mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-05 22:09:56 +03:00
classref: Sync with current master branch
This commit is contained in:
Rémi Verschelde
@@ -16,153 +16,159 @@ Built-in GDScript functions.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :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:`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:`Color<class_color>` | :ref:`ColorN<class_@GDScript_ColorN>` **(** :ref:`String<class_string>` name, :ref:`float<class_float>` alpha **)** |
|
| :ref:`Color<class_color>` | :ref:`ColorN<class_@GDScript_ColorN>` **(** :ref:`String<class_string>` name, :ref:`float<class_float>` alpha **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`abs<class_@GDScript_abs>` **(** :ref:`float<class_float>` s **)** |
|
| :ref:`float<class_float>` | :ref:`abs<class_@GDScript_abs>` **(** :ref:`float<class_float>` s **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`acos<class_@GDScript_acos>` **(** :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:`asin<class_@GDScript_asin>` **(** :ref:`float<class_float>` s **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Nil<class_nil>` | :ref:`assert<class_@GDScript_assert>` **(** :ref:`bool<class_bool>` condition **)** |
|
| void | :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:`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:`atan2<class_@GDScript_atan2>` **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Variant<class_variant>` | :ref:`bytes2var<class_@GDScript_bytes2var>` **(** :ref:`PoolByteArray<class_poolbytearray>` bytes **)** |
|
| :ref:`Variant<class_variant>` | :ref:`bytes2var<class_@GDScript_bytes2var>` **(** :ref:`PoolByteArray<class_poolbytearray>` bytes **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`ceil<class_@GDScript_ceil>` **(** :ref:`float<class_float>` s **)** |
|
| :ref:`float<class_float>` | :ref:`ceil<class_@GDScript_ceil>` **(** :ref:`float<class_float>` s **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`char<class_@GDScript_char>` **(** :ref:`int<class_int>` ascii **)** |
|
| :ref:`String<class_string>` | :ref:`char<class_@GDScript_char>` **(** :ref:`int<class_int>` ascii **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :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:`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>` **(** :ref:`Variant<class_variant>` what, :ref:`int<class_int>` type **)** |
|
| :ref:`Object<class_object>` | :ref:`convert<class_@GDScript_convert>` **(** :ref:`Variant<class_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:`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:`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:`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:`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:`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:`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:`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:`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:`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:`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:`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:`fposmod<class_@GDScript_fposmod>` **(** :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:`funcref<class_@GDScript_funcref>` **(** :ref:`Object<class_object>` instance, :ref:`String<class_string>` funcname **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`hash<class_@GDScript_hash>` **(** :ref:`Variant<class_variant>` var:Variant **)** |
|
| :ref:`int<class_int>` | :ref:`hash<class_@GDScript_hash>` **(** :ref:`Variant<class_variant>` var **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Dictionary<class_dictionary>` | :ref:`inst2dict<class_@GDScript_inst2dict>` **(** :ref:`Object<class_object>` inst **)** |
|
| :ref:`Dictionary<class_dictionary>` | :ref:`inst2dict<class_@GDScript_inst2dict>` **(** :ref:`Object<class_object>` inst **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Object<class_object>` | :ref:`instance_from_id<class_@GDScript_instance_from_id>` **(** :ref:`int<class_int>` instance_id **)** |
|
| :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:`inverse_lerp<class_@GDScript_inverse_lerp>` **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` value **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`is_nan<class_@GDScript_is_nan>` **(** :ref:`float<class_float>` s **)** |
|
| :ref:`float<class_float>` | :ref:`is_inf<class_@GDScript_is_inf>` **(** :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:`is_nan<class_@GDScript_is_nan>` **(** :ref:`float<class_float>` s **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`linear2db<class_@GDScript_linear2db>` **(** :ref:`float<class_float>` nrg **)** |
|
| :ref:`int<class_int>` | :ref:`len<class_@GDScript_len>` **(** :ref:`Variant<class_variant>` var **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Resource<class_resource>` | :ref:`load<class_@GDScript_load>` **(** :ref:`String<class_string>` path **)** |
|
| :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:`log<class_@GDScript_log>` **(** :ref:`float<class_float>` s **)** |
|
| :ref:`float<class_float>` | :ref:`linear2db<class_@GDScript_linear2db>` **(** :ref:`float<class_float>` nrg **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`max<class_@GDScript_max>` **(** :ref:`float<class_float>` a, :ref:`float<class_float>` b **)** |
|
| :ref:`Object<class_object>` | :ref:`load<class_@GDScript_load>` **(** :ref:`String<class_string>` path **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`min<class_@GDScript_min>` **(** :ref:`float<class_float>` a, :ref:`float<class_float>` b **)** |
|
| :ref:`float<class_float>` | :ref:`log<class_@GDScript_log>` **(** :ref:`float<class_float>` s **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`nearest_po2<class_@GDScript_nearest_po2>` **(** :ref:`int<class_int>` val **)** |
|
| :ref:`float<class_float>` | :ref:`max<class_@GDScript_max>` **(** :ref:`float<class_float>` a, :ref:`float<class_float>` b **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Variant<class_variant>` | :ref:`parse_json<class_@GDScript_parse_json>` **(** :ref:`String<class_string>` json **)** |
|
| :ref:`float<class_float>` | :ref:`min<class_@GDScript_min>` **(** :ref:`float<class_float>` a, :ref:`float<class_float>` b **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`pow<class_@GDScript_pow>` **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)** |
|
| :ref:`int<class_int>` | :ref:`nearest_po2<class_@GDScript_nearest_po2>` **(** :ref:`int<class_int>` val **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Resource<class_resource>` | :ref:`preload<class_@GDScript_preload>` **(** :ref:`String<class_string>` path **)** |
|
| :ref:`Variant<class_variant>` | :ref:`parse_json<class_@GDScript_parse_json>` **(** :ref:`String<class_string>` json **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Nil<class_nil>` | :ref:`print<class_@GDScript_print>` **(** :ref:`Variant<class_variant>` what, :ref:`Variant<class_variant>` ... **)** |
|
| :ref:`float<class_float>` | :ref:`pow<class_@GDScript_pow>` **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Nil<class_nil>` | :ref:`print_stack<class_@GDScript_print_stack>` **(** **)** |
|
| :ref:`Resource<class_resource>` | :ref:`preload<class_@GDScript_preload>` **(** :ref:`String<class_string>` path **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Nil<class_nil>` | :ref:`printerr<class_@GDScript_printerr>` **(** :ref:`Variant<class_variant>` what, :ref:`Variant<class_variant>` ... **)** |
|
| void | :ref:`print<class_@GDScript_print>` **(** **)** vararg |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Nil<class_nil>` | :ref:`printraw<class_@GDScript_printraw>` **(** :ref:`Variant<class_variant>` what, :ref:`Variant<class_variant>` ... **)** |
|
| void | :ref:`print_stack<class_@GDScript_print_stack>` **(** **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Nil<class_nil>` | :ref:`prints<class_@GDScript_prints>` **(** :ref:`Variant<class_variant>` what, :ref:`Variant<class_variant>` ... **)** |
|
| void | :ref:`printerr<class_@GDScript_printerr>` **(** **)** vararg |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Nil<class_nil>` | :ref:`printt<class_@GDScript_printt>` **(** :ref:`Variant<class_variant>` what, :ref:`Variant<class_variant>` ... **)** |
|
| void | :ref:`printraw<class_@GDScript_printraw>` **(** **)** vararg |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`rad2deg<class_@GDScript_rad2deg>` **(** :ref:`float<class_float>` rad **)** |
|
| void | :ref:`prints<class_@GDScript_prints>` **(** **)** vararg |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`rand_range<class_@GDScript_rand_range>` **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to **)** |
|
| void | :ref:`printt<class_@GDScript_printt>` **(** **)** vararg |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Array<class_array>` | :ref:`rand_seed<class_@GDScript_rand_seed>` **(** :ref:`int<class_int>` seed **)** |
|
| :ref:`float<class_float>` | :ref:`rad2deg<class_@GDScript_rad2deg>` **(** :ref:`float<class_float>` rad **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :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:`int<class_int>` | :ref:`randi<class_@GDScript_randi>` **(** **)** |
|
| :ref:`Array<class_array>` | :ref:`rand_seed<class_@GDScript_rand_seed>` **(** :ref:`int<class_int>` seed **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Nil<class_nil>` | :ref:`randomize<class_@GDScript_randomize>` **(** **)** |
|
| :ref:`float<class_float>` | :ref:`randf<class_@GDScript_randf>` **(** **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Array<class_array>` | :ref:`range<class_@GDScript_range>` **(** :ref:`Variant<class_variant>` ... **)** |
|
| :ref:`int<class_int>` | :ref:`randi<class_@GDScript_randi>` **(** **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`round<class_@GDScript_round>` **(** :ref:`float<class_float>` s **)** |
|
| void | :ref:`randomize<class_@GDScript_randomize>` **(** **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Nil<class_nil>` | :ref:`seed<class_@GDScript_seed>` **(** :ref:`int<class_int>` seed **)** |
|
| :ref:`Array<class_array>` | :ref:`range<class_@GDScript_range>` **(** **)** vararg |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`sign<class_@GDScript_sign>` **(** :ref:`float<class_float>` s **)** |
|
| :ref:`float<class_float>` | :ref:`range_lerp<class_@GDScript_range_lerp>` **(** :ref:`float<class_float>` value, :ref:`float<class_float>` istart, :ref:`float<class_float>` istop, :ref:`float<class_float>` ostart, :ref:`float<class_float>` ostop **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`sin<class_@GDScript_sin>` **(** :ref:`float<class_float>` s **)** |
|
| :ref:`float<class_float>` | :ref:`round<class_@GDScript_round>` **(** :ref:`float<class_float>` s **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`sinh<class_@GDScript_sinh>` **(** :ref:`float<class_float>` s **)** |
|
| void | :ref:`seed<class_@GDScript_seed>` **(** :ref:`int<class_int>` seed **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`sqrt<class_@GDScript_sqrt>` **(** :ref:`float<class_float>` s **)** |
|
| :ref:`float<class_float>` | :ref:`sign<class_@GDScript_sign>` **(** :ref:`float<class_float>` s **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`stepify<class_@GDScript_stepify>` **(** :ref:`float<class_float>` s, :ref:`float<class_float>` step **)** |
|
| :ref:`float<class_float>` | :ref:`sin<class_@GDScript_sin>` **(** :ref:`float<class_float>` s **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`str<class_@GDScript_str>` **(** :ref:`Variant<class_variant>` what, :ref:`Variant<class_variant>` ... **)** |
|
| :ref:`float<class_float>` | :ref:`sinh<class_@GDScript_sinh>` **(** :ref:`float<class_float>` s **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Variant<class_variant>` | :ref:`str2var<class_@GDScript_str2var>` **(** :ref:`String<class_string>` string **)** |
|
| :ref:`float<class_float>` | :ref:`sqrt<class_@GDScript_sqrt>` **(** :ref:`float<class_float>` s **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`tan<class_@GDScript_tan>` **(** :ref:`float<class_float>` s **)** |
|
| :ref:`float<class_float>` | :ref:`stepify<class_@GDScript_stepify>` **(** :ref:`float<class_float>` s, :ref:`float<class_float>` step **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`tanh<class_@GDScript_tanh>` **(** :ref:`float<class_float>` s **)** |
|
| :ref:`String<class_string>` | :ref:`str<class_@GDScript_str>` **(** **)** vararg |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`to_json<class_@GDScript_to_json>` **(** :ref:`Variant<class_variant>` var:Variant **)** |
|
| :ref:`Variant<class_variant>` | :ref:`str2var<class_@GDScript_str2var>` **(** :ref:`String<class_string>` string **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`type_exists<class_@GDScript_type_exists>` **(** :ref:`String<class_string>` type **)** |
|
| :ref:`float<class_float>` | :ref:`tan<class_@GDScript_tan>` **(** :ref:`float<class_float>` s **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`typeof<class_@GDScript_typeof>` **(** :ref:`Variant<class_variant>` what **)** |
|
| :ref:`float<class_float>` | :ref:`tanh<class_@GDScript_tanh>` **(** :ref:`float<class_float>` s **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Variant<class_variant>` | :ref:`validate_json<class_@GDScript_validate_json>` **(** :ref:`String<class_string>` json **)** |
|
| :ref:`String<class_string>` | :ref:`to_json<class_@GDScript_to_json>` **(** :ref:`Variant<class_variant>` var **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`PoolByteArray<class_poolbytearray>` | :ref:`var2bytes<class_@GDScript_var2bytes>` **(** :ref:`Variant<class_variant>` var **)** |
|
| :ref:`bool<class_bool>` | :ref:`type_exists<class_@GDScript_type_exists>` **(** :ref:`String<class_string>` type **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`var2str<class_@GDScript_var2str>` **(** :ref:`Variant<class_variant>` var **)** |
|
| :ref:`int<class_int>` | :ref:`typeof<class_@GDScript_typeof>` **(** :ref:`Variant<class_variant>` what **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`WeakRef<class_weakref>` | :ref:`weakref<class_@GDScript_weakref>` **(** :ref:`Object<class_object>` obj **)** |
|
| :ref:`String<class_string>` | :ref:`validate_json<class_@GDScript_validate_json>` **(** :ref:`String<class_string>` json **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`GDFunctionState<class_gdfunctionstate>` | :ref:`yield<class_@GDScript_yield>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` signal **)** |
|
| :ref:`PoolByteArray<class_poolbytearray>` | :ref:`var2bytes<class_@GDScript_var2bytes>` **(** :ref:`Variant<class_variant>` var **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`String<class_string>` | :ref:`var2str<class_@GDScript_var2str>` **(** :ref:`Variant<class_variant>` var **)** |
|
||||||
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`Object<class_object>` | :ref:`weakref<class_@GDScript_weakref>` **(** :ref:`Object<class_object>` obj **)** |
|
||||||
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`GDFunctionState<class_gdfunctionstate>` | :ref:`yield<class_@GDScript_yield>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` signal **)** |
|
||||||
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Numeric Constants
|
Numeric Constants
|
||||||
-----------------
|
-----------------
|
||||||
@@ -211,7 +217,7 @@ Returns the principal value of the arc sine of s, expressed in radians. In trigo
|
|||||||
|
|
||||||
.. _class_@GDScript_assert:
|
.. _class_@GDScript_assert:
|
||||||
|
|
||||||
- :ref:`Nil<class_nil>` **assert** **(** :ref:`bool<class_bool>` condition **)**
|
- void **assert** **(** :ref:`bool<class_bool>` condition **)**
|
||||||
|
|
||||||
Assert that the condition is true. If the condition is false, generates an error.
|
Assert that the condition is true. If the condition is false, generates an error.
|
||||||
|
|
||||||
@@ -335,13 +341,13 @@ Module (remainder of x/y) that wraps equally in positive and negative.
|
|||||||
|
|
||||||
.. _class_@GDScript_funcref:
|
.. _class_@GDScript_funcref:
|
||||||
|
|
||||||
- :ref:`FuncRef<class_funcref>` **funcref** **(** :ref:`Object<class_object>` instance, :ref:`String<class_string>` funcname **)**
|
- :ref:`Object<class_object>` **funcref** **(** :ref:`Object<class_object>` instance, :ref:`String<class_string>` funcname **)**
|
||||||
|
|
||||||
Return a reference to the specified function.
|
Return a reference to the specified function.
|
||||||
|
|
||||||
.. _class_@GDScript_hash:
|
.. _class_@GDScript_hash:
|
||||||
|
|
||||||
- :ref:`int<class_int>` **hash** **(** :ref:`Variant<class_variant>` var:Variant **)**
|
- :ref:`int<class_int>` **hash** **(** :ref:`Variant<class_variant>` var **)**
|
||||||
|
|
||||||
Hash the variable passed and return an integer.
|
Hash the variable passed and return an integer.
|
||||||
|
|
||||||
@@ -357,6 +363,10 @@ Convert a script class instance to a dictionary (useful for serializing).
|
|||||||
|
|
||||||
Get an object by its ID.
|
Get an object by its ID.
|
||||||
|
|
||||||
|
.. _class_@GDScript_inverse_lerp:
|
||||||
|
|
||||||
|
- :ref:`float<class_float>` **inverse_lerp** **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` value **)**
|
||||||
|
|
||||||
.. _class_@GDScript_is_inf:
|
.. _class_@GDScript_is_inf:
|
||||||
|
|
||||||
- :ref:`float<class_float>` **is_inf** **(** :ref:`float<class_float>` s **)**
|
- :ref:`float<class_float>` **is_inf** **(** :ref:`float<class_float>` s **)**
|
||||||
@@ -369,6 +379,10 @@ Returns whether s is an infinity value (either positive infinity or negative inf
|
|||||||
|
|
||||||
Returns whether s is a NaN (Not-A-Number) value.
|
Returns whether s is a NaN (Not-A-Number) value.
|
||||||
|
|
||||||
|
.. _class_@GDScript_len:
|
||||||
|
|
||||||
|
- :ref:`int<class_int>` **len** **(** :ref:`Variant<class_variant>` var **)**
|
||||||
|
|
||||||
.. _class_@GDScript_lerp:
|
.. _class_@GDScript_lerp:
|
||||||
|
|
||||||
- :ref:`float<class_float>` **lerp** **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` weight **)**
|
- :ref:`float<class_float>` **lerp** **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` weight **)**
|
||||||
@@ -383,7 +397,7 @@ Convert from linear energy to decibels (audio).
|
|||||||
|
|
||||||
.. _class_@GDScript_load:
|
.. _class_@GDScript_load:
|
||||||
|
|
||||||
- :ref:`Resource<class_resource>` **load** **(** :ref:`String<class_string>` path **)**
|
- :ref:`Object<class_object>` **load** **(** :ref:`String<class_string>` path **)**
|
||||||
|
|
||||||
Load a resource from the filesystem, pass a valid path as argument.
|
Load a resource from the filesystem, pass a valid path as argument.
|
||||||
|
|
||||||
@@ -433,37 +447,37 @@ Preload a resource from the filesystem. The resource is loaded during script par
|
|||||||
|
|
||||||
.. _class_@GDScript_print:
|
.. _class_@GDScript_print:
|
||||||
|
|
||||||
- :ref:`Nil<class_nil>` **print** **(** :ref:`Variant<class_variant>` what, :ref:`Variant<class_variant>` ... **)**
|
- void **print** **(** **)** vararg
|
||||||
|
|
||||||
Print one or more arguments to strings in the best way possible to a console line.
|
Print one or more arguments to strings in the best way possible to a console line.
|
||||||
|
|
||||||
.. _class_@GDScript_print_stack:
|
.. _class_@GDScript_print_stack:
|
||||||
|
|
||||||
- :ref:`Nil<class_nil>` **print_stack** **(** **)**
|
- void **print_stack** **(** **)**
|
||||||
|
|
||||||
Print a stack track at code location, only works when running with debugger turned on.
|
Print a stack track at code location, only works when running with debugger turned on.
|
||||||
|
|
||||||
.. _class_@GDScript_printerr:
|
.. _class_@GDScript_printerr:
|
||||||
|
|
||||||
- :ref:`Nil<class_nil>` **printerr** **(** :ref:`Variant<class_variant>` what, :ref:`Variant<class_variant>` ... **)**
|
- void **printerr** **(** **)** vararg
|
||||||
|
|
||||||
Print one or more arguments to strings in the best way possible to standard error line.
|
Print one or more arguments to strings in the best way possible to standard error line.
|
||||||
|
|
||||||
.. _class_@GDScript_printraw:
|
.. _class_@GDScript_printraw:
|
||||||
|
|
||||||
- :ref:`Nil<class_nil>` **printraw** **(** :ref:`Variant<class_variant>` what, :ref:`Variant<class_variant>` ... **)**
|
- void **printraw** **(** **)** vararg
|
||||||
|
|
||||||
Print one or more arguments to strings in the best way possible to console. No newline is added at the end.
|
Print one or more arguments to strings in the best way possible to console. No newline is added at the end.
|
||||||
|
|
||||||
.. _class_@GDScript_prints:
|
.. _class_@GDScript_prints:
|
||||||
|
|
||||||
- :ref:`Nil<class_nil>` **prints** **(** :ref:`Variant<class_variant>` what, :ref:`Variant<class_variant>` ... **)**
|
- void **prints** **(** **)** vararg
|
||||||
|
|
||||||
Print one or more arguments to the console with a space between each argument.
|
Print one or more arguments to the console with a space between each argument.
|
||||||
|
|
||||||
.. _class_@GDScript_printt:
|
.. _class_@GDScript_printt:
|
||||||
|
|
||||||
- :ref:`Nil<class_nil>` **printt** **(** :ref:`Variant<class_variant>` what, :ref:`Variant<class_variant>` ... **)**
|
- void **printt** **(** **)** vararg
|
||||||
|
|
||||||
Print one or more arguments to the console with a tab between each argument.
|
Print one or more arguments to the console with a tab between each argument.
|
||||||
|
|
||||||
@@ -499,16 +513,20 @@ Return a random 32 bits integer value. To obtain a random value between 0 to N (
|
|||||||
|
|
||||||
.. _class_@GDScript_randomize:
|
.. _class_@GDScript_randomize:
|
||||||
|
|
||||||
- :ref:`Nil<class_nil>` **randomize** **(** **)**
|
- void **randomize** **(** **)**
|
||||||
|
|
||||||
Randomize the seed (or the internal state) of the random number generator. Current implementation reseeds using a number based on time.
|
Randomize the seed (or the internal state) of the random number generator. Current implementation reseeds using a number based on time.
|
||||||
|
|
||||||
.. _class_@GDScript_range:
|
.. _class_@GDScript_range:
|
||||||
|
|
||||||
- :ref:`Array<class_array>` **range** **(** :ref:`Variant<class_variant>` ... **)**
|
- :ref:`Array<class_array>` **range** **(** **)** vararg
|
||||||
|
|
||||||
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).
|
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_range_lerp:
|
||||||
|
|
||||||
|
- :ref:`float<class_float>` **range_lerp** **(** :ref:`float<class_float>` value, :ref:`float<class_float>` istart, :ref:`float<class_float>` istop, :ref:`float<class_float>` ostart, :ref:`float<class_float>` ostop **)**
|
||||||
|
|
||||||
.. _class_@GDScript_round:
|
.. _class_@GDScript_round:
|
||||||
|
|
||||||
- :ref:`float<class_float>` **round** **(** :ref:`float<class_float>` s **)**
|
- :ref:`float<class_float>` **round** **(** :ref:`float<class_float>` s **)**
|
||||||
@@ -517,7 +535,7 @@ Returns the integral value that is nearest to s, with halfway cases rounded away
|
|||||||
|
|
||||||
.. _class_@GDScript_seed:
|
.. _class_@GDScript_seed:
|
||||||
|
|
||||||
- :ref:`Nil<class_nil>` **seed** **(** :ref:`int<class_int>` seed **)**
|
- void **seed** **(** :ref:`int<class_int>` seed **)**
|
||||||
|
|
||||||
Set seed for the random number generator.
|
Set seed for the random number generator.
|
||||||
|
|
||||||
@@ -553,7 +571,7 @@ Snap float value to a given step.
|
|||||||
|
|
||||||
.. _class_@GDScript_str:
|
.. _class_@GDScript_str:
|
||||||
|
|
||||||
- :ref:`String<class_string>` **str** **(** :ref:`Variant<class_variant>` what, :ref:`Variant<class_variant>` ... **)**
|
- :ref:`String<class_string>` **str** **(** **)** vararg
|
||||||
|
|
||||||
Convert one or more arguments to string in the best way possible.
|
Convert one or more arguments to string in the best way possible.
|
||||||
|
|
||||||
@@ -577,7 +595,7 @@ Returns the hyperbolic tangent of s.
|
|||||||
|
|
||||||
.. _class_@GDScript_to_json:
|
.. _class_@GDScript_to_json:
|
||||||
|
|
||||||
- :ref:`String<class_string>` **to_json** **(** :ref:`Variant<class_variant>` var:Variant **)**
|
- :ref:`String<class_string>` **to_json** **(** :ref:`Variant<class_variant>` var **)**
|
||||||
|
|
||||||
Convert a Variant to json text.
|
Convert a Variant to json text.
|
||||||
|
|
||||||
@@ -593,7 +611,7 @@ Return the internal type of the given Variant object, using the TYPE\_\* enum in
|
|||||||
|
|
||||||
.. _class_@GDScript_validate_json:
|
.. _class_@GDScript_validate_json:
|
||||||
|
|
||||||
- :ref:`Variant<class_variant>` **validate_json** **(** :ref:`String<class_string>` json **)**
|
- :ref:`String<class_string>` **validate_json** **(** :ref:`String<class_string>` json **)**
|
||||||
|
|
||||||
This method is used to validate the structure and data types of a piece of JSON, similar to XML Schema for XML.
|
This method is used to validate the structure and data types of a piece of JSON, similar to XML Schema for XML.
|
||||||
|
|
||||||
@@ -611,7 +629,7 @@ Convert a value to a formatted string that can later be parsed using :ref:`str2v
|
|||||||
|
|
||||||
.. _class_@GDScript_weakref:
|
.. _class_@GDScript_weakref:
|
||||||
|
|
||||||
- :ref:`WeakRef<class_weakref>` **weakref** **(** :ref:`Object<class_object>` obj **)**
|
- :ref:`Object<class_object>` **weakref** **(** :ref:`Object<class_object>` obj **)**
|
||||||
|
|
||||||
Return a weak reference to an object.
|
Return a weak reference to an object.
|
||||||
|
|
||||||
|
|||||||
@@ -16,11 +16,11 @@ Global scope constants and variables.
|
|||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
|
- :ref:`ARVRServer<class_arvrserver>` **ARVRServer**
|
||||||
- :ref:`AudioServer<class_audioserver>` **AudioServer** - [AudioServer] singleton
|
- :ref:`AudioServer<class_audioserver>` **AudioServer** - [AudioServer] singleton
|
||||||
- :ref:`ClassDB<class_classdb>` **ClassDB** - [ClassDB] singleton
|
- :ref:`ClassDB<class_classdb>` **ClassDB** - [ClassDB] singleton
|
||||||
- :ref:`Engine<class_engine>` **Engine** - [Engine] singleton
|
- :ref:`Engine<class_engine>` **Engine** - [Engine] singleton
|
||||||
- :ref:`Geometry<class_geometry>` **Geometry** - [Geometry] singleton
|
- :ref:`Geometry<class_geometry>` **Geometry** - [Geometry] singleton
|
||||||
- :ref:`ProjectSettings<class_projectsettings>` **ProjectSettings** - [ProjectSettings] singleton
|
|
||||||
- :ref:`IP<class_ip>` **IP** - [IP] singleton
|
- :ref:`IP<class_ip>` **IP** - [IP] singleton
|
||||||
- :ref:`Input<class_input>` **Input** - [Input] singleton
|
- :ref:`Input<class_input>` **Input** - [Input] singleton
|
||||||
- :ref:`InputMap<class_inputmap>` **InputMap** - [InputMap] singleton
|
- :ref:`InputMap<class_inputmap>` **InputMap** - [InputMap] singleton
|
||||||
@@ -29,6 +29,7 @@ Member Variables
|
|||||||
- :ref:`Performance<class_performance>` **Performance** - [Performance] singleton
|
- :ref:`Performance<class_performance>` **Performance** - [Performance] singleton
|
||||||
- :ref:`Physics2DServer<class_physics2dserver>` **Physics2DServer** - [Physics2DServer] singleton
|
- :ref:`Physics2DServer<class_physics2dserver>` **Physics2DServer** - [Physics2DServer] singleton
|
||||||
- :ref:`PhysicsServer<class_physicsserver>` **PhysicsServer** - [PhysicsServer] singleton
|
- :ref:`PhysicsServer<class_physicsserver>` **PhysicsServer** - [PhysicsServer] singleton
|
||||||
|
- :ref:`ProjectSettings<class_projectsettings>` **ProjectSettings** - [ProjectSettings] singleton
|
||||||
- :ref:`ResourceLoader<class_resourceloader>` **ResourceLoader** - [ResourceLoader] singleton
|
- :ref:`ResourceLoader<class_resourceloader>` **ResourceLoader** - [ResourceLoader] singleton
|
||||||
- :ref:`ResourceSaver<class_resourcesaver>` **ResourceSaver** - [ResourceSaver] singleton
|
- :ref:`ResourceSaver<class_resourcesaver>` **ResourceSaver** - [ResourceSaver] singleton
|
||||||
- :ref:`TranslationServer<class_translationserver>` **TranslationServer** - [TranslationServer] singleton
|
- :ref:`TranslationServer<class_translationserver>` **TranslationServer** - [TranslationServer] singleton
|
||||||
@@ -54,8 +55,8 @@ Numeric Constants
|
|||||||
- **KEY_TAB** = **16777218** --- Tab Key
|
- **KEY_TAB** = **16777218** --- Tab Key
|
||||||
- **KEY_BACKTAB** = **16777219** --- Shift-Tab Key
|
- **KEY_BACKTAB** = **16777219** --- Shift-Tab Key
|
||||||
- **KEY_BACKSPACE** = **16777220** --- Backspace Key
|
- **KEY_BACKSPACE** = **16777220** --- Backspace Key
|
||||||
- **KEY_RETURN** = **16777221** --- Return Key (On Main Keyboard)
|
- **KEY_ENTER** = **16777221** --- Return Key (On Main Keyboard)
|
||||||
- **KEY_ENTER** = **16777222** --- Enter Key (On Numpad)
|
- **KEY_KP_ENTER** = **16777222** --- Enter Key (On Numpad)
|
||||||
- **KEY_INSERT** = **16777223** --- Insert Key
|
- **KEY_INSERT** = **16777223** --- Insert Key
|
||||||
- **KEY_DELETE** = **16777224** --- Delete Key
|
- **KEY_DELETE** = **16777224** --- Delete Key
|
||||||
- **KEY_PAUSE** = **16777225** --- Pause Key
|
- **KEY_PAUSE** = **16777225** --- Pause Key
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
||||||
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
|
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
|
||||||
|
|
||||||
.. _class_@Native:
|
.. _class_@NativeScript:
|
||||||
|
|
||||||
@Native
|
@NativeScript
|
||||||
=======
|
=============
|
||||||
|
|
||||||
**Category:** Core
|
**Category:** Core
|
||||||
|
|
||||||
@@ -20,25 +20,25 @@ Base dialog for user notification.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :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_button<class_AcceptDialog_add_button>` **(** :ref:`String<class_string>` text, :ref:`bool<class_bool>` right=false, :ref:`String<class_string>` action=null **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Button<class_button>` | :ref:`add_cancel<class_AcceptDialog_add_cancel>` **(** :ref:`String<class_string>` name **)** |
|
| :ref:`Button<class_button>` | :ref:`add_cancel<class_AcceptDialog_add_cancel>` **(** :ref:`String<class_string>` name **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`get_hide_on_ok<class_AcceptDialog_get_hide_on_ok>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`get_hide_on_ok<class_AcceptDialog_get_hide_on_ok>` **(** **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Object<class_object>` | :ref:`get_label<class_AcceptDialog_get_label>` **(** **)** |
|
| :ref:`Label<class_label>` | :ref:`get_label<class_AcceptDialog_get_label>` **(** **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Object<class_object>` | :ref:`get_ok<class_AcceptDialog_get_ok>` **(** **)** |
|
| :ref:`Button<class_button>` | :ref:`get_ok<class_AcceptDialog_get_ok>` **(** **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`get_text<class_AcceptDialog_get_text>` **(** **)** const |
|
| :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:`register_text_enter<class_AcceptDialog_register_text_enter>` **(** :ref:`Node<class_node>` line_edit **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_hide_on_ok<class_AcceptDialog_set_hide_on_ok>` **(** :ref:`bool<class_bool>` enabled **)** |
|
| 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 **)** |
|
| void | :ref:`set_text<class_AcceptDialog_set_text>` **(** :ref:`String<class_string>` text **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Signals
|
Signals
|
||||||
-------
|
-------
|
||||||
@@ -66,7 +66,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_AcceptDialog_add_button:
|
.. _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="" **)**
|
- :ref:`Button<class_button>` **add_button** **(** :ref:`String<class_string>` text, :ref:`bool<class_bool>` right=false, :ref:`String<class_string>` action=null **)**
|
||||||
|
|
||||||
Add custom button to the dialog and return the created button.
|
Add custom button to the dialog and return the created button.
|
||||||
|
|
||||||
@@ -86,13 +86,13 @@ Return true if the dialog will be hidden when accepted (default true).
|
|||||||
|
|
||||||
.. _class_AcceptDialog_get_label:
|
.. _class_AcceptDialog_get_label:
|
||||||
|
|
||||||
- :ref:`Object<class_object>` **get_label** **(** **)**
|
- :ref:`Label<class_label>` **get_label** **(** **)**
|
||||||
|
|
||||||
Return the label used for built-in text.
|
Return the label used for built-in text.
|
||||||
|
|
||||||
.. _class_AcceptDialog_get_ok:
|
.. _class_AcceptDialog_get_ok:
|
||||||
|
|
||||||
- :ref:`Object<class_object>` **get_ok** **(** **)**
|
- :ref:`Button<class_button>` **get_ok** **(** **)**
|
||||||
|
|
||||||
Return the OK Button.
|
Return the OK Button.
|
||||||
|
|
||||||
@@ -104,7 +104,7 @@ Return the built-in label text.
|
|||||||
|
|
||||||
.. _class_AcceptDialog_register_text_enter:
|
.. _class_AcceptDialog_register_text_enter:
|
||||||
|
|
||||||
- :ref:`LineEdit<class_lineedit>` **register_text_enter** **(** :ref:`Object<class_object>` line_edit **)**
|
- void **register_text_enter** **(** :ref:`Node<class_node>` line_edit **)**
|
||||||
|
|
||||||
Register a :ref:`LineEdit<class_lineedit>` in the dialog. When the enter key is pressed, the dialog will be accepted.
|
Register a :ref:`LineEdit<class_lineedit>` in the dialog. When the enter key is pressed, the dialog will be accepted.
|
||||||
|
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ 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 **)** |
|
| :ref:`int<class_int>` | :ref:`add_track<class_Animation_add_track>` **(** :ref:`int<class_int>` type, :ref:`int<class_int>` at_pos=null **)** |
|
||||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`clear<class_Animation_clear>` **(** **)** |
|
| void | :ref:`clear<class_Animation_clear>` **(** **)** |
|
||||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -47,7 +47,7 @@ Member Functions
|
|||||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_step<class_Animation_set_step>` **(** :ref:`float<class_float>` size_sec **)** |
|
| void | :ref:`set_step<class_Animation_set_step>` **(** :ref:`float<class_float>` size_sec **)** |
|
||||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :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 |
|
| :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=null **)** const |
|
||||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`track_get_interpolation_loop_wrap<class_Animation_track_get_interpolation_loop_wrap>` **(** :ref:`int<class_int>` idx **)** const |
|
| :ref:`bool<class_bool>` | :ref:`track_get_interpolation_loop_wrap<class_Animation_track_get_interpolation_loop_wrap>` **(** :ref:`int<class_int>` idx **)** const |
|
||||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -59,13 +59,13 @@ Member Functions
|
|||||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :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:`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:`Variant<class_variant>` | :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:`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 |
|
| :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, :ref:`Variant<class_variant>` key, :ref:`float<class_float>` transition=1 **)** |
|
| void | :ref:`track_insert_key<class_Animation_track_insert_key>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`Variant<class_variant>` key, :ref:`float<class_float>` transition=null **)** |
|
||||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`track_is_imported<class_Animation_track_is_imported>` **(** :ref:`int<class_int>` idx **)** const |
|
| :ref:`bool<class_bool>` | :ref:`track_is_imported<class_Animation_track_is_imported>` **(** :ref:`int<class_int>` idx **)** const |
|
||||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -125,7 +125,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_Animation_add_track:
|
.. _class_Animation_add_track:
|
||||||
|
|
||||||
- :ref:`int<class_int>` **add_track** **(** :ref:`int<class_int>` type, :ref:`int<class_int>` at_pos=-1 **)**
|
- :ref:`int<class_int>` **add_track** **(** :ref:`int<class_int>` type, :ref:`int<class_int>` at_pos=null **)**
|
||||||
|
|
||||||
Add a track to the Animation. The track type must be specified as any of the values in the TYPE\_\* enumeration.
|
Add a track to the Animation. The track type must be specified as any of the values in the TYPE\_\* enumeration.
|
||||||
|
|
||||||
@@ -209,7 +209,7 @@ Set the animation step value.
|
|||||||
|
|
||||||
.. _class_Animation_track_find_key:
|
.. _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
|
- :ref:`int<class_int>` **track_find_key** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`bool<class_bool>` exact=null **)** const
|
||||||
|
|
||||||
Find the key index by time in a given track. Optionally, only find it if the exact time is given.
|
Find the key index by time in a given track. Optionally, only find it if the exact time is given.
|
||||||
|
|
||||||
@@ -243,7 +243,7 @@ Return the transition curve (easing) for a specific key (see built-in math funct
|
|||||||
|
|
||||||
.. _class_Animation_track_get_key_value:
|
.. _class_Animation_track_get_key_value:
|
||||||
|
|
||||||
- void **track_get_key_value** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const
|
- :ref:`Variant<class_variant>` **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.
|
Return the value of a given key in a given track.
|
||||||
|
|
||||||
@@ -261,7 +261,7 @@ Get the type of a track.
|
|||||||
|
|
||||||
.. _class_Animation_track_insert_key:
|
.. _class_Animation_track_insert_key:
|
||||||
|
|
||||||
- void **track_insert_key** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`Variant<class_variant>` key, :ref:`float<class_float>` transition=1 **)**
|
- void **track_insert_key** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`Variant<class_variant>` key, :ref:`float<class_float>` transition=null **)**
|
||||||
|
|
||||||
Insert a generic key in a given track.
|
Insert a generic key in a given track.
|
||||||
|
|
||||||
|
|||||||
@@ -18,83 +18,83 @@ Container and player of :ref:`Animation<class_animation>` resources.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`add_animation<class_AnimationPlayer_add_animation>` **(** :ref:`String<class_string>` name, :ref:`Animation<class_animation>` animation **)** |
|
| :ref:`int<class_int>` | :ref:`add_animation<class_AnimationPlayer_add_animation>` **(** :ref:`String<class_string>` name, :ref:`Animation<class_animation>` animation **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`advance<class_AnimationPlayer_advance>` **(** :ref:`float<class_float>` delta **)** |
|
| void | :ref:`advance<class_AnimationPlayer_advance>` **(** :ref:`float<class_float>` delta **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`animation_get_next<class_AnimationPlayer_animation_get_next>` **(** :ref:`String<class_string>` anim_from **)** const |
|
| :ref:`String<class_string>` | :ref:`animation_get_next<class_AnimationPlayer_animation_get_next>` **(** :ref:`String<class_string>` anim_from **)** 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:`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_caches<class_AnimationPlayer_clear_caches>` **(** **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`clear_queue<class_AnimationPlayer_clear_queue>` **(** **)** |
|
| 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:`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:`Animation<class_animation>` | :ref:`get_animation<class_AnimationPlayer_get_animation>` **(** :ref:`String<class_string>` name **)** const |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_animation_list<class_AnimationPlayer_get_animation_list>` **(** **)** const |
|
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_animation_list<class_AnimationPlayer_get_animation_list>` **(** **)** const |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_animation_process_mode<class_AnimationPlayer_get_animation_process_mode>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_animation_process_mode<class_AnimationPlayer_get_animation_process_mode>` **(** **)** const |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`get_autoplay<class_AnimationPlayer_get_autoplay>` **(** **)** const |
|
| :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 |
|
| :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 |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`get_current_animation<class_AnimationPlayer_get_current_animation>` **(** **)** const |
|
| :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_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_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_default_blend_time<class_AnimationPlayer_get_default_blend_time>` **(** **)** const |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_pos<class_AnimationPlayer_get_pos>` **(** **)** 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:`NodePath<class_nodepath>` | :ref:`get_root<class_AnimationPlayer_get_root>` **(** **)** const |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_speed_scale<class_AnimationPlayer_get_speed_scale>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_speed_scale<class_AnimationPlayer_get_speed_scale>` **(** **)** const |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`has_animation<class_AnimationPlayer_has_animation>` **(** :ref:`String<class_string>` name **)** 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_active<class_AnimationPlayer_is_active>` **(** **)** const |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AnimationPlayer_is_playing>` **(** **)** 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<class_AnimationPlayer_play>` **(** :ref:`String<class_string>` name=false, :ref:`float<class_float>` custom_blend=1.0, :ref:`float<class_float>` custom_speed=-1, :ref:`bool<class_bool>` from_end="" **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`play_backwards<class_AnimationPlayer_play_backwards>` **(** :ref:`String<class_string>` name="", :ref:`float<class_float>` custom_blend=-1 **)** |
|
| void | :ref:`play_backwards<class_AnimationPlayer_play_backwards>` **(** :ref:`String<class_string>` name=-1, :ref:`float<class_float>` custom_blend="" **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`queue<class_AnimationPlayer_queue>` **(** :ref:`String<class_string>` name **)** |
|
| void | :ref:`queue<class_AnimationPlayer_queue>` **(** :ref:`String<class_string>` name **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`remove_animation<class_AnimationPlayer_remove_animation>` **(** :ref:`String<class_string>` name **)** |
|
| void | :ref:`remove_animation<class_AnimationPlayer_remove_animation>` **(** :ref:`String<class_string>` name **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`rename_animation<class_AnimationPlayer_rename_animation>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` newname **)** |
|
| 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 **)** |
|
| void | :ref:`seek<class_AnimationPlayer_seek>` **(** :ref:`float<class_float>` pos_sec, :ref:`bool<class_bool>` update=null **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_active<class_AnimationPlayer_set_active>` **(** :ref:`bool<class_bool>` active **)** |
|
| 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 **)** |
|
| void | :ref:`set_animation_process_mode<class_AnimationPlayer_set_animation_process_mode>` **(** :ref:`int<class_int>` mode **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_autoplay<class_AnimationPlayer_set_autoplay>` **(** :ref:`String<class_string>` name **)** |
|
| void | :ref:`set_autoplay<class_AnimationPlayer_set_autoplay>` **(** :ref:`String<class_string>` name **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| 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 **)** |
|
| 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 **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_current_animation<class_AnimationPlayer_set_current_animation>` **(** :ref:`String<class_string>` anim **)** |
|
| void | :ref:`set_current_animation<class_AnimationPlayer_set_current_animation>` **(** :ref:`String<class_string>` anim **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_default_blend_time<class_AnimationPlayer_set_default_blend_time>` **(** :ref:`float<class_float>` sec **)** |
|
| 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_root<class_AnimationPlayer_set_root>` **(** :ref:`NodePath<class_nodepath>` path **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_speed_scale<class_AnimationPlayer_set_speed_scale>` **(** :ref:`float<class_float>` speed **)** |
|
| void | :ref:`set_speed_scale<class_AnimationPlayer_set_speed_scale>` **(** :ref:`float<class_float>` speed **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`stop<class_AnimationPlayer_stop>` **(** :ref:`bool<class_bool>` reset=true **)** |
|
| void | :ref:`stop<class_AnimationPlayer_stop>` **(** :ref:`bool<class_bool>` reset=true **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`stop_all<class_AnimationPlayer_stop_all>` **(** **)** |
|
| void | :ref:`stop_all<class_AnimationPlayer_stop_all>` **(** **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Signals
|
Signals
|
||||||
-------
|
-------
|
||||||
@@ -260,13 +260,13 @@ Return whether an animation is playing.
|
|||||||
|
|
||||||
.. _class_AnimationPlayer_play:
|
.. _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 **)**
|
- void **play** **(** :ref:`String<class_string>` name=false, :ref:`float<class_float>` custom_blend=1.0, :ref:`float<class_float>` custom_speed=-1, :ref:`bool<class_bool>` from_end="" **)**
|
||||||
|
|
||||||
Play a given animation by the animation name. Custom speed and blend times can be set. If custom speed is negative (-1), 'from_end' being true can play the animation backwards.
|
Play a given animation by the animation name. Custom speed and blend times can be set. If custom speed is negative (-1), 'from_end' being true can play the animation backwards.
|
||||||
|
|
||||||
.. _class_AnimationPlayer_play_backwards:
|
.. _class_AnimationPlayer_play_backwards:
|
||||||
|
|
||||||
- void **play_backwards** **(** :ref:`String<class_string>` name="", :ref:`float<class_float>` custom_blend=-1 **)**
|
- void **play_backwards** **(** :ref:`String<class_string>` name=-1, :ref:`float<class_float>` custom_blend="" **)**
|
||||||
|
|
||||||
Play a given animation by the animation name in reverse.
|
Play a given animation by the animation name in reverse.
|
||||||
|
|
||||||
@@ -290,7 +290,7 @@ Rename an existing animation.
|
|||||||
|
|
||||||
.. _class_AnimationPlayer_seek:
|
.. _class_AnimationPlayer_seek:
|
||||||
|
|
||||||
- void **seek** **(** :ref:`float<class_float>` pos_sec, :ref:`bool<class_bool>` update=false **)**
|
- void **seek** **(** :ref:`float<class_float>` pos_sec, :ref:`bool<class_bool>` update=null **)**
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
|
|||||||
@@ -63,9 +63,9 @@ Member Functions
|
|||||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_using_reverb_bus<class_Area_is_using_reverb_bus>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_using_reverb_bus<class_Area_is_using_reverb_bus>` **(** **)** const |
|
||||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`overlaps_area<class_Area_overlaps_area>` **(** :ref:`Object<class_object>` area **)** const |
|
| :ref:`bool<class_bool>` | :ref:`overlaps_area<class_Area_overlaps_area>` **(** :ref:`Node<class_node>` 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_body<class_Area_overlaps_body>` **(** :ref:`Node<class_node>` body **)** const |
|
||||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_angular_damp<class_Area_set_angular_damp>` **(** :ref:`float<class_float>` angular_damp **)** |
|
| void | :ref:`set_angular_damp<class_Area_set_angular_damp>` **(** :ref:`float<class_float>` angular_damp **)** |
|
||||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -151,7 +151,7 @@ Member Variables
|
|||||||
- :ref:`float<class_float>` **linear_damp**
|
- :ref:`float<class_float>` **linear_damp**
|
||||||
- :ref:`bool<class_bool>` **monitorable**
|
- :ref:`bool<class_bool>` **monitorable**
|
||||||
- :ref:`bool<class_bool>` **monitoring**
|
- :ref:`bool<class_bool>` **monitoring**
|
||||||
- :ref:`int<class_int>` **priority**
|
- :ref:`float<class_float>` **priority**
|
||||||
- :ref:`float<class_float>` **reverb_bus_amount**
|
- :ref:`float<class_float>` **reverb_bus_amount**
|
||||||
- :ref:`bool<class_bool>` **reverb_bus_enable**
|
- :ref:`bool<class_bool>` **reverb_bus_enable**
|
||||||
- :ref:`String<class_string>` **reverb_bus_name**
|
- :ref:`String<class_string>` **reverb_bus_name**
|
||||||
@@ -288,13 +288,13 @@ Return whether this area detects bodies/areas entering/exiting it.
|
|||||||
|
|
||||||
.. _class_Area_overlaps_area:
|
.. _class_Area_overlaps_area:
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **overlaps_area** **(** :ref:`Object<class_object>` area **)** const
|
- :ref:`bool<class_bool>` **overlaps_area** **(** :ref:`Node<class_node>` area **)** const
|
||||||
|
|
||||||
Return whether the area passed is totally or partially inside this area.
|
Return whether the area passed is totally or partially inside this area.
|
||||||
|
|
||||||
.. _class_Area_overlaps_body:
|
.. _class_Area_overlaps_body:
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **overlaps_body** **(** :ref:`Object<class_object>` body **)** const
|
- :ref:`bool<class_bool>` **overlaps_body** **(** :ref:`Node<class_node>` body **)** const
|
||||||
|
|
||||||
Return whether the body passed is totally or partially inside this area.
|
Return whether the body passed is totally or partially inside this area.
|
||||||
|
|
||||||
@@ -394,7 +394,7 @@ Set whether this area can detect bodies/areas entering/exiting it.
|
|||||||
|
|
||||||
- void **set_priority** **(** :ref:`float<class_float>` 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.
|
Set the order in which the area is processed. Greater values mean the area gets processed first. This is useful for areas which have a 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.
|
Areas with the same priority value get evaluated in an unpredictable order, and should be differentiated if evaluation order is to be important.
|
||||||
|
|
||||||
|
|||||||
@@ -55,9 +55,9 @@ Member Functions
|
|||||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_overriding_audio_bus<class_Area2D_is_overriding_audio_bus>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_overriding_audio_bus<class_Area2D_is_overriding_audio_bus>` **(** **)** const |
|
||||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`overlaps_area<class_Area2D_overlaps_area>` **(** :ref:`Object<class_object>` area **)** const |
|
| :ref:`bool<class_bool>` | :ref:`overlaps_area<class_Area2D_overlaps_area>` **(** :ref:`Node<class_node>` area **)** const |
|
||||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`overlaps_body<class_Area2D_overlaps_body>` **(** :ref:`Object<class_object>` body **)** const |
|
| :ref:`bool<class_bool>` | :ref:`overlaps_body<class_Area2D_overlaps_body>` **(** :ref:`Node<class_node>` body **)** const |
|
||||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_angular_damp<class_Area2D_set_angular_damp>` **(** :ref:`float<class_float>` angular_damp **)** |
|
| void | :ref:`set_angular_damp<class_Area2D_set_angular_damp>` **(** :ref:`float<class_float>` angular_damp **)** |
|
||||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -135,7 +135,7 @@ Member Variables
|
|||||||
- :ref:`float<class_float>` **linear_damp**
|
- :ref:`float<class_float>` **linear_damp**
|
||||||
- :ref:`bool<class_bool>` **monitorable**
|
- :ref:`bool<class_bool>` **monitorable**
|
||||||
- :ref:`bool<class_bool>` **monitoring**
|
- :ref:`bool<class_bool>` **monitoring**
|
||||||
- :ref:`int<class_int>` **priority**
|
- :ref:`float<class_float>` **priority**
|
||||||
- :ref:`int<class_int>` **space_override**
|
- :ref:`int<class_int>` **space_override**
|
||||||
|
|
||||||
Description
|
Description
|
||||||
@@ -252,13 +252,13 @@ Return whether this area detects bodies/areas entering/exiting it.
|
|||||||
|
|
||||||
.. _class_Area2D_overlaps_area:
|
.. _class_Area2D_overlaps_area:
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **overlaps_area** **(** :ref:`Object<class_object>` area **)** const
|
- :ref:`bool<class_bool>` **overlaps_area** **(** :ref:`Node<class_node>` area **)** const
|
||||||
|
|
||||||
Return whether the area passed is totally or partially inside this area.
|
Return whether the area passed is totally or partially inside this area.
|
||||||
|
|
||||||
.. _class_Area2D_overlaps_body:
|
.. _class_Area2D_overlaps_body:
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **overlaps_body** **(** :ref:`Object<class_object>` body **)** const
|
- :ref:`bool<class_bool>` **overlaps_body** **(** :ref:`Node<class_node>` body **)** const
|
||||||
|
|
||||||
Return whether the body passed is totally or partially inside this area.
|
Return whether the body passed is totally or partially inside this area.
|
||||||
|
|
||||||
@@ -358,7 +358,7 @@ Set whether this area can detect bodies/areas entering/exiting it.
|
|||||||
|
|
||||||
- void **set_priority** **(** :ref:`float<class_float>` 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.
|
Set the order in which the area is processed. Greater values mean the area gets processed first. This is useful for areas which have a 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.
|
Areas with the same priority value get evaluated in an unpredictable order, and should be differentiated if evaluation order is to be important.
|
||||||
|
|
||||||
|
|||||||
@@ -18,49 +18,49 @@ Brief Description
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`add_blend_shape<class_ArrayMesh_add_blend_shape>` **(** :ref:`String<class_string>` name **)** |
|
| void | :ref:`add_blend_shape<class_ArrayMesh_add_blend_shape>` **(** :ref:`String<class_string>` name **)** |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`add_surface_from_arrays<class_ArrayMesh_add_surface_from_arrays>` **(** :ref:`int<class_int>` primitive, :ref:`Array<class_array>` arrays, :ref:`Array<class_array>` blend_shapes=[], :ref:`int<class_int>` compress_flags=97792 **)** |
|
| void | :ref:`add_surface_from_arrays<class_ArrayMesh_add_surface_from_arrays>` **(** :ref:`int<class_int>` primitive, :ref:`Array<class_array>` arrays, :ref:`Array<class_array>` blend_shapes=null, :ref:`int<class_int>` compress_flags=null **)** |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`center_geometry<class_ArrayMesh_center_geometry>` **(** **)** |
|
| void | :ref:`center_geometry<class_ArrayMesh_center_geometry>` **(** **)** |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`clear_blend_shapes<class_ArrayMesh_clear_blend_shapes>` **(** **)** |
|
| void | :ref:`clear_blend_shapes<class_ArrayMesh_clear_blend_shapes>` **(** **)** |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_blend_shape_count<class_ArrayMesh_get_blend_shape_count>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_blend_shape_count<class_ArrayMesh_get_blend_shape_count>` **(** **)** const |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_blend_shape_mode<class_ArrayMesh_get_blend_shape_mode>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_blend_shape_mode<class_ArrayMesh_get_blend_shape_mode>` **(** **)** const |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`get_blend_shape_name<class_ArrayMesh_get_blend_shape_name>` **(** :ref:`int<class_int>` index **)** const |
|
| :ref:`String<class_string>` | :ref:`get_blend_shape_name<class_ArrayMesh_get_blend_shape_name>` **(** :ref:`int<class_int>` index **)** const |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Rect3<class_rect3>` | :ref:`get_custom_aabb<class_ArrayMesh_get_custom_aabb>` **(** **)** const |
|
| :ref:`Rect3<class_rect3>` | :ref:`get_custom_aabb<class_ArrayMesh_get_custom_aabb>` **(** **)** const |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_surface_count<class_ArrayMesh_get_surface_count>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_surface_count<class_ArrayMesh_get_surface_count>` **(** **)** const |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`regen_normalmaps<class_ArrayMesh_regen_normalmaps>` **(** **)** |
|
| void | :ref:`regen_normalmaps<class_ArrayMesh_regen_normalmaps>` **(** **)** |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_blend_shape_mode<class_ArrayMesh_set_blend_shape_mode>` **(** :ref:`int<class_int>` mode **)** |
|
| void | :ref:`set_blend_shape_mode<class_ArrayMesh_set_blend_shape_mode>` **(** :ref:`int<class_int>` mode **)** |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_custom_aabb<class_ArrayMesh_set_custom_aabb>` **(** :ref:`Rect3<class_rect3>` aabb **)** |
|
| void | :ref:`set_custom_aabb<class_ArrayMesh_set_custom_aabb>` **(** :ref:`Rect3<class_rect3>` aabb **)** |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`surface_get_array_index_len<class_ArrayMesh_surface_get_array_index_len>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
| :ref:`int<class_int>` | :ref:`surface_get_array_index_len<class_ArrayMesh_surface_get_array_index_len>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`surface_get_array_len<class_ArrayMesh_surface_get_array_len>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
| :ref:`int<class_int>` | :ref:`surface_get_array_len<class_ArrayMesh_surface_get_array_len>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`surface_get_format<class_ArrayMesh_surface_get_format>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
| :ref:`int<class_int>` | :ref:`surface_get_format<class_ArrayMesh_surface_get_format>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Material<class_material>` | :ref:`surface_get_material<class_ArrayMesh_surface_get_material>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
| :ref:`Material<class_material>` | :ref:`surface_get_material<class_ArrayMesh_surface_get_material>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`surface_get_name<class_ArrayMesh_surface_get_name>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
| :ref:`String<class_string>` | :ref:`surface_get_name<class_ArrayMesh_surface_get_name>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`surface_get_primitive_type<class_ArrayMesh_surface_get_primitive_type>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
| :ref:`int<class_int>` | :ref:`surface_get_primitive_type<class_ArrayMesh_surface_get_primitive_type>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`surface_remove<class_ArrayMesh_surface_remove>` **(** :ref:`int<class_int>` surf_idx **)** |
|
| void | :ref:`surface_remove<class_ArrayMesh_surface_remove>` **(** :ref:`int<class_int>` surf_idx **)** |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`surface_set_material<class_ArrayMesh_surface_set_material>` **(** :ref:`int<class_int>` surf_idx, :ref:`Material<class_material>` material **)** |
|
| void | :ref:`surface_set_material<class_ArrayMesh_surface_set_material>` **(** :ref:`int<class_int>` surf_idx, :ref:`Material<class_material>` material **)** |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`surface_set_name<class_ArrayMesh_surface_set_name>` **(** :ref:`int<class_int>` surf_idx, :ref:`String<class_string>` name **)** |
|
| void | :ref:`surface_set_name<class_ArrayMesh_surface_set_name>` **(** :ref:`int<class_int>` surf_idx, :ref:`String<class_string>` name **)** |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Numeric Constants
|
Numeric Constants
|
||||||
-----------------
|
-----------------
|
||||||
@@ -76,6 +76,7 @@ Numeric Constants
|
|||||||
- **ARRAY_BONES** = **6** --- Array of bone indices, as a float array. Each element in groups of 4 floats.
|
- **ARRAY_BONES** = **6** --- Array of bone indices, as a float array. Each element in groups of 4 floats.
|
||||||
- **ARRAY_WEIGHTS** = **7** --- Array of bone weights, as a float array. Each element in groups of 4 floats.
|
- **ARRAY_WEIGHTS** = **7** --- Array of bone weights, as a float array. Each element in groups of 4 floats.
|
||||||
- **ARRAY_INDEX** = **8** --- Array of integers, used as indices referencing vertices. No index can be beyond the vertex array size.
|
- **ARRAY_INDEX** = **8** --- Array of integers, used as indices referencing vertices. No index can be beyond the vertex array size.
|
||||||
|
- **ARRAY_MAX** = **9**
|
||||||
- **ARRAY_FORMAT_VERTEX** = **1** --- Array format will include vertices (mandatory).
|
- **ARRAY_FORMAT_VERTEX** = **1** --- Array format will include vertices (mandatory).
|
||||||
- **ARRAY_FORMAT_NORMAL** = **2** --- Array format will include normals
|
- **ARRAY_FORMAT_NORMAL** = **2** --- Array format will include normals
|
||||||
- **ARRAY_FORMAT_TANGENT** = **4** --- Array format will include tangents
|
- **ARRAY_FORMAT_TANGENT** = **4** --- Array format will include tangents
|
||||||
@@ -95,7 +96,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_ArrayMesh_add_surface_from_arrays:
|
.. _class_ArrayMesh_add_surface_from_arrays:
|
||||||
|
|
||||||
- void **add_surface_from_arrays** **(** :ref:`int<class_int>` primitive, :ref:`Array<class_array>` arrays, :ref:`Array<class_array>` blend_shapes=[], :ref:`int<class_int>` compress_flags=97792 **)**
|
- void **add_surface_from_arrays** **(** :ref:`int<class_int>` primitive, :ref:`Array<class_array>` arrays, :ref:`Array<class_array>` blend_shapes=null, :ref:`int<class_int>` compress_flags=null **)**
|
||||||
|
|
||||||
Create a new surface (:ref:`get_surface_count<class_ArrayMesh_get_surface_count>` that will become surf_idx for this.
|
Create a new surface (:ref:`get_surface_count<class_ArrayMesh_get_surface_count>` that will become surf_idx for this.
|
||||||
|
|
||||||
|
|||||||
61
classes/class_arvranchor.rst
Normal file
61
classes/class_arvranchor.rst
Normal file
@@ -0,0 +1,61 @@
|
|||||||
|
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
||||||
|
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
|
||||||
|
|
||||||
|
.. _class_ARVRAnchor:
|
||||||
|
|
||||||
|
ARVRAnchor
|
||||||
|
==========
|
||||||
|
|
||||||
|
**Inherits:** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
|
||||||
|
|
||||||
|
**Category:** Core
|
||||||
|
|
||||||
|
Brief Description
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Member Functions
|
||||||
|
----------------
|
||||||
|
|
||||||
|
+--------------------------------+----------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`int<class_int>` | :ref:`get_anchor_id<class_ARVRAnchor_get_anchor_id>` **(** **)** const |
|
||||||
|
+--------------------------------+----------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`String<class_string>` | :ref:`get_anchor_name<class_ARVRAnchor_get_anchor_name>` **(** **)** const |
|
||||||
|
+--------------------------------+----------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`bool<class_bool>` | :ref:`get_is_active<class_ARVRAnchor_get_is_active>` **(** **)** const |
|
||||||
|
+--------------------------------+----------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`Vector3<class_vector3>` | :ref:`get_size<class_ARVRAnchor_get_size>` **(** **)** const |
|
||||||
|
+--------------------------------+----------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`set_anchor_id<class_ARVRAnchor_set_anchor_id>` **(** :ref:`int<class_int>` anchor_id **)** |
|
||||||
|
+--------------------------------+----------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
|
Member Variables
|
||||||
|
----------------
|
||||||
|
|
||||||
|
- :ref:`int<class_int>` **anchor_id**
|
||||||
|
|
||||||
|
Member Function Description
|
||||||
|
---------------------------
|
||||||
|
|
||||||
|
.. _class_ARVRAnchor_get_anchor_id:
|
||||||
|
|
||||||
|
- :ref:`int<class_int>` **get_anchor_id** **(** **)** const
|
||||||
|
|
||||||
|
.. _class_ARVRAnchor_get_anchor_name:
|
||||||
|
|
||||||
|
- :ref:`String<class_string>` **get_anchor_name** **(** **)** const
|
||||||
|
|
||||||
|
.. _class_ARVRAnchor_get_is_active:
|
||||||
|
|
||||||
|
- :ref:`bool<class_bool>` **get_is_active** **(** **)** const
|
||||||
|
|
||||||
|
.. _class_ARVRAnchor_get_size:
|
||||||
|
|
||||||
|
- :ref:`Vector3<class_vector3>` **get_size** **(** **)** const
|
||||||
|
|
||||||
|
.. _class_ARVRAnchor_set_anchor_id:
|
||||||
|
|
||||||
|
- void **set_anchor_id** **(** :ref:`int<class_int>` anchor_id **)**
|
||||||
|
|
||||||
|
|
||||||
17
classes/class_arvrcamera.rst
Normal file
17
classes/class_arvrcamera.rst
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
||||||
|
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
|
||||||
|
|
||||||
|
.. _class_ARVRCamera:
|
||||||
|
|
||||||
|
ARVRCamera
|
||||||
|
==========
|
||||||
|
|
||||||
|
**Inherits:** :ref:`Camera<class_camera>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
|
||||||
|
|
||||||
|
**Category:** Core
|
||||||
|
|
||||||
|
Brief Description
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
79
classes/class_arvrcontroller.rst
Normal file
79
classes/class_arvrcontroller.rst
Normal file
@@ -0,0 +1,79 @@
|
|||||||
|
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
||||||
|
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
|
||||||
|
|
||||||
|
.. _class_ARVRController:
|
||||||
|
|
||||||
|
ARVRController
|
||||||
|
==============
|
||||||
|
|
||||||
|
**Inherits:** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
|
||||||
|
|
||||||
|
**Category:** Core
|
||||||
|
|
||||||
|
Brief Description
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Member Functions
|
||||||
|
----------------
|
||||||
|
|
||||||
|
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`int<class_int>` | :ref:`get_controller_id<class_ARVRController_get_controller_id>` **(** **)** const |
|
||||||
|
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`String<class_string>` | :ref:`get_controller_name<class_ARVRController_get_controller_name>` **(** **)** const |
|
||||||
|
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`bool<class_bool>` | :ref:`get_is_active<class_ARVRController_get_is_active>` **(** **)** const |
|
||||||
|
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`float<class_float>` | :ref:`get_joystick_axis<class_ARVRController_get_joystick_axis>` **(** :ref:`int<class_int>` axis **)** const |
|
||||||
|
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`int<class_int>` | :ref:`get_joystick_id<class_ARVRController_get_joystick_id>` **(** **)** const |
|
||||||
|
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`int<class_int>` | :ref:`is_button_pressed<class_ARVRController_is_button_pressed>` **(** :ref:`int<class_int>` button **)** const |
|
||||||
|
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`set_controller_id<class_ARVRController_set_controller_id>` **(** :ref:`int<class_int>` controller_id **)** |
|
||||||
|
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
|
Signals
|
||||||
|
-------
|
||||||
|
|
||||||
|
- **button_pressed** **(** :ref:`int<class_int>` button **)**
|
||||||
|
- **button_release** **(** :ref:`int<class_int>` button **)**
|
||||||
|
|
||||||
|
Member Variables
|
||||||
|
----------------
|
||||||
|
|
||||||
|
- :ref:`int<class_int>` **controller_id**
|
||||||
|
|
||||||
|
Member Function Description
|
||||||
|
---------------------------
|
||||||
|
|
||||||
|
.. _class_ARVRController_get_controller_id:
|
||||||
|
|
||||||
|
- :ref:`int<class_int>` **get_controller_id** **(** **)** const
|
||||||
|
|
||||||
|
.. _class_ARVRController_get_controller_name:
|
||||||
|
|
||||||
|
- :ref:`String<class_string>` **get_controller_name** **(** **)** const
|
||||||
|
|
||||||
|
.. _class_ARVRController_get_is_active:
|
||||||
|
|
||||||
|
- :ref:`bool<class_bool>` **get_is_active** **(** **)** const
|
||||||
|
|
||||||
|
.. _class_ARVRController_get_joystick_axis:
|
||||||
|
|
||||||
|
- :ref:`float<class_float>` **get_joystick_axis** **(** :ref:`int<class_int>` axis **)** const
|
||||||
|
|
||||||
|
.. _class_ARVRController_get_joystick_id:
|
||||||
|
|
||||||
|
- :ref:`int<class_int>` **get_joystick_id** **(** **)** const
|
||||||
|
|
||||||
|
.. _class_ARVRController_is_button_pressed:
|
||||||
|
|
||||||
|
- :ref:`int<class_int>` **is_button_pressed** **(** :ref:`int<class_int>` button **)** const
|
||||||
|
|
||||||
|
.. _class_ARVRController_set_controller_id:
|
||||||
|
|
||||||
|
- void **set_controller_id** **(** :ref:`int<class_int>` controller_id **)**
|
||||||
|
|
||||||
|
|
||||||
100
classes/class_arvrinterface.rst
Normal file
100
classes/class_arvrinterface.rst
Normal file
@@ -0,0 +1,100 @@
|
|||||||
|
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
||||||
|
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
|
||||||
|
|
||||||
|
.. _class_ARVRInterface:
|
||||||
|
|
||||||
|
ARVRInterface
|
||||||
|
=============
|
||||||
|
|
||||||
|
**Inherits:** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||||
|
|
||||||
|
**Inherited By:** :ref:`ARVRScriptInterface<class_arvrscriptinterface>`
|
||||||
|
|
||||||
|
**Category:** Core
|
||||||
|
|
||||||
|
Brief Description
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Member Functions
|
||||||
|
----------------
|
||||||
|
|
||||||
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`String<class_string>` | :ref:`get_name<class_ARVRInterface_get_name>` **(** **)** const |
|
||||||
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`Vector2<class_vector2>` | :ref:`get_recommended_render_targetsize<class_ARVRInterface_get_recommended_render_targetsize>` **(** **)** |
|
||||||
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`bool<class_bool>` | :ref:`hmd_is_present<class_ARVRInterface_hmd_is_present>` **(** **)** |
|
||||||
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`bool<class_bool>` | :ref:`initialize<class_ARVRInterface_initialize>` **(** **)** |
|
||||||
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`bool<class_bool>` | :ref:`is_initialized<class_ARVRInterface_is_initialized>` **(** **)** |
|
||||||
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`bool<class_bool>` | :ref:`is_installed<class_ARVRInterface_is_installed>` **(** **)** |
|
||||||
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`bool<class_bool>` | :ref:`is_primary<class_ARVRInterface_is_primary>` **(** **)** |
|
||||||
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`set_is_primary<class_ARVRInterface_set_is_primary>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||||
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`bool<class_bool>` | :ref:`supports_hmd<class_ARVRInterface_supports_hmd>` **(** **)** |
|
||||||
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`uninitialize<class_ARVRInterface_uninitialize>` **(** **)** |
|
||||||
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
|
Member Variables
|
||||||
|
----------------
|
||||||
|
|
||||||
|
- :ref:`bool<class_bool>` **primary**
|
||||||
|
|
||||||
|
Numeric Constants
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
- **EYE_MONO** = **0**
|
||||||
|
- **EYE_LEFT** = **1**
|
||||||
|
- **EYE_RIGHT** = **2**
|
||||||
|
|
||||||
|
Member Function Description
|
||||||
|
---------------------------
|
||||||
|
|
||||||
|
.. _class_ARVRInterface_get_name:
|
||||||
|
|
||||||
|
- :ref:`String<class_string>` **get_name** **(** **)** const
|
||||||
|
|
||||||
|
.. _class_ARVRInterface_get_recommended_render_targetsize:
|
||||||
|
|
||||||
|
- :ref:`Vector2<class_vector2>` **get_recommended_render_targetsize** **(** **)**
|
||||||
|
|
||||||
|
.. _class_ARVRInterface_hmd_is_present:
|
||||||
|
|
||||||
|
- :ref:`bool<class_bool>` **hmd_is_present** **(** **)**
|
||||||
|
|
||||||
|
.. _class_ARVRInterface_initialize:
|
||||||
|
|
||||||
|
- :ref:`bool<class_bool>` **initialize** **(** **)**
|
||||||
|
|
||||||
|
.. _class_ARVRInterface_is_initialized:
|
||||||
|
|
||||||
|
- :ref:`bool<class_bool>` **is_initialized** **(** **)**
|
||||||
|
|
||||||
|
.. _class_ARVRInterface_is_installed:
|
||||||
|
|
||||||
|
- :ref:`bool<class_bool>` **is_installed** **(** **)**
|
||||||
|
|
||||||
|
.. _class_ARVRInterface_is_primary:
|
||||||
|
|
||||||
|
- :ref:`bool<class_bool>` **is_primary** **(** **)**
|
||||||
|
|
||||||
|
.. _class_ARVRInterface_set_is_primary:
|
||||||
|
|
||||||
|
- void **set_is_primary** **(** :ref:`bool<class_bool>` enable **)**
|
||||||
|
|
||||||
|
.. _class_ARVRInterface_supports_hmd:
|
||||||
|
|
||||||
|
- :ref:`bool<class_bool>` **supports_hmd** **(** **)**
|
||||||
|
|
||||||
|
.. _class_ARVRInterface_uninitialize:
|
||||||
|
|
||||||
|
- void **uninitialize** **(** **)**
|
||||||
|
|
||||||
|
|
||||||
43
classes/class_arvrorigin.rst
Normal file
43
classes/class_arvrorigin.rst
Normal file
@@ -0,0 +1,43 @@
|
|||||||
|
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
||||||
|
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
|
||||||
|
|
||||||
|
.. _class_ARVROrigin:
|
||||||
|
|
||||||
|
ARVROrigin
|
||||||
|
==========
|
||||||
|
|
||||||
|
**Inherits:** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
|
||||||
|
|
||||||
|
**Category:** Core
|
||||||
|
|
||||||
|
Brief Description
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Member Functions
|
||||||
|
----------------
|
||||||
|
|
||||||
|
+----------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`float<class_float>` | :ref:`get_world_scale<class_ARVROrigin_get_world_scale>` **(** **)** const |
|
||||||
|
+----------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`set_world_scale<class_ARVROrigin_set_world_scale>` **(** :ref:`float<class_float>` world_scale **)** |
|
||||||
|
+----------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
|
Member Variables
|
||||||
|
----------------
|
||||||
|
|
||||||
|
- :ref:`float<class_float>` **world_scale**
|
||||||
|
|
||||||
|
Member Function Description
|
||||||
|
---------------------------
|
||||||
|
|
||||||
|
.. _class_ARVROrigin_get_world_scale:
|
||||||
|
|
||||||
|
- :ref:`float<class_float>` **get_world_scale** **(** **)** const
|
||||||
|
|
||||||
|
.. _class_ARVROrigin_set_world_scale:
|
||||||
|
|
||||||
|
- void **set_world_scale** **(** :ref:`float<class_float>` world_scale **)**
|
||||||
|
|
||||||
|
|
||||||
74
classes/class_arvrpositionaltracker.rst
Normal file
74
classes/class_arvrpositionaltracker.rst
Normal file
@@ -0,0 +1,74 @@
|
|||||||
|
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
||||||
|
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
|
||||||
|
|
||||||
|
.. _class_ARVRPositionalTracker:
|
||||||
|
|
||||||
|
ARVRPositionalTracker
|
||||||
|
=====================
|
||||||
|
|
||||||
|
**Inherits:** :ref:`Object<class_object>`
|
||||||
|
|
||||||
|
**Category:** Core
|
||||||
|
|
||||||
|
Brief Description
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Member Functions
|
||||||
|
----------------
|
||||||
|
|
||||||
|
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`int<class_int>` | :ref:`get_joy_id<class_ARVRPositionalTracker_get_joy_id>` **(** **)** const |
|
||||||
|
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`String<class_string>` | :ref:`get_name<class_ARVRPositionalTracker_get_name>` **(** **)** const |
|
||||||
|
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`Basis<class_basis>` | :ref:`get_orientation<class_ARVRPositionalTracker_get_orientation>` **(** **)** const |
|
||||||
|
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`Vector3<class_vector3>` | :ref:`get_position<class_ARVRPositionalTracker_get_position>` **(** **)** const |
|
||||||
|
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`bool<class_bool>` | :ref:`get_tracks_orientation<class_ARVRPositionalTracker_get_tracks_orientation>` **(** **)** const |
|
||||||
|
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`bool<class_bool>` | :ref:`get_tracks_position<class_ARVRPositionalTracker_get_tracks_position>` **(** **)** const |
|
||||||
|
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`Transform<class_transform>` | :ref:`get_transform<class_ARVRPositionalTracker_get_transform>` **(** :ref:`bool<class_bool>` adjust_by_reference_frame **)** const |
|
||||||
|
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`int<class_int>` | :ref:`get_type<class_ARVRPositionalTracker_get_type>` **(** **)** const |
|
||||||
|
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
|
Member Function Description
|
||||||
|
---------------------------
|
||||||
|
|
||||||
|
.. _class_ARVRPositionalTracker_get_joy_id:
|
||||||
|
|
||||||
|
- :ref:`int<class_int>` **get_joy_id** **(** **)** const
|
||||||
|
|
||||||
|
.. _class_ARVRPositionalTracker_get_name:
|
||||||
|
|
||||||
|
- :ref:`String<class_string>` **get_name** **(** **)** const
|
||||||
|
|
||||||
|
.. _class_ARVRPositionalTracker_get_orientation:
|
||||||
|
|
||||||
|
- :ref:`Basis<class_basis>` **get_orientation** **(** **)** const
|
||||||
|
|
||||||
|
.. _class_ARVRPositionalTracker_get_position:
|
||||||
|
|
||||||
|
- :ref:`Vector3<class_vector3>` **get_position** **(** **)** const
|
||||||
|
|
||||||
|
.. _class_ARVRPositionalTracker_get_tracks_orientation:
|
||||||
|
|
||||||
|
- :ref:`bool<class_bool>` **get_tracks_orientation** **(** **)** const
|
||||||
|
|
||||||
|
.. _class_ARVRPositionalTracker_get_tracks_position:
|
||||||
|
|
||||||
|
- :ref:`bool<class_bool>` **get_tracks_position** **(** **)** const
|
||||||
|
|
||||||
|
.. _class_ARVRPositionalTracker_get_transform:
|
||||||
|
|
||||||
|
- :ref:`Transform<class_transform>` **get_transform** **(** :ref:`bool<class_bool>` adjust_by_reference_frame **)** const
|
||||||
|
|
||||||
|
.. _class_ARVRPositionalTracker_get_type:
|
||||||
|
|
||||||
|
- :ref:`int<class_int>` **get_type** **(** **)** const
|
||||||
|
|
||||||
|
|
||||||
98
classes/class_arvrscriptinterface.rst
Normal file
98
classes/class_arvrscriptinterface.rst
Normal file
@@ -0,0 +1,98 @@
|
|||||||
|
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
||||||
|
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
|
||||||
|
|
||||||
|
.. _class_ARVRScriptInterface:
|
||||||
|
|
||||||
|
ARVRScriptInterface
|
||||||
|
===================
|
||||||
|
|
||||||
|
**Inherits:** :ref:`ARVRInterface<class_arvrinterface>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||||
|
|
||||||
|
**Category:** Core
|
||||||
|
|
||||||
|
Brief Description
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Member Functions
|
||||||
|
----------------
|
||||||
|
|
||||||
|
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`_get_projection_for_eye<class_ARVRScriptInterface__get_projection_for_eye>` **(** **)** virtual |
|
||||||
|
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`commit_for_eye<class_ARVRScriptInterface_commit_for_eye>` **(** :ref:`int<class_int>` eye, :ref:`RID<class_rid>` render_target **)** virtual |
|
||||||
|
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`Vector2<class_vector2>` | :ref:`get_recommended_render_targetsize<class_ARVRScriptInterface_get_recommended_render_targetsize>` **(** **)** virtual |
|
||||||
|
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`Transform<class_transform>` | :ref:`get_transform_for_eye<class_ARVRScriptInterface_get_transform_for_eye>` **(** :ref:`int<class_int>` eye, :ref:`Transform<class_transform>` cam_transform **)** virtual |
|
||||||
|
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`bool<class_bool>` | :ref:`hmd_is_present<class_ARVRScriptInterface_hmd_is_present>` **(** **)** virtual |
|
||||||
|
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`bool<class_bool>` | :ref:`initialize<class_ARVRScriptInterface_initialize>` **(** **)** virtual |
|
||||||
|
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`bool<class_bool>` | :ref:`is_initialized<class_ARVRScriptInterface_is_initialized>` **(** **)** virtual |
|
||||||
|
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`bool<class_bool>` | :ref:`is_installed<class_ARVRScriptInterface_is_installed>` **(** **)** virtual |
|
||||||
|
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`bool<class_bool>` | :ref:`is_stereo<class_ARVRScriptInterface_is_stereo>` **(** **)** virtual |
|
||||||
|
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`process<class_ARVRScriptInterface_process>` **(** **)** virtual |
|
||||||
|
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`bool<class_bool>` | :ref:`supports_hmd<class_ARVRScriptInterface_supports_hmd>` **(** **)** virtual |
|
||||||
|
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`uninitialize<class_ARVRScriptInterface_uninitialize>` **(** **)** virtual |
|
||||||
|
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
|
Member Function Description
|
||||||
|
---------------------------
|
||||||
|
|
||||||
|
.. _class_ARVRScriptInterface__get_projection_for_eye:
|
||||||
|
|
||||||
|
- void **_get_projection_for_eye** **(** **)** virtual
|
||||||
|
|
||||||
|
.. _class_ARVRScriptInterface_commit_for_eye:
|
||||||
|
|
||||||
|
- void **commit_for_eye** **(** :ref:`int<class_int>` eye, :ref:`RID<class_rid>` render_target **)** virtual
|
||||||
|
|
||||||
|
.. _class_ARVRScriptInterface_get_recommended_render_targetsize:
|
||||||
|
|
||||||
|
- :ref:`Vector2<class_vector2>` **get_recommended_render_targetsize** **(** **)** virtual
|
||||||
|
|
||||||
|
.. _class_ARVRScriptInterface_get_transform_for_eye:
|
||||||
|
|
||||||
|
- :ref:`Transform<class_transform>` **get_transform_for_eye** **(** :ref:`int<class_int>` eye, :ref:`Transform<class_transform>` cam_transform **)** virtual
|
||||||
|
|
||||||
|
.. _class_ARVRScriptInterface_hmd_is_present:
|
||||||
|
|
||||||
|
- :ref:`bool<class_bool>` **hmd_is_present** **(** **)** virtual
|
||||||
|
|
||||||
|
.. _class_ARVRScriptInterface_initialize:
|
||||||
|
|
||||||
|
- :ref:`bool<class_bool>` **initialize** **(** **)** virtual
|
||||||
|
|
||||||
|
.. _class_ARVRScriptInterface_is_initialized:
|
||||||
|
|
||||||
|
- :ref:`bool<class_bool>` **is_initialized** **(** **)** virtual
|
||||||
|
|
||||||
|
.. _class_ARVRScriptInterface_is_installed:
|
||||||
|
|
||||||
|
- :ref:`bool<class_bool>` **is_installed** **(** **)** virtual
|
||||||
|
|
||||||
|
.. _class_ARVRScriptInterface_is_stereo:
|
||||||
|
|
||||||
|
- :ref:`bool<class_bool>` **is_stereo** **(** **)** virtual
|
||||||
|
|
||||||
|
.. _class_ARVRScriptInterface_process:
|
||||||
|
|
||||||
|
- void **process** **(** **)** virtual
|
||||||
|
|
||||||
|
.. _class_ARVRScriptInterface_supports_hmd:
|
||||||
|
|
||||||
|
- :ref:`bool<class_bool>` **supports_hmd** **(** **)** virtual
|
||||||
|
|
||||||
|
.. _class_ARVRScriptInterface_uninitialize:
|
||||||
|
|
||||||
|
- void **uninitialize** **(** **)** virtual
|
||||||
|
|
||||||
|
|
||||||
121
classes/class_arvrserver.rst
Normal file
121
classes/class_arvrserver.rst
Normal file
@@ -0,0 +1,121 @@
|
|||||||
|
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
||||||
|
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
|
||||||
|
|
||||||
|
.. _class_ARVRServer:
|
||||||
|
|
||||||
|
ARVRServer
|
||||||
|
==========
|
||||||
|
|
||||||
|
**Inherits:** :ref:`Object<class_object>`
|
||||||
|
|
||||||
|
**Category:** Core
|
||||||
|
|
||||||
|
Brief Description
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Member Functions
|
||||||
|
----------------
|
||||||
|
|
||||||
|
+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`add_interface<class_ARVRServer_add_interface>` **(** :ref:`ARVRInterface<class_arvrinterface>` arg0 **)** |
|
||||||
|
+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`ARVRInterface<class_arvrinterface>` | :ref:`find_interface<class_ARVRServer_find_interface>` **(** :ref:`String<class_string>` name **)** const |
|
||||||
|
+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`ARVRInterface<class_arvrinterface>` | :ref:`get_interface<class_ARVRServer_get_interface>` **(** :ref:`int<class_int>` idx **)** const |
|
||||||
|
+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`int<class_int>` | :ref:`get_interface_count<class_ARVRServer_get_interface_count>` **(** **)** const |
|
||||||
|
+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`Transform<class_transform>` | :ref:`get_reference_frame<class_ARVRServer_get_reference_frame>` **(** **)** const |
|
||||||
|
+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`ARVRPositionalTracker<class_arvrpositionaltracker>` | :ref:`get_tracker<class_ARVRServer_get_tracker>` **(** :ref:`int<class_int>` idx **)** const |
|
||||||
|
+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`int<class_int>` | :ref:`get_tracker_count<class_ARVRServer_get_tracker_count>` **(** **)** const |
|
||||||
|
+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`float<class_float>` | :ref:`get_world_scale<class_ARVRServer_get_world_scale>` **(** **)** const |
|
||||||
|
+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`remove_interface<class_ARVRServer_remove_interface>` **(** :ref:`ARVRInterface<class_arvrinterface>` arg0 **)** |
|
||||||
|
+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`request_reference_frame<class_ARVRServer_request_reference_frame>` **(** :ref:`bool<class_bool>` ignore_tilt, :ref:`bool<class_bool>` keep_height **)** |
|
||||||
|
+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`set_primary_interface<class_ARVRServer_set_primary_interface>` **(** :ref:`ARVRInterface<class_arvrinterface>` arg0 **)** |
|
||||||
|
+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`set_world_scale<class_ARVRServer_set_world_scale>` **(** :ref:`float<class_float>` arg0 **)** |
|
||||||
|
+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
|
Signals
|
||||||
|
-------
|
||||||
|
|
||||||
|
- **interface_added** **(** :ref:`String<class_string>` name **)**
|
||||||
|
- **interface_removed** **(** :ref:`String<class_string>` name **)**
|
||||||
|
- **tracker_added** **(** :ref:`String<class_string>` name, :ref:`int<class_int>` type **)**
|
||||||
|
- **tracker_removed** **(** :ref:`String<class_string>` name **)**
|
||||||
|
|
||||||
|
Member Variables
|
||||||
|
----------------
|
||||||
|
|
||||||
|
- :ref:`float<class_float>` **world_scale**
|
||||||
|
|
||||||
|
Numeric Constants
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
- **TRACKER_CONTROLLER** = **1**
|
||||||
|
- **TRACKER_BASESTATION** = **2**
|
||||||
|
- **TRACKER_ANCHOR** = **4**
|
||||||
|
- **TRACKER_UNKNOWN** = **128**
|
||||||
|
- **TRACKER_ANY_KNOWN** = **127**
|
||||||
|
- **TRACKER_ANY** = **255**
|
||||||
|
|
||||||
|
Member Function Description
|
||||||
|
---------------------------
|
||||||
|
|
||||||
|
.. _class_ARVRServer_add_interface:
|
||||||
|
|
||||||
|
- void **add_interface** **(** :ref:`ARVRInterface<class_arvrinterface>` arg0 **)**
|
||||||
|
|
||||||
|
.. _class_ARVRServer_find_interface:
|
||||||
|
|
||||||
|
- :ref:`ARVRInterface<class_arvrinterface>` **find_interface** **(** :ref:`String<class_string>` name **)** const
|
||||||
|
|
||||||
|
.. _class_ARVRServer_get_interface:
|
||||||
|
|
||||||
|
- :ref:`ARVRInterface<class_arvrinterface>` **get_interface** **(** :ref:`int<class_int>` idx **)** const
|
||||||
|
|
||||||
|
.. _class_ARVRServer_get_interface_count:
|
||||||
|
|
||||||
|
- :ref:`int<class_int>` **get_interface_count** **(** **)** const
|
||||||
|
|
||||||
|
.. _class_ARVRServer_get_reference_frame:
|
||||||
|
|
||||||
|
- :ref:`Transform<class_transform>` **get_reference_frame** **(** **)** const
|
||||||
|
|
||||||
|
.. _class_ARVRServer_get_tracker:
|
||||||
|
|
||||||
|
- :ref:`ARVRPositionalTracker<class_arvrpositionaltracker>` **get_tracker** **(** :ref:`int<class_int>` idx **)** const
|
||||||
|
|
||||||
|
.. _class_ARVRServer_get_tracker_count:
|
||||||
|
|
||||||
|
- :ref:`int<class_int>` **get_tracker_count** **(** **)** const
|
||||||
|
|
||||||
|
.. _class_ARVRServer_get_world_scale:
|
||||||
|
|
||||||
|
- :ref:`float<class_float>` **get_world_scale** **(** **)** const
|
||||||
|
|
||||||
|
.. _class_ARVRServer_remove_interface:
|
||||||
|
|
||||||
|
- void **remove_interface** **(** :ref:`ARVRInterface<class_arvrinterface>` arg0 **)**
|
||||||
|
|
||||||
|
.. _class_ARVRServer_request_reference_frame:
|
||||||
|
|
||||||
|
- void **request_reference_frame** **(** :ref:`bool<class_bool>` ignore_tilt, :ref:`bool<class_bool>` keep_height **)**
|
||||||
|
|
||||||
|
.. _class_ARVRServer_set_primary_interface:
|
||||||
|
|
||||||
|
- void **set_primary_interface** **(** :ref:`ARVRInterface<class_arvrinterface>` arg0 **)**
|
||||||
|
|
||||||
|
.. _class_ARVRServer_set_world_scale:
|
||||||
|
|
||||||
|
- void **set_world_scale** **(** :ref:`float<class_float>` arg0 **)**
|
||||||
|
|
||||||
|
|
||||||
@@ -23,13 +23,13 @@ Member Functions
|
|||||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`_estimate_cost<class_AStar__estimate_cost>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** virtual |
|
| void | :ref:`_estimate_cost<class_AStar__estimate_cost>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** virtual |
|
||||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`add_point<class_AStar_add_point>` **(** :ref:`int<class_int>` id, :ref:`Vector3<class_vector3>` pos, :ref:`float<class_float>` weight_scale=1 **)** |
|
| void | :ref:`add_point<class_AStar_add_point>` **(** :ref:`int<class_int>` id, :ref:`Vector3<class_vector3>` pos, :ref:`float<class_float>` weight_scale=null **)** |
|
||||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`are_points_connected<class_AStar_are_points_connected>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** const |
|
| :ref:`bool<class_bool>` | :ref:`are_points_connected<class_AStar_are_points_connected>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** const |
|
||||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`clear<class_AStar_clear>` **(** **)** |
|
| void | :ref:`clear<class_AStar_clear>` **(** **)** |
|
||||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`connect_points<class_AStar_connect_points>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id, :ref:`bool<class_bool>` bidirectional=true **)** |
|
| void | :ref:`connect_points<class_AStar_connect_points>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id, :ref:`bool<class_bool>` bidirectional=null **)** |
|
||||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`disconnect_points<class_AStar_disconnect_points>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** |
|
| void | :ref:`disconnect_points<class_AStar_disconnect_points>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** |
|
||||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -72,7 +72,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_AStar_add_point:
|
.. _class_AStar_add_point:
|
||||||
|
|
||||||
- void **add_point** **(** :ref:`int<class_int>` id, :ref:`Vector3<class_vector3>` pos, :ref:`float<class_float>` weight_scale=1 **)**
|
- void **add_point** **(** :ref:`int<class_int>` id, :ref:`Vector3<class_vector3>` pos, :ref:`float<class_float>` weight_scale=null **)**
|
||||||
|
|
||||||
Add a new point at the given position ``pos`` with the given identifier ``id``. The ``weight_scale`` has to be 1 or larger.
|
Add a new point at the given position ``pos`` with the given identifier ``id``. The ``weight_scale`` has to be 1 or larger.
|
||||||
|
|
||||||
@@ -90,7 +90,7 @@ Clear all the points and segments from AStar instance.
|
|||||||
|
|
||||||
.. _class_AStar_connect_points:
|
.. _class_AStar_connect_points:
|
||||||
|
|
||||||
- void **connect_points** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id, :ref:`bool<class_bool>` bidirectional=true **)**
|
- void **connect_points** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id, :ref:`bool<class_bool>` bidirectional=null **)**
|
||||||
|
|
||||||
Create a segment between points ``id`` and ``to_id``.
|
Create a segment between points ``id`` and ``to_id``.
|
||||||
|
|
||||||
|
|||||||
@@ -32,11 +32,6 @@ Member Functions
|
|||||||
| void | :ref:`set_region<class_AtlasTexture_set_region>` **(** :ref:`Rect2<class_rect2>` region **)** |
|
| void | :ref:`set_region<class_AtlasTexture_set_region>` **(** :ref:`Rect2<class_rect2>` region **)** |
|
||||||
+--------------------------------+--------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Signals
|
|
||||||
-------
|
|
||||||
|
|
||||||
- **atlas_changed** **(** **)**
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
|
|||||||
@@ -56,7 +56,7 @@ Member Variables
|
|||||||
- :ref:`float<class_float>` **mix**
|
- :ref:`float<class_float>` **mix**
|
||||||
- :ref:`float<class_float>` **ratio**
|
- :ref:`float<class_float>` **ratio**
|
||||||
- :ref:`float<class_float>` **release_ms**
|
- :ref:`float<class_float>` **release_ms**
|
||||||
- :ref:`float<class_float>` **sidechain**
|
- :ref:`String<class_string>` **sidechain**
|
||||||
- :ref:`float<class_float>` **threshold**
|
- :ref:`float<class_float>` **threshold**
|
||||||
|
|
||||||
Member Function Description
|
Member Function Description
|
||||||
|
|||||||
@@ -21,7 +21,7 @@ Member Functions
|
|||||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`add_bus<class_AudioServer_add_bus>` **(** :ref:`int<class_int>` at_pos=-1 **)** |
|
| void | :ref:`add_bus<class_AudioServer_add_bus>` **(** :ref:`int<class_int>` at_pos=-1 **)** |
|
||||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`add_bus_effect<class_AudioServer_add_bus_effect>` **(** :ref:`int<class_int>` bus_idx, :ref:`AudioEffect<class_audioeffect>` effect, :ref:`int<class_int>` arg2=-1 **)** |
|
| void | :ref:`add_bus_effect<class_AudioServer_add_bus_effect>` **(** :ref:`int<class_int>` bus_idx, :ref:`AudioEffect<class_audioeffect>` effect, :ref:`int<class_int>` at_pos=null **)** |
|
||||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`AudioBusLayout<class_audiobuslayout>` | :ref:`generate_bus_layout<class_AudioServer_generate_bus_layout>` **(** **)** const |
|
| :ref:`AudioBusLayout<class_audiobuslayout>` | :ref:`generate_bus_layout<class_AudioServer_generate_bus_layout>` **(** **)** const |
|
||||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -29,7 +29,7 @@ Member Functions
|
|||||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`AudioEffect<class_audioeffect>` | :ref:`get_bus_effect<class_AudioServer_get_bus_effect>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)** |
|
| :ref:`AudioEffect<class_audioeffect>` | :ref:`get_bus_effect<class_AudioServer_get_bus_effect>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)** |
|
||||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`get_bus_effect_count<class_AudioServer_get_bus_effect_count>` **(** :ref:`int<class_int>` bus_idx, :ref:`Object<class_object>` arg1, :ref:`int<class_int>` arg2 **)** |
|
| :ref:`int<class_int>` | :ref:`get_bus_effect_count<class_AudioServer_get_bus_effect_count>` **(** :ref:`int<class_int>` bus_idx **)** |
|
||||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_bus_index<class_AudioServer_get_bus_index>` **(** :ref:`String<class_string>` bus_name **)** const |
|
| :ref:`int<class_int>` | :ref:`get_bus_index<class_AudioServer_get_bus_index>` **(** :ref:`String<class_string>` bus_name **)** const |
|
||||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -105,7 +105,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_AudioServer_add_bus_effect:
|
.. _class_AudioServer_add_bus_effect:
|
||||||
|
|
||||||
- void **add_bus_effect** **(** :ref:`int<class_int>` bus_idx, :ref:`AudioEffect<class_audioeffect>` effect, :ref:`int<class_int>` arg2=-1 **)**
|
- void **add_bus_effect** **(** :ref:`int<class_int>` bus_idx, :ref:`AudioEffect<class_audioeffect>` effect, :ref:`int<class_int>` at_pos=null **)**
|
||||||
|
|
||||||
.. _class_AudioServer_generate_bus_layout:
|
.. _class_AudioServer_generate_bus_layout:
|
||||||
|
|
||||||
@@ -121,7 +121,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_AudioServer_get_bus_effect_count:
|
.. _class_AudioServer_get_bus_effect_count:
|
||||||
|
|
||||||
- void **get_bus_effect_count** **(** :ref:`int<class_int>` bus_idx, :ref:`Object<class_object>` arg1, :ref:`int<class_int>` arg2 **)**
|
- :ref:`int<class_int>` **get_bus_effect_count** **(** :ref:`int<class_int>` bus_idx **)**
|
||||||
|
|
||||||
.. _class_AudioServer_get_bus_index:
|
.. _class_AudioServer_get_bus_index:
|
||||||
|
|
||||||
|
|||||||
@@ -18,21 +18,26 @@ OGG Vorbis audio stream driver.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`PoolByteArray<class_poolbytearray>` | :ref:`get_data<class_AudioStreamOGGVorbis_get_data>` **(** **)** const |
|
| :ref:`PoolByteArray<class_poolbytearray>` | :ref:`get_data<class_AudioStreamOGGVorbis_get_data>` **(** **)** const |
|
||||||
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`has_loop<class_AudioStreamOGGVorbis_has_loop>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_loop_offset<class_AudioStreamOGGVorbis_get_loop_offset>` **(** **)** const |
|
||||||
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_data<class_AudioStreamOGGVorbis_set_data>` **(** :ref:`PoolByteArray<class_poolbytearray>` data **)** |
|
| :ref:`bool<class_bool>` | :ref:`has_loop<class_AudioStreamOGGVorbis_has_loop>` **(** **)** const |
|
||||||
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_loop<class_AudioStreamOGGVorbis_set_loop>` **(** :ref:`bool<class_bool>` enable **)** |
|
| void | :ref:`set_data<class_AudioStreamOGGVorbis_set_data>` **(** :ref:`PoolByteArray<class_poolbytearray>` data **)** |
|
||||||
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`set_loop<class_AudioStreamOGGVorbis_set_loop>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||||
|
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`set_loop_offset<class_AudioStreamOGGVorbis_set_loop_offset>` **(** :ref:`float<class_float>` seconds **)** |
|
||||||
|
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
- :ref:`PoolByteArray<class_poolbytearray>` **data**
|
- :ref:`PoolByteArray<class_poolbytearray>` **data**
|
||||||
- :ref:`bool<class_bool>` **loop**
|
- :ref:`bool<class_bool>` **loop**
|
||||||
|
- :ref:`float<class_float>` **loop_offset**
|
||||||
|
|
||||||
Description
|
Description
|
||||||
-----------
|
-----------
|
||||||
@@ -46,6 +51,10 @@ Member Function Description
|
|||||||
|
|
||||||
- :ref:`PoolByteArray<class_poolbytearray>` **get_data** **(** **)** const
|
- :ref:`PoolByteArray<class_poolbytearray>` **get_data** **(** **)** const
|
||||||
|
|
||||||
|
.. _class_AudioStreamOGGVorbis_get_loop_offset:
|
||||||
|
|
||||||
|
- :ref:`float<class_float>` **get_loop_offset** **(** **)** const
|
||||||
|
|
||||||
.. _class_AudioStreamOGGVorbis_has_loop:
|
.. _class_AudioStreamOGGVorbis_has_loop:
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **has_loop** **(** **)** const
|
- :ref:`bool<class_bool>` **has_loop** **(** **)** const
|
||||||
@@ -58,4 +67,8 @@ Member Function Description
|
|||||||
|
|
||||||
- void **set_loop** **(** :ref:`bool<class_bool>` enable **)**
|
- void **set_loop** **(** :ref:`bool<class_bool>` enable **)**
|
||||||
|
|
||||||
|
.. _class_AudioStreamOGGVorbis_set_loop_offset:
|
||||||
|
|
||||||
|
- void **set_loop_offset** **(** :ref:`float<class_float>` seconds **)**
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -18,37 +18,42 @@ Brief Description
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+------------------------------+------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`get_bus<class_AudioStreamPlayer_get_bus>` **(** **)** const |
|
| :ref:`String<class_string>` | :ref:`get_bus<class_AudioStreamPlayer_get_bus>` **(** **)** const |
|
||||||
+------------------------------+------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_mix_target<class_AudioStreamPlayer_get_mix_target>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_mix_target<class_AudioStreamPlayer_get_mix_target>` **(** **)** const |
|
||||||
+------------------------------+------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_pos<class_AudioStreamPlayer_get_pos>` **(** **)** |
|
| :ref:`float<class_float>` | :ref:`get_pos<class_AudioStreamPlayer_get_pos>` **(** **)** |
|
||||||
+------------------------------+------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Object<class_object>` | :ref:`get_stream<class_AudioStreamPlayer_get_stream>` **(** **)** const |
|
| :ref:`AudioStream<class_audiostream>` | :ref:`get_stream<class_AudioStreamPlayer_get_stream>` **(** **)** const |
|
||||||
+------------------------------+------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_volume_db<class_AudioStreamPlayer_get_volume_db>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_volume_db<class_AudioStreamPlayer_get_volume_db>` **(** **)** const |
|
||||||
+------------------------------+------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_autoplay_enabled<class_AudioStreamPlayer_is_autoplay_enabled>` **(** **)** |
|
| :ref:`bool<class_bool>` | :ref:`is_autoplay_enabled<class_AudioStreamPlayer_is_autoplay_enabled>` **(** **)** |
|
||||||
+------------------------------+------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AudioStreamPlayer_is_playing>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AudioStreamPlayer_is_playing>` **(** **)** const |
|
||||||
+------------------------------+------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`play<class_AudioStreamPlayer_play>` **(** :ref:`float<class_float>` from_pos=0 **)** |
|
| void | :ref:`play<class_AudioStreamPlayer_play>` **(** :ref:`float<class_float>` from_pos=0.0 **)** |
|
||||||
+------------------------------+------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`seek<class_AudioStreamPlayer_seek>` **(** :ref:`float<class_float>` to_pos **)** |
|
| void | :ref:`seek<class_AudioStreamPlayer_seek>` **(** :ref:`float<class_float>` to_pos **)** |
|
||||||
+------------------------------+------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_autoplay<class_AudioStreamPlayer_set_autoplay>` **(** :ref:`bool<class_bool>` enable **)** |
|
| void | :ref:`set_autoplay<class_AudioStreamPlayer_set_autoplay>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||||
+------------------------------+------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_bus<class_AudioStreamPlayer_set_bus>` **(** :ref:`String<class_string>` bus **)** |
|
| void | :ref:`set_bus<class_AudioStreamPlayer_set_bus>` **(** :ref:`String<class_string>` bus **)** |
|
||||||
+------------------------------+------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_mix_target<class_AudioStreamPlayer_set_mix_target>` **(** :ref:`int<class_int>` mix_target **)** |
|
| void | :ref:`set_mix_target<class_AudioStreamPlayer_set_mix_target>` **(** :ref:`int<class_int>` mix_target **)** |
|
||||||
+------------------------------+------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_stream<class_AudioStreamPlayer_set_stream>` **(** :ref:`AudioStream<class_audiostream>` stream **)** |
|
| void | :ref:`set_stream<class_AudioStreamPlayer_set_stream>` **(** :ref:`AudioStream<class_audiostream>` stream **)** |
|
||||||
+------------------------------+------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_volume_db<class_AudioStreamPlayer_set_volume_db>` **(** :ref:`float<class_float>` volume_db **)** |
|
| void | :ref:`set_volume_db<class_AudioStreamPlayer_set_volume_db>` **(** :ref:`float<class_float>` volume_db **)** |
|
||||||
+------------------------------+------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`stop<class_AudioStreamPlayer_stop>` **(** **)** |
|
| void | :ref:`stop<class_AudioStreamPlayer_stop>` **(** **)** |
|
||||||
+------------------------------+------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
|
Signals
|
||||||
|
-------
|
||||||
|
|
||||||
|
- **finished** **(** **)**
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
@@ -77,7 +82,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_AudioStreamPlayer_get_stream:
|
.. _class_AudioStreamPlayer_get_stream:
|
||||||
|
|
||||||
- :ref:`Object<class_object>` **get_stream** **(** **)** const
|
- :ref:`AudioStream<class_audiostream>` **get_stream** **(** **)** const
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer_get_volume_db:
|
.. _class_AudioStreamPlayer_get_volume_db:
|
||||||
|
|
||||||
@@ -93,7 +98,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_AudioStreamPlayer_play:
|
.. _class_AudioStreamPlayer_play:
|
||||||
|
|
||||||
- void **play** **(** :ref:`float<class_float>` from_pos=0 **)**
|
- void **play** **(** :ref:`float<class_float>` from_pos=0.0 **)**
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer_seek:
|
.. _class_AudioStreamPlayer_seek:
|
||||||
|
|
||||||
|
|||||||
@@ -18,45 +18,50 @@ Brief Description
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_area_mask<class_AudioStreamPlayer2D_get_area_mask>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_area_mask<class_AudioStreamPlayer2D_get_area_mask>` **(** **)** const |
|
||||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_attenuation<class_AudioStreamPlayer2D_get_attenuation>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_attenuation<class_AudioStreamPlayer2D_get_attenuation>` **(** **)** const |
|
||||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`get_bus<class_AudioStreamPlayer2D_get_bus>` **(** **)** const |
|
| :ref:`String<class_string>` | :ref:`get_bus<class_AudioStreamPlayer2D_get_bus>` **(** **)** const |
|
||||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_max_distance<class_AudioStreamPlayer2D_get_max_distance>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_max_distance<class_AudioStreamPlayer2D_get_max_distance>` **(** **)** const |
|
||||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_pos<class_AudioStreamPlayer2D_get_pos>` **(** **)** |
|
| :ref:`float<class_float>` | :ref:`get_pos<class_AudioStreamPlayer2D_get_pos>` **(** **)** |
|
||||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Object<class_object>` | :ref:`get_stream<class_AudioStreamPlayer2D_get_stream>` **(** **)** const |
|
| :ref:`AudioStream<class_audiostream>` | :ref:`get_stream<class_AudioStreamPlayer2D_get_stream>` **(** **)** const |
|
||||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_volume_db<class_AudioStreamPlayer2D_get_volume_db>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_volume_db<class_AudioStreamPlayer2D_get_volume_db>` **(** **)** const |
|
||||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_autoplay_enabled<class_AudioStreamPlayer2D_is_autoplay_enabled>` **(** **)** |
|
| :ref:`bool<class_bool>` | :ref:`is_autoplay_enabled<class_AudioStreamPlayer2D_is_autoplay_enabled>` **(** **)** |
|
||||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AudioStreamPlayer2D_is_playing>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AudioStreamPlayer2D_is_playing>` **(** **)** const |
|
||||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`play<class_AudioStreamPlayer2D_play>` **(** :ref:`float<class_float>` from_pos=0 **)** |
|
| void | :ref:`play<class_AudioStreamPlayer2D_play>` **(** :ref:`float<class_float>` from_pos=0.0 **)** |
|
||||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`seek<class_AudioStreamPlayer2D_seek>` **(** :ref:`float<class_float>` to_pos **)** |
|
| void | :ref:`seek<class_AudioStreamPlayer2D_seek>` **(** :ref:`float<class_float>` to_pos **)** |
|
||||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_area_mask<class_AudioStreamPlayer2D_set_area_mask>` **(** :ref:`int<class_int>` mask **)** |
|
| void | :ref:`set_area_mask<class_AudioStreamPlayer2D_set_area_mask>` **(** :ref:`int<class_int>` mask **)** |
|
||||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_attenuation<class_AudioStreamPlayer2D_set_attenuation>` **(** :ref:`float<class_float>` curve **)** |
|
| void | :ref:`set_attenuation<class_AudioStreamPlayer2D_set_attenuation>` **(** :ref:`float<class_float>` curve **)** |
|
||||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_autoplay<class_AudioStreamPlayer2D_set_autoplay>` **(** :ref:`bool<class_bool>` enable **)** |
|
| void | :ref:`set_autoplay<class_AudioStreamPlayer2D_set_autoplay>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_bus<class_AudioStreamPlayer2D_set_bus>` **(** :ref:`String<class_string>` bus **)** |
|
| void | :ref:`set_bus<class_AudioStreamPlayer2D_set_bus>` **(** :ref:`String<class_string>` bus **)** |
|
||||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_max_distance<class_AudioStreamPlayer2D_set_max_distance>` **(** :ref:`float<class_float>` pixels **)** |
|
| void | :ref:`set_max_distance<class_AudioStreamPlayer2D_set_max_distance>` **(** :ref:`float<class_float>` pixels **)** |
|
||||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_stream<class_AudioStreamPlayer2D_set_stream>` **(** :ref:`AudioStream<class_audiostream>` stream **)** |
|
| void | :ref:`set_stream<class_AudioStreamPlayer2D_set_stream>` **(** :ref:`AudioStream<class_audiostream>` stream **)** |
|
||||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_volume_db<class_AudioStreamPlayer2D_set_volume_db>` **(** :ref:`float<class_float>` volume_db **)** |
|
| void | :ref:`set_volume_db<class_AudioStreamPlayer2D_set_volume_db>` **(** :ref:`float<class_float>` volume_db **)** |
|
||||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`stop<class_AudioStreamPlayer2D_stop>` **(** **)** |
|
| void | :ref:`stop<class_AudioStreamPlayer2D_stop>` **(** **)** |
|
||||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
|
Signals
|
||||||
|
-------
|
||||||
|
|
||||||
|
- **finished** **(** **)**
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
@@ -95,7 +100,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_AudioStreamPlayer2D_get_stream:
|
.. _class_AudioStreamPlayer2D_get_stream:
|
||||||
|
|
||||||
- :ref:`Object<class_object>` **get_stream** **(** **)** const
|
- :ref:`AudioStream<class_audiostream>` **get_stream** **(** **)** const
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer2D_get_volume_db:
|
.. _class_AudioStreamPlayer2D_get_volume_db:
|
||||||
|
|
||||||
@@ -111,7 +116,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_AudioStreamPlayer2D_play:
|
.. _class_AudioStreamPlayer2D_play:
|
||||||
|
|
||||||
- void **play** **(** :ref:`float<class_float>` from_pos=0 **)**
|
- void **play** **(** :ref:`float<class_float>` from_pos=0.0 **)**
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer2D_seek:
|
.. _class_AudioStreamPlayer2D_seek:
|
||||||
|
|
||||||
|
|||||||
@@ -18,81 +18,86 @@ Brief Description
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_area_mask<class_AudioStreamPlayer3D_get_area_mask>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_area_mask<class_AudioStreamPlayer3D_get_area_mask>` **(** **)** const |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_attenuation_filter_cutoff_hz<class_AudioStreamPlayer3D_get_attenuation_filter_cutoff_hz>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_attenuation_filter_cutoff_hz<class_AudioStreamPlayer3D_get_attenuation_filter_cutoff_hz>` **(** **)** const |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_attenuation_filter_db<class_AudioStreamPlayer3D_get_attenuation_filter_db>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_attenuation_filter_db<class_AudioStreamPlayer3D_get_attenuation_filter_db>` **(** **)** const |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_attenuation_model<class_AudioStreamPlayer3D_get_attenuation_model>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_attenuation_model<class_AudioStreamPlayer3D_get_attenuation_model>` **(** **)** const |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`get_bus<class_AudioStreamPlayer3D_get_bus>` **(** **)** const |
|
| :ref:`String<class_string>` | :ref:`get_bus<class_AudioStreamPlayer3D_get_bus>` **(** **)** const |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_doppler_tracking<class_AudioStreamPlayer3D_get_doppler_tracking>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_doppler_tracking<class_AudioStreamPlayer3D_get_doppler_tracking>` **(** **)** const |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_emission_angle<class_AudioStreamPlayer3D_get_emission_angle>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_emission_angle<class_AudioStreamPlayer3D_get_emission_angle>` **(** **)** const |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_emission_angle_filter_attenuation_db<class_AudioStreamPlayer3D_get_emission_angle_filter_attenuation_db>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_emission_angle_filter_attenuation_db<class_AudioStreamPlayer3D_get_emission_angle_filter_attenuation_db>` **(** **)** const |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_max_db<class_AudioStreamPlayer3D_get_max_db>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_max_db<class_AudioStreamPlayer3D_get_max_db>` **(** **)** const |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_max_distance<class_AudioStreamPlayer3D_get_max_distance>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_max_distance<class_AudioStreamPlayer3D_get_max_distance>` **(** **)** const |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_out_of_range_mode<class_AudioStreamPlayer3D_get_out_of_range_mode>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_out_of_range_mode<class_AudioStreamPlayer3D_get_out_of_range_mode>` **(** **)** const |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_pos<class_AudioStreamPlayer3D_get_pos>` **(** **)** |
|
| :ref:`float<class_float>` | :ref:`get_pos<class_AudioStreamPlayer3D_get_pos>` **(** **)** |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Object<class_object>` | :ref:`get_stream<class_AudioStreamPlayer3D_get_stream>` **(** **)** const |
|
| :ref:`AudioStream<class_audiostream>` | :ref:`get_stream<class_AudioStreamPlayer3D_get_stream>` **(** **)** const |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_unit_db<class_AudioStreamPlayer3D_get_unit_db>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_unit_db<class_AudioStreamPlayer3D_get_unit_db>` **(** **)** const |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_unit_size<class_AudioStreamPlayer3D_get_unit_size>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_unit_size<class_AudioStreamPlayer3D_get_unit_size>` **(** **)** const |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_autoplay_enabled<class_AudioStreamPlayer3D_is_autoplay_enabled>` **(** **)** |
|
| :ref:`bool<class_bool>` | :ref:`is_autoplay_enabled<class_AudioStreamPlayer3D_is_autoplay_enabled>` **(** **)** |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_emission_angle_enabled<class_AudioStreamPlayer3D_is_emission_angle_enabled>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_emission_angle_enabled<class_AudioStreamPlayer3D_is_emission_angle_enabled>` **(** **)** const |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AudioStreamPlayer3D_is_playing>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AudioStreamPlayer3D_is_playing>` **(** **)** const |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`play<class_AudioStreamPlayer3D_play>` **(** :ref:`float<class_float>` from_pos=0 **)** |
|
| void | :ref:`play<class_AudioStreamPlayer3D_play>` **(** :ref:`float<class_float>` from_pos=0.0 **)** |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`seek<class_AudioStreamPlayer3D_seek>` **(** :ref:`float<class_float>` to_pos **)** |
|
| void | :ref:`seek<class_AudioStreamPlayer3D_seek>` **(** :ref:`float<class_float>` to_pos **)** |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_area_mask<class_AudioStreamPlayer3D_set_area_mask>` **(** :ref:`int<class_int>` mask **)** |
|
| void | :ref:`set_area_mask<class_AudioStreamPlayer3D_set_area_mask>` **(** :ref:`int<class_int>` mask **)** |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_attenuation_filter_cutoff_hz<class_AudioStreamPlayer3D_set_attenuation_filter_cutoff_hz>` **(** :ref:`float<class_float>` degrees **)** |
|
| void | :ref:`set_attenuation_filter_cutoff_hz<class_AudioStreamPlayer3D_set_attenuation_filter_cutoff_hz>` **(** :ref:`float<class_float>` degrees **)** |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_attenuation_filter_db<class_AudioStreamPlayer3D_set_attenuation_filter_db>` **(** :ref:`float<class_float>` db **)** |
|
| void | :ref:`set_attenuation_filter_db<class_AudioStreamPlayer3D_set_attenuation_filter_db>` **(** :ref:`float<class_float>` db **)** |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_attenuation_model<class_AudioStreamPlayer3D_set_attenuation_model>` **(** :ref:`int<class_int>` model **)** |
|
| void | :ref:`set_attenuation_model<class_AudioStreamPlayer3D_set_attenuation_model>` **(** :ref:`int<class_int>` model **)** |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_autoplay<class_AudioStreamPlayer3D_set_autoplay>` **(** :ref:`bool<class_bool>` enable **)** |
|
| void | :ref:`set_autoplay<class_AudioStreamPlayer3D_set_autoplay>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_bus<class_AudioStreamPlayer3D_set_bus>` **(** :ref:`String<class_string>` bus **)** |
|
| void | :ref:`set_bus<class_AudioStreamPlayer3D_set_bus>` **(** :ref:`String<class_string>` bus **)** |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_doppler_tracking<class_AudioStreamPlayer3D_set_doppler_tracking>` **(** :ref:`int<class_int>` mode **)** |
|
| void | :ref:`set_doppler_tracking<class_AudioStreamPlayer3D_set_doppler_tracking>` **(** :ref:`int<class_int>` mode **)** |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_emission_angle<class_AudioStreamPlayer3D_set_emission_angle>` **(** :ref:`float<class_float>` degrees **)** |
|
| void | :ref:`set_emission_angle<class_AudioStreamPlayer3D_set_emission_angle>` **(** :ref:`float<class_float>` degrees **)** |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_emission_angle_enabled<class_AudioStreamPlayer3D_set_emission_angle_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
| void | :ref:`set_emission_angle_enabled<class_AudioStreamPlayer3D_set_emission_angle_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_emission_angle_filter_attenuation_db<class_AudioStreamPlayer3D_set_emission_angle_filter_attenuation_db>` **(** :ref:`float<class_float>` db **)** |
|
| void | :ref:`set_emission_angle_filter_attenuation_db<class_AudioStreamPlayer3D_set_emission_angle_filter_attenuation_db>` **(** :ref:`float<class_float>` db **)** |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_max_db<class_AudioStreamPlayer3D_set_max_db>` **(** :ref:`float<class_float>` max_db **)** |
|
| void | :ref:`set_max_db<class_AudioStreamPlayer3D_set_max_db>` **(** :ref:`float<class_float>` max_db **)** |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_max_distance<class_AudioStreamPlayer3D_set_max_distance>` **(** :ref:`float<class_float>` metres **)** |
|
| void | :ref:`set_max_distance<class_AudioStreamPlayer3D_set_max_distance>` **(** :ref:`float<class_float>` metres **)** |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_out_of_range_mode<class_AudioStreamPlayer3D_set_out_of_range_mode>` **(** :ref:`int<class_int>` mode **)** |
|
| void | :ref:`set_out_of_range_mode<class_AudioStreamPlayer3D_set_out_of_range_mode>` **(** :ref:`int<class_int>` mode **)** |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_stream<class_AudioStreamPlayer3D_set_stream>` **(** :ref:`AudioStream<class_audiostream>` stream **)** |
|
| void | :ref:`set_stream<class_AudioStreamPlayer3D_set_stream>` **(** :ref:`AudioStream<class_audiostream>` stream **)** |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_unit_db<class_AudioStreamPlayer3D_set_unit_db>` **(** :ref:`float<class_float>` unit_db **)** |
|
| void | :ref:`set_unit_db<class_AudioStreamPlayer3D_set_unit_db>` **(** :ref:`float<class_float>` unit_db **)** |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_unit_size<class_AudioStreamPlayer3D_set_unit_size>` **(** :ref:`float<class_float>` unit_size **)** |
|
| void | :ref:`set_unit_size<class_AudioStreamPlayer3D_set_unit_size>` **(** :ref:`float<class_float>` unit_size **)** |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`stop<class_AudioStreamPlayer3D_stop>` **(** **)** |
|
| void | :ref:`stop<class_AudioStreamPlayer3D_stop>` **(** **)** |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
|
Signals
|
||||||
|
-------
|
||||||
|
|
||||||
|
- **finished** **(** **)**
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
@@ -180,7 +185,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_AudioStreamPlayer3D_get_stream:
|
.. _class_AudioStreamPlayer3D_get_stream:
|
||||||
|
|
||||||
- :ref:`Object<class_object>` **get_stream** **(** **)** const
|
- :ref:`AudioStream<class_audiostream>` **get_stream** **(** **)** const
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer3D_get_unit_db:
|
.. _class_AudioStreamPlayer3D_get_unit_db:
|
||||||
|
|
||||||
@@ -204,7 +209,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_AudioStreamPlayer3D_play:
|
.. _class_AudioStreamPlayer3D_play:
|
||||||
|
|
||||||
- void **play** **(** :ref:`float<class_float>` from_pos=0 **)**
|
- void **play** **(** :ref:`float<class_float>` from_pos=0.0 **)**
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer3D_seek:
|
.. _class_AudioStreamPlayer3D_seek:
|
||||||
|
|
||||||
|
|||||||
@@ -18,15 +18,15 @@ Brief Description
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Object<class_object>` | :ref:`get_audio_stream<class_AudioStreamRandomPitch_get_audio_stream>` **(** **)** const |
|
| :ref:`AudioStream<class_audiostream>` | :ref:`get_audio_stream<class_AudioStreamRandomPitch_get_audio_stream>` **(** **)** const |
|
||||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_random_pitch<class_AudioStreamRandomPitch_get_random_pitch>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_random_pitch<class_AudioStreamRandomPitch_get_random_pitch>` **(** **)** const |
|
||||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_audio_stream<class_AudioStreamRandomPitch_set_audio_stream>` **(** :ref:`Object<class_object>` stream **)** |
|
| void | :ref:`set_audio_stream<class_AudioStreamRandomPitch_set_audio_stream>` **(** :ref:`AudioStream<class_audiostream>` stream **)** |
|
||||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_random_pitch<class_AudioStreamRandomPitch_set_random_pitch>` **(** :ref:`float<class_float>` scale **)** |
|
| void | :ref:`set_random_pitch<class_AudioStreamRandomPitch_set_random_pitch>` **(** :ref:`float<class_float>` scale **)** |
|
||||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
@@ -39,7 +39,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_AudioStreamRandomPitch_get_audio_stream:
|
.. _class_AudioStreamRandomPitch_get_audio_stream:
|
||||||
|
|
||||||
- :ref:`Object<class_object>` **get_audio_stream** **(** **)** const
|
- :ref:`AudioStream<class_audiostream>` **get_audio_stream** **(** **)** const
|
||||||
|
|
||||||
.. _class_AudioStreamRandomPitch_get_random_pitch:
|
.. _class_AudioStreamRandomPitch_get_random_pitch:
|
||||||
|
|
||||||
@@ -47,7 +47,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_AudioStreamRandomPitch_set_audio_stream:
|
.. _class_AudioStreamRandomPitch_set_audio_stream:
|
||||||
|
|
||||||
- void **set_audio_stream** **(** :ref:`Object<class_object>` stream **)**
|
- void **set_audio_stream** **(** :ref:`AudioStream<class_audiostream>` stream **)**
|
||||||
|
|
||||||
.. _class_AudioStreamRandomPitch_set_random_pitch:
|
.. _class_AudioStreamRandomPitch_set_random_pitch:
|
||||||
|
|
||||||
|
|||||||
@@ -20,43 +20,43 @@ Provides a base class for different kinds of buttons.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`_pressed<class_BaseButton__pressed>` **(** **)** virtual |
|
| void | :ref:`_pressed<class_BaseButton__pressed>` **(** **)** virtual |
|
||||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`_toggled<class_BaseButton__toggled>` **(** :ref:`bool<class_bool>` pressed **)** virtual |
|
| void | :ref:`_toggled<class_BaseButton__toggled>` **(** :ref:`bool<class_bool>` pressed **)** virtual |
|
||||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_action_mode<class_BaseButton_get_action_mode>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_action_mode<class_BaseButton_get_action_mode>` **(** **)** const |
|
||||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Object<class_object>` | :ref:`get_button_group<class_BaseButton_get_button_group>` **(** **)** const |
|
| :ref:`ButtonGroup<class_buttongroup>` | :ref:`get_button_group<class_BaseButton_get_button_group>` **(** **)** const |
|
||||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_draw_mode<class_BaseButton_get_draw_mode>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_draw_mode<class_BaseButton_get_draw_mode>` **(** **)** const |
|
||||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_enabled_focus_mode<class_BaseButton_get_enabled_focus_mode>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_enabled_focus_mode<class_BaseButton_get_enabled_focus_mode>` **(** **)** const |
|
||||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Object<class_object>` | :ref:`get_shortcut<class_BaseButton_get_shortcut>` **(** **)** const |
|
| :ref:`ShortCut<class_shortcut>` | :ref:`get_shortcut<class_BaseButton_get_shortcut>` **(** **)** const |
|
||||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_disabled<class_BaseButton_is_disabled>` **(** **)** 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_hovered<class_BaseButton_is_hovered>` **(** **)** const |
|
||||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_pressed<class_BaseButton_is_pressed>` **(** **)** 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 |
|
| :ref:`bool<class_bool>` | :ref:`is_toggle_mode<class_BaseButton_is_toggle_mode>` **(** **)** const |
|
||||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_action_mode<class_BaseButton_set_action_mode>` **(** :ref:`int<class_int>` mode **)** |
|
| void | :ref:`set_action_mode<class_BaseButton_set_action_mode>` **(** :ref:`int<class_int>` mode **)** |
|
||||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_button_group<class_BaseButton_set_button_group>` **(** :ref:`Object<class_object>` button_group **)** |
|
| void | :ref:`set_button_group<class_BaseButton_set_button_group>` **(** :ref:`ButtonGroup<class_buttongroup>` button_group **)** |
|
||||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_disabled<class_BaseButton_set_disabled>` **(** :ref:`bool<class_bool>` disabled **)** |
|
| void | :ref:`set_disabled<class_BaseButton_set_disabled>` **(** :ref:`bool<class_bool>` disabled **)** |
|
||||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_enabled_focus_mode<class_BaseButton_set_enabled_focus_mode>` **(** :ref:`int<class_int>` mode **)** |
|
| void | :ref:`set_enabled_focus_mode<class_BaseButton_set_enabled_focus_mode>` **(** :ref:`int<class_int>` mode **)** |
|
||||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_pressed<class_BaseButton_set_pressed>` **(** :ref:`bool<class_bool>` pressed **)** |
|
| void | :ref:`set_pressed<class_BaseButton_set_pressed>` **(** :ref:`bool<class_bool>` pressed **)** |
|
||||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_shortcut<class_BaseButton_set_shortcut>` **(** :ref:`Object<class_object>` shortcut **)** |
|
| void | :ref:`set_shortcut<class_BaseButton_set_shortcut>` **(** :ref:`ShortCut<class_shortcut>` shortcut **)** |
|
||||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_toggle_mode<class_BaseButton_set_toggle_mode>` **(** :ref:`bool<class_bool>` enabled **)** |
|
| void | :ref:`set_toggle_mode<class_BaseButton_set_toggle_mode>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Signals
|
Signals
|
||||||
-------
|
-------
|
||||||
@@ -81,7 +81,7 @@ Member Variables
|
|||||||
- :ref:`bool<class_bool>` **disabled**
|
- :ref:`bool<class_bool>` **disabled**
|
||||||
- :ref:`int<class_int>` **enabled_focus_mode**
|
- :ref:`int<class_int>` **enabled_focus_mode**
|
||||||
- :ref:`ButtonGroup<class_buttongroup>` **group**
|
- :ref:`ButtonGroup<class_buttongroup>` **group**
|
||||||
- :ref:`bool<class_bool>` **is_pressed**
|
- :ref:`bool<class_bool>` **pressed**
|
||||||
- :ref:`ShortCut<class_shortcut>` **shortcut**
|
- :ref:`ShortCut<class_shortcut>` **shortcut**
|
||||||
- :ref:`bool<class_bool>` **toggle_mode**
|
- :ref:`bool<class_bool>` **toggle_mode**
|
||||||
|
|
||||||
@@ -123,7 +123,7 @@ Return the current mode of action (see :ref:`set_action_mode<class_BaseButton_se
|
|||||||
|
|
||||||
.. _class_BaseButton_get_button_group:
|
.. _class_BaseButton_get_button_group:
|
||||||
|
|
||||||
- :ref:`Object<class_object>` **get_button_group** **(** **)** const
|
- :ref:`ButtonGroup<class_buttongroup>` **get_button_group** **(** **)** const
|
||||||
|
|
||||||
.. _class_BaseButton_get_draw_mode:
|
.. _class_BaseButton_get_draw_mode:
|
||||||
|
|
||||||
@@ -139,7 +139,7 @@ Returns focus access mode used when switching between enabled/disabled (see :ref
|
|||||||
|
|
||||||
.. _class_BaseButton_get_shortcut:
|
.. _class_BaseButton_get_shortcut:
|
||||||
|
|
||||||
- :ref:`Object<class_object>` **get_shortcut** **(** **)** const
|
- :ref:`ShortCut<class_shortcut>` **get_shortcut** **(** **)** const
|
||||||
|
|
||||||
.. _class_BaseButton_is_disabled:
|
.. _class_BaseButton_is_disabled:
|
||||||
|
|
||||||
@@ -173,7 +173,7 @@ Set the current mode of action, determining when the button is considered clicke
|
|||||||
|
|
||||||
.. _class_BaseButton_set_button_group:
|
.. _class_BaseButton_set_button_group:
|
||||||
|
|
||||||
- void **set_button_group** **(** :ref:`Object<class_object>` button_group **)**
|
- void **set_button_group** **(** :ref:`ButtonGroup<class_buttongroup>` button_group **)**
|
||||||
|
|
||||||
.. _class_BaseButton_set_disabled:
|
.. _class_BaseButton_set_disabled:
|
||||||
|
|
||||||
@@ -195,7 +195,7 @@ Set the button to pressed state (only if toggle_mode is active).
|
|||||||
|
|
||||||
.. _class_BaseButton_set_shortcut:
|
.. _class_BaseButton_set_shortcut:
|
||||||
|
|
||||||
- void **set_shortcut** **(** :ref:`Object<class_object>` shortcut **)**
|
- void **set_shortcut** **(** :ref:`ShortCut<class_shortcut>` shortcut **)**
|
||||||
|
|
||||||
.. _class_BaseButton_set_toggle_mode:
|
.. _class_BaseButton_set_toggle_mode:
|
||||||
|
|
||||||
|
|||||||
@@ -41,12 +41,6 @@ Member Functions
|
|||||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Basis<class_basis>` | :ref:`scaled<class_Basis_scaled>` **(** :ref:`Vector3<class_vector3>` scale **)** |
|
| :ref:`Basis<class_basis>` | :ref:`scaled<class_Basis_scaled>` **(** :ref:`Vector3<class_vector3>` scale **)** |
|
||||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_rotation_axis_angle<class_Basis_set_rotation_axis_angle>` **(** :ref:`Vector3<class_vector3>` axis, :ref:`float<class_float>` angle **)** |
|
|
||||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_rotation_euler<class_Basis_set_rotation_euler>` **(** :ref:`Vector3<class_vector3>` euler **)** |
|
|
||||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_scale<class_Basis_set_scale>` **(** :ref:`Vector3<class_vector3>` scale **)** |
|
|
||||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`tdotx<class_Basis_tdotx>` **(** :ref:`Vector3<class_vector3>` with **)** |
|
| :ref:`float<class_float>` | :ref:`tdotx<class_Basis_tdotx>` **(** :ref:`Vector3<class_vector3>` with **)** |
|
||||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`tdoty<class_Basis_tdoty>` **(** :ref:`Vector3<class_vector3>` with **)** |
|
| :ref:`float<class_float>` | :ref:`tdoty<class_Basis_tdoty>` **(** :ref:`Vector3<class_vector3>` with **)** |
|
||||||
@@ -87,7 +81,7 @@ Create a rotation matrix from the given quaternion.
|
|||||||
|
|
||||||
- :ref:`Basis<class_basis>` **Basis** **(** :ref:`Vector3<class_vector3>` euler **)**
|
- :ref:`Basis<class_basis>` **Basis** **(** :ref:`Vector3<class_vector3>` euler **)**
|
||||||
|
|
||||||
Create a rotation matrix (in the XYZ convention: first Z, then Y, and X last) from the specified Euler angles, given in the vector format as (third, second, first).
|
Create a rotation matrix (in the YXZ convention: first Z, then X, and Y last) from the specified Euler angles, given in the vector format as (X-angle, Y-angle, Z-angle).
|
||||||
|
|
||||||
.. _class_Basis_Basis:
|
.. _class_Basis_Basis:
|
||||||
|
|
||||||
@@ -111,7 +105,7 @@ Return the determinant of the matrix.
|
|||||||
|
|
||||||
- :ref:`Vector3<class_vector3>` **get_euler** **(** **)**
|
- :ref:`Vector3<class_vector3>` **get_euler** **(** **)**
|
||||||
|
|
||||||
Assuming that the matrix is a proper rotation matrix (orthonormal matrix with determinant +1), return Euler angles (in the XYZ convention: first Z, then Y, and X last). Returned vector contains the rotation angles in the format (third,second,first).
|
Assuming that the matrix is a proper rotation matrix (orthonormal matrix with determinant +1), return Euler angles (in the YXZ convention: first Z, then X, and Y last). Returned vector contains the rotation angles in the format (X-angle, Y-angle, Z-angle).
|
||||||
|
|
||||||
.. _class_Basis_get_orthogonal_index:
|
.. _class_Basis_get_orthogonal_index:
|
||||||
|
|
||||||
@@ -149,24 +143,6 @@ Introduce an additional rotation around the given axis by phi (radians). Only re
|
|||||||
|
|
||||||
Introduce an additional scaling specified by the given 3D scaling factor. Only relevant when the matrix is being used as a part of :ref:`Transform<class_transform>`.
|
Introduce an additional scaling specified by the given 3D scaling factor. Only relevant when the matrix is being used as a part of :ref:`Transform<class_transform>`.
|
||||||
|
|
||||||
.. _class_Basis_set_rotation_axis_angle:
|
|
||||||
|
|
||||||
- void **set_rotation_axis_angle** **(** :ref:`Vector3<class_vector3>` axis, :ref:`float<class_float>` angle **)**
|
|
||||||
|
|
||||||
Changes only the rotation part of the :ref:`Basis<class_basis>` to a rotation around given axis by phi, while preserving the scaling part (as determined by get_scale).
|
|
||||||
|
|
||||||
.. _class_Basis_set_rotation_euler:
|
|
||||||
|
|
||||||
- void **set_rotation_euler** **(** :ref:`Vector3<class_vector3>` euler **)**
|
|
||||||
|
|
||||||
Changes only the rotation part of the :ref:`Basis<class_basis>` to a rotation corresponding to given Euler angles, while preserving the scaling part (as determined by get_scale).
|
|
||||||
|
|
||||||
.. _class_Basis_set_scale:
|
|
||||||
|
|
||||||
- void **set_scale** **(** :ref:`Vector3<class_vector3>` scale **)**
|
|
||||||
|
|
||||||
Changes only the scaling part of the Basis to the specified scaling, while preserving the rotation part (as determined by get_rotation).
|
|
||||||
|
|
||||||
.. _class_Basis_tdotx:
|
.. _class_Basis_tdotx:
|
||||||
|
|
||||||
- :ref:`float<class_float>` **tdotx** **(** :ref:`Vector3<class_vector3>` with **)**
|
- :ref:`float<class_float>` **tdotx** **(** :ref:`Vector3<class_vector3>` with **)**
|
||||||
|
|||||||
@@ -21,7 +21,7 @@ Member Functions
|
|||||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`create<class_BitMap_create>` **(** :ref:`Vector2<class_vector2>` size **)** |
|
| void | :ref:`create<class_BitMap_create>` **(** :ref:`Vector2<class_vector2>` size **)** |
|
||||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`create_from_image_alpha<class_BitMap_create_from_image_alpha>` **(** :ref:`Object<class_object>` image **)** |
|
| void | :ref:`create_from_image_alpha<class_BitMap_create_from_image_alpha>` **(** :ref:`Image<class_image>` image **)** |
|
||||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`get_bit<class_BitMap_get_bit>` **(** :ref:`Vector2<class_vector2>` pos **)** const |
|
| :ref:`bool<class_bool>` | :ref:`get_bit<class_BitMap_get_bit>` **(** :ref:`Vector2<class_vector2>` pos **)** const |
|
||||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -48,7 +48,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_BitMap_create_from_image_alpha:
|
.. _class_BitMap_create_from_image_alpha:
|
||||||
|
|
||||||
- void **create_from_image_alpha** **(** :ref:`Object<class_object>` image **)**
|
- void **create_from_image_alpha** **(** :ref:`Image<class_image>` image **)**
|
||||||
|
|
||||||
.. _class_BitMap_get_bit:
|
.. _class_BitMap_get_bit:
|
||||||
|
|
||||||
|
|||||||
@@ -18,35 +18,35 @@ Brief Description
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`add_char<class_BitmapFont_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_char<class_BitmapFont_add_char>` **(** :ref:`int<class_int>` character, :ref:`int<class_int>` texture, :ref:`Rect2<class_rect2>` rect, :ref:`Vector2<class_vector2>` align=null, :ref:`float<class_float>` advance=null **)** |
|
||||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`add_kerning_pair<class_BitmapFont_add_kerning_pair>` **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b, :ref:`int<class_int>` kerning **)** |
|
| void | :ref:`add_kerning_pair<class_BitmapFont_add_kerning_pair>` **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b, :ref:`int<class_int>` kerning **)** |
|
||||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`add_texture<class_BitmapFont_add_texture>` **(** :ref:`Texture<class_texture>` texture **)** |
|
| void | :ref:`add_texture<class_BitmapFont_add_texture>` **(** :ref:`Texture<class_texture>` texture **)** |
|
||||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`clear<class_BitmapFont_clear>` **(** **)** |
|
| void | :ref:`clear<class_BitmapFont_clear>` **(** **)** |
|
||||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`create_from_fnt<class_BitmapFont_create_from_fnt>` **(** :ref:`String<class_string>` path **)** |
|
| :ref:`int<class_int>` | :ref:`create_from_fnt<class_BitmapFont_create_from_fnt>` **(** :ref:`String<class_string>` path **)** |
|
||||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_char_size<class_BitmapFont_get_char_size>` **(** :ref:`int<class_int>` char, :ref:`int<class_int>` next=0 **)** const |
|
| :ref:`Vector2<class_vector2>` | :ref:`get_char_size<class_BitmapFont_get_char_size>` **(** :ref:`int<class_int>` char, :ref:`int<class_int>` next=null **)** const |
|
||||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Object<class_object>` | :ref:`get_fallback<class_BitmapFont_get_fallback>` **(** **)** const |
|
| :ref:`BitmapFont<class_bitmapfont>` | :ref:`get_fallback<class_BitmapFont_get_fallback>` **(** **)** const |
|
||||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_kerning_pair<class_BitmapFont_get_kerning_pair>` **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b **)** const |
|
| :ref:`int<class_int>` | :ref:`get_kerning_pair<class_BitmapFont_get_kerning_pair>` **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b **)** const |
|
||||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Texture<class_texture>` | :ref:`get_texture<class_BitmapFont_get_texture>` **(** :ref:`int<class_int>` idx **)** const |
|
| :ref:`Texture<class_texture>` | :ref:`get_texture<class_BitmapFont_get_texture>` **(** :ref:`int<class_int>` idx **)** const |
|
||||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_texture_count<class_BitmapFont_get_texture_count>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_texture_count<class_BitmapFont_get_texture_count>` **(** **)** const |
|
||||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_ascent<class_BitmapFont_set_ascent>` **(** :ref:`float<class_float>` px **)** |
|
| void | :ref:`set_ascent<class_BitmapFont_set_ascent>` **(** :ref:`float<class_float>` px **)** |
|
||||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_distance_field_hint<class_BitmapFont_set_distance_field_hint>` **(** :ref:`bool<class_bool>` enable **)** |
|
| void | :ref:`set_distance_field_hint<class_BitmapFont_set_distance_field_hint>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_fallback<class_BitmapFont_set_fallback>` **(** :ref:`Object<class_object>` fallback **)** |
|
| void | :ref:`set_fallback<class_BitmapFont_set_fallback>` **(** :ref:`BitmapFont<class_bitmapfont>` fallback **)** |
|
||||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_height<class_BitmapFont_set_height>` **(** :ref:`float<class_float>` px **)** |
|
| void | :ref:`set_height<class_BitmapFont_set_height>` **(** :ref:`float<class_float>` px **)** |
|
||||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
@@ -64,7 +64,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_BitmapFont_add_char:
|
.. _class_BitmapFont_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 **)**
|
- void **add_char** **(** :ref:`int<class_int>` character, :ref:`int<class_int>` texture, :ref:`Rect2<class_rect2>` rect, :ref:`Vector2<class_vector2>` align=null, :ref:`float<class_float>` advance=null **)**
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
@@ -92,13 +92,13 @@ Clear all the font data.
|
|||||||
|
|
||||||
.. _class_BitmapFont_get_char_size:
|
.. _class_BitmapFont_get_char_size:
|
||||||
|
|
||||||
- :ref:`Vector2<class_vector2>` **get_char_size** **(** :ref:`int<class_int>` char, :ref:`int<class_int>` next=0 **)** const
|
- :ref:`Vector2<class_vector2>` **get_char_size** **(** :ref:`int<class_int>` char, :ref:`int<class_int>` next=null **)** const
|
||||||
|
|
||||||
Return the size of a character, optionally taking kerning into account if the next character is provided.
|
Return the size of a character, optionally taking kerning into account if the next character is provided.
|
||||||
|
|
||||||
.. _class_BitmapFont_get_fallback:
|
.. _class_BitmapFont_get_fallback:
|
||||||
|
|
||||||
- :ref:`Object<class_object>` **get_fallback** **(** **)** const
|
- :ref:`BitmapFont<class_bitmapfont>` **get_fallback** **(** **)** const
|
||||||
|
|
||||||
.. _class_BitmapFont_get_kerning_pair:
|
.. _class_BitmapFont_get_kerning_pair:
|
||||||
|
|
||||||
@@ -126,7 +126,7 @@ Set the font ascent (number of pixels above the baseline).
|
|||||||
|
|
||||||
.. _class_BitmapFont_set_fallback:
|
.. _class_BitmapFont_set_fallback:
|
||||||
|
|
||||||
- void **set_fallback** **(** :ref:`Object<class_object>` fallback **)**
|
- void **set_fallback** **(** :ref:`BitmapFont<class_bitmapfont>` fallback **)**
|
||||||
|
|
||||||
.. _class_BitmapFont_set_height:
|
.. _class_BitmapFont_set_height:
|
||||||
|
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ Camera
|
|||||||
|
|
||||||
**Inherits:** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
|
**Inherits:** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
|
||||||
|
|
||||||
**Inherited By:** :ref:`InterpolatedCamera<class_interpolatedcamera>`
|
**Inherited By:** :ref:`InterpolatedCamera<class_interpolatedcamera>`, :ref:`ARVRCamera<class_arvrcamera>`
|
||||||
|
|
||||||
**Category:** Core
|
**Category:** Core
|
||||||
|
|
||||||
|
|||||||
@@ -18,91 +18,91 @@ Camera node for 2D scenes.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`align<class_Camera2D_align>` **(** **)** |
|
| void | :ref:`align<class_Camera2D_align>` **(** **)** |
|
||||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`clear_current<class_Camera2D_clear_current>` **(** **)** |
|
| void | :ref:`clear_current<class_Camera2D_clear_current>` **(** **)** |
|
||||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`force_update_scroll<class_Camera2D_force_update_scroll>` **(** **)** |
|
| void | :ref:`force_update_scroll<class_Camera2D_force_update_scroll>` **(** **)** |
|
||||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_anchor_mode<class_Camera2D_get_anchor_mode>` **(** **)** 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_pos<class_Camera2D_get_camera_pos>` **(** **)** const |
|
||||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_camera_screen_center<class_Camera2D_get_camera_screen_center>` **(** **)** const |
|
| :ref:`Vector2<class_vector2>` | :ref:`get_camera_screen_center<class_Camera2D_get_camera_screen_center>` **(** **)** const |
|
||||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Viewport<class_viewport>` | :ref:`get_custom_viewport<class_Camera2D_get_custom_viewport>` **(** **)** const |
|
| :ref:`Node<class_node>` | :ref:`get_custom_viewport<class_Camera2D_get_custom_viewport>` **(** **)** const |
|
||||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :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_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 |
|
| :ref:`float<class_float>` | :ref:`get_follow_smoothing<class_Camera2D_get_follow_smoothing>` **(** **)** const |
|
||||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_h_offset<class_Camera2D_get_h_offset>` **(** **)** const |
|
| :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:`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:`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:`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:`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_current<class_Camera2D_is_current>` **(** **)** const |
|
||||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_follow_smoothing_enabled<class_Camera2D_is_follow_smoothing_enabled>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_follow_smoothing_enabled<class_Camera2D_is_follow_smoothing_enabled>` **(** **)** const |
|
||||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_h_drag_enabled<class_Camera2D_is_h_drag_enabled>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_h_drag_enabled<class_Camera2D_is_h_drag_enabled>` **(** **)** const |
|
||||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_limit_drawing_enabled<class_Camera2D_is_limit_drawing_enabled>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_limit_drawing_enabled<class_Camera2D_is_limit_drawing_enabled>` **(** **)** const |
|
||||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_limit_smoothing_enabled<class_Camera2D_is_limit_smoothing_enabled>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_limit_smoothing_enabled<class_Camera2D_is_limit_smoothing_enabled>` **(** **)** const |
|
||||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_margin_drawing_enabled<class_Camera2D_is_margin_drawing_enabled>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_margin_drawing_enabled<class_Camera2D_is_margin_drawing_enabled>` **(** **)** const |
|
||||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_rotating<class_Camera2D_is_rotating>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_rotating<class_Camera2D_is_rotating>` **(** **)** const |
|
||||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_screen_drawing_enabled<class_Camera2D_is_screen_drawing_enabled>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_screen_drawing_enabled<class_Camera2D_is_screen_drawing_enabled>` **(** **)** const |
|
||||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_v_drag_enabled<class_Camera2D_is_v_drag_enabled>` **(** **)** 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:`make_current<class_Camera2D_make_current>` **(** **)** |
|
||||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`reset_smoothing<class_Camera2D_reset_smoothing>` **(** **)** |
|
| void | :ref:`reset_smoothing<class_Camera2D_reset_smoothing>` **(** **)** |
|
||||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_anchor_mode<class_Camera2D_set_anchor_mode>` **(** :ref:`int<class_int>` anchor_mode **)** |
|
| void | :ref:`set_anchor_mode<class_Camera2D_set_anchor_mode>` **(** :ref:`int<class_int>` anchor_mode **)** |
|
||||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_custom_viewport<class_Camera2D_set_custom_viewport>` **(** :ref:`Viewport<class_viewport>` viewport **)** |
|
| void | :ref:`set_custom_viewport<class_Camera2D_set_custom_viewport>` **(** :ref:`Node<class_node>` viewport **)** |
|
||||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_drag_margin<class_Camera2D_set_drag_margin>` **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` drag_margin **)** |
|
| 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_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_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_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_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_limit<class_Camera2D_set_limit>` **(** :ref:`int<class_int>` margin, :ref:`int<class_int>` limit **)** |
|
||||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_limit_drawing_enabled<class_Camera2D_set_limit_drawing_enabled>` **(** :ref:`bool<class_bool>` limit_drawing_enabled **)** |
|
| void | :ref:`set_limit_drawing_enabled<class_Camera2D_set_limit_drawing_enabled>` **(** :ref:`bool<class_bool>` limit_drawing_enabled **)** |
|
||||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_limit_smoothing_enabled<class_Camera2D_set_limit_smoothing_enabled>` **(** :ref:`bool<class_bool>` limit_smoothing_enabled **)** |
|
| void | :ref:`set_limit_smoothing_enabled<class_Camera2D_set_limit_smoothing_enabled>` **(** :ref:`bool<class_bool>` limit_smoothing_enabled **)** |
|
||||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_margin_drawing_enabled<class_Camera2D_set_margin_drawing_enabled>` **(** :ref:`bool<class_bool>` margin_drawing_enabled **)** |
|
| void | :ref:`set_margin_drawing_enabled<class_Camera2D_set_margin_drawing_enabled>` **(** :ref:`bool<class_bool>` margin_drawing_enabled **)** |
|
||||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_offset<class_Camera2D_set_offset>` **(** :ref:`Vector2<class_vector2>` offset **)** |
|
| 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_rotating<class_Camera2D_set_rotating>` **(** :ref:`bool<class_bool>` rotating **)** |
|
||||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_screen_drawing_enabled<class_Camera2D_set_screen_drawing_enabled>` **(** :ref:`bool<class_bool>` screen_drawing_enabled **)** |
|
| void | :ref:`set_screen_drawing_enabled<class_Camera2D_set_screen_drawing_enabled>` **(** :ref:`bool<class_bool>` screen_drawing_enabled **)** |
|
||||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_v_drag_enabled<class_Camera2D_set_v_drag_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
| 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_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 **)** |
|
| void | :ref:`set_zoom<class_Camera2D_set_zoom>` **(** :ref:`Vector2<class_vector2>` zoom **)** |
|
||||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
@@ -177,7 +177,7 @@ Return the camera position.
|
|||||||
|
|
||||||
.. _class_Camera2D_get_custom_viewport:
|
.. _class_Camera2D_get_custom_viewport:
|
||||||
|
|
||||||
- :ref:`Viewport<class_viewport>` **get_custom_viewport** **(** **)** const
|
- :ref:`Node<class_node>` **get_custom_viewport** **(** **)** const
|
||||||
|
|
||||||
.. _class_Camera2D_get_drag_margin:
|
.. _class_Camera2D_get_drag_margin:
|
||||||
|
|
||||||
@@ -271,7 +271,7 @@ This has no effect if smoothing is disabled.
|
|||||||
|
|
||||||
.. _class_Camera2D_set_custom_viewport:
|
.. _class_Camera2D_set_custom_viewport:
|
||||||
|
|
||||||
- void **set_custom_viewport** **(** :ref:`Viewport<class_viewport>` viewport **)**
|
- void **set_custom_viewport** **(** :ref:`Node<class_node>` viewport **)**
|
||||||
|
|
||||||
.. _class_Camera2D_set_drag_margin:
|
.. _class_Camera2D_set_drag_margin:
|
||||||
|
|
||||||
|
|||||||
@@ -20,127 +20,127 @@ Base class of anything 2D.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`_draw<class_CanvasItem__draw>` **(** **)** virtual |
|
| void | :ref:`_draw<class_CanvasItem__draw>` **(** **)** virtual |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :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:`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=null **)** |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| 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_circle<class_CanvasItem_draw_circle>` **(** :ref:`Vector2<class_vector2>` pos, :ref:`float<class_float>` radius, :ref:`Color<class_color>` color **)** |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`draw_colored_polygon<class_CanvasItem_draw_colored_polygon>` **(** :ref:`PoolVector2Array<class_poolvector2array>` points, :ref:`Color<class_color>` color, :ref:`PoolVector2Array<class_poolvector2array>` uvs=PoolVector2Array([]), :ref:`Texture<class_texture>` texture=NULL, :ref:`Texture<class_texture>` normal_map=NULL **)** |
|
| void | :ref:`draw_colored_polygon<class_CanvasItem_draw_colored_polygon>` **(** :ref:`PoolVector2Array<class_poolvector2array>` points, :ref:`Color<class_color>` color, :ref:`PoolVector2Array<class_poolvector2array>` uvs=null, :ref:`Texture<class_texture>` texture=PoolVector2Array( ), :ref:`Texture<class_texture>` normal_map=null, :ref:`bool<class_bool>` antialiased=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, :ref:`bool<class_bool>` antialiased=false **)** |
|
| 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=null, :ref:`bool<class_bool>` antialiased=null **)** |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`draw_polygon<class_CanvasItem_draw_polygon>` **(** :ref:`PoolVector2Array<class_poolvector2array>` points, :ref:`PoolColorArray<class_poolcolorarray>` colors, :ref:`PoolVector2Array<class_poolvector2array>` uvs=PoolVector2Array([]), :ref:`Texture<class_texture>` texture=NULL, :ref:`Texture<class_texture>` normal_map=NULL **)** |
|
| void | :ref:`draw_polygon<class_CanvasItem_draw_polygon>` **(** :ref:`PoolVector2Array<class_poolvector2array>` points, :ref:`PoolColorArray<class_poolcolorarray>` colors, :ref:`PoolVector2Array<class_poolvector2array>` uvs=null, :ref:`Texture<class_texture>` texture=PoolVector2Array( ), :ref:`Texture<class_texture>` normal_map=null, :ref:`bool<class_bool>` antialiased=null **)** |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`draw_polyline<class_CanvasItem_draw_polyline>` **(** :ref:`PoolVector2Array<class_poolvector2array>` points, :ref:`Color<class_color>` color, :ref:`float<class_float>` width=1, :ref:`bool<class_bool>` antialiased=false **)** |
|
| void | :ref:`draw_polyline<class_CanvasItem_draw_polyline>` **(** :ref:`PoolVector2Array<class_poolvector2array>` points, :ref:`Color<class_color>` color, :ref:`float<class_float>` width=null, :ref:`bool<class_bool>` antialiased=null **)** |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`draw_polyline_colors<class_CanvasItem_draw_polyline_colors>` **(** :ref:`PoolVector2Array<class_poolvector2array>` points, :ref:`PoolColorArray<class_poolcolorarray>` colors, :ref:`float<class_float>` width=1, :ref:`bool<class_bool>` antialiased=false **)** |
|
| void | :ref:`draw_polyline_colors<class_CanvasItem_draw_polyline_colors>` **(** :ref:`PoolVector2Array<class_poolvector2array>` points, :ref:`PoolColorArray<class_poolcolorarray>` colors, :ref:`float<class_float>` width=null, :ref:`bool<class_bool>` antialiased=null **)** |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`draw_primitive<class_CanvasItem_draw_primitive>` **(** :ref:`PoolVector2Array<class_poolvector2array>` points, :ref:`PoolColorArray<class_poolcolorarray>` colors, :ref:`PoolVector2Array<class_poolvector2array>` uvs, :ref:`Texture<class_texture>` texture=NULL, :ref:`float<class_float>` width=1, :ref:`Texture<class_texture>` normal_map=NULL **)** |
|
| void | :ref:`draw_primitive<class_CanvasItem_draw_primitive>` **(** :ref:`PoolVector2Array<class_poolvector2array>` points, :ref:`PoolColorArray<class_poolcolorarray>` colors, :ref:`PoolVector2Array<class_poolvector2array>` uvs, :ref:`Texture<class_texture>` texture=null, :ref:`float<class_float>` width=null, :ref:`Texture<class_texture>` normal_map=null **)** |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`draw_rect<class_CanvasItem_draw_rect>` **(** :ref:`Rect2<class_rect2>` rect, :ref:`Color<class_color>` color, :ref:`bool<class_bool>` filled=true **)** |
|
| void | :ref:`draw_rect<class_CanvasItem_draw_rect>` **(** :ref:`Rect2<class_rect2>` rect, :ref:`Color<class_color>` color, :ref:`bool<class_bool>` filled=null **)** |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| 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_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_set_transform_matrix<class_CanvasItem_draw_set_transform_matrix>` **(** :ref:`Transform2D<class_transform2d>` xform **)** |
|
| void | :ref:`draw_set_transform_matrix<class_CanvasItem_draw_set_transform_matrix>` **(** :ref:`Transform2D<class_transform2d>` xform **)** |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| 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_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=null, :ref:`int<class_int>` clip_w=null **)** |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`draw_style_box<class_CanvasItem_draw_style_box>` **(** :ref:`StyleBox<class_stylebox>` style_box, :ref:`Rect2<class_rect2>` rect **)** |
|
| 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), :ref:`Texture<class_texture>` normal_map=NULL **)** |
|
| void | :ref:`draw_texture<class_CanvasItem_draw_texture>` **(** :ref:`Texture<class_texture>` texture, :ref:`Vector2<class_vector2>` pos, :ref:`Color<class_color>` modulate=null, :ref:`Texture<class_texture>` normal_map=null **)** |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`draw_texture_rect<class_CanvasItem_draw_texture_rect>` **(** :ref:`Texture<class_texture>` texture, :ref:`Rect2<class_rect2>` rect, :ref:`bool<class_bool>` tile, :ref:`Color<class_color>` modulate=Color(1,1,1,1), :ref:`bool<class_bool>` transpose=false, :ref:`Texture<class_texture>` normal_map=NULL **)** |
|
| void | :ref:`draw_texture_rect<class_CanvasItem_draw_texture_rect>` **(** :ref:`Texture<class_texture>` texture, :ref:`Rect2<class_rect2>` rect, :ref:`bool<class_bool>` tile, :ref:`Color<class_color>` modulate=null, :ref:`bool<class_bool>` transpose=null, :ref:`Texture<class_texture>` normal_map=null **)** |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| 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, :ref:`Texture<class_texture>` normal_map=NULL, :ref:`bool<class_bool>` clip_uv=true **)** |
|
| 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=null, :ref:`Texture<class_texture>` normal_map=null, :ref:`bool<class_bool>` clip_uv=null **)** |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Variant<class_variant>` | :ref:`edit_get_state<class_CanvasItem_edit_get_state>` **(** **)** const |
|
| :ref:`Variant<class_variant>` | :ref:`edit_get_state<class_CanvasItem_edit_get_state>` **(** **)** const |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`edit_rotate<class_CanvasItem_edit_rotate>` **(** :ref:`float<class_float>` degrees **)** |
|
| void | :ref:`edit_rotate<class_CanvasItem_edit_rotate>` **(** :ref:`float<class_float>` degrees **)** |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`edit_set_rect<class_CanvasItem_edit_set_rect>` **(** :ref:`Rect2<class_rect2>` rect **)** |
|
| void | :ref:`edit_set_rect<class_CanvasItem_edit_set_rect>` **(** :ref:`Rect2<class_rect2>` rect **)** |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`edit_set_state<class_CanvasItem_edit_set_state>` **(** :ref:`Variant<class_variant>` state **)** |
|
| void | :ref:`edit_set_state<class_CanvasItem_edit_set_state>` **(** :ref:`Variant<class_variant>` state **)** |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`RID<class_rid>` | :ref:`get_canvas<class_CanvasItem_get_canvas>` **(** **)** const |
|
| :ref:`RID<class_rid>` | :ref:`get_canvas<class_CanvasItem_get_canvas>` **(** **)** const |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`RID<class_rid>` | :ref:`get_canvas_item<class_CanvasItem_get_canvas_item>` **(** **)** const |
|
| :ref:`RID<class_rid>` | :ref:`get_canvas_item<class_CanvasItem_get_canvas_item>` **(** **)** const |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Transform2D<class_transform2d>` | :ref:`get_canvas_transform<class_CanvasItem_get_canvas_transform>` **(** **)** const |
|
| :ref:`Transform2D<class_transform2d>` | :ref:`get_canvas_transform<class_CanvasItem_get_canvas_transform>` **(** **)** const |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_global_mouse_position<class_CanvasItem_get_global_mouse_position>` **(** **)** const |
|
| :ref:`Vector2<class_vector2>` | :ref:`get_global_mouse_position<class_CanvasItem_get_global_mouse_position>` **(** **)** const |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Transform2D<class_transform2d>` | :ref:`get_global_transform<class_CanvasItem_get_global_transform>` **(** **)** const |
|
| :ref:`Transform2D<class_transform2d>` | :ref:`get_global_transform<class_CanvasItem_get_global_transform>` **(** **)** const |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Transform2D<class_transform2d>` | :ref:`get_global_transform_with_canvas<class_CanvasItem_get_global_transform_with_canvas>` **(** **)** const |
|
| :ref:`Transform2D<class_transform2d>` | :ref:`get_global_transform_with_canvas<class_CanvasItem_get_global_transform_with_canvas>` **(** **)** const |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Rect2<class_rect2>` | :ref:`get_item_and_children_rect<class_CanvasItem_get_item_and_children_rect>` **(** **)** const |
|
| :ref:`Rect2<class_rect2>` | :ref:`get_item_and_children_rect<class_CanvasItem_get_item_and_children_rect>` **(** **)** const |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Rect2<class_rect2>` | :ref:`get_item_rect<class_CanvasItem_get_item_rect>` **(** **)** const |
|
| :ref:`Rect2<class_rect2>` | :ref:`get_item_rect<class_CanvasItem_get_item_rect>` **(** **)** const |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_light_mask<class_CanvasItem_get_light_mask>` **(** **)** 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_local_mouse_pos<class_CanvasItem_get_local_mouse_pos>` **(** **)** const |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Material<class_material>` | :ref:`get_material<class_CanvasItem_get_material>` **(** **)** const |
|
| :ref:`Material<class_material>` | :ref:`get_material<class_CanvasItem_get_material>` **(** **)** const |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Color<class_color>` | :ref:`get_modulate<class_CanvasItem_get_modulate>` **(** **)** const |
|
| :ref:`Color<class_color>` | :ref:`get_modulate<class_CanvasItem_get_modulate>` **(** **)** const |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Color<class_color>` | :ref:`get_self_modulate<class_CanvasItem_get_self_modulate>` **(** **)** const |
|
| :ref:`Color<class_color>` | :ref:`get_self_modulate<class_CanvasItem_get_self_modulate>` **(** **)** const |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Transform2D<class_transform2d>` | :ref:`get_transform<class_CanvasItem_get_transform>` **(** **)** const |
|
| :ref:`Transform2D<class_transform2d>` | :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:`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:`Rect2<class_rect2>` | :ref:`get_viewport_rect<class_CanvasItem_get_viewport_rect>` **(** **)** const |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Transform2D<class_transform2d>` | :ref:`get_viewport_transform<class_CanvasItem_get_viewport_transform>` **(** **)** const |
|
| :ref:`Transform2D<class_transform2d>` | :ref:`get_viewport_transform<class_CanvasItem_get_viewport_transform>` **(** **)** const |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Object<class_object>` | :ref:`get_world_2d<class_CanvasItem_get_world_2d>` **(** **)** const |
|
| :ref:`World2D<class_world2d>` | :ref:`get_world_2d<class_CanvasItem_get_world_2d>` **(** **)** const |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`hide<class_CanvasItem_hide>` **(** **)** |
|
| 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_draw_behind_parent_enabled<class_CanvasItem_is_draw_behind_parent_enabled>` **(** **)** const |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_local_transform_notification_enabled<class_CanvasItem_is_local_transform_notification_enabled>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_local_transform_notification_enabled<class_CanvasItem_is_local_transform_notification_enabled>` **(** **)** const |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_set_as_toplevel<class_CanvasItem_is_set_as_toplevel>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_set_as_toplevel<class_CanvasItem_is_set_as_toplevel>` **(** **)** const |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_transform_notification_enabled<class_CanvasItem_is_transform_notification_enabled>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_transform_notification_enabled<class_CanvasItem_is_transform_notification_enabled>` **(** **)** const |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_visible<class_CanvasItem_is_visible>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_visible<class_CanvasItem_is_visible>` **(** **)** const |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_visible_in_tree<class_CanvasItem_is_visible_in_tree>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_visible_in_tree<class_CanvasItem_is_visible_in_tree>` **(** **)** const |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`make_canvas_pos_local<class_CanvasItem_make_canvas_pos_local>` **(** :ref:`Vector2<class_vector2>` screen_point **)** const |
|
| :ref:`Vector2<class_vector2>` | :ref:`make_canvas_pos_local<class_CanvasItem_make_canvas_pos_local>` **(** :ref:`Vector2<class_vector2>` screen_point **)** const |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Object<class_object>` | :ref:`make_input_local<class_CanvasItem_make_input_local>` **(** :ref:`Object<class_object>` event **)** 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_as_toplevel<class_CanvasItem_set_as_toplevel>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_draw_behind_parent<class_CanvasItem_set_draw_behind_parent>` **(** :ref:`bool<class_bool>` enable **)** |
|
| void | :ref:`set_draw_behind_parent<class_CanvasItem_set_draw_behind_parent>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_light_mask<class_CanvasItem_set_light_mask>` **(** :ref:`int<class_int>` light_mask **)** |
|
| 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:`Material<class_material>` material **)** |
|
| void | :ref:`set_material<class_CanvasItem_set_material>` **(** :ref:`Material<class_material>` material **)** |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_modulate<class_CanvasItem_set_modulate>` **(** :ref:`Color<class_color>` modulate **)** |
|
| void | :ref:`set_modulate<class_CanvasItem_set_modulate>` **(** :ref:`Color<class_color>` modulate **)** |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_notify_local_transform<class_CanvasItem_set_notify_local_transform>` **(** :ref:`bool<class_bool>` enable **)** |
|
| void | :ref:`set_notify_local_transform<class_CanvasItem_set_notify_local_transform>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_notify_transform<class_CanvasItem_set_notify_transform>` **(** :ref:`bool<class_bool>` enable **)** |
|
| void | :ref:`set_notify_transform<class_CanvasItem_set_notify_transform>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_self_modulate<class_CanvasItem_set_self_modulate>` **(** :ref:`Color<class_color>` self_modulate **)** |
|
| void | :ref:`set_self_modulate<class_CanvasItem_set_self_modulate>` **(** :ref:`Color<class_color>` self_modulate **)** |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_use_parent_material<class_CanvasItem_set_use_parent_material>` **(** :ref:`bool<class_bool>` enable **)** |
|
| void | :ref:`set_use_parent_material<class_CanvasItem_set_use_parent_material>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_visible<class_CanvasItem_set_visible>` **(** :ref:`bool<class_bool>` arg0 **)** |
|
| void | :ref:`set_visible<class_CanvasItem_set_visible>` **(** :ref:`bool<class_bool>` visible **)** |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`show<class_CanvasItem_show>` **(** **)** |
|
| void | :ref:`show<class_CanvasItem_show>` **(** **)** |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`update<class_CanvasItem_update>` **(** **)** |
|
| void | :ref:`update<class_CanvasItem_update>` **(** **)** |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Signals
|
Signals
|
||||||
-------
|
-------
|
||||||
@@ -162,7 +162,7 @@ Member Variables
|
|||||||
----------------
|
----------------
|
||||||
|
|
||||||
- :ref:`int<class_int>` **light_mask**
|
- :ref:`int<class_int>` **light_mask**
|
||||||
- ShaderMaterial,CanvasItemMaterial **material**
|
- :ref:`Material<class_material>` **material**
|
||||||
- :ref:`Color<class_color>` **modulate**
|
- :ref:`Color<class_color>` **modulate**
|
||||||
- :ref:`Color<class_color>` **self_modulate**
|
- :ref:`Color<class_color>` **self_modulate**
|
||||||
- :ref:`bool<class_bool>` **show_behind_parent**
|
- :ref:`bool<class_bool>` **show_behind_parent**
|
||||||
@@ -208,7 +208,7 @@ Called (if exists) to draw the canvas item.
|
|||||||
|
|
||||||
.. _class_CanvasItem_draw_char:
|
.. _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) **)**
|
- :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=null **)**
|
||||||
|
|
||||||
Draw a string character using a custom font. Returns the advance, depending on the char width and kerning with an optional next char.
|
Draw a string character using a custom font. Returns the advance, depending on the char width and kerning with an optional next char.
|
||||||
|
|
||||||
@@ -220,39 +220,39 @@ Draw a colored circle.
|
|||||||
|
|
||||||
.. _class_CanvasItem_draw_colored_polygon:
|
.. _class_CanvasItem_draw_colored_polygon:
|
||||||
|
|
||||||
- void **draw_colored_polygon** **(** :ref:`PoolVector2Array<class_poolvector2array>` points, :ref:`Color<class_color>` color, :ref:`PoolVector2Array<class_poolvector2array>` uvs=PoolVector2Array([]), :ref:`Texture<class_texture>` texture=NULL, :ref:`Texture<class_texture>` normal_map=NULL **)**
|
- void **draw_colored_polygon** **(** :ref:`PoolVector2Array<class_poolvector2array>` points, :ref:`Color<class_color>` color, :ref:`PoolVector2Array<class_poolvector2array>` uvs=null, :ref:`Texture<class_texture>` texture=PoolVector2Array( ), :ref:`Texture<class_texture>` normal_map=null, :ref:`bool<class_bool>` antialiased=null **)**
|
||||||
|
|
||||||
Draw a colored polygon of any amount of points, convex or concave.
|
Draw a colored polygon of any amount of points, convex or concave.
|
||||||
|
|
||||||
.. _class_CanvasItem_draw_line:
|
.. _class_CanvasItem_draw_line:
|
||||||
|
|
||||||
- void **draw_line** **(** :ref:`Vector2<class_vector2>` from, :ref:`Vector2<class_vector2>` to, :ref:`Color<class_color>` color, :ref:`float<class_float>` width=1, :ref:`bool<class_bool>` antialiased=false **)**
|
- void **draw_line** **(** :ref:`Vector2<class_vector2>` from, :ref:`Vector2<class_vector2>` to, :ref:`Color<class_color>` color, :ref:`float<class_float>` width=null, :ref:`bool<class_bool>` antialiased=null **)**
|
||||||
|
|
||||||
Draw a line from a 2D point to another, with a given color and width. It can be optionally antialiased.
|
Draw a line from a 2D point to another, with a given color and width. It can be optionally antialiased.
|
||||||
|
|
||||||
.. _class_CanvasItem_draw_polygon:
|
.. _class_CanvasItem_draw_polygon:
|
||||||
|
|
||||||
- void **draw_polygon** **(** :ref:`PoolVector2Array<class_poolvector2array>` points, :ref:`PoolColorArray<class_poolcolorarray>` colors, :ref:`PoolVector2Array<class_poolvector2array>` uvs=PoolVector2Array([]), :ref:`Texture<class_texture>` texture=NULL, :ref:`Texture<class_texture>` normal_map=NULL **)**
|
- void **draw_polygon** **(** :ref:`PoolVector2Array<class_poolvector2array>` points, :ref:`PoolColorArray<class_poolcolorarray>` colors, :ref:`PoolVector2Array<class_poolvector2array>` uvs=null, :ref:`Texture<class_texture>` texture=PoolVector2Array( ), :ref:`Texture<class_texture>` normal_map=null, :ref:`bool<class_bool>` antialiased=null **)**
|
||||||
|
|
||||||
Draw a polygon of any amount of points, convex or concave.
|
Draw a polygon of any amount of points, convex or concave.
|
||||||
|
|
||||||
.. _class_CanvasItem_draw_polyline:
|
.. _class_CanvasItem_draw_polyline:
|
||||||
|
|
||||||
- void **draw_polyline** **(** :ref:`PoolVector2Array<class_poolvector2array>` points, :ref:`Color<class_color>` color, :ref:`float<class_float>` width=1, :ref:`bool<class_bool>` antialiased=false **)**
|
- void **draw_polyline** **(** :ref:`PoolVector2Array<class_poolvector2array>` points, :ref:`Color<class_color>` color, :ref:`float<class_float>` width=null, :ref:`bool<class_bool>` antialiased=null **)**
|
||||||
|
|
||||||
.. _class_CanvasItem_draw_polyline_colors:
|
.. _class_CanvasItem_draw_polyline_colors:
|
||||||
|
|
||||||
- void **draw_polyline_colors** **(** :ref:`PoolVector2Array<class_poolvector2array>` points, :ref:`PoolColorArray<class_poolcolorarray>` colors, :ref:`float<class_float>` width=1, :ref:`bool<class_bool>` antialiased=false **)**
|
- void **draw_polyline_colors** **(** :ref:`PoolVector2Array<class_poolvector2array>` points, :ref:`PoolColorArray<class_poolcolorarray>` colors, :ref:`float<class_float>` width=null, :ref:`bool<class_bool>` antialiased=null **)**
|
||||||
|
|
||||||
.. _class_CanvasItem_draw_primitive:
|
.. _class_CanvasItem_draw_primitive:
|
||||||
|
|
||||||
- void **draw_primitive** **(** :ref:`PoolVector2Array<class_poolvector2array>` points, :ref:`PoolColorArray<class_poolcolorarray>` colors, :ref:`PoolVector2Array<class_poolvector2array>` uvs, :ref:`Texture<class_texture>` texture=NULL, :ref:`float<class_float>` width=1, :ref:`Texture<class_texture>` normal_map=NULL **)**
|
- void **draw_primitive** **(** :ref:`PoolVector2Array<class_poolvector2array>` points, :ref:`PoolColorArray<class_poolcolorarray>` colors, :ref:`PoolVector2Array<class_poolvector2array>` uvs, :ref:`Texture<class_texture>` texture=null, :ref:`float<class_float>` width=null, :ref:`Texture<class_texture>` normal_map=null **)**
|
||||||
|
|
||||||
Draw a custom primitive, 1 point for a point, 2 points for a line, 3 points for a triangle and 4 points for a quad.
|
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:
|
.. _class_CanvasItem_draw_rect:
|
||||||
|
|
||||||
- void **draw_rect** **(** :ref:`Rect2<class_rect2>` rect, :ref:`Color<class_color>` color, :ref:`bool<class_bool>` filled=true **)**
|
- void **draw_rect** **(** :ref:`Rect2<class_rect2>` rect, :ref:`Color<class_color>` color, :ref:`bool<class_bool>` filled=null **)**
|
||||||
|
|
||||||
Draw a colored rectangle.
|
Draw a colored rectangle.
|
||||||
|
|
||||||
@@ -268,7 +268,7 @@ Set a custom transform for drawing. Anything drawn afterwards will be transforme
|
|||||||
|
|
||||||
.. _class_CanvasItem_draw_string:
|
.. _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 **)**
|
- void **draw_string** **(** :ref:`Font<class_font>` font, :ref:`Vector2<class_vector2>` pos, :ref:`String<class_string>` text, :ref:`Color<class_color>` modulate=null, :ref:`int<class_int>` clip_w=null **)**
|
||||||
|
|
||||||
Draw a string using a custom font.
|
Draw a string using a custom font.
|
||||||
|
|
||||||
@@ -280,19 +280,19 @@ Draw a styled rectangle.
|
|||||||
|
|
||||||
.. _class_CanvasItem_draw_texture:
|
.. _class_CanvasItem_draw_texture:
|
||||||
|
|
||||||
- void **draw_texture** **(** :ref:`Texture<class_texture>` texture, :ref:`Vector2<class_vector2>` pos, :ref:`Color<class_color>` modulate=Color(1,1,1,1), :ref:`Texture<class_texture>` normal_map=NULL **)**
|
- void **draw_texture** **(** :ref:`Texture<class_texture>` texture, :ref:`Vector2<class_vector2>` pos, :ref:`Color<class_color>` modulate=null, :ref:`Texture<class_texture>` normal_map=null **)**
|
||||||
|
|
||||||
Draw a texture at a given position.
|
Draw a texture at a given position.
|
||||||
|
|
||||||
.. _class_CanvasItem_draw_texture_rect:
|
.. _class_CanvasItem_draw_texture_rect:
|
||||||
|
|
||||||
- void **draw_texture_rect** **(** :ref:`Texture<class_texture>` texture, :ref:`Rect2<class_rect2>` rect, :ref:`bool<class_bool>` tile, :ref:`Color<class_color>` modulate=Color(1,1,1,1), :ref:`bool<class_bool>` transpose=false, :ref:`Texture<class_texture>` normal_map=NULL **)**
|
- void **draw_texture_rect** **(** :ref:`Texture<class_texture>` texture, :ref:`Rect2<class_rect2>` rect, :ref:`bool<class_bool>` tile, :ref:`Color<class_color>` modulate=null, :ref:`bool<class_bool>` transpose=null, :ref:`Texture<class_texture>` normal_map=null **)**
|
||||||
|
|
||||||
Draw a textured rectangle at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture.
|
Draw a textured rectangle at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture.
|
||||||
|
|
||||||
.. _class_CanvasItem_draw_texture_rect_region:
|
.. _class_CanvasItem_draw_texture_rect_region:
|
||||||
|
|
||||||
- void **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, :ref:`Texture<class_texture>` normal_map=NULL, :ref:`bool<class_bool>` clip_uv=true **)**
|
- void **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=null, :ref:`Texture<class_texture>` normal_map=null, :ref:`bool<class_bool>` clip_uv=null **)**
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
@@ -422,7 +422,7 @@ Get this item's transform in relation to the viewport.
|
|||||||
|
|
||||||
.. _class_CanvasItem_get_world_2d:
|
.. _class_CanvasItem_get_world_2d:
|
||||||
|
|
||||||
- :ref:`Object<class_object>` **get_world_2d** **(** **)** const
|
- :ref:`World2D<class_world2d>` **get_world_2d** **(** **)** const
|
||||||
|
|
||||||
Get the :ref:`World2D<class_world2d>` where this item is in.
|
Get the :ref:`World2D<class_world2d>` where this item is in.
|
||||||
|
|
||||||
@@ -468,7 +468,7 @@ Return true if this CanvasItem is visible. It may be invisible because itself or
|
|||||||
|
|
||||||
.. _class_CanvasItem_make_input_local:
|
.. _class_CanvasItem_make_input_local:
|
||||||
|
|
||||||
- :ref:`Object<class_object>` **make_input_local** **(** :ref:`Object<class_object>` event **)** const
|
- :ref:`InputEvent<class_inputevent>` **make_input_local** **(** :ref:`InputEvent<class_inputevent>` event **)** const
|
||||||
|
|
||||||
.. _class_CanvasItem_set_as_toplevel:
|
.. _class_CanvasItem_set_as_toplevel:
|
||||||
|
|
||||||
@@ -522,7 +522,7 @@ Set whether or not this item should use its parent's material.
|
|||||||
|
|
||||||
.. _class_CanvasItem_set_visible:
|
.. _class_CanvasItem_set_visible:
|
||||||
|
|
||||||
- void **set_visible** **(** :ref:`bool<class_bool>` arg0 **)**
|
- void **set_visible** **(** :ref:`bool<class_bool>` visible **)**
|
||||||
|
|
||||||
Set whether this item should be visible or not.
|
Set whether this item should be visible or not.
|
||||||
|
|
||||||
|
|||||||
@@ -20,37 +20,37 @@ Canvas Item layer.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Viewport<class_viewport>` | :ref:`get_custom_viewport<class_CanvasLayer_get_custom_viewport>` **(** **)** const |
|
| :ref:`Node<class_node>` | :ref:`get_custom_viewport<class_CanvasLayer_get_custom_viewport>` **(** **)** const |
|
||||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_layer<class_CanvasLayer_get_layer>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_layer<class_CanvasLayer_get_layer>` **(** **)** const |
|
||||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_offset<class_CanvasLayer_get_offset>` **(** **)** const |
|
| :ref:`Vector2<class_vector2>` | :ref:`get_offset<class_CanvasLayer_get_offset>` **(** **)** const |
|
||||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_rotation<class_CanvasLayer_get_rotation>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_rotation<class_CanvasLayer_get_rotation>` **(** **)** const |
|
||||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_rotationd<class_CanvasLayer_get_rotationd>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_rotationd<class_CanvasLayer_get_rotationd>` **(** **)** const |
|
||||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_scale<class_CanvasLayer_get_scale>` **(** **)** const |
|
| :ref:`Vector2<class_vector2>` | :ref:`get_scale<class_CanvasLayer_get_scale>` **(** **)** const |
|
||||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Transform2D<class_transform2d>` | :ref:`get_transform<class_CanvasLayer_get_transform>` **(** **)** const |
|
| :ref:`Transform2D<class_transform2d>` | :ref:`get_transform<class_CanvasLayer_get_transform>` **(** **)** const |
|
||||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`World2D<class_world2d>` | :ref:`get_world_2d<class_CanvasLayer_get_world_2d>` **(** **)** const |
|
| :ref:`World2D<class_world2d>` | :ref:`get_world_2d<class_CanvasLayer_get_world_2d>` **(** **)** const |
|
||||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_custom_viewport<class_CanvasLayer_set_custom_viewport>` **(** :ref:`Viewport<class_viewport>` viewport **)** |
|
| void | :ref:`set_custom_viewport<class_CanvasLayer_set_custom_viewport>` **(** :ref:`Node<class_node>` viewport **)** |
|
||||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_layer<class_CanvasLayer_set_layer>` **(** :ref:`int<class_int>` layer **)** |
|
| 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_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_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_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_scale<class_CanvasLayer_set_scale>` **(** :ref:`Vector2<class_vector2>` scale **)** |
|
||||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_transform<class_CanvasLayer_set_transform>` **(** :ref:`Transform2D<class_transform2d>` transform **)** |
|
| void | :ref:`set_transform<class_CanvasLayer_set_transform>` **(** :ref:`Transform2D<class_transform2d>` transform **)** |
|
||||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
@@ -70,7 +70,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_CanvasLayer_get_custom_viewport:
|
.. _class_CanvasLayer_get_custom_viewport:
|
||||||
|
|
||||||
- :ref:`Viewport<class_viewport>` **get_custom_viewport** **(** **)** const
|
- :ref:`Node<class_node>` **get_custom_viewport** **(** **)** const
|
||||||
|
|
||||||
.. _class_CanvasLayer_get_layer:
|
.. _class_CanvasLayer_get_layer:
|
||||||
|
|
||||||
@@ -116,7 +116,7 @@ Return the :ref:`World2D<class_world2d>` used by this layer.
|
|||||||
|
|
||||||
.. _class_CanvasLayer_set_custom_viewport:
|
.. _class_CanvasLayer_set_custom_viewport:
|
||||||
|
|
||||||
- void **set_custom_viewport** **(** :ref:`Viewport<class_viewport>` viewport **)**
|
- void **set_custom_viewport** **(** :ref:`Node<class_node>` viewport **)**
|
||||||
|
|
||||||
.. _class_CanvasLayer_set_layer:
|
.. _class_CanvasLayer_set_layer:
|
||||||
|
|
||||||
|
|||||||
@@ -18,47 +18,47 @@ Brief Description
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`can_instance<class_ClassDB_can_instance>` **(** :ref:`String<class_string>` class **)** const |
|
| :ref:`bool<class_bool>` | :ref:`can_instance<class_ClassDB_can_instance>` **(** :ref:`String<class_string>` class **)** const |
|
||||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`class_exists<class_ClassDB_class_exists>` **(** :ref:`String<class_string>` class **)** const |
|
| :ref:`bool<class_bool>` | :ref:`class_exists<class_ClassDB_class_exists>` **(** :ref:`String<class_string>` class **)** const |
|
||||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`class_get_category<class_ClassDB_class_get_category>` **(** :ref:`String<class_string>` class **)** const |
|
| :ref:`String<class_string>` | :ref:`class_get_category<class_ClassDB_class_get_category>` **(** :ref:`String<class_string>` class **)** const |
|
||||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`class_get_integer_constant<class_ClassDB_class_get_integer_constant>` **(** :ref:`String<class_string>` class, :ref:`String<class_string>` name **)** const |
|
| :ref:`int<class_int>` | :ref:`class_get_integer_constant<class_ClassDB_class_get_integer_constant>` **(** :ref:`String<class_string>` class, :ref:`String<class_string>` name **)** const |
|
||||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`class_get_integer_constant_list<class_ClassDB_class_get_integer_constant_list>` **(** :ref:`String<class_string>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const |
|
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`class_get_integer_constant_list<class_ClassDB_class_get_integer_constant_list>` **(** :ref:`String<class_string>` class, :ref:`bool<class_bool>` no_inheritance=null **)** const |
|
||||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Array<class_array>` | :ref:`class_get_method_list<class_ClassDB_class_get_method_list>` **(** :ref:`String<class_string>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const |
|
| :ref:`Array<class_array>` | :ref:`class_get_method_list<class_ClassDB_class_get_method_list>` **(** :ref:`String<class_string>` class, :ref:`bool<class_bool>` no_inheritance=null **)** const |
|
||||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Variant<class_variant>` | :ref:`class_get_property<class_ClassDB_class_get_property>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` property **)** const |
|
| :ref:`Variant<class_variant>` | :ref:`class_get_property<class_ClassDB_class_get_property>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` property **)** const |
|
||||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Array<class_array>` | :ref:`class_get_property_list<class_ClassDB_class_get_property_list>` **(** :ref:`String<class_string>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const |
|
| :ref:`Array<class_array>` | :ref:`class_get_property_list<class_ClassDB_class_get_property_list>` **(** :ref:`String<class_string>` class, :ref:`bool<class_bool>` no_inheritance=null **)** const |
|
||||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Dictionary<class_dictionary>` | :ref:`class_get_signal<class_ClassDB_class_get_signal>` **(** :ref:`String<class_string>` class, :ref:`String<class_string>` signal **)** const |
|
| :ref:`Dictionary<class_dictionary>` | :ref:`class_get_signal<class_ClassDB_class_get_signal>` **(** :ref:`String<class_string>` class, :ref:`String<class_string>` signal **)** const |
|
||||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Array<class_array>` | :ref:`class_get_signal_list<class_ClassDB_class_get_signal_list>` **(** :ref:`String<class_string>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const |
|
| :ref:`Array<class_array>` | :ref:`class_get_signal_list<class_ClassDB_class_get_signal_list>` **(** :ref:`String<class_string>` class, :ref:`bool<class_bool>` no_inheritance=null **)** const |
|
||||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`class_has_integer_constant<class_ClassDB_class_has_integer_constant>` **(** :ref:`String<class_string>` class, :ref:`String<class_string>` name **)** const |
|
| :ref:`bool<class_bool>` | :ref:`class_has_integer_constant<class_ClassDB_class_has_integer_constant>` **(** :ref:`String<class_string>` class, :ref:`String<class_string>` name **)** const |
|
||||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`class_has_method<class_ClassDB_class_has_method>` **(** :ref:`String<class_string>` class, :ref:`String<class_string>` method, :ref:`bool<class_bool>` no_inheritance=false **)** const |
|
| :ref:`bool<class_bool>` | :ref:`class_has_method<class_ClassDB_class_has_method>` **(** :ref:`String<class_string>` class, :ref:`String<class_string>` method, :ref:`bool<class_bool>` no_inheritance=null **)** const |
|
||||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`class_has_signal<class_ClassDB_class_has_signal>` **(** :ref:`String<class_string>` class, :ref:`String<class_string>` signal **)** const |
|
| :ref:`bool<class_bool>` | :ref:`class_has_signal<class_ClassDB_class_has_signal>` **(** :ref:`String<class_string>` class, :ref:`String<class_string>` signal **)** const |
|
||||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| Error | :ref:`class_set_property<class_ClassDB_class_set_property>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)** const |
|
| :ref:`int<class_int>` | :ref:`class_set_property<class_ClassDB_class_set_property>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)** const |
|
||||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_class_list<class_ClassDB_get_class_list>` **(** **)** const |
|
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_class_list<class_ClassDB_get_class_list>` **(** **)** const |
|
||||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_inheriters_from_class<class_ClassDB_get_inheriters_from_class>` **(** :ref:`String<class_string>` class **)** const |
|
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_inheriters_from_class<class_ClassDB_get_inheriters_from_class>` **(** :ref:`String<class_string>` class **)** const |
|
||||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`get_parent_class<class_ClassDB_get_parent_class>` **(** :ref:`String<class_string>` class **)** const |
|
| :ref:`String<class_string>` | :ref:`get_parent_class<class_ClassDB_get_parent_class>` **(** :ref:`String<class_string>` class **)** const |
|
||||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Variant<class_variant>` | :ref:`instance<class_ClassDB_instance>` **(** :ref:`String<class_string>` class **)** const |
|
| :ref:`Variant<class_variant>` | :ref:`instance<class_ClassDB_instance>` **(** :ref:`String<class_string>` class **)** const |
|
||||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_class_enabled<class_ClassDB_is_class_enabled>` **(** :ref:`String<class_string>` class **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_class_enabled<class_ClassDB_is_class_enabled>` **(** :ref:`String<class_string>` class **)** const |
|
||||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_parent_class<class_ClassDB_is_parent_class>` **(** :ref:`String<class_string>` class, :ref:`String<class_string>` inherits **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_parent_class<class_ClassDB_is_parent_class>` **(** :ref:`String<class_string>` class, :ref:`String<class_string>` inherits **)** const |
|
||||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Member Function Description
|
Member Function Description
|
||||||
---------------------------
|
---------------------------
|
||||||
@@ -81,11 +81,11 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_ClassDB_class_get_integer_constant_list:
|
.. _class_ClassDB_class_get_integer_constant_list:
|
||||||
|
|
||||||
- :ref:`PoolStringArray<class_poolstringarray>` **class_get_integer_constant_list** **(** :ref:`String<class_string>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const
|
- :ref:`PoolStringArray<class_poolstringarray>` **class_get_integer_constant_list** **(** :ref:`String<class_string>` class, :ref:`bool<class_bool>` no_inheritance=null **)** const
|
||||||
|
|
||||||
.. _class_ClassDB_class_get_method_list:
|
.. _class_ClassDB_class_get_method_list:
|
||||||
|
|
||||||
- :ref:`Array<class_array>` **class_get_method_list** **(** :ref:`String<class_string>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const
|
- :ref:`Array<class_array>` **class_get_method_list** **(** :ref:`String<class_string>` class, :ref:`bool<class_bool>` no_inheritance=null **)** const
|
||||||
|
|
||||||
.. _class_ClassDB_class_get_property:
|
.. _class_ClassDB_class_get_property:
|
||||||
|
|
||||||
@@ -93,7 +93,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_ClassDB_class_get_property_list:
|
.. _class_ClassDB_class_get_property_list:
|
||||||
|
|
||||||
- :ref:`Array<class_array>` **class_get_property_list** **(** :ref:`String<class_string>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const
|
- :ref:`Array<class_array>` **class_get_property_list** **(** :ref:`String<class_string>` class, :ref:`bool<class_bool>` no_inheritance=null **)** const
|
||||||
|
|
||||||
.. _class_ClassDB_class_get_signal:
|
.. _class_ClassDB_class_get_signal:
|
||||||
|
|
||||||
@@ -101,7 +101,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_ClassDB_class_get_signal_list:
|
.. _class_ClassDB_class_get_signal_list:
|
||||||
|
|
||||||
- :ref:`Array<class_array>` **class_get_signal_list** **(** :ref:`String<class_string>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const
|
- :ref:`Array<class_array>` **class_get_signal_list** **(** :ref:`String<class_string>` class, :ref:`bool<class_bool>` no_inheritance=null **)** const
|
||||||
|
|
||||||
.. _class_ClassDB_class_has_integer_constant:
|
.. _class_ClassDB_class_has_integer_constant:
|
||||||
|
|
||||||
@@ -109,7 +109,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_ClassDB_class_has_method:
|
.. _class_ClassDB_class_has_method:
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **class_has_method** **(** :ref:`String<class_string>` class, :ref:`String<class_string>` method, :ref:`bool<class_bool>` no_inheritance=false **)** const
|
- :ref:`bool<class_bool>` **class_has_method** **(** :ref:`String<class_string>` class, :ref:`String<class_string>` method, :ref:`bool<class_bool>` no_inheritance=null **)** const
|
||||||
|
|
||||||
.. _class_ClassDB_class_has_signal:
|
.. _class_ClassDB_class_has_signal:
|
||||||
|
|
||||||
@@ -117,7 +117,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_ClassDB_class_set_property:
|
.. _class_ClassDB_class_set_property:
|
||||||
|
|
||||||
- Error **class_set_property** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)** const
|
- :ref:`int<class_int>` **class_set_property** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)** const
|
||||||
|
|
||||||
.. _class_ClassDB_get_class_list:
|
.. _class_ClassDB_get_class_list:
|
||||||
|
|
||||||
|
|||||||
@@ -23,30 +23,46 @@ Member Functions
|
|||||||
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`_input_event<class_CollisionObject__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 **)** virtual |
|
| void | :ref:`_input_event<class_CollisionObject__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 **)** virtual |
|
||||||
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`get_capture_input_on_drag<class_CollisionObject_get_capture_input_on_drag>` **(** **)** const |
|
|
||||||
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`int<class_int>` | :ref:`create_shape_owner<class_CollisionObject_create_shape_owner>` **(** :ref:`Object<class_object>` owner **)** |
|
| :ref:`int<class_int>` | :ref:`create_shape_owner<class_CollisionObject_create_shape_owner>` **(** :ref:`Object<class_object>` owner **)** |
|
||||||
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :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:`RID<class_rid>` | :ref:`get_rid<class_CollisionObject_get_rid>` **(** **)** const |
|
||||||
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Array<class_array>` | :ref:`get_shape_owners<class_CollisionObject_get_shape_owners>` **(** **)** |
|
| :ref:`Array<class_array>` | :ref:`get_shape_owners<class_CollisionObject_get_shape_owners>` **(** **)** |
|
||||||
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`shape_owner_clear_shapes<class_CollisionObject_shape_owner_clear_shapes>` **(** :ref:`int<class_int>` owner_id **)** |
|
|
||||||
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`Shape<class_shape>` | :ref:`shape_owner_get_shape<class_CollisionObject_shape_owner_get_shape>` **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** |
|
|
||||||
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`int<class_int>` | :ref:`shape_owner_get_shape_count<class_CollisionObject_shape_owner_get_shape_count>` **(** :ref:`int<class_int>` owner_id **)** |
|
|
||||||
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`Transform<class_transform>` | :ref:`shape_owner_get_transform<class_CollisionObject_shape_owner_get_transform>` **(** :ref:`int<class_int>` owner_id **)** |
|
|
||||||
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`shape_owner_remove_shape<class_CollisionObject_shape_owner_remove_shape>` **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** |
|
|
||||||
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_ray_pickable<class_CollisionObject_is_ray_pickable>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_ray_pickable<class_CollisionObject_is_ray_pickable>` **(** **)** const |
|
||||||
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`bool<class_bool>` | :ref:`is_shape_owner_disabled<class_CollisionObject_is_shape_owner_disabled>` **(** :ref:`int<class_int>` owner_id **)** const |
|
||||||
|
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`remove_shape_owner<class_CollisionObject_remove_shape_owner>` **(** :ref:`int<class_int>` owner_id **)** |
|
||||||
|
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_capture_input_on_drag<class_CollisionObject_set_capture_input_on_drag>` **(** :ref:`bool<class_bool>` enable **)** |
|
| 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_ray_pickable<class_CollisionObject_set_ray_pickable>` **(** :ref:`bool<class_bool>` ray_pickable **)** |
|
||||||
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`int<class_int>` | :ref:`shape_find_owner<class_CollisionObject_shape_find_owner>` **(** :ref:`int<class_int>` shape_index **)** const |
|
||||||
|
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`shape_owner_add_shape<class_CollisionObject_shape_owner_add_shape>` **(** :ref:`int<class_int>` owner_id, :ref:`Shape<class_shape>` shape **)** |
|
||||||
|
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`shape_owner_clear_shapes<class_CollisionObject_shape_owner_clear_shapes>` **(** :ref:`int<class_int>` owner_id **)** |
|
||||||
|
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`Object<class_object>` | :ref:`shape_owner_get_owner<class_CollisionObject_shape_owner_get_owner>` **(** :ref:`int<class_int>` owner_id **)** const |
|
||||||
|
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`Shape<class_shape>` | :ref:`shape_owner_get_shape<class_CollisionObject_shape_owner_get_shape>` **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** const |
|
||||||
|
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`int<class_int>` | :ref:`shape_owner_get_shape_count<class_CollisionObject_shape_owner_get_shape_count>` **(** :ref:`int<class_int>` owner_id **)** const |
|
||||||
|
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`int<class_int>` | :ref:`shape_owner_get_shape_index<class_CollisionObject_shape_owner_get_shape_index>` **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** const |
|
||||||
|
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`Transform<class_transform>` | :ref:`shape_owner_get_transform<class_CollisionObject_shape_owner_get_transform>` **(** :ref:`int<class_int>` owner_id **)** const |
|
||||||
|
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`shape_owner_remove_shape<class_CollisionObject_shape_owner_remove_shape>` **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** |
|
||||||
|
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`shape_owner_set_disabled<class_CollisionObject_shape_owner_set_disabled>` **(** :ref:`int<class_int>` owner_id, :ref:`bool<class_bool>` disabled **)** |
|
||||||
|
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`shape_owner_set_transform<class_CollisionObject_shape_owner_set_transform>` **(** :ref:`int<class_int>` owner_id, :ref:`Transform<class_transform>` transform **)** |
|
||||||
|
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Signals
|
Signals
|
||||||
-------
|
-------
|
||||||
@@ -68,16 +84,16 @@ Member Function Description
|
|||||||
|
|
||||||
- void **_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 **)** virtual
|
- void **_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 **)** virtual
|
||||||
|
|
||||||
.. _class_CollisionObject_get_capture_input_on_drag:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **get_capture_input_on_drag** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_CollisionObject_create_shape_owner:
|
.. _class_CollisionObject_create_shape_owner:
|
||||||
|
|
||||||
- :ref:`int<class_int>` **create_shape_owner** **(** :ref:`Object<class_object>` owner **)**
|
- :ref:`int<class_int>` **create_shape_owner** **(** :ref:`Object<class_object>` owner **)**
|
||||||
|
|
||||||
Creates new holder for the shapes. Argument is a :ref:`CollisionShape<class_collisionshape>` node. It will return owner_id which usually you will want to save for later use.
|
Creates new holder for the shapes. Argument is a :ref:`CollisionShape<class_collisionshape>` node. It will return owner_id which usually you will want to save for later use.
|
||||||
|
|
||||||
|
.. _class_CollisionObject_get_capture_input_on_drag:
|
||||||
|
|
||||||
|
- :ref:`bool<class_bool>` **get_capture_input_on_drag** **(** **)** const
|
||||||
|
|
||||||
.. _class_CollisionObject_get_rid:
|
.. _class_CollisionObject_get_rid:
|
||||||
|
|
||||||
- :ref:`RID<class_rid>` **get_rid** **(** **)** const
|
- :ref:`RID<class_rid>` **get_rid** **(** **)** const
|
||||||
@@ -88,40 +104,18 @@ Creates new holder for the shapes. Argument is a :ref:`CollisionShape<class_coll
|
|||||||
|
|
||||||
Shape owner is a node which is holding concrete shape resources. This method will return an array which is holding an integer numbers that are representing unique ID of each owner. You can use those ids when you are using others shape_owner methods.
|
Shape owner is a node which is holding concrete shape resources. This method will return an array which is holding an integer numbers that are representing unique ID of each owner. You can use those ids when you are using others shape_owner methods.
|
||||||
|
|
||||||
.. _class_CollisionObject_shape_owner_clear_shapes:
|
|
||||||
|
|
||||||
- void **shape_owner_clear_shapes** **(** :ref:`int<class_int>` owner_id **)**
|
|
||||||
|
|
||||||
Will remove all the shapes associated with given owner.
|
|
||||||
|
|
||||||
.. _class_CollisionObject_shape_owner_get_shape:
|
|
||||||
|
|
||||||
- :ref:`Shape<class_shape>` **shape_owner_get_shape** **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)**
|
|
||||||
|
|
||||||
Will return a :ref:`Shape<class_shape>`. First argument owner_id is an integer that can be obtained from :ref:`get_shape_owners<class_CollisionObject_get_shape_owners>`. Shape_id is a position of the shape inside owner; it's a value in range from 0 to :ref:`shape_owner_get_shape_count<class_CollisionObject_shape_owner_get_shape_count>`.
|
|
||||||
|
|
||||||
.. _class_CollisionObject_shape_owner_get_shape_count:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **shape_owner_get_shape_count** **(** :ref:`int<class_int>` owner_id **)**
|
|
||||||
|
|
||||||
Returns number of shapes to which given owner is associated to.
|
|
||||||
|
|
||||||
.. _class_CollisionObject_shape_owner_get_transform:
|
|
||||||
|
|
||||||
- :ref:`Transform<class_transform>` **shape_owner_get_transform** **(** :ref:`int<class_int>` owner_id **)**
|
|
||||||
|
|
||||||
Will return :ref:`Transform<class_transform>` of an owner node.
|
|
||||||
|
|
||||||
.. _class_CollisionObject_shape_owner_remove_shape:
|
|
||||||
|
|
||||||
- void **shape_owner_remove_shape** **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)**
|
|
||||||
|
|
||||||
Removes related shape from the owner.
|
|
||||||
|
|
||||||
.. _class_CollisionObject_is_ray_pickable:
|
.. _class_CollisionObject_is_ray_pickable:
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_ray_pickable** **(** **)** const
|
- :ref:`bool<class_bool>` **is_ray_pickable** **(** **)** const
|
||||||
|
|
||||||
|
.. _class_CollisionObject_is_shape_owner_disabled:
|
||||||
|
|
||||||
|
- :ref:`bool<class_bool>` **is_shape_owner_disabled** **(** :ref:`int<class_int>` owner_id **)** const
|
||||||
|
|
||||||
|
.. _class_CollisionObject_remove_shape_owner:
|
||||||
|
|
||||||
|
- void **remove_shape_owner** **(** :ref:`int<class_int>` owner_id **)**
|
||||||
|
|
||||||
.. _class_CollisionObject_set_capture_input_on_drag:
|
.. _class_CollisionObject_set_capture_input_on_drag:
|
||||||
|
|
||||||
- void **set_capture_input_on_drag** **(** :ref:`bool<class_bool>` enable **)**
|
- void **set_capture_input_on_drag** **(** :ref:`bool<class_bool>` enable **)**
|
||||||
@@ -130,4 +124,58 @@ Removes related shape from the owner.
|
|||||||
|
|
||||||
- void **set_ray_pickable** **(** :ref:`bool<class_bool>` ray_pickable **)**
|
- void **set_ray_pickable** **(** :ref:`bool<class_bool>` ray_pickable **)**
|
||||||
|
|
||||||
|
.. _class_CollisionObject_shape_find_owner:
|
||||||
|
|
||||||
|
- :ref:`int<class_int>` **shape_find_owner** **(** :ref:`int<class_int>` shape_index **)** const
|
||||||
|
|
||||||
|
.. _class_CollisionObject_shape_owner_add_shape:
|
||||||
|
|
||||||
|
- void **shape_owner_add_shape** **(** :ref:`int<class_int>` owner_id, :ref:`Shape<class_shape>` shape **)**
|
||||||
|
|
||||||
|
.. _class_CollisionObject_shape_owner_clear_shapes:
|
||||||
|
|
||||||
|
- void **shape_owner_clear_shapes** **(** :ref:`int<class_int>` owner_id **)**
|
||||||
|
|
||||||
|
Will remove all the shapes associated with given owner.
|
||||||
|
|
||||||
|
.. _class_CollisionObject_shape_owner_get_owner:
|
||||||
|
|
||||||
|
- :ref:`Object<class_object>` **shape_owner_get_owner** **(** :ref:`int<class_int>` owner_id **)** const
|
||||||
|
|
||||||
|
.. _class_CollisionObject_shape_owner_get_shape:
|
||||||
|
|
||||||
|
- :ref:`Shape<class_shape>` **shape_owner_get_shape** **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** const
|
||||||
|
|
||||||
|
Will return a :ref:`Shape<class_shape>`. First argument owner_id is an integer that can be obtained from :ref:`get_shape_owners<class_CollisionObject_get_shape_owners>`. Shape_id is a position of the shape inside owner; it's a value in range from 0 to :ref:`shape_owner_get_shape_count<class_CollisionObject_shape_owner_get_shape_count>`.
|
||||||
|
|
||||||
|
.. _class_CollisionObject_shape_owner_get_shape_count:
|
||||||
|
|
||||||
|
- :ref:`int<class_int>` **shape_owner_get_shape_count** **(** :ref:`int<class_int>` owner_id **)** const
|
||||||
|
|
||||||
|
Returns number of shapes to which given owner is associated to.
|
||||||
|
|
||||||
|
.. _class_CollisionObject_shape_owner_get_shape_index:
|
||||||
|
|
||||||
|
- :ref:`int<class_int>` **shape_owner_get_shape_index** **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** const
|
||||||
|
|
||||||
|
.. _class_CollisionObject_shape_owner_get_transform:
|
||||||
|
|
||||||
|
- :ref:`Transform<class_transform>` **shape_owner_get_transform** **(** :ref:`int<class_int>` owner_id **)** const
|
||||||
|
|
||||||
|
Will return :ref:`Transform<class_transform>` of an owner node.
|
||||||
|
|
||||||
|
.. _class_CollisionObject_shape_owner_remove_shape:
|
||||||
|
|
||||||
|
- void **shape_owner_remove_shape** **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)**
|
||||||
|
|
||||||
|
Removes related shape from the owner.
|
||||||
|
|
||||||
|
.. _class_CollisionObject_shape_owner_set_disabled:
|
||||||
|
|
||||||
|
- void **shape_owner_set_disabled** **(** :ref:`int<class_int>` owner_id, :ref:`bool<class_bool>` disabled **)**
|
||||||
|
|
||||||
|
.. _class_CollisionObject_shape_owner_set_transform:
|
||||||
|
|
||||||
|
- void **shape_owner_set_transform** **(** :ref:`int<class_int>` owner_id, :ref:`Transform<class_transform>` transform **)**
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -29,19 +29,39 @@ Member Functions
|
|||||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Array<class_array>` | :ref:`get_shape_owners<class_CollisionObject2D_get_shape_owners>` **(** **)** |
|
| :ref:`Array<class_array>` | :ref:`get_shape_owners<class_CollisionObject2D_get_shape_owners>` **(** **)** |
|
||||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`bool<class_bool>` | :ref:`is_pickable<class_CollisionObject2D_is_pickable>` **(** **)** const |
|
||||||
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`bool<class_bool>` | :ref:`is_shape_owner_disabled<class_CollisionObject2D_is_shape_owner_disabled>` **(** :ref:`int<class_int>` owner_id **)** const |
|
||||||
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`bool<class_bool>` | :ref:`is_shape_owner_one_way_collision_enabled<class_CollisionObject2D_is_shape_owner_one_way_collision_enabled>` **(** :ref:`int<class_int>` owner_id **)** const |
|
||||||
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`remove_shape_owner<class_CollisionObject2D_remove_shape_owner>` **(** :ref:`int<class_int>` owner_id **)** |
|
||||||
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`set_pickable<class_CollisionObject2D_set_pickable>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||||
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`int<class_int>` | :ref:`shape_find_owner<class_CollisionObject2D_shape_find_owner>` **(** :ref:`int<class_int>` shape_index **)** const |
|
||||||
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`shape_owner_add_shape<class_CollisionObject2D_shape_owner_add_shape>` **(** :ref:`int<class_int>` owner_id, :ref:`Shape2D<class_shape2d>` shape **)** |
|
||||||
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`shape_owner_clear_shapes<class_CollisionObject2D_shape_owner_clear_shapes>` **(** :ref:`int<class_int>` owner_id **)** |
|
| void | :ref:`shape_owner_clear_shapes<class_CollisionObject2D_shape_owner_clear_shapes>` **(** :ref:`int<class_int>` owner_id **)** |
|
||||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Shape2D<class_shape2d>` | :ref:`shape_owner_get_shape<class_CollisionObject2D_shape_owner_get_shape>` **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** |
|
| :ref:`Object<class_object>` | :ref:`shape_owner_get_owner<class_CollisionObject2D_shape_owner_get_owner>` **(** :ref:`int<class_int>` owner_id **)** const |
|
||||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`shape_owner_get_shape_count<class_CollisionObject2D_shape_owner_get_shape_count>` **(** :ref:`int<class_int>` owner_id **)** |
|
| :ref:`Shape2D<class_shape2d>` | :ref:`shape_owner_get_shape<class_CollisionObject2D_shape_owner_get_shape>` **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** const |
|
||||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Transform2D<class_transform2d>` | :ref:`shape_owner_get_transform<class_CollisionObject2D_shape_owner_get_transform>` **(** :ref:`int<class_int>` owner_id **)** |
|
| :ref:`int<class_int>` | :ref:`shape_owner_get_shape_count<class_CollisionObject2D_shape_owner_get_shape_count>` **(** :ref:`int<class_int>` owner_id **)** const |
|
||||||
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`int<class_int>` | :ref:`shape_owner_get_shape_index<class_CollisionObject2D_shape_owner_get_shape_index>` **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** const |
|
||||||
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`Transform2D<class_transform2d>` | :ref:`shape_owner_get_transform<class_CollisionObject2D_shape_owner_get_transform>` **(** :ref:`int<class_int>` owner_id **)** const |
|
||||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`shape_owner_remove_shape<class_CollisionObject2D_shape_owner_remove_shape>` **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** |
|
| void | :ref:`shape_owner_remove_shape<class_CollisionObject2D_shape_owner_remove_shape>` **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** |
|
||||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_pickable<class_CollisionObject2D_is_pickable>` **(** **)** const |
|
| void | :ref:`shape_owner_set_disabled<class_CollisionObject2D_shape_owner_set_disabled>` **(** :ref:`int<class_int>` owner_id, :ref:`bool<class_bool>` disabled **)** |
|
||||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_pickable<class_CollisionObject2D_set_pickable>` **(** :ref:`bool<class_bool>` enabled **)** |
|
| void | :ref:`shape_owner_set_one_way_collision<class_CollisionObject2D_shape_owner_set_one_way_collision>` **(** :ref:`int<class_int>` owner_id, :ref:`bool<class_bool>` enable **)** |
|
||||||
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`shape_owner_set_transform<class_CollisionObject2D_shape_owner_set_transform>` **(** :ref:`int<class_int>` owner_id, :ref:`Transform2D<class_transform2d>` transform **)** |
|
||||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Signals
|
Signals
|
||||||
@@ -90,27 +110,67 @@ Return the RID of this object.
|
|||||||
|
|
||||||
Shape owner is a node which is holding concrete shape resources. This method will return an array which is holding an integer numbers that are representing unique ID of each owner. You can use those ids when you are using others shape_owner methods.
|
Shape owner is a node which is holding concrete shape resources. This method will return an array which is holding an integer numbers that are representing unique ID of each owner. You can use those ids when you are using others shape_owner methods.
|
||||||
|
|
||||||
|
.. _class_CollisionObject2D_is_pickable:
|
||||||
|
|
||||||
|
- :ref:`bool<class_bool>` **is_pickable** **(** **)** const
|
||||||
|
|
||||||
|
Return whether this object is pickable.
|
||||||
|
|
||||||
|
.. _class_CollisionObject2D_is_shape_owner_disabled:
|
||||||
|
|
||||||
|
- :ref:`bool<class_bool>` **is_shape_owner_disabled** **(** :ref:`int<class_int>` owner_id **)** const
|
||||||
|
|
||||||
|
.. _class_CollisionObject2D_is_shape_owner_one_way_collision_enabled:
|
||||||
|
|
||||||
|
- :ref:`bool<class_bool>` **is_shape_owner_one_way_collision_enabled** **(** :ref:`int<class_int>` owner_id **)** const
|
||||||
|
|
||||||
|
.. _class_CollisionObject2D_remove_shape_owner:
|
||||||
|
|
||||||
|
- void **remove_shape_owner** **(** :ref:`int<class_int>` owner_id **)**
|
||||||
|
|
||||||
|
.. _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_shape_find_owner:
|
||||||
|
|
||||||
|
- :ref:`int<class_int>` **shape_find_owner** **(** :ref:`int<class_int>` shape_index **)** const
|
||||||
|
|
||||||
|
.. _class_CollisionObject2D_shape_owner_add_shape:
|
||||||
|
|
||||||
|
- void **shape_owner_add_shape** **(** :ref:`int<class_int>` owner_id, :ref:`Shape2D<class_shape2d>` shape **)**
|
||||||
|
|
||||||
.. _class_CollisionObject2D_shape_owner_clear_shapes:
|
.. _class_CollisionObject2D_shape_owner_clear_shapes:
|
||||||
|
|
||||||
- void **shape_owner_clear_shapes** **(** :ref:`int<class_int>` owner_id **)**
|
- void **shape_owner_clear_shapes** **(** :ref:`int<class_int>` owner_id **)**
|
||||||
|
|
||||||
Will remove all the shapes associated with given owner.
|
Will remove all the shapes associated with given owner.
|
||||||
|
|
||||||
|
.. _class_CollisionObject2D_shape_owner_get_owner:
|
||||||
|
|
||||||
|
- :ref:`Object<class_object>` **shape_owner_get_owner** **(** :ref:`int<class_int>` owner_id **)** const
|
||||||
|
|
||||||
.. _class_CollisionObject2D_shape_owner_get_shape:
|
.. _class_CollisionObject2D_shape_owner_get_shape:
|
||||||
|
|
||||||
- :ref:`Shape2D<class_shape2d>` **shape_owner_get_shape** **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)**
|
- :ref:`Shape2D<class_shape2d>` **shape_owner_get_shape** **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** const
|
||||||
|
|
||||||
Will return a :ref:`Shape2D<class_shape2d>`. First argument owner_id is an integer that can be obtained from :ref:`get_shape_owners<class_CollisionObject2D_get_shape_owners>`. Shape_id is a position of the shape inside owner; it's a value in range from 0 to :ref:`shape_owner_get_shape_count<class_CollisionObject2D_shape_owner_get_shape_count>`.
|
Will return a :ref:`Shape2D<class_shape2d>`. First argument owner_id is an integer that can be obtained from :ref:`get_shape_owners<class_CollisionObject2D_get_shape_owners>`. Shape_id is a position of the shape inside owner; it's a value in range from 0 to :ref:`shape_owner_get_shape_count<class_CollisionObject2D_shape_owner_get_shape_count>`.
|
||||||
|
|
||||||
.. _class_CollisionObject2D_shape_owner_get_shape_count:
|
.. _class_CollisionObject2D_shape_owner_get_shape_count:
|
||||||
|
|
||||||
- :ref:`int<class_int>` **shape_owner_get_shape_count** **(** :ref:`int<class_int>` owner_id **)**
|
- :ref:`int<class_int>` **shape_owner_get_shape_count** **(** :ref:`int<class_int>` owner_id **)** const
|
||||||
|
|
||||||
Returns number of shapes to which given owner is associated to.
|
Returns number of shapes to which given owner is associated to.
|
||||||
|
|
||||||
|
.. _class_CollisionObject2D_shape_owner_get_shape_index:
|
||||||
|
|
||||||
|
- :ref:`int<class_int>` **shape_owner_get_shape_index** **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** const
|
||||||
|
|
||||||
.. _class_CollisionObject2D_shape_owner_get_transform:
|
.. _class_CollisionObject2D_shape_owner_get_transform:
|
||||||
|
|
||||||
- :ref:`Transform2D<class_transform2d>` **shape_owner_get_transform** **(** :ref:`int<class_int>` owner_id **)**
|
- :ref:`Transform2D<class_transform2d>` **shape_owner_get_transform** **(** :ref:`int<class_int>` owner_id **)** const
|
||||||
|
|
||||||
Will return :ref:`Transform2D<class_transform2d>` of an owner node.
|
Will return :ref:`Transform2D<class_transform2d>` of an owner node.
|
||||||
|
|
||||||
@@ -120,16 +180,16 @@ Will return :ref:`Transform2D<class_transform2d>` of an owner node.
|
|||||||
|
|
||||||
Removes related shape from the owner.
|
Removes related shape from the owner.
|
||||||
|
|
||||||
.. _class_CollisionObject2D_is_pickable:
|
.. _class_CollisionObject2D_shape_owner_set_disabled:
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_pickable** **(** **)** const
|
- void **shape_owner_set_disabled** **(** :ref:`int<class_int>` owner_id, :ref:`bool<class_bool>` disabled **)**
|
||||||
|
|
||||||
Return whether this object is pickable.
|
.. _class_CollisionObject2D_shape_owner_set_one_way_collision:
|
||||||
|
|
||||||
.. _class_CollisionObject2D_set_pickable:
|
- void **shape_owner_set_one_way_collision** **(** :ref:`int<class_int>` owner_id, :ref:`bool<class_bool>` enable **)**
|
||||||
|
|
||||||
- void **set_pickable** **(** :ref:`bool<class_bool>` enabled **)**
|
.. _class_CollisionObject2D_shape_owner_set_transform:
|
||||||
|
|
||||||
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.
|
- void **shape_owner_set_transform** **(** :ref:`int<class_int>` owner_id, :ref:`Transform2D<class_transform2d>` transform **)**
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -18,19 +18,19 @@ Brief Description
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Object<class_object>` | :ref:`get_shape<class_CollisionShape_get_shape>` **(** **)** const |
|
| :ref:`Shape<class_shape>` | :ref:`get_shape<class_CollisionShape_get_shape>` **(** **)** const |
|
||||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_disabled<class_CollisionShape_is_disabled>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_disabled<class_CollisionShape_is_disabled>` **(** **)** const |
|
||||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`make_convex_from_brothers<class_CollisionShape_make_convex_from_brothers>` **(** **)** |
|
| void | :ref:`make_convex_from_brothers<class_CollisionShape_make_convex_from_brothers>` **(** **)** |
|
||||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`resource_changed<class_CollisionShape_resource_changed>` **(** :ref:`Object<class_object>` resource **)** |
|
| void | :ref:`resource_changed<class_CollisionShape_resource_changed>` **(** :ref:`Resource<class_resource>` resource **)** |
|
||||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_disabled<class_CollisionShape_set_disabled>` **(** :ref:`bool<class_bool>` enable **)** |
|
| void | :ref:`set_disabled<class_CollisionShape_set_disabled>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_shape<class_CollisionShape_set_shape>` **(** :ref:`Object<class_object>` shape **)** |
|
| void | :ref:`set_shape<class_CollisionShape_set_shape>` **(** :ref:`Shape<class_shape>` shape **)** |
|
||||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
@@ -43,7 +43,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_CollisionShape_get_shape:
|
.. _class_CollisionShape_get_shape:
|
||||||
|
|
||||||
- :ref:`Object<class_object>` **get_shape** **(** **)** const
|
- :ref:`Shape<class_shape>` **get_shape** **(** **)** const
|
||||||
|
|
||||||
.. _class_CollisionShape_is_disabled:
|
.. _class_CollisionShape_is_disabled:
|
||||||
|
|
||||||
@@ -55,7 +55,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_CollisionShape_resource_changed:
|
.. _class_CollisionShape_resource_changed:
|
||||||
|
|
||||||
- void **resource_changed** **(** :ref:`Object<class_object>` resource **)**
|
- void **resource_changed** **(** :ref:`Resource<class_resource>` resource **)**
|
||||||
|
|
||||||
.. _class_CollisionShape_set_disabled:
|
.. _class_CollisionShape_set_disabled:
|
||||||
|
|
||||||
@@ -63,6 +63,6 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_CollisionShape_set_shape:
|
.. _class_CollisionShape_set_shape:
|
||||||
|
|
||||||
- void **set_shape** **(** :ref:`Object<class_object>` shape **)**
|
- void **set_shape** **(** :ref:`Shape<class_shape>` shape **)**
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -18,19 +18,19 @@ Editor-only class for easy editing of shapes.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Object<class_object>` | :ref:`get_shape<class_CollisionShape2D_get_shape>` **(** **)** const |
|
| :ref:`Shape2D<class_shape2d>` | :ref:`get_shape<class_CollisionShape2D_get_shape>` **(** **)** const |
|
||||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_disabled<class_CollisionShape2D_is_disabled>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_disabled<class_CollisionShape2D_is_disabled>` **(** **)** const |
|
||||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_one_way_collision_enabled<class_CollisionShape2D_is_one_way_collision_enabled>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_one_way_collision_enabled<class_CollisionShape2D_is_one_way_collision_enabled>` **(** **)** const |
|
||||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_disabled<class_CollisionShape2D_set_disabled>` **(** :ref:`bool<class_bool>` disabled **)** |
|
| void | :ref:`set_disabled<class_CollisionShape2D_set_disabled>` **(** :ref:`bool<class_bool>` disabled **)** |
|
||||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_one_way_collision<class_CollisionShape2D_set_one_way_collision>` **(** :ref:`bool<class_bool>` enabled **)** |
|
| void | :ref:`set_one_way_collision<class_CollisionShape2D_set_one_way_collision>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_shape<class_CollisionShape2D_set_shape>` **(** :ref:`Object<class_object>` shape **)** |
|
| void | :ref:`set_shape<class_CollisionShape2D_set_shape>` **(** :ref:`Shape2D<class_shape2d>` shape **)** |
|
||||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
@@ -49,7 +49,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_CollisionShape2D_get_shape:
|
.. _class_CollisionShape2D_get_shape:
|
||||||
|
|
||||||
- :ref:`Object<class_object>` **get_shape** **(** **)** const
|
- :ref:`Shape2D<class_shape2d>` **get_shape** **(** **)** const
|
||||||
|
|
||||||
Return this shape's :ref:`Shape2D<class_shape2d>`.
|
Return this shape's :ref:`Shape2D<class_shape2d>`.
|
||||||
|
|
||||||
@@ -71,7 +71,7 @@ Return this shape's :ref:`Shape2D<class_shape2d>`.
|
|||||||
|
|
||||||
.. _class_CollisionShape2D_set_shape:
|
.. _class_CollisionShape2D_set_shape:
|
||||||
|
|
||||||
- void **set_shape** **(** :ref:`Object<class_object>` shape **)**
|
- void **set_shape** **(** :ref:`Shape2D<class_shape2d>` shape **)**
|
||||||
|
|
||||||
Set this shape's :ref:`Shape2D<class_shape2d>`. This will not appear as a node, but can be directly edited as a property.
|
Set this shape's :ref:`Shape2D<class_shape2d>`. This will not appear as a node, but can be directly edited as a property.
|
||||||
|
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ Member Functions
|
|||||||
----------------
|
----------------
|
||||||
|
|
||||||
+----------------------------+-------------------------------------------------------------------------------------------------------+
|
+----------------------------+-------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`add_preset<class_ColorPicker_add_preset>` **(** :ref:`Color<class_color>` arg0 **)** |
|
| void | :ref:`add_preset<class_ColorPicker_add_preset>` **(** :ref:`Color<class_color>` color **)** |
|
||||||
+----------------------------+-------------------------------------------------------------------------------------------------------+
|
+----------------------------+-------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Color<class_color>` | :ref:`get_pick_color<class_ColorPicker_get_pick_color>` **(** **)** const |
|
| :ref:`Color<class_color>` | :ref:`get_pick_color<class_ColorPicker_get_pick_color>` **(** **)** const |
|
||||||
+----------------------------+-------------------------------------------------------------------------------------------------------+
|
+----------------------------+-------------------------------------------------------------------------------------------------------+
|
||||||
@@ -51,7 +51,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_ColorPicker_add_preset:
|
.. _class_ColorPicker_add_preset:
|
||||||
|
|
||||||
- void **add_preset** **(** :ref:`Color<class_color>` arg0 **)**
|
- void **add_preset** **(** :ref:`Color<class_color>` 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.
|
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.
|
||||||
|
|
||||||
|
|||||||
@@ -25,15 +25,15 @@ Member Functions
|
|||||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_sections<class_ConfigFile_get_sections>` **(** **)** const |
|
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_sections<class_ConfigFile_get_sections>` **(** **)** const |
|
||||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Variant<class_variant>` | :ref:`get_value<class_ConfigFile_get_value>` **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, :ref:`Variant<class_variant>` default=NULL **)** const |
|
| :ref:`Variant<class_variant>` | :ref:`get_value<class_ConfigFile_get_value>` **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, :ref:`Variant<class_variant>` default=null **)** const |
|
||||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`has_section<class_ConfigFile_has_section>` **(** :ref:`String<class_string>` section **)** const |
|
| :ref:`bool<class_bool>` | :ref:`has_section<class_ConfigFile_has_section>` **(** :ref:`String<class_string>` section **)** const |
|
||||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :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:`bool<class_bool>` | :ref:`has_section_key<class_ConfigFile_has_section_key>` **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key **)** const |
|
||||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| Error | :ref:`load<class_ConfigFile_load>` **(** :ref:`String<class_string>` path **)** |
|
| :ref:`int<class_int>` | :ref:`load<class_ConfigFile_load>` **(** :ref:`String<class_string>` path **)** |
|
||||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| Error | :ref:`save<class_ConfigFile_save>` **(** :ref:`String<class_string>` path **)** |
|
| :ref:`int<class_int>` | :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, :ref:`Variant<class_variant>` value **)** |
|
| void | :ref:`set_value<class_ConfigFile_set_value>` **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, :ref:`Variant<class_variant>` value **)** |
|
||||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -79,7 +79,7 @@ Return an array of all defined section identifiers.
|
|||||||
|
|
||||||
.. _class_ConfigFile_get_value:
|
.. _class_ConfigFile_get_value:
|
||||||
|
|
||||||
- :ref:`Variant<class_variant>` **get_value** **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, :ref:`Variant<class_variant>` default=NULL **)** const
|
- :ref:`Variant<class_variant>` **get_value** **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, :ref:`Variant<class_variant>` default=null **)** const
|
||||||
|
|
||||||
Return the current value for the specified section and key. If the section and/or the key do not exist, the method returns the value of the optional *default* argument (and thus ``NULL`` if not specified).
|
Return the current value for the specified section and key. If the section and/or the key do not exist, the method returns the value of the optional *default* argument (and thus ``NULL`` if not specified).
|
||||||
|
|
||||||
@@ -97,13 +97,13 @@ Check if the specified section-key pair exists.
|
|||||||
|
|
||||||
.. _class_ConfigFile_load:
|
.. _class_ConfigFile_load:
|
||||||
|
|
||||||
- Error **load** **(** :ref:`String<class_string>` path **)**
|
- :ref:`int<class_int>` **load** **(** :ref:`String<class_string>` path **)**
|
||||||
|
|
||||||
Load the config file specified as a parameter. The file's contents are parsed and loaded in the ConfigFile object from which the method was called. The return value is one of the OK, FAILED or ERR\_\* constants listed in :ref:`@Global Scope<class_@global scope>` (if the load was successful, it returns OK).
|
Load the config file specified as a parameter. The file's contents are parsed and loaded in the ConfigFile object from which the method was called. The return value is one of the OK, FAILED or ERR\_\* constants listed in :ref:`@Global Scope<class_@global scope>` (if the load was successful, it returns OK).
|
||||||
|
|
||||||
.. _class_ConfigFile_save:
|
.. _class_ConfigFile_save:
|
||||||
|
|
||||||
- Error **save** **(** :ref:`String<class_string>` path **)**
|
- :ref:`int<class_int>` **save** **(** :ref:`String<class_string>` path **)**
|
||||||
|
|
||||||
Save the contents of the ConfigFile object to the file specified as a parameter. The output file uses an INI-style structure.
|
Save the contents of the ConfigFile object to the file specified as a parameter. The output file uses an INI-style structure.
|
||||||
|
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ Container
|
|||||||
|
|
||||||
**Inherits:** :ref:`Control<class_control>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
|
**Inherits:** :ref:`Control<class_control>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
|
||||||
|
|
||||||
**Inherited By:** :ref:`PanelContainer<class_panelcontainer>`, :ref:`GridContainer<class_gridcontainer>`, :ref:`ScrollContainer<class_scrollcontainer>`, :ref:`ViewportContainer<class_viewportcontainer>`, :ref:`CenterContainer<class_centercontainer>`, :ref:`MarginContainer<class_margincontainer>`, :ref:`GraphNode<class_graphnode>`, :ref:`SplitContainer<class_splitcontainer>`, :ref:`BoxContainer<class_boxcontainer>`
|
**Inherited By:** :ref:`PanelContainer<class_panelcontainer>`, :ref:`GridContainer<class_gridcontainer>`, :ref:`ScrollContainer<class_scrollcontainer>`, :ref:`ViewportContainer<class_viewportcontainer>`, :ref:`MarginContainer<class_margincontainer>`, :ref:`CenterContainer<class_centercontainer>`, :ref:`GraphNode<class_graphnode>`, :ref:`SplitContainer<class_splitcontainer>`, :ref:`BoxContainer<class_boxcontainer>`
|
||||||
|
|
||||||
**Category:** Core
|
**Category:** Core
|
||||||
|
|
||||||
|
|||||||
@@ -20,199 +20,201 @@ Control is the base node for all the GUI components.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`_get_minimum_size<class_Control__get_minimum_size>` **(** **)** virtual |
|
| :ref:`Vector2<class_vector2>` | :ref:`_get_minimum_size<class_Control__get_minimum_size>` **(** **)** virtual |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`_gui_input<class_Control__gui_input>` **(** :ref:`InputEvent<class_inputevent>` event **)** virtual |
|
| void | :ref:`_gui_input<class_Control__gui_input>` **(** :ref:`InputEvent<class_inputevent>` event **)** virtual |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`accept_event<class_Control_accept_event>` **(** **)** |
|
| void | :ref:`accept_event<class_Control_accept_event>` **(** **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`add_color_override<class_Control_add_color_override>` **(** :ref:`String<class_string>` name, :ref:`Color<class_color>` color **)** |
|
| void | :ref:`add_color_override<class_Control_add_color_override>` **(** :ref:`String<class_string>` name, :ref:`Color<class_color>` color **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`add_constant_override<class_Control_add_constant_override>` **(** :ref:`String<class_string>` name, :ref:`int<class_int>` constant **)** |
|
| void | :ref:`add_constant_override<class_Control_add_constant_override>` **(** :ref:`String<class_string>` name, :ref:`int<class_int>` constant **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`add_font_override<class_Control_add_font_override>` **(** :ref:`String<class_string>` name, :ref:`Font<class_font>` font **)** |
|
| void | :ref:`add_font_override<class_Control_add_font_override>` **(** :ref:`String<class_string>` name, :ref:`Font<class_font>` font **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`add_icon_override<class_Control_add_icon_override>` **(** :ref:`String<class_string>` name, :ref:`Texture<class_texture>` texture **)** |
|
| void | :ref:`add_icon_override<class_Control_add_icon_override>` **(** :ref:`String<class_string>` name, :ref:`Texture<class_texture>` texture **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`add_shader_override<class_Control_add_shader_override>` **(** :ref:`String<class_string>` name, :ref:`Shader<class_shader>` shader **)** |
|
| void | :ref:`add_shader_override<class_Control_add_shader_override>` **(** :ref:`String<class_string>` name, :ref:`Shader<class_shader>` shader **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`add_style_override<class_Control_add_style_override>` **(** :ref:`String<class_string>` name, :ref:`StyleBox<class_stylebox>` stylebox **)** |
|
| void | :ref:`add_style_override<class_Control_add_style_override>` **(** :ref:`String<class_string>` name, :ref:`StyleBox<class_stylebox>` stylebox **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`can_drop_data<class_Control_can_drop_data>` **(** :ref:`Vector2<class_vector2>` pos, :ref:`Variant<class_variant>` data **)** virtual |
|
| :ref:`bool<class_bool>` | :ref:`can_drop_data<class_Control_can_drop_data>` **(** :ref:`Vector2<class_vector2>` pos, :ref:`Variant<class_variant>` data **)** virtual |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`drop_data<class_Control_drop_data>` **(** :ref:`Vector2<class_vector2>` pos, :ref:`Variant<class_variant>` data **)** virtual |
|
| void | :ref:`drop_data<class_Control_drop_data>` **(** :ref:`Vector2<class_vector2>` pos, :ref:`Variant<class_variant>` data **)** virtual |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`force_drag<class_Control_force_drag>` **(** :ref:`Variant<class_variant>` data, :ref:`Object<class_object>` preview **)** |
|
| void | :ref:`force_drag<class_Control_force_drag>` **(** :ref:`Variant<class_variant>` data, :ref:`Control<class_control>` preview **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_anchor<class_Control_get_anchor>` **(** :ref:`int<class_int>` margin **)** const |
|
| :ref:`float<class_float>` | :ref:`get_anchor<class_Control_get_anchor>` **(** :ref:`int<class_int>` margin **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_begin<class_Control_get_begin>` **(** **)** const |
|
| :ref:`Vector2<class_vector2>` | :ref:`get_begin<class_Control_get_begin>` **(** **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Color<class_color>` | :ref:`get_color<class_Control_get_color>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const |
|
| :ref:`Color<class_color>` | :ref:`get_color<class_Control_get_color>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type=null **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_combined_minimum_size<class_Control_get_combined_minimum_size>` **(** **)** const |
|
| :ref:`Vector2<class_vector2>` | :ref:`get_combined_minimum_size<class_Control_get_combined_minimum_size>` **(** **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_constant<class_Control_get_constant>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const |
|
| :ref:`int<class_int>` | :ref:`get_constant<class_Control_get_constant>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type=null **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_cursor_shape<class_Control_get_cursor_shape>` **(** :ref:`Vector2<class_vector2>` pos=Vector2(0, 0) **)** const |
|
| :ref:`int<class_int>` | :ref:`get_cursor_shape<class_Control_get_cursor_shape>` **(** :ref:`Vector2<class_vector2>` pos=Vector2( 0, 0 ) **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_custom_minimum_size<class_Control_get_custom_minimum_size>` **(** **)** const |
|
| :ref:`Vector2<class_vector2>` | :ref:`get_custom_minimum_size<class_Control_get_custom_minimum_size>` **(** **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_default_cursor_shape<class_Control_get_default_cursor_shape>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_default_cursor_shape<class_Control_get_default_cursor_shape>` **(** **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Object<class_object>` | :ref:`get_drag_data<class_Control_get_drag_data>` **(** :ref:`Vector2<class_vector2>` pos **)** virtual |
|
| :ref:`Object<class_object>` | :ref:`get_drag_data<class_Control_get_drag_data>` **(** :ref:`Vector2<class_vector2>` pos **)** virtual |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_end<class_Control_get_end>` **(** **)** const |
|
| :ref:`Vector2<class_vector2>` | :ref:`get_end<class_Control_get_end>` **(** **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_focus_mode<class_Control_get_focus_mode>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_focus_mode<class_Control_get_focus_mode>` **(** **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`NodePath<class_nodepath>` | :ref:`get_focus_neighbour<class_Control_get_focus_neighbour>` **(** :ref:`int<class_int>` margin **)** const |
|
| :ref:`NodePath<class_nodepath>` | :ref:`get_focus_neighbour<class_Control_get_focus_neighbour>` **(** :ref:`int<class_int>` margin **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Control<class_control>` | :ref:`get_focus_owner<class_Control_get_focus_owner>` **(** **)** const |
|
| :ref:`Control<class_control>` | :ref:`get_focus_owner<class_Control_get_focus_owner>` **(** **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Font<class_font>` | :ref:`get_font<class_Control_get_font>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const |
|
| :ref:`Font<class_font>` | :ref:`get_font<class_Control_get_font>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type=null **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_global_position<class_Control_get_global_position>` **(** **)** const |
|
| :ref:`Vector2<class_vector2>` | :ref:`get_global_position<class_Control_get_global_position>` **(** **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Rect2<class_rect2>` | :ref:`get_global_rect<class_Control_get_global_rect>` **(** **)** const |
|
| :ref:`Rect2<class_rect2>` | :ref:`get_global_rect<class_Control_get_global_rect>` **(** **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_h_grow_direction<class_Control_get_h_grow_direction>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_h_grow_direction<class_Control_get_h_grow_direction>` **(** **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_h_size_flags<class_Control_get_h_size_flags>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_h_size_flags<class_Control_get_h_size_flags>` **(** **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Texture<class_texture>` | :ref:`get_icon<class_Control_get_icon>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const |
|
| :ref:`Texture<class_texture>` | :ref:`get_icon<class_Control_get_icon>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type=null **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_margin<class_Control_get_margin>` **(** :ref:`int<class_int>` margin **)** const |
|
| :ref:`float<class_float>` | :ref:`get_margin<class_Control_get_margin>` **(** :ref:`int<class_int>` margin **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_minimum_size<class_Control_get_minimum_size>` **(** **)** const |
|
| :ref:`Vector2<class_vector2>` | :ref:`get_minimum_size<class_Control_get_minimum_size>` **(** **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_mouse_filter<class_Control_get_mouse_filter>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_mouse_filter<class_Control_get_mouse_filter>` **(** **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_parent_area_size<class_Control_get_parent_area_size>` **(** **)** const |
|
| :ref:`Vector2<class_vector2>` | :ref:`get_parent_area_size<class_Control_get_parent_area_size>` **(** **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Control<class_control>` | :ref:`get_parent_control<class_Control_get_parent_control>` **(** **)** const |
|
| :ref:`Control<class_control>` | :ref:`get_parent_control<class_Control_get_parent_control>` **(** **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_pivot_offset<class_Control_get_pivot_offset>` **(** **)** const |
|
| :ref:`Vector2<class_vector2>` | :ref:`get_pivot_offset<class_Control_get_pivot_offset>` **(** **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_position<class_Control_get_position>` **(** **)** const |
|
| :ref:`Vector2<class_vector2>` | :ref:`get_position<class_Control_get_position>` **(** **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Rect2<class_rect2>` | :ref:`get_rect<class_Control_get_rect>` **(** **)** const |
|
| :ref:`Rect2<class_rect2>` | :ref:`get_rect<class_Control_get_rect>` **(** **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_rotation<class_Control_get_rotation>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_rotation<class_Control_get_rotation>` **(** **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_rotation_deg<class_Control_get_rotation_deg>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_rotation_deg<class_Control_get_rotation_deg>` **(** **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_scale<class_Control_get_scale>` **(** **)** const |
|
| :ref:`Vector2<class_vector2>` | :ref:`get_scale<class_Control_get_scale>` **(** **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_size<class_Control_get_size>` **(** **)** const |
|
| :ref:`Vector2<class_vector2>` | :ref:`get_size<class_Control_get_size>` **(** **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_stretch_ratio<class_Control_get_stretch_ratio>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_stretch_ratio<class_Control_get_stretch_ratio>` **(** **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`StyleBox<class_stylebox>` | :ref:`get_stylebox<class_Control_get_stylebox>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const |
|
| :ref:`StyleBox<class_stylebox>` | :ref:`get_stylebox<class_Control_get_stylebox>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type=null **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Theme<class_theme>` | :ref:`get_theme<class_Control_get_theme>` **(** **)** const |
|
| :ref:`Theme<class_theme>` | :ref:`get_theme<class_Control_get_theme>` **(** **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`get_tooltip<class_Control_get_tooltip>` **(** :ref:`Vector2<class_vector2>` atpos=Vector2(0, 0) **)** const |
|
| :ref:`String<class_string>` | :ref:`get_tooltip<class_Control_get_tooltip>` **(** :ref:`Vector2<class_vector2>` atpos=Vector2( 0, 0 ) **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_v_grow_direction<class_Control_get_v_grow_direction>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_v_grow_direction<class_Control_get_v_grow_direction>` **(** **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_v_size_flags<class_Control_get_v_size_flags>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_v_size_flags<class_Control_get_v_size_flags>` **(** **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`grab_click_focus<class_Control_grab_click_focus>` **(** **)** |
|
| void | :ref:`grab_click_focus<class_Control_grab_click_focus>` **(** **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`grab_focus<class_Control_grab_focus>` **(** **)** |
|
| void | :ref:`grab_focus<class_Control_grab_focus>` **(** **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`has_color<class_Control_has_color>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const |
|
| :ref:`bool<class_bool>` | :ref:`has_color<class_Control_has_color>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type=null **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`has_color_override<class_Control_has_color_override>` **(** :ref:`String<class_string>` name **)** const |
|
| :ref:`bool<class_bool>` | :ref:`has_color_override<class_Control_has_color_override>` **(** :ref:`String<class_string>` name **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`has_constant<class_Control_has_constant>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const |
|
| :ref:`bool<class_bool>` | :ref:`has_constant<class_Control_has_constant>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type=null **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`has_constant_override<class_Control_has_constant_override>` **(** :ref:`String<class_string>` name **)** const |
|
| :ref:`bool<class_bool>` | :ref:`has_constant_override<class_Control_has_constant_override>` **(** :ref:`String<class_string>` name **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`has_focus<class_Control_has_focus>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`has_focus<class_Control_has_focus>` **(** **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`has_font<class_Control_has_font>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const |
|
| :ref:`bool<class_bool>` | :ref:`has_font<class_Control_has_font>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type=null **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`has_font_override<class_Control_has_font_override>` **(** :ref:`String<class_string>` name **)** const |
|
| :ref:`bool<class_bool>` | :ref:`has_font_override<class_Control_has_font_override>` **(** :ref:`String<class_string>` name **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`has_icon<class_Control_has_icon>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const |
|
| :ref:`bool<class_bool>` | :ref:`has_icon<class_Control_has_icon>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type=null **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`has_icon_override<class_Control_has_icon_override>` **(** :ref:`String<class_string>` name **)** const |
|
| :ref:`bool<class_bool>` | :ref:`has_icon_override<class_Control_has_icon_override>` **(** :ref:`String<class_string>` name **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`has_point<class_Control_has_point>` **(** :ref:`Vector2<class_vector2>` point **)** virtual |
|
| :ref:`bool<class_bool>` | :ref:`has_point<class_Control_has_point>` **(** :ref:`Vector2<class_vector2>` point **)** virtual |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`has_stylebox<class_Control_has_stylebox>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const |
|
| :ref:`bool<class_bool>` | :ref:`has_stylebox<class_Control_has_stylebox>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type=null **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`has_stylebox_override<class_Control_has_stylebox_override>` **(** :ref:`String<class_string>` name **)** const |
|
| :ref:`bool<class_bool>` | :ref:`has_stylebox_override<class_Control_has_stylebox_override>` **(** :ref:`String<class_string>` name **)** const |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_clipping_contents<class_Control_is_clipping_contents>` **(** **)** |
|
| :ref:`bool<class_bool>` | :ref:`is_clipping_contents<class_Control_is_clipping_contents>` **(** **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`minimum_size_changed<class_Control_minimum_size_changed>` **(** **)** |
|
| void | :ref:`minimum_size_changed<class_Control_minimum_size_changed>` **(** **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`release_focus<class_Control_release_focus>` **(** **)** |
|
| void | :ref:`release_focus<class_Control_release_focus>` **(** **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_anchor<class_Control_set_anchor>` **(** :ref:`int<class_int>` margin, :ref:`int<class_int>` anchor_mode, :ref:`bool<class_bool>` keep_margin=false **)** |
|
| void | :ref:`set_anchor<class_Control_set_anchor>` **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` anchor, :ref:`bool<class_bool>` keep_margin=null, :ref:`bool<class_bool>` push_opposite_anchor=null **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_anchor_and_margin<class_Control_set_anchor_and_margin>` **(** :ref:`int<class_int>` margin, :ref:`int<class_int>` anchor_mode, :ref:`float<class_float>` offset **)** |
|
| void | :ref:`set_anchor_and_margin<class_Control_set_anchor_and_margin>` **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` anchor, :ref:`float<class_float>` offset, :ref:`bool<class_bool>` push_opposite_anchor=null **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_area_as_parent_rect<class_Control_set_area_as_parent_rect>` **(** :ref:`int<class_int>` margin=0 **)** |
|
| void | :ref:`set_anchors_preset<class_Control_set_anchors_preset>` **(** :ref:`int<class_int>` preset, :ref:`bool<class_bool>` keep_margin=null **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_begin<class_Control_set_begin>` **(** :ref:`Vector2<class_vector2>` pos **)** |
|
| void | :ref:`set_area_as_parent_rect<class_Control_set_area_as_parent_rect>` **(** :ref:`int<class_int>` margin=0 **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_clip_contents<class_Control_set_clip_contents>` **(** :ref:`bool<class_bool>` enable **)** |
|
| void | :ref:`set_begin<class_Control_set_begin>` **(** :ref:`Vector2<class_vector2>` pos **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_custom_minimum_size<class_Control_set_custom_minimum_size>` **(** :ref:`Vector2<class_vector2>` size **)** |
|
| void | :ref:`set_clip_contents<class_Control_set_clip_contents>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_default_cursor_shape<class_Control_set_default_cursor_shape>` **(** :ref:`int<class_int>` shape **)** |
|
| void | :ref:`set_custom_minimum_size<class_Control_set_custom_minimum_size>` **(** :ref:`Vector2<class_vector2>` size **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_drag_forwarding<class_Control_set_drag_forwarding>` **(** :ref:`Control<class_control>` target **)** |
|
| void | :ref:`set_default_cursor_shape<class_Control_set_default_cursor_shape>` **(** :ref:`int<class_int>` shape **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_drag_preview<class_Control_set_drag_preview>` **(** :ref:`Control<class_control>` control **)** |
|
| void | :ref:`set_drag_forwarding<class_Control_set_drag_forwarding>` **(** :ref:`Control<class_control>` target **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_end<class_Control_set_end>` **(** :ref:`Vector2<class_vector2>` pos **)** |
|
| void | :ref:`set_drag_preview<class_Control_set_drag_preview>` **(** :ref:`Control<class_control>` control **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_focus_mode<class_Control_set_focus_mode>` **(** :ref:`int<class_int>` mode **)** |
|
| void | :ref:`set_end<class_Control_set_end>` **(** :ref:`Vector2<class_vector2>` pos **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_focus_neighbour<class_Control_set_focus_neighbour>` **(** :ref:`int<class_int>` margin, :ref:`NodePath<class_nodepath>` neighbour **)** |
|
| void | :ref:`set_focus_mode<class_Control_set_focus_mode>` **(** :ref:`int<class_int>` mode **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_global_position<class_Control_set_global_position>` **(** :ref:`Vector2<class_vector2>` pos **)** |
|
| void | :ref:`set_focus_neighbour<class_Control_set_focus_neighbour>` **(** :ref:`int<class_int>` margin, :ref:`NodePath<class_nodepath>` neighbour **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_h_grow_direction<class_Control_set_h_grow_direction>` **(** :ref:`int<class_int>` direction **)** |
|
| void | :ref:`set_global_position<class_Control_set_global_position>` **(** :ref:`Vector2<class_vector2>` pos **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_h_size_flags<class_Control_set_h_size_flags>` **(** :ref:`int<class_int>` flags **)** |
|
| void | :ref:`set_h_grow_direction<class_Control_set_h_grow_direction>` **(** :ref:`int<class_int>` direction **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_margin<class_Control_set_margin>` **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` offset **)** |
|
| void | :ref:`set_h_size_flags<class_Control_set_h_size_flags>` **(** :ref:`int<class_int>` flags **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_mouse_filter<class_Control_set_mouse_filter>` **(** :ref:`int<class_int>` filter **)** |
|
| void | :ref:`set_margin<class_Control_set_margin>` **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` offset **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_pivot_offset<class_Control_set_pivot_offset>` **(** :ref:`Vector2<class_vector2>` pivot_offset **)** |
|
| void | :ref:`set_mouse_filter<class_Control_set_mouse_filter>` **(** :ref:`int<class_int>` filter **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_position<class_Control_set_position>` **(** :ref:`Vector2<class_vector2>` pos **)** |
|
| void | :ref:`set_pivot_offset<class_Control_set_pivot_offset>` **(** :ref:`Vector2<class_vector2>` pivot_offset **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_rotation<class_Control_set_rotation>` **(** :ref:`float<class_float>` radians **)** |
|
| void | :ref:`set_position<class_Control_set_position>` **(** :ref:`Vector2<class_vector2>` pos **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_rotation_deg<class_Control_set_rotation_deg>` **(** :ref:`float<class_float>` degrees **)** |
|
| void | :ref:`set_rotation<class_Control_set_rotation>` **(** :ref:`float<class_float>` radians **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_scale<class_Control_set_scale>` **(** :ref:`Vector2<class_vector2>` scale **)** |
|
| void | :ref:`set_rotation_deg<class_Control_set_rotation_deg>` **(** :ref:`float<class_float>` degrees **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_size<class_Control_set_size>` **(** :ref:`Vector2<class_vector2>` size **)** |
|
| void | :ref:`set_scale<class_Control_set_scale>` **(** :ref:`Vector2<class_vector2>` scale **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_stretch_ratio<class_Control_set_stretch_ratio>` **(** :ref:`float<class_float>` ratio **)** |
|
| void | :ref:`set_size<class_Control_set_size>` **(** :ref:`Vector2<class_vector2>` size **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_theme<class_Control_set_theme>` **(** :ref:`Theme<class_theme>` theme **)** |
|
| void | :ref:`set_stretch_ratio<class_Control_set_stretch_ratio>` **(** :ref:`float<class_float>` ratio **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_tooltip<class_Control_set_tooltip>` **(** :ref:`String<class_string>` tooltip **)** |
|
| void | :ref:`set_theme<class_Control_set_theme>` **(** :ref:`Theme<class_theme>` theme **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_v_grow_direction<class_Control_set_v_grow_direction>` **(** :ref:`int<class_int>` direction **)** |
|
| void | :ref:`set_tooltip<class_Control_set_tooltip>` **(** :ref:`String<class_string>` tooltip **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_v_size_flags<class_Control_set_v_size_flags>` **(** :ref:`int<class_int>` flags **)** |
|
| void | :ref:`set_v_grow_direction<class_Control_set_v_grow_direction>` **(** :ref:`int<class_int>` direction **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`show_modal<class_Control_show_modal>` **(** :ref:`bool<class_bool>` exclusive=false **)** |
|
| void | :ref:`set_v_size_flags<class_Control_set_v_size_flags>` **(** :ref:`int<class_int>` flags **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`warp_mouse<class_Control_warp_mouse>` **(** :ref:`Vector2<class_vector2>` to_pos **)** |
|
| void | :ref:`show_modal<class_Control_show_modal>` **(** :ref:`bool<class_bool>` exclusive=false **)** |
|
||||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`warp_mouse<class_Control_warp_mouse>` **(** :ref:`Vector2<class_vector2>` to_pos **)** |
|
||||||
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Signals
|
Signals
|
||||||
-------
|
-------
|
||||||
@@ -244,10 +246,10 @@ Emitted when the size flags changed.
|
|||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
- :ref:`int<class_int>` **anchor_bottom**
|
- :ref:`float<class_float>` **anchor_bottom**
|
||||||
- :ref:`int<class_int>` **anchor_left**
|
- :ref:`float<class_float>` **anchor_left**
|
||||||
- :ref:`int<class_int>` **anchor_right**
|
- :ref:`float<class_float>` **anchor_right**
|
||||||
- :ref:`int<class_int>` **anchor_top**
|
- :ref:`float<class_float>` **anchor_top**
|
||||||
- :ref:`NodePath<class_nodepath>` **focus_neighbour_bottom**
|
- :ref:`NodePath<class_nodepath>` **focus_neighbour_bottom**
|
||||||
- :ref:`NodePath<class_nodepath>` **focus_neighbour_left**
|
- :ref:`NodePath<class_nodepath>` **focus_neighbour_left**
|
||||||
- :ref:`NodePath<class_nodepath>` **focus_neighbour_right**
|
- :ref:`NodePath<class_nodepath>` **focus_neighbour_right**
|
||||||
@@ -255,10 +257,10 @@ Member Variables
|
|||||||
- :ref:`int<class_int>` **grow_horizontal**
|
- :ref:`int<class_int>` **grow_horizontal**
|
||||||
- :ref:`int<class_int>` **grow_vertical**
|
- :ref:`int<class_int>` **grow_vertical**
|
||||||
- :ref:`String<class_string>` **hint_tooltip**
|
- :ref:`String<class_string>` **hint_tooltip**
|
||||||
- :ref:`int<class_int>` **margin_bottom**
|
- :ref:`float<class_float>` **margin_bottom**
|
||||||
- :ref:`int<class_int>` **margin_left**
|
- :ref:`float<class_float>` **margin_left**
|
||||||
- :ref:`int<class_int>` **margin_right**
|
- :ref:`float<class_float>` **margin_right**
|
||||||
- :ref:`int<class_int>` **margin_top**
|
- :ref:`float<class_float>` **margin_top**
|
||||||
- :ref:`int<class_int>` **mouse_filter**
|
- :ref:`int<class_int>` **mouse_filter**
|
||||||
- :ref:`bool<class_bool>` **rect_clip_content**
|
- :ref:`bool<class_bool>` **rect_clip_content**
|
||||||
- :ref:`Vector2<class_vector2>` **rect_min_size**
|
- :ref:`Vector2<class_vector2>` **rect_min_size**
|
||||||
@@ -268,16 +270,13 @@ Member Variables
|
|||||||
- :ref:`Vector2<class_vector2>` **rect_scale**
|
- :ref:`Vector2<class_vector2>` **rect_scale**
|
||||||
- :ref:`Vector2<class_vector2>` **rect_size**
|
- :ref:`Vector2<class_vector2>` **rect_size**
|
||||||
- :ref:`int<class_int>` **size_flags_horizontal**
|
- :ref:`int<class_int>` **size_flags_horizontal**
|
||||||
- :ref:`int<class_int>` **size_flags_stretch_ratio**
|
- :ref:`float<class_float>` **size_flags_stretch_ratio**
|
||||||
- :ref:`int<class_int>` **size_flags_vertical**
|
- :ref:`int<class_int>` **size_flags_vertical**
|
||||||
- :ref:`Theme<class_theme>` **theme**
|
- :ref:`Theme<class_theme>` **theme**
|
||||||
|
|
||||||
Numeric Constants
|
Numeric Constants
|
||||||
-----------------
|
-----------------
|
||||||
|
|
||||||
- **ANCHOR_BEGIN** = **0** --- X is relative to MARGIN_LEFT, Y is relative to MARGIN_TOP.
|
|
||||||
- **ANCHOR_END** = **1** --- X is relative to -MARGIN_RIGHT, Y is relative to -MARGIN_BOTTOM.
|
|
||||||
- **ANCHOR_CENTER** = **2**
|
|
||||||
- **FOCUS_NONE** = **0** --- Control can't acquire focus.
|
- **FOCUS_NONE** = **0** --- Control can't acquire focus.
|
||||||
- **FOCUS_CLICK** = **1** --- Control can acquire focus only if clicked.
|
- **FOCUS_CLICK** = **1** --- Control can acquire focus only if clicked.
|
||||||
- **FOCUS_ALL** = **2** --- Control can acquire focus if clicked, or by pressing TAB/Directionals in the keyboard from another Control.
|
- **FOCUS_ALL** = **2** --- Control can acquire focus if clicked, or by pressing TAB/Directionals in the keyboard from another Control.
|
||||||
@@ -305,6 +304,22 @@ Numeric Constants
|
|||||||
- **CURSOR_VSPLIT** = **14**
|
- **CURSOR_VSPLIT** = **14**
|
||||||
- **CURSOR_HSPLIT** = **15**
|
- **CURSOR_HSPLIT** = **15**
|
||||||
- **CURSOR_HELP** = **16**
|
- **CURSOR_HELP** = **16**
|
||||||
|
- **PRESET_TOP_LEFT** = **0**
|
||||||
|
- **PRESET_TOP_RIGHT** = **1**
|
||||||
|
- **PRESET_BOTTOM_LEFT** = **2**
|
||||||
|
- **PRESET_BOTTOM_RIGHT** = **3**
|
||||||
|
- **PRESET_CENTER_LEFT** = **4**
|
||||||
|
- **PRESET_CENTER_TOP** = **5**
|
||||||
|
- **PRESET_CENTER_RIGHT** = **6**
|
||||||
|
- **PRESET_CENTER_BOTTOM** = **7**
|
||||||
|
- **PRESET_CENTER** = **8**
|
||||||
|
- **PRESET_LEFT_WIDE** = **9**
|
||||||
|
- **PRESET_TOP_WIDE** = **10**
|
||||||
|
- **PRESET_RIGHT_WIDE** = **11**
|
||||||
|
- **PRESET_BOTTOM_WIDE** = **12**
|
||||||
|
- **PRESET_VCENTER_WIDE** = **13**
|
||||||
|
- **PRESET_HCENTER_WIDE** = **14**
|
||||||
|
- **PRESET_WIDE** = **15**
|
||||||
- **SIZE_EXPAND** = **2**
|
- **SIZE_EXPAND** = **2**
|
||||||
- **SIZE_FILL** = **1**
|
- **SIZE_FILL** = **1**
|
||||||
- **SIZE_EXPAND_FILL** = **3**
|
- **SIZE_EXPAND_FILL** = **3**
|
||||||
@@ -315,6 +330,8 @@ Numeric Constants
|
|||||||
- **MOUSE_FILTER_IGNORE** = **2**
|
- **MOUSE_FILTER_IGNORE** = **2**
|
||||||
- **GROW_DIRECTION_BEGIN** = **0**
|
- **GROW_DIRECTION_BEGIN** = **0**
|
||||||
- **GROW_DIRECTION_END** = **1**
|
- **GROW_DIRECTION_END** = **1**
|
||||||
|
- **ANCHOR_BEGIN** = **0** --- X is relative to MARGIN_LEFT, Y is relative to MARGIN_TOP.
|
||||||
|
- **ANCHOR_END** = **1** --- X is relative to -MARGIN_RIGHT, Y is relative to -MARGIN_BOTTOM.
|
||||||
|
|
||||||
Description
|
Description
|
||||||
-----------
|
-----------
|
||||||
@@ -394,11 +411,11 @@ Override a single stylebox (Stylebox) in the theme of this Control. If stylebox
|
|||||||
|
|
||||||
.. _class_Control_force_drag:
|
.. _class_Control_force_drag:
|
||||||
|
|
||||||
- void **force_drag** **(** :ref:`Variant<class_variant>` data, :ref:`Object<class_object>` preview **)**
|
- void **force_drag** **(** :ref:`Variant<class_variant>` data, :ref:`Control<class_control>` preview **)**
|
||||||
|
|
||||||
.. _class_Control_get_anchor:
|
.. _class_Control_get_anchor:
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_anchor** **(** :ref:`int<class_int>` margin **)** const
|
- :ref:`float<class_float>` **get_anchor** **(** :ref:`int<class_int>` margin **)** const
|
||||||
|
|
||||||
Return the anchor type (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) for a given margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM).
|
Return the anchor type (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) for a given margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM).
|
||||||
|
|
||||||
@@ -408,7 +425,7 @@ Return the anchor type (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) for a given marg
|
|||||||
|
|
||||||
.. _class_Control_get_color:
|
.. _class_Control_get_color:
|
||||||
|
|
||||||
- :ref:`Color<class_color>` **get_color** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const
|
- :ref:`Color<class_color>` **get_color** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type=null **)** const
|
||||||
|
|
||||||
.. _class_Control_get_combined_minimum_size:
|
.. _class_Control_get_combined_minimum_size:
|
||||||
|
|
||||||
@@ -416,11 +433,11 @@ Return the anchor type (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) for a given marg
|
|||||||
|
|
||||||
.. _class_Control_get_constant:
|
.. _class_Control_get_constant:
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_constant** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const
|
- :ref:`int<class_int>` **get_constant** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type=null **)** const
|
||||||
|
|
||||||
.. _class_Control_get_cursor_shape:
|
.. _class_Control_get_cursor_shape:
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_cursor_shape** **(** :ref:`Vector2<class_vector2>` pos=Vector2(0, 0) **)** const
|
- :ref:`int<class_int>` **get_cursor_shape** **(** :ref:`Vector2<class_vector2>` pos=Vector2( 0, 0 ) **)** const
|
||||||
|
|
||||||
Return the cursor shape at a certain position in the control.
|
Return the cursor shape at a certain position in the control.
|
||||||
|
|
||||||
@@ -464,7 +481,7 @@ Return which control is owning the keyboard focus, or null if no one.
|
|||||||
|
|
||||||
.. _class_Control_get_font:
|
.. _class_Control_get_font:
|
||||||
|
|
||||||
- :ref:`Font<class_font>` **get_font** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const
|
- :ref:`Font<class_font>` **get_font** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type=null **)** const
|
||||||
|
|
||||||
.. _class_Control_get_global_position:
|
.. _class_Control_get_global_position:
|
||||||
|
|
||||||
@@ -490,7 +507,7 @@ Hint for containers, return horizontal positioning flags.
|
|||||||
|
|
||||||
.. _class_Control_get_icon:
|
.. _class_Control_get_icon:
|
||||||
|
|
||||||
- :ref:`Texture<class_texture>` **get_icon** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const
|
- :ref:`Texture<class_texture>` **get_icon** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type=null **)** const
|
||||||
|
|
||||||
.. _class_Control_get_margin:
|
.. _class_Control_get_margin:
|
||||||
|
|
||||||
@@ -564,7 +581,7 @@ Hint for containers, return the stretch ratio. This value is relative to other s
|
|||||||
|
|
||||||
.. _class_Control_get_stylebox:
|
.. _class_Control_get_stylebox:
|
||||||
|
|
||||||
- :ref:`StyleBox<class_stylebox>` **get_stylebox** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const
|
- :ref:`StyleBox<class_stylebox>` **get_stylebox** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type=null **)** const
|
||||||
|
|
||||||
.. _class_Control_get_theme:
|
.. _class_Control_get_theme:
|
||||||
|
|
||||||
@@ -574,7 +591,7 @@ Return a :ref:`Theme<class_theme>` override, if one exists (see :ref:`set_theme<
|
|||||||
|
|
||||||
.. _class_Control_get_tooltip:
|
.. _class_Control_get_tooltip:
|
||||||
|
|
||||||
- :ref:`String<class_string>` **get_tooltip** **(** :ref:`Vector2<class_vector2>` atpos=Vector2(0, 0) **)** const
|
- :ref:`String<class_string>` **get_tooltip** **(** :ref:`Vector2<class_vector2>` atpos=Vector2( 0, 0 ) **)** const
|
||||||
|
|
||||||
Return the tooltip, which will appear when the cursor is resting over this control.
|
Return the tooltip, which will appear when the cursor is resting over this control.
|
||||||
|
|
||||||
@@ -600,7 +617,7 @@ Steal the focus from another control and become the focused control (see :ref:`s
|
|||||||
|
|
||||||
.. _class_Control_has_color:
|
.. _class_Control_has_color:
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **has_color** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const
|
- :ref:`bool<class_bool>` **has_color** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type=null **)** const
|
||||||
|
|
||||||
.. _class_Control_has_color_override:
|
.. _class_Control_has_color_override:
|
||||||
|
|
||||||
@@ -608,7 +625,7 @@ Steal the focus from another control and become the focused control (see :ref:`s
|
|||||||
|
|
||||||
.. _class_Control_has_constant:
|
.. _class_Control_has_constant:
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **has_constant** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const
|
- :ref:`bool<class_bool>` **has_constant** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type=null **)** const
|
||||||
|
|
||||||
.. _class_Control_has_constant_override:
|
.. _class_Control_has_constant_override:
|
||||||
|
|
||||||
@@ -622,7 +639,7 @@ Return whether the Control is the current focused control (see :ref:`set_focus_m
|
|||||||
|
|
||||||
.. _class_Control_has_font:
|
.. _class_Control_has_font:
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **has_font** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const
|
- :ref:`bool<class_bool>` **has_font** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type=null **)** const
|
||||||
|
|
||||||
.. _class_Control_has_font_override:
|
.. _class_Control_has_font_override:
|
||||||
|
|
||||||
@@ -630,7 +647,7 @@ Return whether the Control is the current focused control (see :ref:`set_focus_m
|
|||||||
|
|
||||||
.. _class_Control_has_icon:
|
.. _class_Control_has_icon:
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **has_icon** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const
|
- :ref:`bool<class_bool>` **has_icon** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type=null **)** const
|
||||||
|
|
||||||
.. _class_Control_has_icon_override:
|
.. _class_Control_has_icon_override:
|
||||||
|
|
||||||
@@ -638,11 +655,11 @@ Return whether the Control is the current focused control (see :ref:`set_focus_m
|
|||||||
|
|
||||||
.. _class_Control_has_point:
|
.. _class_Control_has_point:
|
||||||
|
|
||||||
- void **has_point** **(** :ref:`Vector2<class_vector2>` point **)** virtual
|
- :ref:`bool<class_bool>` **has_point** **(** :ref:`Vector2<class_vector2>` point **)** virtual
|
||||||
|
|
||||||
.. _class_Control_has_stylebox:
|
.. _class_Control_has_stylebox:
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **has_stylebox** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const
|
- :ref:`bool<class_bool>` **has_stylebox** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type=null **)** const
|
||||||
|
|
||||||
.. _class_Control_has_stylebox_override:
|
.. _class_Control_has_stylebox_override:
|
||||||
|
|
||||||
@@ -664,17 +681,15 @@ Give up the focus, no other control will be able to receive keyboard input.
|
|||||||
|
|
||||||
.. _class_Control_set_anchor:
|
.. _class_Control_set_anchor:
|
||||||
|
|
||||||
- void **set_anchor** **(** :ref:`int<class_int>` margin, :ref:`int<class_int>` anchor_mode, :ref:`bool<class_bool>` keep_margin=false **)**
|
- void **set_anchor** **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` anchor, :ref:`bool<class_bool>` keep_margin=null, :ref:`bool<class_bool>` push_opposite_anchor=null **)**
|
||||||
|
|
||||||
Change the anchor (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) type for a margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Changing the anchor mode converts the current margin offset from the previous anchor mode to the new one, so margin offsets (:ref:`set_margin<class_Control_set_margin>`) must be done after setting anchors, or at the same time (:ref:`set_anchor_and_margin<class_Control_set_anchor_and_margin>`)
|
|
||||||
|
|
||||||
Additionally, ``keep_margin`` controls whether margins should be left the same, or changed to keep the same position and size on-screen.
|
|
||||||
|
|
||||||
.. _class_Control_set_anchor_and_margin:
|
.. _class_Control_set_anchor_and_margin:
|
||||||
|
|
||||||
- void **set_anchor_and_margin** **(** :ref:`int<class_int>` margin, :ref:`int<class_int>` anchor_mode, :ref:`float<class_float>` offset **)**
|
- void **set_anchor_and_margin** **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` anchor, :ref:`float<class_float>` offset, :ref:`bool<class_bool>` push_opposite_anchor=null **)**
|
||||||
|
|
||||||
Change the anchor (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) type for a margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM), and also set its offset. This is a helper (see :ref:`set_anchor<class_Control_set_anchor>` and :ref:`set_margin<class_Control_set_margin>`).
|
.. _class_Control_set_anchors_preset:
|
||||||
|
|
||||||
|
- void **set_anchors_preset** **(** :ref:`int<class_int>` preset, :ref:`bool<class_bool>` keep_margin=null **)**
|
||||||
|
|
||||||
.. _class_Control_set_area_as_parent_rect:
|
.. _class_Control_set_area_as_parent_rect:
|
||||||
|
|
||||||
|
|||||||
@@ -27,7 +27,7 @@ Member Functions
|
|||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
- :ref:`Array<class_array>` **points**
|
- :ref:`PoolVector3Array<class_poolvector3array>` **points**
|
||||||
|
|
||||||
Description
|
Description
|
||||||
-----------
|
-----------
|
||||||
|
|||||||
@@ -18,27 +18,27 @@ Brief Description
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_flags<class_CubeMap_get_flags>` **(** **)** 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:`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:`float<class_float>` | :ref:`get_lossy_storage_quality<class_CubeMap_get_lossy_storage_quality>` **(** **)** const |
|
||||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Object<class_object>` | :ref:`get_side<class_CubeMap_get_side>` **(** :ref:`int<class_int>` side **)** const |
|
| :ref:`Image<class_image>` | :ref:`get_side<class_CubeMap_get_side>` **(** :ref:`int<class_int>` side **)** const |
|
||||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_storage<class_CubeMap_get_storage>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_storage<class_CubeMap_get_storage>` **(** **)** const |
|
||||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_width<class_CubeMap_get_width>` **(** **)** 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_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 **)** |
|
| void | :ref:`set_lossy_storage_quality<class_CubeMap_set_lossy_storage_quality>` **(** :ref:`float<class_float>` quality **)** |
|
||||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_side<class_CubeMap_set_side>` **(** :ref:`int<class_int>` side, :ref:`Object<class_object>` image **)** |
|
| 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 **)** |
|
| void | :ref:`set_storage<class_CubeMap_set_storage>` **(** :ref:`int<class_int>` mode **)** |
|
||||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Numeric Constants
|
Numeric Constants
|
||||||
-----------------
|
-----------------
|
||||||
@@ -74,7 +74,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_CubeMap_get_side:
|
.. _class_CubeMap_get_side:
|
||||||
|
|
||||||
- :ref:`Object<class_object>` **get_side** **(** :ref:`int<class_int>` side **)** const
|
- :ref:`Image<class_image>` **get_side** **(** :ref:`int<class_int>` side **)** const
|
||||||
|
|
||||||
.. _class_CubeMap_get_storage:
|
.. _class_CubeMap_get_storage:
|
||||||
|
|
||||||
@@ -94,7 +94,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_CubeMap_set_side:
|
.. _class_CubeMap_set_side:
|
||||||
|
|
||||||
- void **set_side** **(** :ref:`int<class_int>` side, :ref:`Object<class_object>` image **)**
|
- void **set_side** **(** :ref:`int<class_int>` side, :ref:`Image<class_image>` image **)**
|
||||||
|
|
||||||
.. _class_CubeMap_set_storage:
|
.. _class_CubeMap_set_storage:
|
||||||
|
|
||||||
|
|||||||
@@ -39,7 +39,7 @@ Member Functions
|
|||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
- :ref:`Vector2<class_vector2>` **size**
|
- :ref:`Vector3<class_vector3>` **size**
|
||||||
- :ref:`int<class_int>` **subdivide_depth**
|
- :ref:`int<class_int>` **subdivide_depth**
|
||||||
- :ref:`int<class_int>` **subdivide_height**
|
- :ref:`int<class_int>` **subdivide_height**
|
||||||
- :ref:`int<class_int>` **subdivide_width**
|
- :ref:`int<class_int>` **subdivide_width**
|
||||||
|
|||||||
@@ -18,55 +18,55 @@ Brief Description
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`add_point<class_Curve_add_point>` **(** :ref:`Vector2<class_vector2>` pos, :ref:`float<class_float>` left_tangent=0, :ref:`float<class_float>` right_tangent=0, :ref:`int<class_int>` left_mode=0, :ref:`int<class_int>` right_mode=0 **)** |
|
| :ref:`int<class_int>` | :ref:`add_point<class_Curve_add_point>` **(** :ref:`Vector2<class_vector2>` pos, :ref:`float<class_float>` left_tangent=0, :ref:`float<class_float>` right_tangent=0, :ref:`int<class_int>` left_mode=0, :ref:`int<class_int>` right_mode=null **)** |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`bake<class_Curve_bake>` **(** **)** |
|
| void | :ref:`bake<class_Curve_bake>` **(** **)** |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`clean_dupes<class_Curve_clean_dupes>` **(** **)** |
|
| void | :ref:`clean_dupes<class_Curve_clean_dupes>` **(** **)** |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`clear_points<class_Curve_clear_points>` **(** **)** |
|
| void | :ref:`clear_points<class_Curve_clear_points>` **(** **)** |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_bake_resolution<class_Curve_get_bake_resolution>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_bake_resolution<class_Curve_get_bake_resolution>` **(** **)** const |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_max_value<class_Curve_get_max_value>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_max_value<class_Curve_get_max_value>` **(** **)** const |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_min_value<class_Curve_get_min_value>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_min_value<class_Curve_get_min_value>` **(** **)** const |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_point_left_mode<class_Curve_get_point_left_mode>` **(** :ref:`int<class_int>` index **)** const |
|
| :ref:`int<class_int>` | :ref:`get_point_left_mode<class_Curve_get_point_left_mode>` **(** :ref:`int<class_int>` index **)** const |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_point_left_tangent<class_Curve_get_point_left_tangent>` **(** :ref:`int<class_int>` index **)** const |
|
| :ref:`float<class_float>` | :ref:`get_point_left_tangent<class_Curve_get_point_left_tangent>` **(** :ref:`int<class_int>` index **)** const |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_point_pos<class_Curve_get_point_pos>` **(** :ref:`int<class_int>` index **)** const |
|
| :ref:`Vector2<class_vector2>` | :ref:`get_point_pos<class_Curve_get_point_pos>` **(** :ref:`int<class_int>` index **)** const |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_point_right_mode<class_Curve_get_point_right_mode>` **(** :ref:`int<class_int>` index **)** const |
|
| :ref:`int<class_int>` | :ref:`get_point_right_mode<class_Curve_get_point_right_mode>` **(** :ref:`int<class_int>` index **)** const |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_point_right_tangent<class_Curve_get_point_right_tangent>` **(** :ref:`int<class_int>` index **)** const |
|
| :ref:`float<class_float>` | :ref:`get_point_right_tangent<class_Curve_get_point_right_tangent>` **(** :ref:`int<class_int>` index **)** const |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`interpolate<class_Curve_interpolate>` **(** :ref:`float<class_float>` offset **)** const |
|
| :ref:`float<class_float>` | :ref:`interpolate<class_Curve_interpolate>` **(** :ref:`float<class_float>` offset **)** const |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`interpolate_baked<class_Curve_interpolate_baked>` **(** :ref:`float<class_float>` offset **)** |
|
| :ref:`float<class_float>` | :ref:`interpolate_baked<class_Curve_interpolate_baked>` **(** :ref:`float<class_float>` offset **)** |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`remove_point<class_Curve_remove_point>` **(** :ref:`int<class_int>` index **)** |
|
| void | :ref:`remove_point<class_Curve_remove_point>` **(** :ref:`int<class_int>` index **)** |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_bake_resolution<class_Curve_set_bake_resolution>` **(** :ref:`int<class_int>` resolution **)** |
|
| void | :ref:`set_bake_resolution<class_Curve_set_bake_resolution>` **(** :ref:`int<class_int>` resolution **)** |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_max_value<class_Curve_set_max_value>` **(** :ref:`float<class_float>` max **)** |
|
| void | :ref:`set_max_value<class_Curve_set_max_value>` **(** :ref:`float<class_float>` max **)** |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_min_value<class_Curve_set_min_value>` **(** :ref:`float<class_float>` min **)** |
|
| void | :ref:`set_min_value<class_Curve_set_min_value>` **(** :ref:`float<class_float>` min **)** |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_point_left_mode<class_Curve_set_point_left_mode>` **(** :ref:`int<class_int>` index, :ref:`int<class_int>` mode **)** |
|
| void | :ref:`set_point_left_mode<class_Curve_set_point_left_mode>` **(** :ref:`int<class_int>` index, :ref:`int<class_int>` mode **)** |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_point_left_tangent<class_Curve_set_point_left_tangent>` **(** :ref:`int<class_int>` index, :ref:`float<class_float>` tangent **)** |
|
| void | :ref:`set_point_left_tangent<class_Curve_set_point_left_tangent>` **(** :ref:`int<class_int>` index, :ref:`float<class_float>` tangent **)** |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_point_offset<class_Curve_set_point_offset>` **(** :ref:`int<class_int>` index, :ref:`float<class_float>` offset **)** |
|
| void | :ref:`set_point_offset<class_Curve_set_point_offset>` **(** :ref:`int<class_int>` index, :ref:`float<class_float>` offset **)** |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_point_right_mode<class_Curve_set_point_right_mode>` **(** :ref:`int<class_int>` index, :ref:`int<class_int>` mode **)** |
|
| void | :ref:`set_point_right_mode<class_Curve_set_point_right_mode>` **(** :ref:`int<class_int>` index, :ref:`int<class_int>` mode **)** |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_point_right_tangent<class_Curve_set_point_right_tangent>` **(** :ref:`int<class_int>` index, :ref:`float<class_float>` tangent **)** |
|
| void | :ref:`set_point_right_tangent<class_Curve_set_point_right_tangent>` **(** :ref:`int<class_int>` index, :ref:`float<class_float>` tangent **)** |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_point_value<class_Curve_set_point_value>` **(** :ref:`int<class_int>` index, :ref:`float<class_float>` y **)** |
|
| void | :ref:`set_point_value<class_Curve_set_point_value>` **(** :ref:`int<class_int>` index, :ref:`float<class_float>` y **)** |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Signals
|
Signals
|
||||||
-------
|
-------
|
||||||
@@ -76,7 +76,7 @@ Signals
|
|||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
- :ref:`int<class_int>` **_data**
|
- :ref:`Array<class_array>` **_data**
|
||||||
- :ref:`int<class_int>` **bake_resolution**
|
- :ref:`int<class_int>` **bake_resolution**
|
||||||
- :ref:`float<class_float>` **max_value**
|
- :ref:`float<class_float>` **max_value**
|
||||||
- :ref:`float<class_float>` **min_value**
|
- :ref:`float<class_float>` **min_value**
|
||||||
@@ -86,7 +86,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_Curve_add_point:
|
.. _class_Curve_add_point:
|
||||||
|
|
||||||
- :ref:`int<class_int>` **add_point** **(** :ref:`Vector2<class_vector2>` pos, :ref:`float<class_float>` left_tangent=0, :ref:`float<class_float>` right_tangent=0, :ref:`int<class_int>` left_mode=0, :ref:`int<class_int>` right_mode=0 **)**
|
- :ref:`int<class_int>` **add_point** **(** :ref:`Vector2<class_vector2>` pos, :ref:`float<class_float>` left_tangent=0, :ref:`float<class_float>` right_tangent=0, :ref:`int<class_int>` left_mode=0, :ref:`int<class_int>` right_mode=null **)**
|
||||||
|
|
||||||
.. _class_Curve_bake:
|
.. _class_Curve_bake:
|
||||||
|
|
||||||
|
|||||||
@@ -18,48 +18,48 @@ Describes a Bezier curve in 2D space.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| 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:`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=null **)** |
|
||||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`clear_points<class_Curve2D_clear_points>` **(** **)** |
|
| void | :ref:`clear_points<class_Curve2D_clear_points>` **(** **)** |
|
||||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_bake_interval<class_Curve2D_get_bake_interval>` **(** **)** const |
|
| :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:`float<class_float>` | :ref:`get_baked_length<class_Curve2D_get_baked_length>` **(** **)** const |
|
||||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`PoolVector2Array<class_poolvector2array>` | :ref:`get_baked_points<class_Curve2D_get_baked_points>` **(** **)** const |
|
| :ref:`PoolVector2Array<class_poolvector2array>` | :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:`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_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_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:`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<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:`Vector2<class_vector2>` | :ref:`interpolate_baked<class_Curve2D_interpolate_baked>` **(** :ref:`float<class_float>` offset, :ref:`bool<class_bool>` cubic=null **)** const |
|
||||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`interpolatef<class_Curve2D_interpolatef>` **(** :ref:`float<class_float>` fofs **)** 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:`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_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_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_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 **)** |
|
| void | :ref:`set_point_pos<class_Curve2D_set_point_pos>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` pos **)** |
|
||||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`PoolVector2Array<class_poolvector2array>` | :ref:`tesselate<class_Curve2D_tesselate>` **(** :ref:`int<class_int>` max_stages=5, :ref:`float<class_float>` tolerance_degrees=4 **)** const |
|
| :ref:`PoolVector2Array<class_poolvector2array>` | :ref:`tessellate<class_Curve2D_tessellate>` **(** :ref:`int<class_int>` max_stages=4, :ref:`float<class_float>` tolerance_degrees=5 **)** const |
|
||||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
- :ref:`int<class_int>` **_data**
|
- :ref:`Dictionary<class_dictionary>` **_data**
|
||||||
- :ref:`float<class_float>` **bake_interval**
|
- :ref:`float<class_float>` **bake_interval**
|
||||||
|
|
||||||
Description
|
Description
|
||||||
@@ -74,7 +74,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_Curve2D_add_point:
|
.. _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 **)**
|
- 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=null **)**
|
||||||
|
|
||||||
Adds a point to a curve, at position "pos", with control points "in" and "out".
|
Adds a point to a curve, at position "pos", with control points "in" and "out".
|
||||||
|
|
||||||
@@ -136,7 +136,7 @@ If "idx" is out of bounds it is truncated to the first or last vertex, and "t" i
|
|||||||
|
|
||||||
.. _class_Curve2D_interpolate_baked:
|
.. _class_Curve2D_interpolate_baked:
|
||||||
|
|
||||||
- :ref:`Vector2<class_vector2>` **interpolate_baked** **(** :ref:`float<class_float>` offset, :ref:`bool<class_bool>` cubic=false **)** const
|
- :ref:`Vector2<class_vector2>` **interpolate_baked** **(** :ref:`float<class_float>` offset, :ref:`bool<class_bool>` cubic=null **)** const
|
||||||
|
|
||||||
Returns a point within the curve at position "offset", where "offset" is measured as a pixel distance along the curve.
|
Returns a point within the curve at position "offset", where "offset" is measured as a pixel distance along the curve.
|
||||||
|
|
||||||
@@ -180,9 +180,9 @@ Sets the position of the control point leading out of the vertex "idx". If the i
|
|||||||
|
|
||||||
Sets the position for the vertex "idx". If the index is out of bounds, the function sends an error to the console.
|
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:
|
.. _class_Curve2D_tessellate:
|
||||||
|
|
||||||
- :ref:`PoolVector2Array<class_poolvector2array>` **tesselate** **(** :ref:`int<class_int>` max_stages=5, :ref:`float<class_float>` tolerance_degrees=4 **)** const
|
- :ref:`PoolVector2Array<class_poolvector2array>` **tessellate** **(** :ref:`int<class_int>` max_stages=4, :ref:`float<class_float>` tolerance_degrees=5 **)** const
|
||||||
|
|
||||||
Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts.
|
Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts.
|
||||||
|
|
||||||
|
|||||||
@@ -18,54 +18,54 @@ Describes a Bezier curve in 3D space.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| 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:`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=null **)** |
|
||||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`clear_points<class_Curve3D_clear_points>` **(** **)** |
|
| void | :ref:`clear_points<class_Curve3D_clear_points>` **(** **)** |
|
||||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_bake_interval<class_Curve3D_get_bake_interval>` **(** **)** const |
|
| :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:`float<class_float>` | :ref:`get_baked_length<class_Curve3D_get_baked_length>` **(** **)** const |
|
||||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`PoolVector3Array<class_poolvector3array>` | :ref:`get_baked_points<class_Curve3D_get_baked_points>` **(** **)** const |
|
| :ref:`PoolVector3Array<class_poolvector3array>` | :ref:`get_baked_points<class_Curve3D_get_baked_points>` **(** **)** const |
|
||||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`PoolRealArray<class_poolrealarray>` | :ref:`get_baked_tilts<class_Curve3D_get_baked_tilts>` **(** **)** const |
|
| :ref:`PoolRealArray<class_poolrealarray>` | :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:`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_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_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:`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:`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<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:`interpolate_baked<class_Curve3D_interpolate_baked>` **(** :ref:`float<class_float>` offset, :ref:`bool<class_bool>` cubic=null **)** const |
|
||||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector3<class_vector3>` | :ref:`interpolatef<class_Curve3D_interpolatef>` **(** :ref:`float<class_float>` fofs **)** 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:`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_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_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_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_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 **)** |
|
| void | :ref:`set_point_tilt<class_Curve3D_set_point_tilt>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` tilt **)** |
|
||||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`PoolVector3Array<class_poolvector3array>` | :ref:`tesselate<class_Curve3D_tesselate>` **(** :ref:`int<class_int>` max_stages=5, :ref:`float<class_float>` tolerance_degrees=4 **)** const |
|
| :ref:`PoolVector3Array<class_poolvector3array>` | :ref:`tessellate<class_Curve3D_tessellate>` **(** :ref:`int<class_int>` max_stages=4, :ref:`float<class_float>` tolerance_degrees=5 **)** const |
|
||||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
- :ref:`int<class_int>` **_data**
|
- :ref:`Dictionary<class_dictionary>` **_data**
|
||||||
- :ref:`float<class_float>` **bake_interval**
|
- :ref:`float<class_float>` **bake_interval**
|
||||||
|
|
||||||
Description
|
Description
|
||||||
@@ -80,7 +80,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_Curve3D_add_point:
|
.. _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 **)**
|
- 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=null **)**
|
||||||
|
|
||||||
Adds a point to a curve, at position "pos", with control points "in" and "out".
|
Adds a point to a curve, at position "pos", with control points "in" and "out".
|
||||||
|
|
||||||
@@ -154,7 +154,7 @@ If "idx" is out of bounds it is truncated to the first or last vertex, and "t" i
|
|||||||
|
|
||||||
.. _class_Curve3D_interpolate_baked:
|
.. _class_Curve3D_interpolate_baked:
|
||||||
|
|
||||||
- :ref:`Vector3<class_vector3>` **interpolate_baked** **(** :ref:`float<class_float>` offset, :ref:`bool<class_bool>` cubic=false **)** const
|
- :ref:`Vector3<class_vector3>` **interpolate_baked** **(** :ref:`float<class_float>` offset, :ref:`bool<class_bool>` cubic=null **)** const
|
||||||
|
|
||||||
Returns a point within the curve at position "offset", where "offset" is measured as a distance in 3D units along the curve.
|
Returns a point within the curve at position "offset", where "offset" is measured as a distance in 3D units along the curve.
|
||||||
|
|
||||||
@@ -206,9 +206,9 @@ Sets the tilt angle in radians for the point "idx". If the index is out of bound
|
|||||||
|
|
||||||
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.
|
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:
|
.. _class_Curve3D_tessellate:
|
||||||
|
|
||||||
- :ref:`PoolVector3Array<class_poolvector3array>` **tesselate** **(** :ref:`int<class_int>` max_stages=5, :ref:`float<class_float>` tolerance_degrees=4 **)** const
|
- :ref:`PoolVector3Array<class_poolvector3array>` **tessellate** **(** :ref:`int<class_int>` max_stages=4, :ref:`float<class_float>` tolerance_degrees=5 **)** const
|
||||||
|
|
||||||
Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts.
|
Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts.
|
||||||
|
|
||||||
|
|||||||
@@ -31,6 +31,7 @@ Member Functions
|
|||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
|
- :ref:`float<class_float>` **directional_shadow_bias_split_scale**
|
||||||
- :ref:`bool<class_bool>` **directional_shadow_blend_splits**
|
- :ref:`bool<class_bool>` **directional_shadow_blend_splits**
|
||||||
- :ref:`int<class_int>` **directional_shadow_mode**
|
- :ref:`int<class_int>` **directional_shadow_mode**
|
||||||
- :ref:`float<class_float>` **directional_shadow_normal_bias**
|
- :ref:`float<class_float>` **directional_shadow_normal_bias**
|
||||||
|
|||||||
@@ -19,9 +19,9 @@ Member Functions
|
|||||||
----------------
|
----------------
|
||||||
|
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| Error | :ref:`change_dir<class_Directory_change_dir>` **(** :ref:`String<class_string>` todir **)** |
|
| :ref:`int<class_int>` | :ref:`change_dir<class_Directory_change_dir>` **(** :ref:`String<class_string>` todir **)** |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| Error | :ref:`copy<class_Directory_copy>` **(** :ref:`String<class_string>` from, :ref:`String<class_string>` to **)** |
|
| :ref:`int<class_int>` | :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 |
|
| :ref:`bool<class_bool>` | :ref:`current_is_dir<class_Directory_current_is_dir>` **(** **)** const |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -45,15 +45,15 @@ Member Functions
|
|||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`list_dir_end<class_Directory_list_dir_end>` **(** **)** |
|
| void | :ref:`list_dir_end<class_Directory_list_dir_end>` **(** **)** |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| Error | :ref:`make_dir<class_Directory_make_dir>` **(** :ref:`String<class_string>` path **)** |
|
| :ref:`int<class_int>` | :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:`int<class_int>` | :ref:`make_dir_recursive<class_Directory_make_dir_recursive>` **(** :ref:`String<class_string>` path **)** |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| Error | :ref:`open<class_Directory_open>` **(** :ref:`String<class_string>` path **)** |
|
| :ref:`int<class_int>` | :ref:`open<class_Directory_open>` **(** :ref:`String<class_string>` path **)** |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| Error | :ref:`remove<class_Directory_remove>` **(** :ref:`String<class_string>` path **)** |
|
| :ref:`int<class_int>` | :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 **)** |
|
| :ref:`int<class_int>` | :ref:`rename<class_Directory_rename>` **(** :ref:`String<class_string>` from, :ref:`String<class_string>` to **)** |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Description
|
Description
|
||||||
@@ -84,7 +84,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_Directory_change_dir:
|
.. _class_Directory_change_dir:
|
||||||
|
|
||||||
- Error **change_dir** **(** :ref:`String<class_string>` todir **)**
|
- :ref:`int<class_int>` **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``).
|
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``).
|
||||||
|
|
||||||
@@ -92,7 +92,7 @@ The method returns one of the error code constants defined in :ref:`@Global Scop
|
|||||||
|
|
||||||
.. _class_Directory_copy:
|
.. _class_Directory_copy:
|
||||||
|
|
||||||
- Error **copy** **(** :ref:`String<class_string>` from, :ref:`String<class_string>` to **)**
|
- :ref:`int<class_int>` **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.
|
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.
|
||||||
|
|
||||||
@@ -170,7 +170,7 @@ Close the current stream opened with :ref:`list_dir_begin<class_Directory_list_d
|
|||||||
|
|
||||||
.. _class_Directory_make_dir:
|
.. _class_Directory_make_dir:
|
||||||
|
|
||||||
- Error **make_dir** **(** :ref:`String<class_string>` path **)**
|
- :ref:`int<class_int>` **make_dir** **(** :ref:`String<class_string>` path **)**
|
||||||
|
|
||||||
Create a directory. The argument can be relative to the current directory, or an absolute path. The target directory should be placed in an already existing directory (to create the full path recursively, see :ref:`make_dir_recursive<class_Directory_make_dir_recursive>`).
|
Create a directory. The argument can be relative to the current directory, or an absolute path. The target directory should be placed in an already existing directory (to create the full path recursively, see :ref:`make_dir_recursive<class_Directory_make_dir_recursive>`).
|
||||||
|
|
||||||
@@ -178,7 +178,7 @@ The method returns one of the error code constants defined in :ref:`@Global Scop
|
|||||||
|
|
||||||
.. _class_Directory_make_dir_recursive:
|
.. _class_Directory_make_dir_recursive:
|
||||||
|
|
||||||
- Error **make_dir_recursive** **(** :ref:`String<class_string>` path **)**
|
- :ref:`int<class_int>` **make_dir_recursive** **(** :ref:`String<class_string>` path **)**
|
||||||
|
|
||||||
Create a target directory and all necessary intermediate directories in its path, by calling :ref:`make_dir<class_Directory_make_dir>` recursively. The argument can be relative to the current directory, or an absolute path.
|
Create a target directory and all necessary intermediate directories in its path, by calling :ref:`make_dir<class_Directory_make_dir>` recursively. The argument can be relative to the current directory, or an absolute path.
|
||||||
|
|
||||||
@@ -186,7 +186,7 @@ Return one of the error code constants defined in :ref:`@Global Scope<class_@glo
|
|||||||
|
|
||||||
.. _class_Directory_open:
|
.. _class_Directory_open:
|
||||||
|
|
||||||
- Error **open** **(** :ref:`String<class_string>` path **)**
|
- :ref:`int<class_int>` **open** **(** :ref:`String<class_string>` 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``).
|
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``).
|
||||||
|
|
||||||
@@ -194,7 +194,7 @@ The method returns one of the error code constants defined in :ref:`@Global Scop
|
|||||||
|
|
||||||
.. _class_Directory_remove:
|
.. _class_Directory_remove:
|
||||||
|
|
||||||
- Error **remove** **(** :ref:`String<class_string>` path **)**
|
- :ref:`int<class_int>` **remove** **(** :ref:`String<class_string>` path **)**
|
||||||
|
|
||||||
Delete the target file or an empty directory. The argument can be relative to the current directory, or an absolute path. If the target directory is not empty, the operation will fail.
|
Delete the target file or an empty directory. The argument can be relative to the current directory, or an absolute path. If the target directory is not empty, the operation will fail.
|
||||||
|
|
||||||
@@ -202,7 +202,7 @@ Return one of the error code constants defined in :ref:`@Global Scope<class_@glo
|
|||||||
|
|
||||||
.. _class_Directory_rename:
|
.. _class_Directory_rename:
|
||||||
|
|
||||||
- Error **rename** **(** :ref:`String<class_string>` from, :ref:`String<class_string>` to **)**
|
- :ref:`int<class_int>` **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.
|
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.
|
||||||
|
|
||||||
|
|||||||
@@ -42,6 +42,7 @@ Signals
|
|||||||
- **filesystem_changed** **(** **)**
|
- **filesystem_changed** **(** **)**
|
||||||
Emitted if the filesystem changed.
|
Emitted if the filesystem changed.
|
||||||
|
|
||||||
|
- **resources_reimported** **(** :ref:`PoolStringArray<class_poolstringarray>` resources **)**
|
||||||
- **sources_changed** **(** :ref:`bool<class_bool>` exist **)**
|
- **sources_changed** **(** :ref:`bool<class_bool>` exist **)**
|
||||||
Emitted if the source of any imported file changed.
|
Emitted if the source of any imported file changed.
|
||||||
|
|
||||||
|
|||||||
@@ -18,29 +18,31 @@ A diretory for the resource filesystem.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`find_dir_index<class_EditorFileSystemDirectory_find_dir_index>` **(** :ref:`String<class_string>` name **)** const |
|
| :ref:`int<class_int>` | :ref:`find_dir_index<class_EditorFileSystemDirectory_find_dir_index>` **(** :ref:`String<class_string>` name **)** const |
|
||||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`find_file_index<class_EditorFileSystemDirectory_find_file_index>` **(** :ref:`String<class_string>` name **)** const |
|
| :ref:`int<class_int>` | :ref:`find_file_index<class_EditorFileSystemDirectory_find_file_index>` **(** :ref:`String<class_string>` name **)** const |
|
||||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`get_file<class_EditorFileSystemDirectory_get_file>` **(** :ref:`int<class_int>` idx **)** const |
|
| :ref:`String<class_string>` | :ref:`get_file<class_EditorFileSystemDirectory_get_file>` **(** :ref:`int<class_int>` idx **)** const |
|
||||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_file_count<class_EditorFileSystemDirectory_get_file_count>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_file_count<class_EditorFileSystemDirectory_get_file_count>` **(** **)** const |
|
||||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`get_file_path<class_EditorFileSystemDirectory_get_file_path>` **(** :ref:`int<class_int>` idx **)** const |
|
| :ref:`bool<class_bool>` | :ref:`get_file_import_is_valid<class_EditorFileSystemDirectory_get_file_import_is_valid>` **(** :ref:`int<class_int>` idx **)** const |
|
||||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`get_file_type<class_EditorFileSystemDirectory_get_file_type>` **(** :ref:`int<class_int>` idx **)** const |
|
| :ref:`String<class_string>` | :ref:`get_file_path<class_EditorFileSystemDirectory_get_file_path>` **(** :ref:`int<class_int>` idx **)** const |
|
||||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`get_name<class_EditorFileSystemDirectory_get_name>` **(** **)** |
|
| :ref:`String<class_string>` | :ref:`get_file_type<class_EditorFileSystemDirectory_get_file_type>` **(** :ref:`int<class_int>` idx **)** const |
|
||||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`EditorFileSystemDirectory<class_editorfilesystemdirectory>` | :ref:`get_parent<class_EditorFileSystemDirectory_get_parent>` **(** **)** |
|
| :ref:`String<class_string>` | :ref:`get_name<class_EditorFileSystemDirectory_get_name>` **(** **)** |
|
||||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`get_path<class_EditorFileSystemDirectory_get_path>` **(** **)** const |
|
| :ref:`EditorFileSystemDirectory<class_editorfilesystemdirectory>` | :ref:`get_parent<class_EditorFileSystemDirectory_get_parent>` **(** **)** |
|
||||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Object<class_object>` | :ref:`get_subdir<class_EditorFileSystemDirectory_get_subdir>` **(** :ref:`int<class_int>` idx **)** |
|
| :ref:`String<class_string>` | :ref:`get_path<class_EditorFileSystemDirectory_get_path>` **(** **)** const |
|
||||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_subdir_count<class_EditorFileSystemDirectory_get_subdir_count>` **(** **)** const |
|
| :ref:`EditorFileSystemDirectory<class_editorfilesystemdirectory>` | :ref:`get_subdir<class_EditorFileSystemDirectory_get_subdir>` **(** :ref:`int<class_int>` idx **)** |
|
||||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`int<class_int>` | :ref:`get_subdir_count<class_EditorFileSystemDirectory_get_subdir_count>` **(** **)** const |
|
||||||
|
+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Member Function Description
|
Member Function Description
|
||||||
---------------------------
|
---------------------------
|
||||||
@@ -61,6 +63,10 @@ Member Function Description
|
|||||||
|
|
||||||
- :ref:`int<class_int>` **get_file_count** **(** **)** const
|
- :ref:`int<class_int>` **get_file_count** **(** **)** const
|
||||||
|
|
||||||
|
.. _class_EditorFileSystemDirectory_get_file_import_is_valid:
|
||||||
|
|
||||||
|
- :ref:`bool<class_bool>` **get_file_import_is_valid** **(** :ref:`int<class_int>` idx **)** const
|
||||||
|
|
||||||
.. _class_EditorFileSystemDirectory_get_file_path:
|
.. _class_EditorFileSystemDirectory_get_file_path:
|
||||||
|
|
||||||
- :ref:`String<class_string>` **get_file_path** **(** :ref:`int<class_int>` idx **)** const
|
- :ref:`String<class_string>` **get_file_path** **(** :ref:`int<class_int>` idx **)** const
|
||||||
@@ -83,7 +89,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_EditorFileSystemDirectory_get_subdir:
|
.. _class_EditorFileSystemDirectory_get_subdir:
|
||||||
|
|
||||||
- :ref:`Object<class_object>` **get_subdir** **(** :ref:`int<class_int>` idx **)**
|
- :ref:`EditorFileSystemDirectory<class_editorfilesystemdirectory>` **get_subdir** **(** :ref:`int<class_int>` idx **)**
|
||||||
|
|
||||||
.. _class_EditorFileSystemDirectory_get_subdir_count:
|
.. _class_EditorFileSystemDirectory_get_subdir_count:
|
||||||
|
|
||||||
|
|||||||
122
classes/class_editorinterface.rst
Normal file
122
classes/class_editorinterface.rst
Normal file
@@ -0,0 +1,122 @@
|
|||||||
|
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
||||||
|
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
|
||||||
|
|
||||||
|
.. _class_EditorInterface:
|
||||||
|
|
||||||
|
EditorInterface
|
||||||
|
===============
|
||||||
|
|
||||||
|
**Inherits:** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
|
||||||
|
|
||||||
|
**Category:** Core
|
||||||
|
|
||||||
|
Brief Description
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Member Functions
|
||||||
|
----------------
|
||||||
|
|
||||||
|
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`edit_resource<class_EditorInterface_edit_resource>` **(** :ref:`Resource<class_resource>` resource **)** |
|
||||||
|
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`Control<class_control>` | :ref:`get_base_control<class_EditorInterface_get_base_control>` **(** **)** |
|
||||||
|
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`Node<class_node>` | :ref:`get_edited_scene_root<class_EditorInterface_get_edited_scene_root>` **(** **)** |
|
||||||
|
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`EditorSettings<class_editorsettings>` | :ref:`get_editor_settings<class_EditorInterface_get_editor_settings>` **(** **)** |
|
||||||
|
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`Control<class_control>` | :ref:`get_editor_viewport<class_EditorInterface_get_editor_viewport>` **(** **)** |
|
||||||
|
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`Array<class_array>` | :ref:`get_open_scenes<class_EditorInterface_get_open_scenes>` **(** **)** const |
|
||||||
|
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`EditorFileSystem<class_editorfilesystem>` | :ref:`get_resource_filesystem<class_EditorInterface_get_resource_filesystem>` **(** **)** |
|
||||||
|
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`EditorResourcePreview<class_editorresourcepreview>` | :ref:`get_resource_previewer<class_EditorInterface_get_resource_previewer>` **(** **)** |
|
||||||
|
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`ScriptEditor<class_scripteditor>` | :ref:`get_script_editor<class_EditorInterface_get_script_editor>` **(** **)** |
|
||||||
|
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`EditorSelection<class_editorselection>` | :ref:`get_selection<class_EditorInterface_get_selection>` **(** **)** |
|
||||||
|
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`inspect_object<class_EditorInterface_inspect_object>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` for_property=null **)** |
|
||||||
|
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`Array<class_array>` | :ref:`make_mesh_previews<class_EditorInterface_make_mesh_previews>` **(** :ref:`Array<class_array>` arg0, :ref:`int<class_int>` arg1 **)** |
|
||||||
|
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`open_scene_from_path<class_EditorInterface_open_scene_from_path>` **(** :ref:`String<class_string>` scene_filepath **)** |
|
||||||
|
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`reload_scene_from_path<class_EditorInterface_reload_scene_from_path>` **(** :ref:`String<class_string>` scene_filepath **)** |
|
||||||
|
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`int<class_int>` | :ref:`save_scene<class_EditorInterface_save_scene>` **(** **)** |
|
||||||
|
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`save_scene_as<class_EditorInterface_save_scene_as>` **(** :ref:`String<class_string>` path, :ref:`bool<class_bool>` with_preview=null **)** |
|
||||||
|
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
|
Member Function Description
|
||||||
|
---------------------------
|
||||||
|
|
||||||
|
.. _class_EditorInterface_edit_resource:
|
||||||
|
|
||||||
|
- void **edit_resource** **(** :ref:`Resource<class_resource>` resource **)**
|
||||||
|
|
||||||
|
.. _class_EditorInterface_get_base_control:
|
||||||
|
|
||||||
|
- :ref:`Control<class_control>` **get_base_control** **(** **)**
|
||||||
|
|
||||||
|
.. _class_EditorInterface_get_edited_scene_root:
|
||||||
|
|
||||||
|
- :ref:`Node<class_node>` **get_edited_scene_root** **(** **)**
|
||||||
|
|
||||||
|
.. _class_EditorInterface_get_editor_settings:
|
||||||
|
|
||||||
|
- :ref:`EditorSettings<class_editorsettings>` **get_editor_settings** **(** **)**
|
||||||
|
|
||||||
|
.. _class_EditorInterface_get_editor_viewport:
|
||||||
|
|
||||||
|
- :ref:`Control<class_control>` **get_editor_viewport** **(** **)**
|
||||||
|
|
||||||
|
.. _class_EditorInterface_get_open_scenes:
|
||||||
|
|
||||||
|
- :ref:`Array<class_array>` **get_open_scenes** **(** **)** const
|
||||||
|
|
||||||
|
.. _class_EditorInterface_get_resource_filesystem:
|
||||||
|
|
||||||
|
- :ref:`EditorFileSystem<class_editorfilesystem>` **get_resource_filesystem** **(** **)**
|
||||||
|
|
||||||
|
.. _class_EditorInterface_get_resource_previewer:
|
||||||
|
|
||||||
|
- :ref:`EditorResourcePreview<class_editorresourcepreview>` **get_resource_previewer** **(** **)**
|
||||||
|
|
||||||
|
.. _class_EditorInterface_get_script_editor:
|
||||||
|
|
||||||
|
- :ref:`ScriptEditor<class_scripteditor>` **get_script_editor** **(** **)**
|
||||||
|
|
||||||
|
.. _class_EditorInterface_get_selection:
|
||||||
|
|
||||||
|
- :ref:`EditorSelection<class_editorselection>` **get_selection** **(** **)**
|
||||||
|
|
||||||
|
.. _class_EditorInterface_inspect_object:
|
||||||
|
|
||||||
|
- void **inspect_object** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` for_property=null **)**
|
||||||
|
|
||||||
|
.. _class_EditorInterface_make_mesh_previews:
|
||||||
|
|
||||||
|
- :ref:`Array<class_array>` **make_mesh_previews** **(** :ref:`Array<class_array>` arg0, :ref:`int<class_int>` arg1 **)**
|
||||||
|
|
||||||
|
.. _class_EditorInterface_open_scene_from_path:
|
||||||
|
|
||||||
|
- void **open_scene_from_path** **(** :ref:`String<class_string>` scene_filepath **)**
|
||||||
|
|
||||||
|
.. _class_EditorInterface_reload_scene_from_path:
|
||||||
|
|
||||||
|
- void **reload_scene_from_path** **(** :ref:`String<class_string>` scene_filepath **)**
|
||||||
|
|
||||||
|
.. _class_EditorInterface_save_scene:
|
||||||
|
|
||||||
|
- :ref:`int<class_int>` **save_scene** **(** **)**
|
||||||
|
|
||||||
|
.. _class_EditorInterface_save_scene_as:
|
||||||
|
|
||||||
|
- void **save_scene_as** **(** :ref:`String<class_string>` path, :ref:`bool<class_bool>` with_preview=null **)**
|
||||||
|
|
||||||
|
|
||||||
@@ -18,99 +18,75 @@ Used by the editor to extend its functionality.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`ToolButton<class_toolbutton>` | :ref:`add_control_to_bottom_panel<class_EditorPlugin_add_control_to_bottom_panel>` **(** :ref:`Control<class_control>` control, :ref:`String<class_string>` title **)** |
|
| :ref:`ToolButton<class_toolbutton>` | :ref:`add_control_to_bottom_panel<class_EditorPlugin_add_control_to_bottom_panel>` **(** :ref:`Control<class_control>` control, :ref:`String<class_string>` title **)** |
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`add_control_to_container<class_EditorPlugin_add_control_to_container>` **(** :ref:`int<class_int>` container, :ref:`Control<class_control>` control **)** |
|
| void | :ref:`add_control_to_container<class_EditorPlugin_add_control_to_container>` **(** :ref:`int<class_int>` container, :ref:`Control<class_control>` control **)** |
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`add_control_to_dock<class_EditorPlugin_add_control_to_dock>` **(** :ref:`int<class_int>` slot, :ref:`Control<class_control>` control **)** |
|
| void | :ref:`add_control_to_dock<class_EditorPlugin_add_control_to_dock>` **(** :ref:`int<class_int>` slot, :ref:`Control<class_control>` 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:`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:`add_import_plugin<class_EditorPlugin_add_import_plugin>` **(** :ref:`Object<class_object>` arg0 **)** |
|
| void | :ref:`add_import_plugin<class_EditorPlugin_add_import_plugin>` **(** :ref:`EditorImportPlugin<class_editorimportplugin>` importer **)** |
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`add_tool_submenu_item<class_EditorPlugin_add_tool_submenu_item>` **(** :ref:`String<class_string>` name, :ref:`PopupMenu<class_popupmenu>` submenu **)** |
|
| void | :ref:`add_tool_submenu_item<class_EditorPlugin_add_tool_submenu_item>` **(** :ref:`String<class_string>` name, :ref:`Object<class_object>` submenu **)** |
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`apply_changes<class_EditorPlugin_apply_changes>` **(** **)** virtual |
|
| void | :ref:`apply_changes<class_EditorPlugin_apply_changes>` **(** **)** virtual |
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`clear<class_EditorPlugin_clear>` **(** **)** virtual |
|
| void | :ref:`clear<class_EditorPlugin_clear>` **(** **)** virtual |
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`EditorSpatialGizmo<class_editorspatialgizmo>` | :ref:`create_spatial_gizmo<class_EditorPlugin_create_spatial_gizmo>` **(** :ref:`Spatial<class_spatial>` for_spatial **)** virtual |
|
| :ref:`EditorSpatialGizmo<class_editorspatialgizmo>` | :ref:`create_spatial_gizmo<class_EditorPlugin_create_spatial_gizmo>` **(** :ref:`Spatial<class_spatial>` for_spatial **)** virtual |
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`edit<class_EditorPlugin_edit>` **(** :ref:`Object<class_object>` object **)** virtual |
|
| void | :ref:`edit<class_EditorPlugin_edit>` **(** :ref:`Object<class_object>` object **)** virtual |
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`edit_resource<class_EditorPlugin_edit_resource>` **(** :ref:`Object<class_object>` arg0 **)** |
|
| :ref:`bool<class_bool>` | :ref:`forward_canvas_gui_input<class_EditorPlugin_forward_canvas_gui_input>` **(** :ref:`Transform2D<class_transform2d>` canvas_xform, :ref:`InputEvent<class_inputevent>` event **)** virtual |
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`forward_canvas_gui_input<class_EditorPlugin_forward_canvas_gui_input>` **(** :ref:`Transform2D<class_transform2d>` canvas_xform, :ref:`InputEvent<class_inputevent>` event **)** virtual |
|
| void | :ref:`forward_draw_over_canvas<class_EditorPlugin_forward_draw_over_canvas>` **(** :ref:`Transform2D<class_transform2d>` canvas_xform, :ref:`Control<class_control>` canvas **)** virtual |
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`forward_draw_over_canvas<class_EditorPlugin_forward_draw_over_canvas>` **(** :ref:`Transform2D<class_transform2d>` canvas_xform, :ref:`Control<class_control>` canvas **)** virtual |
|
| :ref:`bool<class_bool>` | :ref:`forward_spatial_gui_input<class_EditorPlugin_forward_spatial_gui_input>` **(** :ref:`Camera<class_camera>` camera, :ref:`InputEvent<class_inputevent>` event **)** virtual |
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`forward_spatial_gui_input<class_EditorPlugin_forward_spatial_gui_input>` **(** :ref:`Camera<class_camera>` camera, :ref:`InputEvent<class_inputevent>` event **)** virtual |
|
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_breakpoints<class_EditorPlugin_get_breakpoints>` **(** **)** virtual |
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Control<class_control>` | :ref:`get_base_control<class_EditorPlugin_get_base_control>` **(** **)** |
|
| :ref:`EditorInterface<class_editorinterface>` | :ref:`get_editor_interface<class_EditorPlugin_get_editor_interface>` **(** **)** |
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_breakpoints<class_EditorPlugin_get_breakpoints>` **(** **)** virtual |
|
| :ref:`String<class_string>` | :ref:`get_plugin_name<class_EditorPlugin_get_plugin_name>` **(** **)** virtual |
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`EditorSettings<class_editorsettings>` | :ref:`get_editor_settings<class_EditorPlugin_get_editor_settings>` **(** **)** |
|
| :ref:`Dictionary<class_dictionary>` | :ref:`get_state<class_EditorPlugin_get_state>` **(** **)** virtual |
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Node<class_node>` | :ref:`get_edited_scene_root<class_EditorPlugin_get_edited_scene_root>` **(** **)** |
|
| :ref:`UndoRedo<class_undoredo>` | :ref:`get_undo_redo<class_EditorPlugin_get_undo_redo>` **(** **)** |
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Control<class_control>` | :ref:`get_editor_viewport<class_EditorPlugin_get_editor_viewport>` **(** **)** |
|
| void | :ref:`get_window_layout<class_EditorPlugin_get_window_layout>` **(** :ref:`ConfigFile<class_configfile>` layout **)** virtual |
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`get_name<class_EditorPlugin_get_name>` **(** **)** virtual |
|
| :ref:`bool<class_bool>` | :ref:`handles<class_EditorPlugin_handles>` **(** :ref:`Object<class_object>` object **)** virtual |
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Array<class_array>` | :ref:`get_open_scenes<class_EditorPlugin_get_open_scenes>` **(** **)** |
|
| :ref:`bool<class_bool>` | :ref:`has_main_screen<class_EditorPlugin_has_main_screen>` **(** **)** virtual |
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`EditorFileSystem<class_editorfilesystem>` | :ref:`get_resource_filesystem<class_EditorPlugin_get_resource_filesystem>` **(** **)** |
|
| void | :ref:`hide_bottom_panel<class_EditorPlugin_hide_bottom_panel>` **(** **)** |
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`EditorResourcePreview<class_editorresourcepreview>` | :ref:`get_resource_previewer<class_EditorPlugin_get_resource_previewer>` **(** **)** |
|
| void | :ref:`make_bottom_panel_item_visible<class_EditorPlugin_make_bottom_panel_item_visible>` **(** :ref:`Control<class_control>` item **)** |
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`ScriptEditor<class_scripteditor>` | :ref:`get_script_editor<class_EditorPlugin_get_script_editor>` **(** **)** |
|
| void | :ref:`make_visible<class_EditorPlugin_make_visible>` **(** :ref:`bool<class_bool>` visible **)** virtual |
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`EditorSelection<class_editorselection>` | :ref:`get_selection<class_EditorPlugin_get_selection>` **(** **)** |
|
| void | :ref:`queue_save_layout<class_EditorPlugin_queue_save_layout>` **(** **)** const |
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Dictionary<class_dictionary>` | :ref:`get_state<class_EditorPlugin_get_state>` **(** **)** virtual |
|
| void | :ref:`remove_control_from_bottom_panel<class_EditorPlugin_remove_control_from_bottom_panel>` **(** :ref:`Control<class_control>` control **)** |
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`UndoRedo<class_undoredo>` | :ref:`get_undo_redo<class_EditorPlugin_get_undo_redo>` **(** **)** |
|
| void | :ref:`remove_control_from_docks<class_EditorPlugin_remove_control_from_docks>` **(** :ref:`Control<class_control>` control **)** |
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`get_window_layout<class_EditorPlugin_get_window_layout>` **(** :ref:`ConfigFile<class_configfile>` layout **)** virtual |
|
| void | :ref:`remove_custom_type<class_EditorPlugin_remove_custom_type>` **(** :ref:`String<class_string>` type **)** |
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`handles<class_EditorPlugin_handles>` **(** :ref:`Object<class_object>` object **)** virtual |
|
| void | :ref:`remove_import_plugin<class_EditorPlugin_remove_import_plugin>` **(** :ref:`EditorImportPlugin<class_editorimportplugin>` importer **)** |
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`has_main_screen<class_EditorPlugin_has_main_screen>` **(** **)** virtual |
|
| void | :ref:`save_external_data<class_EditorPlugin_save_external_data>` **(** **)** virtual |
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`hide_bottom_panel<class_EditorPlugin_hide_bottom_panel>` **(** **)** |
|
| void | :ref:`set_input_event_forwarding_always_enabled<class_EditorPlugin_set_input_event_forwarding_always_enabled>` **(** **)** |
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`inspect_object<class_EditorPlugin_inspect_object>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` for_property="" **)** |
|
| void | :ref:`set_state<class_EditorPlugin_set_state>` **(** :ref:`Dictionary<class_dictionary>` state **)** virtual |
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`make_bottom_panel_item_visible<class_EditorPlugin_make_bottom_panel_item_visible>` **(** :ref:`Control<class_control>` item **)** |
|
| void | :ref:`set_window_layout<class_EditorPlugin_set_window_layout>` **(** :ref:`ConfigFile<class_configfile>` layout **)** virtual |
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`make_visible<class_EditorPlugin_make_visible>` **(** :ref:`bool<class_bool>` visible **)** virtual |
|
| void | :ref:`update_canvas<class_EditorPlugin_update_canvas>` **(** **)** |
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`open_scene_from_path<class_EditorPlugin_open_scene_from_path>` **(** :ref:`String<class_string>` scene_filepath **)** |
|
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`queue_save_layout<class_EditorPlugin_queue_save_layout>` **(** **)** const |
|
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`reload_scene_from_path<class_EditorPlugin_reload_scene_from_path>` **(** :ref:`String<class_string>` scene_filepath **)** |
|
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`remove_control_from_bottom_panel<class_EditorPlugin_remove_control_from_bottom_panel>` **(** :ref:`Control<class_control>` control **)** |
|
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`remove_control_from_docks<class_EditorPlugin_remove_control_from_docks>` **(** :ref:`Control<class_control>` control **)** |
|
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`remove_custom_type<class_EditorPlugin_remove_custom_type>` **(** :ref:`String<class_string>` type **)** |
|
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`remove_import_plugin<class_EditorPlugin_remove_import_plugin>` **(** :ref:`Object<class_object>` arg0 **)** |
|
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`save_external_data<class_EditorPlugin_save_external_data>` **(** **)** virtual |
|
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_input_event_forwarding_always_enabled<class_EditorPlugin_set_input_event_forwarding_always_enabled>` **(** **)** |
|
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_state<class_EditorPlugin_set_state>` **(** :ref:`Dictionary<class_dictionary>` state **)** virtual |
|
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_window_layout<class_EditorPlugin_set_window_layout>` **(** :ref:`ConfigFile<class_configfile>` layout **)** virtual |
|
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`update_canvas<class_EditorPlugin_update_canvas>` **(** **)** |
|
|
||||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Signals
|
Signals
|
||||||
-------
|
-------
|
||||||
@@ -118,7 +94,7 @@ Signals
|
|||||||
- **main_screen_changed** **(** :ref:`String<class_string>` screen_name **)**
|
- **main_screen_changed** **(** :ref:`String<class_string>` screen_name **)**
|
||||||
Emitted when user change main screen view (2D, 3D, Script, AssetLib). Works also with screens which are defined by plugins.
|
Emitted when user change main screen view (2D, 3D, Script, AssetLib). Works also with screens which are defined by plugins.
|
||||||
|
|
||||||
- **scene_changed** **(** :ref:`Node<class_node>` scene_root **)**
|
- **scene_changed** **(** :ref:`Object<class_object>` scene_root **)**
|
||||||
Emitted when user change scene. The argument is a root node of freshly opened scene.
|
Emitted when user change scene. The argument is a root node of freshly opened scene.
|
||||||
|
|
||||||
- **scene_closed** **(** :ref:`String<class_string>` filepath **)**
|
- **scene_closed** **(** :ref:`String<class_string>` filepath **)**
|
||||||
@@ -193,11 +169,11 @@ During run-time, this will be a simple object with a script so this function doe
|
|||||||
|
|
||||||
.. _class_EditorPlugin_add_import_plugin:
|
.. _class_EditorPlugin_add_import_plugin:
|
||||||
|
|
||||||
- void **add_import_plugin** **(** :ref:`Object<class_object>` arg0 **)**
|
- void **add_import_plugin** **(** :ref:`EditorImportPlugin<class_editorimportplugin>` importer **)**
|
||||||
|
|
||||||
.. _class_EditorPlugin_add_tool_submenu_item:
|
.. _class_EditorPlugin_add_tool_submenu_item:
|
||||||
|
|
||||||
- void **add_tool_submenu_item** **(** :ref:`String<class_string>` name, :ref:`PopupMenu<class_popupmenu>` submenu **)**
|
- void **add_tool_submenu_item** **(** :ref:`String<class_string>` name, :ref:`Object<class_object>` submenu **)**
|
||||||
|
|
||||||
.. _class_EditorPlugin_apply_changes:
|
.. _class_EditorPlugin_apply_changes:
|
||||||
|
|
||||||
@@ -225,10 +201,6 @@ This is used for plugins that create gizmos used by the spatial editor. Just che
|
|||||||
|
|
||||||
This function is used for plugins that edit specific object types (nodes or resources). It requests the editor to edit the given object.
|
This function is used for plugins that edit specific object types (nodes or resources). It requests the editor to edit the given object.
|
||||||
|
|
||||||
.. _class_EditorPlugin_edit_resource:
|
|
||||||
|
|
||||||
- void **edit_resource** **(** :ref:`Object<class_object>` arg0 **)**
|
|
||||||
|
|
||||||
.. _class_EditorPlugin_forward_canvas_gui_input:
|
.. _class_EditorPlugin_forward_canvas_gui_input:
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **forward_canvas_gui_input** **(** :ref:`Transform2D<class_transform2d>` canvas_xform, :ref:`InputEvent<class_inputevent>` event **)** virtual
|
- :ref:`bool<class_bool>` **forward_canvas_gui_input** **(** :ref:`Transform2D<class_transform2d>` canvas_xform, :ref:`InputEvent<class_inputevent>` event **)** virtual
|
||||||
@@ -247,71 +219,19 @@ Implement this function if you are interested in 3D view screen input events. It
|
|||||||
|
|
||||||
If you would like to always gets those input events then additionally use :ref:`set_input_forwarding_always_enabled<class_EditorPlugin_set_input_forwarding_always_enabled>`.
|
If you would like to always gets those input events then additionally use :ref:`set_input_forwarding_always_enabled<class_EditorPlugin_set_input_forwarding_always_enabled>`.
|
||||||
|
|
||||||
.. _class_EditorPlugin_get_base_control:
|
|
||||||
|
|
||||||
- :ref:`Control<class_control>` **get_base_control** **(** **)**
|
|
||||||
|
|
||||||
Get a base control where it's safe to place dialogs. Many plugins open dialogs and they need a control as a base to make sure they use the editor icons and theme.
|
|
||||||
|
|
||||||
.. _class_EditorPlugin_get_breakpoints:
|
.. _class_EditorPlugin_get_breakpoints:
|
||||||
|
|
||||||
- :ref:`PoolStringArray<class_poolstringarray>` **get_breakpoints** **(** **)** virtual
|
- :ref:`PoolStringArray<class_poolstringarray>` **get_breakpoints** **(** **)** virtual
|
||||||
|
|
||||||
This is for editors that edit script based objects. You can return a list of breakpoints in the format (script:line), for example: res://path_to_script.gd:25
|
This is for editors that edit script based objects. You can return a list of breakpoints in the format (script:line), for example: res://path_to_script.gd:25
|
||||||
|
|
||||||
.. _class_EditorPlugin_get_editor_settings:
|
.. _class_EditorPlugin_get_editor_interface:
|
||||||
|
|
||||||
- :ref:`EditorSettings<class_editorsettings>` **get_editor_settings** **(** **)**
|
- :ref:`EditorInterface<class_editorinterface>` **get_editor_interface** **(** **)**
|
||||||
|
|
||||||
Get the general settings for the editor (the same window that appears in the Settings menu).
|
.. _class_EditorPlugin_get_plugin_name:
|
||||||
|
|
||||||
.. _class_EditorPlugin_get_edited_scene_root:
|
- :ref:`String<class_string>` **get_plugin_name** **(** **)** virtual
|
||||||
|
|
||||||
- :ref:`Node<class_node>` **get_edited_scene_root** **(** **)**
|
|
||||||
|
|
||||||
Returns root node of currently edited scene.
|
|
||||||
|
|
||||||
.. _class_EditorPlugin_get_editor_viewport:
|
|
||||||
|
|
||||||
- :ref:`Control<class_control>` **get_editor_viewport** **(** **)**
|
|
||||||
|
|
||||||
Get the main editor control. Use this as a parent for main screens.
|
|
||||||
|
|
||||||
.. _class_EditorPlugin_get_name:
|
|
||||||
|
|
||||||
- :ref:`String<class_string>` **get_name** **(** **)** virtual
|
|
||||||
|
|
||||||
Get the name of the editor plugin. For main scren plugins this is what will appear in the selector (which by default is 2D, 3D, Script).
|
|
||||||
|
|
||||||
.. _class_EditorPlugin_get_open_scenes:
|
|
||||||
|
|
||||||
- :ref:`Array<class_array>` **get_open_scenes** **(** **)**
|
|
||||||
|
|
||||||
Will return an Array of Strings which represent file paths to currently open scenes.
|
|
||||||
|
|
||||||
.. _class_EditorPlugin_get_resource_filesystem:
|
|
||||||
|
|
||||||
- :ref:`EditorFileSystem<class_editorfilesystem>` **get_resource_filesystem** **(** **)**
|
|
||||||
|
|
||||||
Get the filesystem cache for all resources in the project.
|
|
||||||
|
|
||||||
.. _class_EditorPlugin_get_resource_previewer:
|
|
||||||
|
|
||||||
- :ref:`EditorResourcePreview<class_editorresourcepreview>` **get_resource_previewer** **(** **)**
|
|
||||||
|
|
||||||
Get tool for generating resource previews.
|
|
||||||
|
|
||||||
.. _class_EditorPlugin_get_script_editor:
|
|
||||||
|
|
||||||
- :ref:`ScriptEditor<class_scripteditor>` **get_script_editor** **(** **)**
|
|
||||||
|
|
||||||
Will return ScriptEditor object which contains informations about state of the scripts which are currently open by the editor.
|
|
||||||
|
|
||||||
.. _class_EditorPlugin_get_selection:
|
|
||||||
|
|
||||||
- :ref:`EditorSelection<class_editorselection>` **get_selection** **(** **)**
|
|
||||||
|
|
||||||
Get the object that handles the selection of nodes in the Scene Tree editor.
|
|
||||||
|
|
||||||
.. _class_EditorPlugin_get_state:
|
.. _class_EditorPlugin_get_state:
|
||||||
|
|
||||||
@@ -347,12 +267,6 @@ Return true if this is a main screen editor plugin (it goes in the main screen s
|
|||||||
|
|
||||||
- void **hide_bottom_panel** **(** **)**
|
- void **hide_bottom_panel** **(** **)**
|
||||||
|
|
||||||
.. _class_EditorPlugin_inspect_object:
|
|
||||||
|
|
||||||
- void **inspect_object** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` for_property="" **)**
|
|
||||||
|
|
||||||
Inspect an object in the inspector.
|
|
||||||
|
|
||||||
.. _class_EditorPlugin_make_bottom_panel_item_visible:
|
.. _class_EditorPlugin_make_bottom_panel_item_visible:
|
||||||
|
|
||||||
- void **make_bottom_panel_item_visible** **(** :ref:`Control<class_control>` item **)**
|
- void **make_bottom_panel_item_visible** **(** :ref:`Control<class_control>` item **)**
|
||||||
@@ -365,24 +279,12 @@ This function will be called when the editor is requested to become visible. It
|
|||||||
|
|
||||||
Remember that you have to manage the visibility of all your editor controls manually.
|
Remember that you have to manage the visibility of all your editor controls manually.
|
||||||
|
|
||||||
.. _class_EditorPlugin_open_scene_from_path:
|
|
||||||
|
|
||||||
- void **open_scene_from_path** **(** :ref:`String<class_string>` scene_filepath **)**
|
|
||||||
|
|
||||||
Opens scene in editor. Do not use during plugin initialization. If you need, then use it together with :ref:`Object.call_deferred<class_Object_call_deferred>`.
|
|
||||||
|
|
||||||
.. _class_EditorPlugin_queue_save_layout:
|
.. _class_EditorPlugin_queue_save_layout:
|
||||||
|
|
||||||
- void **queue_save_layout** **(** **)** const
|
- void **queue_save_layout** **(** **)** const
|
||||||
|
|
||||||
Queue save the project's editor layout.
|
Queue save the project's editor layout.
|
||||||
|
|
||||||
.. _class_EditorPlugin_reload_scene_from_path:
|
|
||||||
|
|
||||||
- void **reload_scene_from_path** **(** :ref:`String<class_string>` scene_filepath **)**
|
|
||||||
|
|
||||||
Reloads already loaded editor scene.
|
|
||||||
|
|
||||||
.. _class_EditorPlugin_remove_control_from_bottom_panel:
|
.. _class_EditorPlugin_remove_control_from_bottom_panel:
|
||||||
|
|
||||||
- void **remove_control_from_bottom_panel** **(** :ref:`Control<class_control>` control **)**
|
- void **remove_control_from_bottom_panel** **(** :ref:`Control<class_control>` control **)**
|
||||||
@@ -403,7 +305,7 @@ Remove a custom type added by :ref:`EditorPlugin.add_custom_type<class_EditorPlu
|
|||||||
|
|
||||||
.. _class_EditorPlugin_remove_import_plugin:
|
.. _class_EditorPlugin_remove_import_plugin:
|
||||||
|
|
||||||
- void **remove_import_plugin** **(** :ref:`Object<class_object>` arg0 **)**
|
- void **remove_import_plugin** **(** :ref:`EditorImportPlugin<class_editorimportplugin>` importer **)**
|
||||||
|
|
||||||
.. _class_EditorPlugin_save_external_data:
|
.. _class_EditorPlugin_save_external_data:
|
||||||
|
|
||||||
|
|||||||
@@ -18,13 +18,15 @@ Simple script to perform changes in the currently edited scene.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+------------------------------+-------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+---------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`_run<class_EditorScript__run>` **(** **)** virtual |
|
| void | :ref:`_run<class_EditorScript__run>` **(** **)** virtual |
|
||||||
+------------------------------+-------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+---------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`add_root_node<class_EditorScript_add_root_node>` **(** :ref:`Object<class_object>` node **)** |
|
| void | :ref:`add_root_node<class_EditorScript_add_root_node>` **(** :ref:`Node<class_node>` node **)** |
|
||||||
+------------------------------+-------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+---------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Object<class_object>` | :ref:`get_scene<class_EditorScript_get_scene>` **(** **)** |
|
| :ref:`EditorInterface<class_editorinterface>` | :ref:`get_editor_interface<class_EditorScript_get_editor_interface>` **(** **)** |
|
||||||
+------------------------------+-------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+---------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`Node<class_node>` | :ref:`get_scene<class_EditorScript_get_scene>` **(** **)** |
|
||||||
|
+------------------------------------------------+---------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Description
|
Description
|
||||||
-----------
|
-----------
|
||||||
@@ -40,10 +42,14 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_EditorScript_add_root_node:
|
.. _class_EditorScript_add_root_node:
|
||||||
|
|
||||||
- void **add_root_node** **(** :ref:`Object<class_object>` node **)**
|
- void **add_root_node** **(** :ref:`Node<class_node>` node **)**
|
||||||
|
|
||||||
|
.. _class_EditorScript_get_editor_interface:
|
||||||
|
|
||||||
|
- :ref:`EditorInterface<class_editorinterface>` **get_editor_interface** **(** **)**
|
||||||
|
|
||||||
.. _class_EditorScript_get_scene:
|
.. _class_EditorScript_get_scene:
|
||||||
|
|
||||||
- :ref:`Object<class_object>` **get_scene** **(** **)**
|
- :ref:`Node<class_node>` **get_scene** **(** **)**
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -94,7 +94,7 @@ Get the list of favorite directories for this project.
|
|||||||
|
|
||||||
- :ref:`String<class_string>` **get_project_settings_path** **(** **)** const
|
- :ref:`String<class_string>` **get_project_settings_path** **(** **)** const
|
||||||
|
|
||||||
Get the specific project settings path. Projects all have an unique sub-directory inside the settings path where project specific settings are saved.
|
Get the specific project settings path. Projects all have a unique sub-directory inside the settings path where project specific settings are saved.
|
||||||
|
|
||||||
.. _class_EditorSettings_get_recent_dirs:
|
.. _class_EditorSettings_get_recent_dirs:
|
||||||
|
|
||||||
|
|||||||
@@ -18,33 +18,33 @@ Custom gizmo for editing Spatial objects.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`add_collision_segments<class_EditorSpatialGizmo_add_collision_segments>` **(** :ref:`PoolVector3Array<class_poolvector3array>` segments **)** |
|
| void | :ref:`add_collision_segments<class_EditorSpatialGizmo_add_collision_segments>` **(** :ref:`PoolVector3Array<class_poolvector3array>` segments **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`add_collision_triangles<class_EditorSpatialGizmo_add_collision_triangles>` **(** :ref:`TriangleMesh<class_trianglemesh>` triangles **)** |
|
| void | :ref:`add_collision_triangles<class_EditorSpatialGizmo_add_collision_triangles>` **(** :ref:`TriangleMesh<class_trianglemesh>` triangles **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`add_handles<class_EditorSpatialGizmo_add_handles>` **(** :ref:`PoolVector3Array<class_poolvector3array>` handles, :ref:`bool<class_bool>` billboard=false, :ref:`bool<class_bool>` secondary=false **)** |
|
| void | :ref:`add_handles<class_EditorSpatialGizmo_add_handles>` **(** :ref:`PoolVector3Array<class_poolvector3array>` handles, :ref:`bool<class_bool>` billboard=false, :ref:`bool<class_bool>` secondary=null **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`add_lines<class_EditorSpatialGizmo_add_lines>` **(** :ref:`PoolVector3Array<class_poolvector3array>` lines, :ref:`Material<class_material>` material, :ref:`bool<class_bool>` billboard=false **)** |
|
| void | :ref:`add_lines<class_EditorSpatialGizmo_add_lines>` **(** :ref:`PoolVector3Array<class_poolvector3array>` lines, :ref:`Material<class_material>` material, :ref:`bool<class_bool>` billboard=null **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`add_mesh<class_EditorSpatialGizmo_add_mesh>` **(** :ref:`Mesh<class_mesh>` mesh, :ref:`bool<class_bool>` billboard=false, :ref:`RID<class_rid>` skeleton=[RID] **)** |
|
| void | :ref:`add_mesh<class_EditorSpatialGizmo_add_mesh>` **(** :ref:`ArrayMesh<class_arraymesh>` mesh, :ref:`bool<class_bool>` billboard=false, :ref:`RID<class_rid>` skeleton=null **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`add_unscaled_billboard<class_EditorSpatialGizmo_add_unscaled_billboard>` **(** :ref:`Material<class_material>` material, :ref:`float<class_float>` default_scale=1 **)** |
|
| void | :ref:`add_unscaled_billboard<class_EditorSpatialGizmo_add_unscaled_billboard>` **(** :ref:`Material<class_material>` material, :ref:`float<class_float>` default_scale=null **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`clear<class_EditorSpatialGizmo_clear>` **(** **)** |
|
| void | :ref:`clear<class_EditorSpatialGizmo_clear>` **(** **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`commit_handle<class_EditorSpatialGizmo_commit_handle>` **(** :ref:`int<class_int>` index, :ref:`Variant<class_variant>` restore, :ref:`bool<class_bool>` cancel **)** virtual |
|
| void | :ref:`commit_handle<class_EditorSpatialGizmo_commit_handle>` **(** :ref:`int<class_int>` index, :ref:`Variant<class_variant>` restore, :ref:`bool<class_bool>` cancel=false **)** virtual |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`get_handle_name<class_EditorSpatialGizmo_get_handle_name>` **(** :ref:`int<class_int>` index **)** virtual |
|
| :ref:`String<class_string>` | :ref:`get_handle_name<class_EditorSpatialGizmo_get_handle_name>` **(** :ref:`int<class_int>` index **)** virtual |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Variant<class_variant>` | :ref:`get_handle_value<class_EditorSpatialGizmo_get_handle_value>` **(** :ref:`int<class_int>` index **)** virtual |
|
| :ref:`Variant<class_variant>` | :ref:`get_handle_value<class_EditorSpatialGizmo_get_handle_value>` **(** :ref:`int<class_int>` index **)** virtual |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`redraw<class_EditorSpatialGizmo_redraw>` **(** **)** virtual |
|
| void | :ref:`redraw<class_EditorSpatialGizmo_redraw>` **(** **)** virtual |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_handle<class_EditorSpatialGizmo_set_handle>` **(** :ref:`int<class_int>` index, :ref:`Camera<class_camera>` camera, :ref:`Vector2<class_vector2>` point **)** virtual |
|
| void | :ref:`set_handle<class_EditorSpatialGizmo_set_handle>` **(** :ref:`int<class_int>` index, :ref:`Camera<class_camera>` camera, :ref:`Vector2<class_vector2>` point **)** virtual |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_spatial_node<class_EditorSpatialGizmo_set_spatial_node>` **(** :ref:`Spatial<class_spatial>` node **)** |
|
| void | :ref:`set_spatial_node<class_EditorSpatialGizmo_set_spatial_node>` **(** :ref:`Node<class_node>` node **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Description
|
Description
|
||||||
-----------
|
-----------
|
||||||
@@ -66,7 +66,7 @@ Add collision triangles to the gizmo for picking. A :ref:`TriangleMesh<class_tri
|
|||||||
|
|
||||||
.. _class_EditorSpatialGizmo_add_handles:
|
.. _class_EditorSpatialGizmo_add_handles:
|
||||||
|
|
||||||
- void **add_handles** **(** :ref:`PoolVector3Array<class_poolvector3array>` handles, :ref:`bool<class_bool>` billboard=false, :ref:`bool<class_bool>` secondary=false **)**
|
- void **add_handles** **(** :ref:`PoolVector3Array<class_poolvector3array>` handles, :ref:`bool<class_bool>` billboard=false, :ref:`bool<class_bool>` secondary=null **)**
|
||||||
|
|
||||||
Add a list of handles (points) which can be used to deform the object being edited.
|
Add a list of handles (points) which can be used to deform the object being edited.
|
||||||
|
|
||||||
@@ -74,19 +74,17 @@ There are virtual functions which will be called upon editing of these handles.
|
|||||||
|
|
||||||
.. _class_EditorSpatialGizmo_add_lines:
|
.. _class_EditorSpatialGizmo_add_lines:
|
||||||
|
|
||||||
- void **add_lines** **(** :ref:`PoolVector3Array<class_poolvector3array>` lines, :ref:`Material<class_material>` material, :ref:`bool<class_bool>` billboard=false **)**
|
- void **add_lines** **(** :ref:`PoolVector3Array<class_poolvector3array>` lines, :ref:`Material<class_material>` material, :ref:`bool<class_bool>` billboard=null **)**
|
||||||
|
|
||||||
Add lines to the gizmo (as sets of 2 points), with a given material. The lines are used for visualizing the gizmo. Call this function during :ref:`redraw<class_EditorSpatialGizmo_redraw>`.
|
Add lines to the gizmo (as sets of 2 points), with a given material. The lines are used for visualizing the gizmo. Call this function during :ref:`redraw<class_EditorSpatialGizmo_redraw>`.
|
||||||
|
|
||||||
.. _class_EditorSpatialGizmo_add_mesh:
|
.. _class_EditorSpatialGizmo_add_mesh:
|
||||||
|
|
||||||
- void **add_mesh** **(** :ref:`Mesh<class_mesh>` mesh, :ref:`bool<class_bool>` billboard=false, :ref:`RID<class_rid>` skeleton=[RID] **)**
|
- void **add_mesh** **(** :ref:`ArrayMesh<class_arraymesh>` mesh, :ref:`bool<class_bool>` billboard=false, :ref:`RID<class_rid>` skeleton=null **)**
|
||||||
|
|
||||||
Add a mesh to the gizmo, this is used for visualization. Call this function during :ref:`redraw<class_EditorSpatialGizmo_redraw>`.
|
|
||||||
|
|
||||||
.. _class_EditorSpatialGizmo_add_unscaled_billboard:
|
.. _class_EditorSpatialGizmo_add_unscaled_billboard:
|
||||||
|
|
||||||
- void **add_unscaled_billboard** **(** :ref:`Material<class_material>` material, :ref:`float<class_float>` default_scale=1 **)**
|
- void **add_unscaled_billboard** **(** :ref:`Material<class_material>` material, :ref:`float<class_float>` default_scale=null **)**
|
||||||
|
|
||||||
Add an unscaled billboard for visualization. Call this function during :ref:`redraw<class_EditorSpatialGizmo_redraw>`.
|
Add an unscaled billboard for visualization. Call this function during :ref:`redraw<class_EditorSpatialGizmo_redraw>`.
|
||||||
|
|
||||||
@@ -96,7 +94,7 @@ Add an unscaled billboard for visualization. Call this function during :ref:`red
|
|||||||
|
|
||||||
.. _class_EditorSpatialGizmo_commit_handle:
|
.. _class_EditorSpatialGizmo_commit_handle:
|
||||||
|
|
||||||
- void **commit_handle** **(** :ref:`int<class_int>` index, :ref:`Variant<class_variant>` restore, :ref:`bool<class_bool>` cancel **)** virtual
|
- void **commit_handle** **(** :ref:`int<class_int>` index, :ref:`Variant<class_variant>` restore, :ref:`bool<class_bool>` cancel=false **)** virtual
|
||||||
|
|
||||||
Commit a handle being edited (handles must have been prevously added by :ref:`add_handles<class_EditorSpatialGizmo_add_handles>`).
|
Commit a handle being edited (handles must have been prevously added by :ref:`add_handles<class_EditorSpatialGizmo_add_handles>`).
|
||||||
|
|
||||||
@@ -132,8 +130,6 @@ The :ref:`Camera<class_camera>` is also provided so screen coordinates can be co
|
|||||||
|
|
||||||
.. _class_EditorSpatialGizmo_set_spatial_node:
|
.. _class_EditorSpatialGizmo_set_spatial_node:
|
||||||
|
|
||||||
- void **set_spatial_node** **(** :ref:`Spatial<class_spatial>` node **)**
|
- void **set_spatial_node** **(** :ref:`Node<class_node>` node **)**
|
||||||
|
|
||||||
Call this function once and upon creation of the gizmo, otherwise no other function will work. The argument is the node being edited by the gizmo.
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
38
classes/class_encodedobjectasid.rst
Normal file
38
classes/class_encodedobjectasid.rst
Normal file
@@ -0,0 +1,38 @@
|
|||||||
|
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
||||||
|
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
|
||||||
|
|
||||||
|
.. _class_EncodedObjectAsID:
|
||||||
|
|
||||||
|
EncodedObjectAsID
|
||||||
|
=================
|
||||||
|
|
||||||
|
**Inherits:** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||||
|
|
||||||
|
**Category:** Core
|
||||||
|
|
||||||
|
Brief Description
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Member Functions
|
||||||
|
----------------
|
||||||
|
|
||||||
|
+------------------------+----------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`int<class_int>` | :ref:`get_object_id<class_EncodedObjectAsID_get_object_id>` **(** **)** const |
|
||||||
|
+------------------------+----------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`set_object_id<class_EncodedObjectAsID_set_object_id>` **(** :ref:`int<class_int>` id **)** |
|
||||||
|
+------------------------+----------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
|
Member Function Description
|
||||||
|
---------------------------
|
||||||
|
|
||||||
|
.. _class_EncodedObjectAsID_get_object_id:
|
||||||
|
|
||||||
|
- :ref:`int<class_int>` **get_object_id** **(** **)** const
|
||||||
|
|
||||||
|
.. _class_EncodedObjectAsID_set_object_id:
|
||||||
|
|
||||||
|
- void **set_object_id** **(** :ref:`int<class_int>` id **)**
|
||||||
|
|
||||||
|
|
||||||
@@ -18,8 +18,6 @@ Brief Description
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`String<class_string>` | :ref:`get_custom_level<class_Engine_get_custom_level>` **(** **)** const |
|
|
||||||
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_frames_drawn<class_Engine_get_frames_drawn>` **(** **)** |
|
| :ref:`int<class_int>` | :ref:`get_frames_drawn<class_Engine_get_frames_drawn>` **(** **)** |
|
||||||
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -35,8 +33,12 @@ Member Functions
|
|||||||
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Dictionary<class_dictionary>` | :ref:`get_version_info<class_Engine_get_version_info>` **(** **)** const |
|
| :ref:`Dictionary<class_dictionary>` | :ref:`get_version_info<class_Engine_get_version_info>` **(** **)** const |
|
||||||
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`bool<class_bool>` | :ref:`is_editor_hint<class_Engine_is_editor_hint>` **(** **)** const |
|
||||||
|
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_in_fixed_frame<class_Engine_is_in_fixed_frame>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_in_fixed_frame<class_Engine_is_in_fixed_frame>` **(** **)** const |
|
||||||
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`set_editor_hint<class_Engine_set_editor_hint>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||||
|
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_iterations_per_second<class_Engine_set_iterations_per_second>` **(** :ref:`int<class_int>` iterations_per_second **)** |
|
| void | :ref:`set_iterations_per_second<class_Engine_set_iterations_per_second>` **(** :ref:`int<class_int>` iterations_per_second **)** |
|
||||||
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_target_fps<class_Engine_set_target_fps>` **(** :ref:`int<class_int>` target_fps **)** |
|
| void | :ref:`set_target_fps<class_Engine_set_target_fps>` **(** :ref:`int<class_int>` target_fps **)** |
|
||||||
@@ -47,12 +49,6 @@ Member Functions
|
|||||||
Member Function Description
|
Member Function Description
|
||||||
---------------------------
|
---------------------------
|
||||||
|
|
||||||
.. _class_Engine_get_custom_level:
|
|
||||||
|
|
||||||
- :ref:`String<class_string>` **get_custom_level** **(** **)** const
|
|
||||||
|
|
||||||
Returns the value of the commandline argument "-level".
|
|
||||||
|
|
||||||
.. _class_Engine_get_frames_drawn:
|
.. _class_Engine_get_frames_drawn:
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_frames_drawn** **(** **)**
|
- :ref:`int<class_int>` **get_frames_drawn** **(** **)**
|
||||||
@@ -105,10 +101,18 @@ Returns the current engine version information in a Dictionary.
|
|||||||
|
|
||||||
"string" - major + minor + patch + status + revision in a single String
|
"string" - major + minor + patch + status + revision in a single String
|
||||||
|
|
||||||
|
.. _class_Engine_is_editor_hint:
|
||||||
|
|
||||||
|
- :ref:`bool<class_bool>` **is_editor_hint** **(** **)** const
|
||||||
|
|
||||||
.. _class_Engine_is_in_fixed_frame:
|
.. _class_Engine_is_in_fixed_frame:
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_in_fixed_frame** **(** **)** const
|
- :ref:`bool<class_bool>` **is_in_fixed_frame** **(** **)** const
|
||||||
|
|
||||||
|
.. _class_Engine_set_editor_hint:
|
||||||
|
|
||||||
|
- void **set_editor_hint** **(** :ref:`bool<class_bool>` enabled **)**
|
||||||
|
|
||||||
.. _class_Engine_set_iterations_per_second:
|
.. _class_Engine_set_iterations_per_second:
|
||||||
|
|
||||||
- void **set_iterations_per_second** **(** :ref:`int<class_int>` iterations_per_second **)**
|
- void **set_iterations_per_second** **(** :ref:`int<class_int>` iterations_per_second **)**
|
||||||
|
|||||||
@@ -18,283 +18,283 @@ Brief Description
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_adjustment_brightness<class_Environment_get_adjustment_brightness>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_adjustment_brightness<class_Environment_get_adjustment_brightness>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Object<class_object>` | :ref:`get_adjustment_color_correction<class_Environment_get_adjustment_color_correction>` **(** **)** const |
|
| :ref:`Texture<class_texture>` | :ref:`get_adjustment_color_correction<class_Environment_get_adjustment_color_correction>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_adjustment_contrast<class_Environment_get_adjustment_contrast>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_adjustment_contrast<class_Environment_get_adjustment_contrast>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_adjustment_saturation<class_Environment_get_adjustment_saturation>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_adjustment_saturation<class_Environment_get_adjustment_saturation>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Color<class_color>` | :ref:`get_ambient_light_color<class_Environment_get_ambient_light_color>` **(** **)** const |
|
| :ref:`Color<class_color>` | :ref:`get_ambient_light_color<class_Environment_get_ambient_light_color>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_ambient_light_energy<class_Environment_get_ambient_light_energy>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_ambient_light_energy<class_Environment_get_ambient_light_energy>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_ambient_light_sky_contribution<class_Environment_get_ambient_light_sky_contribution>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_ambient_light_sky_contribution<class_Environment_get_ambient_light_sky_contribution>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_background<class_Environment_get_background>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_background<class_Environment_get_background>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Color<class_color>` | :ref:`get_bg_color<class_Environment_get_bg_color>` **(** **)** const |
|
| :ref:`Color<class_color>` | :ref:`get_bg_color<class_Environment_get_bg_color>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_bg_energy<class_Environment_get_bg_energy>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_bg_energy<class_Environment_get_bg_energy>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_canvas_max_layer<class_Environment_get_canvas_max_layer>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_canvas_max_layer<class_Environment_get_canvas_max_layer>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_dof_blur_far_amount<class_Environment_get_dof_blur_far_amount>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_dof_blur_far_amount<class_Environment_get_dof_blur_far_amount>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_dof_blur_far_distance<class_Environment_get_dof_blur_far_distance>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_dof_blur_far_distance<class_Environment_get_dof_blur_far_distance>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_dof_blur_far_quality<class_Environment_get_dof_blur_far_quality>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_dof_blur_far_quality<class_Environment_get_dof_blur_far_quality>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_dof_blur_far_transition<class_Environment_get_dof_blur_far_transition>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_dof_blur_far_transition<class_Environment_get_dof_blur_far_transition>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_dof_blur_near_amount<class_Environment_get_dof_blur_near_amount>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_dof_blur_near_amount<class_Environment_get_dof_blur_near_amount>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_dof_blur_near_distance<class_Environment_get_dof_blur_near_distance>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_dof_blur_near_distance<class_Environment_get_dof_blur_near_distance>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_dof_blur_near_quality<class_Environment_get_dof_blur_near_quality>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_dof_blur_near_quality<class_Environment_get_dof_blur_near_quality>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_dof_blur_near_transition<class_Environment_get_dof_blur_near_transition>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_dof_blur_near_transition<class_Environment_get_dof_blur_near_transition>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Color<class_color>` | :ref:`get_fog_color<class_Environment_get_fog_color>` **(** **)** const |
|
| :ref:`Color<class_color>` | :ref:`get_fog_color<class_Environment_get_fog_color>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_fog_depth_begin<class_Environment_get_fog_depth_begin>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_fog_depth_begin<class_Environment_get_fog_depth_begin>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_fog_depth_curve<class_Environment_get_fog_depth_curve>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_fog_depth_curve<class_Environment_get_fog_depth_curve>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_fog_height_curve<class_Environment_get_fog_height_curve>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_fog_height_curve<class_Environment_get_fog_height_curve>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_fog_height_max<class_Environment_get_fog_height_max>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_fog_height_max<class_Environment_get_fog_height_max>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_fog_height_min<class_Environment_get_fog_height_min>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_fog_height_min<class_Environment_get_fog_height_min>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_fog_sun_amount<class_Environment_get_fog_sun_amount>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_fog_sun_amount<class_Environment_get_fog_sun_amount>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Color<class_color>` | :ref:`get_fog_sun_color<class_Environment_get_fog_sun_color>` **(** **)** const |
|
| :ref:`Color<class_color>` | :ref:`get_fog_sun_color<class_Environment_get_fog_sun_color>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_fog_transmit_curve<class_Environment_get_fog_transmit_curve>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_fog_transmit_curve<class_Environment_get_fog_transmit_curve>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_glow_blend_mode<class_Environment_get_glow_blend_mode>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_glow_blend_mode<class_Environment_get_glow_blend_mode>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_glow_bloom<class_Environment_get_glow_bloom>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_glow_bloom<class_Environment_get_glow_bloom>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_glow_hdr_bleed_scale<class_Environment_get_glow_hdr_bleed_scale>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_glow_hdr_bleed_scale<class_Environment_get_glow_hdr_bleed_scale>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_glow_hdr_bleed_threshold<class_Environment_get_glow_hdr_bleed_threshold>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_glow_hdr_bleed_threshold<class_Environment_get_glow_hdr_bleed_threshold>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_glow_intensity<class_Environment_get_glow_intensity>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_glow_intensity<class_Environment_get_glow_intensity>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_glow_strength<class_Environment_get_glow_strength>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_glow_strength<class_Environment_get_glow_strength>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`CubeMap<class_cubemap>` | :ref:`get_sky<class_Environment_get_sky>` **(** **)** const |
|
| :ref:`Sky<class_sky>` | :ref:`get_sky<class_Environment_get_sky>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_sky_scale<class_Environment_get_sky_scale>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_sky_scale<class_Environment_get_sky_scale>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_ssao_bias<class_Environment_get_ssao_bias>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_ssao_bias<class_Environment_get_ssao_bias>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Color<class_color>` | :ref:`get_ssao_color<class_Environment_get_ssao_color>` **(** **)** const |
|
| :ref:`Color<class_color>` | :ref:`get_ssao_color<class_Environment_get_ssao_color>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_ssao_direct_light_affect<class_Environment_get_ssao_direct_light_affect>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_ssao_direct_light_affect<class_Environment_get_ssao_direct_light_affect>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_ssao_intensity<class_Environment_get_ssao_intensity>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_ssao_intensity<class_Environment_get_ssao_intensity>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_ssao_intensity2<class_Environment_get_ssao_intensity2>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_ssao_intensity2<class_Environment_get_ssao_intensity2>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_ssao_radius<class_Environment_get_ssao_radius>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_ssao_radius<class_Environment_get_ssao_radius>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_ssao_radius2<class_Environment_get_ssao_radius2>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_ssao_radius2<class_Environment_get_ssao_radius2>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_ssr_depth_tolerance<class_Environment_get_ssr_depth_tolerance>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_ssr_depth_tolerance<class_Environment_get_ssr_depth_tolerance>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_ssr_fade_in<class_Environment_get_ssr_fade_in>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_ssr_fade_in<class_Environment_get_ssr_fade_in>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_ssr_fade_out<class_Environment_get_ssr_fade_out>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_ssr_fade_out<class_Environment_get_ssr_fade_out>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_ssr_max_steps<class_Environment_get_ssr_max_steps>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_ssr_max_steps<class_Environment_get_ssr_max_steps>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`get_tonemap_auto_exposure<class_Environment_get_tonemap_auto_exposure>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`get_tonemap_auto_exposure<class_Environment_get_tonemap_auto_exposure>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_tonemap_auto_exposure_grey<class_Environment_get_tonemap_auto_exposure_grey>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_tonemap_auto_exposure_grey<class_Environment_get_tonemap_auto_exposure_grey>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_tonemap_auto_exposure_max<class_Environment_get_tonemap_auto_exposure_max>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_tonemap_auto_exposure_max<class_Environment_get_tonemap_auto_exposure_max>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_tonemap_auto_exposure_min<class_Environment_get_tonemap_auto_exposure_min>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_tonemap_auto_exposure_min<class_Environment_get_tonemap_auto_exposure_min>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_tonemap_auto_exposure_speed<class_Environment_get_tonemap_auto_exposure_speed>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_tonemap_auto_exposure_speed<class_Environment_get_tonemap_auto_exposure_speed>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_tonemap_exposure<class_Environment_get_tonemap_exposure>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_tonemap_exposure<class_Environment_get_tonemap_exposure>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_tonemap_white<class_Environment_get_tonemap_white>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_tonemap_white<class_Environment_get_tonemap_white>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_tonemapper<class_Environment_get_tonemapper>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_tonemapper<class_Environment_get_tonemapper>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_adjustment_enabled<class_Environment_is_adjustment_enabled>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_adjustment_enabled<class_Environment_is_adjustment_enabled>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_dof_blur_far_enabled<class_Environment_is_dof_blur_far_enabled>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_dof_blur_far_enabled<class_Environment_is_dof_blur_far_enabled>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_dof_blur_near_enabled<class_Environment_is_dof_blur_near_enabled>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_dof_blur_near_enabled<class_Environment_is_dof_blur_near_enabled>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_fog_depth_enabled<class_Environment_is_fog_depth_enabled>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_fog_depth_enabled<class_Environment_is_fog_depth_enabled>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_fog_enabled<class_Environment_is_fog_enabled>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_fog_enabled<class_Environment_is_fog_enabled>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_fog_height_enabled<class_Environment_is_fog_height_enabled>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_fog_height_enabled<class_Environment_is_fog_height_enabled>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_fog_transmit_enabled<class_Environment_is_fog_transmit_enabled>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_fog_transmit_enabled<class_Environment_is_fog_transmit_enabled>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_glow_bicubic_upscale_enabled<class_Environment_is_glow_bicubic_upscale_enabled>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_glow_bicubic_upscale_enabled<class_Environment_is_glow_bicubic_upscale_enabled>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_glow_enabled<class_Environment_is_glow_enabled>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_glow_enabled<class_Environment_is_glow_enabled>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_glow_level_enabled<class_Environment_is_glow_level_enabled>` **(** :ref:`int<class_int>` idx **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_glow_level_enabled<class_Environment_is_glow_level_enabled>` **(** :ref:`int<class_int>` idx **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_ssao_blur_enabled<class_Environment_is_ssao_blur_enabled>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_ssao_blur_enabled<class_Environment_is_ssao_blur_enabled>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_ssao_enabled<class_Environment_is_ssao_enabled>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_ssao_enabled<class_Environment_is_ssao_enabled>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_ssr_enabled<class_Environment_is_ssr_enabled>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_ssr_enabled<class_Environment_is_ssr_enabled>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_ssr_rough<class_Environment_is_ssr_rough>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_ssr_rough<class_Environment_is_ssr_rough>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_adjustment_brightness<class_Environment_set_adjustment_brightness>` **(** :ref:`float<class_float>` brightness **)** |
|
| void | :ref:`set_adjustment_brightness<class_Environment_set_adjustment_brightness>` **(** :ref:`float<class_float>` brightness **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_adjustment_color_correction<class_Environment_set_adjustment_color_correction>` **(** :ref:`Object<class_object>` color_correction **)** |
|
| void | :ref:`set_adjustment_color_correction<class_Environment_set_adjustment_color_correction>` **(** :ref:`Texture<class_texture>` color_correction **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_adjustment_contrast<class_Environment_set_adjustment_contrast>` **(** :ref:`float<class_float>` contrast **)** |
|
| void | :ref:`set_adjustment_contrast<class_Environment_set_adjustment_contrast>` **(** :ref:`float<class_float>` contrast **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_adjustment_enable<class_Environment_set_adjustment_enable>` **(** :ref:`bool<class_bool>` enabled **)** |
|
| void | :ref:`set_adjustment_enable<class_Environment_set_adjustment_enable>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_adjustment_saturation<class_Environment_set_adjustment_saturation>` **(** :ref:`float<class_float>` saturation **)** |
|
| void | :ref:`set_adjustment_saturation<class_Environment_set_adjustment_saturation>` **(** :ref:`float<class_float>` saturation **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_ambient_light_color<class_Environment_set_ambient_light_color>` **(** :ref:`Color<class_color>` color **)** |
|
| void | :ref:`set_ambient_light_color<class_Environment_set_ambient_light_color>` **(** :ref:`Color<class_color>` color **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_ambient_light_energy<class_Environment_set_ambient_light_energy>` **(** :ref:`float<class_float>` energy **)** |
|
| void | :ref:`set_ambient_light_energy<class_Environment_set_ambient_light_energy>` **(** :ref:`float<class_float>` energy **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_ambient_light_sky_contribution<class_Environment_set_ambient_light_sky_contribution>` **(** :ref:`float<class_float>` energy **)** |
|
| void | :ref:`set_ambient_light_sky_contribution<class_Environment_set_ambient_light_sky_contribution>` **(** :ref:`float<class_float>` energy **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_background<class_Environment_set_background>` **(** :ref:`int<class_int>` mode **)** |
|
| void | :ref:`set_background<class_Environment_set_background>` **(** :ref:`int<class_int>` mode **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_bg_color<class_Environment_set_bg_color>` **(** :ref:`Color<class_color>` color **)** |
|
| void | :ref:`set_bg_color<class_Environment_set_bg_color>` **(** :ref:`Color<class_color>` color **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_bg_energy<class_Environment_set_bg_energy>` **(** :ref:`float<class_float>` energy **)** |
|
| void | :ref:`set_bg_energy<class_Environment_set_bg_energy>` **(** :ref:`float<class_float>` energy **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_canvas_max_layer<class_Environment_set_canvas_max_layer>` **(** :ref:`int<class_int>` layer **)** |
|
| void | :ref:`set_canvas_max_layer<class_Environment_set_canvas_max_layer>` **(** :ref:`int<class_int>` layer **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_dof_blur_far_amount<class_Environment_set_dof_blur_far_amount>` **(** :ref:`float<class_float>` intensity **)** |
|
| void | :ref:`set_dof_blur_far_amount<class_Environment_set_dof_blur_far_amount>` **(** :ref:`float<class_float>` intensity **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_dof_blur_far_distance<class_Environment_set_dof_blur_far_distance>` **(** :ref:`float<class_float>` intensity **)** |
|
| void | :ref:`set_dof_blur_far_distance<class_Environment_set_dof_blur_far_distance>` **(** :ref:`float<class_float>` intensity **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_dof_blur_far_enabled<class_Environment_set_dof_blur_far_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
| void | :ref:`set_dof_blur_far_enabled<class_Environment_set_dof_blur_far_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_dof_blur_far_quality<class_Environment_set_dof_blur_far_quality>` **(** :ref:`int<class_int>` intensity **)** |
|
| void | :ref:`set_dof_blur_far_quality<class_Environment_set_dof_blur_far_quality>` **(** :ref:`int<class_int>` intensity **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_dof_blur_far_transition<class_Environment_set_dof_blur_far_transition>` **(** :ref:`float<class_float>` intensity **)** |
|
| void | :ref:`set_dof_blur_far_transition<class_Environment_set_dof_blur_far_transition>` **(** :ref:`float<class_float>` intensity **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_dof_blur_near_amount<class_Environment_set_dof_blur_near_amount>` **(** :ref:`float<class_float>` intensity **)** |
|
| void | :ref:`set_dof_blur_near_amount<class_Environment_set_dof_blur_near_amount>` **(** :ref:`float<class_float>` intensity **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_dof_blur_near_distance<class_Environment_set_dof_blur_near_distance>` **(** :ref:`float<class_float>` intensity **)** |
|
| void | :ref:`set_dof_blur_near_distance<class_Environment_set_dof_blur_near_distance>` **(** :ref:`float<class_float>` intensity **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_dof_blur_near_enabled<class_Environment_set_dof_blur_near_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
| void | :ref:`set_dof_blur_near_enabled<class_Environment_set_dof_blur_near_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_dof_blur_near_quality<class_Environment_set_dof_blur_near_quality>` **(** :ref:`int<class_int>` level **)** |
|
| void | :ref:`set_dof_blur_near_quality<class_Environment_set_dof_blur_near_quality>` **(** :ref:`int<class_int>` level **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_dof_blur_near_transition<class_Environment_set_dof_blur_near_transition>` **(** :ref:`float<class_float>` intensity **)** |
|
| void | :ref:`set_dof_blur_near_transition<class_Environment_set_dof_blur_near_transition>` **(** :ref:`float<class_float>` intensity **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_fog_color<class_Environment_set_fog_color>` **(** :ref:`Color<class_color>` color **)** |
|
| void | :ref:`set_fog_color<class_Environment_set_fog_color>` **(** :ref:`Color<class_color>` color **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_fog_depth_begin<class_Environment_set_fog_depth_begin>` **(** :ref:`float<class_float>` distance **)** |
|
| void | :ref:`set_fog_depth_begin<class_Environment_set_fog_depth_begin>` **(** :ref:`float<class_float>` distance **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_fog_depth_curve<class_Environment_set_fog_depth_curve>` **(** :ref:`float<class_float>` curve **)** |
|
| void | :ref:`set_fog_depth_curve<class_Environment_set_fog_depth_curve>` **(** :ref:`float<class_float>` curve **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_fog_depth_enabled<class_Environment_set_fog_depth_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
| void | :ref:`set_fog_depth_enabled<class_Environment_set_fog_depth_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_fog_enabled<class_Environment_set_fog_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
| void | :ref:`set_fog_enabled<class_Environment_set_fog_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_fog_height_curve<class_Environment_set_fog_height_curve>` **(** :ref:`float<class_float>` curve **)** |
|
| void | :ref:`set_fog_height_curve<class_Environment_set_fog_height_curve>` **(** :ref:`float<class_float>` curve **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_fog_height_enabled<class_Environment_set_fog_height_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
| void | :ref:`set_fog_height_enabled<class_Environment_set_fog_height_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_fog_height_max<class_Environment_set_fog_height_max>` **(** :ref:`float<class_float>` height **)** |
|
| void | :ref:`set_fog_height_max<class_Environment_set_fog_height_max>` **(** :ref:`float<class_float>` height **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_fog_height_min<class_Environment_set_fog_height_min>` **(** :ref:`float<class_float>` height **)** |
|
| void | :ref:`set_fog_height_min<class_Environment_set_fog_height_min>` **(** :ref:`float<class_float>` height **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_fog_sun_amount<class_Environment_set_fog_sun_amount>` **(** :ref:`float<class_float>` amount **)** |
|
| void | :ref:`set_fog_sun_amount<class_Environment_set_fog_sun_amount>` **(** :ref:`float<class_float>` amount **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_fog_sun_color<class_Environment_set_fog_sun_color>` **(** :ref:`Color<class_color>` color **)** |
|
| void | :ref:`set_fog_sun_color<class_Environment_set_fog_sun_color>` **(** :ref:`Color<class_color>` color **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_fog_transmit_curve<class_Environment_set_fog_transmit_curve>` **(** :ref:`float<class_float>` curve **)** |
|
| void | :ref:`set_fog_transmit_curve<class_Environment_set_fog_transmit_curve>` **(** :ref:`float<class_float>` curve **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_fog_transmit_enabled<class_Environment_set_fog_transmit_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
| void | :ref:`set_fog_transmit_enabled<class_Environment_set_fog_transmit_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_glow_bicubic_upscale<class_Environment_set_glow_bicubic_upscale>` **(** :ref:`bool<class_bool>` enabled **)** |
|
| void | :ref:`set_glow_bicubic_upscale<class_Environment_set_glow_bicubic_upscale>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_glow_blend_mode<class_Environment_set_glow_blend_mode>` **(** :ref:`int<class_int>` mode **)** |
|
| void | :ref:`set_glow_blend_mode<class_Environment_set_glow_blend_mode>` **(** :ref:`int<class_int>` mode **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_glow_bloom<class_Environment_set_glow_bloom>` **(** :ref:`float<class_float>` amount **)** |
|
| void | :ref:`set_glow_bloom<class_Environment_set_glow_bloom>` **(** :ref:`float<class_float>` amount **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_glow_enabled<class_Environment_set_glow_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
| void | :ref:`set_glow_enabled<class_Environment_set_glow_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_glow_hdr_bleed_scale<class_Environment_set_glow_hdr_bleed_scale>` **(** :ref:`float<class_float>` scale **)** |
|
| void | :ref:`set_glow_hdr_bleed_scale<class_Environment_set_glow_hdr_bleed_scale>` **(** :ref:`float<class_float>` scale **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_glow_hdr_bleed_threshold<class_Environment_set_glow_hdr_bleed_threshold>` **(** :ref:`float<class_float>` threshold **)** |
|
| void | :ref:`set_glow_hdr_bleed_threshold<class_Environment_set_glow_hdr_bleed_threshold>` **(** :ref:`float<class_float>` threshold **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_glow_intensity<class_Environment_set_glow_intensity>` **(** :ref:`float<class_float>` intensity **)** |
|
| void | :ref:`set_glow_intensity<class_Environment_set_glow_intensity>` **(** :ref:`float<class_float>` intensity **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_glow_level<class_Environment_set_glow_level>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enabled **)** |
|
| void | :ref:`set_glow_level<class_Environment_set_glow_level>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enabled **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_glow_strength<class_Environment_set_glow_strength>` **(** :ref:`float<class_float>` strength **)** |
|
| void | :ref:`set_glow_strength<class_Environment_set_glow_strength>` **(** :ref:`float<class_float>` strength **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_sky<class_Environment_set_sky>` **(** :ref:`Sky<class_sky>` sky **)** |
|
| void | :ref:`set_sky<class_Environment_set_sky>` **(** :ref:`Sky<class_sky>` sky **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_sky_scale<class_Environment_set_sky_scale>` **(** :ref:`float<class_float>` scale **)** |
|
| void | :ref:`set_sky_scale<class_Environment_set_sky_scale>` **(** :ref:`float<class_float>` scale **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_ssao_bias<class_Environment_set_ssao_bias>` **(** :ref:`float<class_float>` bias **)** |
|
| void | :ref:`set_ssao_bias<class_Environment_set_ssao_bias>` **(** :ref:`float<class_float>` bias **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_ssao_blur<class_Environment_set_ssao_blur>` **(** :ref:`bool<class_bool>` enabled **)** |
|
| void | :ref:`set_ssao_blur<class_Environment_set_ssao_blur>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_ssao_color<class_Environment_set_ssao_color>` **(** :ref:`Color<class_color>` color **)** |
|
| void | :ref:`set_ssao_color<class_Environment_set_ssao_color>` **(** :ref:`Color<class_color>` color **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_ssao_direct_light_affect<class_Environment_set_ssao_direct_light_affect>` **(** :ref:`float<class_float>` amount **)** |
|
| void | :ref:`set_ssao_direct_light_affect<class_Environment_set_ssao_direct_light_affect>` **(** :ref:`float<class_float>` amount **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_ssao_enabled<class_Environment_set_ssao_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
| void | :ref:`set_ssao_enabled<class_Environment_set_ssao_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_ssao_intensity<class_Environment_set_ssao_intensity>` **(** :ref:`float<class_float>` intensity **)** |
|
| void | :ref:`set_ssao_intensity<class_Environment_set_ssao_intensity>` **(** :ref:`float<class_float>` intensity **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_ssao_intensity2<class_Environment_set_ssao_intensity2>` **(** :ref:`float<class_float>` intensity **)** |
|
| void | :ref:`set_ssao_intensity2<class_Environment_set_ssao_intensity2>` **(** :ref:`float<class_float>` intensity **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_ssao_radius<class_Environment_set_ssao_radius>` **(** :ref:`float<class_float>` radius **)** |
|
| void | :ref:`set_ssao_radius<class_Environment_set_ssao_radius>` **(** :ref:`float<class_float>` radius **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_ssao_radius2<class_Environment_set_ssao_radius2>` **(** :ref:`float<class_float>` radius **)** |
|
| void | :ref:`set_ssao_radius2<class_Environment_set_ssao_radius2>` **(** :ref:`float<class_float>` radius **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_ssr_depth_tolerance<class_Environment_set_ssr_depth_tolerance>` **(** :ref:`float<class_float>` depth_tolerance **)** |
|
| void | :ref:`set_ssr_depth_tolerance<class_Environment_set_ssr_depth_tolerance>` **(** :ref:`float<class_float>` depth_tolerance **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_ssr_enabled<class_Environment_set_ssr_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
| void | :ref:`set_ssr_enabled<class_Environment_set_ssr_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_ssr_fade_in<class_Environment_set_ssr_fade_in>` **(** :ref:`float<class_float>` fade_in **)** |
|
| void | :ref:`set_ssr_fade_in<class_Environment_set_ssr_fade_in>` **(** :ref:`float<class_float>` fade_in **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_ssr_fade_out<class_Environment_set_ssr_fade_out>` **(** :ref:`float<class_float>` fade_out **)** |
|
| void | :ref:`set_ssr_fade_out<class_Environment_set_ssr_fade_out>` **(** :ref:`float<class_float>` fade_out **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_ssr_max_steps<class_Environment_set_ssr_max_steps>` **(** :ref:`int<class_int>` max_steps **)** |
|
| void | :ref:`set_ssr_max_steps<class_Environment_set_ssr_max_steps>` **(** :ref:`int<class_int>` max_steps **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_ssr_rough<class_Environment_set_ssr_rough>` **(** :ref:`bool<class_bool>` rough **)** |
|
| void | :ref:`set_ssr_rough<class_Environment_set_ssr_rough>` **(** :ref:`bool<class_bool>` rough **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_tonemap_auto_exposure<class_Environment_set_tonemap_auto_exposure>` **(** :ref:`bool<class_bool>` auto_exposure **)** |
|
| void | :ref:`set_tonemap_auto_exposure<class_Environment_set_tonemap_auto_exposure>` **(** :ref:`bool<class_bool>` auto_exposure **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_tonemap_auto_exposure_grey<class_Environment_set_tonemap_auto_exposure_grey>` **(** :ref:`float<class_float>` exposure_grey **)** |
|
| void | :ref:`set_tonemap_auto_exposure_grey<class_Environment_set_tonemap_auto_exposure_grey>` **(** :ref:`float<class_float>` exposure_grey **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_tonemap_auto_exposure_max<class_Environment_set_tonemap_auto_exposure_max>` **(** :ref:`float<class_float>` exposure_max **)** |
|
| void | :ref:`set_tonemap_auto_exposure_max<class_Environment_set_tonemap_auto_exposure_max>` **(** :ref:`float<class_float>` exposure_max **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_tonemap_auto_exposure_min<class_Environment_set_tonemap_auto_exposure_min>` **(** :ref:`float<class_float>` exposure_min **)** |
|
| void | :ref:`set_tonemap_auto_exposure_min<class_Environment_set_tonemap_auto_exposure_min>` **(** :ref:`float<class_float>` exposure_min **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_tonemap_auto_exposure_speed<class_Environment_set_tonemap_auto_exposure_speed>` **(** :ref:`float<class_float>` exposure_speed **)** |
|
| void | :ref:`set_tonemap_auto_exposure_speed<class_Environment_set_tonemap_auto_exposure_speed>` **(** :ref:`float<class_float>` exposure_speed **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_tonemap_exposure<class_Environment_set_tonemap_exposure>` **(** :ref:`float<class_float>` exposure **)** |
|
| void | :ref:`set_tonemap_exposure<class_Environment_set_tonemap_exposure>` **(** :ref:`float<class_float>` exposure **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_tonemap_white<class_Environment_set_tonemap_white>` **(** :ref:`float<class_float>` white **)** |
|
| void | :ref:`set_tonemap_white<class_Environment_set_tonemap_white>` **(** :ref:`float<class_float>` white **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_tonemapper<class_Environment_set_tonemapper>` **(** :ref:`int<class_int>` mode **)** |
|
| void | :ref:`set_tonemapper<class_Environment_set_tonemapper>` **(** :ref:`int<class_int>` mode **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
@@ -405,7 +405,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_Environment_get_adjustment_color_correction:
|
.. _class_Environment_get_adjustment_color_correction:
|
||||||
|
|
||||||
- :ref:`Object<class_object>` **get_adjustment_color_correction** **(** **)** const
|
- :ref:`Texture<class_texture>` **get_adjustment_color_correction** **(** **)** const
|
||||||
|
|
||||||
.. _class_Environment_get_adjustment_contrast:
|
.. _class_Environment_get_adjustment_contrast:
|
||||||
|
|
||||||
@@ -537,7 +537,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_Environment_get_sky:
|
.. _class_Environment_get_sky:
|
||||||
|
|
||||||
- :ref:`CubeMap<class_cubemap>` **get_sky** **(** **)** const
|
- :ref:`Sky<class_sky>` **get_sky** **(** **)** const
|
||||||
|
|
||||||
.. _class_Environment_get_sky_scale:
|
.. _class_Environment_get_sky_scale:
|
||||||
|
|
||||||
@@ -681,7 +681,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_Environment_set_adjustment_color_correction:
|
.. _class_Environment_set_adjustment_color_correction:
|
||||||
|
|
||||||
- void **set_adjustment_color_correction** **(** :ref:`Object<class_object>` color_correction **)**
|
- void **set_adjustment_color_correction** **(** :ref:`Texture<class_texture>` color_correction **)**
|
||||||
|
|
||||||
.. _class_Environment_set_adjustment_contrast:
|
.. _class_Environment_set_adjustment_contrast:
|
||||||
|
|
||||||
|
|||||||
@@ -43,7 +43,7 @@ Member Functions
|
|||||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`get_endian_swap<class_File_get_endian_swap>` **(** **)** |
|
| :ref:`bool<class_bool>` | :ref:`get_endian_swap<class_File_get_endian_swap>` **(** **)** |
|
||||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| Error | :ref:`get_error<class_File_get_error>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_error<class_File_get_error>` **(** **)** const |
|
||||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_float<class_File_get_float>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_float<class_File_get_float>` **(** **)** const |
|
||||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -63,13 +63,13 @@ Member Functions
|
|||||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`get_sha256<class_File_get_sha256>` **(** :ref:`String<class_string>` path **)** const |
|
| :ref:`String<class_string>` | :ref:`get_sha256<class_File_get_sha256>` **(** :ref:`String<class_string>` path **)** const |
|
||||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`get_var<class_File_get_var>` **(** **)** const |
|
| :ref:`Variant<class_variant>` | :ref:`get_var<class_File_get_var>` **(** **)** const |
|
||||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_open<class_File_is_open>` **(** **)** 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<class_File_open>` **(** :ref:`String<class_string>` path, :ref:`int<class_int>` flags **)** |
|
||||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`open_compressed<class_File_open_compressed>` **(** :ref:`String<class_string>` path, :ref:`int<class_int>` mode_flags, :ref:`int<class_int>` compression_mode=0 **)** |
|
| :ref:`int<class_int>` | :ref:`open_compressed<class_File_open_compressed>` **(** :ref:`String<class_string>` path, :ref:`int<class_int>` mode_flags, :ref:`int<class_int>` compression_mode=null **)** |
|
||||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`open_encrypted<class_File_open_encrypted>` **(** :ref:`String<class_string>` path, :ref:`int<class_int>` mode_flags, :ref:`PoolByteArray<class_poolbytearray>` key **)** |
|
| :ref:`int<class_int>` | :ref:`open_encrypted<class_File_open_encrypted>` **(** :ref:`String<class_string>` path, :ref:`int<class_int>` mode_flags, :ref:`PoolByteArray<class_poolbytearray>` key **)** |
|
||||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -217,7 +217,7 @@ Get whether endian swap is enabled for this file.
|
|||||||
|
|
||||||
.. _class_File_get_error:
|
.. _class_File_get_error:
|
||||||
|
|
||||||
- Error **get_error** **(** **)** const
|
- :ref:`int<class_int>` **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>`.
|
Get the last error that happened when trying to perform operations. Compare with the ``ERR_FILE\_\*`` constants from :ref:`@Global Scope<class_@global scope>`.
|
||||||
|
|
||||||
@@ -275,7 +275,7 @@ Return a sha256 String representing the file at the given path or an empty :ref:
|
|||||||
|
|
||||||
.. _class_File_get_var:
|
.. _class_File_get_var:
|
||||||
|
|
||||||
- void **get_var** **(** **)** const
|
- :ref:`Variant<class_variant>` **get_var** **(** **)** const
|
||||||
|
|
||||||
Get the next Variant value from the file.
|
Get the next Variant value from the file.
|
||||||
|
|
||||||
@@ -293,7 +293,7 @@ Open the file for writing or reading, depending on the flags.
|
|||||||
|
|
||||||
.. _class_File_open_compressed:
|
.. _class_File_open_compressed:
|
||||||
|
|
||||||
- :ref:`int<class_int>` **open_compressed** **(** :ref:`String<class_string>` path, :ref:`int<class_int>` mode_flags, :ref:`int<class_int>` compression_mode=0 **)**
|
- :ref:`int<class_int>` **open_compressed** **(** :ref:`String<class_string>` path, :ref:`int<class_int>` mode_flags, :ref:`int<class_int>` compression_mode=null **)**
|
||||||
|
|
||||||
Open a compressed file for reading or writing. The compression_mode can be set as one of the COMPRESSION\_\* constants.
|
Open a compressed file for reading or writing. The compression_mode can be set as one of the COMPRESSION\_\* constants.
|
||||||
|
|
||||||
|
|||||||
@@ -20,41 +20,41 @@ Internationalized font and text drawing support.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| 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 |
|
| 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=null, :ref:`int<class_int>` clip_w=null **)** 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 |
|
| :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=null, :ref:`Color<class_color>` modulate=null **)** const |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_ascent<class_Font_get_ascent>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_ascent<class_Font_get_ascent>` **(** **)** const |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_descent<class_Font_get_descent>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_descent<class_Font_get_descent>` **(** **)** const |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_height<class_Font_get_height>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_height<class_Font_get_height>` **(** **)** const |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_string_size<class_Font_get_string_size>` **(** :ref:`String<class_string>` string **)** const |
|
| :ref:`Vector2<class_vector2>` | :ref:`get_string_size<class_Font_get_string_size>` **(** :ref:`String<class_string>` string **)** const |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_distance_field_hint<class_Font_is_distance_field_hint>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_distance_field_hint<class_Font_is_distance_field_hint>` **(** **)** const |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`update_changes<class_Font_update_changes>` **(** **)** |
|
| void | :ref:`update_changes<class_Font_update_changes>` **(** **)** |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Description
|
Description
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
Font contains an unicode compatible character set, as well as the ability to draw it with variable width, ascent, descent and kerning. For creating fonts from TTF files (or other font formats), see the editor support for fonts. TODO check wikipedia for graph of ascent/baseline/descent/height/etc.
|
Font contains a unicode compatible character set, as well as the ability to draw it with variable width, ascent, descent and kerning. For creating fonts from TTF files (or other font formats), see the editor support for fonts. TODO check wikipedia for graph of ascent/baseline/descent/height/etc.
|
||||||
|
|
||||||
Member Function Description
|
Member Function Description
|
||||||
---------------------------
|
---------------------------
|
||||||
|
|
||||||
.. _class_Font_draw:
|
.. _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
|
- void **draw** **(** :ref:`RID<class_rid>` canvas_item, :ref:`Vector2<class_vector2>` pos, :ref:`String<class_string>` string, :ref:`Color<class_color>` modulate=null, :ref:`int<class_int>` clip_w=null **)** const
|
||||||
|
|
||||||
Draw "string" into a canvas item using the font at a given "pos" position, with "modulate" color, and optionally clipping the width. "pos" specifies the baseline, not the top. To draw from the top, *ascent* must be added to the Y axis.
|
Draw "string" into a canvas item using the font at a given "pos" position, with "modulate" color, and optionally clipping the width. "pos" specifies the baseline, not the top. To draw from the top, *ascent* must be added to the Y axis.
|
||||||
|
|
||||||
.. _class_Font_draw_char:
|
.. _class_Font_draw_char:
|
||||||
|
|
||||||
- :ref:`float<class_float>` **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
|
- :ref:`float<class_float>` **draw_char** **(** :ref:`RID<class_rid>` canvas_item, :ref:`Vector2<class_vector2>` pos, :ref:`int<class_int>` char, :ref:`int<class_int>` next=null, :ref:`Color<class_color>` modulate=null **)** const
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
|
|||||||
@@ -21,7 +21,7 @@ Member Functions
|
|||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_valid<class_GDFunctionState_is_valid>` **(** :ref:`bool<class_bool>` extended_check=false **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_valid<class_GDFunctionState_is_valid>` **(** :ref:`bool<class_bool>` extended_check=false **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Variant<class_variant>` | :ref:`resume<class_GDFunctionState_resume>` **(** :ref:`Variant<class_variant>` arg=NULL **)** |
|
| :ref:`Variant<class_variant>` | :ref:`resume<class_GDFunctionState_resume>` **(** :ref:`Variant<class_variant>` arg=null **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Signals
|
Signals
|
||||||
@@ -47,7 +47,7 @@ If ``extended_check`` is enabled, it also checks if the associated script and ob
|
|||||||
|
|
||||||
.. _class_GDFunctionState_resume:
|
.. _class_GDFunctionState_resume:
|
||||||
|
|
||||||
- :ref:`Variant<class_variant>` **resume** **(** :ref:`Variant<class_variant>` arg=NULL **)**
|
- :ref:`Variant<class_variant>` **resume** **(** :ref:`Variant<class_variant>` arg=null **)**
|
||||||
|
|
||||||
Resume execution of the yielded function call.
|
Resume execution of the yielded function call.
|
||||||
|
|
||||||
|
|||||||
61
classes/class_gdnative.rst
Normal file
61
classes/class_gdnative.rst
Normal file
@@ -0,0 +1,61 @@
|
|||||||
|
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
||||||
|
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
|
||||||
|
|
||||||
|
.. _class_GDNative:
|
||||||
|
|
||||||
|
GDNative
|
||||||
|
========
|
||||||
|
|
||||||
|
**Inherits:** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||||
|
|
||||||
|
**Category:** Core
|
||||||
|
|
||||||
|
Brief Description
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Member Functions
|
||||||
|
----------------
|
||||||
|
|
||||||
|
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`Variant<class_variant>` | :ref:`call_native<class_GDNative_call_native>` **(** :ref:`String<class_string>` procedure_name, :ref:`String<class_string>` arguments, :ref:`Array<class_array>` arg2 **)** |
|
||||||
|
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`GDNativeLibrary<class_gdnativelibrary>` | :ref:`get_library<class_GDNative_get_library>` **(** **)** |
|
||||||
|
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`bool<class_bool>` | :ref:`initialize<class_GDNative_initialize>` **(** **)** |
|
||||||
|
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`set_library<class_GDNative_set_library>` **(** :ref:`GDNativeLibrary<class_gdnativelibrary>` library **)** |
|
||||||
|
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`bool<class_bool>` | :ref:`terminate<class_GDNative_terminate>` **(** **)** |
|
||||||
|
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
|
Member Variables
|
||||||
|
----------------
|
||||||
|
|
||||||
|
- :ref:`GDNativeLibrary<class_gdnativelibrary>` **library**
|
||||||
|
|
||||||
|
Member Function Description
|
||||||
|
---------------------------
|
||||||
|
|
||||||
|
.. _class_GDNative_call_native:
|
||||||
|
|
||||||
|
- :ref:`Variant<class_variant>` **call_native** **(** :ref:`String<class_string>` procedure_name, :ref:`String<class_string>` arguments, :ref:`Array<class_array>` arg2 **)**
|
||||||
|
|
||||||
|
.. _class_GDNative_get_library:
|
||||||
|
|
||||||
|
- :ref:`GDNativeLibrary<class_gdnativelibrary>` **get_library** **(** **)**
|
||||||
|
|
||||||
|
.. _class_GDNative_initialize:
|
||||||
|
|
||||||
|
- :ref:`bool<class_bool>` **initialize** **(** **)**
|
||||||
|
|
||||||
|
.. _class_GDNative_set_library:
|
||||||
|
|
||||||
|
- void **set_library** **(** :ref:`GDNativeLibrary<class_gdnativelibrary>` library **)**
|
||||||
|
|
||||||
|
.. _class_GDNative_terminate:
|
||||||
|
|
||||||
|
- :ref:`bool<class_bool>` **terminate** **(** **)**
|
||||||
|
|
||||||
|
|
||||||
@@ -18,15 +18,15 @@ Brief Description
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+-------+--------------------------------------------------+
|
+--------------------------------+--------------------------------------------------+
|
||||||
| void | :ref:`new<class_GDNativeClass_new>` **(** **)** |
|
| :ref:`Variant<class_variant>` | :ref:`new<class_GDNativeClass_new>` **(** **)** |
|
||||||
+-------+--------------------------------------------------+
|
+--------------------------------+--------------------------------------------------+
|
||||||
|
|
||||||
Member Function Description
|
Member Function Description
|
||||||
---------------------------
|
---------------------------
|
||||||
|
|
||||||
.. _class_GDNativeClass_new:
|
.. _class_GDNativeClass_new:
|
||||||
|
|
||||||
- void **new** **(** **)**
|
- :ref:`Variant<class_variant>` **new** **(** **)**
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -18,21 +18,21 @@ Brief Description
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`get_platform_file<class_GDNativeLibrary_get_platform_file>` **(** :ref:`String<class_string>` platform **)** const |
|
| :ref:`String<class_string>` | :ref:`get_library_path<class_GDNativeLibrary_get_library_path>` **(** :ref:`String<class_string>` platform **)** const |
|
||||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_platform_file<class_GDNativeLibrary_set_platform_file>` **(** :ref:`String<class_string>` platform, :ref:`String<class_string>` file **)** |
|
| void | :ref:`set_library_path<class_GDNativeLibrary_set_library_path>` **(** :ref:`String<class_string>` platform, :ref:`String<class_string>` path **)** |
|
||||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Member Function Description
|
Member Function Description
|
||||||
---------------------------
|
---------------------------
|
||||||
|
|
||||||
.. _class_GDNativeLibrary_get_platform_file:
|
.. _class_GDNativeLibrary_get_library_path:
|
||||||
|
|
||||||
- :ref:`String<class_string>` **get_platform_file** **(** :ref:`String<class_string>` platform **)** const
|
- :ref:`String<class_string>` **get_library_path** **(** :ref:`String<class_string>` platform **)** const
|
||||||
|
|
||||||
.. _class_GDNativeLibrary_set_platform_file:
|
.. _class_GDNativeLibrary_set_library_path:
|
||||||
|
|
||||||
- void **set_platform_file** **(** :ref:`String<class_string>` platform, :ref:`String<class_string>` file **)**
|
- void **set_library_path** **(** :ref:`String<class_string>` platform, :ref:`String<class_string>` path **)**
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,62 +0,0 @@
|
|||||||
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
||||||
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
|
|
||||||
|
|
||||||
.. _class_GDNativeScript:
|
|
||||||
|
|
||||||
GDNativeScript
|
|
||||||
==============
|
|
||||||
|
|
||||||
**Inherits:** :ref:`Script<class_script>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
|
||||||
|
|
||||||
**Category:** Core
|
|
||||||
|
|
||||||
Brief Description
|
|
||||||
-----------------
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Member Functions
|
|
||||||
----------------
|
|
||||||
|
|
||||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`Object<class_object>` | :ref:`get_library<class_GDNativeScript_get_library>` **(** **)** const |
|
|
||||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`String<class_string>` | :ref:`get_script_name<class_GDNativeScript_get_script_name>` **(** **)** const |
|
|
||||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`Object<class_object>` | :ref:`new<class_GDNativeScript_new>` **(** **)** vararg |
|
|
||||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_library<class_GDNativeScript_set_library>` **(** :ref:`Object<class_object>` library **)** |
|
|
||||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_script_name<class_GDNativeScript_set_script_name>` **(** :ref:`String<class_string>` script_name **)** |
|
|
||||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
|
||||||
----------------
|
|
||||||
|
|
||||||
- :ref:`GDNativeLibrary<class_gdnativelibrary>` **library**
|
|
||||||
- :ref:`String<class_string>` **script_name**
|
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_GDNativeScript_get_library:
|
|
||||||
|
|
||||||
- :ref:`Object<class_object>` **get_library** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_GDNativeScript_get_script_name:
|
|
||||||
|
|
||||||
- :ref:`String<class_string>` **get_script_name** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_GDNativeScript_new:
|
|
||||||
|
|
||||||
- :ref:`Object<class_object>` **new** **(** **)** vararg
|
|
||||||
|
|
||||||
.. _class_GDNativeScript_set_library:
|
|
||||||
|
|
||||||
- void **set_library** **(** :ref:`Object<class_object>` library **)**
|
|
||||||
|
|
||||||
.. _class_GDNativeScript_set_script_name:
|
|
||||||
|
|
||||||
- void **set_script_name** **(** :ref:`String<class_string>` script_name **)**
|
|
||||||
|
|
||||||
|
|
||||||
@@ -21,9 +21,9 @@ 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_box_planes<class_Geometry_build_box_planes>` **(** :ref:`Vector3<class_vector3>` extents **)** |
|
||||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :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:`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=null **)** |
|
||||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :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_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=null **)** |
|
||||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :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:`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 **)** |
|
||||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -43,7 +43,7 @@ Member Functions
|
|||||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :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:`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 |
|
||||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| 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:`Variant<class_variant>` | :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:`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:`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 **)** |
|
||||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -51,11 +51,11 @@ Member Functions
|
|||||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`PoolVector3Array<class_poolvector3array>` | :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:`PoolVector3Array<class_poolvector3array>` | :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:`Variant<class_variant>` | :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:`PoolVector3Array<class_poolvector3array>` | :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:`PoolVector3Array<class_poolvector3array>` | :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:`Variant<class_variant>` | :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:`PoolIntArray<class_poolintarray>` | :ref:`triangulate_polygon<class_Geometry_triangulate_polygon>` **(** :ref:`PoolVector2Array<class_poolvector2array>` polygon **)** |
|
| :ref:`PoolIntArray<class_poolintarray>` | :ref:`triangulate_polygon<class_Geometry_triangulate_polygon>` **(** :ref:`PoolVector2Array<class_poolvector2array>` polygon **)** |
|
||||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -69,11 +69,11 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_Geometry_build_capsule_planes:
|
.. _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 **)**
|
- :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=null **)**
|
||||||
|
|
||||||
.. _class_Geometry_build_cylinder_planes:
|
.. _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 **)**
|
- :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=null **)**
|
||||||
|
|
||||||
.. _class_Geometry_get_closest_point_to_segment:
|
.. _class_Geometry_get_closest_point_to_segment:
|
||||||
|
|
||||||
@@ -113,7 +113,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_Geometry_ray_intersects_triangle:
|
.. _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 **)**
|
- :ref:`Variant<class_variant>` **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:
|
.. _class_Geometry_segment_intersects_circle:
|
||||||
|
|
||||||
@@ -129,7 +129,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_Geometry_segment_intersects_segment_2d:
|
.. _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 **)**
|
- :ref:`Variant<class_variant>` **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:
|
.. _class_Geometry_segment_intersects_sphere:
|
||||||
|
|
||||||
@@ -137,7 +137,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_Geometry_segment_intersects_triangle:
|
.. _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 **)**
|
- :ref:`Variant<class_variant>` **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:
|
.. _class_Geometry_triangulate_polygon:
|
||||||
|
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ GeometryInstance
|
|||||||
|
|
||||||
**Inherits:** :ref:`VisualInstance<class_visualinstance>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
|
**Inherits:** :ref:`VisualInstance<class_visualinstance>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
|
||||||
|
|
||||||
**Inherited By:** :ref:`MultiMeshInstance<class_multimeshinstance>`, :ref:`SpriteBase3D<class_spritebase3d>`, :ref:`MeshInstance<class_meshinstance>`, :ref:`Particles<class_particles>`, :ref:`ImmediateGeometry<class_immediategeometry>`
|
**Inherited By:** :ref:`MultiMeshInstance<class_multimeshinstance>`, :ref:`MeshInstance<class_meshinstance>`, :ref:`Particles<class_particles>`, :ref:`SpriteBase3D<class_spritebase3d>`, :ref:`ImmediateGeometry<class_immediategeometry>`
|
||||||
|
|
||||||
**Category:** Core
|
**Category:** Core
|
||||||
|
|
||||||
@@ -20,59 +20,56 @@ Base node for geometry based visual instances.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_cast_shadows_setting<class_GeometryInstance_get_cast_shadows_setting>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_cast_shadows_setting<class_GeometryInstance_get_cast_shadows_setting>` **(** **)** const |
|
||||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_extra_cull_margin<class_GeometryInstance_get_extra_cull_margin>` **(** **)** 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:`bool<class_bool>` | :ref:`get_flag<class_GeometryInstance_get_flag>` **(** :ref:`int<class_int>` flag **)** const |
|
||||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_lod_max_distance<class_GeometryInstance_get_lod_max_distance>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_lod_max_distance<class_GeometryInstance_get_lod_max_distance>` **(** **)** const |
|
||||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_lod_max_hysteresis<class_GeometryInstance_get_lod_max_hysteresis>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_lod_max_hysteresis<class_GeometryInstance_get_lod_max_hysteresis>` **(** **)** const |
|
||||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_lod_min_distance<class_GeometryInstance_get_lod_min_distance>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_lod_min_distance<class_GeometryInstance_get_lod_min_distance>` **(** **)** const |
|
||||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_lod_min_hysteresis<class_GeometryInstance_get_lod_min_hysteresis>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_lod_min_hysteresis<class_GeometryInstance_get_lod_min_hysteresis>` **(** **)** const |
|
||||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Object<class_object>` | :ref:`get_material_override<class_GeometryInstance_get_material_override>` **(** **)** const |
|
| :ref:`Material<class_material>` | :ref:`get_material_override<class_GeometryInstance_get_material_override>` **(** **)** const |
|
||||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_cast_shadows_setting<class_GeometryInstance_set_cast_shadows_setting>` **(** :ref:`int<class_int>` shadow_casting_setting **)** |
|
| void | :ref:`set_cast_shadows_setting<class_GeometryInstance_set_cast_shadows_setting>` **(** :ref:`int<class_int>` shadow_casting_setting **)** |
|
||||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_extra_cull_margin<class_GeometryInstance_set_extra_cull_margin>` **(** :ref:`float<class_float>` margin **)** |
|
| void | :ref:`set_extra_cull_margin<class_GeometryInstance_set_extra_cull_margin>` **(** :ref:`float<class_float>` margin **)** |
|
||||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_flag<class_GeometryInstance_set_flag>` **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` value **)** |
|
| void | :ref:`set_flag<class_GeometryInstance_set_flag>` **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` value **)** |
|
||||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_lod_max_distance<class_GeometryInstance_set_lod_max_distance>` **(** :ref:`float<class_float>` mode **)** |
|
| void | :ref:`set_lod_max_distance<class_GeometryInstance_set_lod_max_distance>` **(** :ref:`float<class_float>` mode **)** |
|
||||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_lod_max_hysteresis<class_GeometryInstance_set_lod_max_hysteresis>` **(** :ref:`float<class_float>` mode **)** |
|
| void | :ref:`set_lod_max_hysteresis<class_GeometryInstance_set_lod_max_hysteresis>` **(** :ref:`float<class_float>` mode **)** |
|
||||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_lod_min_distance<class_GeometryInstance_set_lod_min_distance>` **(** :ref:`float<class_float>` mode **)** |
|
| void | :ref:`set_lod_min_distance<class_GeometryInstance_set_lod_min_distance>` **(** :ref:`float<class_float>` mode **)** |
|
||||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_lod_min_hysteresis<class_GeometryInstance_set_lod_min_hysteresis>` **(** :ref:`float<class_float>` mode **)** |
|
| void | :ref:`set_lod_min_hysteresis<class_GeometryInstance_set_lod_min_hysteresis>` **(** :ref:`float<class_float>` mode **)** |
|
||||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_material_override<class_GeometryInstance_set_material_override>` **(** :ref:`Object<class_object>` material **)** |
|
| void | :ref:`set_material_override<class_GeometryInstance_set_material_override>` **(** :ref:`Material<class_material>` material **)** |
|
||||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
- :ref:`int<class_int>` **cast_shadow**
|
- :ref:`int<class_int>` **cast_shadow**
|
||||||
- :ref:`float<class_float>` **extra_cull_margin**
|
- :ref:`float<class_float>` **extra_cull_margin**
|
||||||
- :ref:`int<class_int>` **lod_max_distance**
|
- :ref:`float<class_float>` **lod_max_distance**
|
||||||
- :ref:`int<class_int>` **lod_max_hysteresis**
|
- :ref:`float<class_float>` **lod_max_hysteresis**
|
||||||
- :ref:`int<class_int>` **lod_min_distance**
|
- :ref:`float<class_float>` **lod_min_distance**
|
||||||
- :ref:`int<class_int>` **lod_min_hysteresis**
|
- :ref:`float<class_float>` **lod_min_hysteresis**
|
||||||
- ShaderMaterial,SpatialMaterial **material_override**
|
- :ref:`Material<class_material>` **material_override**
|
||||||
- :ref:`bool<class_bool>` **use_in_baked_light**
|
- :ref:`bool<class_bool>` **use_in_baked_light**
|
||||||
- :ref:`bool<class_bool>` **visible_in_all_rooms**
|
|
||||||
|
|
||||||
Numeric Constants
|
Numeric Constants
|
||||||
-----------------
|
-----------------
|
||||||
|
|
||||||
- **FLAG_CAST_SHADOW** = **0**
|
- **FLAG_MAX** = **1**
|
||||||
- **FLAG_VISIBLE_IN_ALL_ROOMS** = **1**
|
|
||||||
- **FLAG_MAX** = **3**
|
|
||||||
- **SHADOW_CASTING_SETTING_OFF** = **0**
|
- **SHADOW_CASTING_SETTING_OFF** = **0**
|
||||||
- **SHADOW_CASTING_SETTING_ON** = **1**
|
- **SHADOW_CASTING_SETTING_ON** = **1**
|
||||||
- **SHADOW_CASTING_SETTING_DOUBLE_SIDED** = **2**
|
- **SHADOW_CASTING_SETTING_DOUBLE_SIDED** = **2**
|
||||||
@@ -116,7 +113,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_GeometryInstance_get_material_override:
|
.. _class_GeometryInstance_get_material_override:
|
||||||
|
|
||||||
- :ref:`Object<class_object>` **get_material_override** **(** **)** const
|
- :ref:`Material<class_material>` **get_material_override** **(** **)** const
|
||||||
|
|
||||||
Return the material override for the whole geometry.
|
Return the material override for the whole geometry.
|
||||||
|
|
||||||
@@ -150,7 +147,7 @@ Return the material override for the whole geometry.
|
|||||||
|
|
||||||
.. _class_GeometryInstance_set_material_override:
|
.. _class_GeometryInstance_set_material_override:
|
||||||
|
|
||||||
- void **set_material_override** **(** :ref:`Object<class_object>` material **)**
|
- void **set_material_override** **(** :ref:`Material<class_material>` material **)**
|
||||||
|
|
||||||
Set the material override for the whole geometry.
|
Set the material override for the whole geometry.
|
||||||
|
|
||||||
|
|||||||
@@ -18,51 +18,51 @@ Brief Description
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`bake<class_GIProbe_bake>` **(** :ref:`Object<class_object>` from_node=NULL, :ref:`bool<class_bool>` create_visual_debug=false **)** |
|
| void | :ref:`bake<class_GIProbe_bake>` **(** :ref:`Node<class_node>` from_node=false, :ref:`bool<class_bool>` create_visual_debug=null **)** |
|
||||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`debug_bake<class_GIProbe_debug_bake>` **(** **)** |
|
| void | :ref:`debug_bake<class_GIProbe_debug_bake>` **(** **)** |
|
||||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_bias<class_GIProbe_get_bias>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_bias<class_GIProbe_get_bias>` **(** **)** const |
|
||||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_dynamic_range<class_GIProbe_get_dynamic_range>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_dynamic_range<class_GIProbe_get_dynamic_range>` **(** **)** const |
|
||||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_energy<class_GIProbe_get_energy>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_energy<class_GIProbe_get_energy>` **(** **)** const |
|
||||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector3<class_vector3>` | :ref:`get_extents<class_GIProbe_get_extents>` **(** **)** const |
|
| :ref:`Vector3<class_vector3>` | :ref:`get_extents<class_GIProbe_get_extents>` **(** **)** const |
|
||||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_normal_bias<class_GIProbe_get_normal_bias>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_normal_bias<class_GIProbe_get_normal_bias>` **(** **)** const |
|
||||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Object<class_object>` | :ref:`get_probe_data<class_GIProbe_get_probe_data>` **(** **)** const |
|
| :ref:`GIProbeData<class_giprobedata>` | :ref:`get_probe_data<class_GIProbe_get_probe_data>` **(** **)** const |
|
||||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_propagation<class_GIProbe_get_propagation>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_propagation<class_GIProbe_get_propagation>` **(** **)** const |
|
||||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_subdiv<class_GIProbe_get_subdiv>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_subdiv<class_GIProbe_get_subdiv>` **(** **)** const |
|
||||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_compressed<class_GIProbe_is_compressed>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_compressed<class_GIProbe_is_compressed>` **(** **)** const |
|
||||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_interior<class_GIProbe_is_interior>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_interior<class_GIProbe_is_interior>` **(** **)** const |
|
||||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_bias<class_GIProbe_set_bias>` **(** :ref:`float<class_float>` max **)** |
|
| void | :ref:`set_bias<class_GIProbe_set_bias>` **(** :ref:`float<class_float>` max **)** |
|
||||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_compress<class_GIProbe_set_compress>` **(** :ref:`bool<class_bool>` enable **)** |
|
| void | :ref:`set_compress<class_GIProbe_set_compress>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_dynamic_range<class_GIProbe_set_dynamic_range>` **(** :ref:`int<class_int>` max **)** |
|
| void | :ref:`set_dynamic_range<class_GIProbe_set_dynamic_range>` **(** :ref:`int<class_int>` max **)** |
|
||||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_energy<class_GIProbe_set_energy>` **(** :ref:`float<class_float>` max **)** |
|
| void | :ref:`set_energy<class_GIProbe_set_energy>` **(** :ref:`float<class_float>` max **)** |
|
||||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_extents<class_GIProbe_set_extents>` **(** :ref:`Vector3<class_vector3>` extents **)** |
|
| void | :ref:`set_extents<class_GIProbe_set_extents>` **(** :ref:`Vector3<class_vector3>` extents **)** |
|
||||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_interior<class_GIProbe_set_interior>` **(** :ref:`bool<class_bool>` enable **)** |
|
| void | :ref:`set_interior<class_GIProbe_set_interior>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_normal_bias<class_GIProbe_set_normal_bias>` **(** :ref:`float<class_float>` max **)** |
|
| void | :ref:`set_normal_bias<class_GIProbe_set_normal_bias>` **(** :ref:`float<class_float>` max **)** |
|
||||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_probe_data<class_GIProbe_set_probe_data>` **(** :ref:`Object<class_object>` data **)** |
|
| void | :ref:`set_probe_data<class_GIProbe_set_probe_data>` **(** :ref:`GIProbeData<class_giprobedata>` data **)** |
|
||||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_propagation<class_GIProbe_set_propagation>` **(** :ref:`float<class_float>` max **)** |
|
| void | :ref:`set_propagation<class_GIProbe_set_propagation>` **(** :ref:`float<class_float>` max **)** |
|
||||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_subdiv<class_GIProbe_set_subdiv>` **(** :ref:`int<class_int>` subdiv **)** |
|
| void | :ref:`set_subdiv<class_GIProbe_set_subdiv>` **(** :ref:`int<class_int>` subdiv **)** |
|
||||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
@@ -91,7 +91,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_GIProbe_bake:
|
.. _class_GIProbe_bake:
|
||||||
|
|
||||||
- void **bake** **(** :ref:`Object<class_object>` from_node=NULL, :ref:`bool<class_bool>` create_visual_debug=false **)**
|
- void **bake** **(** :ref:`Node<class_node>` from_node=false, :ref:`bool<class_bool>` create_visual_debug=null **)**
|
||||||
|
|
||||||
.. _class_GIProbe_debug_bake:
|
.. _class_GIProbe_debug_bake:
|
||||||
|
|
||||||
@@ -119,7 +119,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_GIProbe_get_probe_data:
|
.. _class_GIProbe_get_probe_data:
|
||||||
|
|
||||||
- :ref:`Object<class_object>` **get_probe_data** **(** **)** const
|
- :ref:`GIProbeData<class_giprobedata>` **get_probe_data** **(** **)** const
|
||||||
|
|
||||||
.. _class_GIProbe_get_propagation:
|
.. _class_GIProbe_get_propagation:
|
||||||
|
|
||||||
@@ -167,7 +167,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_GIProbe_set_probe_data:
|
.. _class_GIProbe_set_probe_data:
|
||||||
|
|
||||||
- void **set_probe_data** **(** :ref:`Object<class_object>` data **)**
|
- void **set_probe_data** **(** :ref:`GIProbeData<class_giprobedata>` data **)**
|
||||||
|
|
||||||
.. _class_GIProbe_set_propagation:
|
.. _class_GIProbe_set_propagation:
|
||||||
|
|
||||||
|
|||||||
@@ -47,8 +47,8 @@ Member Functions
|
|||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
- :ref:`float<class_float>` **colors**
|
- :ref:`PoolColorArray<class_poolcolorarray>` **colors**
|
||||||
- :ref:`float<class_float>` **offsets**
|
- :ref:`PoolRealArray<class_poolrealarray>` **offsets**
|
||||||
|
|
||||||
Description
|
Description
|
||||||
-----------
|
-----------
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ 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:`int<class_int>` | :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 **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| 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 **)** |
|
| 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 **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -41,7 +41,7 @@ Member Functions
|
|||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_scroll_ofs<class_GraphEdit_set_scroll_ofs>` **(** :ref:`Vector2<class_vector2>` ofs **)** |
|
| void | :ref:`set_scroll_ofs<class_GraphEdit_set_scroll_ofs>` **(** :ref:`Vector2<class_vector2>` ofs **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_selected<class_GraphEdit_set_selected>` **(** :ref:`Object<class_object>` node **)** |
|
| void | :ref:`set_selected<class_GraphEdit_set_selected>` **(** :ref:`Node<class_node>` node **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_snap<class_GraphEdit_set_snap>` **(** :ref:`int<class_int>` pixels **)** |
|
| void | :ref:`set_snap<class_GraphEdit_set_snap>` **(** :ref:`int<class_int>` pixels **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -81,7 +81,7 @@ Signal sent when a popup is requested. Happens on right-clicking in the GraphEdi
|
|||||||
Description
|
Description
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
GraphEdit manages the showing of GraphNodes it contains, as well as connections an disconnections between them. Signals are sent for each of these two events. Disconnection between GraphNodes slots is disabled by default.
|
GraphEdit manages the showing of GraphNodes it contains, as well as connections and disconnections between them. Signals are sent for each of these two events. Disconnection between GraphNodes slots is disabled by default.
|
||||||
|
|
||||||
It is greatly advised to enable low processor usage mode (see :ref:`OS.set_low_processor_usage_mode<class_OS_set_low_processor_usage_mode>`) when using GraphEdits.
|
It is greatly advised to enable low processor usage mode (see :ref:`OS.set_low_processor_usage_mode<class_OS_set_low_processor_usage_mode>`) when using GraphEdits.
|
||||||
|
|
||||||
@@ -90,7 +90,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_GraphEdit_connect_node:
|
.. _class_GraphEdit_connect_node:
|
||||||
|
|
||||||
- Error **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:`int<class_int>` **connect_node** **(** :ref:`String<class_string>` from, :ref:`int<class_int>` from_port, :ref:`String<class_string>` to, :ref:`int<class_int>` to_port **)**
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
@@ -150,7 +150,7 @@ Enable the disconnection of existing connections in the visual GraphEdit by left
|
|||||||
|
|
||||||
.. _class_GraphEdit_set_selected:
|
.. _class_GraphEdit_set_selected:
|
||||||
|
|
||||||
- void **set_selected** **(** :ref:`Object<class_object>` node **)**
|
- void **set_selected** **(** :ref:`Node<class_node>` node **)**
|
||||||
|
|
||||||
.. _class_GraphEdit_set_snap:
|
.. _class_GraphEdit_set_snap:
|
||||||
|
|
||||||
|
|||||||
@@ -18,69 +18,69 @@ A GraphNode is a container with several input and output slots allowing connecti
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`clear_all_slots<class_GraphNode_clear_all_slots>` **(** **)** |
|
| 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_slot<class_GraphNode_clear_slot>` **(** :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_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:`int<class_int>` | :ref:`get_connection_input_count<class_GraphNode_get_connection_input_count>` **(** **)** |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_connection_input_pos<class_GraphNode_get_connection_input_pos>` **(** :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:`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_output_color<class_GraphNode_get_connection_output_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:`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:`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:`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:`Vector2<class_vector2>` | :ref:`get_offset<class_GraphNode_get_offset>` **(** **)** const |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_overlay<class_GraphNode_get_overlay>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_overlay<class_GraphNode_get_overlay>` **(** **)** 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_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:`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_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:`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:`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_close_button_visible<class_GraphNode_is_close_button_visible>` **(** **)** const |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_comment<class_GraphNode_is_comment>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_comment<class_GraphNode_is_comment>` **(** **)** const |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_resizeable<class_GraphNode_is_resizeable>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_resizeable<class_GraphNode_is_resizeable>` **(** **)** const |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_selected<class_GraphNode_is_selected>` **(** **)** |
|
| :ref:`bool<class_bool>` | :ref:`is_selected<class_GraphNode_is_selected>` **(** **)** |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :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_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 |
|
| :ref:`bool<class_bool>` | :ref:`is_slot_enabled_right<class_GraphNode_is_slot_enabled_right>` **(** :ref:`int<class_int>` idx **)** const |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_comment<class_GraphNode_set_comment>` **(** :ref:`bool<class_bool>` comment **)** |
|
| void | :ref:`set_comment<class_GraphNode_set_comment>` **(** :ref:`bool<class_bool>` comment **)** |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_offset<class_GraphNode_set_offset>` **(** :ref:`Vector2<class_vector2>` offset **)** |
|
| void | :ref:`set_offset<class_GraphNode_set_offset>` **(** :ref:`Vector2<class_vector2>` offset **)** |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_overlay<class_GraphNode_set_overlay>` **(** :ref:`int<class_int>` overlay **)** |
|
| void | :ref:`set_overlay<class_GraphNode_set_overlay>` **(** :ref:`int<class_int>` overlay **)** |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_resizeable<class_GraphNode_set_resizeable>` **(** :ref:`bool<class_bool>` resizeable **)** |
|
| void | :ref:`set_resizeable<class_GraphNode_set_resizeable>` **(** :ref:`bool<class_bool>` resizeable **)** |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_selected<class_GraphNode_set_selected>` **(** :ref:`bool<class_bool>` selected **)** |
|
| void | :ref:`set_selected<class_GraphNode_set_selected>` **(** :ref:`bool<class_bool>` selected **)** |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_show_close_button<class_GraphNode_set_show_close_button>` **(** :ref:`bool<class_bool>` show **)** |
|
| void | :ref:`set_show_close_button<class_GraphNode_set_show_close_button>` **(** :ref:`bool<class_bool>` show **)** |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| 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, :ref:`Object<class_object>` custom_left=NULL, :ref:`Object<class_object>` custom_right=NULL **)** |
|
| 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, :ref:`Texture<class_texture>` custom_left=null, :ref:`Texture<class_texture>` custom_right=null **)** |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_title<class_GraphNode_set_title>` **(** :ref:`String<class_string>` title **)** |
|
| void | :ref:`set_title<class_GraphNode_set_title>` **(** :ref:`String<class_string>` title **)** |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Signals
|
Signals
|
||||||
-------
|
-------
|
||||||
@@ -281,7 +281,7 @@ Show the close button on the GraphNode if 'show' is true (disabled by default).
|
|||||||
|
|
||||||
.. _class_GraphNode_set_slot:
|
.. _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, :ref:`Object<class_object>` custom_left=NULL, :ref:`Object<class_object>` custom_right=NULL **)**
|
- 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, :ref:`Texture<class_texture>` custom_left=null, :ref:`Texture<class_texture>` custom_right=null **)**
|
||||||
|
|
||||||
.. _class_GraphNode_set_title:
|
.. _class_GraphNode_set_title:
|
||||||
|
|
||||||
|
|||||||
@@ -18,69 +18,45 @@ Brief Description
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Rect3<class_rect3>` | :ref:`area_get_bounds<class_GridMap_area_get_bounds>` **(** :ref:`int<class_int>` area **)** const |
|
| void | :ref:`clear<class_GridMap_clear>` **(** **)** |
|
||||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`area_get_name<class_GridMap_area_get_name>` **(** :ref:`int<class_int>` area **)** const |
|
| :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:`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:`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:`area_get_portal_disable_distance<class_GridMap_area_get_portal_disable_distance>` **(** :ref:`int<class_int>` area **)** const |
|
| :ref:`Vector3<class_vector3>` | :ref:`get_cell_size<class_GridMap_get_cell_size>` **(** **)** const |
|
||||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`area_is_exterior_portal<class_GridMap_area_is_exterior_portal>` **(** :ref:`int<class_int>` area **)** const |
|
| :ref:`bool<class_bool>` | :ref:`get_center_x<class_GridMap_get_center_x>` **(** **)** const |
|
||||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`area_set_exterior_portal<class_GridMap_area_set_exterior_portal>` **(** :ref:`int<class_int>` area, :ref:`bool<class_bool>` enable **)** |
|
| :ref:`bool<class_bool>` | :ref:`get_center_y<class_GridMap_get_center_y>` **(** **)** const |
|
||||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`area_set_name<class_GridMap_area_set_name>` **(** :ref:`int<class_int>` area, :ref:`String<class_string>` name **)** |
|
| :ref:`bool<class_bool>` | :ref:`get_center_z<class_GridMap_get_center_z>` **(** **)** 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 **)** |
|
| :ref:`Array<class_array>` | :ref:`get_meshes<class_GridMap_get_meshes>` **(** **)** |
|
||||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| 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:`int<class_int>` | :ref:`get_octant_size<class_GridMap_get_octant_size>` **(** **)** const |
|
||||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`clear<class_GridMap_clear>` **(** **)** |
|
| :ref:`MeshLibrary<class_meshlibrary>` | :ref:`get_theme<class_GridMap_get_theme>` **(** **)** const |
|
||||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`create_area<class_GridMap_create_area>` **(** :ref:`int<class_int>` id, :ref:`Rect3<class_rect3>` area **)** |
|
| void | :ref:`resource_changed<class_GridMap_resource_changed>` **(** :ref:`Resource<class_resource>` resource **)** |
|
||||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`erase_area<class_GridMap_erase_area>` **(** :ref:`int<class_int>` area **)** |
|
| 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=null **)** |
|
||||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :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 |
|
| void | :ref:`set_cell_size<class_GridMap_set_cell_size>` **(** :ref:`Vector3<class_vector3>` size **)** |
|
||||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :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:`set_center_x<class_GridMap_set_center_x>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_cell_size<class_GridMap_get_cell_size>` **(** **)** const |
|
| void | :ref:`set_center_y<class_GridMap_set_center_y>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`get_center_x<class_GridMap_get_center_x>` **(** **)** const |
|
| void | :ref:`set_center_z<class_GridMap_set_center_z>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`get_center_y<class_GridMap_get_center_y>` **(** **)** const |
|
| void | :ref:`set_clip<class_GridMap_set_clip>` **(** :ref:`bool<class_bool>` enabled, :ref:`bool<class_bool>` clipabove=0, :ref:`int<class_int>` floor=true, :ref:`int<class_int>` axis=null **)** |
|
||||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`get_center_z<class_GridMap_get_center_z>` **(** **)** const |
|
| void | :ref:`set_octant_size<class_GridMap_set_octant_size>` **(** :ref:`int<class_int>` size **)** |
|
||||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Array<class_array>` | :ref:`get_meshes<class_GridMap_get_meshes>` **(** **)** |
|
| void | :ref:`set_theme<class_GridMap_set_theme>` **(** :ref:`MeshLibrary<class_meshlibrary>` theme **)** |
|
||||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :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:`resource_changed<class_GridMap_resource_changed>` **(** :ref:`Object<class_object>` resource **)** |
|
|
||||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| 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 **)** |
|
|
||||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Numeric Constants
|
Numeric Constants
|
||||||
-----------------
|
-----------------
|
||||||
@@ -90,54 +66,10 @@ Numeric Constants
|
|||||||
Member Function Description
|
Member Function Description
|
||||||
---------------------------
|
---------------------------
|
||||||
|
|
||||||
.. _class_GridMap_area_get_bounds:
|
|
||||||
|
|
||||||
- :ref:`Rect3<class_rect3>` **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 **)**
|
|
||||||
|
|
||||||
.. _class_GridMap_area_set_name:
|
|
||||||
|
|
||||||
- void **area_set_name** **(** :ref:`int<class_int>` area, :ref:`String<class_string>` name **)**
|
|
||||||
|
|
||||||
.. _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_set_portal_disable_distance:
|
|
||||||
|
|
||||||
- void **area_set_portal_disable_distance** **(** :ref:`int<class_int>` area, :ref:`float<class_float>` distance **)**
|
|
||||||
|
|
||||||
.. _class_GridMap_clear:
|
.. _class_GridMap_clear:
|
||||||
|
|
||||||
- void **clear** **(** **)**
|
- void **clear** **(** **)**
|
||||||
|
|
||||||
.. _class_GridMap_create_area:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **create_area** **(** :ref:`int<class_int>` id, :ref:`Rect3<class_rect3>` area **)**
|
|
||||||
|
|
||||||
.. _class_GridMap_erase_area:
|
|
||||||
|
|
||||||
- void **erase_area** **(** :ref:`int<class_int>` area **)**
|
|
||||||
|
|
||||||
.. _class_GridMap_get_cell_item:
|
.. _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
|
- :ref:`int<class_int>` **get_cell_item** **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z **)** const
|
||||||
@@ -148,7 +80,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_GridMap_get_cell_size:
|
.. _class_GridMap_get_cell_size:
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_cell_size** **(** **)** const
|
- :ref:`Vector3<class_vector3>` **get_cell_size** **(** **)** const
|
||||||
|
|
||||||
.. _class_GridMap_get_center_x:
|
.. _class_GridMap_get_center_x:
|
||||||
|
|
||||||
@@ -174,21 +106,17 @@ Member Function Description
|
|||||||
|
|
||||||
- :ref:`MeshLibrary<class_meshlibrary>` **get_theme** **(** **)** const
|
- :ref:`MeshLibrary<class_meshlibrary>` **get_theme** **(** **)** const
|
||||||
|
|
||||||
.. _class_GridMap_get_unused_area_id:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_unused_area_id** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_GridMap_resource_changed:
|
.. _class_GridMap_resource_changed:
|
||||||
|
|
||||||
- void **resource_changed** **(** :ref:`Object<class_object>` resource **)**
|
- void **resource_changed** **(** :ref:`Resource<class_resource>` resource **)**
|
||||||
|
|
||||||
.. _class_GridMap_set_cell_item:
|
.. _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 **)**
|
- 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=null **)**
|
||||||
|
|
||||||
.. _class_GridMap_set_cell_size:
|
.. _class_GridMap_set_cell_size:
|
||||||
|
|
||||||
- void **set_cell_size** **(** :ref:`float<class_float>` size **)**
|
- void **set_cell_size** **(** :ref:`Vector3<class_vector3>` size **)**
|
||||||
|
|
||||||
.. _class_GridMap_set_center_x:
|
.. _class_GridMap_set_center_x:
|
||||||
|
|
||||||
@@ -204,7 +132,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_GridMap_set_clip:
|
.. _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 **)**
|
- void **set_clip** **(** :ref:`bool<class_bool>` enabled, :ref:`bool<class_bool>` clipabove=0, :ref:`int<class_int>` floor=true, :ref:`int<class_int>` axis=null **)**
|
||||||
|
|
||||||
.. _class_GridMap_set_octant_size:
|
.. _class_GridMap_set_octant_size:
|
||||||
|
|
||||||
|
|||||||
@@ -21,7 +21,7 @@ Member Functions
|
|||||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`close<class_HTTPClient_close>` **(** **)** |
|
| void | :ref:`close<class_HTTPClient_close>` **(** **)** |
|
||||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| Error | :ref:`connect_to_host<class_HTTPClient_connect_to_host>` **(** :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:`int<class_int>` | :ref:`connect_to_host<class_HTTPClient_connect_to_host>` **(** :ref:`String<class_string>` host, :ref:`int<class_int>` port, :ref:`bool<class_bool>` use_ssl=null, :ref:`bool<class_bool>` verify_host=null **)** |
|
||||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`StreamPeer<class_streampeer>` | :ref:`get_connection<class_HTTPClient_get_connection>` **(** **)** const |
|
| :ref:`StreamPeer<class_streampeer>` | :ref:`get_connection<class_HTTPClient_get_connection>` **(** **)** const |
|
||||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -41,13 +41,13 @@ Member Functions
|
|||||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_response_chunked<class_HTTPClient_is_response_chunked>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_response_chunked<class_HTTPClient_is_response_chunked>` **(** **)** const |
|
||||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| Error | :ref:`poll<class_HTTPClient_poll>` **(** **)** |
|
| :ref:`int<class_int>` | :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:`String<class_string>` | :ref:`query_string_from_dict<class_HTTPClient_query_string_from_dict>` **(** :ref:`Dictionary<class_dictionary>` fields **)** |
|
||||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`PoolByteArray<class_poolbytearray>` | :ref:`read_response_body_chunk<class_HTTPClient_read_response_body_chunk>` **(** **)** |
|
| :ref:`PoolByteArray<class_poolbytearray>` | :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:`PoolStringArray<class_poolstringarray>` headers, :ref:`String<class_string>` body="" **)** |
|
| :ref:`int<class_int>` | :ref:`request<class_HTTPClient_request>` **(** :ref:`int<class_int>` method, :ref:`String<class_string>` url, :ref:`PoolStringArray<class_poolstringarray>` headers, :ref:`String<class_string>` body=null **)** |
|
||||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`request_raw<class_HTTPClient_request_raw>` **(** :ref:`int<class_int>` method, :ref:`String<class_string>` url, :ref:`PoolStringArray<class_poolstringarray>` headers, :ref:`PoolByteArray<class_poolbytearray>` body **)** |
|
| :ref:`int<class_int>` | :ref:`request_raw<class_HTTPClient_request_raw>` **(** :ref:`int<class_int>` method, :ref:`String<class_string>` url, :ref:`PoolStringArray<class_poolstringarray>` headers, :ref:`PoolByteArray<class_poolbytearray>` body **)** |
|
||||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -152,7 +152,7 @@ Cloces the current connection, allows for reusal of :ref:`HTTPClient<class_httpc
|
|||||||
|
|
||||||
.. _class_HTTPClient_connect_to_host:
|
.. _class_HTTPClient_connect_to_host:
|
||||||
|
|
||||||
- Error **connect_to_host** **(** :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:`int<class_int>` **connect_to_host** **(** :ref:`String<class_string>` host, :ref:`int<class_int>` port, :ref:`bool<class_bool>` use_ssl=null, :ref:`bool<class_bool>` verify_host=null **)**
|
||||||
|
|
||||||
Connect to a host. This needs to be done before any requests are sent.
|
Connect to a host. This needs to be done before any requests are sent.
|
||||||
|
|
||||||
@@ -220,7 +220,7 @@ Return whether this :ref:`HTTPClient<class_httpclient>` has a response that is c
|
|||||||
|
|
||||||
.. _class_HTTPClient_poll:
|
.. _class_HTTPClient_poll:
|
||||||
|
|
||||||
- Error **poll** **(** **)**
|
- :ref:`int<class_int>` **poll** **(** **)**
|
||||||
|
|
||||||
This needs to be called in order to have any request processed. Check results with :ref:`get_status<class_HTTPClient_get_status>`
|
This needs to be called in order to have any request processed. Check results with :ref:`get_status<class_HTTPClient_get_status>`
|
||||||
|
|
||||||
@@ -244,7 +244,7 @@ Reads one chunk from the response.
|
|||||||
|
|
||||||
.. _class_HTTPClient_request:
|
.. _class_HTTPClient_request:
|
||||||
|
|
||||||
- :ref:`int<class_int>` **request** **(** :ref:`int<class_int>` method, :ref:`String<class_string>` url, :ref:`PoolStringArray<class_poolstringarray>` headers, :ref:`String<class_string>` body="" **)**
|
- :ref:`int<class_int>` **request** **(** :ref:`int<class_int>` method, :ref:`String<class_string>` url, :ref:`PoolStringArray<class_poolstringarray>` headers, :ref:`String<class_string>` body=null **)**
|
||||||
|
|
||||||
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".
|
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".
|
||||||
|
|
||||||
|
|||||||
@@ -18,33 +18,33 @@ A Node with the ability to send HTTP requests.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`cancel_request<class_HTTPRequest_cancel_request>` **(** **)** |
|
| void | :ref:`cancel_request<class_HTTPRequest_cancel_request>` **(** **)** |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_body_size<class_HTTPRequest_get_body_size>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_body_size<class_HTTPRequest_get_body_size>` **(** **)** const |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_body_size_limit<class_HTTPRequest_get_body_size_limit>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_body_size_limit<class_HTTPRequest_get_body_size_limit>` **(** **)** const |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`get_download_file<class_HTTPRequest_get_download_file>` **(** **)** const |
|
| :ref:`String<class_string>` | :ref:`get_download_file<class_HTTPRequest_get_download_file>` **(** **)** const |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_downloaded_bytes<class_HTTPRequest_get_downloaded_bytes>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_downloaded_bytes<class_HTTPRequest_get_downloaded_bytes>` **(** **)** const |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_http_client_status<class_HTTPRequest_get_http_client_status>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_http_client_status<class_HTTPRequest_get_http_client_status>` **(** **)** const |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_max_redirects<class_HTTPRequest_get_max_redirects>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_max_redirects<class_HTTPRequest_get_max_redirects>` **(** **)** const |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_using_threads<class_HTTPRequest_is_using_threads>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_using_threads<class_HTTPRequest_is_using_threads>` **(** **)** const |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`request<class_HTTPRequest_request>` **(** :ref:`String<class_string>` url, :ref:`PoolStringArray<class_poolstringarray>` custom_headers=PoolStringArray([]), :ref:`bool<class_bool>` ssl_validate_domain=true, :ref:`int<class_int>` method=0, :ref:`String<class_string>` request_data="" **)** |
|
| :ref:`int<class_int>` | :ref:`request<class_HTTPRequest_request>` **(** :ref:`String<class_string>` url, :ref:`PoolStringArray<class_poolstringarray>` custom_headers=0, :ref:`bool<class_bool>` ssl_validate_domain=true, :ref:`int<class_int>` method=PoolStringArray( ), :ref:`String<class_string>` request_data=null **)** |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_body_size_limit<class_HTTPRequest_set_body_size_limit>` **(** :ref:`int<class_int>` bytes **)** |
|
| void | :ref:`set_body_size_limit<class_HTTPRequest_set_body_size_limit>` **(** :ref:`int<class_int>` bytes **)** |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_download_file<class_HTTPRequest_set_download_file>` **(** :ref:`String<class_string>` path **)** |
|
| void | :ref:`set_download_file<class_HTTPRequest_set_download_file>` **(** :ref:`String<class_string>` path **)** |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_max_redirects<class_HTTPRequest_set_max_redirects>` **(** :ref:`int<class_int>` amount **)** |
|
| void | :ref:`set_max_redirects<class_HTTPRequest_set_max_redirects>` **(** :ref:`int<class_int>` amount **)** |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_use_threads<class_HTTPRequest_set_use_threads>` **(** :ref:`bool<class_bool>` enable **)** |
|
| void | :ref:`set_use_threads<class_HTTPRequest_set_use_threads>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Signals
|
Signals
|
||||||
-------
|
-------
|
||||||
@@ -136,7 +136,7 @@ Whether this request is using threads.
|
|||||||
|
|
||||||
.. _class_HTTPRequest_request:
|
.. _class_HTTPRequest_request:
|
||||||
|
|
||||||
- :ref:`int<class_int>` **request** **(** :ref:`String<class_string>` url, :ref:`PoolStringArray<class_poolstringarray>` custom_headers=PoolStringArray([]), :ref:`bool<class_bool>` ssl_validate_domain=true, :ref:`int<class_int>` method=0, :ref:`String<class_string>` request_data="" **)**
|
- :ref:`int<class_int>` **request** **(** :ref:`String<class_string>` url, :ref:`PoolStringArray<class_poolstringarray>` custom_headers=0, :ref:`bool<class_bool>` ssl_validate_domain=true, :ref:`int<class_int>` method=PoolStringArray( ), :ref:`String<class_string>` request_data=null **)**
|
||||||
|
|
||||||
.. _class_HTTPRequest_set_body_size_limit:
|
.. _class_HTTPRequest_set_body_size_limit:
|
||||||
|
|
||||||
|
|||||||
@@ -29,7 +29,7 @@ Member Functions
|
|||||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`clear_mipmaps<class_Image_clear_mipmaps>` **(** **)** |
|
| void | :ref:`clear_mipmaps<class_Image_clear_mipmaps>` **(** **)** |
|
||||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`compress<class_Image_compress>` **(** :ref:`int<class_int>` mode, :ref:`int<class_int>` arg1, :ref:`float<class_float>` arg2 **)** |
|
| :ref:`int<class_int>` | :ref:`compress<class_Image_compress>` **(** :ref:`int<class_int>` mode, :ref:`int<class_int>` source, :ref:`float<class_float>` lossy_quality **)** |
|
||||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`convert<class_Image_convert>` **(** :ref:`int<class_int>` format **)** |
|
| void | :ref:`convert<class_Image_convert>` **(** :ref:`int<class_int>` format **)** |
|
||||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -69,6 +69,8 @@ Member Functions
|
|||||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Image<class_image>` | :ref:`get_rect<class_Image_get_rect>` **(** :ref:`Rect2<class_rect2>` rect **)** const |
|
| :ref:`Image<class_image>` | :ref:`get_rect<class_Image_get_rect>` **(** :ref:`Rect2<class_rect2>` rect **)** const |
|
||||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`Vector2<class_vector2>` | :ref:`get_size<class_Image_get_size>` **(** **)** const |
|
||||||
|
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Rect2<class_rect2>` | :ref:`get_used_rect<class_Image_get_used_rect>` **(** **)** const |
|
| :ref:`Rect2<class_rect2>` | :ref:`get_used_rect<class_Image_get_used_rect>` **(** **)** const |
|
||||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_width<class_Image_get_width>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_width<class_Image_get_width>` **(** **)** const |
|
||||||
@@ -89,7 +91,7 @@ Member Functions
|
|||||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`premultiply_alpha<class_Image_premultiply_alpha>` **(** **)** |
|
| void | :ref:`premultiply_alpha<class_Image_premultiply_alpha>` **(** **)** |
|
||||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`resize<class_Image_resize>` **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`int<class_int>` interpolation=1 **)** |
|
| void | :ref:`resize<class_Image_resize>` **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`int<class_int>` interpolation=null **)** |
|
||||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`resize_to_po2<class_Image_resize_to_po2>` **(** :ref:`bool<class_bool>` square=false **)** |
|
| void | :ref:`resize_to_po2<class_Image_resize_to_po2>` **(** :ref:`bool<class_bool>` square=false **)** |
|
||||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -203,7 +205,7 @@ Blits a "src_rect" :ref:`Rect2<class_rect2>` from "src" :ref:`Image<class_image>
|
|||||||
|
|
||||||
.. _class_Image_compress:
|
.. _class_Image_compress:
|
||||||
|
|
||||||
- :ref:`int<class_int>` **compress** **(** :ref:`int<class_int>` mode, :ref:`int<class_int>` arg1, :ref:`float<class_float>` arg2 **)**
|
- :ref:`int<class_int>` **compress** **(** :ref:`int<class_int>` mode, :ref:`int<class_int>` source, :ref:`float<class_float>` lossy_quality **)**
|
||||||
|
|
||||||
.. _class_Image_convert:
|
.. _class_Image_convert:
|
||||||
|
|
||||||
@@ -293,6 +295,10 @@ Return the height of the :ref:`Image<class_image>`.
|
|||||||
|
|
||||||
Return a new :ref:`Image<class_image>` that is a copy of "area" in this :ref:`Image<class_image>`.
|
Return a new :ref:`Image<class_image>` that is a copy of "area" in this :ref:`Image<class_image>`.
|
||||||
|
|
||||||
|
.. _class_Image_get_size:
|
||||||
|
|
||||||
|
- :ref:`Vector2<class_vector2>` **get_size** **(** **)** const
|
||||||
|
|
||||||
.. _class_Image_get_used_rect:
|
.. _class_Image_get_used_rect:
|
||||||
|
|
||||||
- :ref:`Rect2<class_rect2>` **get_used_rect** **(** **)** const
|
- :ref:`Rect2<class_rect2>` **get_used_rect** **(** **)** const
|
||||||
@@ -341,7 +347,7 @@ Load an :ref:`Image<class_image>`.
|
|||||||
|
|
||||||
.. _class_Image_resize:
|
.. _class_Image_resize:
|
||||||
|
|
||||||
- void **resize** **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`int<class_int>` interpolation=1 **)**
|
- void **resize** **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`int<class_int>` interpolation=null **)**
|
||||||
|
|
||||||
.. _class_Image_resize_to_po2:
|
.. _class_Image_resize_to_po2:
|
||||||
|
|
||||||
|
|||||||
@@ -18,29 +18,27 @@ A :ref:`Texture<class_texture>` based on an :ref:`Image<class_image>`.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`create<class_ImageTexture_create>` **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`int<class_int>` format, :ref:`int<class_int>` flags=7 **)** |
|
| void | :ref:`create<class_ImageTexture_create>` **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`int<class_int>` format, :ref:`int<class_int>` flags=null **)** |
|
||||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`create_from_image<class_ImageTexture_create_from_image>` **(** :ref:`Image<class_image>` image, :ref:`int<class_int>` flags=7 **)** |
|
| void | :ref:`create_from_image<class_ImageTexture_create_from_image>` **(** :ref:`Image<class_image>` image, :ref:`int<class_int>` flags=null **)** |
|
||||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Image<class_image>` | :ref:`get_data<class_ImageTexture_get_data>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_format<class_ImageTexture_get_format>` **(** **)** const |
|
||||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :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 |
|
||||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_lossy_storage_quality<class_ImageTexture_get_lossy_storage_quality>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_storage<class_ImageTexture_get_storage>` **(** **)** const |
|
||||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_storage<class_ImageTexture_get_storage>` **(** **)** const |
|
| void | :ref:`load<class_ImageTexture_load>` **(** :ref:`String<class_string>` path **)** |
|
||||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| 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:`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_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_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:`set_storage<class_ImageTexture_set_storage>` **(** :ref:`int<class_int>` mode **)** |
|
|
||||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Numeric Constants
|
Numeric Constants
|
||||||
-----------------
|
-----------------
|
||||||
@@ -59,7 +57,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_ImageTexture_create:
|
.. _class_ImageTexture_create:
|
||||||
|
|
||||||
- void **create** **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`int<class_int>` format, :ref:`int<class_int>` flags=7 **)**
|
- void **create** **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`int<class_int>` format, :ref:`int<class_int>` flags=null **)**
|
||||||
|
|
||||||
Create a new :ref:`ImageTexture<class_imagetexture>` with "width" and "height".
|
Create a new :ref:`ImageTexture<class_imagetexture>` with "width" and "height".
|
||||||
|
|
||||||
@@ -69,16 +67,10 @@ Create a new :ref:`ImageTexture<class_imagetexture>` with "width" and "height".
|
|||||||
|
|
||||||
.. _class_ImageTexture_create_from_image:
|
.. _class_ImageTexture_create_from_image:
|
||||||
|
|
||||||
- void **create_from_image** **(** :ref:`Image<class_image>` image, :ref:`int<class_int>` flags=7 **)**
|
- void **create_from_image** **(** :ref:`Image<class_image>` image, :ref:`int<class_int>` flags=null **)**
|
||||||
|
|
||||||
Create a new :ref:`ImageTexture<class_imagetexture>` from an :ref:`Image<class_image>` with "flags" from :ref:`Texture<class_texture>`.FLAG\_\*.
|
Create a new :ref:`ImageTexture<class_imagetexture>` from an :ref:`Image<class_image>` with "flags" from :ref:`Texture<class_texture>`.FLAG\_\*.
|
||||||
|
|
||||||
.. _class_ImageTexture_get_data:
|
|
||||||
|
|
||||||
- :ref:`Image<class_image>` **get_data** **(** **)** const
|
|
||||||
|
|
||||||
Return the :ref:`Image<class_image>` of this :ref:`ImageTexture<class_imagetexture>`.
|
|
||||||
|
|
||||||
.. _class_ImageTexture_get_format:
|
.. _class_ImageTexture_get_format:
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_format** **(** **)** const
|
- :ref:`int<class_int>` **get_format** **(** **)** const
|
||||||
|
|||||||
@@ -19,11 +19,11 @@ 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, :ref:`bool<class_bool>` add_uv=true **)** |
|
| void | :ref:`add_sphere<class_ImmediateGeometry_add_sphere>` **(** :ref:`int<class_int>` lats, :ref:`int<class_int>` lons, :ref:`float<class_float>` radius, :ref:`bool<class_bool>` add_uv=null **)** |
|
||||||
+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`add_vertex<class_ImmediateGeometry_add_vertex>` **(** :ref:`Vector3<class_vector3>` pos **)** |
|
| 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=NULL **)** |
|
| void | :ref:`begin<class_ImmediateGeometry_begin>` **(** :ref:`int<class_int>` primitive, :ref:`Texture<class_texture>` texture=null **)** |
|
||||||
+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`clear<class_ImmediateGeometry_clear>` **(** **)** |
|
| void | :ref:`clear<class_ImmediateGeometry_clear>` **(** **)** |
|
||||||
+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+-------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -45,9 +45,9 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_ImmediateGeometry_add_sphere:
|
.. _class_ImmediateGeometry_add_sphere:
|
||||||
|
|
||||||
- void **add_sphere** **(** :ref:`int<class_int>` lats, :ref:`int<class_int>` lons, :ref:`float<class_float>` radius, :ref:`bool<class_bool>` add_uv=true **)**
|
- void **add_sphere** **(** :ref:`int<class_int>` lats, :ref:`int<class_int>` lons, :ref:`float<class_float>` radius, :ref:`bool<class_bool>` add_uv=null **)**
|
||||||
|
|
||||||
Simple helper to draw an uvsphere, with given latitudes, longitude and radius.
|
Simple helper to draw a uvsphere, with given latitudes, longitude and radius.
|
||||||
|
|
||||||
.. _class_ImmediateGeometry_add_vertex:
|
.. _class_ImmediateGeometry_add_vertex:
|
||||||
|
|
||||||
@@ -57,7 +57,7 @@ Add a vertex with the currently set color/uv/etc.
|
|||||||
|
|
||||||
.. _class_ImmediateGeometry_begin:
|
.. _class_ImmediateGeometry_begin:
|
||||||
|
|
||||||
- void **begin** **(** :ref:`int<class_int>` primitive, :ref:`Texture<class_texture>` texture=NULL **)**
|
- void **begin** **(** :ref:`int<class_int>` primitive, :ref:`Texture<class_texture>` texture=null **)**
|
||||||
|
|
||||||
Begin drawing (And optionally pass a texture override). When done call end(). For more information on how this works, search for glBegin() glEnd() references.
|
Begin drawing (And optionally pass a texture override). When done call end(). For more information on how this works, search for glBegin() glEnd() references.
|
||||||
|
|
||||||
|
|||||||
@@ -20,75 +20,75 @@ A Singleton that deals with inputs.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`action_press<class_Input_action_press>` **(** :ref:`String<class_string>` action **)** |
|
| 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:`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 **)** |
|
| void | :ref:`add_joy_mapping<class_Input_add_joy_mapping>` **(** :ref:`String<class_string>` mapping, :ref:`bool<class_bool>` update_existing=null **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector3<class_vector3>` | :ref:`get_accelerometer<class_Input_get_accelerometer>` **(** **)** const |
|
| :ref:`Vector3<class_vector3>` | :ref:`get_accelerometer<class_Input_get_accelerometer>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Array<class_array>` | :ref:`get_connected_joypads<class_Input_get_connected_joypads>` **(** **)** |
|
| :ref:`Array<class_array>` | :ref:`get_connected_joypads<class_Input_get_connected_joypads>` **(** **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector3<class_vector3>` | :ref:`get_gravity<class_Input_get_gravity>` **(** **)** const |
|
| :ref:`Vector3<class_vector3>` | :ref:`get_gravity<class_Input_get_gravity>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector3<class_vector3>` | :ref:`get_gyroscope<class_Input_get_gyroscope>` **(** **)** const |
|
| :ref:`Vector3<class_vector3>` | :ref:`get_gyroscope<class_Input_get_gyroscope>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_joy_axis<class_Input_get_joy_axis>` **(** :ref:`int<class_int>` device, :ref:`int<class_int>` axis **)** const |
|
| :ref:`float<class_float>` | :ref:`get_joy_axis<class_Input_get_joy_axis>` **(** :ref:`int<class_int>` device, :ref:`int<class_int>` axis **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_joy_axis_index_from_string<class_Input_get_joy_axis_index_from_string>` **(** :ref:`String<class_string>` axis **)** |
|
| :ref:`int<class_int>` | :ref:`get_joy_axis_index_from_string<class_Input_get_joy_axis_index_from_string>` **(** :ref:`String<class_string>` axis **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`get_joy_axis_string<class_Input_get_joy_axis_string>` **(** :ref:`int<class_int>` axis_index **)** |
|
| :ref:`String<class_string>` | :ref:`get_joy_axis_string<class_Input_get_joy_axis_string>` **(** :ref:`int<class_int>` axis_index **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_joy_button_index_from_string<class_Input_get_joy_button_index_from_string>` **(** :ref:`String<class_string>` button **)** |
|
| :ref:`int<class_int>` | :ref:`get_joy_button_index_from_string<class_Input_get_joy_button_index_from_string>` **(** :ref:`String<class_string>` button **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`get_joy_button_string<class_Input_get_joy_button_string>` **(** :ref:`int<class_int>` button_index **)** |
|
| :ref:`String<class_string>` | :ref:`get_joy_button_string<class_Input_get_joy_button_string>` **(** :ref:`int<class_int>` button_index **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :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_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:`String<class_string>` | :ref:`get_joy_name<class_Input_get_joy_name>` **(** :ref:`int<class_int>` device **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_joy_vibration_duration<class_Input_get_joy_vibration_duration>` **(** :ref:`int<class_int>` device **)** |
|
| :ref:`float<class_float>` | :ref:`get_joy_vibration_duration<class_Input_get_joy_vibration_duration>` **(** :ref:`int<class_int>` device **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_joy_vibration_strength<class_Input_get_joy_vibration_strength>` **(** :ref:`int<class_int>` device **)** |
|
| :ref:`Vector2<class_vector2>` | :ref:`get_joy_vibration_strength<class_Input_get_joy_vibration_strength>` **(** :ref:`int<class_int>` device **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_last_mouse_speed<class_Input_get_last_mouse_speed>` **(** **)** const |
|
| :ref:`Vector2<class_vector2>` | :ref:`get_last_mouse_speed<class_Input_get_last_mouse_speed>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector3<class_vector3>` | :ref:`get_magnetometer<class_Input_get_magnetometer>` **(** **)** const |
|
| :ref:`Vector3<class_vector3>` | :ref:`get_magnetometer<class_Input_get_magnetometer>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_mouse_button_mask<class_Input_get_mouse_button_mask>` **(** **)** const |
|
| :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:`int<class_int>` | :ref:`get_mouse_mode<class_Input_get_mouse_mode>` **(** **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_action_just_pressed<class_Input_is_action_just_pressed>` **(** :ref:`String<class_string>` action **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_action_just_pressed<class_Input_is_action_just_pressed>` **(** :ref:`String<class_string>` action **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_action_just_released<class_Input_is_action_just_released>` **(** :ref:`String<class_string>` action **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_action_just_released<class_Input_is_action_just_released>` **(** :ref:`String<class_string>` action **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_action_pressed<class_Input_is_action_pressed>` **(** :ref:`String<class_string>` action **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_action_pressed<class_Input_is_action_pressed>` **(** :ref:`String<class_string>` action **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :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 **)** const |
|
| :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 **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_joy_known<class_Input_is_joy_known>` **(** :ref:`int<class_int>` device **)** |
|
| :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 **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_key_pressed<class_Input_is_key_pressed>` **(** :ref:`int<class_int>` scancode **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_mouse_button_pressed<class_Input_is_mouse_button_pressed>` **(** :ref:`int<class_int>` button **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_mouse_button_pressed<class_Input_is_mouse_button_pressed>` **(** :ref:`int<class_int>` button **)** const |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`parse_input_event<class_Input_parse_input_event>` **(** :ref:`Object<class_object>` event **)** |
|
| void | :ref:`parse_input_event<class_Input_parse_input_event>` **(** :ref:`InputEvent<class_inputevent>` event **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`remove_joy_mapping<class_Input_remove_joy_mapping>` **(** :ref:`String<class_string>` guid **)** |
|
| 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_custom_mouse_cursor<class_Input_set_custom_mouse_cursor>` **(** :ref:`Resource<class_resource>` image, :ref:`Vector2<class_vector2>` hotspot=null **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_mouse_mode<class_Input_set_mouse_mode>` **(** :ref:`int<class_int>` mode **)** |
|
| void | :ref:`set_mouse_mode<class_Input_set_mouse_mode>` **(** :ref:`int<class_int>` mode **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`start_joy_vibration<class_Input_start_joy_vibration>` **(** :ref:`int<class_int>` device, :ref:`float<class_float>` weak_magnitude, :ref:`float<class_float>` strong_magnitude, :ref:`float<class_float>` duration=0 **)** |
|
| void | :ref:`start_joy_vibration<class_Input_start_joy_vibration>` **(** :ref:`int<class_int>` device, :ref:`float<class_float>` weak_magnitude, :ref:`float<class_float>` strong_magnitude, :ref:`float<class_float>` duration=null **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`stop_joy_vibration<class_Input_stop_joy_vibration>` **(** :ref:`int<class_int>` device **)** |
|
| void | :ref:`stop_joy_vibration<class_Input_stop_joy_vibration>` **(** :ref:`int<class_int>` device **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`warp_mouse_pos<class_Input_warp_mouse_pos>` **(** :ref:`Vector2<class_vector2>` to **)** |
|
| void | :ref:`warp_mouse_pos<class_Input_warp_mouse_pos>` **(** :ref:`Vector2<class_vector2>` to **)** |
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Signals
|
Signals
|
||||||
-------
|
-------
|
||||||
@@ -127,7 +127,7 @@ If the specified action is already pressed, this will release it.
|
|||||||
|
|
||||||
.. _class_Input_add_joy_mapping:
|
.. _class_Input_add_joy_mapping:
|
||||||
|
|
||||||
- void **add_joy_mapping** **(** :ref:`String<class_string>` mapping, :ref:`bool<class_bool>` update_existing=false **)**
|
- void **add_joy_mapping** **(** :ref:`String<class_string>` mapping, :ref:`bool<class_bool>` update_existing=null **)**
|
||||||
|
|
||||||
Add a new mapping entry (in SDL2 format) to the mapping database. Optionally update already connected devices.
|
Add a new mapping entry (in SDL2 format) to the mapping database. Optionally update already connected devices.
|
||||||
|
|
||||||
@@ -263,7 +263,7 @@ Returns true or false depending on whether mouse button is pressed or not. You c
|
|||||||
|
|
||||||
.. _class_Input_parse_input_event:
|
.. _class_Input_parse_input_event:
|
||||||
|
|
||||||
- void **parse_input_event** **(** :ref:`Object<class_object>` event **)**
|
- void **parse_input_event** **(** :ref:`InputEvent<class_inputevent>` event **)**
|
||||||
|
|
||||||
.. _class_Input_remove_joy_mapping:
|
.. _class_Input_remove_joy_mapping:
|
||||||
|
|
||||||
@@ -273,9 +273,7 @@ Removes all mappings from the internal db that match the given uid.
|
|||||||
|
|
||||||
.. _class_Input_set_custom_mouse_cursor:
|
.. _class_Input_set_custom_mouse_cursor:
|
||||||
|
|
||||||
- void **set_custom_mouse_cursor** **(** :ref:`Texture<class_texture>` image, :ref:`Vector2<class_vector2>` hotspot=Vector2(0, 0) **)**
|
- void **set_custom_mouse_cursor** **(** :ref:`Resource<class_resource>` image, :ref:`Vector2<class_vector2>` hotspot=null **)**
|
||||||
|
|
||||||
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:
|
.. _class_Input_set_mouse_mode:
|
||||||
|
|
||||||
@@ -285,7 +283,7 @@ Set the mouse mode. See the constants for more information.
|
|||||||
|
|
||||||
.. _class_Input_start_joy_vibration:
|
.. _class_Input_start_joy_vibration:
|
||||||
|
|
||||||
- void **start_joy_vibration** **(** :ref:`int<class_int>` device, :ref:`float<class_float>` weak_magnitude, :ref:`float<class_float>` strong_magnitude, :ref:`float<class_float>` duration=0 **)**
|
- void **start_joy_vibration** **(** :ref:`int<class_int>` device, :ref:`float<class_float>` weak_magnitude, :ref:`float<class_float>` strong_magnitude, :ref:`float<class_float>` duration=null **)**
|
||||||
|
|
||||||
Starts to vibrate the joypad. Joypads usually come with two rumble motors, a strong and a weak one. weak_magnitude is the strength of the weak motor (between 0 and 1) and strong_magnitude is the strength of the strong motor (between 0 and 1). duration is the duration of the effect in seconds (a duration of 0 will try to play the vibration indefinitely).
|
Starts to vibrate the joypad. Joypads usually come with two rumble motors, a strong and a weak one. weak_magnitude is the strength of the weak motor (between 0 and 1) and strong_magnitude is the strength of the strong motor (between 0 and 1). duration is the duration of the effect in seconds (a duration of 0 will try to play the vibration indefinitely).
|
||||||
|
|
||||||
|
|||||||
@@ -20,35 +20,35 @@ Brief Description
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`action_match<class_InputEvent_action_match>` **(** :ref:`InputEvent<class_inputevent>` event **)** const |
|
| :ref:`bool<class_bool>` | :ref:`action_match<class_InputEvent_action_match>` **(** :ref:`InputEvent<class_inputevent>` event **)** const |
|
||||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`as_text<class_InputEvent_as_text>` **(** **)** const |
|
| :ref:`String<class_string>` | :ref:`as_text<class_InputEvent_as_text>` **(** **)** const |
|
||||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_device<class_InputEvent_get_device>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_device<class_InputEvent_get_device>` **(** **)** const |
|
||||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_id<class_InputEvent_get_id>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_id<class_InputEvent_get_id>` **(** **)** const |
|
||||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_action<class_InputEvent_is_action>` **(** :ref:`String<class_string>` action **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_action<class_InputEvent_is_action>` **(** :ref:`String<class_string>` action **)** const |
|
||||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_action_pressed<class_InputEvent_is_action_pressed>` **(** :ref:`String<class_string>` action **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_action_pressed<class_InputEvent_is_action_pressed>` **(** :ref:`String<class_string>` action **)** const |
|
||||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_action_released<class_InputEvent_is_action_released>` **(** :ref:`String<class_string>` action **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_action_released<class_InputEvent_is_action_released>` **(** :ref:`String<class_string>` action **)** const |
|
||||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_action_type<class_InputEvent_is_action_type>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_action_type<class_InputEvent_is_action_type>` **(** **)** const |
|
||||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_echo<class_InputEvent_is_echo>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_echo<class_InputEvent_is_echo>` **(** **)** const |
|
||||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_pressed<class_InputEvent_is_pressed>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_pressed<class_InputEvent_is_pressed>` **(** **)** const |
|
||||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_device<class_InputEvent_set_device>` **(** :ref:`int<class_int>` device **)** |
|
| void | :ref:`set_device<class_InputEvent_set_device>` **(** :ref:`int<class_int>` device **)** |
|
||||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_id<class_InputEvent_set_id>` **(** :ref:`int<class_int>` id **)** |
|
| void | :ref:`set_id<class_InputEvent_set_id>` **(** :ref:`int<class_int>` id **)** |
|
||||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`shortcut_match<class_InputEvent_shortcut_match>` **(** :ref:`InputEvent<class_inputevent>` event **)** const |
|
| :ref:`bool<class_bool>` | :ref:`shortcut_match<class_InputEvent_shortcut_match>` **(** :ref:`InputEvent<class_inputevent>` event **)** const |
|
||||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`InputEvent<class_inputevent>` | :ref:`xformed_by<class_InputEvent_xformed_by>` **(** :ref:`Transform2D<class_transform2d>` xform, :ref:`Vector2<class_vector2>` local_ofs=Vector2(0, 0) **)** const |
|
| :ref:`InputEvent<class_inputevent>` | :ref:`xformed_by<class_InputEvent_xformed_by>` **(** :ref:`Transform2D<class_transform2d>` xform, :ref:`Vector2<class_vector2>` local_ofs=null **)** const |
|
||||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
@@ -122,6 +122,6 @@ Return if this input event is pressed. Not relevant for the event types MOUSE_MO
|
|||||||
|
|
||||||
.. _class_InputEvent_xformed_by:
|
.. _class_InputEvent_xformed_by:
|
||||||
|
|
||||||
- :ref:`InputEvent<class_inputevent>` **xformed_by** **(** :ref:`Transform2D<class_transform2d>` xform, :ref:`Vector2<class_vector2>` local_ofs=Vector2(0, 0) **)** const
|
- :ref:`InputEvent<class_inputevent>` **xformed_by** **(** :ref:`Transform2D<class_transform2d>` xform, :ref:`Vector2<class_vector2>` local_ofs=null **)** const
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -37,7 +37,7 @@ Member Functions
|
|||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
- :ref:`int<class_int>` **echo** - Echo state of the key, i.e. whether it's a repeat event or not.
|
- :ref:`bool<class_bool>` **echo** - Echo state of the key, i.e. whether it's a repeat event or not.
|
||||||
- :ref:`bool<class_bool>` **pressed** - Pressed state of the key.
|
- :ref:`bool<class_bool>` **pressed** - Pressed state of the key.
|
||||||
- :ref:`int<class_int>` **scancode** - Scancode of the key, one of the KEY_* constants in [@Global Scope].
|
- :ref:`int<class_int>` **scancode** - Scancode of the key, one of the KEY_* constants in [@Global Scope].
|
||||||
- :ref:`int<class_int>` **unicode** - Unicode identifier of the key (when relevant).
|
- :ref:`int<class_int>` **unicode** - Unicode identifier of the key (when relevant).
|
||||||
|
|||||||
@@ -18,46 +18,46 @@ Singleton that manages actions.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`action_add_event<class_InputMap_action_add_event>` **(** :ref:`String<class_string>` action, :ref:`Object<class_object>` event **)** |
|
| void | :ref:`action_add_event<class_InputMap_action_add_event>` **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)** |
|
||||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`action_erase_event<class_InputMap_action_erase_event>` **(** :ref:`String<class_string>` action, :ref:`Object<class_object>` event **)** |
|
| void | :ref:`action_erase_event<class_InputMap_action_erase_event>` **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)** |
|
||||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`action_has_event<class_InputMap_action_has_event>` **(** :ref:`String<class_string>` action, :ref:`Object<class_object>` event **)** |
|
| :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:`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:`erase_action<class_InputMap_erase_action>` **(** :ref:`String<class_string>` action **)** |
|
||||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`event_is_action<class_InputMap_event_is_action>` **(** :ref:`Object<class_object>` event, :ref:`String<class_string>` action **)** const |
|
| :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_action_list<class_InputMap_get_action_list>` **(** :ref:`String<class_string>` action **)** |
|
| :ref:`Array<class_array>` | :ref:`get_action_list<class_InputMap_get_action_list>` **(** :ref:`String<class_string>` action **)** |
|
||||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Array<class_array>` | :ref:`get_actions<class_InputMap_get_actions>` **(** **)** |
|
| :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 |
|
| :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>` **(** **)** |
|
| void | :ref:`load_from_globals<class_InputMap_load_from_globals>` **(** **)** |
|
||||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Member Function Description
|
Member Function Description
|
||||||
---------------------------
|
---------------------------
|
||||||
|
|
||||||
.. _class_InputMap_action_add_event:
|
.. _class_InputMap_action_add_event:
|
||||||
|
|
||||||
- void **action_add_event** **(** :ref:`String<class_string>` action, :ref:`Object<class_object>` event **)**
|
- void **action_add_event** **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)**
|
||||||
|
|
||||||
Add an :ref:`InputEvent<class_inputevent>` to an action. This :ref:`InputEvent<class_inputevent>` will trigger the action.
|
Add an :ref:`InputEvent<class_inputevent>` to an action. This :ref:`InputEvent<class_inputevent>` will trigger the action.
|
||||||
|
|
||||||
.. _class_InputMap_action_erase_event:
|
.. _class_InputMap_action_erase_event:
|
||||||
|
|
||||||
- void **action_erase_event** **(** :ref:`String<class_string>` action, :ref:`Object<class_object>` event **)**
|
- void **action_erase_event** **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)**
|
||||||
|
|
||||||
Remove an :ref:`InputEvent<class_inputevent>` from an action.
|
Remove an :ref:`InputEvent<class_inputevent>` from an action.
|
||||||
|
|
||||||
.. _class_InputMap_action_has_event:
|
.. _class_InputMap_action_has_event:
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **action_has_event** **(** :ref:`String<class_string>` action, :ref:`Object<class_object>` event **)**
|
- :ref:`bool<class_bool>` **action_has_event** **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)**
|
||||||
|
|
||||||
Whether an action has an :ref:`InputEvent<class_inputevent>` associated with it.
|
Whether an action has an :ref:`InputEvent<class_inputevent>` associated with it.
|
||||||
|
|
||||||
@@ -75,7 +75,7 @@ Remove an action from the :ref:`InputMap<class_inputmap>`.
|
|||||||
|
|
||||||
.. _class_InputMap_event_is_action:
|
.. _class_InputMap_event_is_action:
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **event_is_action** **(** :ref:`Object<class_object>` event, :ref:`String<class_string>` action **)** const
|
- :ref:`bool<class_bool>` **event_is_action** **(** :ref:`InputEvent<class_inputevent>` event, :ref:`String<class_string>` action **)** const
|
||||||
|
|
||||||
Return whether the given event is part of an existing action. This method ignores keyboard modifiers if the given :ref:`InputEvent<class_inputevent>` is not pressed (for proper release detection). See :ref:`action_has_event<class_InputMap_action_has_event>` if you don't want this behavior.
|
Return whether the given event is part of an existing action. This method ignores keyboard modifiers if the given :ref:`InputEvent<class_inputevent>` is not pressed (for proper release detection). See :ref:`action_has_event<class_InputMap_action_has_event>` if you don't want this behavior.
|
||||||
|
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ Member Functions
|
|||||||
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Dictionary<class_dictionary>` | :ref:`get_stored_values<class_InstancePlaceholder_get_stored_values>` **(** :ref:`bool<class_bool>` with_order=false **)** |
|
| :ref:`Dictionary<class_dictionary>` | :ref:`get_stored_values<class_InstancePlaceholder_get_stored_values>` **(** :ref:`bool<class_bool>` with_order=false **)** |
|
||||||
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`replace_by_instance<class_InstancePlaceholder_replace_by_instance>` **(** :ref:`PackedScene<class_packedscene>` custom_scene=NULL **)** |
|
| void | :ref:`replace_by_instance<class_InstancePlaceholder_replace_by_instance>` **(** :ref:`PackedScene<class_packedscene>` custom_scene=null **)** |
|
||||||
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Description
|
Description
|
||||||
@@ -48,7 +48,7 @@ Retrieve the path to the :ref:`PackedScene<class_packedscene>` resource file tha
|
|||||||
|
|
||||||
.. _class_InstancePlaceholder_replace_by_instance:
|
.. _class_InstancePlaceholder_replace_by_instance:
|
||||||
|
|
||||||
- void **replace_by_instance** **(** :ref:`PackedScene<class_packedscene>` custom_scene=NULL **)**
|
- void **replace_by_instance** **(** :ref:`PackedScene<class_packedscene>` custom_scene=null **)**
|
||||||
|
|
||||||
Replace this placeholder by the scene handed as an argument, or the original scene if no argument is given. As for all resources, the scene is loaded only if it's not loaded already. By manually loading the scene beforehand, delays caused by this function can be avoided.
|
Replace this placeholder by the scene handed as an argument, or the original scene if no argument is given. As for all resources, the scene is loaded only if it's not loaded already. By manually loading the scene beforehand, delays caused by this function can be avoided.
|
||||||
|
|
||||||
|
|||||||
@@ -29,7 +29,7 @@ Member Functions
|
|||||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_speed<class_InterpolatedCamera_set_speed>` **(** :ref:`float<class_float>` speed **)** |
|
| void | :ref:`set_speed<class_InterpolatedCamera_set_speed>` **(** :ref:`float<class_float>` speed **)** |
|
||||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_target<class_InterpolatedCamera_set_target>` **(** :ref:`Camera<class_camera>` target **)** |
|
| void | :ref:`set_target<class_InterpolatedCamera_set_target>` **(** :ref:`Object<class_object>` target **)** |
|
||||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_target_path<class_InterpolatedCamera_set_target_path>` **(** :ref:`NodePath<class_nodepath>` target_path **)** |
|
| void | :ref:`set_target_path<class_InterpolatedCamera_set_target_path>` **(** :ref:`NodePath<class_nodepath>` target_path **)** |
|
||||||
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -66,7 +66,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_InterpolatedCamera_set_target:
|
.. _class_InterpolatedCamera_set_target:
|
||||||
|
|
||||||
- void **set_target** **(** :ref:`Camera<class_camera>` target **)**
|
- void **set_target** **(** :ref:`Object<class_object>` target **)**
|
||||||
|
|
||||||
.. _class_InterpolatedCamera_set_target_path:
|
.. _class_InterpolatedCamera_set_target_path:
|
||||||
|
|
||||||
|
|||||||
@@ -20,21 +20,21 @@ IP Protocol support functions.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`clear_cache<class_IP_clear_cache>` **(** :ref:`String<class_string>` arg0="" **)** |
|
| void | :ref:`clear_cache<class_IP_clear_cache>` **(** :ref:`String<class_string>` hostname="" **)** |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`erase_resolve_item<class_IP_erase_resolve_item>` **(** :ref:`int<class_int>` id **)** |
|
| void | :ref:`erase_resolve_item<class_IP_erase_resolve_item>` **(** :ref:`int<class_int>` id **)** |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Array<class_array>` | :ref:`get_local_addresses<class_IP_get_local_addresses>` **(** **)** const |
|
| :ref:`Array<class_array>` | :ref:`get_local_addresses<class_IP_get_local_addresses>` **(** **)** const |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`get_resolve_item_address<class_IP_get_resolve_item_address>` **(** :ref:`int<class_int>` id **)** const |
|
| :ref:`String<class_string>` | :ref:`get_resolve_item_address<class_IP_get_resolve_item_address>` **(** :ref:`int<class_int>` id **)** const |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_resolve_item_status<class_IP_get_resolve_item_status>` **(** :ref:`int<class_int>` id **)** const |
|
| :ref:`int<class_int>` | :ref:`get_resolve_item_status<class_IP_get_resolve_item_status>` **(** :ref:`int<class_int>` id **)** const |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`resolve_hostname<class_IP_resolve_hostname>` **(** :ref:`String<class_string>` host, :ref:`int<class_int>` ip_type=3 **)** |
|
| :ref:`String<class_string>` | :ref:`resolve_hostname<class_IP_resolve_hostname>` **(** :ref:`String<class_string>` host, :ref:`int<class_int>` ip_type=null **)** |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`resolve_hostname_queue_item<class_IP_resolve_hostname_queue_item>` **(** :ref:`String<class_string>` host, :ref:`int<class_int>` ip_type=3 **)** |
|
| :ref:`int<class_int>` | :ref:`resolve_hostname_queue_item<class_IP_resolve_hostname_queue_item>` **(** :ref:`String<class_string>` host, :ref:`int<class_int>` ip_type=null **)** |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Numeric Constants
|
Numeric Constants
|
||||||
-----------------
|
-----------------
|
||||||
@@ -60,7 +60,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_IP_clear_cache:
|
.. _class_IP_clear_cache:
|
||||||
|
|
||||||
- void **clear_cache** **(** :ref:`String<class_string>` arg0="" **)**
|
- void **clear_cache** **(** :ref:`String<class_string>` hostname="" **)**
|
||||||
|
|
||||||
.. _class_IP_erase_resolve_item:
|
.. _class_IP_erase_resolve_item:
|
||||||
|
|
||||||
@@ -86,13 +86,13 @@ Return the status of hostname queued for resolving, given its queue ID. Returned
|
|||||||
|
|
||||||
.. _class_IP_resolve_hostname:
|
.. _class_IP_resolve_hostname:
|
||||||
|
|
||||||
- :ref:`String<class_string>` **resolve_hostname** **(** :ref:`String<class_string>` host, :ref:`int<class_int>` ip_type=3 **)**
|
- :ref:`String<class_string>` **resolve_hostname** **(** :ref:`String<class_string>` host, :ref:`int<class_int>` ip_type=null **)**
|
||||||
|
|
||||||
Resolve a given hostname, blocking. Resolved hostname is returned as an IPv4 or IPv6 depending on "ip_type".
|
Resolve a given hostname, blocking. Resolved hostname is returned as an IPv4 or IPv6 depending on "ip_type".
|
||||||
|
|
||||||
.. _class_IP_resolve_hostname_queue_item:
|
.. _class_IP_resolve_hostname_queue_item:
|
||||||
|
|
||||||
- :ref:`int<class_int>` **resolve_hostname_queue_item** **(** :ref:`String<class_string>` host, :ref:`int<class_int>` ip_type=3 **)**
|
- :ref:`int<class_int>` **resolve_hostname_queue_item** **(** :ref:`String<class_string>` host, :ref:`int<class_int>` ip_type=null **)**
|
||||||
|
|
||||||
Create a queue item for resolving a given hostname to an IPv4 or IPv6 depending on "ip_type". The queue ID is returned, or RESOLVER_INVALID_ID on error.
|
Create a queue item for resolving a given hostname to an IPv4 or IPv6 depending on "ip_type". The queue ID is returned, or RESOLVER_INVALID_ID on error.
|
||||||
|
|
||||||
|
|||||||
@@ -19,9 +19,9 @@ Member Functions
|
|||||||
----------------
|
----------------
|
||||||
|
|
||||||
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`add_icon_item<class_ItemList_add_icon_item>` **(** :ref:`Texture<class_texture>` icon, :ref:`bool<class_bool>` selectable=true **)** |
|
| void | :ref:`add_icon_item<class_ItemList_add_icon_item>` **(** :ref:`Texture<class_texture>` icon, :ref:`bool<class_bool>` selectable=null **)** |
|
||||||
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`add_item<class_ItemList_add_item>` **(** :ref:`String<class_string>` text, :ref:`Texture<class_texture>` icon=NULL, :ref:`bool<class_bool>` selectable=true **)** |
|
| void | :ref:`add_item<class_ItemList_add_item>` **(** :ref:`String<class_string>` text, :ref:`Texture<class_texture>` icon=null, :ref:`bool<class_bool>` selectable=null **)** |
|
||||||
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`clear<class_ItemList_clear>` **(** **)** |
|
| void | :ref:`clear<class_ItemList_clear>` **(** **)** |
|
||||||
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -37,7 +37,7 @@ Member Functions
|
|||||||
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_icon_scale<class_ItemList_get_icon_scale>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_icon_scale<class_ItemList_get_icon_scale>` **(** **)** const |
|
||||||
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_item_at_pos<class_ItemList_get_item_at_pos>` **(** :ref:`Vector2<class_vector2>` pos, :ref:`bool<class_bool>` exact=false **)** const |
|
| :ref:`int<class_int>` | :ref:`get_item_at_pos<class_ItemList_get_item_at_pos>` **(** :ref:`Vector2<class_vector2>` pos, :ref:`bool<class_bool>` exact=null **)** const |
|
||||||
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_item_count<class_ItemList_get_item_count>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_item_count<class_ItemList_get_item_count>` **(** **)** const |
|
||||||
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -61,7 +61,9 @@ Member Functions
|
|||||||
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`PoolIntArray<class_poolintarray>` | :ref:`get_selected_items<class_ItemList_get_selected_items>` **(** **)** |
|
| :ref:`PoolIntArray<class_poolintarray>` | :ref:`get_selected_items<class_ItemList_get_selected_items>` **(** **)** |
|
||||||
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Object<class_object>` | :ref:`get_v_scroll<class_ItemList_get_v_scroll>` **(** **)** |
|
| :ref:`VScrollBar<class_vscrollbar>` | :ref:`get_v_scroll<class_ItemList_get_v_scroll>` **(** **)** |
|
||||||
|
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`bool<class_bool>` | :ref:`has_auto_height<class_ItemList_has_auto_height>` **(** **)** const |
|
||||||
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_item_disabled<class_ItemList_is_item_disabled>` **(** :ref:`int<class_int>` idx **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_item_disabled<class_ItemList_is_item_disabled>` **(** :ref:`int<class_int>` idx **)** const |
|
||||||
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -69,16 +71,18 @@ Member Functions
|
|||||||
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_item_tooltip_enabled<class_ItemList_is_item_tooltip_enabled>` **(** :ref:`int<class_int>` idx **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_item_tooltip_enabled<class_ItemList_is_item_tooltip_enabled>` **(** :ref:`int<class_int>` idx **)** const |
|
||||||
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`is_same_column_width<class_ItemList_is_same_column_width>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_same_column_width<class_ItemList_is_same_column_width>` **(** **)** const |
|
||||||
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_selected<class_ItemList_is_selected>` **(** :ref:`int<class_int>` idx **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_selected<class_ItemList_is_selected>` **(** :ref:`int<class_int>` idx **)** const |
|
||||||
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`remove_item<class_ItemList_remove_item>` **(** :ref:`int<class_int>` idx **)** |
|
| void | :ref:`remove_item<class_ItemList_remove_item>` **(** :ref:`int<class_int>` idx **)** |
|
||||||
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`select<class_ItemList_select>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` single=true **)** |
|
| void | :ref:`select<class_ItemList_select>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` single=null **)** |
|
||||||
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_allow_rmb_select<class_ItemList_set_allow_rmb_select>` **(** :ref:`bool<class_bool>` allow **)** |
|
| void | :ref:`set_allow_rmb_select<class_ItemList_set_allow_rmb_select>` **(** :ref:`bool<class_bool>` allow **)** |
|
||||||
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`set_auto_height<class_ItemList_set_auto_height>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||||
|
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_fixed_column_width<class_ItemList_set_fixed_column_width>` **(** :ref:`int<class_int>` width **)** |
|
| void | :ref:`set_fixed_column_width<class_ItemList_set_fixed_column_width>` **(** :ref:`int<class_int>` width **)** |
|
||||||
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_fixed_icon_size<class_ItemList_set_fixed_icon_size>` **(** :ref:`Vector2<class_vector2>` size **)** |
|
| void | :ref:`set_fixed_icon_size<class_ItemList_set_fixed_icon_size>` **(** :ref:`Vector2<class_vector2>` size **)** |
|
||||||
@@ -142,6 +146,7 @@ Member Variables
|
|||||||
----------------
|
----------------
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **allow_rmb_select**
|
- :ref:`bool<class_bool>` **allow_rmb_select**
|
||||||
|
- :ref:`bool<class_bool>` **auto_height**
|
||||||
- :ref:`int<class_int>` **fixed_column_width**
|
- :ref:`int<class_int>` **fixed_column_width**
|
||||||
- :ref:`int<class_int>` **icon_mode**
|
- :ref:`int<class_int>` **icon_mode**
|
||||||
- :ref:`float<class_float>` **icon_scale**
|
- :ref:`float<class_float>` **icon_scale**
|
||||||
@@ -175,13 +180,13 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_ItemList_add_icon_item:
|
.. _class_ItemList_add_icon_item:
|
||||||
|
|
||||||
- void **add_icon_item** **(** :ref:`Texture<class_texture>` icon, :ref:`bool<class_bool>` selectable=true **)**
|
- void **add_icon_item** **(** :ref:`Texture<class_texture>` icon, :ref:`bool<class_bool>` selectable=null **)**
|
||||||
|
|
||||||
Adds an item to the item list with no text, only an icon.
|
Adds an item to the item list with no text, only an icon.
|
||||||
|
|
||||||
.. _class_ItemList_add_item:
|
.. _class_ItemList_add_item:
|
||||||
|
|
||||||
- void **add_item** **(** :ref:`String<class_string>` text, :ref:`Texture<class_texture>` icon=NULL, :ref:`bool<class_bool>` selectable=true **)**
|
- void **add_item** **(** :ref:`String<class_string>` text, :ref:`Texture<class_texture>` icon=null, :ref:`bool<class_bool>` selectable=null **)**
|
||||||
|
|
||||||
Adds an item to the item list with specified text. Specify an icon of null for a list item with no icon.
|
Adds an item to the item list with specified text. Specify an icon of null for a list item with no icon.
|
||||||
|
|
||||||
@@ -225,7 +230,7 @@ If column size has been fixed to a value, return that value.
|
|||||||
|
|
||||||
.. _class_ItemList_get_item_at_pos:
|
.. _class_ItemList_get_item_at_pos:
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_item_at_pos** **(** :ref:`Vector2<class_vector2>` pos, :ref:`bool<class_bool>` exact=false **)** const
|
- :ref:`int<class_int>` **get_item_at_pos** **(** :ref:`Vector2<class_vector2>` pos, :ref:`bool<class_bool>` exact=null **)** const
|
||||||
|
|
||||||
Given a position within the control return the item (if any) at that point.
|
Given a position within the control return the item (if any) at that point.
|
||||||
|
|
||||||
@@ -287,10 +292,14 @@ Returns the list of selected indexes.
|
|||||||
|
|
||||||
.. _class_ItemList_get_v_scroll:
|
.. _class_ItemList_get_v_scroll:
|
||||||
|
|
||||||
- :ref:`Object<class_object>` **get_v_scroll** **(** **)**
|
- :ref:`VScrollBar<class_vscrollbar>` **get_v_scroll** **(** **)**
|
||||||
|
|
||||||
Returns the current vertical scroll bar for the List.
|
Returns the current vertical scroll bar for the List.
|
||||||
|
|
||||||
|
.. _class_ItemList_has_auto_height:
|
||||||
|
|
||||||
|
- :ref:`bool<class_bool>` **has_auto_height** **(** **)** const
|
||||||
|
|
||||||
.. _class_ItemList_is_item_disabled:
|
.. _class_ItemList_is_item_disabled:
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_item_disabled** **(** :ref:`int<class_int>` idx **)** const
|
- :ref:`bool<class_bool>` **is_item_disabled** **(** :ref:`int<class_int>` idx **)** const
|
||||||
@@ -311,7 +320,7 @@ Returns whether the tooptip is enabled for specified item index.
|
|||||||
|
|
||||||
.. _class_ItemList_is_same_column_width:
|
.. _class_ItemList_is_same_column_width:
|
||||||
|
|
||||||
- :ref:`int<class_int>` **is_same_column_width** **(** **)** const
|
- :ref:`bool<class_bool>` **is_same_column_width** **(** **)** const
|
||||||
|
|
||||||
Returns whether or not all columns of the list are of the same size.
|
Returns whether or not all columns of the list are of the same size.
|
||||||
|
|
||||||
@@ -329,7 +338,7 @@ Remove item at specified index from the list.
|
|||||||
|
|
||||||
.. _class_ItemList_select:
|
.. _class_ItemList_select:
|
||||||
|
|
||||||
- void **select** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` single=true **)**
|
- void **select** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` single=null **)**
|
||||||
|
|
||||||
Select the item at the specified index.
|
Select the item at the specified index.
|
||||||
|
|
||||||
@@ -341,6 +350,10 @@ Note: This method does not trigger the item selection signal.
|
|||||||
|
|
||||||
Allow (or disallow) selection of (selectable) items in the list using right mouse button.
|
Allow (or disallow) selection of (selectable) items in the list using right mouse button.
|
||||||
|
|
||||||
|
.. _class_ItemList_set_auto_height:
|
||||||
|
|
||||||
|
- void **set_auto_height** **(** :ref:`bool<class_bool>` enable **)**
|
||||||
|
|
||||||
.. _class_ItemList_set_fixed_column_width:
|
.. _class_ItemList_set_fixed_column_width:
|
||||||
|
|
||||||
- void **set_fixed_column_width** **(** :ref:`int<class_int>` width **)**
|
- void **set_fixed_column_width** **(** :ref:`int<class_int>` width **)**
|
||||||
|
|||||||
@@ -18,49 +18,49 @@ Kinematic body 3D node.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Object<class_object>` | :ref:`get_collision_collider<class_KinematicBody_get_collision_collider>` **(** :ref:`int<class_int>` collision **)** const |
|
| :ref:`Object<class_object>` | :ref:`get_collision_collider<class_KinematicBody_get_collision_collider>` **(** :ref:`int<class_int>` collision **)** const |
|
||||||
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_collision_collider_id<class_KinematicBody_get_collision_collider_id>` **(** :ref:`int<class_int>` collision **)** const |
|
| :ref:`int<class_int>` | :ref:`get_collision_collider_id<class_KinematicBody_get_collision_collider_id>` **(** :ref:`int<class_int>` collision **)** const |
|
||||||
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`get_collision_collider_metadata<class_KinematicBody_get_collision_collider_metadata>` **(** :ref:`int<class_int>` collision **)** const |
|
| :ref:`Variant<class_variant>` | :ref:`get_collision_collider_metadata<class_KinematicBody_get_collision_collider_metadata>` **(** :ref:`int<class_int>` collision **)** const |
|
||||||
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Object<class_object>` | :ref:`get_collision_collider_shape<class_KinematicBody_get_collision_collider_shape>` **(** :ref:`int<class_int>` collision **)** const |
|
| :ref:`Object<class_object>` | :ref:`get_collision_collider_shape<class_KinematicBody_get_collision_collider_shape>` **(** :ref:`int<class_int>` collision **)** const |
|
||||||
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_collision_collider_shape_index<class_KinematicBody_get_collision_collider_shape_index>` **(** :ref:`int<class_int>` collision **)** const |
|
| :ref:`int<class_int>` | :ref:`get_collision_collider_shape_index<class_KinematicBody_get_collision_collider_shape_index>` **(** :ref:`int<class_int>` collision **)** const |
|
||||||
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector3<class_vector3>` | :ref:`get_collision_collider_velocity<class_KinematicBody_get_collision_collider_velocity>` **(** :ref:`int<class_int>` collision **)** const |
|
| :ref:`Vector3<class_vector3>` | :ref:`get_collision_collider_velocity<class_KinematicBody_get_collision_collider_velocity>` **(** :ref:`int<class_int>` collision **)** const |
|
||||||
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_collision_count<class_KinematicBody_get_collision_count>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_collision_count<class_KinematicBody_get_collision_count>` **(** **)** const |
|
||||||
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Object<class_object>` | :ref:`get_collision_local_shape<class_KinematicBody_get_collision_local_shape>` **(** :ref:`int<class_int>` collision **)** const |
|
| :ref:`Object<class_object>` | :ref:`get_collision_local_shape<class_KinematicBody_get_collision_local_shape>` **(** :ref:`int<class_int>` collision **)** const |
|
||||||
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector3<class_vector3>` | :ref:`get_collision_normal<class_KinematicBody_get_collision_normal>` **(** :ref:`int<class_int>` collision **)** const |
|
| :ref:`Vector3<class_vector3>` | :ref:`get_collision_normal<class_KinematicBody_get_collision_normal>` **(** :ref:`int<class_int>` collision **)** const |
|
||||||
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector3<class_vector3>` | :ref:`get_collision_position<class_KinematicBody_get_collision_position>` **(** :ref:`int<class_int>` collision **)** const |
|
| :ref:`Vector3<class_vector3>` | :ref:`get_collision_position<class_KinematicBody_get_collision_position>` **(** :ref:`int<class_int>` collision **)** const |
|
||||||
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector3<class_vector3>` | :ref:`get_collision_remainder<class_KinematicBody_get_collision_remainder>` **(** :ref:`int<class_int>` collision **)** const |
|
| :ref:`Vector3<class_vector3>` | :ref:`get_collision_remainder<class_KinematicBody_get_collision_remainder>` **(** :ref:`int<class_int>` collision **)** const |
|
||||||
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector3<class_vector3>` | :ref:`get_collision_travel<class_KinematicBody_get_collision_travel>` **(** :ref:`int<class_int>` collision **)** const |
|
| :ref:`Vector3<class_vector3>` | :ref:`get_collision_travel<class_KinematicBody_get_collision_travel>` **(** :ref:`int<class_int>` collision **)** const |
|
||||||
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector3<class_vector3>` | :ref:`get_floor_velocity<class_KinematicBody_get_floor_velocity>` **(** **)** const |
|
| :ref:`Vector3<class_vector3>` | :ref:`get_floor_velocity<class_KinematicBody_get_floor_velocity>` **(** **)** const |
|
||||||
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_safe_margin<class_KinematicBody_get_safe_margin>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_safe_margin<class_KinematicBody_get_safe_margin>` **(** **)** const |
|
||||||
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_on_ceiling<class_KinematicBody_is_on_ceiling>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_on_ceiling<class_KinematicBody_is_on_ceiling>` **(** **)** const |
|
||||||
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_on_floor<class_KinematicBody_is_on_floor>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_on_floor<class_KinematicBody_is_on_floor>` **(** **)** const |
|
||||||
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_on_wall<class_KinematicBody_is_on_wall>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_on_wall<class_KinematicBody_is_on_wall>` **(** **)** const |
|
||||||
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Dictionary<class_dictionary>` | :ref:`move<class_KinematicBody_move>` **(** :ref:`Vector3<class_vector3>` rel_vec **)** |
|
| :ref:`Dictionary<class_dictionary>` | :ref:`move<class_KinematicBody_move>` **(** :ref:`Vector3<class_vector3>` rel_vec **)** |
|
||||||
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector3<class_vector3>` | :ref:`move_and_slide<class_KinematicBody_move_and_slide>` **(** :ref:`Vector3<class_vector3>` linear_velocity, :ref:`Vector3<class_vector3>` floor_normal=Vector3(0, 0, 0), :ref:`float<class_float>` slope_stop_min_velocity=0.05, :ref:`int<class_int>` max_bounces=4, :ref:`float<class_float>` floor_max_angle=0.785398 **)** |
|
| :ref:`Vector3<class_vector3>` | :ref:`move_and_slide<class_KinematicBody_move_and_slide>` **(** :ref:`Vector3<class_vector3>` linear_velocity, :ref:`Vector3<class_vector3>` floor_normal=4, :ref:`float<class_float>` slope_stop_min_velocity=0.05, :ref:`int<class_int>` max_bounces=Vector3( 0, 0, 0 ), :ref:`float<class_float>` floor_max_angle=null **)** |
|
||||||
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_safe_margin<class_KinematicBody_set_safe_margin>` **(** :ref:`float<class_float>` pixels **)** |
|
| void | :ref:`set_safe_margin<class_KinematicBody_set_safe_margin>` **(** :ref:`float<class_float>` pixels **)** |
|
||||||
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`test_move<class_KinematicBody_test_move>` **(** :ref:`Transform<class_transform>` from, :ref:`Vector3<class_vector3>` rel_vec **)** |
|
| :ref:`bool<class_bool>` | :ref:`test_move<class_KinematicBody_test_move>` **(** :ref:`Transform<class_transform>` from, :ref:`Vector3<class_vector3>` rel_vec **)** |
|
||||||
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
@@ -89,7 +89,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_KinematicBody_get_collision_collider_metadata:
|
.. _class_KinematicBody_get_collision_collider_metadata:
|
||||||
|
|
||||||
- void **get_collision_collider_metadata** **(** :ref:`int<class_int>` collision **)** const
|
- :ref:`Variant<class_variant>` **get_collision_collider_metadata** **(** :ref:`int<class_int>` collision **)** const
|
||||||
|
|
||||||
.. _class_KinematicBody_get_collision_collider_shape:
|
.. _class_KinematicBody_get_collision_collider_shape:
|
||||||
|
|
||||||
@@ -173,7 +173,7 @@ If the body did not intersect anything, then an empty dictionary (dir.empty()==t
|
|||||||
|
|
||||||
.. _class_KinematicBody_move_and_slide:
|
.. _class_KinematicBody_move_and_slide:
|
||||||
|
|
||||||
- :ref:`Vector3<class_vector3>` **move_and_slide** **(** :ref:`Vector3<class_vector3>` linear_velocity, :ref:`Vector3<class_vector3>` floor_normal=Vector3(0, 0, 0), :ref:`float<class_float>` slope_stop_min_velocity=0.05, :ref:`int<class_int>` max_bounces=4, :ref:`float<class_float>` floor_max_angle=0.785398 **)**
|
- :ref:`Vector3<class_vector3>` **move_and_slide** **(** :ref:`Vector3<class_vector3>` linear_velocity, :ref:`Vector3<class_vector3>` floor_normal=4, :ref:`float<class_float>` slope_stop_min_velocity=0.05, :ref:`int<class_int>` max_bounces=Vector3( 0, 0, 0 ), :ref:`float<class_float>` floor_max_angle=null **)**
|
||||||
|
|
||||||
.. _class_KinematicBody_set_safe_margin:
|
.. _class_KinematicBody_set_safe_margin:
|
||||||
|
|
||||||
|
|||||||
@@ -18,49 +18,49 @@ Kinematic body 2D node.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Object<class_object>` | :ref:`get_collision_collider<class_KinematicBody2D_get_collision_collider>` **(** :ref:`int<class_int>` collision **)** const |
|
| :ref:`Object<class_object>` | :ref:`get_collision_collider<class_KinematicBody2D_get_collision_collider>` **(** :ref:`int<class_int>` collision **)** const |
|
||||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_collision_collider_id<class_KinematicBody2D_get_collision_collider_id>` **(** :ref:`int<class_int>` collision **)** const |
|
| :ref:`int<class_int>` | :ref:`get_collision_collider_id<class_KinematicBody2D_get_collision_collider_id>` **(** :ref:`int<class_int>` collision **)** const |
|
||||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`get_collision_collider_metadata<class_KinematicBody2D_get_collision_collider_metadata>` **(** :ref:`int<class_int>` collision **)** const |
|
| :ref:`Variant<class_variant>` | :ref:`get_collision_collider_metadata<class_KinematicBody2D_get_collision_collider_metadata>` **(** :ref:`int<class_int>` collision **)** const |
|
||||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Object<class_object>` | :ref:`get_collision_collider_shape<class_KinematicBody2D_get_collision_collider_shape>` **(** :ref:`int<class_int>` collision **)** const |
|
| :ref:`Object<class_object>` | :ref:`get_collision_collider_shape<class_KinematicBody2D_get_collision_collider_shape>` **(** :ref:`int<class_int>` collision **)** const |
|
||||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_collision_collider_shape_index<class_KinematicBody2D_get_collision_collider_shape_index>` **(** :ref:`int<class_int>` collision **)** const |
|
| :ref:`int<class_int>` | :ref:`get_collision_collider_shape_index<class_KinematicBody2D_get_collision_collider_shape_index>` **(** :ref:`int<class_int>` collision **)** const |
|
||||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_collision_collider_velocity<class_KinematicBody2D_get_collision_collider_velocity>` **(** :ref:`int<class_int>` collision **)** const |
|
| :ref:`Vector2<class_vector2>` | :ref:`get_collision_collider_velocity<class_KinematicBody2D_get_collision_collider_velocity>` **(** :ref:`int<class_int>` collision **)** const |
|
||||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_collision_count<class_KinematicBody2D_get_collision_count>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_collision_count<class_KinematicBody2D_get_collision_count>` **(** **)** const |
|
||||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Object<class_object>` | :ref:`get_collision_local_shape<class_KinematicBody2D_get_collision_local_shape>` **(** :ref:`int<class_int>` collision **)** const |
|
| :ref:`Object<class_object>` | :ref:`get_collision_local_shape<class_KinematicBody2D_get_collision_local_shape>` **(** :ref:`int<class_int>` collision **)** const |
|
||||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_collision_normal<class_KinematicBody2D_get_collision_normal>` **(** :ref:`int<class_int>` collision **)** const |
|
| :ref:`Vector2<class_vector2>` | :ref:`get_collision_normal<class_KinematicBody2D_get_collision_normal>` **(** :ref:`int<class_int>` collision **)** const |
|
||||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_collision_position<class_KinematicBody2D_get_collision_position>` **(** :ref:`int<class_int>` collision **)** const |
|
| :ref:`Vector2<class_vector2>` | :ref:`get_collision_position<class_KinematicBody2D_get_collision_position>` **(** :ref:`int<class_int>` collision **)** const |
|
||||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_collision_remainder<class_KinematicBody2D_get_collision_remainder>` **(** :ref:`int<class_int>` collision **)** const |
|
| :ref:`Vector2<class_vector2>` | :ref:`get_collision_remainder<class_KinematicBody2D_get_collision_remainder>` **(** :ref:`int<class_int>` collision **)** const |
|
||||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_collision_travel<class_KinematicBody2D_get_collision_travel>` **(** :ref:`int<class_int>` collision **)** const |
|
| :ref:`Vector2<class_vector2>` | :ref:`get_collision_travel<class_KinematicBody2D_get_collision_travel>` **(** :ref:`int<class_int>` collision **)** const |
|
||||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_floor_velocity<class_KinematicBody2D_get_floor_velocity>` **(** **)** const |
|
| :ref:`Vector2<class_vector2>` | :ref:`get_floor_velocity<class_KinematicBody2D_get_floor_velocity>` **(** **)** const |
|
||||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_safe_margin<class_KinematicBody2D_get_safe_margin>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_safe_margin<class_KinematicBody2D_get_safe_margin>` **(** **)** const |
|
||||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_on_ceiling<class_KinematicBody2D_is_on_ceiling>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_on_ceiling<class_KinematicBody2D_is_on_ceiling>` **(** **)** const |
|
||||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_on_floor<class_KinematicBody2D_is_on_floor>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_on_floor<class_KinematicBody2D_is_on_floor>` **(** **)** const |
|
||||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_on_wall<class_KinematicBody2D_is_on_wall>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_on_wall<class_KinematicBody2D_is_on_wall>` **(** **)** const |
|
||||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Dictionary<class_dictionary>` | :ref:`move<class_KinematicBody2D_move>` **(** :ref:`Vector2<class_vector2>` rel_vec **)** |
|
| :ref:`Dictionary<class_dictionary>` | :ref:`move<class_KinematicBody2D_move>` **(** :ref:`Vector2<class_vector2>` rel_vec **)** |
|
||||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`move_and_slide<class_KinematicBody2D_move_and_slide>` **(** :ref:`Vector2<class_vector2>` linear_velocity, :ref:`Vector2<class_vector2>` floor_normal=Vector2(0, 0), :ref:`float<class_float>` slope_stop_min_velocity=5, :ref:`int<class_int>` max_bounces=4, :ref:`float<class_float>` floor_max_angle=0.785398 **)** |
|
| :ref:`Vector2<class_vector2>` | :ref:`move_and_slide<class_KinematicBody2D_move_and_slide>` **(** :ref:`Vector2<class_vector2>` linear_velocity, :ref:`Vector2<class_vector2>` floor_normal=4, :ref:`float<class_float>` slope_stop_min_velocity=5, :ref:`int<class_int>` max_bounces=Vector2( 0, 0 ), :ref:`float<class_float>` floor_max_angle=null **)** |
|
||||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_safe_margin<class_KinematicBody2D_set_safe_margin>` **(** :ref:`float<class_float>` pixels **)** |
|
| void | :ref:`set_safe_margin<class_KinematicBody2D_set_safe_margin>` **(** :ref:`float<class_float>` pixels **)** |
|
||||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`test_move<class_KinematicBody2D_test_move>` **(** :ref:`Transform2D<class_transform2d>` from, :ref:`Vector2<class_vector2>` rel_vec **)** |
|
| :ref:`bool<class_bool>` | :ref:`test_move<class_KinematicBody2D_test_move>` **(** :ref:`Transform2D<class_transform2d>` from, :ref:`Vector2<class_vector2>` rel_vec **)** |
|
||||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
@@ -89,7 +89,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_KinematicBody2D_get_collision_collider_metadata:
|
.. _class_KinematicBody2D_get_collision_collider_metadata:
|
||||||
|
|
||||||
- void **get_collision_collider_metadata** **(** :ref:`int<class_int>` collision **)** const
|
- :ref:`Variant<class_variant>` **get_collision_collider_metadata** **(** :ref:`int<class_int>` collision **)** const
|
||||||
|
|
||||||
.. _class_KinematicBody2D_get_collision_collider_shape:
|
.. _class_KinematicBody2D_get_collision_collider_shape:
|
||||||
|
|
||||||
@@ -175,7 +175,7 @@ If the body did not intersect anything, then an empty dictionary (dir.empty()==t
|
|||||||
|
|
||||||
.. _class_KinematicBody2D_move_and_slide:
|
.. _class_KinematicBody2D_move_and_slide:
|
||||||
|
|
||||||
- :ref:`Vector2<class_vector2>` **move_and_slide** **(** :ref:`Vector2<class_vector2>` linear_velocity, :ref:`Vector2<class_vector2>` floor_normal=Vector2(0, 0), :ref:`float<class_float>` slope_stop_min_velocity=5, :ref:`int<class_int>` max_bounces=4, :ref:`float<class_float>` floor_max_angle=0.785398 **)**
|
- :ref:`Vector2<class_vector2>` **move_and_slide** **(** :ref:`Vector2<class_vector2>` linear_velocity, :ref:`Vector2<class_vector2>` floor_normal=4, :ref:`float<class_float>` slope_stop_min_velocity=5, :ref:`int<class_int>` max_bounces=Vector2( 0, 0 ), :ref:`float<class_float>` floor_max_angle=null **)**
|
||||||
|
|
||||||
.. _class_KinematicBody2D_set_safe_margin:
|
.. _class_KinematicBody2D_set_safe_margin:
|
||||||
|
|
||||||
|
|||||||
@@ -20,35 +20,39 @@ Provides a base class for different kinds of light nodes.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Color<class_color>` | :ref:`get_color<class_Light_get_color>` **(** **)** const |
|
| :ref:`Color<class_color>` | :ref:`get_color<class_Light_get_color>` **(** **)** const |
|
||||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_cull_mask<class_Light_get_cull_mask>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_cull_mask<class_Light_get_cull_mask>` **(** **)** const |
|
||||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_param<class_Light_get_param>` **(** :ref:`int<class_int>` param **)** const |
|
| :ref:`float<class_float>` | :ref:`get_param<class_Light_get_param>` **(** :ref:`int<class_int>` param **)** const |
|
||||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Color<class_color>` | :ref:`get_shadow_color<class_Light_get_shadow_color>` **(** **)** const |
|
| :ref:`Color<class_color>` | :ref:`get_shadow_color<class_Light_get_shadow_color>` **(** **)** const |
|
||||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`has_shadow<class_Light_has_shadow>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`get_shadow_reverse_cull_face<class_Light_get_shadow_reverse_cull_face>` **(** **)** const |
|
||||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_editor_only<class_Light_is_editor_only>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`has_shadow<class_Light_has_shadow>` **(** **)** const |
|
||||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_negative<class_Light_is_negative>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_editor_only<class_Light_is_editor_only>` **(** **)** const |
|
||||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_color<class_Light_set_color>` **(** :ref:`Color<class_color>` color **)** |
|
| :ref:`bool<class_bool>` | :ref:`is_negative<class_Light_is_negative>` **(** **)** const |
|
||||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_cull_mask<class_Light_set_cull_mask>` **(** :ref:`int<class_int>` cull_mask **)** |
|
| void | :ref:`set_color<class_Light_set_color>` **(** :ref:`Color<class_color>` color **)** |
|
||||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_editor_only<class_Light_set_editor_only>` **(** :ref:`bool<class_bool>` editor_only **)** |
|
| void | :ref:`set_cull_mask<class_Light_set_cull_mask>` **(** :ref:`int<class_int>` cull_mask **)** |
|
||||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_negative<class_Light_set_negative>` **(** :ref:`bool<class_bool>` enabled **)** |
|
| void | :ref:`set_editor_only<class_Light_set_editor_only>` **(** :ref:`bool<class_bool>` editor_only **)** |
|
||||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_param<class_Light_set_param>` **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
|
| void | :ref:`set_negative<class_Light_set_negative>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_shadow<class_Light_set_shadow>` **(** :ref:`bool<class_bool>` enabled **)** |
|
| void | :ref:`set_param<class_Light_set_param>` **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
|
||||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_shadow_color<class_Light_set_shadow_color>` **(** :ref:`Color<class_color>` shadow_color **)** |
|
| void | :ref:`set_shadow<class_Light_set_shadow>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`set_shadow_color<class_Light_set_shadow_color>` **(** :ref:`Color<class_color>` shadow_color **)** |
|
||||||
|
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`set_shadow_reverse_cull_face<class_Light_set_shadow_reverse_cull_face>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||||
|
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
@@ -64,6 +68,7 @@ Member Variables
|
|||||||
- :ref:`float<class_float>` **shadow_contact**
|
- :ref:`float<class_float>` **shadow_contact**
|
||||||
- :ref:`bool<class_bool>` **shadow_enabled**
|
- :ref:`bool<class_bool>` **shadow_enabled**
|
||||||
- :ref:`float<class_float>` **shadow_max_distance**
|
- :ref:`float<class_float>` **shadow_max_distance**
|
||||||
|
- :ref:`bool<class_bool>` **shadow_reverse_cull_face**
|
||||||
|
|
||||||
Numeric Constants
|
Numeric Constants
|
||||||
-----------------
|
-----------------
|
||||||
@@ -81,7 +86,7 @@ Numeric Constants
|
|||||||
- **PARAM_SHADOW_SPLIT_3_OFFSET** = **10**
|
- **PARAM_SHADOW_SPLIT_3_OFFSET** = **10**
|
||||||
- **PARAM_SHADOW_NORMAL_BIAS** = **11**
|
- **PARAM_SHADOW_NORMAL_BIAS** = **11**
|
||||||
- **PARAM_SHADOW_BIAS** = **12**
|
- **PARAM_SHADOW_BIAS** = **12**
|
||||||
- **PARAM_MAX** = **13**
|
- **PARAM_MAX** = **14**
|
||||||
|
|
||||||
Description
|
Description
|
||||||
-----------
|
-----------
|
||||||
@@ -107,6 +112,10 @@ Member Function Description
|
|||||||
|
|
||||||
- :ref:`Color<class_color>` **get_shadow_color** **(** **)** const
|
- :ref:`Color<class_color>` **get_shadow_color** **(** **)** const
|
||||||
|
|
||||||
|
.. _class_Light_get_shadow_reverse_cull_face:
|
||||||
|
|
||||||
|
- :ref:`bool<class_bool>` **get_shadow_reverse_cull_face** **(** **)** const
|
||||||
|
|
||||||
.. _class_Light_has_shadow:
|
.. _class_Light_has_shadow:
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **has_shadow** **(** **)** const
|
- :ref:`bool<class_bool>` **has_shadow** **(** **)** const
|
||||||
@@ -147,4 +156,8 @@ Member Function Description
|
|||||||
|
|
||||||
- void **set_shadow_color** **(** :ref:`Color<class_color>` shadow_color **)**
|
- void **set_shadow_color** **(** :ref:`Color<class_color>` shadow_color **)**
|
||||||
|
|
||||||
|
.. _class_Light_set_shadow_reverse_cull_face:
|
||||||
|
|
||||||
|
- void **set_shadow_reverse_cull_face** **(** :ref:`bool<class_bool>` enable **)**
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -45,7 +45,7 @@ Member Functions
|
|||||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_shadow_smooth<class_Light2D_get_shadow_smooth>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_shadow_smooth<class_Light2D_get_shadow_smooth>` **(** **)** const |
|
||||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Object<class_object>` | :ref:`get_texture<class_Light2D_get_texture>` **(** **)** const |
|
| :ref:`Texture<class_texture>` | :ref:`get_texture<class_Light2D_get_texture>` **(** **)** const |
|
||||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_texture_offset<class_Light2D_get_texture_offset>` **(** **)** const |
|
| :ref:`Vector2<class_vector2>` | :ref:`get_texture_offset<class_Light2D_get_texture_offset>` **(** **)** const |
|
||||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -93,7 +93,7 @@ Member Functions
|
|||||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_shadow_smooth<class_Light2D_set_shadow_smooth>` **(** :ref:`float<class_float>` smooth **)** |
|
| void | :ref:`set_shadow_smooth<class_Light2D_set_shadow_smooth>` **(** :ref:`float<class_float>` smooth **)** |
|
||||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_texture<class_Light2D_set_texture>` **(** :ref:`Object<class_object>` texture **)** |
|
| void | :ref:`set_texture<class_Light2D_set_texture>` **(** :ref:`Texture<class_texture>` texture **)** |
|
||||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_texture_offset<class_Light2D_set_texture_offset>` **(** :ref:`Vector2<class_vector2>` texture_offset **)** |
|
| void | :ref:`set_texture_offset<class_Light2D_set_texture_offset>` **(** :ref:`Vector2<class_vector2>` texture_offset **)** |
|
||||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -119,15 +119,15 @@ Member Variables
|
|||||||
- :ref:`int<class_int>` **range_layer_min**
|
- :ref:`int<class_int>` **range_layer_min**
|
||||||
- :ref:`int<class_int>` **range_z_max**
|
- :ref:`int<class_int>` **range_z_max**
|
||||||
- :ref:`int<class_int>` **range_z_min**
|
- :ref:`int<class_int>` **range_z_min**
|
||||||
- :ref:`float<class_float>` **scale**
|
|
||||||
- :ref:`int<class_int>` **shadow_buffer_size**
|
- :ref:`int<class_int>` **shadow_buffer_size**
|
||||||
- :ref:`Color<class_color>` **shadow_color**
|
- :ref:`Color<class_color>` **shadow_color**
|
||||||
- :ref:`bool<class_bool>` **shadow_enabled**
|
- :ref:`bool<class_bool>` **shadow_enabled**
|
||||||
- :ref:`float<class_float>` **shadow_filter**
|
- :ref:`int<class_int>` **shadow_filter**
|
||||||
- :ref:`float<class_float>` **shadow_filter_smooth**
|
- :ref:`float<class_float>` **shadow_filter_smooth**
|
||||||
- :ref:`float<class_float>` **shadow_gradient_length**
|
- :ref:`float<class_float>` **shadow_gradient_length**
|
||||||
- :ref:`int<class_int>` **shadow_item_cull_mask**
|
- :ref:`int<class_int>` **shadow_item_cull_mask**
|
||||||
- :ref:`Texture<class_texture>` **texture**
|
- :ref:`Texture<class_texture>` **texture**
|
||||||
|
- :ref:`float<class_float>` **texture_scale**
|
||||||
|
|
||||||
Numeric Constants
|
Numeric Constants
|
||||||
-----------------
|
-----------------
|
||||||
@@ -215,7 +215,7 @@ Return the color of casted shadows for this Light2D.
|
|||||||
|
|
||||||
.. _class_Light2D_get_texture:
|
.. _class_Light2D_get_texture:
|
||||||
|
|
||||||
- :ref:`Object<class_object>` **get_texture** **(** **)** const
|
- :ref:`Texture<class_texture>` **get_texture** **(** **)** const
|
||||||
|
|
||||||
Return the texture of the Light2D.
|
Return the texture of the Light2D.
|
||||||
|
|
||||||
@@ -349,7 +349,7 @@ Enable or disable shadows casting from this Light2D according to the 'enabled' p
|
|||||||
|
|
||||||
.. _class_Light2D_set_texture:
|
.. _class_Light2D_set_texture:
|
||||||
|
|
||||||
- void **set_texture** **(** :ref:`Object<class_object>` texture **)**
|
- void **set_texture** **(** :ref:`Texture<class_texture>` texture **)**
|
||||||
|
|
||||||
Set the texture of the Light2D.
|
Set the texture of the Light2D.
|
||||||
|
|
||||||
|
|||||||
@@ -27,7 +27,7 @@ Member Functions
|
|||||||
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_end_cap_mode<class_Line2D_get_end_cap_mode>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_end_cap_mode<class_Line2D_get_end_cap_mode>` **(** **)** const |
|
||||||
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Object<class_object>` | :ref:`get_gradient<class_Line2D_get_gradient>` **(** **)** const |
|
| :ref:`Gradient<class_gradient>` | :ref:`get_gradient<class_Line2D_get_gradient>` **(** **)** const |
|
||||||
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_joint_mode<class_Line2D_get_joint_mode>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_joint_mode<class_Line2D_get_joint_mode>` **(** **)** const |
|
||||||
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -41,7 +41,7 @@ Member Functions
|
|||||||
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_sharp_limit<class_Line2D_get_sharp_limit>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_sharp_limit<class_Line2D_get_sharp_limit>` **(** **)** const |
|
||||||
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Object<class_object>` | :ref:`get_texture<class_Line2D_get_texture>` **(** **)** const |
|
| :ref:`Texture<class_texture>` | :ref:`get_texture<class_Line2D_get_texture>` **(** **)** const |
|
||||||
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_texture_mode<class_Line2D_get_texture_mode>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_texture_mode<class_Line2D_get_texture_mode>` **(** **)** const |
|
||||||
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -55,7 +55,7 @@ Member Functions
|
|||||||
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_end_cap_mode<class_Line2D_set_end_cap_mode>` **(** :ref:`int<class_int>` mode **)** |
|
| void | :ref:`set_end_cap_mode<class_Line2D_set_end_cap_mode>` **(** :ref:`int<class_int>` mode **)** |
|
||||||
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_gradient<class_Line2D_set_gradient>` **(** :ref:`Object<class_object>` color **)** |
|
| void | :ref:`set_gradient<class_Line2D_set_gradient>` **(** :ref:`Gradient<class_gradient>` color **)** |
|
||||||
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_joint_mode<class_Line2D_set_joint_mode>` **(** :ref:`int<class_int>` mode **)** |
|
| void | :ref:`set_joint_mode<class_Line2D_set_joint_mode>` **(** :ref:`int<class_int>` mode **)** |
|
||||||
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -67,7 +67,7 @@ Member Functions
|
|||||||
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_sharp_limit<class_Line2D_set_sharp_limit>` **(** :ref:`float<class_float>` limit **)** |
|
| void | :ref:`set_sharp_limit<class_Line2D_set_sharp_limit>` **(** :ref:`float<class_float>` limit **)** |
|
||||||
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_texture<class_Line2D_set_texture>` **(** :ref:`Object<class_object>` texture **)** |
|
| void | :ref:`set_texture<class_Line2D_set_texture>` **(** :ref:`Texture<class_texture>` texture **)** |
|
||||||
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_texture_mode<class_Line2D_set_texture_mode>` **(** :ref:`int<class_int>` mode **)** |
|
| void | :ref:`set_texture_mode<class_Line2D_set_texture_mode>` **(** :ref:`int<class_int>` mode **)** |
|
||||||
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -122,7 +122,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_Line2D_get_gradient:
|
.. _class_Line2D_get_gradient:
|
||||||
|
|
||||||
- :ref:`Object<class_object>` **get_gradient** **(** **)** const
|
- :ref:`Gradient<class_gradient>` **get_gradient** **(** **)** const
|
||||||
|
|
||||||
.. _class_Line2D_get_joint_mode:
|
.. _class_Line2D_get_joint_mode:
|
||||||
|
|
||||||
@@ -150,7 +150,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_Line2D_get_texture:
|
.. _class_Line2D_get_texture:
|
||||||
|
|
||||||
- :ref:`Object<class_object>` **get_texture** **(** **)** const
|
- :ref:`Texture<class_texture>` **get_texture** **(** **)** const
|
||||||
|
|
||||||
.. _class_Line2D_get_texture_mode:
|
.. _class_Line2D_get_texture_mode:
|
||||||
|
|
||||||
@@ -178,7 +178,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_Line2D_set_gradient:
|
.. _class_Line2D_set_gradient:
|
||||||
|
|
||||||
- void **set_gradient** **(** :ref:`Object<class_object>` color **)**
|
- void **set_gradient** **(** :ref:`Gradient<class_gradient>` color **)**
|
||||||
|
|
||||||
.. _class_Line2D_set_joint_mode:
|
.. _class_Line2D_set_joint_mode:
|
||||||
|
|
||||||
@@ -202,7 +202,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_Line2D_set_texture:
|
.. _class_Line2D_set_texture:
|
||||||
|
|
||||||
- void **set_texture** **(** :ref:`Object<class_object>` texture **)**
|
- void **set_texture** **(** :ref:`Texture<class_texture>` texture **)**
|
||||||
|
|
||||||
.. _class_Line2D_set_texture_mode:
|
.. _class_Line2D_set_texture_mode:
|
||||||
|
|
||||||
|
|||||||
@@ -53,7 +53,7 @@ Member Functions
|
|||||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`menu_option<class_LineEdit_menu_option>` **(** :ref:`int<class_int>` option **)** |
|
| void | :ref:`menu_option<class_LineEdit_menu_option>` **(** :ref:`int<class_int>` option **)** |
|
||||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`select<class_LineEdit_select>` **(** :ref:`int<class_int>` from=0, :ref:`int<class_int>` to=-1 **)** |
|
| void | :ref:`select<class_LineEdit_select>` **(** :ref:`int<class_int>` from=-1, :ref:`int<class_int>` to=0 **)** |
|
||||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`select_all<class_LineEdit_select_all>` **(** **)** |
|
| void | :ref:`select_all<class_LineEdit_select_all>` **(** **)** |
|
||||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -216,7 +216,7 @@ Return the *secret* status of the :ref:`LineEdit<class_lineedit>` (see :ref:`set
|
|||||||
|
|
||||||
.. _class_LineEdit_select:
|
.. _class_LineEdit_select:
|
||||||
|
|
||||||
- void **select** **(** :ref:`int<class_int>` from=0, :ref:`int<class_int>` to=-1 **)**
|
- void **select** **(** :ref:`int<class_int>` from=-1, :ref:`int<class_int>` to=0 **)**
|
||||||
|
|
||||||
.. _class_LineEdit_select_all:
|
.. _class_LineEdit_select_all:
|
||||||
|
|
||||||
|
|||||||
@@ -41,7 +41,7 @@ Member Functions
|
|||||||
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`init<class_MainLoop_init>` **(** **)** |
|
| void | :ref:`init<class_MainLoop_init>` **(** **)** |
|
||||||
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`input_event<class_MainLoop_input_event>` **(** :ref:`Object<class_object>` ev **)** |
|
| void | :ref:`input_event<class_MainLoop_input_event>` **(** :ref:`InputEvent<class_inputevent>` ev **)** |
|
||||||
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`input_text<class_MainLoop_input_text>` **(** :ref:`String<class_string>` text **)** |
|
| void | :ref:`input_text<class_MainLoop_input_text>` **(** :ref:`String<class_string>` text **)** |
|
||||||
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -58,6 +58,8 @@ Numeric Constants
|
|||||||
- **NOTIFICATION_WM_QUIT_REQUEST** = **6**
|
- **NOTIFICATION_WM_QUIT_REQUEST** = **6**
|
||||||
- **NOTIFICATION_WM_UNFOCUS_REQUEST** = **8**
|
- **NOTIFICATION_WM_UNFOCUS_REQUEST** = **8**
|
||||||
- **NOTIFICATION_OS_MEMORY_WARNING** = **9**
|
- **NOTIFICATION_OS_MEMORY_WARNING** = **9**
|
||||||
|
- **NOTIFICATION_TRANSLATION_CHANGED** = **90**
|
||||||
|
- **NOTIFICATION_WM_ABOUT** = **91**
|
||||||
|
|
||||||
Description
|
Description
|
||||||
-----------
|
-----------
|
||||||
@@ -109,7 +111,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_MainLoop_input_event:
|
.. _class_MainLoop_input_event:
|
||||||
|
|
||||||
- void **input_event** **(** :ref:`Object<class_object>` ev **)**
|
- void **input_event** **(** :ref:`InputEvent<class_inputevent>` ev **)**
|
||||||
|
|
||||||
.. _class_MainLoop_input_text:
|
.. _class_MainLoop_input_text:
|
||||||
|
|
||||||
|
|||||||
@@ -20,16 +20,27 @@ Abstract base :ref:`Resource<class_resource>` for coloring and shading geometry.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Material<class_material>` | :ref:`get_next_pass<class_Material_get_next_pass>` **(** **)** const |
|
| :ref:`Material<class_material>` | :ref:`get_next_pass<class_Material_get_next_pass>` **(** **)** const |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_next_pass<class_Material_set_next_pass>` **(** :ref:`Material<class_material>` next_pass **)** |
|
| :ref:`int<class_int>` | :ref:`get_render_priority<class_Material_get_render_priority>` **(** **)** const |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`set_next_pass<class_Material_set_next_pass>` **(** :ref:`Material<class_material>` next_pass **)** |
|
||||||
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`set_render_priority<class_Material_set_render_priority>` **(** :ref:`int<class_int>` priority **)** |
|
||||||
|
+----------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
- :ref:`Material<class_material>` **next_pass**
|
- :ref:`Material<class_material>` **next_pass**
|
||||||
|
- :ref:`int<class_int>` **render_priority**
|
||||||
|
|
||||||
|
Numeric Constants
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
- **RENDER_PRIORITY_MAX** = **127**
|
||||||
|
- **RENDER_PRIORITY_MIN** = **-128**
|
||||||
|
|
||||||
Description
|
Description
|
||||||
-----------
|
-----------
|
||||||
@@ -43,8 +54,16 @@ Member Function Description
|
|||||||
|
|
||||||
- :ref:`Material<class_material>` **get_next_pass** **(** **)** const
|
- :ref:`Material<class_material>` **get_next_pass** **(** **)** const
|
||||||
|
|
||||||
|
.. _class_Material_get_render_priority:
|
||||||
|
|
||||||
|
- :ref:`int<class_int>` **get_render_priority** **(** **)** const
|
||||||
|
|
||||||
.. _class_Material_set_next_pass:
|
.. _class_Material_set_next_pass:
|
||||||
|
|
||||||
- void **set_next_pass** **(** :ref:`Material<class_material>` next_pass **)**
|
- void **set_next_pass** **(** :ref:`Material<class_material>` next_pass **)**
|
||||||
|
|
||||||
|
.. _class_Material_set_render_priority:
|
||||||
|
|
||||||
|
- void **set_render_priority** **(** :ref:`int<class_int>` priority **)**
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ Member Functions
|
|||||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Shape<class_shape>` | :ref:`create_convex_shape<class_Mesh_create_convex_shape>` **(** **)** const |
|
| :ref:`Shape<class_shape>` | :ref:`create_convex_shape<class_Mesh_create_convex_shape>` **(** **)** const |
|
||||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`ArrayMesh<class_arraymesh>` | :ref:`create_outline<class_Mesh_create_outline>` **(** :ref:`float<class_float>` margin **)** const |
|
| :ref:`Mesh<class_mesh>` | :ref:`create_outline<class_Mesh_create_outline>` **(** :ref:`float<class_float>` margin **)** const |
|
||||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Shape<class_shape>` | :ref:`create_trimesh_shape<class_Mesh_create_trimesh_shape>` **(** **)** const |
|
| :ref:`Shape<class_shape>` | :ref:`create_trimesh_shape<class_Mesh_create_trimesh_shape>` **(** **)** const |
|
||||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------+
|
||||||
@@ -57,7 +57,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_Mesh_create_outline:
|
.. _class_Mesh_create_outline:
|
||||||
|
|
||||||
- :ref:`ArrayMesh<class_arraymesh>` **create_outline** **(** :ref:`float<class_float>` margin **)** const
|
- :ref:`Mesh<class_mesh>` **create_outline** **(** :ref:`float<class_float>` margin **)** const
|
||||||
|
|
||||||
.. _class_Mesh_create_trimesh_shape:
|
.. _class_Mesh_create_trimesh_shape:
|
||||||
|
|
||||||
|
|||||||
@@ -21,9 +21,9 @@ Member Functions
|
|||||||
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`clear<class_MeshDataTool_clear>` **(** **)** |
|
| void | :ref:`clear<class_MeshDataTool_clear>` **(** **)** |
|
||||||
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`commit_to_surface<class_MeshDataTool_commit_to_surface>` **(** :ref:`Object<class_object>` mesh **)** |
|
| :ref:`int<class_int>` | :ref:`commit_to_surface<class_MeshDataTool_commit_to_surface>` **(** :ref:`ArrayMesh<class_arraymesh>` mesh **)** |
|
||||||
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`create_from_surface<class_MeshDataTool_create_from_surface>` **(** :ref:`Object<class_object>` mesh, :ref:`int<class_int>` surface **)** |
|
| :ref:`int<class_int>` | :ref:`create_from_surface<class_MeshDataTool_create_from_surface>` **(** :ref:`ArrayMesh<class_arraymesh>` mesh, :ref:`int<class_int>` surface **)** |
|
||||||
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_edge_count<class_MeshDataTool_get_edge_count>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_edge_count<class_MeshDataTool_get_edge_count>` **(** **)** const |
|
||||||
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -45,7 +45,7 @@ Member Functions
|
|||||||
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_format<class_MeshDataTool_get_format>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_format<class_MeshDataTool_get_format>` **(** **)** const |
|
||||||
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Object<class_object>` | :ref:`get_material<class_MeshDataTool_get_material>` **(** **)** const |
|
| :ref:`Material<class_material>` | :ref:`get_material<class_MeshDataTool_get_material>` **(** **)** const |
|
||||||
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector3<class_vector3>` | :ref:`get_vertex<class_MeshDataTool_get_vertex>` **(** :ref:`int<class_int>` idx **)** const |
|
| :ref:`Vector3<class_vector3>` | :ref:`get_vertex<class_MeshDataTool_get_vertex>` **(** :ref:`int<class_int>` idx **)** const |
|
||||||
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -105,11 +105,11 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_MeshDataTool_commit_to_surface:
|
.. _class_MeshDataTool_commit_to_surface:
|
||||||
|
|
||||||
- :ref:`int<class_int>` **commit_to_surface** **(** :ref:`Object<class_object>` mesh **)**
|
- :ref:`int<class_int>` **commit_to_surface** **(** :ref:`ArrayMesh<class_arraymesh>` mesh **)**
|
||||||
|
|
||||||
.. _class_MeshDataTool_create_from_surface:
|
.. _class_MeshDataTool_create_from_surface:
|
||||||
|
|
||||||
- :ref:`int<class_int>` **create_from_surface** **(** :ref:`Object<class_object>` mesh, :ref:`int<class_int>` surface **)**
|
- :ref:`int<class_int>` **create_from_surface** **(** :ref:`ArrayMesh<class_arraymesh>` mesh, :ref:`int<class_int>` surface **)**
|
||||||
|
|
||||||
.. _class_MeshDataTool_get_edge_count:
|
.. _class_MeshDataTool_get_edge_count:
|
||||||
|
|
||||||
@@ -153,7 +153,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_MeshDataTool_get_material:
|
.. _class_MeshDataTool_get_material:
|
||||||
|
|
||||||
- :ref:`Object<class_object>` **get_material** **(** **)** const
|
- :ref:`Material<class_material>` **get_material** **(** **)** const
|
||||||
|
|
||||||
.. _class_MeshDataTool_get_vertex:
|
.. _class_MeshDataTool_get_vertex:
|
||||||
|
|
||||||
|
|||||||
@@ -31,7 +31,9 @@ Member Functions
|
|||||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`NavigationMesh<class_navigationmesh>` | :ref:`get_item_navmesh<class_MeshLibrary_get_item_navmesh>` **(** :ref:`int<class_int>` id **)** const |
|
| :ref:`NavigationMesh<class_navigationmesh>` | :ref:`get_item_navmesh<class_MeshLibrary_get_item_navmesh>` **(** :ref:`int<class_int>` id **)** const |
|
||||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Shape<class_shape>` | :ref:`get_item_shape<class_MeshLibrary_get_item_shape>` **(** :ref:`int<class_int>` id **)** const |
|
| :ref:`Texture<class_texture>` | :ref:`get_item_preview<class_MeshLibrary_get_item_preview>` **(** :ref:`int<class_int>` id **)** const |
|
||||||
|
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`Array<class_array>` | :ref:`get_item_shapes<class_MeshLibrary_get_item_shapes>` **(** :ref:`int<class_int>` id **)** const |
|
||||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_last_unused_item_id<class_MeshLibrary_get_last_unused_item_id>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_last_unused_item_id<class_MeshLibrary_get_last_unused_item_id>` **(** **)** const |
|
||||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -43,7 +45,9 @@ Member Functions
|
|||||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_item_navmesh<class_MeshLibrary_set_item_navmesh>` **(** :ref:`int<class_int>` id, :ref:`NavigationMesh<class_navigationmesh>` navmesh **)** |
|
| void | :ref:`set_item_navmesh<class_MeshLibrary_set_item_navmesh>` **(** :ref:`int<class_int>` id, :ref:`NavigationMesh<class_navigationmesh>` navmesh **)** |
|
||||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_item_shape<class_MeshLibrary_set_item_shape>` **(** :ref:`int<class_int>` id, :ref:`Shape<class_shape>` shape **)** |
|
| void | :ref:`set_item_preview<class_MeshLibrary_set_item_preview>` **(** :ref:`int<class_int>` id, :ref:`Texture<class_texture>` texture **)** |
|
||||||
|
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`set_item_shapes<class_MeshLibrary_set_item_shapes>` **(** :ref:`int<class_int>` id, :ref:`Array<class_array>` shapes **)** |
|
||||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Description
|
Description
|
||||||
@@ -88,9 +92,13 @@ Return the name of the item.
|
|||||||
|
|
||||||
- :ref:`NavigationMesh<class_navigationmesh>` **get_item_navmesh** **(** :ref:`int<class_int>` id **)** const
|
- :ref:`NavigationMesh<class_navigationmesh>` **get_item_navmesh** **(** :ref:`int<class_int>` id **)** const
|
||||||
|
|
||||||
.. _class_MeshLibrary_get_item_shape:
|
.. _class_MeshLibrary_get_item_preview:
|
||||||
|
|
||||||
- :ref:`Shape<class_shape>` **get_item_shape** **(** :ref:`int<class_int>` id **)** const
|
- :ref:`Texture<class_texture>` **get_item_preview** **(** :ref:`int<class_int>` id **)** const
|
||||||
|
|
||||||
|
.. _class_MeshLibrary_get_item_shapes:
|
||||||
|
|
||||||
|
- :ref:`Array<class_array>` **get_item_shapes** **(** :ref:`int<class_int>` id **)** const
|
||||||
|
|
||||||
.. _class_MeshLibrary_get_last_unused_item_id:
|
.. _class_MeshLibrary_get_last_unused_item_id:
|
||||||
|
|
||||||
@@ -120,8 +128,12 @@ Set the name of the item.
|
|||||||
|
|
||||||
- void **set_item_navmesh** **(** :ref:`int<class_int>` id, :ref:`NavigationMesh<class_navigationmesh>` navmesh **)**
|
- void **set_item_navmesh** **(** :ref:`int<class_int>` id, :ref:`NavigationMesh<class_navigationmesh>` navmesh **)**
|
||||||
|
|
||||||
.. _class_MeshLibrary_set_item_shape:
|
.. _class_MeshLibrary_set_item_preview:
|
||||||
|
|
||||||
- void **set_item_shape** **(** :ref:`int<class_int>` id, :ref:`Shape<class_shape>` shape **)**
|
- void **set_item_preview** **(** :ref:`int<class_int>` id, :ref:`Texture<class_texture>` texture **)**
|
||||||
|
|
||||||
|
.. _class_MeshLibrary_set_item_shapes:
|
||||||
|
|
||||||
|
- void **set_item_shapes** **(** :ref:`int<class_int>` id, :ref:`Array<class_array>` shapes **)**
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -18,11 +18,11 @@ Node that instances a :ref:`MultiMesh<class_multimesh>`.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
|
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Object<class_object>` | :ref:`get_multimesh<class_MultiMeshInstance_get_multimesh>` **(** **)** const |
|
| :ref:`MultiMesh<class_multimesh>` | :ref:`get_multimesh<class_MultiMeshInstance_get_multimesh>` **(** **)** const |
|
||||||
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
|
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_multimesh<class_MultiMeshInstance_set_multimesh>` **(** :ref:`Object<class_object>` multimesh **)** |
|
| void | :ref:`set_multimesh<class_MultiMeshInstance_set_multimesh>` **(** :ref:`MultiMesh<class_multimesh>` multimesh **)** |
|
||||||
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
|
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
@@ -39,14 +39,14 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_MultiMeshInstance_get_multimesh:
|
.. _class_MultiMeshInstance_get_multimesh:
|
||||||
|
|
||||||
- :ref:`Object<class_object>` **get_multimesh** **(** **)** const
|
- :ref:`MultiMesh<class_multimesh>` **get_multimesh** **(** **)** const
|
||||||
|
|
||||||
Return the :ref:`MultiMesh<class_multimesh>` that is used for instancing.
|
Return the :ref:`MultiMesh<class_multimesh>` that is used for instancing.
|
||||||
|
|
||||||
.. _class_MultiMeshInstance_set_multimesh:
|
.. _class_MultiMeshInstance_set_multimesh:
|
||||||
|
|
||||||
- void **set_multimesh** **(** :ref:`Object<class_object>` multimesh **)**
|
- void **set_multimesh** **(** :ref:`MultiMesh<class_multimesh>` multimesh **)**
|
||||||
|
|
||||||
Set the :ref:`MultiMesh<class_multimesh>` to be instance.
|
Set the :ref:`MultiMesh<class_multimesh>` to be instanced.
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user