mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-03 05:48:42 +03:00
classref: Remove stray spaces in method signatures
This commit is contained in:
Rémi Verschelde
@@ -17,159 +17,159 @@ Built-in GDScript 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:`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:`acos<class_@GDScript_acos>` **(** :ref:`float<class_float>` s **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`asin<class_@GDScript_asin>` **(** :ref:`float<class_float>` s **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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:`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:`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:`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:`float<class_float>` | :ref:`cos<class_@GDScript_cos>` **(** :ref:`float<class_float>` s **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`cosh<class_@GDScript_cosh>` **(** :ref:`float<class_float>` s **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`db2linear<class_@GDScript_db2linear>` **(** :ref:`float<class_float>` db **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`decimals<class_@GDScript_decimals>` **(** :ref:`float<class_float>` step **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`dectime<class_@GDScript_dectime>` **(** :ref:`float<class_float>` value, :ref:`float<class_float>` amount, :ref:`float<class_float>` step **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`deg2rad<class_@GDScript_deg2rad>` **(** :ref:`float<class_float>` deg **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Object<class_object>` | :ref:`dict2inst<class_@GDScript_dict2inst>` **(** :ref:`Dictionary<class_dictionary>` dict **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`ease<class_@GDScript_ease>` **(** :ref:`float<class_float>` s, :ref:`float<class_float>` curve **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`exp<class_@GDScript_exp>` **(** :ref:`float<class_float>` s **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`floor<class_@GDScript_floor>` **(** :ref:`float<class_float>` s **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`fmod<class_@GDScript_fmod>` **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`fposmod<class_@GDScript_fposmod>` **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`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 **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`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:`bool<class_bool>` | :ref:`is_inf<class_@GDScript_is_inf>` **(** :ref:`float<class_float>` s **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_nan<class_@GDScript_is_nan>` **(** :ref:`float<class_float>` s **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`len<class_@GDScript_len>` **(** :ref:`Variant<class_variant>` var **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`linear2db<class_@GDScript_linear2db>` **(** :ref:`float<class_float>` nrg **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Object<class_object>` | :ref:`load<class_@GDScript_load>` **(** :ref:`String<class_string>` path **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`log<class_@GDScript_log>` **(** :ref:`float<class_float>` s **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`max<class_@GDScript_max>` **(** :ref:`float<class_float>` a, :ref:`float<class_float>` b **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`min<class_@GDScript_min>` **(** :ref:`float<class_float>` a, :ref:`float<class_float>` b **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`nearest_po2<class_@GDScript_nearest_po2>` **(** :ref:`int<class_int>` val **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_variant>` | :ref:`parse_json<class_@GDScript_parse_json>` **(** :ref:`String<class_string>` json **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`pow<class_@GDScript_pow>` **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Resource<class_resource>` | :ref:`preload<class_@GDScript_preload>` **(** :ref:`String<class_string>` path **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`print<class_@GDScript_print>` **(** **)** vararg |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`print_stack<class_@GDScript_print_stack>` **(** **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`printerr<class_@GDScript_printerr>` **(** **)** vararg |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`printraw<class_@GDScript_printraw>` **(** **)** vararg |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`prints<class_@GDScript_prints>` **(** **)** vararg |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`printt<class_@GDScript_printt>` **(** **)** vararg |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`rad2deg<class_@GDScript_rad2deg>` **(** :ref:`float<class_float>` rad **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`rand_range<class_@GDScript_rand_range>` **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`rand_seed<class_@GDScript_rand_seed>` **(** :ref:`int<class_int>` seed **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`randf<class_@GDScript_randf>` **(** **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`randi<class_@GDScript_randi>` **(** **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`randomize<class_@GDScript_randomize>` **(** **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`range<class_@GDScript_range>` **(** **)** vararg |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`round<class_@GDScript_round>` **(** :ref:`float<class_float>` s **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`seed<class_@GDScript_seed>` **(** :ref:`int<class_int>` seed **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`sign<class_@GDScript_sign>` **(** :ref:`float<class_float>` s **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`sin<class_@GDScript_sin>` **(** :ref:`float<class_float>` s **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`sinh<class_@GDScript_sinh>` **(** :ref:`float<class_float>` s **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`sqrt<class_@GDScript_sqrt>` **(** :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:`String<class_string>` | :ref:`str<class_@GDScript_str>` **(** **)** vararg |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_variant>` | :ref:`str2var<class_@GDScript_str2var>` **(** :ref:`String<class_string>` string **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`tan<class_@GDScript_tan>` **(** :ref:`float<class_float>` s **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`tanh<class_@GDScript_tanh>` **(** :ref:`float<class_float>` s **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`to_json<class_@GDScript_to_json>` **(** :ref:`Variant<class_variant>` var **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`type_exists<class_@GDScript_type_exists>` **(** :ref:`String<class_string>` type **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`typeof<class_@GDScript_typeof>` **(** :ref:`Variant<class_variant>` what **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`validate_json<class_@GDScript_validate_json>` **(** :ref:`String<class_string>` json **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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 **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`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:`asin<class_@GDScript_asin>` **(** :ref:`float<class_float>` s **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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:`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:`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:`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:`float<class_float>` | :ref:`cos<class_@GDScript_cos>` **(** :ref:`float<class_float>` s **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`cosh<class_@GDScript_cosh>` **(** :ref:`float<class_float>` s **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`db2linear<class_@GDScript_db2linear>` **(** :ref:`float<class_float>` db **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`decimals<class_@GDScript_decimals>` **(** :ref:`float<class_float>` step **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`dectime<class_@GDScript_dectime>` **(** :ref:`float<class_float>` value, :ref:`float<class_float>` amount, :ref:`float<class_float>` step **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`deg2rad<class_@GDScript_deg2rad>` **(** :ref:`float<class_float>` deg **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Object<class_object>` | :ref:`dict2inst<class_@GDScript_dict2inst>` **(** :ref:`Dictionary<class_dictionary>` dict **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`ease<class_@GDScript_ease>` **(** :ref:`float<class_float>` s, :ref:`float<class_float>` curve **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`exp<class_@GDScript_exp>` **(** :ref:`float<class_float>` s **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`floor<class_@GDScript_floor>` **(** :ref:`float<class_float>` s **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`fmod<class_@GDScript_fmod>` **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`fposmod<class_@GDScript_fposmod>` **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`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 **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`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:`bool<class_bool>` | :ref:`is_inf<class_@GDScript_is_inf>` **(** :ref:`float<class_float>` s **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_nan<class_@GDScript_is_nan>` **(** :ref:`float<class_float>` s **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`len<class_@GDScript_len>` **(** :ref:`Variant<class_variant>` var **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`linear2db<class_@GDScript_linear2db>` **(** :ref:`float<class_float>` nrg **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Object<class_object>` | :ref:`load<class_@GDScript_load>` **(** :ref:`String<class_string>` path **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`log<class_@GDScript_log>` **(** :ref:`float<class_float>` s **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`max<class_@GDScript_max>` **(** :ref:`float<class_float>` a, :ref:`float<class_float>` b **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`min<class_@GDScript_min>` **(** :ref:`float<class_float>` a, :ref:`float<class_float>` b **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`nearest_po2<class_@GDScript_nearest_po2>` **(** :ref:`int<class_int>` val **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_variant>` | :ref:`parse_json<class_@GDScript_parse_json>` **(** :ref:`String<class_string>` json **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`pow<class_@GDScript_pow>` **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Resource<class_resource>` | :ref:`preload<class_@GDScript_preload>` **(** :ref:`String<class_string>` path **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`print<class_@GDScript_print>` **(** **)** vararg |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`print_stack<class_@GDScript_print_stack>` **(** **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`printerr<class_@GDScript_printerr>` **(** **)** vararg |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`printraw<class_@GDScript_printraw>` **(** **)** vararg |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`prints<class_@GDScript_prints>` **(** **)** vararg |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`printt<class_@GDScript_printt>` **(** **)** vararg |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`rad2deg<class_@GDScript_rad2deg>` **(** :ref:`float<class_float>` rad **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`rand_range<class_@GDScript_rand_range>` **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`rand_seed<class_@GDScript_rand_seed>` **(** :ref:`int<class_int>` seed **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`randf<class_@GDScript_randf>` **(** **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`randi<class_@GDScript_randi>` **(** **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`randomize<class_@GDScript_randomize>` **(** **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`range<class_@GDScript_range>` **(** **)** vararg |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`round<class_@GDScript_round>` **(** :ref:`float<class_float>` s **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`seed<class_@GDScript_seed>` **(** :ref:`int<class_int>` seed **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`sign<class_@GDScript_sign>` **(** :ref:`float<class_float>` s **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`sin<class_@GDScript_sin>` **(** :ref:`float<class_float>` s **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`sinh<class_@GDScript_sinh>` **(** :ref:`float<class_float>` s **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`sqrt<class_@GDScript_sqrt>` **(** :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:`String<class_string>` | :ref:`str<class_@GDScript_str>` **(** **)** vararg |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_variant>` | :ref:`str2var<class_@GDScript_str2var>` **(** :ref:`String<class_string>` string **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`tan<class_@GDScript_tan>` **(** :ref:`float<class_float>` s **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`tanh<class_@GDScript_tanh>` **(** :ref:`float<class_float>` s **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`to_json<class_@GDScript_to_json>` **(** :ref:`Variant<class_variant>` var **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`type_exists<class_@GDScript_type_exists>` **(** :ref:`String<class_string>` type **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`typeof<class_@GDScript_typeof>` **(** :ref:`Variant<class_variant>` what **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`validate_json<class_@GDScript_validate_json>` **(** :ref:`String<class_string>` json **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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
|
||||
-----------------
|
||||
@@ -190,7 +190,7 @@ Member Function Description
|
||||
|
||||
.. _class_@GDScript_Color8:
|
||||
|
||||
- :ref:`Color<class_color>` **Color8** **(** :ref:`int<class_int>` r8, :ref:`int<class_int>` g8, :ref:`int<class_int>` b8, :ref:`int<class_int>` a8 **)**
|
||||
- :ref:`Color<class_color>` **Color8** **(** :ref:`int<class_int>` r8, :ref:`int<class_int>` g8, :ref:`int<class_int>` b8, :ref:`int<class_int>` a8 **)**
|
||||
|
||||
Returns a 32 bit color with red, green, blue and alpha channels. Each channel has 8 bits of information ranging from 0 to 255.
|
||||
|
||||
@@ -208,7 +208,7 @@ Returns a 32 bit color with red, green, blue and alpha channels. Each channel ha
|
||||
|
||||
.. _class_@GDScript_ColorN:
|
||||
|
||||
- :ref:`Color<class_color>` **ColorN** **(** :ref:`String<class_string>` name, :ref:`float<class_float>` alpha **)**
|
||||
- :ref:`Color<class_color>` **ColorN** **(** :ref:`String<class_string>` name, :ref:`float<class_float>` alpha **)**
|
||||
|
||||
Returns color ``name`` with ``alpha`` ranging from 0 to 1. Note: ``name`` is defined in color_names.inc.
|
||||
|
||||
@@ -218,7 +218,7 @@ Returns color ``name`` with ``alpha`` ranging from 0 to 1. Note: ``name`` is def
|
||||
|
||||
.. _class_@GDScript_abs:
|
||||
|
||||
- :ref:`float<class_float>` **abs** **(** :ref:`float<class_float>` s **)**
|
||||
- :ref:`float<class_float>` **abs** **(** :ref:`float<class_float>` s **)**
|
||||
|
||||
Returns the absolute value of parameter ``s`` (i.e. unsigned value, works for integer and float).
|
||||
|
||||
@@ -229,7 +229,7 @@ Returns the absolute value of parameter ``s`` (i.e. unsigned value, works for i
|
||||
|
||||
.. _class_@GDScript_acos:
|
||||
|
||||
- :ref:`float<class_float>` **acos** **(** :ref:`float<class_float>` s **)**
|
||||
- :ref:`float<class_float>` **acos** **(** :ref:`float<class_float>` s **)**
|
||||
|
||||
Returns the arc cosine of ``s`` in radians. Use to get the angle of cosine ``s``.
|
||||
|
||||
@@ -240,7 +240,7 @@ Returns the arc cosine of ``s`` in radians. Use to get the angle of cosine ``s``
|
||||
|
||||
.. _class_@GDScript_asin:
|
||||
|
||||
- :ref:`float<class_float>` **asin** **(** :ref:`float<class_float>` s **)**
|
||||
- :ref:`float<class_float>` **asin** **(** :ref:`float<class_float>` s **)**
|
||||
|
||||
Returns the arc sine of ``s`` in radians. Use to get the angle of sine ``s``.
|
||||
|
||||
@@ -251,7 +251,7 @@ Returns the arc sine of ``s`` in radians. Use to get the angle of sine ``s``.
|
||||
|
||||
.. _class_@GDScript_assert:
|
||||
|
||||
- void **assert** **(** :ref:`bool<class_bool>` condition **)**
|
||||
- void **assert** **(** :ref:`bool<class_bool>` condition **)**
|
||||
|
||||
Assert that the ``condition`` is true. If the ``condition`` is false a fatal error is generated and the program is halted. Useful for debugging to make sure a value is always true.
|
||||
|
||||
@@ -265,7 +265,7 @@ Assert that the ``condition`` is true. If the ``condition`` is false a fatal err
|
||||
|
||||
.. _class_@GDScript_atan:
|
||||
|
||||
- :ref:`float<class_float>` **atan** **(** :ref:`float<class_float>` s **)**
|
||||
- :ref:`float<class_float>` **atan** **(** :ref:`float<class_float>` s **)**
|
||||
|
||||
Returns the arc tangent of ``s`` in radians. Use it to get the angle from an angle's tangent in trigonometry: ``atan(tan(angle)) == angle``.
|
||||
|
||||
@@ -277,7 +277,7 @@ The method cannot know in which quadrant the angle should fall. See :ref:`atan2<
|
||||
|
||||
.. _class_@GDScript_atan2:
|
||||
|
||||
- :ref:`float<class_float>` **atan2** **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)**
|
||||
- :ref:`float<class_float>` **atan2** **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)**
|
||||
|
||||
Returns the arc tangent of ``y/x`` in radians. Use to get the angle of tangent ``y/x``. To compute the value, the method takes into account the sign of both arguments in order to determine the quadrant.
|
||||
|
||||
@@ -287,13 +287,13 @@ Returns the arc tangent of ``y/x`` in radians. Use to get the angle of tangent `
|
||||
|
||||
.. _class_@GDScript_bytes2var:
|
||||
|
||||
- :ref:`Variant<class_variant>` **bytes2var** **(** :ref:`PoolByteArray<class_poolbytearray>` bytes **)**
|
||||
- :ref:`Variant<class_variant>` **bytes2var** **(** :ref:`PoolByteArray<class_poolbytearray>` bytes **)**
|
||||
|
||||
Decodes a byte array back to a value.
|
||||
|
||||
.. _class_@GDScript_ceil:
|
||||
|
||||
- :ref:`float<class_float>` **ceil** **(** :ref:`float<class_float>` s **)**
|
||||
- :ref:`float<class_float>` **ceil** **(** :ref:`float<class_float>` s **)**
|
||||
|
||||
Rounds ``s`` upward, returning the smallest integral value that is not less than ``s``.
|
||||
|
||||
@@ -304,7 +304,7 @@ Rounds ``s`` upward, returning the smallest integral value that is not less than
|
||||
|
||||
.. _class_@GDScript_char:
|
||||
|
||||
- :ref:`String<class_string>` **char** **(** :ref:`int<class_int>` ascii **)**
|
||||
- :ref:`String<class_string>` **char** **(** :ref:`int<class_int>` ascii **)**
|
||||
|
||||
Returns a character as a String of the given ASCII code.
|
||||
|
||||
@@ -317,7 +317,7 @@ Returns a character as a String of the given ASCII code.
|
||||
|
||||
.. _class_@GDScript_clamp:
|
||||
|
||||
- :ref:`float<class_float>` **clamp** **(** :ref:`float<class_float>` val, :ref:`float<class_float>` min, :ref:`float<class_float>` max **)**
|
||||
- :ref:`float<class_float>` **clamp** **(** :ref:`float<class_float>` val, :ref:`float<class_float>` min, :ref:`float<class_float>` max **)**
|
||||
|
||||
Clamps ``val`` and returns a value not less than ``min`` and not more than ``max``.
|
||||
|
||||
@@ -333,7 +333,7 @@ Clamps ``val`` and returns a value not less than ``min`` and not more than ``max
|
||||
|
||||
.. _class_@GDScript_convert:
|
||||
|
||||
- :ref:`Object<class_object>` **convert** **(** :ref:`Variant<class_variant>` what, :ref:`int<class_int>` type **)**
|
||||
- :ref:`Object<class_object>` **convert** **(** :ref:`Variant<class_variant>` what, :ref:`int<class_int>` type **)**
|
||||
|
||||
Converts from a type to another in the best way possible. The ``type`` parameter uses the enum TYPE\_\* in :ref:`@Global Scope<class_@global scope>`.
|
||||
|
||||
@@ -349,7 +349,7 @@ Converts from a type to another in the best way possible. The ``type`` parameter
|
||||
|
||||
.. _class_@GDScript_cos:
|
||||
|
||||
- :ref:`float<class_float>` **cos** **(** :ref:`float<class_float>` s **)**
|
||||
- :ref:`float<class_float>` **cos** **(** :ref:`float<class_float>` s **)**
|
||||
|
||||
Returns the cosine of angle ``s`` in radians.
|
||||
|
||||
@@ -361,7 +361,7 @@ Returns the cosine of angle ``s`` in radians.
|
||||
|
||||
.. _class_@GDScript_cosh:
|
||||
|
||||
- :ref:`float<class_float>` **cosh** **(** :ref:`float<class_float>` s **)**
|
||||
- :ref:`float<class_float>` **cosh** **(** :ref:`float<class_float>` s **)**
|
||||
|
||||
Returns the hyperbolic cosine of ``s`` in radians.
|
||||
|
||||
@@ -372,13 +372,13 @@ Returns the hyperbolic cosine of ``s`` in radians.
|
||||
|
||||
.. _class_@GDScript_db2linear:
|
||||
|
||||
- :ref:`float<class_float>` **db2linear** **(** :ref:`float<class_float>` db **)**
|
||||
- :ref:`float<class_float>` **db2linear** **(** :ref:`float<class_float>` db **)**
|
||||
|
||||
Converts from decibels to linear energy (audio).
|
||||
|
||||
.. _class_@GDScript_decimals:
|
||||
|
||||
- :ref:`float<class_float>` **decimals** **(** :ref:`float<class_float>` step **)**
|
||||
- :ref:`float<class_float>` **decimals** **(** :ref:`float<class_float>` step **)**
|
||||
|
||||
Returns the position of the first non-zero digit, after the decimal point.
|
||||
|
||||
@@ -389,7 +389,7 @@ Returns the position of the first non-zero digit, after the decimal point.
|
||||
|
||||
.. _class_@GDScript_dectime:
|
||||
|
||||
- :ref:`float<class_float>` **dectime** **(** :ref:`float<class_float>` value, :ref:`float<class_float>` amount, :ref:`float<class_float>` step **)**
|
||||
- :ref:`float<class_float>` **dectime** **(** :ref:`float<class_float>` value, :ref:`float<class_float>` amount, :ref:`float<class_float>` step **)**
|
||||
|
||||
Returns the result of ``value`` decreased by ``step`` \* ``amount``.
|
||||
|
||||
@@ -400,7 +400,7 @@ Returns the result of ``value`` decreased by ``step`` \* ``amount``.
|
||||
|
||||
.. _class_@GDScript_deg2rad:
|
||||
|
||||
- :ref:`float<class_float>` **deg2rad** **(** :ref:`float<class_float>` deg **)**
|
||||
- :ref:`float<class_float>` **deg2rad** **(** :ref:`float<class_float>` deg **)**
|
||||
|
||||
Returns degrees converted to radians.
|
||||
|
||||
@@ -411,19 +411,19 @@ Returns degrees converted to radians.
|
||||
|
||||
.. _class_@GDScript_dict2inst:
|
||||
|
||||
- :ref:`Object<class_object>` **dict2inst** **(** :ref:`Dictionary<class_dictionary>` dict **)**
|
||||
- :ref:`Object<class_object>` **dict2inst** **(** :ref:`Dictionary<class_dictionary>` dict **)**
|
||||
|
||||
Converts a previously converted instance to a dictionary, back into an instance. Useful for deserializing.
|
||||
|
||||
.. _class_@GDScript_ease:
|
||||
|
||||
- :ref:`float<class_float>` **ease** **(** :ref:`float<class_float>` s, :ref:`float<class_float>` curve **)**
|
||||
- :ref:`float<class_float>` **ease** **(** :ref:`float<class_float>` s, :ref:`float<class_float>` curve **)**
|
||||
|
||||
Easing function, based on exponent. 0 is constant, 1 is linear, 0 to 1 is ease-in, 1+ is ease out. Negative values are in-out/out in.
|
||||
|
||||
.. _class_@GDScript_exp:
|
||||
|
||||
- :ref:`float<class_float>` **exp** **(** :ref:`float<class_float>` s **)**
|
||||
- :ref:`float<class_float>` **exp** **(** :ref:`float<class_float>` s **)**
|
||||
|
||||
Raises the Euler's constant **e** to the power of ``s`` and returns it. **e** has an approximate value of 2.71828.
|
||||
|
||||
@@ -433,7 +433,7 @@ Raises the Euler's constant **e** to the power of ``s`` and returns it. **e** ha
|
||||
|
||||
.. _class_@GDScript_floor:
|
||||
|
||||
- :ref:`float<class_float>` **floor** **(** :ref:`float<class_float>` s **)**
|
||||
- :ref:`float<class_float>` **floor** **(** :ref:`float<class_float>` s **)**
|
||||
|
||||
Rounds ``s`` to the closest smaller integer and returns it.
|
||||
|
||||
@@ -446,7 +446,7 @@ Rounds ``s`` to the closest smaller integer and returns it.
|
||||
|
||||
.. _class_@GDScript_fmod:
|
||||
|
||||
- :ref:`float<class_float>` **fmod** **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)**
|
||||
- :ref:`float<class_float>` **fmod** **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)**
|
||||
|
||||
Returns the floating-point remainder of ``x/y``.
|
||||
|
||||
@@ -457,7 +457,7 @@ Returns the floating-point remainder of ``x/y``.
|
||||
|
||||
.. _class_@GDScript_fposmod:
|
||||
|
||||
- :ref:`float<class_float>` **fposmod** **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)**
|
||||
- :ref:`float<class_float>` **fposmod** **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)**
|
||||
|
||||
Returns the floating-point remainder of ``x/y`` that wraps equally in positive and negative.
|
||||
|
||||
@@ -485,7 +485,7 @@ Produces:
|
||||
|
||||
.. _class_@GDScript_funcref:
|
||||
|
||||
- :ref:`Object<class_object>` **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 **)**
|
||||
|
||||
Returns a reference to the specified function ``funcname`` in the ``instance`` node. As functions aren't first-class objects in GDscript, use ``funcref`` to store a :ref:`FuncRef<class_funcref>` in a variable and call it later.
|
||||
|
||||
@@ -499,7 +499,7 @@ Returns a reference to the specified function ``funcname`` in the ``instance`` n
|
||||
|
||||
.. _class_@GDScript_hash:
|
||||
|
||||
- :ref:`int<class_int>` **hash** **(** :ref:`Variant<class_variant>` var **)**
|
||||
- :ref:`int<class_int>` **hash** **(** :ref:`Variant<class_variant>` var **)**
|
||||
|
||||
Returns the integer hash of the variable passed.
|
||||
|
||||
@@ -509,7 +509,7 @@ Returns the integer hash of the variable passed.
|
||||
|
||||
.. _class_@GDScript_inst2dict:
|
||||
|
||||
- :ref:`Dictionary<class_dictionary>` **inst2dict** **(** :ref:`Object<class_object>` inst **)**
|
||||
- :ref:`Dictionary<class_dictionary>` **inst2dict** **(** :ref:`Object<class_object>` inst **)**
|
||||
|
||||
Returns the passed instance converted to a dictionary (useful for serializing).
|
||||
|
||||
@@ -530,7 +530,7 @@ Prints out:
|
||||
|
||||
.. _class_@GDScript_instance_from_id:
|
||||
|
||||
- :ref:`Object<class_object>` **instance_from_id** **(** :ref:`int<class_int>` instance_id **)**
|
||||
- :ref:`Object<class_object>` **instance_from_id** **(** :ref:`int<class_int>` instance_id **)**
|
||||
|
||||
Returns the Object that corresponds to ``instance_id``. All Objects have a unique instance ID.
|
||||
|
||||
@@ -544,7 +544,7 @@ Returns the Object that corresponds to ``instance_id``. All Objects have a uniqu
|
||||
|
||||
.. _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 **)**
|
||||
- :ref:`float<class_float>` **inverse_lerp** **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` value **)**
|
||||
|
||||
Returns a normalized value considering the given range.
|
||||
|
||||
@@ -554,19 +554,19 @@ Returns a normalized value considering the given range.
|
||||
|
||||
.. _class_@GDScript_is_inf:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_inf** **(** :ref:`float<class_float>` s **)**
|
||||
- :ref:`bool<class_bool>` **is_inf** **(** :ref:`float<class_float>` s **)**
|
||||
|
||||
Returns True/False whether ``s`` is an infinity value (either positive infinity or negative infinity).
|
||||
|
||||
.. _class_@GDScript_is_nan:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_nan** **(** :ref:`float<class_float>` s **)**
|
||||
- :ref:`bool<class_bool>` **is_nan** **(** :ref:`float<class_float>` s **)**
|
||||
|
||||
Returns True/False whether ``s`` is a NaN (Not-A-Number) value.
|
||||
|
||||
.. _class_@GDScript_len:
|
||||
|
||||
- :ref:`int<class_int>` **len** **(** :ref:`Variant<class_variant>` var **)**
|
||||
- :ref:`int<class_int>` **len** **(** :ref:`Variant<class_variant>` var **)**
|
||||
|
||||
Returns length of Variant ``var``. Length is the character count of String, element count of Array, size of Dictionary, etc. Note: Generates a fatal error if Variant can not provide a length.
|
||||
|
||||
@@ -577,7 +577,7 @@ Returns length of Variant ``var``. Length is the character count of String, elem
|
||||
|
||||
.. _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 **)**
|
||||
|
||||
Linearly interpolates between two values by a normalized value.
|
||||
|
||||
@@ -587,13 +587,13 @@ Linearly interpolates between two values by a normalized value.
|
||||
|
||||
.. _class_@GDScript_linear2db:
|
||||
|
||||
- :ref:`float<class_float>` **linear2db** **(** :ref:`float<class_float>` nrg **)**
|
||||
- :ref:`float<class_float>` **linear2db** **(** :ref:`float<class_float>` nrg **)**
|
||||
|
||||
Converts from linear energy to decibels (audio).
|
||||
|
||||
.. _class_@GDScript_load:
|
||||
|
||||
- :ref:`Object<class_object>` **load** **(** :ref:`String<class_string>` path **)**
|
||||
- :ref:`Object<class_object>` **load** **(** :ref:`String<class_string>` path **)**
|
||||
|
||||
Loads a resource from the filesystem located at 'path'. Note: resource paths can be obtained by right clicking on a resource in the Assets Panel and choosing "Copy Path".
|
||||
|
||||
@@ -604,7 +604,7 @@ Loads a resource from the filesystem located at 'path'. Note: resource paths can
|
||||
|
||||
.. _class_@GDScript_log:
|
||||
|
||||
- :ref:`float<class_float>` **log** **(** :ref:`float<class_float>` s **)**
|
||||
- :ref:`float<class_float>` **log** **(** :ref:`float<class_float>` s **)**
|
||||
|
||||
Natural logarithm. The amount of time needed to reach a certain level of continuous growth. Note: This is not the same as the log function on your calculator which is a base 10 logarithm.
|
||||
|
||||
@@ -614,7 +614,7 @@ Natural logarithm. The amount of time needed to reach a certain level of continu
|
||||
|
||||
.. _class_@GDScript_max:
|
||||
|
||||
- :ref:`float<class_float>` **max** **(** :ref:`float<class_float>` a, :ref:`float<class_float>` b **)**
|
||||
- :ref:`float<class_float>` **max** **(** :ref:`float<class_float>` a, :ref:`float<class_float>` b **)**
|
||||
|
||||
Returns the maximum of two values.
|
||||
|
||||
@@ -625,7 +625,7 @@ Returns the maximum of two values.
|
||||
|
||||
.. _class_@GDScript_min:
|
||||
|
||||
- :ref:`float<class_float>` **min** **(** :ref:`float<class_float>` a, :ref:`float<class_float>` b **)**
|
||||
- :ref:`float<class_float>` **min** **(** :ref:`float<class_float>` a, :ref:`float<class_float>` b **)**
|
||||
|
||||
Returns the minimum of two values.
|
||||
|
||||
@@ -636,7 +636,7 @@ Returns the minimum of two values.
|
||||
|
||||
.. _class_@GDScript_nearest_po2:
|
||||
|
||||
- :ref:`int<class_int>` **nearest_po2** **(** :ref:`int<class_int>` val **)**
|
||||
- :ref:`int<class_int>` **nearest_po2** **(** :ref:`int<class_int>` val **)**
|
||||
|
||||
Returns the nearest larger power of 2 for integer ``val``.
|
||||
|
||||
@@ -648,7 +648,7 @@ Returns the nearest larger power of 2 for integer ``val``.
|
||||
|
||||
.. _class_@GDScript_parse_json:
|
||||
|
||||
- :ref:`Variant<class_variant>` **parse_json** **(** :ref:`String<class_string>` json **)**
|
||||
- :ref:`Variant<class_variant>` **parse_json** **(** :ref:`String<class_string>` json **)**
|
||||
|
||||
Parse JSON text to a Variant (use :ref:`typeof<class_@GDScript_typeof>` to check if it is what you expect).
|
||||
|
||||
@@ -664,7 +664,7 @@ Be aware that the JSON specification does not define integer or float types, but
|
||||
|
||||
.. _class_@GDScript_pow:
|
||||
|
||||
- :ref:`float<class_float>` **pow** **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)**
|
||||
- :ref:`float<class_float>` **pow** **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)**
|
||||
|
||||
Returns the result of ``x`` raised to the power of ``y``.
|
||||
|
||||
@@ -674,7 +674,7 @@ Returns the result of ``x`` raised to the power of ``y``.
|
||||
|
||||
.. _class_@GDScript_preload:
|
||||
|
||||
- :ref:`Resource<class_resource>` **preload** **(** :ref:`String<class_string>` path **)**
|
||||
- :ref:`Resource<class_resource>` **preload** **(** :ref:`String<class_string>` path **)**
|
||||
|
||||
Returns a resource from the filesystem that is loaded during script parsing. Note: resource paths can be obtained by right clicking on a resource in the Assets Panel and choosing "Copy Path".
|
||||
|
||||
@@ -685,7 +685,7 @@ Returns a resource from the filesystem that is loaded during script parsing. Not
|
||||
|
||||
.. _class_@GDScript_print:
|
||||
|
||||
- void **print** **(** **)** vararg
|
||||
- void **print** **(** **)** vararg
|
||||
|
||||
Converts one or more arguments to strings in the best way possible and prints them to the console.
|
||||
|
||||
@@ -696,7 +696,7 @@ Converts one or more arguments to strings in the best way possible and prints th
|
||||
|
||||
.. _class_@GDScript_print_stack:
|
||||
|
||||
- void **print_stack** **(** **)**
|
||||
- void **print_stack** **(** **)**
|
||||
|
||||
Prints a stack track at code location, only works when running with debugger turned on.
|
||||
|
||||
@@ -708,7 +708,7 @@ Output in the console would look something like this:
|
||||
|
||||
.. _class_@GDScript_printerr:
|
||||
|
||||
- void **printerr** **(** **)** vararg
|
||||
- void **printerr** **(** **)** vararg
|
||||
|
||||
Prints one or more arguments to strings in the best way possible to standard error line.
|
||||
|
||||
@@ -718,7 +718,7 @@ Prints one or more arguments to strings in the best way possible to standard err
|
||||
|
||||
.. _class_@GDScript_printraw:
|
||||
|
||||
- void **printraw** **(** **)** vararg
|
||||
- void **printraw** **(** **)** vararg
|
||||
|
||||
Prints one or more arguments to strings in the best way possible to console. No newline is added at the end.
|
||||
|
||||
@@ -730,7 +730,7 @@ Prints one or more arguments to strings in the best way possible to console. No
|
||||
|
||||
.. _class_@GDScript_prints:
|
||||
|
||||
- void **prints** **(** **)** vararg
|
||||
- void **prints** **(** **)** vararg
|
||||
|
||||
Prints one or more arguments to the console with a space between each argument.
|
||||
|
||||
@@ -740,7 +740,7 @@ Prints one or more arguments to the console with a space between each argument.
|
||||
|
||||
.. _class_@GDScript_printt:
|
||||
|
||||
- void **printt** **(** **)** vararg
|
||||
- void **printt** **(** **)** vararg
|
||||
|
||||
Prints one or more arguments to the console with a tab between each argument.
|
||||
|
||||
@@ -750,7 +750,7 @@ Prints one or more arguments to the console with a tab between each argument.
|
||||
|
||||
.. _class_@GDScript_rad2deg:
|
||||
|
||||
- :ref:`float<class_float>` **rad2deg** **(** :ref:`float<class_float>` rad **)**
|
||||
- :ref:`float<class_float>` **rad2deg** **(** :ref:`float<class_float>` rad **)**
|
||||
|
||||
Converts from radians to degrees.
|
||||
|
||||
@@ -760,7 +760,7 @@ Converts from radians to degrees.
|
||||
|
||||
.. _class_@GDScript_rand_range:
|
||||
|
||||
- :ref:`float<class_float>` **rand_range** **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to **)**
|
||||
- :ref:`float<class_float>` **rand_range** **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to **)**
|
||||
|
||||
Random range, any floating point value between ``from`` and ``to``.
|
||||
|
||||
@@ -770,13 +770,13 @@ Random range, any floating point value between ``from`` and ``to``.
|
||||
|
||||
.. _class_@GDScript_rand_seed:
|
||||
|
||||
- :ref:`Array<class_array>` **rand_seed** **(** :ref:`int<class_int>` seed **)**
|
||||
- :ref:`Array<class_array>` **rand_seed** **(** :ref:`int<class_int>` seed **)**
|
||||
|
||||
Random from seed: pass a ``seed``, and an array with both number and new seed is returned. "Seed" here refers to the internal state of the pseudo random number generator. The internal state of the current implementation is 64 bits.
|
||||
|
||||
.. _class_@GDScript_randf:
|
||||
|
||||
- :ref:`float<class_float>` **randf** **(** **)**
|
||||
- :ref:`float<class_float>` **randf** **(** **)**
|
||||
|
||||
Returns a random floating point value between 0 and 1.
|
||||
|
||||
@@ -786,7 +786,7 @@ Returns a random floating point value between 0 and 1.
|
||||
|
||||
.. _class_@GDScript_randi:
|
||||
|
||||
- :ref:`int<class_int>` **randi** **(** **)**
|
||||
- :ref:`int<class_int>` **randi** **(** **)**
|
||||
|
||||
Returns a random 32 bit integer. Use remainder to obtain a random value between 0 and N (where N is smaller than 2^32 -1).
|
||||
|
||||
@@ -798,7 +798,7 @@ Returns a random 32 bit integer. Use remainder to obtain a random value between
|
||||
|
||||
.. _class_@GDScript_randomize:
|
||||
|
||||
- void **randomize** **(** **)**
|
||||
- void **randomize** **(** **)**
|
||||
|
||||
Randomizes the seed (or the internal state) of the random number generator. Current implementation reseeds using a number based on time.
|
||||
|
||||
@@ -809,7 +809,7 @@ Randomizes the seed (or the internal state) of the random number generator. Curr
|
||||
|
||||
.. _class_@GDScript_range:
|
||||
|
||||
- :ref:`Array<class_array>` **range** **(** **)** vararg
|
||||
- :ref:`Array<class_array>` **range** **(** **)** vararg
|
||||
|
||||
Returns 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).
|
||||
|
||||
@@ -841,7 +841,7 @@ Output:
|
||||
|
||||
.. _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 **)**
|
||||
- :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 **)**
|
||||
|
||||
Maps a ``value`` from range ``[istart, istop]`` to ``[ostart, ostop]``.
|
||||
|
||||
@@ -851,7 +851,7 @@ Maps a ``value`` from range ``[istart, istop]`` to ``[ostart, ostop]``.
|
||||
|
||||
.. _class_@GDScript_round:
|
||||
|
||||
- :ref:`float<class_float>` **round** **(** :ref:`float<class_float>` s **)**
|
||||
- :ref:`float<class_float>` **round** **(** :ref:`float<class_float>` s **)**
|
||||
|
||||
Returns the integral value that is nearest to ``s``, with halfway cases rounded away from zero.
|
||||
|
||||
@@ -861,7 +861,7 @@ Returns the integral value that is nearest to ``s``, with halfway cases rounded
|
||||
|
||||
.. _class_@GDScript_seed:
|
||||
|
||||
- void **seed** **(** :ref:`int<class_int>` seed **)**
|
||||
- void **seed** **(** :ref:`int<class_int>` seed **)**
|
||||
|
||||
Sets seed for the random number generator.
|
||||
|
||||
@@ -872,7 +872,7 @@ Sets seed for the random number generator.
|
||||
|
||||
.. _class_@GDScript_sign:
|
||||
|
||||
- :ref:`float<class_float>` **sign** **(** :ref:`float<class_float>` s **)**
|
||||
- :ref:`float<class_float>` **sign** **(** :ref:`float<class_float>` s **)**
|
||||
|
||||
Returns sign of ``s`` -1 or 1.
|
||||
|
||||
@@ -883,7 +883,7 @@ Returns sign of ``s`` -1 or 1.
|
||||
|
||||
.. _class_@GDScript_sin:
|
||||
|
||||
- :ref:`float<class_float>` **sin** **(** :ref:`float<class_float>` s **)**
|
||||
- :ref:`float<class_float>` **sin** **(** :ref:`float<class_float>` s **)**
|
||||
|
||||
Returns the sine of angle ``s`` in radians.
|
||||
|
||||
@@ -893,7 +893,7 @@ Returns the sine of angle ``s`` in radians.
|
||||
|
||||
.. _class_@GDScript_sinh:
|
||||
|
||||
- :ref:`float<class_float>` **sinh** **(** :ref:`float<class_float>` s **)**
|
||||
- :ref:`float<class_float>` **sinh** **(** :ref:`float<class_float>` s **)**
|
||||
|
||||
Returns the hyperbolic sine of ``s``.
|
||||
|
||||
@@ -904,7 +904,7 @@ Returns the hyperbolic sine of ``s``.
|
||||
|
||||
.. _class_@GDScript_sqrt:
|
||||
|
||||
- :ref:`float<class_float>` **sqrt** **(** :ref:`float<class_float>` s **)**
|
||||
- :ref:`float<class_float>` **sqrt** **(** :ref:`float<class_float>` s **)**
|
||||
|
||||
Returns the square root of ``s``.
|
||||
|
||||
@@ -914,13 +914,13 @@ Returns the square root of ``s``.
|
||||
|
||||
.. _class_@GDScript_stepify:
|
||||
|
||||
- :ref:`float<class_float>` **stepify** **(** :ref:`float<class_float>` s, :ref:`float<class_float>` step **)**
|
||||
- :ref:`float<class_float>` **stepify** **(** :ref:`float<class_float>` s, :ref:`float<class_float>` step **)**
|
||||
|
||||
Snaps float value ``s`` to a given ``step``.
|
||||
|
||||
.. _class_@GDScript_str:
|
||||
|
||||
- :ref:`String<class_string>` **str** **(** **)** vararg
|
||||
- :ref:`String<class_string>` **str** **(** **)** vararg
|
||||
|
||||
Converts one or more arguments to string in the best way possible.
|
||||
|
||||
@@ -933,7 +933,7 @@ Converts one or more arguments to string in the best way possible.
|
||||
|
||||
.. _class_@GDScript_str2var:
|
||||
|
||||
- :ref:`Variant<class_variant>` **str2var** **(** :ref:`String<class_string>` string **)**
|
||||
- :ref:`Variant<class_variant>` **str2var** **(** :ref:`String<class_string>` string **)**
|
||||
|
||||
Converts a formatted string that was returned by :ref:`var2str<class_@GDScript_var2str>` to the original value.
|
||||
|
||||
@@ -945,7 +945,7 @@ Converts a formatted string that was returned by :ref:`var2str<class_@GDScript_v
|
||||
|
||||
.. _class_@GDScript_tan:
|
||||
|
||||
- :ref:`float<class_float>` **tan** **(** :ref:`float<class_float>` s **)**
|
||||
- :ref:`float<class_float>` **tan** **(** :ref:`float<class_float>` s **)**
|
||||
|
||||
Returns the tangent of angle ``s`` in radians.
|
||||
|
||||
@@ -955,7 +955,7 @@ Returns the tangent of angle ``s`` in radians.
|
||||
|
||||
.. _class_@GDScript_tanh:
|
||||
|
||||
- :ref:`float<class_float>` **tanh** **(** :ref:`float<class_float>` s **)**
|
||||
- :ref:`float<class_float>` **tanh** **(** :ref:`float<class_float>` s **)**
|
||||
|
||||
Returns the hyperbolic tangent of ``s``.
|
||||
|
||||
@@ -966,7 +966,7 @@ Returns the hyperbolic tangent of ``s``.
|
||||
|
||||
.. _class_@GDScript_to_json:
|
||||
|
||||
- :ref:`String<class_string>` **to_json** **(** :ref:`Variant<class_variant>` var **)**
|
||||
- :ref:`String<class_string>` **to_json** **(** :ref:`Variant<class_variant>` var **)**
|
||||
|
||||
Converts a Variant ``var`` to JSON text and return the result. Useful for serializing data to store or send over the network.
|
||||
|
||||
@@ -978,7 +978,7 @@ Converts a Variant ``var`` to JSON text and return the result. Useful for serial
|
||||
|
||||
.. _class_@GDScript_type_exists:
|
||||
|
||||
- :ref:`bool<class_bool>` **type_exists** **(** :ref:`String<class_string>` type **)**
|
||||
- :ref:`bool<class_bool>` **type_exists** **(** :ref:`String<class_string>` type **)**
|
||||
|
||||
Returns whether the given class exists in :ref:`ClassDB<class_classdb>`.
|
||||
|
||||
@@ -989,7 +989,7 @@ Returns whether the given class exists in :ref:`ClassDB<class_classdb>`.
|
||||
|
||||
.. _class_@GDScript_typeof:
|
||||
|
||||
- :ref:`int<class_int>` **typeof** **(** :ref:`Variant<class_variant>` what **)**
|
||||
- :ref:`int<class_int>` **typeof** **(** :ref:`Variant<class_variant>` what **)**
|
||||
|
||||
Returns the internal type of the given Variant object, using the TYPE\_\* enum in :ref:`@Global Scope<class_@global scope>`.
|
||||
|
||||
@@ -1003,7 +1003,7 @@ Returns the internal type of the given Variant object, using the TYPE\_\* enum i
|
||||
|
||||
.. _class_@GDScript_validate_json:
|
||||
|
||||
- :ref:`String<class_string>` **validate_json** **(** :ref:`String<class_string>` json **)**
|
||||
- :ref:`String<class_string>` **validate_json** **(** :ref:`String<class_string>` json **)**
|
||||
|
||||
Checks that ``json`` is valid JSON data. Returns empty string if valid. Returns error message if not valid.
|
||||
|
||||
@@ -1018,13 +1018,13 @@ Checks that ``json`` is valid JSON data. Returns empty string if valid. Returns
|
||||
|
||||
.. _class_@GDScript_var2bytes:
|
||||
|
||||
- :ref:`PoolByteArray<class_poolbytearray>` **var2bytes** **(** :ref:`Variant<class_variant>` var **)**
|
||||
- :ref:`PoolByteArray<class_poolbytearray>` **var2bytes** **(** :ref:`Variant<class_variant>` var **)**
|
||||
|
||||
Encodes a variable value to a byte array.
|
||||
|
||||
.. _class_@GDScript_var2str:
|
||||
|
||||
- :ref:`String<class_string>` **var2str** **(** :ref:`Variant<class_variant>` var **)**
|
||||
- :ref:`String<class_string>` **var2str** **(** :ref:`Variant<class_variant>` var **)**
|
||||
|
||||
Converts a Variant ``var`` to a formatted string that can later be parsed using :ref:`str2var<class_@GDScript_str2var>`.
|
||||
|
||||
@@ -1044,7 +1044,7 @@ prints
|
||||
|
||||
.. _class_@GDScript_weakref:
|
||||
|
||||
- :ref:`Object<class_object>` **weakref** **(** :ref:`Object<class_object>` obj **)**
|
||||
- :ref:`Object<class_object>` **weakref** **(** :ref:`Object<class_object>` obj **)**
|
||||
|
||||
Returns a weak reference to an object.
|
||||
|
||||
@@ -1052,7 +1052,7 @@ A weak reference to an object is not enough to keep the object alive: when the o
|
||||
|
||||
.. _class_@GDScript_yield:
|
||||
|
||||
- :ref:`GDFunctionState<class_gdfunctionstate>` **yield** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` signal **)**
|
||||
- :ref:`GDFunctionState<class_gdfunctionstate>` **yield** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` signal **)**
|
||||
|
||||
Stops the function execution and returns the current state. Call :ref:`GDFunctionState.resume<class_GDFunctionState_resume>` on the state to resume execution. This invalidates the state.
|
||||
|
||||
|
||||
@@ -21,38 +21,38 @@ Base dialog for user notification.
|
||||
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_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:`Label<class_label>` | :ref:`get_label<class_AcceptDialog_get_label>` **(** **)** |
|
||||
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Button<class_button>` | :ref:`get_ok<class_AcceptDialog_get_ok>` **(** **)** |
|
||||
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_text<class_AcceptDialog_get_text>` **(** **)** const |
|
||||
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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_text<class_AcceptDialog_set_text>` **(** :ref:`String<class_string>` text **)** |
|
||||
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Button<class_button>` | :ref:`add_button<class_AcceptDialog_add_button>` **(** :ref:`String<class_string>` text, :ref:`bool<class_bool>` right=false, :ref:`String<class_string>` action="" **)** |
|
||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Button<class_button>` | :ref:`add_cancel<class_AcceptDialog_add_cancel>` **(** :ref:`String<class_string>` name **)** |
|
||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_hide_on_ok<class_AcceptDialog_get_hide_on_ok>` **(** **)** const |
|
||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Label<class_label>` | :ref:`get_label<class_AcceptDialog_get_label>` **(** **)** |
|
||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Button<class_button>` | :ref:`get_ok<class_AcceptDialog_get_ok>` **(** **)** |
|
||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_text<class_AcceptDialog_get_text>` **(** **)** const |
|
||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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_text<class_AcceptDialog_set_text>` **(** :ref:`String<class_string>` text **)** |
|
||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_AcceptDialog_confirmed:
|
||||
|
||||
- **confirmed** **(** **)**
|
||||
- **confirmed** **(** **)**
|
||||
|
||||
Emitted when the dialog is accepted.
|
||||
|
||||
.. _class_AcceptDialog_custom_action:
|
||||
|
||||
- **custom_action** **(** :ref:`String<class_string>` action **)**
|
||||
- **custom_action** **(** :ref:`String<class_string>` action **)**
|
||||
|
||||
Emitted when a custom button is pressed. See :ref:`add_button<class_AcceptDialog_add_button>`.
|
||||
|
||||
@@ -79,7 +79,7 @@ Member Function Description
|
||||
|
||||
.. _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="" **)**
|
||||
|
||||
Adds a button with label *text* and a custom *action* to the dialog and returns the created button. *action* will be passed to the custom_action signal when pressed.
|
||||
|
||||
@@ -87,49 +87,49 @@ If ``true``, *right* will place the button to the right of any sibling buttons.
|
||||
|
||||
.. _class_AcceptDialog_add_cancel:
|
||||
|
||||
- :ref:`Button<class_button>` **add_cancel** **(** :ref:`String<class_string>` name **)**
|
||||
- :ref:`Button<class_button>` **add_cancel** **(** :ref:`String<class_string>` name **)**
|
||||
|
||||
Adds a button with label *name* and a cancel action to the dialog and returns the created button.
|
||||
|
||||
.. _class_AcceptDialog_get_hide_on_ok:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_hide_on_ok** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **get_hide_on_ok** **(** **)** const
|
||||
|
||||
Return true if the dialog will be hidden when accepted (default true).
|
||||
|
||||
.. _class_AcceptDialog_get_label:
|
||||
|
||||
- :ref:`Label<class_label>` **get_label** **(** **)**
|
||||
- :ref:`Label<class_label>` **get_label** **(** **)**
|
||||
|
||||
Return the label used for built-in text.
|
||||
|
||||
.. _class_AcceptDialog_get_ok:
|
||||
|
||||
- :ref:`Button<class_button>` **get_ok** **(** **)**
|
||||
- :ref:`Button<class_button>` **get_ok** **(** **)**
|
||||
|
||||
Return the OK Button.
|
||||
|
||||
.. _class_AcceptDialog_get_text:
|
||||
|
||||
- :ref:`String<class_string>` **get_text** **(** **)** const
|
||||
- :ref:`String<class_string>` **get_text** **(** **)** const
|
||||
|
||||
Return the built-in label text.
|
||||
|
||||
.. _class_AcceptDialog_register_text_enter:
|
||||
|
||||
- void **register_text_enter** **(** :ref:`Node<class_node>` line_edit **)**
|
||||
- void **register_text_enter** **(** :ref:`Node<class_node>` line_edit **)**
|
||||
|
||||
Registers a :ref:`LineEdit<class_lineedit>` in the dialog. When the enter key is pressed, the dialog will be accepted.
|
||||
|
||||
.. _class_AcceptDialog_set_hide_on_ok:
|
||||
|
||||
- void **set_hide_on_ok** **(** :ref:`bool<class_bool>` enabled **)**
|
||||
- void **set_hide_on_ok** **(** :ref:`bool<class_bool>` enabled **)**
|
||||
|
||||
Set whether the dialog is hidden when accepted (default true).
|
||||
|
||||
.. _class_AcceptDialog_set_text:
|
||||
|
||||
- void **set_text** **(** :ref:`String<class_string>` text **)**
|
||||
- void **set_text** **(** :ref:`String<class_string>` text **)**
|
||||
|
||||
Set the built-in label text.
|
||||
|
||||
|
||||
@@ -19,54 +19,54 @@ Sprite node that can use multiple textures for animation.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_animation<class_AnimatedSprite_get_animation>` **(** **)** const |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_frame<class_AnimatedSprite_get_frame>` **(** **)** const |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_offset<class_AnimatedSprite_get_offset>` **(** **)** const |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`SpriteFrames<class_spriteframes>` | :ref:`get_sprite_frames<class_AnimatedSprite_get_sprite_frames>` **(** **)** const |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_centered<class_AnimatedSprite_is_centered>` **(** **)** const |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_flipped_h<class_AnimatedSprite_is_flipped_h>` **(** **)** const |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_flipped_v<class_AnimatedSprite_is_flipped_v>` **(** **)** const |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AnimatedSprite_is_playing>` **(** **)** const |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`play<class_AnimatedSprite_play>` **(** :ref:`String<class_string>` anim="" **)** |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_animation<class_AnimatedSprite_set_animation>` **(** :ref:`String<class_string>` animation **)** |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_centered<class_AnimatedSprite_set_centered>` **(** :ref:`bool<class_bool>` centered **)** |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_flip_h<class_AnimatedSprite_set_flip_h>` **(** :ref:`bool<class_bool>` flip_h **)** |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_flip_v<class_AnimatedSprite_set_flip_v>` **(** :ref:`bool<class_bool>` flip_v **)** |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_frame<class_AnimatedSprite_set_frame>` **(** :ref:`int<class_int>` frame **)** |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_offset<class_AnimatedSprite_set_offset>` **(** :ref:`Vector2<class_vector2>` offset **)** |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_sprite_frames<class_AnimatedSprite_set_sprite_frames>` **(** :ref:`SpriteFrames<class_spriteframes>` sprite_frames **)** |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`stop<class_AnimatedSprite_stop>` **(** **)** |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_animation<class_AnimatedSprite_get_animation>` **(** **)** const |
|
||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_frame<class_AnimatedSprite_get_frame>` **(** **)** const |
|
||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_offset<class_AnimatedSprite_get_offset>` **(** **)** const |
|
||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`SpriteFrames<class_spriteframes>` | :ref:`get_sprite_frames<class_AnimatedSprite_get_sprite_frames>` **(** **)** const |
|
||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_centered<class_AnimatedSprite_is_centered>` **(** **)** const |
|
||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_flipped_h<class_AnimatedSprite_is_flipped_h>` **(** **)** const |
|
||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_flipped_v<class_AnimatedSprite_is_flipped_v>` **(** **)** const |
|
||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AnimatedSprite_is_playing>` **(** **)** const |
|
||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`play<class_AnimatedSprite_play>` **(** :ref:`String<class_string>` anim="" **)** |
|
||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_animation<class_AnimatedSprite_set_animation>` **(** :ref:`String<class_string>` animation **)** |
|
||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_centered<class_AnimatedSprite_set_centered>` **(** :ref:`bool<class_bool>` centered **)** |
|
||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_flip_h<class_AnimatedSprite_set_flip_h>` **(** :ref:`bool<class_bool>` flip_h **)** |
|
||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_flip_v<class_AnimatedSprite_set_flip_v>` **(** :ref:`bool<class_bool>` flip_v **)** |
|
||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_frame<class_AnimatedSprite_set_frame>` **(** :ref:`int<class_int>` frame **)** |
|
||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_offset<class_AnimatedSprite_set_offset>` **(** :ref:`Vector2<class_vector2>` offset **)** |
|
||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_sprite_frames<class_AnimatedSprite_set_sprite_frames>` **(** :ref:`SpriteFrames<class_spriteframes>` sprite_frames **)** |
|
||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`stop<class_AnimatedSprite_stop>` **(** **)** |
|
||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_AnimatedSprite_animation_finished:
|
||||
|
||||
- **animation_finished** **(** **)**
|
||||
- **animation_finished** **(** **)**
|
||||
|
||||
Emitted when the animation is finished (when it plays the last frame). If the animation is looping, this signal is emitted every time the last frame is drawn.
|
||||
|
||||
.. _class_AnimatedSprite_frame_changed:
|
||||
|
||||
- **frame_changed** **(** **)**
|
||||
- **frame_changed** **(** **)**
|
||||
|
||||
Emitted when :ref:`frame<class_AnimatedSprite_frame>` changed.
|
||||
|
||||
@@ -117,103 +117,103 @@ Member Function Description
|
||||
|
||||
.. _class_AnimatedSprite_get_animation:
|
||||
|
||||
- :ref:`String<class_string>` **get_animation** **(** **)** const
|
||||
- :ref:`String<class_string>` **get_animation** **(** **)** const
|
||||
|
||||
Return the name of the current animation set to the node.
|
||||
|
||||
.. _class_AnimatedSprite_get_frame:
|
||||
|
||||
- :ref:`int<class_int>` **get_frame** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_frame** **(** **)** const
|
||||
|
||||
Return the visible frame index.
|
||||
|
||||
.. _class_AnimatedSprite_get_offset:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **get_offset** **(** **)** const
|
||||
- :ref:`Vector2<class_vector2>` **get_offset** **(** **)** const
|
||||
|
||||
Return the offset of the sprite in the node origin.
|
||||
|
||||
.. _class_AnimatedSprite_get_sprite_frames:
|
||||
|
||||
- :ref:`SpriteFrames<class_spriteframes>` **get_sprite_frames** **(** **)** const
|
||||
- :ref:`SpriteFrames<class_spriteframes>` **get_sprite_frames** **(** **)** const
|
||||
|
||||
Get the :ref:`SpriteFrames<class_spriteframes>` resource, which contains all frames.
|
||||
|
||||
.. _class_AnimatedSprite_is_centered:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_centered** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_centered** **(** **)** const
|
||||
|
||||
Return true when centered. See :ref:`set_centered<class_AnimatedSprite_set_centered>`.
|
||||
|
||||
.. _class_AnimatedSprite_is_flipped_h:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_flipped_h** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_flipped_h** **(** **)** const
|
||||
|
||||
Return true if sprite is flipped horizontally.
|
||||
|
||||
.. _class_AnimatedSprite_is_flipped_v:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_flipped_v** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_flipped_v** **(** **)** const
|
||||
|
||||
Return true if sprite is flipped vertically.
|
||||
|
||||
.. _class_AnimatedSprite_is_playing:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_playing** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_playing** **(** **)** const
|
||||
|
||||
Return true if an animation if currently being played.
|
||||
|
||||
.. _class_AnimatedSprite_play:
|
||||
|
||||
- void **play** **(** :ref:`String<class_string>` anim="" **)**
|
||||
- void **play** **(** :ref:`String<class_string>` anim="" **)**
|
||||
|
||||
Play the animation set in parameter. If no parameter is provided, the current animation is played.
|
||||
|
||||
.. _class_AnimatedSprite_set_animation:
|
||||
|
||||
- void **set_animation** **(** :ref:`String<class_string>` animation **)**
|
||||
- void **set_animation** **(** :ref:`String<class_string>` animation **)**
|
||||
|
||||
Set the current animation of the node and reinits the frame counter of the animation.
|
||||
|
||||
.. _class_AnimatedSprite_set_centered:
|
||||
|
||||
- void **set_centered** **(** :ref:`bool<class_bool>` centered **)**
|
||||
- void **set_centered** **(** :ref:`bool<class_bool>` centered **)**
|
||||
|
||||
When turned on, offset at (0,0) is the center of the sprite, when off, the top-left corner is.
|
||||
|
||||
.. _class_AnimatedSprite_set_flip_h:
|
||||
|
||||
- void **set_flip_h** **(** :ref:`bool<class_bool>` flip_h **)**
|
||||
- void **set_flip_h** **(** :ref:`bool<class_bool>` flip_h **)**
|
||||
|
||||
If true, sprite is flipped horizontally.
|
||||
|
||||
.. _class_AnimatedSprite_set_flip_v:
|
||||
|
||||
- void **set_flip_v** **(** :ref:`bool<class_bool>` flip_v **)**
|
||||
- void **set_flip_v** **(** :ref:`bool<class_bool>` flip_v **)**
|
||||
|
||||
If true, sprite is flipped vertically.
|
||||
|
||||
.. _class_AnimatedSprite_set_frame:
|
||||
|
||||
- void **set_frame** **(** :ref:`int<class_int>` frame **)**
|
||||
- void **set_frame** **(** :ref:`int<class_int>` frame **)**
|
||||
|
||||
Set the visible sprite frame index (from the list of frames inside the :ref:`SpriteFrames<class_spriteframes>` resource).
|
||||
|
||||
.. _class_AnimatedSprite_set_offset:
|
||||
|
||||
- void **set_offset** **(** :ref:`Vector2<class_vector2>` offset **)**
|
||||
- void **set_offset** **(** :ref:`Vector2<class_vector2>` offset **)**
|
||||
|
||||
Set the offset of the sprite in the node origin. Position varies depending on whether it is centered or not.
|
||||
|
||||
.. _class_AnimatedSprite_set_sprite_frames:
|
||||
|
||||
- void **set_sprite_frames** **(** :ref:`SpriteFrames<class_spriteframes>` sprite_frames **)**
|
||||
- void **set_sprite_frames** **(** :ref:`SpriteFrames<class_spriteframes>` sprite_frames **)**
|
||||
|
||||
Set the :ref:`SpriteFrames<class_spriteframes>` resource, which contains all frames.
|
||||
|
||||
.. _class_AnimatedSprite_stop:
|
||||
|
||||
- void **stop** **(** **)**
|
||||
- void **stop** **(** **)**
|
||||
|
||||
Stop the current animation (does not reset the frame counter).
|
||||
|
||||
|
||||
@@ -19,32 +19,32 @@ Brief Description
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_animation<class_AnimatedSprite3D_get_animation>` **(** **)** const |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_frame<class_AnimatedSprite3D_get_frame>` **(** **)** const |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`SpriteFrames<class_spriteframes>` | :ref:`get_sprite_frames<class_AnimatedSprite3D_get_sprite_frames>` **(** **)** const |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AnimatedSprite3D_is_playing>` **(** **)** const |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`play<class_AnimatedSprite3D_play>` **(** :ref:`String<class_string>` anim="" **)** |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_animation<class_AnimatedSprite3D_set_animation>` **(** :ref:`String<class_string>` animation **)** |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_frame<class_AnimatedSprite3D_set_frame>` **(** :ref:`int<class_int>` frame **)** |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_sprite_frames<class_AnimatedSprite3D_set_sprite_frames>` **(** :ref:`SpriteFrames<class_spriteframes>` sprite_frames **)** |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`stop<class_AnimatedSprite3D_stop>` **(** **)** |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_animation<class_AnimatedSprite3D_get_animation>` **(** **)** const |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_frame<class_AnimatedSprite3D_get_frame>` **(** **)** const |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`SpriteFrames<class_spriteframes>` | :ref:`get_sprite_frames<class_AnimatedSprite3D_get_sprite_frames>` **(** **)** const |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AnimatedSprite3D_is_playing>` **(** **)** const |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`play<class_AnimatedSprite3D_play>` **(** :ref:`String<class_string>` anim="" **)** |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_animation<class_AnimatedSprite3D_set_animation>` **(** :ref:`String<class_string>` animation **)** |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_frame<class_AnimatedSprite3D_set_frame>` **(** :ref:`int<class_int>` frame **)** |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_sprite_frames<class_AnimatedSprite3D_set_sprite_frames>` **(** :ref:`SpriteFrames<class_spriteframes>` sprite_frames **)** |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`stop<class_AnimatedSprite3D_stop>` **(** **)** |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_AnimatedSprite3D_frame_changed:
|
||||
|
||||
- **frame_changed** **(** **)**
|
||||
- **frame_changed** **(** **)**
|
||||
|
||||
Emitted when :ref:`frame<class_AnimatedSprite3D_frame>` changed.
|
||||
|
||||
@@ -79,55 +79,55 @@ Member Function Description
|
||||
|
||||
.. _class_AnimatedSprite3D_get_animation:
|
||||
|
||||
- :ref:`String<class_string>` **get_animation** **(** **)** const
|
||||
- :ref:`String<class_string>` **get_animation** **(** **)** const
|
||||
|
||||
Return the name of the current animation set to the node.
|
||||
|
||||
.. _class_AnimatedSprite3D_get_frame:
|
||||
|
||||
- :ref:`int<class_int>` **get_frame** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_frame** **(** **)** const
|
||||
|
||||
Return the visible frame index.
|
||||
|
||||
.. _class_AnimatedSprite3D_get_sprite_frames:
|
||||
|
||||
- :ref:`SpriteFrames<class_spriteframes>` **get_sprite_frames** **(** **)** const
|
||||
- :ref:`SpriteFrames<class_spriteframes>` **get_sprite_frames** **(** **)** const
|
||||
|
||||
Get the :ref:`SpriteFrames<class_spriteframes>` resource, which contains all frames.
|
||||
|
||||
.. _class_AnimatedSprite3D_is_playing:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_playing** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_playing** **(** **)** const
|
||||
|
||||
Return true if an animation if currently being played.
|
||||
|
||||
.. _class_AnimatedSprite3D_play:
|
||||
|
||||
- void **play** **(** :ref:`String<class_string>` anim="" **)**
|
||||
- void **play** **(** :ref:`String<class_string>` anim="" **)**
|
||||
|
||||
Play the animation set in parameter. If no parameter is provided, the current animation is played.
|
||||
|
||||
.. _class_AnimatedSprite3D_set_animation:
|
||||
|
||||
- void **set_animation** **(** :ref:`String<class_string>` animation **)**
|
||||
- void **set_animation** **(** :ref:`String<class_string>` animation **)**
|
||||
|
||||
Set the current animation of the node and reinits the frame counter of the animation.
|
||||
|
||||
.. _class_AnimatedSprite3D_set_frame:
|
||||
|
||||
- void **set_frame** **(** :ref:`int<class_int>` frame **)**
|
||||
- void **set_frame** **(** :ref:`int<class_int>` frame **)**
|
||||
|
||||
Set the visible sprite frame index (from the list of frames inside the :ref:`SpriteFrames<class_spriteframes>` resource).
|
||||
|
||||
.. _class_AnimatedSprite3D_set_sprite_frames:
|
||||
|
||||
- void **set_sprite_frames** **(** :ref:`SpriteFrames<class_spriteframes>` sprite_frames **)**
|
||||
- void **set_sprite_frames** **(** :ref:`SpriteFrames<class_spriteframes>` sprite_frames **)**
|
||||
|
||||
Set the :ref:`SpriteFrames<class_spriteframes>` resource, which contains all frames.
|
||||
|
||||
.. _class_AnimatedSprite3D_stop:
|
||||
|
||||
- void **stop** **(** **)**
|
||||
- void **stop** **(** **)**
|
||||
|
||||
Stop the current animation (does not reset the frame counter).
|
||||
|
||||
|
||||
@@ -19,87 +19,87 @@ Contains data used to animate everything in the engine.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`add_track<class_Animation_add_track>` **(** :ref:`int<class_int>` type, :ref:`int<class_int>` at_position=-1 **)** |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear<class_Animation_clear>` **(** **)** |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`find_track<class_Animation_find_track>` **(** :ref:`NodePath<class_nodepath>` path **)** const |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_length<class_Animation_get_length>` **(** **)** const |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_step<class_Animation_get_step>` **(** **)** const |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_track_count<class_Animation_get_track_count>` **(** **)** const |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_loop<class_Animation_has_loop>` **(** **)** const |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolIntArray<class_poolintarray>` | :ref:`method_track_get_key_indices<class_Animation_method_track_get_key_indices>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`method_track_get_name<class_Animation_method_track_get_name>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`method_track_get_params<class_Animation_method_track_get_params>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_track<class_Animation_remove_track>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_length<class_Animation_set_length>` **(** :ref:`float<class_float>` time_sec **)** |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_loop<class_Animation_set_loop>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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:`bool<class_bool>` | :ref:`track_get_interpolation_loop_wrap<class_Animation_track_get_interpolation_loop_wrap>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`track_get_interpolation_type<class_Animation_track_get_interpolation_type>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`track_get_key_count<class_Animation_track_get_key_count>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`track_get_key_time<class_Animation_track_get_key_time>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`track_get_key_transition<class_Animation_track_get_key_transition>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`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 **)** |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`track_is_imported<class_Animation_track_is_imported>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_move_down<class_Animation_track_move_down>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_move_up<class_Animation_track_move_up>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_remove_key<class_Animation_track_remove_key>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_remove_key_at_position<class_Animation_track_remove_key_at_position>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` position **)** |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_set_imported<class_Animation_track_set_imported>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` imported **)** |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_set_interpolation_loop_wrap<class_Animation_track_set_interpolation_loop_wrap>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` interpolation **)** |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_set_interpolation_type<class_Animation_track_set_interpolation_type>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` interpolation **)** |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_set_key_transition<class_Animation_track_set_key_transition>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`float<class_float>` transition **)** |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_set_key_value<class_Animation_track_set_key_value>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key, :ref:`Variant<class_variant>` value **)** |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_set_path<class_Animation_track_set_path>` **(** :ref:`int<class_int>` idx, :ref:`NodePath<class_nodepath>` path **)** |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`transform_track_insert_key<class_Animation_transform_track_insert_key>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`Vector3<class_vector3>` location, :ref:`Quat<class_quat>` rotation, :ref:`Vector3<class_vector3>` scale **)** |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`transform_track_interpolate<class_Animation_transform_track_interpolate>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec **)** const |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolIntArray<class_poolintarray>` | :ref:`value_track_get_key_indices<class_Animation_value_track_get_key_indices>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`value_track_get_update_mode<class_Animation_value_track_get_update_mode>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`value_track_set_update_mode<class_Animation_value_track_set_update_mode>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` mode **)** |
|
||||
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`add_track<class_Animation_add_track>` **(** :ref:`int<class_int>` type, :ref:`int<class_int>` at_position=-1 **)** |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear<class_Animation_clear>` **(** **)** |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`find_track<class_Animation_find_track>` **(** :ref:`NodePath<class_nodepath>` path **)** const |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_length<class_Animation_get_length>` **(** **)** const |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_step<class_Animation_get_step>` **(** **)** const |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_track_count<class_Animation_get_track_count>` **(** **)** const |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_loop<class_Animation_has_loop>` **(** **)** const |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolIntArray<class_poolintarray>` | :ref:`method_track_get_key_indices<class_Animation_method_track_get_key_indices>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`method_track_get_name<class_Animation_method_track_get_name>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`method_track_get_params<class_Animation_method_track_get_params>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_track<class_Animation_remove_track>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_length<class_Animation_set_length>` **(** :ref:`float<class_float>` time_sec **)** |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_loop<class_Animation_set_loop>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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:`bool<class_bool>` | :ref:`track_get_interpolation_loop_wrap<class_Animation_track_get_interpolation_loop_wrap>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`track_get_interpolation_type<class_Animation_track_get_interpolation_type>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`track_get_key_count<class_Animation_track_get_key_count>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`track_get_key_time<class_Animation_track_get_key_time>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`track_get_key_transition<class_Animation_track_get_key_transition>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`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 **)** |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`track_is_imported<class_Animation_track_is_imported>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_move_down<class_Animation_track_move_down>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_move_up<class_Animation_track_move_up>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_remove_key<class_Animation_track_remove_key>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_remove_key_at_position<class_Animation_track_remove_key_at_position>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` position **)** |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_set_imported<class_Animation_track_set_imported>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` imported **)** |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_set_interpolation_loop_wrap<class_Animation_track_set_interpolation_loop_wrap>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` interpolation **)** |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_set_interpolation_type<class_Animation_track_set_interpolation_type>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` interpolation **)** |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_set_key_transition<class_Animation_track_set_key_transition>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`float<class_float>` transition **)** |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_set_key_value<class_Animation_track_set_key_value>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key, :ref:`Variant<class_variant>` value **)** |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`track_set_path<class_Animation_track_set_path>` **(** :ref:`int<class_int>` idx, :ref:`NodePath<class_nodepath>` path **)** |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`transform_track_insert_key<class_Animation_transform_track_insert_key>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`Vector3<class_vector3>` location, :ref:`Quat<class_quat>` rotation, :ref:`Vector3<class_vector3>` scale **)** |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`transform_track_interpolate<class_Animation_transform_track_interpolate>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec **)** const |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolIntArray<class_poolintarray>` | :ref:`value_track_get_key_indices<class_Animation_value_track_get_key_indices>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`value_track_get_update_mode<class_Animation_value_track_get_update_mode>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`value_track_set_update_mode<class_Animation_value_track_set_update_mode>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` mode **)** |
|
||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Numeric Constants
|
||||
-----------------
|
||||
@@ -126,237 +126,237 @@ Member Function Description
|
||||
|
||||
.. _class_Animation_add_track:
|
||||
|
||||
- :ref:`int<class_int>` **add_track** **(** :ref:`int<class_int>` type, :ref:`int<class_int>` at_position=-1 **)**
|
||||
- :ref:`int<class_int>` **add_track** **(** :ref:`int<class_int>` type, :ref:`int<class_int>` at_position=-1 **)**
|
||||
|
||||
Add a track to the Animation. The track type must be specified as any of the values in the TYPE\_\* enumeration.
|
||||
|
||||
.. _class_Animation_clear:
|
||||
|
||||
- void **clear** **(** **)**
|
||||
- void **clear** **(** **)**
|
||||
|
||||
Clear the animation (clear all tracks and reset all).
|
||||
|
||||
.. _class_Animation_find_track:
|
||||
|
||||
- :ref:`int<class_int>` **find_track** **(** :ref:`NodePath<class_nodepath>` path **)** const
|
||||
- :ref:`int<class_int>` **find_track** **(** :ref:`NodePath<class_nodepath>` path **)** const
|
||||
|
||||
Return the index of the specified track. If the track is not found, return -1.
|
||||
|
||||
.. _class_Animation_get_length:
|
||||
|
||||
- :ref:`float<class_float>` **get_length** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_length** **(** **)** const
|
||||
|
||||
Return the total length of the animation (in seconds).
|
||||
|
||||
.. _class_Animation_get_step:
|
||||
|
||||
- :ref:`float<class_float>` **get_step** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_step** **(** **)** const
|
||||
|
||||
Get the animation step value.
|
||||
|
||||
.. _class_Animation_get_track_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_track_count** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_track_count** **(** **)** const
|
||||
|
||||
Return the amount of tracks in the animation.
|
||||
|
||||
.. _class_Animation_has_loop:
|
||||
|
||||
- :ref:`bool<class_bool>` **has_loop** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **has_loop** **(** **)** const
|
||||
|
||||
Return whether the animation has the loop flag set.
|
||||
|
||||
.. _class_Animation_method_track_get_key_indices:
|
||||
|
||||
- :ref:`PoolIntArray<class_poolintarray>` **method_track_get_key_indices** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const
|
||||
- :ref:`PoolIntArray<class_poolintarray>` **method_track_get_key_indices** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const
|
||||
|
||||
Return all the key indices of a method track, given a position and delta time.
|
||||
|
||||
.. _class_Animation_method_track_get_name:
|
||||
|
||||
- :ref:`String<class_string>` **method_track_get_name** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const
|
||||
- :ref:`String<class_string>` **method_track_get_name** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const
|
||||
|
||||
Return the method name of a method track.
|
||||
|
||||
.. _class_Animation_method_track_get_params:
|
||||
|
||||
- :ref:`Array<class_array>` **method_track_get_params** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const
|
||||
- :ref:`Array<class_array>` **method_track_get_params** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const
|
||||
|
||||
Return the arguments values to be called on a method track for a given key in a given track.
|
||||
|
||||
.. _class_Animation_remove_track:
|
||||
|
||||
- void **remove_track** **(** :ref:`int<class_int>` idx **)**
|
||||
- void **remove_track** **(** :ref:`int<class_int>` idx **)**
|
||||
|
||||
Remove a track by specifying the track index.
|
||||
|
||||
.. _class_Animation_set_length:
|
||||
|
||||
- void **set_length** **(** :ref:`float<class_float>` time_sec **)**
|
||||
- void **set_length** **(** :ref:`float<class_float>` time_sec **)**
|
||||
|
||||
Set the total length of the animation (in seconds). Note that length is not delimited by the last key, as this one may be before or after the end to ensure correct interpolation and looping.
|
||||
|
||||
.. _class_Animation_set_loop:
|
||||
|
||||
- void **set_loop** **(** :ref:`bool<class_bool>` enabled **)**
|
||||
- void **set_loop** **(** :ref:`bool<class_bool>` enabled **)**
|
||||
|
||||
Set a flag indicating that the animation must loop. This is uses for correct interpolation of animation cycles, and for hinting the player that it must restart the animation.
|
||||
|
||||
.. _class_Animation_set_step:
|
||||
|
||||
- void **set_step** **(** :ref:`float<class_float>` size_sec **)**
|
||||
- void **set_step** **(** :ref:`float<class_float>` size_sec **)**
|
||||
|
||||
Set the animation step value.
|
||||
|
||||
.. _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=false **)** const
|
||||
|
||||
Find the key index by time in a given track. Optionally, only find it if the exact time is given.
|
||||
|
||||
.. _class_Animation_track_get_interpolation_loop_wrap:
|
||||
|
||||
- :ref:`bool<class_bool>` **track_get_interpolation_loop_wrap** **(** :ref:`int<class_int>` idx **)** const
|
||||
- :ref:`bool<class_bool>` **track_get_interpolation_loop_wrap** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
.. _class_Animation_track_get_interpolation_type:
|
||||
|
||||
- :ref:`int<class_int>` **track_get_interpolation_type** **(** :ref:`int<class_int>` idx **)** const
|
||||
- :ref:`int<class_int>` **track_get_interpolation_type** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Return the interpolation type of a given track, from the INTERPOLATION\_\* enum.
|
||||
|
||||
.. _class_Animation_track_get_key_count:
|
||||
|
||||
- :ref:`int<class_int>` **track_get_key_count** **(** :ref:`int<class_int>` idx **)** const
|
||||
- :ref:`int<class_int>` **track_get_key_count** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Return the amount of keys in a given track.
|
||||
|
||||
.. _class_Animation_track_get_key_time:
|
||||
|
||||
- :ref:`float<class_float>` **track_get_key_time** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const
|
||||
- :ref:`float<class_float>` **track_get_key_time** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const
|
||||
|
||||
Return the time at which the key is located.
|
||||
|
||||
.. _class_Animation_track_get_key_transition:
|
||||
|
||||
- :ref:`float<class_float>` **track_get_key_transition** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const
|
||||
- :ref:`float<class_float>` **track_get_key_transition** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const
|
||||
|
||||
Return the transition curve (easing) for a specific key (see built-in math function "ease").
|
||||
|
||||
.. _class_Animation_track_get_key_value:
|
||||
|
||||
- :ref:`Variant<class_variant>` **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.
|
||||
|
||||
.. _class_Animation_track_get_path:
|
||||
|
||||
- :ref:`NodePath<class_nodepath>` **track_get_path** **(** :ref:`int<class_int>` idx **)** const
|
||||
- :ref:`NodePath<class_nodepath>` **track_get_path** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Get the path of a track. for more information on the path format, see :ref:`track_set_path<class_Animation_track_set_path>`
|
||||
|
||||
.. _class_Animation_track_get_type:
|
||||
|
||||
- :ref:`int<class_int>` **track_get_type** **(** :ref:`int<class_int>` idx **)** const
|
||||
- :ref:`int<class_int>` **track_get_type** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Get the type of a track.
|
||||
|
||||
.. _class_Animation_track_insert_key:
|
||||
|
||||
- void **track_insert_key** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :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=1 **)**
|
||||
|
||||
Insert a generic key in a given track.
|
||||
|
||||
.. _class_Animation_track_is_imported:
|
||||
|
||||
- :ref:`bool<class_bool>` **track_is_imported** **(** :ref:`int<class_int>` idx **)** const
|
||||
- :ref:`bool<class_bool>` **track_is_imported** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Return true if the given track is imported. Else, return false.
|
||||
|
||||
.. _class_Animation_track_move_down:
|
||||
|
||||
- void **track_move_down** **(** :ref:`int<class_int>` idx **)**
|
||||
- void **track_move_down** **(** :ref:`int<class_int>` idx **)**
|
||||
|
||||
Move a track down.
|
||||
|
||||
.. _class_Animation_track_move_up:
|
||||
|
||||
- void **track_move_up** **(** :ref:`int<class_int>` idx **)**
|
||||
- void **track_move_up** **(** :ref:`int<class_int>` idx **)**
|
||||
|
||||
Move a track up.
|
||||
|
||||
.. _class_Animation_track_remove_key:
|
||||
|
||||
- void **track_remove_key** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)**
|
||||
- void **track_remove_key** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)**
|
||||
|
||||
Remove a key by index in a given track.
|
||||
|
||||
.. _class_Animation_track_remove_key_at_position:
|
||||
|
||||
- void **track_remove_key_at_position** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` position **)**
|
||||
- void **track_remove_key_at_position** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` position **)**
|
||||
|
||||
Remove a key by position (seconds) in a given track.
|
||||
|
||||
.. _class_Animation_track_set_imported:
|
||||
|
||||
- void **track_set_imported** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` imported **)**
|
||||
- void **track_set_imported** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` imported **)**
|
||||
|
||||
Set the given track as imported or not.
|
||||
|
||||
.. _class_Animation_track_set_interpolation_loop_wrap:
|
||||
|
||||
- void **track_set_interpolation_loop_wrap** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` interpolation **)**
|
||||
- void **track_set_interpolation_loop_wrap** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` interpolation **)**
|
||||
|
||||
.. _class_Animation_track_set_interpolation_type:
|
||||
|
||||
- void **track_set_interpolation_type** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` interpolation **)**
|
||||
- void **track_set_interpolation_type** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` interpolation **)**
|
||||
|
||||
Set the interpolation type of a given track, from the INTERPOLATION\_\* enum.
|
||||
|
||||
.. _class_Animation_track_set_key_transition:
|
||||
|
||||
- void **track_set_key_transition** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`float<class_float>` transition **)**
|
||||
- void **track_set_key_transition** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`float<class_float>` transition **)**
|
||||
|
||||
Set the transition curve (easing) for a specific key (see built-in math function "ease").
|
||||
|
||||
.. _class_Animation_track_set_key_value:
|
||||
|
||||
- void **track_set_key_value** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key, :ref:`Variant<class_variant>` value **)**
|
||||
- void **track_set_key_value** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key, :ref:`Variant<class_variant>` value **)**
|
||||
|
||||
Set the value of an existing key.
|
||||
|
||||
.. _class_Animation_track_set_path:
|
||||
|
||||
- void **track_set_path** **(** :ref:`int<class_int>` idx, :ref:`NodePath<class_nodepath>` path **)**
|
||||
- void **track_set_path** **(** :ref:`int<class_int>` idx, :ref:`NodePath<class_nodepath>` path **)**
|
||||
|
||||
Set the path of a track. Paths must be valid scene-tree paths to a node, and must be specified starting from the parent node of the node that will reproduce the animation. Tracks that control properties or bones must append their name after the path, separated by ":". Example: "character/skeleton:ankle" or "character/mesh:transform/local"
|
||||
|
||||
.. _class_Animation_transform_track_insert_key:
|
||||
|
||||
- :ref:`int<class_int>` **transform_track_insert_key** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`Vector3<class_vector3>` location, :ref:`Quat<class_quat>` rotation, :ref:`Vector3<class_vector3>` scale **)**
|
||||
- :ref:`int<class_int>` **transform_track_insert_key** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`Vector3<class_vector3>` location, :ref:`Quat<class_quat>` rotation, :ref:`Vector3<class_vector3>` scale **)**
|
||||
|
||||
Insert a transform key for a transform track.
|
||||
|
||||
.. _class_Animation_transform_track_interpolate:
|
||||
|
||||
- :ref:`Array<class_array>` **transform_track_interpolate** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec **)** const
|
||||
- :ref:`Array<class_array>` **transform_track_interpolate** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec **)** const
|
||||
|
||||
Return the interpolated value of a transform track at a given time (in seconds). An array consisting of 3 elements: position (:ref:`Vector3<class_vector3>`), rotation (:ref:`Quat<class_quat>`) and scale (:ref:`Vector3<class_vector3>`).
|
||||
|
||||
.. _class_Animation_value_track_get_key_indices:
|
||||
|
||||
- :ref:`PoolIntArray<class_poolintarray>` **value_track_get_key_indices** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const
|
||||
- :ref:`PoolIntArray<class_poolintarray>` **value_track_get_key_indices** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const
|
||||
|
||||
Return all the key indices of a value track, given a position and delta time.
|
||||
|
||||
.. _class_Animation_value_track_get_update_mode:
|
||||
|
||||
- :ref:`int<class_int>` **value_track_get_update_mode** **(** :ref:`int<class_int>` idx **)** const
|
||||
- :ref:`int<class_int>` **value_track_get_update_mode** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Return the update mode of a value track.
|
||||
|
||||
.. _class_Animation_value_track_set_update_mode:
|
||||
|
||||
- void **value_track_set_update_mode** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` mode **)**
|
||||
- void **value_track_set_update_mode** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` mode **)**
|
||||
|
||||
Set the update mode (UPDATE\_\*) of a value track.
|
||||
|
||||
|
||||
@@ -19,102 +19,102 @@ Container and player of :ref:`Animation<class_animation>` resources.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`add_animation<class_AnimationPlayer_add_animation>` **(** :ref:`String<class_string>` name, :ref:`Animation<class_animation>` animation **)** |
|
||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`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 |
|
||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`animation_set_next<class_AnimationPlayer_animation_set_next>` **(** :ref:`String<class_string>` anim_from, :ref:`String<class_string>` anim_to **)** |
|
||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_caches<class_AnimationPlayer_clear_caches>` **(** **)** |
|
||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_queue<class_AnimationPlayer_clear_queue>` **(** **)** |
|
||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`find_animation<class_AnimationPlayer_find_animation>` **(** :ref:`Animation<class_animation>` animation **)** const |
|
||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Animation<class_animation>` | :ref:`get_animation<class_AnimationPlayer_get_animation>` **(** :ref:`String<class_string>` name **)** const |
|
||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`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:`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:`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_position<class_AnimationPlayer_get_current_animation_position>` **(** **)** const |
|
||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_default_blend_time<class_AnimationPlayer_get_default_blend_time>` **(** **)** const |
|
||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_position<class_AnimationPlayer_get_position>` **(** **)** 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:`bool<class_bool>` | :ref:`has_animation<class_AnimationPlayer_has_animation>` **(** :ref:`String<class_string>` name **)** const |
|
||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_active<class_AnimationPlayer_is_active>` **(** **)** const |
|
||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AnimationPlayer_is_playing>` **(** **)** const |
|
||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`play<class_AnimationPlayer_play>` **(** :ref:`String<class_string>` name="", :ref:`float<class_float>` custom_blend=-1, :ref:`float<class_float>` custom_speed=1.0, :ref:`bool<class_bool>` from_end=false **)** |
|
||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`play_backwards<class_AnimationPlayer_play_backwards>` **(** :ref:`String<class_string>` name="", :ref:`float<class_float>` custom_blend=-1 **)** |
|
||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`queue<class_AnimationPlayer_queue>` **(** :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:`seek<class_AnimationPlayer_seek>` **(** :ref:`float<class_float>` seconds, :ref:`bool<class_bool>` update=false **)** |
|
||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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_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_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_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:`stop<class_AnimationPlayer_stop>` **(** :ref:`bool<class_bool>` reset=true **)** |
|
||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`stop_all<class_AnimationPlayer_stop_all>` **(** **)** |
|
||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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 **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`clear_caches<class_AnimationPlayer_clear_caches>` **(** **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_queue<class_AnimationPlayer_clear_queue>` **(** **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`find_animation<class_AnimationPlayer_find_animation>` **(** :ref:`Animation<class_animation>` animation **)** const |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Animation<class_animation>` | :ref:`get_animation<class_AnimationPlayer_get_animation>` **(** :ref:`String<class_string>` name **)** const |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`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:`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:`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_position<class_AnimationPlayer_get_current_animation_position>` **(** **)** const |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_default_blend_time<class_AnimationPlayer_get_default_blend_time>` **(** **)** const |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_position<class_AnimationPlayer_get_position>` **(** **)** 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:`bool<class_bool>` | :ref:`has_animation<class_AnimationPlayer_has_animation>` **(** :ref:`String<class_string>` name **)** const |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_active<class_AnimationPlayer_is_active>` **(** **)** const |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AnimationPlayer_is_playing>` **(** **)** const |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`play<class_AnimationPlayer_play>` **(** :ref:`String<class_string>` name="", :ref:`float<class_float>` custom_blend=-1, :ref:`float<class_float>` custom_speed=1.0, :ref:`bool<class_bool>` from_end=false **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`play_backwards<class_AnimationPlayer_play_backwards>` **(** :ref:`String<class_string>` name="", :ref:`float<class_float>` custom_blend=-1 **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`queue<class_AnimationPlayer_queue>` **(** :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:`seek<class_AnimationPlayer_seek>` **(** :ref:`float<class_float>` seconds, :ref:`bool<class_bool>` update=false **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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_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_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_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:`stop<class_AnimationPlayer_stop>` **(** :ref:`bool<class_bool>` reset=true **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`stop_all<class_AnimationPlayer_stop_all>` **(** **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_AnimationPlayer_animation_changed:
|
||||
|
||||
- **animation_changed** **(** :ref:`String<class_string>` old_name, :ref:`String<class_string>` new_name **)**
|
||||
- **animation_changed** **(** :ref:`String<class_string>` old_name, :ref:`String<class_string>` new_name **)**
|
||||
|
||||
If the currently being played animation changes, this signal will notify of such change.
|
||||
|
||||
.. _class_AnimationPlayer_animation_finished:
|
||||
|
||||
- **animation_finished** **(** :ref:`String<class_string>` name **)**
|
||||
- **animation_finished** **(** :ref:`String<class_string>` name **)**
|
||||
|
||||
Notifies when an animation finished playing.
|
||||
|
||||
.. _class_AnimationPlayer_animation_started:
|
||||
|
||||
- **animation_started** **(** :ref:`String<class_string>` name **)**
|
||||
- **animation_started** **(** :ref:`String<class_string>` name **)**
|
||||
|
||||
Notifies when an animation starts playing.
|
||||
|
||||
@@ -151,229 +151,229 @@ Member Function Description
|
||||
|
||||
.. _class_AnimationPlayer_add_animation:
|
||||
|
||||
- :ref:`int<class_int>` **add_animation** **(** :ref:`String<class_string>` name, :ref:`Animation<class_animation>` animation **)**
|
||||
- :ref:`int<class_int>` **add_animation** **(** :ref:`String<class_string>` name, :ref:`Animation<class_animation>` animation **)**
|
||||
|
||||
Add an animation resource to the player, which will be later referenced by the "name" argument.
|
||||
|
||||
.. _class_AnimationPlayer_advance:
|
||||
|
||||
- void **advance** **(** :ref:`float<class_float>` delta **)**
|
||||
- void **advance** **(** :ref:`float<class_float>` delta **)**
|
||||
|
||||
Used to skip ahead or skip back in an animation. Delta is the time in seconds to skip.
|
||||
|
||||
.. _class_AnimationPlayer_animation_get_next:
|
||||
|
||||
- :ref:`String<class_string>` **animation_get_next** **(** :ref:`String<class_string>` anim_from **)** const
|
||||
- :ref:`String<class_string>` **animation_get_next** **(** :ref:`String<class_string>` anim_from **)** const
|
||||
|
||||
Return the name of the next animation in the queue.
|
||||
|
||||
.. _class_AnimationPlayer_animation_set_next:
|
||||
|
||||
- void **animation_set_next** **(** :ref:`String<class_string>` anim_from, :ref:`String<class_string>` anim_to **)**
|
||||
- void **animation_set_next** **(** :ref:`String<class_string>` anim_from, :ref:`String<class_string>` anim_to **)**
|
||||
|
||||
Set the name of an animation that will be played after.
|
||||
|
||||
.. _class_AnimationPlayer_clear_caches:
|
||||
|
||||
- void **clear_caches** **(** **)**
|
||||
- void **clear_caches** **(** **)**
|
||||
|
||||
The animation player creates caches for faster access to the nodes it will animate. However, if a specific node is removed, it may not notice it, so clear_caches will force the player to search for the nodes again.
|
||||
|
||||
.. _class_AnimationPlayer_clear_queue:
|
||||
|
||||
- void **clear_queue** **(** **)**
|
||||
- void **clear_queue** **(** **)**
|
||||
|
||||
If animations are queued to play, clear them.
|
||||
|
||||
.. _class_AnimationPlayer_find_animation:
|
||||
|
||||
- :ref:`String<class_string>` **find_animation** **(** :ref:`Animation<class_animation>` animation **)** const
|
||||
- :ref:`String<class_string>` **find_animation** **(** :ref:`Animation<class_animation>` animation **)** const
|
||||
|
||||
Find an animation name by resource.
|
||||
|
||||
.. _class_AnimationPlayer_get_animation:
|
||||
|
||||
- :ref:`Animation<class_animation>` **get_animation** **(** :ref:`String<class_string>` name **)** const
|
||||
- :ref:`Animation<class_animation>` **get_animation** **(** :ref:`String<class_string>` name **)** const
|
||||
|
||||
Get an :ref:`Animation<class_animation>` resource by requesting a name.
|
||||
|
||||
.. _class_AnimationPlayer_get_animation_list:
|
||||
|
||||
- :ref:`PoolStringArray<class_poolstringarray>` **get_animation_list** **(** **)** const
|
||||
- :ref:`PoolStringArray<class_poolstringarray>` **get_animation_list** **(** **)** const
|
||||
|
||||
Get the list of names of the animations stored in the player.
|
||||
|
||||
.. _class_AnimationPlayer_get_animation_process_mode:
|
||||
|
||||
- :ref:`int<class_int>` **get_animation_process_mode** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_animation_process_mode** **(** **)** const
|
||||
|
||||
Return the mode in which the animation player processes. See :ref:`set_animation_process_mode<class_AnimationPlayer_set_animation_process_mode>`.
|
||||
|
||||
.. _class_AnimationPlayer_get_autoplay:
|
||||
|
||||
- :ref:`String<class_string>` **get_autoplay** **(** **)** const
|
||||
- :ref:`String<class_string>` **get_autoplay** **(** **)** const
|
||||
|
||||
Return the name of the animation that will be automatically played when the scene is loaded.
|
||||
|
||||
.. _class_AnimationPlayer_get_blend_time:
|
||||
|
||||
- :ref:`float<class_float>` **get_blend_time** **(** :ref:`String<class_string>` anim_from, :ref:`String<class_string>` anim_to **)** const
|
||||
- :ref:`float<class_float>` **get_blend_time** **(** :ref:`String<class_string>` anim_from, :ref:`String<class_string>` anim_to **)** const
|
||||
|
||||
Get the blend time between two animations, referenced by their names.
|
||||
|
||||
.. _class_AnimationPlayer_get_current_animation:
|
||||
|
||||
- :ref:`String<class_string>` **get_current_animation** **(** **)** const
|
||||
- :ref:`String<class_string>` **get_current_animation** **(** **)** const
|
||||
|
||||
Return the name of the animation being played.
|
||||
|
||||
.. _class_AnimationPlayer_get_current_animation_length:
|
||||
|
||||
- :ref:`float<class_float>` **get_current_animation_length** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_current_animation_length** **(** **)** const
|
||||
|
||||
Get the length (in seconds) of the currently being played animation.
|
||||
|
||||
.. _class_AnimationPlayer_get_current_animation_position:
|
||||
|
||||
- :ref:`float<class_float>` **get_current_animation_position** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_current_animation_position** **(** **)** const
|
||||
|
||||
Get the position (in seconds) of the currently being played animation.
|
||||
|
||||
.. _class_AnimationPlayer_get_default_blend_time:
|
||||
|
||||
- :ref:`float<class_float>` **get_default_blend_time** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_default_blend_time** **(** **)** const
|
||||
|
||||
Return the default blend time between animations.
|
||||
|
||||
.. _class_AnimationPlayer_get_position:
|
||||
|
||||
- :ref:`float<class_float>` **get_position** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_position** **(** **)** const
|
||||
|
||||
Return the playback position (in seconds) in an animation channel (or channel 0 if none is provided).
|
||||
|
||||
.. _class_AnimationPlayer_get_root:
|
||||
|
||||
- :ref:`NodePath<class_nodepath>` **get_root** **(** **)** const
|
||||
- :ref:`NodePath<class_nodepath>` **get_root** **(** **)** const
|
||||
|
||||
Return path to root node (see :ref:`set_root<class_AnimationPlayer_set_root>`).
|
||||
|
||||
.. _class_AnimationPlayer_get_speed_scale:
|
||||
|
||||
- :ref:`float<class_float>` **get_speed_scale** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_speed_scale** **(** **)** const
|
||||
|
||||
Get the speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default ratio is *1* (no scaling).
|
||||
|
||||
.. _class_AnimationPlayer_has_animation:
|
||||
|
||||
- :ref:`bool<class_bool>` **has_animation** **(** :ref:`String<class_string>` name **)** const
|
||||
- :ref:`bool<class_bool>` **has_animation** **(** :ref:`String<class_string>` name **)** const
|
||||
|
||||
Request whether an :ref:`Animation<class_animation>` name exist within the player.
|
||||
|
||||
.. _class_AnimationPlayer_is_active:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_active** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_active** **(** **)** const
|
||||
|
||||
Return true if the player is active.
|
||||
|
||||
.. _class_AnimationPlayer_is_playing:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_playing** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_playing** **(** **)** const
|
||||
|
||||
Return whether an animation is playing.
|
||||
|
||||
.. _class_AnimationPlayer_play:
|
||||
|
||||
- void **play** **(** :ref:`String<class_string>` name="", :ref:`float<class_float>` custom_blend=-1, :ref:`float<class_float>` custom_speed=1.0, :ref:`bool<class_bool>` from_end=false **)**
|
||||
- void **play** **(** :ref:`String<class_string>` name="", :ref:`float<class_float>` custom_blend=-1, :ref:`float<class_float>` custom_speed=1.0, :ref:`bool<class_bool>` from_end=false **)**
|
||||
|
||||
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:
|
||||
|
||||
- void **play_backwards** **(** :ref:`String<class_string>` name="", :ref:`float<class_float>` custom_blend=-1 **)**
|
||||
- void **play_backwards** **(** :ref:`String<class_string>` name="", :ref:`float<class_float>` custom_blend=-1 **)**
|
||||
|
||||
Play a given animation by the animation name in reverse.
|
||||
|
||||
.. _class_AnimationPlayer_queue:
|
||||
|
||||
- void **queue** **(** :ref:`String<class_string>` name **)**
|
||||
- void **queue** **(** :ref:`String<class_string>` name **)**
|
||||
|
||||
Queue an animation for playback once the current one is done.
|
||||
|
||||
.. _class_AnimationPlayer_remove_animation:
|
||||
|
||||
- void **remove_animation** **(** :ref:`String<class_string>` name **)**
|
||||
- void **remove_animation** **(** :ref:`String<class_string>` name **)**
|
||||
|
||||
Remove an animation from the player (by supplying the same name used to add it).
|
||||
|
||||
.. _class_AnimationPlayer_rename_animation:
|
||||
|
||||
- void **rename_animation** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` newname **)**
|
||||
- void **rename_animation** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` newname **)**
|
||||
|
||||
Rename an existing animation.
|
||||
|
||||
.. _class_AnimationPlayer_seek:
|
||||
|
||||
- void **seek** **(** :ref:`float<class_float>` seconds, :ref:`bool<class_bool>` update=false **)**
|
||||
- void **seek** **(** :ref:`float<class_float>` seconds, :ref:`bool<class_bool>` update=false **)**
|
||||
|
||||
Seek the animation to a given position in time (in seconds). If 'update' is true, the animation will be updated too, otherwise it will be updated at process time.
|
||||
|
||||
.. _class_AnimationPlayer_set_active:
|
||||
|
||||
- void **set_active** **(** :ref:`bool<class_bool>` active **)**
|
||||
- void **set_active** **(** :ref:`bool<class_bool>` active **)**
|
||||
|
||||
Set the player as active (playing). If false, it will do nothing.
|
||||
|
||||
.. _class_AnimationPlayer_set_animation_process_mode:
|
||||
|
||||
- void **set_animation_process_mode** **(** :ref:`int<class_int>` mode **)**
|
||||
- void **set_animation_process_mode** **(** :ref:`int<class_int>` mode **)**
|
||||
|
||||
Set the mode in which the animation player processes. By default, it processes on idle time (framerate dependent), but using fixed time works well for animating static collision bodies in 2D and 3D. See enum ANIMATION_PROCESS\_\*.
|
||||
|
||||
.. _class_AnimationPlayer_set_autoplay:
|
||||
|
||||
- void **set_autoplay** **(** :ref:`String<class_string>` name **)**
|
||||
- void **set_autoplay** **(** :ref:`String<class_string>` name **)**
|
||||
|
||||
Set the name of the animation that will be automatically played when the scene is loaded.
|
||||
|
||||
.. _class_AnimationPlayer_set_blend_time:
|
||||
|
||||
- void **set_blend_time** **(** :ref:`String<class_string>` anim_from, :ref:`String<class_string>` anim_to, :ref:`float<class_float>` sec **)**
|
||||
- void **set_blend_time** **(** :ref:`String<class_string>` anim_from, :ref:`String<class_string>` anim_to, :ref:`float<class_float>` sec **)**
|
||||
|
||||
Specify a blend time (in seconds) between two animations, referenced by their names.
|
||||
|
||||
.. _class_AnimationPlayer_set_current_animation:
|
||||
|
||||
- void **set_current_animation** **(** :ref:`String<class_string>` anim **)**
|
||||
- void **set_current_animation** **(** :ref:`String<class_string>` anim **)**
|
||||
|
||||
Set the current animation (even if no playback occurs). Using set_current_animation() and set_active() are similar to calling play().
|
||||
|
||||
.. _class_AnimationPlayer_set_default_blend_time:
|
||||
|
||||
- void **set_default_blend_time** **(** :ref:`float<class_float>` sec **)**
|
||||
- void **set_default_blend_time** **(** :ref:`float<class_float>` sec **)**
|
||||
|
||||
Set the default blend time between animations.
|
||||
|
||||
.. _class_AnimationPlayer_set_root:
|
||||
|
||||
- void **set_root** **(** :ref:`NodePath<class_nodepath>` path **)**
|
||||
- void **set_root** **(** :ref:`NodePath<class_nodepath>` path **)**
|
||||
|
||||
AnimationPlayer resolves animation track paths from this node (which is relative to itself), by default root is "..", but it can be changed.
|
||||
|
||||
.. _class_AnimationPlayer_set_speed_scale:
|
||||
|
||||
- void **set_speed_scale** **(** :ref:`float<class_float>` speed **)**
|
||||
- void **set_speed_scale** **(** :ref:`float<class_float>` speed **)**
|
||||
|
||||
Set a speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default ratio is *1* (no scaling).
|
||||
|
||||
.. _class_AnimationPlayer_stop:
|
||||
|
||||
- void **stop** **(** :ref:`bool<class_bool>` reset=true **)**
|
||||
- void **stop** **(** :ref:`bool<class_bool>` reset=true **)**
|
||||
|
||||
Stop the currently playing animation.
|
||||
|
||||
.. _class_AnimationPlayer_stop_all:
|
||||
|
||||
- void **stop_all** **(** **)**
|
||||
- void **stop_all** **(** **)**
|
||||
|
||||
Stop playback of animations (deprecated).
|
||||
|
||||
|
||||
@@ -19,135 +19,135 @@ Animation Player that uses a node graph for the blending.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_node<class_AnimationTreePlayer_add_node>` **(** :ref:`int<class_int>` type, :ref:`String<class_string>` id **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`advance<class_AnimationTreePlayer_advance>` **(** :ref:`float<class_float>` delta **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Animation<class_animation>` | :ref:`animation_node_get_animation<class_AnimationTreePlayer_animation_node_get_animation>` **(** :ref:`String<class_string>` id **)** const |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`animation_node_get_master_animation<class_AnimationTreePlayer_animation_node_get_master_animation>` **(** :ref:`String<class_string>` id **)** const |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`animation_node_set_animation<class_AnimationTreePlayer_animation_node_set_animation>` **(** :ref:`String<class_string>` id, :ref:`Animation<class_animation>` animation **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`animation_node_set_filter_path<class_AnimationTreePlayer_animation_node_set_filter_path>` **(** :ref:`String<class_string>` id, :ref:`NodePath<class_nodepath>` path, :ref:`bool<class_bool>` enable **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`animation_node_set_master_animation<class_AnimationTreePlayer_animation_node_set_master_animation>` **(** :ref:`String<class_string>` id, :ref:`String<class_string>` source **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`are_nodes_connected<class_AnimationTreePlayer_are_nodes_connected>` **(** :ref:`String<class_string>` id, :ref:`String<class_string>` dst_id, :ref:`int<class_int>` dst_input_idx **)** const |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`blend2_node_get_amount<class_AnimationTreePlayer_blend2_node_get_amount>` **(** :ref:`String<class_string>` id **)** const |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`blend2_node_set_amount<class_AnimationTreePlayer_blend2_node_set_amount>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` blend **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`blend2_node_set_filter_path<class_AnimationTreePlayer_blend2_node_set_filter_path>` **(** :ref:`String<class_string>` id, :ref:`NodePath<class_nodepath>` path, :ref:`bool<class_bool>` enable **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`blend3_node_get_amount<class_AnimationTreePlayer_blend3_node_get_amount>` **(** :ref:`String<class_string>` id **)** const |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`blend3_node_set_amount<class_AnimationTreePlayer_blend3_node_set_amount>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` blend **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`blend4_node_get_amount<class_AnimationTreePlayer_blend4_node_get_amount>` **(** :ref:`String<class_string>` id **)** const |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`blend4_node_set_amount<class_AnimationTreePlayer_blend4_node_set_amount>` **(** :ref:`String<class_string>` id, :ref:`Vector2<class_vector2>` blend **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`connect_nodes<class_AnimationTreePlayer_connect_nodes>` **(** :ref:`String<class_string>` id, :ref:`String<class_string>` dst_id, :ref:`int<class_int>` dst_input_idx **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`disconnect_nodes<class_AnimationTreePlayer_disconnect_nodes>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` dst_input_idx **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_animation_process_mode<class_AnimationTreePlayer_get_animation_process_mode>` **(** **)** const |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`NodePath<class_nodepath>` | :ref:`get_base_path<class_AnimationTreePlayer_get_base_path>` **(** **)** const |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`NodePath<class_nodepath>` | :ref:`get_master_player<class_AnimationTreePlayer_get_master_player>` **(** **)** const |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_node_list<class_AnimationTreePlayer_get_node_list>` **(** **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_active<class_AnimationTreePlayer_is_active>` **(** **)** const |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`mix_node_get_amount<class_AnimationTreePlayer_mix_node_get_amount>` **(** :ref:`String<class_string>` id **)** const |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`mix_node_set_amount<class_AnimationTreePlayer_mix_node_set_amount>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` ratio **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`node_exists<class_AnimationTreePlayer_node_exists>` **(** :ref:`String<class_string>` node **)** const |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`node_get_input_count<class_AnimationTreePlayer_node_get_input_count>` **(** :ref:`String<class_string>` id **)** const |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`node_get_input_source<class_AnimationTreePlayer_node_get_input_source>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` idx **)** const |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`node_get_position<class_AnimationTreePlayer_node_get_position>` **(** :ref:`String<class_string>` id **)** const |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`node_get_type<class_AnimationTreePlayer_node_get_type>` **(** :ref:`String<class_string>` id **)** const |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`node_rename<class_AnimationTreePlayer_node_rename>` **(** :ref:`String<class_string>` node, :ref:`String<class_string>` new_name **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`node_set_position<class_AnimationTreePlayer_node_set_position>` **(** :ref:`String<class_string>` id, :ref:`Vector2<class_vector2>` screen_position **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`oneshot_node_get_autorestart_delay<class_AnimationTreePlayer_oneshot_node_get_autorestart_delay>` **(** :ref:`String<class_string>` id **)** const |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`oneshot_node_get_autorestart_random_delay<class_AnimationTreePlayer_oneshot_node_get_autorestart_random_delay>` **(** :ref:`String<class_string>` id **)** const |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`oneshot_node_get_fadein_time<class_AnimationTreePlayer_oneshot_node_get_fadein_time>` **(** :ref:`String<class_string>` id **)** const |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`oneshot_node_get_fadeout_time<class_AnimationTreePlayer_oneshot_node_get_fadeout_time>` **(** :ref:`String<class_string>` id **)** const |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`oneshot_node_has_autorestart<class_AnimationTreePlayer_oneshot_node_has_autorestart>` **(** :ref:`String<class_string>` id **)** const |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`oneshot_node_is_active<class_AnimationTreePlayer_oneshot_node_is_active>` **(** :ref:`String<class_string>` id **)** const |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`oneshot_node_set_autorestart<class_AnimationTreePlayer_oneshot_node_set_autorestart>` **(** :ref:`String<class_string>` id, :ref:`bool<class_bool>` enable **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`oneshot_node_set_autorestart_delay<class_AnimationTreePlayer_oneshot_node_set_autorestart_delay>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` delay_sec **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`oneshot_node_set_autorestart_random_delay<class_AnimationTreePlayer_oneshot_node_set_autorestart_random_delay>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` rand_sec **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`oneshot_node_set_fadein_time<class_AnimationTreePlayer_oneshot_node_set_fadein_time>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`oneshot_node_set_fadeout_time<class_AnimationTreePlayer_oneshot_node_set_fadeout_time>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`oneshot_node_set_filter_path<class_AnimationTreePlayer_oneshot_node_set_filter_path>` **(** :ref:`String<class_string>` id, :ref:`NodePath<class_nodepath>` path, :ref:`bool<class_bool>` enable **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`oneshot_node_start<class_AnimationTreePlayer_oneshot_node_start>` **(** :ref:`String<class_string>` id **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`oneshot_node_stop<class_AnimationTreePlayer_oneshot_node_stop>` **(** :ref:`String<class_string>` id **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`recompute_caches<class_AnimationTreePlayer_recompute_caches>` **(** **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_node<class_AnimationTreePlayer_remove_node>` **(** :ref:`String<class_string>` id **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`reset<class_AnimationTreePlayer_reset>` **(** **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_active<class_AnimationTreePlayer_set_active>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_animation_process_mode<class_AnimationTreePlayer_set_animation_process_mode>` **(** :ref:`int<class_int>` mode **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_base_path<class_AnimationTreePlayer_set_base_path>` **(** :ref:`NodePath<class_nodepath>` path **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_master_player<class_AnimationTreePlayer_set_master_player>` **(** :ref:`NodePath<class_nodepath>` nodepath **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`timescale_node_get_scale<class_AnimationTreePlayer_timescale_node_get_scale>` **(** :ref:`String<class_string>` id **)** const |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`timescale_node_set_scale<class_AnimationTreePlayer_timescale_node_set_scale>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` scale **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`timeseek_node_seek<class_AnimationTreePlayer_timeseek_node_seek>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` seconds **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`transition_node_delete_input<class_AnimationTreePlayer_transition_node_delete_input>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`transition_node_get_current<class_AnimationTreePlayer_transition_node_get_current>` **(** :ref:`String<class_string>` id **)** const |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`transition_node_get_input_count<class_AnimationTreePlayer_transition_node_get_input_count>` **(** :ref:`String<class_string>` id **)** const |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`transition_node_get_xfade_time<class_AnimationTreePlayer_transition_node_get_xfade_time>` **(** :ref:`String<class_string>` id **)** const |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`transition_node_has_input_auto_advance<class_AnimationTreePlayer_transition_node_has_input_auto_advance>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)** const |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`transition_node_set_current<class_AnimationTreePlayer_transition_node_set_current>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`transition_node_set_input_auto_advance<class_AnimationTreePlayer_transition_node_set_input_auto_advance>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx, :ref:`bool<class_bool>` enable **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`transition_node_set_input_count<class_AnimationTreePlayer_transition_node_set_input_count>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` count **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`transition_node_set_xfade_time<class_AnimationTreePlayer_transition_node_set_xfade_time>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_node<class_AnimationTreePlayer_add_node>` **(** :ref:`int<class_int>` type, :ref:`String<class_string>` id **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`advance<class_AnimationTreePlayer_advance>` **(** :ref:`float<class_float>` delta **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Animation<class_animation>` | :ref:`animation_node_get_animation<class_AnimationTreePlayer_animation_node_get_animation>` **(** :ref:`String<class_string>` id **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`animation_node_get_master_animation<class_AnimationTreePlayer_animation_node_get_master_animation>` **(** :ref:`String<class_string>` id **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`animation_node_set_animation<class_AnimationTreePlayer_animation_node_set_animation>` **(** :ref:`String<class_string>` id, :ref:`Animation<class_animation>` animation **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`animation_node_set_filter_path<class_AnimationTreePlayer_animation_node_set_filter_path>` **(** :ref:`String<class_string>` id, :ref:`NodePath<class_nodepath>` path, :ref:`bool<class_bool>` enable **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`animation_node_set_master_animation<class_AnimationTreePlayer_animation_node_set_master_animation>` **(** :ref:`String<class_string>` id, :ref:`String<class_string>` source **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`are_nodes_connected<class_AnimationTreePlayer_are_nodes_connected>` **(** :ref:`String<class_string>` id, :ref:`String<class_string>` dst_id, :ref:`int<class_int>` dst_input_idx **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`blend2_node_get_amount<class_AnimationTreePlayer_blend2_node_get_amount>` **(** :ref:`String<class_string>` id **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`blend2_node_set_amount<class_AnimationTreePlayer_blend2_node_set_amount>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` blend **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`blend2_node_set_filter_path<class_AnimationTreePlayer_blend2_node_set_filter_path>` **(** :ref:`String<class_string>` id, :ref:`NodePath<class_nodepath>` path, :ref:`bool<class_bool>` enable **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`blend3_node_get_amount<class_AnimationTreePlayer_blend3_node_get_amount>` **(** :ref:`String<class_string>` id **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`blend3_node_set_amount<class_AnimationTreePlayer_blend3_node_set_amount>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` blend **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`blend4_node_get_amount<class_AnimationTreePlayer_blend4_node_get_amount>` **(** :ref:`String<class_string>` id **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`blend4_node_set_amount<class_AnimationTreePlayer_blend4_node_set_amount>` **(** :ref:`String<class_string>` id, :ref:`Vector2<class_vector2>` blend **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`connect_nodes<class_AnimationTreePlayer_connect_nodes>` **(** :ref:`String<class_string>` id, :ref:`String<class_string>` dst_id, :ref:`int<class_int>` dst_input_idx **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`disconnect_nodes<class_AnimationTreePlayer_disconnect_nodes>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` dst_input_idx **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_animation_process_mode<class_AnimationTreePlayer_get_animation_process_mode>` **(** **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`NodePath<class_nodepath>` | :ref:`get_base_path<class_AnimationTreePlayer_get_base_path>` **(** **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`NodePath<class_nodepath>` | :ref:`get_master_player<class_AnimationTreePlayer_get_master_player>` **(** **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_node_list<class_AnimationTreePlayer_get_node_list>` **(** **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_active<class_AnimationTreePlayer_is_active>` **(** **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`mix_node_get_amount<class_AnimationTreePlayer_mix_node_get_amount>` **(** :ref:`String<class_string>` id **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`mix_node_set_amount<class_AnimationTreePlayer_mix_node_set_amount>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` ratio **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`node_exists<class_AnimationTreePlayer_node_exists>` **(** :ref:`String<class_string>` node **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`node_get_input_count<class_AnimationTreePlayer_node_get_input_count>` **(** :ref:`String<class_string>` id **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`node_get_input_source<class_AnimationTreePlayer_node_get_input_source>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` idx **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`node_get_position<class_AnimationTreePlayer_node_get_position>` **(** :ref:`String<class_string>` id **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`node_get_type<class_AnimationTreePlayer_node_get_type>` **(** :ref:`String<class_string>` id **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`node_rename<class_AnimationTreePlayer_node_rename>` **(** :ref:`String<class_string>` node, :ref:`String<class_string>` new_name **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`node_set_position<class_AnimationTreePlayer_node_set_position>` **(** :ref:`String<class_string>` id, :ref:`Vector2<class_vector2>` screen_position **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`oneshot_node_get_autorestart_delay<class_AnimationTreePlayer_oneshot_node_get_autorestart_delay>` **(** :ref:`String<class_string>` id **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`oneshot_node_get_autorestart_random_delay<class_AnimationTreePlayer_oneshot_node_get_autorestart_random_delay>` **(** :ref:`String<class_string>` id **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`oneshot_node_get_fadein_time<class_AnimationTreePlayer_oneshot_node_get_fadein_time>` **(** :ref:`String<class_string>` id **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`oneshot_node_get_fadeout_time<class_AnimationTreePlayer_oneshot_node_get_fadeout_time>` **(** :ref:`String<class_string>` id **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`oneshot_node_has_autorestart<class_AnimationTreePlayer_oneshot_node_has_autorestart>` **(** :ref:`String<class_string>` id **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`oneshot_node_is_active<class_AnimationTreePlayer_oneshot_node_is_active>` **(** :ref:`String<class_string>` id **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`oneshot_node_set_autorestart<class_AnimationTreePlayer_oneshot_node_set_autorestart>` **(** :ref:`String<class_string>` id, :ref:`bool<class_bool>` enable **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`oneshot_node_set_autorestart_delay<class_AnimationTreePlayer_oneshot_node_set_autorestart_delay>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` delay_sec **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`oneshot_node_set_autorestart_random_delay<class_AnimationTreePlayer_oneshot_node_set_autorestart_random_delay>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` rand_sec **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`oneshot_node_set_fadein_time<class_AnimationTreePlayer_oneshot_node_set_fadein_time>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`oneshot_node_set_fadeout_time<class_AnimationTreePlayer_oneshot_node_set_fadeout_time>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`oneshot_node_set_filter_path<class_AnimationTreePlayer_oneshot_node_set_filter_path>` **(** :ref:`String<class_string>` id, :ref:`NodePath<class_nodepath>` path, :ref:`bool<class_bool>` enable **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`oneshot_node_start<class_AnimationTreePlayer_oneshot_node_start>` **(** :ref:`String<class_string>` id **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`oneshot_node_stop<class_AnimationTreePlayer_oneshot_node_stop>` **(** :ref:`String<class_string>` id **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`recompute_caches<class_AnimationTreePlayer_recompute_caches>` **(** **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_node<class_AnimationTreePlayer_remove_node>` **(** :ref:`String<class_string>` id **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`reset<class_AnimationTreePlayer_reset>` **(** **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_active<class_AnimationTreePlayer_set_active>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_animation_process_mode<class_AnimationTreePlayer_set_animation_process_mode>` **(** :ref:`int<class_int>` mode **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_base_path<class_AnimationTreePlayer_set_base_path>` **(** :ref:`NodePath<class_nodepath>` path **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_master_player<class_AnimationTreePlayer_set_master_player>` **(** :ref:`NodePath<class_nodepath>` nodepath **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`timescale_node_get_scale<class_AnimationTreePlayer_timescale_node_get_scale>` **(** :ref:`String<class_string>` id **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`timescale_node_set_scale<class_AnimationTreePlayer_timescale_node_set_scale>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` scale **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`timeseek_node_seek<class_AnimationTreePlayer_timeseek_node_seek>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` seconds **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`transition_node_delete_input<class_AnimationTreePlayer_transition_node_delete_input>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`transition_node_get_current<class_AnimationTreePlayer_transition_node_get_current>` **(** :ref:`String<class_string>` id **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`transition_node_get_input_count<class_AnimationTreePlayer_transition_node_get_input_count>` **(** :ref:`String<class_string>` id **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`transition_node_get_xfade_time<class_AnimationTreePlayer_transition_node_get_xfade_time>` **(** :ref:`String<class_string>` id **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`transition_node_has_input_auto_advance<class_AnimationTreePlayer_transition_node_has_input_auto_advance>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`transition_node_set_current<class_AnimationTreePlayer_transition_node_set_current>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`transition_node_set_input_auto_advance<class_AnimationTreePlayer_transition_node_set_input_auto_advance>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx, :ref:`bool<class_bool>` enable **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`transition_node_set_input_count<class_AnimationTreePlayer_transition_node_set_input_count>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` count **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`transition_node_set_xfade_time<class_AnimationTreePlayer_transition_node_set_xfade_time>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -183,346 +183,346 @@ Member Function Description
|
||||
|
||||
.. _class_AnimationTreePlayer_add_node:
|
||||
|
||||
- void **add_node** **(** :ref:`int<class_int>` type, :ref:`String<class_string>` id **)**
|
||||
- void **add_node** **(** :ref:`int<class_int>` type, :ref:`String<class_string>` id **)**
|
||||
|
||||
Add a node of a given type in the graph with given id.
|
||||
|
||||
.. _class_AnimationTreePlayer_advance:
|
||||
|
||||
- void **advance** **(** :ref:`float<class_float>` delta **)**
|
||||
- void **advance** **(** :ref:`float<class_float>` delta **)**
|
||||
|
||||
.. _class_AnimationTreePlayer_animation_node_get_animation:
|
||||
|
||||
- :ref:`Animation<class_animation>` **animation_node_get_animation** **(** :ref:`String<class_string>` id **)** const
|
||||
- :ref:`Animation<class_animation>` **animation_node_get_animation** **(** :ref:`String<class_string>` id **)** const
|
||||
|
||||
Returns an animation given its name.
|
||||
|
||||
.. _class_AnimationTreePlayer_animation_node_get_master_animation:
|
||||
|
||||
- :ref:`String<class_string>` **animation_node_get_master_animation** **(** :ref:`String<class_string>` id **)** const
|
||||
- :ref:`String<class_string>` **animation_node_get_master_animation** **(** :ref:`String<class_string>` id **)** const
|
||||
|
||||
.. _class_AnimationTreePlayer_animation_node_set_animation:
|
||||
|
||||
- void **animation_node_set_animation** **(** :ref:`String<class_string>` id, :ref:`Animation<class_animation>` animation **)**
|
||||
- void **animation_node_set_animation** **(** :ref:`String<class_string>` id, :ref:`Animation<class_animation>` animation **)**
|
||||
|
||||
Set the animation for an animation node.
|
||||
|
||||
.. _class_AnimationTreePlayer_animation_node_set_filter_path:
|
||||
|
||||
- void **animation_node_set_filter_path** **(** :ref:`String<class_string>` id, :ref:`NodePath<class_nodepath>` path, :ref:`bool<class_bool>` enable **)**
|
||||
- void **animation_node_set_filter_path** **(** :ref:`String<class_string>` id, :ref:`NodePath<class_nodepath>` path, :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
.. _class_AnimationTreePlayer_animation_node_set_master_animation:
|
||||
|
||||
- void **animation_node_set_master_animation** **(** :ref:`String<class_string>` id, :ref:`String<class_string>` source **)**
|
||||
- void **animation_node_set_master_animation** **(** :ref:`String<class_string>` id, :ref:`String<class_string>` source **)**
|
||||
|
||||
.. _class_AnimationTreePlayer_are_nodes_connected:
|
||||
|
||||
- :ref:`bool<class_bool>` **are_nodes_connected** **(** :ref:`String<class_string>` id, :ref:`String<class_string>` dst_id, :ref:`int<class_int>` dst_input_idx **)** const
|
||||
- :ref:`bool<class_bool>` **are_nodes_connected** **(** :ref:`String<class_string>` id, :ref:`String<class_string>` dst_id, :ref:`int<class_int>` dst_input_idx **)** const
|
||||
|
||||
Returns whether node ``id`` and ``dst_id`` are connected at the specified slot.
|
||||
|
||||
.. _class_AnimationTreePlayer_blend2_node_get_amount:
|
||||
|
||||
- :ref:`float<class_float>` **blend2_node_get_amount** **(** :ref:`String<class_string>` id **)** const
|
||||
- :ref:`float<class_float>` **blend2_node_get_amount** **(** :ref:`String<class_string>` id **)** const
|
||||
|
||||
Returns the blend amount of a Blend2 node given its name.
|
||||
|
||||
.. _class_AnimationTreePlayer_blend2_node_set_amount:
|
||||
|
||||
- void **blend2_node_set_amount** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` blend **)**
|
||||
- void **blend2_node_set_amount** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` blend **)**
|
||||
|
||||
Sets the blend amount of a Blend2 node given its name and value.
|
||||
|
||||
.. _class_AnimationTreePlayer_blend2_node_set_filter_path:
|
||||
|
||||
- void **blend2_node_set_filter_path** **(** :ref:`String<class_string>` id, :ref:`NodePath<class_nodepath>` path, :ref:`bool<class_bool>` enable **)**
|
||||
- void **blend2_node_set_filter_path** **(** :ref:`String<class_string>` id, :ref:`NodePath<class_nodepath>` path, :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
.. _class_AnimationTreePlayer_blend3_node_get_amount:
|
||||
|
||||
- :ref:`float<class_float>` **blend3_node_get_amount** **(** :ref:`String<class_string>` id **)** const
|
||||
- :ref:`float<class_float>` **blend3_node_get_amount** **(** :ref:`String<class_string>` id **)** const
|
||||
|
||||
Returns the blend amount of a Blend3 node given its name.
|
||||
|
||||
.. _class_AnimationTreePlayer_blend3_node_set_amount:
|
||||
|
||||
- void **blend3_node_set_amount** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` blend **)**
|
||||
- void **blend3_node_set_amount** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` blend **)**
|
||||
|
||||
Sets the blend amount of a Blend3 node given its name and value.
|
||||
|
||||
.. _class_AnimationTreePlayer_blend4_node_get_amount:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **blend4_node_get_amount** **(** :ref:`String<class_string>` id **)** const
|
||||
- :ref:`Vector2<class_vector2>` **blend4_node_get_amount** **(** :ref:`String<class_string>` id **)** const
|
||||
|
||||
Returns the blend amount of a Blend4 node given its name.
|
||||
|
||||
.. _class_AnimationTreePlayer_blend4_node_set_amount:
|
||||
|
||||
- void **blend4_node_set_amount** **(** :ref:`String<class_string>` id, :ref:`Vector2<class_vector2>` blend **)**
|
||||
- void **blend4_node_set_amount** **(** :ref:`String<class_string>` id, :ref:`Vector2<class_vector2>` blend **)**
|
||||
|
||||
Sets the blend amount of a Blend4 node given its name and value.
|
||||
|
||||
.. _class_AnimationTreePlayer_connect_nodes:
|
||||
|
||||
- :ref:`int<class_int>` **connect_nodes** **(** :ref:`String<class_string>` id, :ref:`String<class_string>` dst_id, :ref:`int<class_int>` dst_input_idx **)**
|
||||
- :ref:`int<class_int>` **connect_nodes** **(** :ref:`String<class_string>` id, :ref:`String<class_string>` dst_id, :ref:`int<class_int>` dst_input_idx **)**
|
||||
|
||||
Connects node ``id`` to ``dst_id`` at the specified input slot.
|
||||
|
||||
.. _class_AnimationTreePlayer_disconnect_nodes:
|
||||
|
||||
- void **disconnect_nodes** **(** :ref:`String<class_string>` id, :ref:`int<class_int>` dst_input_idx **)**
|
||||
- void **disconnect_nodes** **(** :ref:`String<class_string>` id, :ref:`int<class_int>` dst_input_idx **)**
|
||||
|
||||
Disconnects nodes connected to ``id`` at the specified input slot.
|
||||
|
||||
.. _class_AnimationTreePlayer_get_animation_process_mode:
|
||||
|
||||
- :ref:`int<class_int>` **get_animation_process_mode** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_animation_process_mode** **(** **)** const
|
||||
|
||||
Returns playback process mode of this AnimationTreePlayer.
|
||||
|
||||
.. _class_AnimationTreePlayer_get_base_path:
|
||||
|
||||
- :ref:`NodePath<class_nodepath>` **get_base_path** **(** **)** const
|
||||
- :ref:`NodePath<class_nodepath>` **get_base_path** **(** **)** const
|
||||
|
||||
.. _class_AnimationTreePlayer_get_master_player:
|
||||
|
||||
- :ref:`NodePath<class_nodepath>` **get_master_player** **(** **)** const
|
||||
- :ref:`NodePath<class_nodepath>` **get_master_player** **(** **)** const
|
||||
|
||||
.. _class_AnimationTreePlayer_get_node_list:
|
||||
|
||||
- :ref:`PoolStringArray<class_poolstringarray>` **get_node_list** **(** **)**
|
||||
- :ref:`PoolStringArray<class_poolstringarray>` **get_node_list** **(** **)**
|
||||
|
||||
Returns a PoolStringArray containing the name of all nodes.
|
||||
|
||||
.. _class_AnimationTreePlayer_is_active:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_active** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_active** **(** **)** const
|
||||
|
||||
Returns whether this AnimationTreePlayer is active.
|
||||
|
||||
.. _class_AnimationTreePlayer_mix_node_get_amount:
|
||||
|
||||
- :ref:`float<class_float>` **mix_node_get_amount** **(** :ref:`String<class_string>` id **)** const
|
||||
- :ref:`float<class_float>` **mix_node_get_amount** **(** :ref:`String<class_string>` id **)** const
|
||||
|
||||
Returns mix amount of a Mix node given its name.
|
||||
|
||||
.. _class_AnimationTreePlayer_mix_node_set_amount:
|
||||
|
||||
- void **mix_node_set_amount** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` ratio **)**
|
||||
- void **mix_node_set_amount** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` ratio **)**
|
||||
|
||||
Sets mix amount of a Mix node given its name and value.
|
||||
|
||||
.. _class_AnimationTreePlayer_node_exists:
|
||||
|
||||
- :ref:`bool<class_bool>` **node_exists** **(** :ref:`String<class_string>` node **)** const
|
||||
- :ref:`bool<class_bool>` **node_exists** **(** :ref:`String<class_string>` node **)** const
|
||||
|
||||
Check if a node exists (by name).
|
||||
|
||||
.. _class_AnimationTreePlayer_node_get_input_count:
|
||||
|
||||
- :ref:`int<class_int>` **node_get_input_count** **(** :ref:`String<class_string>` id **)** const
|
||||
- :ref:`int<class_int>` **node_get_input_count** **(** :ref:`String<class_string>` id **)** const
|
||||
|
||||
Return the input count for a given node. Different types of nodes have different amount of inputs.
|
||||
|
||||
.. _class_AnimationTreePlayer_node_get_input_source:
|
||||
|
||||
- :ref:`String<class_string>` **node_get_input_source** **(** :ref:`String<class_string>` id, :ref:`int<class_int>` idx **)** const
|
||||
- :ref:`String<class_string>` **node_get_input_source** **(** :ref:`String<class_string>` id, :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Return the input source for a given node input.
|
||||
|
||||
.. _class_AnimationTreePlayer_node_get_position:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **node_get_position** **(** :ref:`String<class_string>` id **)** const
|
||||
- :ref:`Vector2<class_vector2>` **node_get_position** **(** :ref:`String<class_string>` id **)** const
|
||||
|
||||
Returns position of a node in the graph given its name.
|
||||
|
||||
.. _class_AnimationTreePlayer_node_get_type:
|
||||
|
||||
- :ref:`int<class_int>` **node_get_type** **(** :ref:`String<class_string>` id **)** const
|
||||
- :ref:`int<class_int>` **node_get_type** **(** :ref:`String<class_string>` id **)** const
|
||||
|
||||
Get the node type, will return from NODE\_\* enum.
|
||||
|
||||
.. _class_AnimationTreePlayer_node_rename:
|
||||
|
||||
- :ref:`int<class_int>` **node_rename** **(** :ref:`String<class_string>` node, :ref:`String<class_string>` new_name **)**
|
||||
- :ref:`int<class_int>` **node_rename** **(** :ref:`String<class_string>` node, :ref:`String<class_string>` new_name **)**
|
||||
|
||||
Rename a node in the graph.
|
||||
|
||||
.. _class_AnimationTreePlayer_node_set_position:
|
||||
|
||||
- void **node_set_position** **(** :ref:`String<class_string>` id, :ref:`Vector2<class_vector2>` screen_position **)**
|
||||
- void **node_set_position** **(** :ref:`String<class_string>` id, :ref:`Vector2<class_vector2>` screen_position **)**
|
||||
|
||||
Sets position of a node in the graph given its name and position.
|
||||
|
||||
.. _class_AnimationTreePlayer_oneshot_node_get_autorestart_delay:
|
||||
|
||||
- :ref:`float<class_float>` **oneshot_node_get_autorestart_delay** **(** :ref:`String<class_string>` id **)** const
|
||||
- :ref:`float<class_float>` **oneshot_node_get_autorestart_delay** **(** :ref:`String<class_string>` id **)** const
|
||||
|
||||
Returns autostart delay of a OneShot node given its name.
|
||||
|
||||
.. _class_AnimationTreePlayer_oneshot_node_get_autorestart_random_delay:
|
||||
|
||||
- :ref:`float<class_float>` **oneshot_node_get_autorestart_random_delay** **(** :ref:`String<class_string>` id **)** const
|
||||
- :ref:`float<class_float>` **oneshot_node_get_autorestart_random_delay** **(** :ref:`String<class_string>` id **)** const
|
||||
|
||||
Returns autostart random delay of a OneShot node given its name.
|
||||
|
||||
.. _class_AnimationTreePlayer_oneshot_node_get_fadein_time:
|
||||
|
||||
- :ref:`float<class_float>` **oneshot_node_get_fadein_time** **(** :ref:`String<class_string>` id **)** const
|
||||
- :ref:`float<class_float>` **oneshot_node_get_fadein_time** **(** :ref:`String<class_string>` id **)** const
|
||||
|
||||
Returns fade in time of a OneShot node given its name.
|
||||
|
||||
.. _class_AnimationTreePlayer_oneshot_node_get_fadeout_time:
|
||||
|
||||
- :ref:`float<class_float>` **oneshot_node_get_fadeout_time** **(** :ref:`String<class_string>` id **)** const
|
||||
- :ref:`float<class_float>` **oneshot_node_get_fadeout_time** **(** :ref:`String<class_string>` id **)** const
|
||||
|
||||
Returns fade out time of a OneShot node given its name.
|
||||
|
||||
.. _class_AnimationTreePlayer_oneshot_node_has_autorestart:
|
||||
|
||||
- :ref:`bool<class_bool>` **oneshot_node_has_autorestart** **(** :ref:`String<class_string>` id **)** const
|
||||
- :ref:`bool<class_bool>` **oneshot_node_has_autorestart** **(** :ref:`String<class_string>` id **)** const
|
||||
|
||||
Returns whether a OneShot node will auto restart given its name.
|
||||
|
||||
.. _class_AnimationTreePlayer_oneshot_node_is_active:
|
||||
|
||||
- :ref:`bool<class_bool>` **oneshot_node_is_active** **(** :ref:`String<class_string>` id **)** const
|
||||
- :ref:`bool<class_bool>` **oneshot_node_is_active** **(** :ref:`String<class_string>` id **)** const
|
||||
|
||||
Returns whether a OneShot node is active given its name.
|
||||
|
||||
.. _class_AnimationTreePlayer_oneshot_node_set_autorestart:
|
||||
|
||||
- void **oneshot_node_set_autorestart** **(** :ref:`String<class_string>` id, :ref:`bool<class_bool>` enable **)**
|
||||
- void **oneshot_node_set_autorestart** **(** :ref:`String<class_string>` id, :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
Sets autorestart property of a OneShot node given its name and value.
|
||||
|
||||
.. _class_AnimationTreePlayer_oneshot_node_set_autorestart_delay:
|
||||
|
||||
- void **oneshot_node_set_autorestart_delay** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` delay_sec **)**
|
||||
- void **oneshot_node_set_autorestart_delay** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` delay_sec **)**
|
||||
|
||||
Sets autorestart delay of a OneShot node given its name and value in seconds.
|
||||
|
||||
.. _class_AnimationTreePlayer_oneshot_node_set_autorestart_random_delay:
|
||||
|
||||
- void **oneshot_node_set_autorestart_random_delay** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` rand_sec **)**
|
||||
- void **oneshot_node_set_autorestart_random_delay** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` rand_sec **)**
|
||||
|
||||
Sets autorestart random delay of a OneShot node given its name and value in seconds.
|
||||
|
||||
.. _class_AnimationTreePlayer_oneshot_node_set_fadein_time:
|
||||
|
||||
- void **oneshot_node_set_fadein_time** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)**
|
||||
- void **oneshot_node_set_fadein_time** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)**
|
||||
|
||||
Sets fade in time of a OneShot node given its name and value in seconds.
|
||||
|
||||
.. _class_AnimationTreePlayer_oneshot_node_set_fadeout_time:
|
||||
|
||||
- void **oneshot_node_set_fadeout_time** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)**
|
||||
- void **oneshot_node_set_fadeout_time** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)**
|
||||
|
||||
Sets fade out time of a OneShot node given its name and value in seconds.
|
||||
|
||||
.. _class_AnimationTreePlayer_oneshot_node_set_filter_path:
|
||||
|
||||
- void **oneshot_node_set_filter_path** **(** :ref:`String<class_string>` id, :ref:`NodePath<class_nodepath>` path, :ref:`bool<class_bool>` enable **)**
|
||||
- void **oneshot_node_set_filter_path** **(** :ref:`String<class_string>` id, :ref:`NodePath<class_nodepath>` path, :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
.. _class_AnimationTreePlayer_oneshot_node_start:
|
||||
|
||||
- void **oneshot_node_start** **(** :ref:`String<class_string>` id **)**
|
||||
- void **oneshot_node_start** **(** :ref:`String<class_string>` id **)**
|
||||
|
||||
Starts a OneShot node given its name.
|
||||
|
||||
.. _class_AnimationTreePlayer_oneshot_node_stop:
|
||||
|
||||
- void **oneshot_node_stop** **(** :ref:`String<class_string>` id **)**
|
||||
- void **oneshot_node_stop** **(** :ref:`String<class_string>` id **)**
|
||||
|
||||
Stops a OneShot node given its name.
|
||||
|
||||
.. _class_AnimationTreePlayer_recompute_caches:
|
||||
|
||||
- void **recompute_caches** **(** **)**
|
||||
- void **recompute_caches** **(** **)**
|
||||
|
||||
.. _class_AnimationTreePlayer_remove_node:
|
||||
|
||||
- void **remove_node** **(** :ref:`String<class_string>` id **)**
|
||||
- void **remove_node** **(** :ref:`String<class_string>` id **)**
|
||||
|
||||
.. _class_AnimationTreePlayer_reset:
|
||||
|
||||
- void **reset** **(** **)**
|
||||
- void **reset** **(** **)**
|
||||
|
||||
Resets this AnimationTreePlayer.
|
||||
|
||||
.. _class_AnimationTreePlayer_set_active:
|
||||
|
||||
- void **set_active** **(** :ref:`bool<class_bool>` enabled **)**
|
||||
- void **set_active** **(** :ref:`bool<class_bool>` enabled **)**
|
||||
|
||||
Sets whether this AnimationTreePlayer is active. AnimationTreePlayer will start processing if set to active.
|
||||
|
||||
.. _class_AnimationTreePlayer_set_animation_process_mode:
|
||||
|
||||
- void **set_animation_process_mode** **(** :ref:`int<class_int>` mode **)**
|
||||
- void **set_animation_process_mode** **(** :ref:`int<class_int>` mode **)**
|
||||
|
||||
Sets process mode (ANIMATION_PROCESS\_\*) of this AnimationTreePlayer.
|
||||
|
||||
.. _class_AnimationTreePlayer_set_base_path:
|
||||
|
||||
- void **set_base_path** **(** :ref:`NodePath<class_nodepath>` path **)**
|
||||
- void **set_base_path** **(** :ref:`NodePath<class_nodepath>` path **)**
|
||||
|
||||
Sets base path of this AnimationTreePlayer.
|
||||
|
||||
.. _class_AnimationTreePlayer_set_master_player:
|
||||
|
||||
- void **set_master_player** **(** :ref:`NodePath<class_nodepath>` nodepath **)**
|
||||
- void **set_master_player** **(** :ref:`NodePath<class_nodepath>` nodepath **)**
|
||||
|
||||
.. _class_AnimationTreePlayer_timescale_node_get_scale:
|
||||
|
||||
- :ref:`float<class_float>` **timescale_node_get_scale** **(** :ref:`String<class_string>` id **)** const
|
||||
- :ref:`float<class_float>` **timescale_node_get_scale** **(** :ref:`String<class_string>` id **)** const
|
||||
|
||||
Returns time scale value of a TimeScale node given its name.
|
||||
|
||||
.. _class_AnimationTreePlayer_timescale_node_set_scale:
|
||||
|
||||
- void **timescale_node_set_scale** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` scale **)**
|
||||
- void **timescale_node_set_scale** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` scale **)**
|
||||
|
||||
Sets time scale value of a TimeScale node given its name and value.
|
||||
|
||||
.. _class_AnimationTreePlayer_timeseek_node_seek:
|
||||
|
||||
- void **timeseek_node_seek** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` seconds **)**
|
||||
- void **timeseek_node_seek** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` seconds **)**
|
||||
|
||||
Sets time seek value of a TimeSeek node given its name and value.
|
||||
|
||||
.. _class_AnimationTreePlayer_transition_node_delete_input:
|
||||
|
||||
- void **transition_node_delete_input** **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)**
|
||||
- void **transition_node_delete_input** **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)**
|
||||
|
||||
.. _class_AnimationTreePlayer_transition_node_get_current:
|
||||
|
||||
- :ref:`int<class_int>` **transition_node_get_current** **(** :ref:`String<class_string>` id **)** const
|
||||
- :ref:`int<class_int>` **transition_node_get_current** **(** :ref:`String<class_string>` id **)** const
|
||||
|
||||
.. _class_AnimationTreePlayer_transition_node_get_input_count:
|
||||
|
||||
- :ref:`int<class_int>` **transition_node_get_input_count** **(** :ref:`String<class_string>` id **)** const
|
||||
- :ref:`int<class_int>` **transition_node_get_input_count** **(** :ref:`String<class_string>` id **)** const
|
||||
|
||||
.. _class_AnimationTreePlayer_transition_node_get_xfade_time:
|
||||
|
||||
- :ref:`float<class_float>` **transition_node_get_xfade_time** **(** :ref:`String<class_string>` id **)** const
|
||||
- :ref:`float<class_float>` **transition_node_get_xfade_time** **(** :ref:`String<class_string>` id **)** const
|
||||
|
||||
.. _class_AnimationTreePlayer_transition_node_has_input_auto_advance:
|
||||
|
||||
- :ref:`bool<class_bool>` **transition_node_has_input_auto_advance** **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)** const
|
||||
- :ref:`bool<class_bool>` **transition_node_has_input_auto_advance** **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)** const
|
||||
|
||||
.. _class_AnimationTreePlayer_transition_node_set_current:
|
||||
|
||||
- void **transition_node_set_current** **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)**
|
||||
- void **transition_node_set_current** **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)**
|
||||
|
||||
.. _class_AnimationTreePlayer_transition_node_set_input_auto_advance:
|
||||
|
||||
- void **transition_node_set_input_auto_advance** **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx, :ref:`bool<class_bool>` enable **)**
|
||||
- void **transition_node_set_input_auto_advance** **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx, :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
.. _class_AnimationTreePlayer_transition_node_set_input_count:
|
||||
|
||||
- void **transition_node_set_input_count** **(** :ref:`String<class_string>` id, :ref:`int<class_int>` count **)**
|
||||
- void **transition_node_set_input_count** **(** :ref:`String<class_string>` id, :ref:`int<class_int>` count **)**
|
||||
|
||||
.. _class_AnimationTreePlayer_transition_node_set_xfade_time:
|
||||
|
||||
- void **transition_node_set_xfade_time** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)**
|
||||
- void **transition_node_set_xfade_time** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)**
|
||||
|
||||
|
||||
|
||||
@@ -19,144 +19,144 @@ General purpose area node for detection and 3D physics influence.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_angular_damp<class_Area_get_angular_damp>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_audio_bus<class_Area_get_audio_bus>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_collision_layer<class_Area_get_collision_layer>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_collision_layer_bit<class_Area_get_collision_layer_bit>` **(** :ref:`int<class_int>` bit **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_collision_mask<class_Area_get_collision_mask>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_collision_mask_bit<class_Area_get_collision_mask_bit>` **(** :ref:`int<class_int>` bit **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_gravity<class_Area_get_gravity>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_gravity_distance_scale<class_Area_get_gravity_distance_scale>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_gravity_vector<class_Area_get_gravity_vector>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_linear_damp<class_Area_get_linear_damp>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_overlapping_areas<class_Area_get_overlapping_areas>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_overlapping_bodies<class_Area_get_overlapping_bodies>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_priority<class_Area_get_priority>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_reverb_amount<class_Area_get_reverb_amount>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_reverb_bus<class_Area_get_reverb_bus>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_reverb_uniformity<class_Area_get_reverb_uniformity>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_space_override_mode<class_Area_get_space_override_mode>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_gravity_a_point<class_Area_is_gravity_a_point>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_monitorable<class_Area_is_monitorable>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_monitoring<class_Area_is_monitoring>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_overriding_audio_bus<class_Area_is_overriding_audio_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:`Node<class_node>` area **)** 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_audio_bus<class_Area_set_audio_bus>` **(** :ref:`String<class_string>` name **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_audio_bus_override<class_Area_set_audio_bus_override>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_layer<class_Area_set_collision_layer>` **(** :ref:`int<class_int>` collision_layer **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_layer_bit<class_Area_set_collision_layer_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_mask<class_Area_set_collision_mask>` **(** :ref:`int<class_int>` collision_mask **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_mask_bit<class_Area_set_collision_mask_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_gravity<class_Area_set_gravity>` **(** :ref:`float<class_float>` gravity **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_gravity_distance_scale<class_Area_set_gravity_distance_scale>` **(** :ref:`float<class_float>` distance_scale **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_gravity_is_point<class_Area_set_gravity_is_point>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_gravity_vector<class_Area_set_gravity_vector>` **(** :ref:`Vector3<class_vector3>` vector **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_linear_damp<class_Area_set_linear_damp>` **(** :ref:`float<class_float>` linear_damp **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_monitorable<class_Area_set_monitorable>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_monitoring<class_Area_set_monitoring>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_priority<class_Area_set_priority>` **(** :ref:`float<class_float>` priority **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_reverb_amount<class_Area_set_reverb_amount>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_reverb_bus<class_Area_set_reverb_bus>` **(** :ref:`String<class_string>` name **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_reverb_uniformity<class_Area_set_reverb_uniformity>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_space_override_mode<class_Area_set_space_override_mode>` **(** :ref:`int<class_int>` enable **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_use_reverb_bus<class_Area_set_use_reverb_bus>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_angular_damp<class_Area_get_angular_damp>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_audio_bus<class_Area_get_audio_bus>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_collision_layer<class_Area_get_collision_layer>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_collision_layer_bit<class_Area_get_collision_layer_bit>` **(** :ref:`int<class_int>` bit **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_collision_mask<class_Area_get_collision_mask>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_collision_mask_bit<class_Area_get_collision_mask_bit>` **(** :ref:`int<class_int>` bit **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_gravity<class_Area_get_gravity>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_gravity_distance_scale<class_Area_get_gravity_distance_scale>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_gravity_vector<class_Area_get_gravity_vector>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_linear_damp<class_Area_get_linear_damp>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_overlapping_areas<class_Area_get_overlapping_areas>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_overlapping_bodies<class_Area_get_overlapping_bodies>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_priority<class_Area_get_priority>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_reverb_amount<class_Area_get_reverb_amount>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_reverb_bus<class_Area_get_reverb_bus>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_reverb_uniformity<class_Area_get_reverb_uniformity>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_space_override_mode<class_Area_get_space_override_mode>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_gravity_a_point<class_Area_is_gravity_a_point>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_monitorable<class_Area_is_monitorable>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_monitoring<class_Area_is_monitoring>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_overriding_audio_bus<class_Area_is_overriding_audio_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:`Node<class_node>` area **)** 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_audio_bus<class_Area_set_audio_bus>` **(** :ref:`String<class_string>` name **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_audio_bus_override<class_Area_set_audio_bus_override>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_layer<class_Area_set_collision_layer>` **(** :ref:`int<class_int>` collision_layer **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_layer_bit<class_Area_set_collision_layer_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_mask<class_Area_set_collision_mask>` **(** :ref:`int<class_int>` collision_mask **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_mask_bit<class_Area_set_collision_mask_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_gravity<class_Area_set_gravity>` **(** :ref:`float<class_float>` gravity **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_gravity_distance_scale<class_Area_set_gravity_distance_scale>` **(** :ref:`float<class_float>` distance_scale **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_gravity_is_point<class_Area_set_gravity_is_point>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_gravity_vector<class_Area_set_gravity_vector>` **(** :ref:`Vector3<class_vector3>` vector **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_linear_damp<class_Area_set_linear_damp>` **(** :ref:`float<class_float>` linear_damp **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_monitorable<class_Area_set_monitorable>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_monitoring<class_Area_set_monitoring>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_priority<class_Area_set_priority>` **(** :ref:`float<class_float>` priority **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_reverb_amount<class_Area_set_reverb_amount>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_reverb_bus<class_Area_set_reverb_bus>` **(** :ref:`String<class_string>` name **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_reverb_uniformity<class_Area_set_reverb_uniformity>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_space_override_mode<class_Area_set_space_override_mode>` **(** :ref:`int<class_int>` enable **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_use_reverb_bus<class_Area_set_use_reverb_bus>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_Area_area_entered:
|
||||
|
||||
- **area_entered** **(** :ref:`Object<class_object>` area **)**
|
||||
- **area_entered** **(** :ref:`Object<class_object>` area **)**
|
||||
|
||||
Emitted when another area enters.
|
||||
|
||||
.. _class_Area_area_exited:
|
||||
|
||||
- **area_exited** **(** :ref:`Object<class_object>` area **)**
|
||||
- **area_exited** **(** :ref:`Object<class_object>` area **)**
|
||||
|
||||
Emitted when another area exits.
|
||||
|
||||
.. _class_Area_area_shape_entered:
|
||||
|
||||
- **area_shape_entered** **(** :ref:`int<class_int>` area_id, :ref:`Object<class_object>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)**
|
||||
- **area_shape_entered** **(** :ref:`int<class_int>` area_id, :ref:`Object<class_object>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)**
|
||||
|
||||
Emitted when another area enters, reporting which areas overlapped.
|
||||
|
||||
.. _class_Area_area_shape_exited:
|
||||
|
||||
- **area_shape_exited** **(** :ref:`int<class_int>` area_id, :ref:`Object<class_object>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)**
|
||||
- **area_shape_exited** **(** :ref:`int<class_int>` area_id, :ref:`Object<class_object>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)**
|
||||
|
||||
Emitted when another area exits, reporting which areas were overlapping.
|
||||
|
||||
.. _class_Area_body_entered:
|
||||
|
||||
- **body_entered** **(** :ref:`Object<class_object>` body **)**
|
||||
- **body_entered** **(** :ref:`Object<class_object>` body **)**
|
||||
|
||||
Emitted when a :ref:`PhysicsBody<class_physicsbody>` object enters.
|
||||
|
||||
.. _class_Area_body_exited:
|
||||
|
||||
- **body_exited** **(** :ref:`Object<class_object>` body **)**
|
||||
- **body_exited** **(** :ref:`Object<class_object>` body **)**
|
||||
|
||||
Emitted when a :ref:`PhysicsBody2D<class_physicsbody2d>` object exits.
|
||||
|
||||
.. _class_Area_body_shape_entered:
|
||||
|
||||
- **body_shape_entered** **(** :ref:`int<class_int>` body_id, :ref:`Object<class_object>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
|
||||
- **body_shape_entered** **(** :ref:`int<class_int>` body_id, :ref:`Object<class_object>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
|
||||
|
||||
Emitted when a :ref:`PhysicsBody2D<class_physicsbody2d>` object enters, reporting which shapes overlapped.
|
||||
|
||||
.. _class_Area_body_shape_exited:
|
||||
|
||||
- **body_shape_exited** **(** :ref:`int<class_int>` body_id, :ref:`Object<class_object>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
|
||||
- **body_shape_exited** **(** :ref:`int<class_int>` body_id, :ref:`Object<class_object>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
|
||||
|
||||
Emitted when a :ref:`PhysicsBody2D<class_physicsbody2d>` object exits, reporting which shapes were overlapping.
|
||||
|
||||
@@ -256,139 +256,139 @@ Member Function Description
|
||||
|
||||
.. _class_Area_get_angular_damp:
|
||||
|
||||
- :ref:`float<class_float>` **get_angular_damp** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_angular_damp** **(** **)** const
|
||||
|
||||
Return the angular damp rate.
|
||||
|
||||
.. _class_Area_get_audio_bus:
|
||||
|
||||
- :ref:`String<class_string>` **get_audio_bus** **(** **)** const
|
||||
- :ref:`String<class_string>` **get_audio_bus** **(** **)** const
|
||||
|
||||
.. _class_Area_get_collision_layer:
|
||||
|
||||
- :ref:`int<class_int>` **get_collision_layer** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_collision_layer** **(** **)** const
|
||||
|
||||
Return the physics layer this area is in.
|
||||
|
||||
.. _class_Area_get_collision_layer_bit:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_collision_layer_bit** **(** :ref:`int<class_int>` bit **)** const
|
||||
- :ref:`bool<class_bool>` **get_collision_layer_bit** **(** :ref:`int<class_int>` bit **)** const
|
||||
|
||||
Return an individual bit on the layer mask.
|
||||
|
||||
.. _class_Area_get_collision_mask:
|
||||
|
||||
- :ref:`int<class_int>` **get_collision_mask** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_collision_mask** **(** **)** const
|
||||
|
||||
Return the physics layers this area can scan for collisions.
|
||||
|
||||
.. _class_Area_get_collision_mask_bit:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_collision_mask_bit** **(** :ref:`int<class_int>` bit **)** const
|
||||
- :ref:`bool<class_bool>` **get_collision_mask_bit** **(** :ref:`int<class_int>` bit **)** const
|
||||
|
||||
Return an individual bit on the collision mask.
|
||||
|
||||
.. _class_Area_get_gravity:
|
||||
|
||||
- :ref:`float<class_float>` **get_gravity** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_gravity** **(** **)** const
|
||||
|
||||
Return the gravity intensity.
|
||||
|
||||
.. _class_Area_get_gravity_distance_scale:
|
||||
|
||||
- :ref:`float<class_float>` **get_gravity_distance_scale** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_gravity_distance_scale** **(** **)** const
|
||||
|
||||
Return the falloff factor for point gravity.
|
||||
|
||||
.. _class_Area_get_gravity_vector:
|
||||
|
||||
- :ref:`Vector3<class_vector3>` **get_gravity_vector** **(** **)** const
|
||||
- :ref:`Vector3<class_vector3>` **get_gravity_vector** **(** **)** const
|
||||
|
||||
Return the gravity vector. If gravity is a point (see :ref:`is_gravity_a_point<class_Area_is_gravity_a_point>`), this will be the attraction center.
|
||||
|
||||
.. _class_Area_get_linear_damp:
|
||||
|
||||
- :ref:`float<class_float>` **get_linear_damp** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_linear_damp** **(** **)** const
|
||||
|
||||
Return the linear damp rate.
|
||||
|
||||
.. _class_Area_get_overlapping_areas:
|
||||
|
||||
- :ref:`Array<class_array>` **get_overlapping_areas** **(** **)** const
|
||||
- :ref:`Array<class_array>` **get_overlapping_areas** **(** **)** const
|
||||
|
||||
Returns a list of intersecting :ref:`Area<class_area>`\ s.
|
||||
|
||||
.. _class_Area_get_overlapping_bodies:
|
||||
|
||||
- :ref:`Array<class_array>` **get_overlapping_bodies** **(** **)** const
|
||||
- :ref:`Array<class_array>` **get_overlapping_bodies** **(** **)** const
|
||||
|
||||
Returns a list of intersecting :ref:`PhysicsBody<class_physicsbody>`\ s.
|
||||
|
||||
.. _class_Area_get_priority:
|
||||
|
||||
- :ref:`float<class_float>` **get_priority** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_priority** **(** **)** const
|
||||
|
||||
Return the processing order of this area.
|
||||
|
||||
.. _class_Area_get_reverb_amount:
|
||||
|
||||
- :ref:`float<class_float>` **get_reverb_amount** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_reverb_amount** **(** **)** const
|
||||
|
||||
.. _class_Area_get_reverb_bus:
|
||||
|
||||
- :ref:`String<class_string>` **get_reverb_bus** **(** **)** const
|
||||
- :ref:`String<class_string>` **get_reverb_bus** **(** **)** const
|
||||
|
||||
.. _class_Area_get_reverb_uniformity:
|
||||
|
||||
- :ref:`float<class_float>` **get_reverb_uniformity** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_reverb_uniformity** **(** **)** const
|
||||
|
||||
.. _class_Area_get_space_override_mode:
|
||||
|
||||
- :ref:`int<class_int>` **get_space_override_mode** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_space_override_mode** **(** **)** const
|
||||
|
||||
Return the space override mode.
|
||||
|
||||
.. _class_Area_is_gravity_a_point:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_gravity_a_point** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_gravity_a_point** **(** **)** const
|
||||
|
||||
Return whether gravity is a point. A point gravity will attract objects towards it, as opposed to a gravity vector, which moves them in a given direction.
|
||||
|
||||
.. _class_Area_is_monitorable:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_monitorable** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_monitorable** **(** **)** const
|
||||
|
||||
Return whether this area can be detected by other, monitoring, areas.
|
||||
|
||||
.. _class_Area_is_monitoring:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_monitoring** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_monitoring** **(** **)** const
|
||||
|
||||
Return whether this area detects bodies/areas entering/exiting it.
|
||||
|
||||
.. _class_Area_is_overriding_audio_bus:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_overriding_audio_bus** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_overriding_audio_bus** **(** **)** const
|
||||
|
||||
.. _class_Area_is_using_reverb_bus:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_using_reverb_bus** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_using_reverb_bus** **(** **)** const
|
||||
|
||||
.. _class_Area_overlaps_area:
|
||||
|
||||
- :ref:`bool<class_bool>` **overlaps_area** **(** :ref:`Node<class_node>` area **)** const
|
||||
- :ref:`bool<class_bool>` **overlaps_area** **(** :ref:`Node<class_node>` area **)** const
|
||||
|
||||
If ``true`` the given area overlaps the Area.
|
||||
|
||||
.. _class_Area_overlaps_body:
|
||||
|
||||
- :ref:`bool<class_bool>` **overlaps_body** **(** :ref:`Node<class_node>` body **)** const
|
||||
- :ref:`bool<class_bool>` **overlaps_body** **(** :ref:`Node<class_node>` body **)** const
|
||||
|
||||
If ``true`` the given body overlaps the Area.
|
||||
|
||||
.. _class_Area_set_angular_damp:
|
||||
|
||||
- void **set_angular_damp** **(** :ref:`float<class_float>` angular_damp **)**
|
||||
- void **set_angular_damp** **(** :ref:`float<class_float>` angular_damp **)**
|
||||
|
||||
Set the rate at which objects stop spinning in this area, if there are not any other forces making it spin. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops.
|
||||
|
||||
@@ -396,15 +396,15 @@ In practice, as the fraction of speed lost gets smaller with each frame, a value
|
||||
|
||||
.. _class_Area_set_audio_bus:
|
||||
|
||||
- void **set_audio_bus** **(** :ref:`String<class_string>` name **)**
|
||||
- void **set_audio_bus** **(** :ref:`String<class_string>` name **)**
|
||||
|
||||
.. _class_Area_set_audio_bus_override:
|
||||
|
||||
- void **set_audio_bus_override** **(** :ref:`bool<class_bool>` enable **)**
|
||||
- void **set_audio_bus_override** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
.. _class_Area_set_collision_layer:
|
||||
|
||||
- void **set_collision_layer** **(** :ref:`int<class_int>` collision_layer **)**
|
||||
- void **set_collision_layer** **(** :ref:`int<class_int>` collision_layer **)**
|
||||
|
||||
Set the physics layers this area is in.
|
||||
|
||||
@@ -414,25 +414,25 @@ A contact is detected if object A is in any of the layers that object B scans, o
|
||||
|
||||
.. _class_Area_set_collision_layer_bit:
|
||||
|
||||
- void **set_collision_layer_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)**
|
||||
- void **set_collision_layer_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)**
|
||||
|
||||
Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier.
|
||||
|
||||
.. _class_Area_set_collision_mask:
|
||||
|
||||
- void **set_collision_mask** **(** :ref:`int<class_int>` collision_mask **)**
|
||||
- void **set_collision_mask** **(** :ref:`int<class_int>` collision_mask **)**
|
||||
|
||||
Set the physics layers this area can scan for collisions.
|
||||
|
||||
.. _class_Area_set_collision_mask_bit:
|
||||
|
||||
- void **set_collision_mask_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)**
|
||||
- void **set_collision_mask_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)**
|
||||
|
||||
Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier.
|
||||
|
||||
.. _class_Area_set_gravity:
|
||||
|
||||
- void **set_gravity** **(** :ref:`float<class_float>` gravity **)**
|
||||
- void **set_gravity** **(** :ref:`float<class_float>` gravity **)**
|
||||
|
||||
Set the gravity intensity. This is useful to alter the force of gravity without altering its direction.
|
||||
|
||||
@@ -440,19 +440,19 @@ This value multiplies the gravity vector, whether it is the given vector (:ref:`
|
||||
|
||||
.. _class_Area_set_gravity_distance_scale:
|
||||
|
||||
- void **set_gravity_distance_scale** **(** :ref:`float<class_float>` distance_scale **)**
|
||||
- void **set_gravity_distance_scale** **(** :ref:`float<class_float>` distance_scale **)**
|
||||
|
||||
Set the falloff factor for point gravity. The greater this value is, the faster the strength of gravity decreases with the square of distance.
|
||||
|
||||
.. _class_Area_set_gravity_is_point:
|
||||
|
||||
- void **set_gravity_is_point** **(** :ref:`bool<class_bool>` enable **)**
|
||||
- void **set_gravity_is_point** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
When overriding space parameters, this method sets whether this area has a center of gravity. To set/get the location of the center of gravity, use :ref:`set_gravity_vector<class_Area_set_gravity_vector>`/:ref:`get_gravity_vector<class_Area_get_gravity_vector>`.
|
||||
|
||||
.. _class_Area_set_gravity_vector:
|
||||
|
||||
- void **set_gravity_vector** **(** :ref:`Vector3<class_vector3>` vector **)**
|
||||
- void **set_gravity_vector** **(** :ref:`Vector3<class_vector3>` vector **)**
|
||||
|
||||
Set the gravity vector. This vector does not have to be normalized.
|
||||
|
||||
@@ -460,7 +460,7 @@ If gravity is a point (see :ref:`is_gravity_a_point<class_Area_is_gravity_a_poin
|
||||
|
||||
.. _class_Area_set_linear_damp:
|
||||
|
||||
- void **set_linear_damp** **(** :ref:`float<class_float>` linear_damp **)**
|
||||
- void **set_linear_damp** **(** :ref:`float<class_float>` linear_damp **)**
|
||||
|
||||
Set the rate at which objects stop moving in this area, if there are not any other forces moving it. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops.
|
||||
|
||||
@@ -468,19 +468,19 @@ In practice, as the fraction of speed lost gets smaller with each frame, a value
|
||||
|
||||
.. _class_Area_set_monitorable:
|
||||
|
||||
- void **set_monitorable** **(** :ref:`bool<class_bool>` enable **)**
|
||||
- void **set_monitorable** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
Set whether this area can be detected by other, monitoring, areas. Only areas need to be marked as monitorable. Bodies are always so.
|
||||
|
||||
.. _class_Area_set_monitoring:
|
||||
|
||||
- void **set_monitoring** **(** :ref:`bool<class_bool>` enable **)**
|
||||
- void **set_monitoring** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
Set whether this area can detect bodies/areas entering/exiting it.
|
||||
|
||||
.. _class_Area_set_priority:
|
||||
|
||||
- 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 a space override different from AREA_SPACE_OVERRIDE_DISABLED or AREA_SPACE_OVERRIDE_COMBINE, as they replace values, and are thus order-dependent.
|
||||
|
||||
@@ -488,19 +488,19 @@ Areas with the same priority value get evaluated in an unpredictable order, and
|
||||
|
||||
.. _class_Area_set_reverb_amount:
|
||||
|
||||
- void **set_reverb_amount** **(** :ref:`float<class_float>` amount **)**
|
||||
- void **set_reverb_amount** **(** :ref:`float<class_float>` amount **)**
|
||||
|
||||
.. _class_Area_set_reverb_bus:
|
||||
|
||||
- void **set_reverb_bus** **(** :ref:`String<class_string>` name **)**
|
||||
- void **set_reverb_bus** **(** :ref:`String<class_string>` name **)**
|
||||
|
||||
.. _class_Area_set_reverb_uniformity:
|
||||
|
||||
- void **set_reverb_uniformity** **(** :ref:`float<class_float>` amount **)**
|
||||
- void **set_reverb_uniformity** **(** :ref:`float<class_float>` amount **)**
|
||||
|
||||
.. _class_Area_set_space_override_mode:
|
||||
|
||||
- void **set_space_override_mode** **(** :ref:`int<class_int>` enable **)**
|
||||
- void **set_space_override_mode** **(** :ref:`int<class_int>` enable **)**
|
||||
|
||||
Set the space override mode. This mode controls how an area affects gravity and damp.
|
||||
|
||||
@@ -516,6 +516,6 @@ AREA_SPACE_OVERRIDE_REPLACE_COMBINE: This area replaces any gravity/damp calcula
|
||||
|
||||
.. _class_Area_set_use_reverb_bus:
|
||||
|
||||
- void **set_use_reverb_bus** **(** :ref:`bool<class_bool>` enable **)**
|
||||
- void **set_use_reverb_bus** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
|
||||
|
||||
@@ -19,128 +19,128 @@ Brief Description
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_angular_damp<class_Area2D_get_angular_damp>` **(** **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_audio_bus_name<class_Area2D_get_audio_bus_name>` **(** **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_collision_layer<class_Area2D_get_collision_layer>` **(** **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_collision_layer_bit<class_Area2D_get_collision_layer_bit>` **(** :ref:`int<class_int>` bit **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_collision_mask<class_Area2D_get_collision_mask>` **(** **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_collision_mask_bit<class_Area2D_get_collision_mask_bit>` **(** :ref:`int<class_int>` bit **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_gravity<class_Area2D_get_gravity>` **(** **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_gravity_distance_scale<class_Area2D_get_gravity_distance_scale>` **(** **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_gravity_vector<class_Area2D_get_gravity_vector>` **(** **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_linear_damp<class_Area2D_get_linear_damp>` **(** **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_overlapping_areas<class_Area2D_get_overlapping_areas>` **(** **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_overlapping_bodies<class_Area2D_get_overlapping_bodies>` **(** **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_priority<class_Area2D_get_priority>` **(** **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_space_override_mode<class_Area2D_get_space_override_mode>` **(** **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_gravity_a_point<class_Area2D_is_gravity_a_point>` **(** **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_monitorable<class_Area2D_is_monitorable>` **(** **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_monitoring<class_Area2D_is_monitoring>` **(** **)** 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:`Node<class_node>` area **)** 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_audio_bus_name<class_Area2D_set_audio_bus_name>` **(** :ref:`String<class_string>` name **)** |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_audio_bus_override<class_Area2D_set_audio_bus_override>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_layer<class_Area2D_set_collision_layer>` **(** :ref:`int<class_int>` collision_layer **)** |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_layer_bit<class_Area2D_set_collision_layer_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_mask<class_Area2D_set_collision_mask>` **(** :ref:`int<class_int>` collision_mask **)** |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_mask_bit<class_Area2D_set_collision_mask_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_gravity<class_Area2D_set_gravity>` **(** :ref:`float<class_float>` gravity **)** |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_gravity_distance_scale<class_Area2D_set_gravity_distance_scale>` **(** :ref:`float<class_float>` distance_scale **)** |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_gravity_is_point<class_Area2D_set_gravity_is_point>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_gravity_vector<class_Area2D_set_gravity_vector>` **(** :ref:`Vector2<class_vector2>` vector **)** |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_linear_damp<class_Area2D_set_linear_damp>` **(** :ref:`float<class_float>` linear_damp **)** |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_monitorable<class_Area2D_set_monitorable>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_monitoring<class_Area2D_set_monitoring>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_priority<class_Area2D_set_priority>` **(** :ref:`float<class_float>` priority **)** |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_space_override_mode<class_Area2D_set_space_override_mode>` **(** :ref:`int<class_int>` space_override_mode **)** |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_angular_damp<class_Area2D_get_angular_damp>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_audio_bus_name<class_Area2D_get_audio_bus_name>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_collision_layer<class_Area2D_get_collision_layer>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_collision_layer_bit<class_Area2D_get_collision_layer_bit>` **(** :ref:`int<class_int>` bit **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_collision_mask<class_Area2D_get_collision_mask>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_collision_mask_bit<class_Area2D_get_collision_mask_bit>` **(** :ref:`int<class_int>` bit **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_gravity<class_Area2D_get_gravity>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_gravity_distance_scale<class_Area2D_get_gravity_distance_scale>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_gravity_vector<class_Area2D_get_gravity_vector>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_linear_damp<class_Area2D_get_linear_damp>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_overlapping_areas<class_Area2D_get_overlapping_areas>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_overlapping_bodies<class_Area2D_get_overlapping_bodies>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_priority<class_Area2D_get_priority>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_space_override_mode<class_Area2D_get_space_override_mode>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_gravity_a_point<class_Area2D_is_gravity_a_point>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_monitorable<class_Area2D_is_monitorable>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_monitoring<class_Area2D_is_monitoring>` **(** **)** 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:`Node<class_node>` area **)** 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_audio_bus_name<class_Area2D_set_audio_bus_name>` **(** :ref:`String<class_string>` name **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_audio_bus_override<class_Area2D_set_audio_bus_override>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_layer<class_Area2D_set_collision_layer>` **(** :ref:`int<class_int>` collision_layer **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_layer_bit<class_Area2D_set_collision_layer_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_mask<class_Area2D_set_collision_mask>` **(** :ref:`int<class_int>` collision_mask **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_mask_bit<class_Area2D_set_collision_mask_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_gravity<class_Area2D_set_gravity>` **(** :ref:`float<class_float>` gravity **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_gravity_distance_scale<class_Area2D_set_gravity_distance_scale>` **(** :ref:`float<class_float>` distance_scale **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_gravity_is_point<class_Area2D_set_gravity_is_point>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_gravity_vector<class_Area2D_set_gravity_vector>` **(** :ref:`Vector2<class_vector2>` vector **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_linear_damp<class_Area2D_set_linear_damp>` **(** :ref:`float<class_float>` linear_damp **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_monitorable<class_Area2D_set_monitorable>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_monitoring<class_Area2D_set_monitoring>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_priority<class_Area2D_set_priority>` **(** :ref:`float<class_float>` priority **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_space_override_mode<class_Area2D_set_space_override_mode>` **(** :ref:`int<class_int>` space_override_mode **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_Area2D_area_entered:
|
||||
|
||||
- **area_entered** **(** :ref:`Object<class_object>` area **)**
|
||||
- **area_entered** **(** :ref:`Object<class_object>` area **)**
|
||||
|
||||
Emitted when another area enters.
|
||||
|
||||
.. _class_Area2D_area_exited:
|
||||
|
||||
- **area_exited** **(** :ref:`Object<class_object>` area **)**
|
||||
- **area_exited** **(** :ref:`Object<class_object>` area **)**
|
||||
|
||||
Emitted when another area exits.
|
||||
|
||||
.. _class_Area2D_area_shape_entered:
|
||||
|
||||
- **area_shape_entered** **(** :ref:`int<class_int>` area_id, :ref:`Object<class_object>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)**
|
||||
- **area_shape_entered** **(** :ref:`int<class_int>` area_id, :ref:`Object<class_object>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)**
|
||||
|
||||
Emitted when another area enters, reporting which shapes overlapped.
|
||||
|
||||
.. _class_Area2D_area_shape_exited:
|
||||
|
||||
- **area_shape_exited** **(** :ref:`int<class_int>` area_id, :ref:`Object<class_object>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)**
|
||||
- **area_shape_exited** **(** :ref:`int<class_int>` area_id, :ref:`Object<class_object>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)**
|
||||
|
||||
Emitted when another area exits, reporting which shapes were overlapping.
|
||||
|
||||
.. _class_Area2D_body_entered:
|
||||
|
||||
- **body_entered** **(** :ref:`Object<class_object>` body **)**
|
||||
- **body_entered** **(** :ref:`Object<class_object>` body **)**
|
||||
|
||||
Emitted when a :ref:`PhysicsBody2D<class_physicsbody2d>` object enters.
|
||||
|
||||
.. _class_Area2D_body_exited:
|
||||
|
||||
- **body_exited** **(** :ref:`Object<class_object>` body **)**
|
||||
- **body_exited** **(** :ref:`Object<class_object>` body **)**
|
||||
|
||||
Emitted when a :ref:`PhysicsBody2D<class_physicsbody2d>` object exits.
|
||||
|
||||
.. _class_Area2D_body_shape_entered:
|
||||
|
||||
- **body_shape_entered** **(** :ref:`int<class_int>` body_id, :ref:`Object<class_object>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
|
||||
- **body_shape_entered** **(** :ref:`int<class_int>` body_id, :ref:`Object<class_object>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
|
||||
|
||||
Emitted when a :ref:`PhysicsBody2D<class_physicsbody2d>` object enters, reporting which shapes overlapped.
|
||||
|
||||
.. _class_Area2D_body_shape_exited:
|
||||
|
||||
- **body_shape_exited** **(** :ref:`int<class_int>` body_id, :ref:`Object<class_object>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
|
||||
- **body_shape_exited** **(** :ref:`int<class_int>` body_id, :ref:`Object<class_object>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
|
||||
|
||||
Emitted when a :ref:`PhysicsBody2D<class_physicsbody2d>` object exits, reporting which shapes were overlapping.
|
||||
|
||||
@@ -224,123 +224,123 @@ Member Function Description
|
||||
|
||||
.. _class_Area2D_get_angular_damp:
|
||||
|
||||
- :ref:`float<class_float>` **get_angular_damp** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_angular_damp** **(** **)** const
|
||||
|
||||
Return the angular damp rate.
|
||||
|
||||
.. _class_Area2D_get_audio_bus_name:
|
||||
|
||||
- :ref:`String<class_string>` **get_audio_bus_name** **(** **)** const
|
||||
- :ref:`String<class_string>` **get_audio_bus_name** **(** **)** const
|
||||
|
||||
.. _class_Area2D_get_collision_layer:
|
||||
|
||||
- :ref:`int<class_int>` **get_collision_layer** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_collision_layer** **(** **)** const
|
||||
|
||||
Return the physics layer this area is in.
|
||||
|
||||
.. _class_Area2D_get_collision_layer_bit:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_collision_layer_bit** **(** :ref:`int<class_int>` bit **)** const
|
||||
- :ref:`bool<class_bool>` **get_collision_layer_bit** **(** :ref:`int<class_int>` bit **)** const
|
||||
|
||||
Return an individual bit on the layer mask. Describes whether other areas will collide with this one on the given layer.
|
||||
|
||||
.. _class_Area2D_get_collision_mask:
|
||||
|
||||
- :ref:`int<class_int>` **get_collision_mask** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_collision_mask** **(** **)** const
|
||||
|
||||
Return the physics layers this area will scan to determine collisions.
|
||||
|
||||
.. _class_Area2D_get_collision_mask_bit:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_collision_mask_bit** **(** :ref:`int<class_int>` bit **)** const
|
||||
- :ref:`bool<class_bool>` **get_collision_mask_bit** **(** :ref:`int<class_int>` bit **)** const
|
||||
|
||||
Return an individual bit on the collision mask. Describes whether this area will collide with others on the given layer.
|
||||
|
||||
.. _class_Area2D_get_gravity:
|
||||
|
||||
- :ref:`float<class_float>` **get_gravity** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_gravity** **(** **)** const
|
||||
|
||||
Return the gravity intensity.
|
||||
|
||||
.. _class_Area2D_get_gravity_distance_scale:
|
||||
|
||||
- :ref:`float<class_float>` **get_gravity_distance_scale** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_gravity_distance_scale** **(** **)** const
|
||||
|
||||
Return the falloff factor for point gravity.
|
||||
|
||||
.. _class_Area2D_get_gravity_vector:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **get_gravity_vector** **(** **)** const
|
||||
- :ref:`Vector2<class_vector2>` **get_gravity_vector** **(** **)** const
|
||||
|
||||
Return the gravity vector. If gravity is a point (see :ref:`is_gravity_a_point<class_Area2D_is_gravity_a_point>`), this will be the attraction center.
|
||||
|
||||
.. _class_Area2D_get_linear_damp:
|
||||
|
||||
- :ref:`float<class_float>` **get_linear_damp** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_linear_damp** **(** **)** const
|
||||
|
||||
Return the linear damp rate.
|
||||
|
||||
.. _class_Area2D_get_overlapping_areas:
|
||||
|
||||
- :ref:`Array<class_array>` **get_overlapping_areas** **(** **)** const
|
||||
- :ref:`Array<class_array>` **get_overlapping_areas** **(** **)** const
|
||||
|
||||
Returns a list of intersecting :ref:`Area2D<class_area2d>`\ s.
|
||||
|
||||
.. _class_Area2D_get_overlapping_bodies:
|
||||
|
||||
- :ref:`Array<class_array>` **get_overlapping_bodies** **(** **)** const
|
||||
- :ref:`Array<class_array>` **get_overlapping_bodies** **(** **)** const
|
||||
|
||||
Returns a list of intersecting :ref:`PhysicsBody2D<class_physicsbody2d>`\ s.
|
||||
|
||||
.. _class_Area2D_get_priority:
|
||||
|
||||
- :ref:`float<class_float>` **get_priority** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_priority** **(** **)** const
|
||||
|
||||
Return the processing order of this area.
|
||||
|
||||
.. _class_Area2D_get_space_override_mode:
|
||||
|
||||
- :ref:`int<class_int>` **get_space_override_mode** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_space_override_mode** **(** **)** const
|
||||
|
||||
Return the space override mode.
|
||||
|
||||
.. _class_Area2D_is_gravity_a_point:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_gravity_a_point** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_gravity_a_point** **(** **)** const
|
||||
|
||||
Return whether gravity is a point. A point gravity will attract objects towards it, as opposed to a gravity vector, which moves them in a given direction.
|
||||
|
||||
.. _class_Area2D_is_monitorable:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_monitorable** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_monitorable** **(** **)** const
|
||||
|
||||
Return whether this area can be detected by other, monitoring, areas.
|
||||
|
||||
.. _class_Area2D_is_monitoring:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_monitoring** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_monitoring** **(** **)** const
|
||||
|
||||
Return whether this area detects bodies/areas entering/exiting it.
|
||||
|
||||
.. _class_Area2D_is_overriding_audio_bus:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_overriding_audio_bus** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_overriding_audio_bus** **(** **)** const
|
||||
|
||||
.. _class_Area2D_overlaps_area:
|
||||
|
||||
- :ref:`bool<class_bool>` **overlaps_area** **(** :ref:`Node<class_node>` area **)** const
|
||||
- :ref:`bool<class_bool>` **overlaps_area** **(** :ref:`Node<class_node>` area **)** const
|
||||
|
||||
If ``true`` the given area overlaps the Area2D.
|
||||
|
||||
.. _class_Area2D_overlaps_body:
|
||||
|
||||
- :ref:`bool<class_bool>` **overlaps_body** **(** :ref:`Node<class_node>` body **)** const
|
||||
- :ref:`bool<class_bool>` **overlaps_body** **(** :ref:`Node<class_node>` body **)** const
|
||||
|
||||
If ``true`` the given body overlaps the Area2D.
|
||||
|
||||
.. _class_Area2D_set_angular_damp:
|
||||
|
||||
- void **set_angular_damp** **(** :ref:`float<class_float>` angular_damp **)**
|
||||
- void **set_angular_damp** **(** :ref:`float<class_float>` angular_damp **)**
|
||||
|
||||
Set the rate at which objects stop spinning in this area, if there are not any other forces making it spin. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops.
|
||||
|
||||
@@ -348,15 +348,15 @@ In practice, as the fraction of speed lost gets smaller with each frame, a value
|
||||
|
||||
.. _class_Area2D_set_audio_bus_name:
|
||||
|
||||
- void **set_audio_bus_name** **(** :ref:`String<class_string>` name **)**
|
||||
- void **set_audio_bus_name** **(** :ref:`String<class_string>` name **)**
|
||||
|
||||
.. _class_Area2D_set_audio_bus_override:
|
||||
|
||||
- void **set_audio_bus_override** **(** :ref:`bool<class_bool>` enable **)**
|
||||
- void **set_audio_bus_override** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
.. _class_Area2D_set_collision_layer:
|
||||
|
||||
- void **set_collision_layer** **(** :ref:`int<class_int>` collision_layer **)**
|
||||
- void **set_collision_layer** **(** :ref:`int<class_int>` collision_layer **)**
|
||||
|
||||
Set the physics layers this area is in.
|
||||
|
||||
@@ -366,25 +366,25 @@ A contact is detected if object A is in any of the layers that object B scans, o
|
||||
|
||||
.. _class_Area2D_set_collision_layer_bit:
|
||||
|
||||
- void **set_collision_layer_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)**
|
||||
- void **set_collision_layer_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)**
|
||||
|
||||
Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier.
|
||||
|
||||
.. _class_Area2D_set_collision_mask:
|
||||
|
||||
- void **set_collision_mask** **(** :ref:`int<class_int>` collision_mask **)**
|
||||
- void **set_collision_mask** **(** :ref:`int<class_int>` collision_mask **)**
|
||||
|
||||
Set the physics layers this area can scan for collisions.
|
||||
|
||||
.. _class_Area2D_set_collision_mask_bit:
|
||||
|
||||
- void **set_collision_mask_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)**
|
||||
- void **set_collision_mask_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)**
|
||||
|
||||
Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier.
|
||||
|
||||
.. _class_Area2D_set_gravity:
|
||||
|
||||
- void **set_gravity** **(** :ref:`float<class_float>` gravity **)**
|
||||
- void **set_gravity** **(** :ref:`float<class_float>` gravity **)**
|
||||
|
||||
Set the gravity intensity. This is useful to alter the force of gravity without altering its direction.
|
||||
|
||||
@@ -392,19 +392,19 @@ This value multiplies the gravity vector, whether it is the given vector (:ref:`
|
||||
|
||||
.. _class_Area2D_set_gravity_distance_scale:
|
||||
|
||||
- void **set_gravity_distance_scale** **(** :ref:`float<class_float>` distance_scale **)**
|
||||
- void **set_gravity_distance_scale** **(** :ref:`float<class_float>` distance_scale **)**
|
||||
|
||||
Set the falloff factor for point gravity. The greater this value is, the faster the strength of gravity decreases with the square of distance.
|
||||
|
||||
.. _class_Area2D_set_gravity_is_point:
|
||||
|
||||
- void **set_gravity_is_point** **(** :ref:`bool<class_bool>` enable **)**
|
||||
- void **set_gravity_is_point** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
When overriding space parameters, this method sets whether this area has a center of gravity. To set/get the location of the center of gravity, use :ref:`set_gravity_vector<class_Area2D_set_gravity_vector>`/:ref:`get_gravity_vector<class_Area2D_get_gravity_vector>`.
|
||||
|
||||
.. _class_Area2D_set_gravity_vector:
|
||||
|
||||
- void **set_gravity_vector** **(** :ref:`Vector2<class_vector2>` vector **)**
|
||||
- void **set_gravity_vector** **(** :ref:`Vector2<class_vector2>` vector **)**
|
||||
|
||||
Set the gravity vector. This vector does not have to be normalized.
|
||||
|
||||
@@ -412,7 +412,7 @@ If gravity is a point (see :ref:`is_gravity_a_point<class_Area2D_is_gravity_a_po
|
||||
|
||||
.. _class_Area2D_set_linear_damp:
|
||||
|
||||
- void **set_linear_damp** **(** :ref:`float<class_float>` linear_damp **)**
|
||||
- void **set_linear_damp** **(** :ref:`float<class_float>` linear_damp **)**
|
||||
|
||||
Set the rate at which objects stop moving in this area, if there are not any other forces moving it. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops.
|
||||
|
||||
@@ -420,19 +420,19 @@ In practice, as the fraction of speed lost gets smaller with each frame, a value
|
||||
|
||||
.. _class_Area2D_set_monitorable:
|
||||
|
||||
- void **set_monitorable** **(** :ref:`bool<class_bool>` enable **)**
|
||||
- void **set_monitorable** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
Set whether this area can be detected by other, monitoring, areas. Only areas need to be marked as monitorable. Bodies are always so.
|
||||
|
||||
.. _class_Area2D_set_monitoring:
|
||||
|
||||
- void **set_monitoring** **(** :ref:`bool<class_bool>` enable **)**
|
||||
- void **set_monitoring** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
Set whether this area can detect bodies/areas entering/exiting it.
|
||||
|
||||
.. _class_Area2D_set_priority:
|
||||
|
||||
- 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 a space override different from AREA_SPACE_OVERRIDE_DISABLED or AREA_SPACE_OVERRIDE_COMBINE, as they replace values, and are thus order-dependent.
|
||||
|
||||
@@ -440,7 +440,7 @@ Areas with the same priority value get evaluated in an unpredictable order, and
|
||||
|
||||
.. _class_Area2D_set_space_override_mode:
|
||||
|
||||
- void **set_space_override_mode** **(** :ref:`int<class_int>` space_override_mode **)**
|
||||
- void **set_space_override_mode** **(** :ref:`int<class_int>` space_override_mode **)**
|
||||
|
||||
Set the space override mode. This mode controls how an area affects gravity and damp.
|
||||
|
||||
|
||||
@@ -17,69 +17,69 @@ Generic array datatype.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`PoolColorArray<class_poolcolorarray>` from **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`PoolVector3Array<class_poolvector3array>` from **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`PoolVector2Array<class_poolvector2array>` from **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`PoolStringArray<class_poolstringarray>` from **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`PoolRealArray<class_poolrealarray>` from **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`PoolIntArray<class_poolintarray>` from **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`PoolByteArray<class_poolbytearray>` from **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`append<class_Array_append>` **(** var value **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`back<class_Array_back>` **(** **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear<class_Array_clear>` **(** **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`count<class_Array_count>` **(** var value **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`duplicate<class_Array_duplicate>` **(** **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`empty<class_Array_empty>` **(** **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`erase<class_Array_erase>` **(** var value **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`find<class_Array_find>` **(** var what, :ref:`int<class_int>` from=0 **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`find_last<class_Array_find_last>` **(** var value **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`front<class_Array_front>` **(** **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has<class_Array_has>` **(** var value **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`hash<class_Array_hash>` **(** **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`insert<class_Array_insert>` **(** :ref:`int<class_int>` position, var value **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`invert<class_Array_invert>` **(** **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`pop_back<class_Array_pop_back>` **(** **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`pop_front<class_Array_pop_front>` **(** **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`push_back<class_Array_push_back>` **(** var value **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`push_front<class_Array_push_front>` **(** var value **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove<class_Array_remove>` **(** :ref:`int<class_int>` position **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`resize<class_Array_resize>` **(** :ref:`int<class_int>` size **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`rfind<class_Array_rfind>` **(** var what, :ref:`int<class_int>` from=-1 **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`size<class_Array_size>` **(** **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`sort<class_Array_sort>` **(** **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`sort_custom<class_Array_sort_custom>` **(** :ref:`Object<class_object>` obj, :ref:`String<class_string>` func **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`PoolColorArray<class_poolcolorarray>` from **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`PoolVector3Array<class_poolvector3array>` from **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`PoolVector2Array<class_poolvector2array>` from **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`PoolStringArray<class_poolstringarray>` from **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`PoolRealArray<class_poolrealarray>` from **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`PoolIntArray<class_poolintarray>` from **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`PoolByteArray<class_poolbytearray>` from **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`append<class_Array_append>` **(** var value **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`back<class_Array_back>` **(** **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear<class_Array_clear>` **(** **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`count<class_Array_count>` **(** var value **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`duplicate<class_Array_duplicate>` **(** **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`empty<class_Array_empty>` **(** **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`erase<class_Array_erase>` **(** var value **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`find<class_Array_find>` **(** var what, :ref:`int<class_int>` from=0 **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`find_last<class_Array_find_last>` **(** var value **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`front<class_Array_front>` **(** **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has<class_Array_has>` **(** var value **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`hash<class_Array_hash>` **(** **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`insert<class_Array_insert>` **(** :ref:`int<class_int>` position, var value **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`invert<class_Array_invert>` **(** **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`pop_back<class_Array_pop_back>` **(** **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`pop_front<class_Array_pop_front>` **(** **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`push_back<class_Array_push_back>` **(** var value **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`push_front<class_Array_push_front>` **(** var value **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove<class_Array_remove>` **(** :ref:`int<class_int>` position **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`resize<class_Array_resize>` **(** :ref:`int<class_int>` size **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`rfind<class_Array_rfind>` **(** var what, :ref:`int<class_int>` from=-1 **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`size<class_Array_size>` **(** **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`sort<class_Array_sort>` **(** **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`sort_custom<class_Array_sort_custom>` **(** :ref:`Object<class_object>` obj, :ref:`String<class_string>` func **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -91,109 +91,109 @@ Member Function Description
|
||||
|
||||
.. _class_Array_Array:
|
||||
|
||||
- :ref:`Array<class_array>` **Array** **(** :ref:`PoolColorArray<class_poolcolorarray>` from **)**
|
||||
- :ref:`Array<class_array>` **Array** **(** :ref:`PoolColorArray<class_poolcolorarray>` from **)**
|
||||
|
||||
Construct an array from a :ref:`PoolColorArray<class_poolcolorarray>`.
|
||||
|
||||
.. _class_Array_Array:
|
||||
|
||||
- :ref:`Array<class_array>` **Array** **(** :ref:`PoolVector3Array<class_poolvector3array>` from **)**
|
||||
- :ref:`Array<class_array>` **Array** **(** :ref:`PoolVector3Array<class_poolvector3array>` from **)**
|
||||
|
||||
Construct an array from a :ref:`PoolVector3Array<class_poolvector3array>`.
|
||||
|
||||
.. _class_Array_Array:
|
||||
|
||||
- :ref:`Array<class_array>` **Array** **(** :ref:`PoolVector2Array<class_poolvector2array>` from **)**
|
||||
- :ref:`Array<class_array>` **Array** **(** :ref:`PoolVector2Array<class_poolvector2array>` from **)**
|
||||
|
||||
Construct an array from a :ref:`PoolVector2Array<class_poolvector2array>`.
|
||||
|
||||
.. _class_Array_Array:
|
||||
|
||||
- :ref:`Array<class_array>` **Array** **(** :ref:`PoolStringArray<class_poolstringarray>` from **)**
|
||||
- :ref:`Array<class_array>` **Array** **(** :ref:`PoolStringArray<class_poolstringarray>` from **)**
|
||||
|
||||
Construct an array from a :ref:`PoolStringArray<class_poolstringarray>`.
|
||||
|
||||
.. _class_Array_Array:
|
||||
|
||||
- :ref:`Array<class_array>` **Array** **(** :ref:`PoolRealArray<class_poolrealarray>` from **)**
|
||||
- :ref:`Array<class_array>` **Array** **(** :ref:`PoolRealArray<class_poolrealarray>` from **)**
|
||||
|
||||
Construct an array from a :ref:`PoolRealArray<class_poolrealarray>`.
|
||||
|
||||
.. _class_Array_Array:
|
||||
|
||||
- :ref:`Array<class_array>` **Array** **(** :ref:`PoolIntArray<class_poolintarray>` from **)**
|
||||
- :ref:`Array<class_array>` **Array** **(** :ref:`PoolIntArray<class_poolintarray>` from **)**
|
||||
|
||||
Construct an array from a :ref:`PoolIntArray<class_poolintarray>`.
|
||||
|
||||
.. _class_Array_Array:
|
||||
|
||||
- :ref:`Array<class_array>` **Array** **(** :ref:`PoolByteArray<class_poolbytearray>` from **)**
|
||||
- :ref:`Array<class_array>` **Array** **(** :ref:`PoolByteArray<class_poolbytearray>` from **)**
|
||||
|
||||
Construct an array from a :ref:`PoolByteArray<class_poolbytearray>`.
|
||||
|
||||
.. _class_Array_append:
|
||||
|
||||
- void **append** **(** var value **)**
|
||||
- void **append** **(** var value **)**
|
||||
|
||||
Append an element at the end of the array (alias of :ref:`push_back<class_Array_push_back>`).
|
||||
|
||||
.. _class_Array_back:
|
||||
|
||||
- void **back** **(** **)**
|
||||
- void **back** **(** **)**
|
||||
|
||||
Returns the last element of the array if the array is not empty (size>0).
|
||||
|
||||
.. _class_Array_clear:
|
||||
|
||||
- void **clear** **(** **)**
|
||||
- void **clear** **(** **)**
|
||||
|
||||
Clear the array (resize to 0).
|
||||
|
||||
.. _class_Array_count:
|
||||
|
||||
- :ref:`int<class_int>` **count** **(** var value **)**
|
||||
- :ref:`int<class_int>` **count** **(** var value **)**
|
||||
|
||||
Return the amount of times an element is in the array.
|
||||
|
||||
.. _class_Array_duplicate:
|
||||
|
||||
- :ref:`Array<class_array>` **duplicate** **(** **)**
|
||||
- :ref:`Array<class_array>` **duplicate** **(** **)**
|
||||
|
||||
Returns a copy of this ``Array``.
|
||||
|
||||
.. _class_Array_empty:
|
||||
|
||||
- :ref:`bool<class_bool>` **empty** **(** **)**
|
||||
- :ref:`bool<class_bool>` **empty** **(** **)**
|
||||
|
||||
Return true if the array is empty (size==0).
|
||||
|
||||
.. _class_Array_erase:
|
||||
|
||||
- void **erase** **(** var value **)**
|
||||
- void **erase** **(** var value **)**
|
||||
|
||||
Remove the first occurrence of a value from the array.
|
||||
|
||||
.. _class_Array_find:
|
||||
|
||||
- :ref:`int<class_int>` **find** **(** var what, :ref:`int<class_int>` from=0 **)**
|
||||
- :ref:`int<class_int>` **find** **(** var what, :ref:`int<class_int>` from=0 **)**
|
||||
|
||||
Searches the array for a value and returns its index or -1 if not found. Optionally, the initial search index can be passed.
|
||||
|
||||
.. _class_Array_find_last:
|
||||
|
||||
- :ref:`int<class_int>` **find_last** **(** var value **)**
|
||||
- :ref:`int<class_int>` **find_last** **(** var value **)**
|
||||
|
||||
Searches the array in reverse order for a value and returns its index or -1 if not found.
|
||||
|
||||
.. _class_Array_front:
|
||||
|
||||
- void **front** **(** **)**
|
||||
- void **front** **(** **)**
|
||||
|
||||
Returns the first element of the array if the array is not empty (size>0).
|
||||
|
||||
.. _class_Array_has:
|
||||
|
||||
- :ref:`bool<class_bool>` **has** **(** var value **)**
|
||||
- :ref:`bool<class_bool>` **has** **(** var value **)**
|
||||
|
||||
Return true if the array contains given value.
|
||||
|
||||
@@ -206,79 +206,79 @@ Return true if the array contains given value.
|
||||
|
||||
.. _class_Array_hash:
|
||||
|
||||
- :ref:`int<class_int>` **hash** **(** **)**
|
||||
- :ref:`int<class_int>` **hash** **(** **)**
|
||||
|
||||
Return a hashed integer value representing the array contents.
|
||||
|
||||
.. _class_Array_insert:
|
||||
|
||||
- void **insert** **(** :ref:`int<class_int>` position, var value **)**
|
||||
- void **insert** **(** :ref:`int<class_int>` position, var value **)**
|
||||
|
||||
Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()).
|
||||
|
||||
.. _class_Array_invert:
|
||||
|
||||
- void **invert** **(** **)**
|
||||
- void **invert** **(** **)**
|
||||
|
||||
Reverse the order of the elements in the array (so first element will now be the last) and return reference to the array.
|
||||
|
||||
.. _class_Array_pop_back:
|
||||
|
||||
- void **pop_back** **(** **)**
|
||||
- void **pop_back** **(** **)**
|
||||
|
||||
Remove the last element of the array.
|
||||
|
||||
.. _class_Array_pop_front:
|
||||
|
||||
- void **pop_front** **(** **)**
|
||||
- void **pop_front** **(** **)**
|
||||
|
||||
Remove the first element of the array.
|
||||
|
||||
.. _class_Array_push_back:
|
||||
|
||||
- void **push_back** **(** var value **)**
|
||||
- void **push_back** **(** var value **)**
|
||||
|
||||
Append an element at the end of the array.
|
||||
|
||||
.. _class_Array_push_front:
|
||||
|
||||
- void **push_front** **(** var value **)**
|
||||
- void **push_front** **(** var value **)**
|
||||
|
||||
Add an element at the beginning of the array.
|
||||
|
||||
.. _class_Array_remove:
|
||||
|
||||
- void **remove** **(** :ref:`int<class_int>` position **)**
|
||||
- void **remove** **(** :ref:`int<class_int>` position **)**
|
||||
|
||||
Remove an element from the array by index.
|
||||
|
||||
.. _class_Array_resize:
|
||||
|
||||
- void **resize** **(** :ref:`int<class_int>` size **)**
|
||||
- void **resize** **(** :ref:`int<class_int>` size **)**
|
||||
|
||||
Resize the array to contain a different number of elements. If the array size is smaller, elements are cleared, if bigger, new elements are Null.
|
||||
|
||||
.. _class_Array_rfind:
|
||||
|
||||
- :ref:`int<class_int>` **rfind** **(** var what, :ref:`int<class_int>` from=-1 **)**
|
||||
- :ref:`int<class_int>` **rfind** **(** var what, :ref:`int<class_int>` from=-1 **)**
|
||||
|
||||
Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array.
|
||||
|
||||
.. _class_Array_size:
|
||||
|
||||
- :ref:`int<class_int>` **size** **(** **)**
|
||||
- :ref:`int<class_int>` **size** **(** **)**
|
||||
|
||||
Return the amount of elements in the array.
|
||||
|
||||
.. _class_Array_sort:
|
||||
|
||||
- void **sort** **(** **)**
|
||||
- void **sort** **(** **)**
|
||||
|
||||
Sort the array using natural order and return reference to the array.
|
||||
|
||||
.. _class_Array_sort_custom:
|
||||
|
||||
- void **sort_custom** **(** :ref:`Object<class_object>` obj, :ref:`String<class_string>` func **)**
|
||||
- void **sort_custom** **(** :ref:`Object<class_object>` obj, :ref:`String<class_string>` func **)**
|
||||
|
||||
Sort the array using a custom method and return reference to the array. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return true if the first argument is less than the second, and return false otherwise. Note: you cannot randomize the return value as the heapsort algorithm expects a deterministic result. Doing so will result in unexpected behavior.
|
||||
|
||||
|
||||
@@ -19,53 +19,53 @@ Brief Description
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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:`center_geometry<class_ArrayMesh_center_geometry>` **(** **)** |
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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_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:`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 |
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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_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_len<class_ArrayMesh_surface_get_array_len>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`surface_get_arrays<class_ArrayMesh_surface_get_arrays>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`surface_get_blend_shape_arrays<class_ArrayMesh_surface_get_blend_shape_arrays>` **(** :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:`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 |
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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_name<class_ArrayMesh_surface_set_name>` **(** :ref:`int<class_int>` surf_idx, :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:`center_geometry<class_ArrayMesh_center_geometry>` **(** **)** |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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_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:`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 |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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_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_len<class_ArrayMesh_surface_get_array_len>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`surface_get_arrays<class_ArrayMesh_surface_get_arrays>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`surface_get_blend_shape_arrays<class_ArrayMesh_surface_get_blend_shape_arrays>` **(** :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:`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 |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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_name<class_ArrayMesh_surface_set_name>` **(** :ref:`int<class_int>` surf_idx, :ref:`String<class_string>` name **)** |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Numeric Constants
|
||||
-----------------
|
||||
@@ -97,11 +97,11 @@ Member Function Description
|
||||
|
||||
.. _class_ArrayMesh_add_blend_shape:
|
||||
|
||||
- void **add_blend_shape** **(** :ref:`String<class_string>` name **)**
|
||||
- void **add_blend_shape** **(** :ref:`String<class_string>` name **)**
|
||||
|
||||
.. _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=[ ], :ref:`int<class_int>` compress_flags=97792 **)**
|
||||
|
||||
Create a new surface (:ref:`get_surface_count<class_ArrayMesh_get_surface_count>` that will become surf_idx for this.
|
||||
|
||||
@@ -109,101 +109,101 @@ Surfaces are created to be rendered using a "primitive", which may be PRIMITIVE_
|
||||
|
||||
.. _class_ArrayMesh_center_geometry:
|
||||
|
||||
- void **center_geometry** **(** **)**
|
||||
- void **center_geometry** **(** **)**
|
||||
|
||||
.. _class_ArrayMesh_clear_blend_shapes:
|
||||
|
||||
- void **clear_blend_shapes** **(** **)**
|
||||
- void **clear_blend_shapes** **(** **)**
|
||||
|
||||
.. _class_ArrayMesh_get_blend_shape_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_blend_shape_count** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_blend_shape_count** **(** **)** const
|
||||
|
||||
.. _class_ArrayMesh_get_blend_shape_mode:
|
||||
|
||||
- :ref:`int<class_int>` **get_blend_shape_mode** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_blend_shape_mode** **(** **)** const
|
||||
|
||||
.. _class_ArrayMesh_get_blend_shape_name:
|
||||
|
||||
- :ref:`String<class_string>` **get_blend_shape_name** **(** :ref:`int<class_int>` index **)** const
|
||||
- :ref:`String<class_string>` **get_blend_shape_name** **(** :ref:`int<class_int>` index **)** const
|
||||
|
||||
.. _class_ArrayMesh_get_custom_aabb:
|
||||
|
||||
- :ref:`Rect3<class_rect3>` **get_custom_aabb** **(** **)** const
|
||||
- :ref:`Rect3<class_rect3>` **get_custom_aabb** **(** **)** const
|
||||
|
||||
.. _class_ArrayMesh_get_surface_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_surface_count** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_surface_count** **(** **)** const
|
||||
|
||||
Return the amount of surfaces that the :ref:`ArrayMesh<class_arraymesh>` holds.
|
||||
|
||||
.. _class_ArrayMesh_regen_normalmaps:
|
||||
|
||||
- void **regen_normalmaps** **(** **)**
|
||||
- void **regen_normalmaps** **(** **)**
|
||||
|
||||
.. _class_ArrayMesh_set_blend_shape_mode:
|
||||
|
||||
- void **set_blend_shape_mode** **(** :ref:`int<class_int>` mode **)**
|
||||
- void **set_blend_shape_mode** **(** :ref:`int<class_int>` mode **)**
|
||||
|
||||
.. _class_ArrayMesh_set_custom_aabb:
|
||||
|
||||
- void **set_custom_aabb** **(** :ref:`Rect3<class_rect3>` aabb **)**
|
||||
- void **set_custom_aabb** **(** :ref:`Rect3<class_rect3>` aabb **)**
|
||||
|
||||
.. _class_ArrayMesh_surface_get_array_index_len:
|
||||
|
||||
- :ref:`int<class_int>` **surface_get_array_index_len** **(** :ref:`int<class_int>` surf_idx **)** const
|
||||
- :ref:`int<class_int>` **surface_get_array_index_len** **(** :ref:`int<class_int>` surf_idx **)** const
|
||||
|
||||
Return the length in indices of the index array in the requested surface (see :ref:`add_surface<class_ArrayMesh_add_surface>`).
|
||||
|
||||
.. _class_ArrayMesh_surface_get_array_len:
|
||||
|
||||
- :ref:`int<class_int>` **surface_get_array_len** **(** :ref:`int<class_int>` surf_idx **)** const
|
||||
- :ref:`int<class_int>` **surface_get_array_len** **(** :ref:`int<class_int>` surf_idx **)** const
|
||||
|
||||
Return the length in vertices of the vertex array in the requested surface (see :ref:`add_surface<class_ArrayMesh_add_surface>`).
|
||||
|
||||
.. _class_ArrayMesh_surface_get_arrays:
|
||||
|
||||
- :ref:`Array<class_array>` **surface_get_arrays** **(** :ref:`int<class_int>` surf_idx **)** const
|
||||
- :ref:`Array<class_array>` **surface_get_arrays** **(** :ref:`int<class_int>` surf_idx **)** const
|
||||
|
||||
.. _class_ArrayMesh_surface_get_blend_shape_arrays:
|
||||
|
||||
- :ref:`Array<class_array>` **surface_get_blend_shape_arrays** **(** :ref:`int<class_int>` surf_idx **)** const
|
||||
- :ref:`Array<class_array>` **surface_get_blend_shape_arrays** **(** :ref:`int<class_int>` surf_idx **)** const
|
||||
|
||||
.. _class_ArrayMesh_surface_get_format:
|
||||
|
||||
- :ref:`int<class_int>` **surface_get_format** **(** :ref:`int<class_int>` surf_idx **)** const
|
||||
- :ref:`int<class_int>` **surface_get_format** **(** :ref:`int<class_int>` surf_idx **)** const
|
||||
|
||||
Return the format mask of the requested surface (see :ref:`add_surface<class_ArrayMesh_add_surface>`).
|
||||
|
||||
.. _class_ArrayMesh_surface_get_material:
|
||||
|
||||
- :ref:`Material<class_material>` **surface_get_material** **(** :ref:`int<class_int>` surf_idx **)** const
|
||||
- :ref:`Material<class_material>` **surface_get_material** **(** :ref:`int<class_int>` surf_idx **)** const
|
||||
|
||||
Return a :ref:`Material<class_material>` in a given surface. Surface is rendered using this material.
|
||||
|
||||
.. _class_ArrayMesh_surface_get_name:
|
||||
|
||||
- :ref:`String<class_string>` **surface_get_name** **(** :ref:`int<class_int>` surf_idx **)** const
|
||||
- :ref:`String<class_string>` **surface_get_name** **(** :ref:`int<class_int>` surf_idx **)** const
|
||||
|
||||
.. _class_ArrayMesh_surface_get_primitive_type:
|
||||
|
||||
- :ref:`int<class_int>` **surface_get_primitive_type** **(** :ref:`int<class_int>` surf_idx **)** const
|
||||
- :ref:`int<class_int>` **surface_get_primitive_type** **(** :ref:`int<class_int>` surf_idx **)** const
|
||||
|
||||
Return the primitive type of the requested surface (see :ref:`add_surface<class_ArrayMesh_add_surface>`).
|
||||
|
||||
.. _class_ArrayMesh_surface_remove:
|
||||
|
||||
- void **surface_remove** **(** :ref:`int<class_int>` surf_idx **)**
|
||||
- void **surface_remove** **(** :ref:`int<class_int>` surf_idx **)**
|
||||
|
||||
Remove a surface at position surf_idx, shifting greater surfaces one surf_idx slot down.
|
||||
|
||||
.. _class_ArrayMesh_surface_set_material:
|
||||
|
||||
- void **surface_set_material** **(** :ref:`int<class_int>` surf_idx, :ref:`Material<class_material>` material **)**
|
||||
- void **surface_set_material** **(** :ref:`int<class_int>` surf_idx, :ref:`Material<class_material>` material **)**
|
||||
|
||||
.. _class_ArrayMesh_surface_set_name:
|
||||
|
||||
- void **surface_set_name** **(** :ref:`int<class_int>` surf_idx, :ref:`String<class_string>` name **)**
|
||||
- void **surface_set_name** **(** :ref:`int<class_int>` surf_idx, :ref:`String<class_string>` name **)**
|
||||
|
||||
Set a :ref:`Material<class_material>` for a given surface. Surface will be rendered using this material.
|
||||
|
||||
|
||||
@@ -19,19 +19,19 @@ Anchor point in AR Space
|
||||
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:`Plane<class_plane>` | :ref:`get_plane<class_ARVRAnchor_get_plane>` **(** **)** 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 **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------+
|
||||
| :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:`Plane<class_plane>` | :ref:`get_plane<class_ARVRAnchor_get_plane>` **(** **)** 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
|
||||
----------------
|
||||
@@ -55,37 +55,37 @@ Member Function Description
|
||||
|
||||
.. _class_ARVRAnchor_get_anchor_id:
|
||||
|
||||
- :ref:`int<class_int>` **get_anchor_id** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_anchor_id** **(** **)** const
|
||||
|
||||
Returns the anchor id for this anchor.
|
||||
|
||||
.. _class_ARVRAnchor_get_anchor_name:
|
||||
|
||||
- :ref:`String<class_string>` **get_anchor_name** **(** **)** const
|
||||
- :ref:`String<class_string>` **get_anchor_name** **(** **)** const
|
||||
|
||||
Returns the name given to this anchor.
|
||||
|
||||
.. _class_ARVRAnchor_get_is_active:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_is_active** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **get_is_active** **(** **)** const
|
||||
|
||||
Returns true if the anchor is being tracked and false if no anchor with this id is currently known.
|
||||
|
||||
.. _class_ARVRAnchor_get_plane:
|
||||
|
||||
- :ref:`Plane<class_plane>` **get_plane** **(** **)** const
|
||||
- :ref:`Plane<class_plane>` **get_plane** **(** **)** const
|
||||
|
||||
Returns a plane aligned with our anchor, handy for intersection testing
|
||||
|
||||
.. _class_ARVRAnchor_get_size:
|
||||
|
||||
- :ref:`Vector3<class_vector3>` **get_size** **(** **)** const
|
||||
- :ref:`Vector3<class_vector3>` **get_size** **(** **)** const
|
||||
|
||||
Returns the estimated size of the plane that was detected. Say when the anchor relates to a table in the real world, this is the estimated size of the surface of that table.
|
||||
|
||||
.. _class_ARVRAnchor_set_anchor_id:
|
||||
|
||||
- void **set_anchor_id** **(** :ref:`int<class_int>` anchor_id **)**
|
||||
- void **set_anchor_id** **(** :ref:`int<class_int>` anchor_id **)**
|
||||
|
||||
Binds this anchor node to an anchor with this id. You can set this before the anchor itself exists. The first anchor that is identified gets id 1, the second id 2, etc. When anchors get removed that slot remains free and can be assigned to the next anchor that is identified. The most common situation where anchors 'disappear' is when the AR server identifies that two anchors represent different parts of the same plane and merge them.
|
||||
|
||||
|
||||
@@ -19,36 +19,36 @@ A spatial node representing a spatially tracked controller.
|
||||
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:`int<class_int>` | :ref:`get_hand<class_ARVRController_get_hand>` **(** **)** 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 **)** |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`int<class_int>` | :ref:`get_hand<class_ARVRController_get_hand>` **(** **)** 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
|
||||
-------
|
||||
|
||||
.. _class_ARVRController_button_pressed:
|
||||
|
||||
- **button_pressed** **(** :ref:`int<class_int>` button **)**
|
||||
- **button_pressed** **(** :ref:`int<class_int>` button **)**
|
||||
|
||||
When a button on this controller is pressed, this signal is given.
|
||||
|
||||
.. _class_ARVRController_button_release:
|
||||
|
||||
- **button_release** **(** :ref:`int<class_int>` button **)**
|
||||
- **button_release** **(** :ref:`int<class_int>` button **)**
|
||||
|
||||
When a button on this controller is released, this signal is given.
|
||||
|
||||
@@ -75,47 +75,47 @@ Member Function Description
|
||||
|
||||
.. _class_ARVRController_get_controller_id:
|
||||
|
||||
- :ref:`int<class_int>` **get_controller_id** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_controller_id** **(** **)** const
|
||||
|
||||
Returns the controller id currently assigned to this node.
|
||||
|
||||
.. _class_ARVRController_get_controller_name:
|
||||
|
||||
- :ref:`String<class_string>` **get_controller_name** **(** **)** const
|
||||
- :ref:`String<class_string>` **get_controller_name** **(** **)** const
|
||||
|
||||
If active, returns the name of the associated controller if provided by the AR/VR SDK used.
|
||||
|
||||
.. _class_ARVRController_get_hand:
|
||||
|
||||
- :ref:`int<class_int>` **get_hand** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_hand** **(** **)** const
|
||||
|
||||
.. _class_ARVRController_get_is_active:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_is_active** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **get_is_active** **(** **)** const
|
||||
|
||||
Returns true if the controller bound to this node is currently active and being tracked.
|
||||
|
||||
.. _class_ARVRController_get_joystick_axis:
|
||||
|
||||
- :ref:`float<class_float>` **get_joystick_axis** **(** :ref:`int<class_int>` axis **)** const
|
||||
- :ref:`float<class_float>` **get_joystick_axis** **(** :ref:`int<class_int>` axis **)** const
|
||||
|
||||
Returns the value of the given axis for things like triggers, touchpads, etc. that are embedded into the controller.
|
||||
|
||||
.. _class_ARVRController_get_joystick_id:
|
||||
|
||||
- :ref:`int<class_int>` **get_joystick_id** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_joystick_id** **(** **)** const
|
||||
|
||||
Returns the ID of the joystick object bound to this. Every controller tracked by the ARVR Server that has buttons and axis will also be registered as a joystick within Godot. This means that all the normal joystick tracking and input mapping will work for buttons and axis found on the AR/VR controllers. This ID is purely offered as information so you can link up the controller with its joystick entry.
|
||||
|
||||
.. _class_ARVRController_is_button_pressed:
|
||||
|
||||
- :ref:`int<class_int>` **is_button_pressed** **(** :ref:`int<class_int>` button **)** const
|
||||
- :ref:`int<class_int>` **is_button_pressed** **(** :ref:`int<class_int>` button **)** const
|
||||
|
||||
Is the given button currently pressed?
|
||||
|
||||
.. _class_ARVRController_set_controller_id:
|
||||
|
||||
- void **set_controller_id** **(** :ref:`int<class_int>` controller_id **)**
|
||||
- void **set_controller_id** **(** :ref:`int<class_int>` controller_id **)**
|
||||
|
||||
Changes the id that identifies the controller bound to this node. The first controller that the ARVR Server detects will have id 1, the second id 2, the third id 3, etc. When a controller is turned off that slot is freed ensuring that controllers will keep the same id while it is turned on even when controllers with lower ids are turned off.
|
||||
|
||||
|
||||
@@ -21,33 +21,33 @@ Base class for ARVR interface implementation.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_anchor_detection_is_enabled<class_ARVRInterface_get_anchor_detection_is_enabled>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_capabilities<class_ARVRInterface_get_capabilities>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`int<class_int>` | :ref:`get_tracking_status<class_ARVRInterface_get_tracking_status>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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_primary<class_ARVRInterface_is_primary>` **(** **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_stereo<class_ARVRInterface_is_stereo>` **(** **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_anchor_detection_is_enabled<class_ARVRInterface_set_anchor_detection_is_enabled>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_is_initialized<class_ARVRInterface_set_is_initialized>` **(** :ref:`bool<class_bool>` initialized **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_is_primary<class_ARVRInterface_set_is_primary>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`uninitialize<class_ARVRInterface_uninitialize>` **(** **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_anchor_detection_is_enabled<class_ARVRInterface_get_anchor_detection_is_enabled>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_capabilities<class_ARVRInterface_get_capabilities>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`int<class_int>` | :ref:`get_tracking_status<class_ARVRInterface_get_tracking_status>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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_primary<class_ARVRInterface_is_primary>` **(** **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_stereo<class_ARVRInterface_is_stereo>` **(** **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_anchor_detection_is_enabled<class_ARVRInterface_set_anchor_detection_is_enabled>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_is_initialized<class_ARVRInterface_set_is_initialized>` **(** :ref:`bool<class_bool>` initialized **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_is_primary<class_ARVRInterface_set_is_primary>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`uninitialize<class_ARVRInterface_uninitialize>` **(** **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -94,37 +94,37 @@ Member Function Description
|
||||
|
||||
.. _class_ARVRInterface_get_anchor_detection_is_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_anchor_detection_is_enabled** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **get_anchor_detection_is_enabled** **(** **)** const
|
||||
|
||||
Returns true if achor detection is enabled (AR only).
|
||||
|
||||
.. _class_ARVRInterface_get_capabilities:
|
||||
|
||||
- :ref:`int<class_int>` **get_capabilities** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_capabilities** **(** **)** const
|
||||
|
||||
Returns a combination of flags providing information about the capabilities of this interface.
|
||||
|
||||
.. _class_ARVRInterface_get_name:
|
||||
|
||||
- :ref:`String<class_string>` **get_name** **(** **)** const
|
||||
- :ref:`String<class_string>` **get_name** **(** **)** const
|
||||
|
||||
Returns the name of this interface (OpenVR, OpenHMD, ARKit, etc).
|
||||
|
||||
.. _class_ARVRInterface_get_recommended_render_targetsize:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **get_recommended_render_targetsize** **(** **)**
|
||||
- :ref:`Vector2<class_vector2>` **get_recommended_render_targetsize** **(** **)**
|
||||
|
||||
Returns the resolution at which we should render our intermediate results before things like lens distortion are applied by the VR platform.
|
||||
|
||||
.. _class_ARVRInterface_get_tracking_status:
|
||||
|
||||
- :ref:`int<class_int>` **get_tracking_status** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_tracking_status** **(** **)** const
|
||||
|
||||
If supported, returns the status of our tracking. This will allow you to provide feedback to the user whether there are issues with positional tracking.
|
||||
|
||||
.. _class_ARVRInterface_initialize:
|
||||
|
||||
- :ref:`bool<class_bool>` **initialize** **(** **)**
|
||||
- :ref:`bool<class_bool>` **initialize** **(** **)**
|
||||
|
||||
Call this to initialize this interface. The first interface that is initialized is identified as the primary interface and it will be used for rendering output.
|
||||
|
||||
@@ -138,43 +138,43 @@ While currently not used you can activate additional interfaces, you may wish to
|
||||
|
||||
.. _class_ARVRInterface_is_initialized:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_initialized** **(** **)**
|
||||
- :ref:`bool<class_bool>` **is_initialized** **(** **)**
|
||||
|
||||
Returns true if this interface is active.
|
||||
|
||||
.. _class_ARVRInterface_is_primary:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_primary** **(** **)**
|
||||
- :ref:`bool<class_bool>` **is_primary** **(** **)**
|
||||
|
||||
Returns true if this interface is currently the primary interface (the interface responsible for showing the output).
|
||||
|
||||
.. _class_ARVRInterface_is_stereo:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_stereo** **(** **)**
|
||||
- :ref:`bool<class_bool>` **is_stereo** **(** **)**
|
||||
|
||||
Returns true if the current output of this interface is in stereo.
|
||||
|
||||
.. _class_ARVRInterface_set_anchor_detection_is_enabled:
|
||||
|
||||
- void **set_anchor_detection_is_enabled** **(** :ref:`bool<class_bool>` enable **)**
|
||||
- void **set_anchor_detection_is_enabled** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
Enables anchor detection, this is used on AR interfaces and enables the extra logic that will detect planes, features, objects, etc. and adds/modifies anchor points.
|
||||
|
||||
.. _class_ARVRInterface_set_is_initialized:
|
||||
|
||||
- void **set_is_initialized** **(** :ref:`bool<class_bool>` initialized **)**
|
||||
- void **set_is_initialized** **(** :ref:`bool<class_bool>` initialized **)**
|
||||
|
||||
Initialize/uninitialize this interface (same effect as calling initialize/uninitialize).
|
||||
|
||||
.. _class_ARVRInterface_set_is_primary:
|
||||
|
||||
- void **set_is_primary** **(** :ref:`bool<class_bool>` enable **)**
|
||||
- void **set_is_primary** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
Set this interface to the primary interface (unset the old one).
|
||||
|
||||
.. _class_ARVRInterface_uninitialize:
|
||||
|
||||
- void **uninitialize** **(** **)**
|
||||
- void **uninitialize** **(** **)**
|
||||
|
||||
Turns the interface off.
|
||||
|
||||
|
||||
@@ -19,11 +19,11 @@ Our origin point in AR/VR.
|
||||
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 **)** |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| :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
|
||||
----------------
|
||||
@@ -49,13 +49,13 @@ Member Function Description
|
||||
|
||||
.. _class_ARVROrigin_get_world_scale:
|
||||
|
||||
- :ref:`float<class_float>` **get_world_scale** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_world_scale** **(** **)** const
|
||||
|
||||
Get the world scale applied to our positioning.
|
||||
|
||||
.. _class_ARVROrigin_set_world_scale:
|
||||
|
||||
- void **set_world_scale** **(** :ref:`float<class_float>` world_scale **)**
|
||||
- void **set_world_scale** **(** :ref:`float<class_float>` world_scale **)**
|
||||
|
||||
Changes the world scaling factor.
|
||||
|
||||
|
||||
@@ -19,25 +19,25 @@ A tracked object
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_hand<class_ARVRPositionalTracker_get_hand>` **(** **)** const |
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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 |
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_hand<class_ARVRPositionalTracker_get_hand>` **(** **)** const |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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 |
|
||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Numeric Constants
|
||||
-----------------
|
||||
@@ -60,53 +60,53 @@ Member Function Description
|
||||
|
||||
.. _class_ARVRPositionalTracker_get_hand:
|
||||
|
||||
- :ref:`int<class_int>` **get_hand** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_hand** **(** **)** const
|
||||
|
||||
.. _class_ARVRPositionalTracker_get_joy_id:
|
||||
|
||||
- :ref:`int<class_int>` **get_joy_id** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_joy_id** **(** **)** const
|
||||
|
||||
If this is a controller that is being tracked the controller will also be represented by a joystick entry with this id.
|
||||
|
||||
.. _class_ARVRPositionalTracker_get_name:
|
||||
|
||||
- :ref:`String<class_string>` **get_name** **(** **)** const
|
||||
- :ref:`String<class_string>` **get_name** **(** **)** const
|
||||
|
||||
If available this returns the name of the controller or anchor point.
|
||||
|
||||
.. _class_ARVRPositionalTracker_get_orientation:
|
||||
|
||||
- :ref:`Basis<class_basis>` **get_orientation** **(** **)** const
|
||||
- :ref:`Basis<class_basis>` **get_orientation** **(** **)** const
|
||||
|
||||
Returns the orientation matrix of the controller.
|
||||
|
||||
.. _class_ARVRPositionalTracker_get_position:
|
||||
|
||||
- :ref:`Vector3<class_vector3>` **get_position** **(** **)** const
|
||||
- :ref:`Vector3<class_vector3>` **get_position** **(** **)** const
|
||||
|
||||
Returns the position of the controller adjusted by world scale.
|
||||
|
||||
.. _class_ARVRPositionalTracker_get_tracks_orientation:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_tracks_orientation** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **get_tracks_orientation** **(** **)** const
|
||||
|
||||
Returns true if the orientation of this device is being tracked.
|
||||
|
||||
.. _class_ARVRPositionalTracker_get_tracks_position:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_tracks_position** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **get_tracks_position** **(** **)** const
|
||||
|
||||
Returns true if the position of this device is being tracked.
|
||||
|
||||
.. _class_ARVRPositionalTracker_get_transform:
|
||||
|
||||
- :ref:`Transform<class_transform>` **get_transform** **(** :ref:`bool<class_bool>` adjust_by_reference_frame **)** const
|
||||
- :ref:`Transform<class_transform>` **get_transform** **(** :ref:`bool<class_bool>` adjust_by_reference_frame **)** const
|
||||
|
||||
Returns the transform combining the orientation and position of this device.
|
||||
|
||||
.. _class_ARVRPositionalTracker_get_type:
|
||||
|
||||
- :ref:`int<class_int>` **get_type** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_type** **(** **)** const
|
||||
|
||||
Type of tracker.
|
||||
|
||||
|
||||
@@ -19,56 +19,56 @@ This is our AR/VR Server.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_interface<class_ARVRServer_add_interface>` **(** :ref:`ARVRInterface<class_arvrinterface>` interface **)** |
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`center_on_hmd<class_ARVRServer_center_on_hmd>` **(** :ref:`bool<class_bool>` ignore_tilt, :ref:`bool<class_bool>` keep_height **)** |
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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>` interface **)** |
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_primary_interface<class_ARVRServer_set_primary_interface>` **(** :ref:`ARVRInterface<class_arvrinterface>` interface **)** |
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_world_scale<class_ARVRServer_set_world_scale>` **(** :ref:`float<class_float>` arg0 **)** |
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_interface<class_ARVRServer_add_interface>` **(** :ref:`ARVRInterface<class_arvrinterface>` interface **)** |
|
||||
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`center_on_hmd<class_ARVRServer_center_on_hmd>` **(** :ref:`bool<class_bool>` ignore_tilt, :ref:`bool<class_bool>` keep_height **)** |
|
||||
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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>` interface **)** |
|
||||
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_primary_interface<class_ARVRServer_set_primary_interface>` **(** :ref:`ARVRInterface<class_arvrinterface>` interface **)** |
|
||||
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_world_scale<class_ARVRServer_set_world_scale>` **(** :ref:`float<class_float>` arg0 **)** |
|
||||
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_ARVRServer_interface_added:
|
||||
|
||||
- **interface_added** **(** :ref:`String<class_string>` name **)**
|
||||
- **interface_added** **(** :ref:`String<class_string>` name **)**
|
||||
|
||||
Signal send when a new interface has been added.
|
||||
|
||||
.. _class_ARVRServer_interface_removed:
|
||||
|
||||
- **interface_removed** **(** :ref:`String<class_string>` name **)**
|
||||
- **interface_removed** **(** :ref:`String<class_string>` name **)**
|
||||
|
||||
Signal send when an interface is removed.
|
||||
|
||||
.. _class_ARVRServer_tracker_added:
|
||||
|
||||
- **tracker_added** **(** :ref:`String<class_string>` name, :ref:`int<class_int>` type, :ref:`int<class_int>` id **)**
|
||||
- **tracker_added** **(** :ref:`String<class_string>` name, :ref:`int<class_int>` type, :ref:`int<class_int>` id **)**
|
||||
|
||||
Signal send when a new tracker has been added. If you don't use a fixed number of controllers or if you're using ARVRAnchors for an AR solution it is important to react to this signal and add the appropriate ARVRController or ARVRAnchor node related to this new tracker.
|
||||
|
||||
.. _class_ARVRServer_tracker_removed:
|
||||
|
||||
- **tracker_removed** **(** :ref:`String<class_string>` name, :ref:`int<class_int>` type, :ref:`int<class_int>` id **)**
|
||||
- **tracker_removed** **(** :ref:`String<class_string>` name, :ref:`int<class_int>` type, :ref:`int<class_int>` id **)**
|
||||
|
||||
Signal send when a tracker is removed, you should remove any ARVRController or ARVRAnchor points if applicable. This is not mandatory, the nodes simply become inactive and will be made active again when a new tracker becomes available (i.e. a new controller is switched on that takes the place of the previous one).
|
||||
|
||||
@@ -101,13 +101,13 @@ Member Function Description
|
||||
|
||||
.. _class_ARVRServer_add_interface:
|
||||
|
||||
- void **add_interface** **(** :ref:`ARVRInterface<class_arvrinterface>` interface **)**
|
||||
- void **add_interface** **(** :ref:`ARVRInterface<class_arvrinterface>` interface **)**
|
||||
|
||||
Mostly exposed for GDNative based interfaces, this is called to register an available interface with the AR/VR server.
|
||||
|
||||
.. _class_ARVRServer_center_on_hmd:
|
||||
|
||||
- void **center_on_hmd** **(** :ref:`bool<class_bool>` ignore_tilt, :ref:`bool<class_bool>` keep_height **)**
|
||||
- void **center_on_hmd** **(** :ref:`bool<class_bool>` ignore_tilt, :ref:`bool<class_bool>` keep_height **)**
|
||||
|
||||
This is a really important function to understand correctly. AR and VR platforms all handle positioning slightly differently.
|
||||
|
||||
@@ -123,61 +123,61 @@ You should call this method after a few seconds have passed, when the user reque
|
||||
|
||||
.. _class_ARVRServer_find_interface:
|
||||
|
||||
- :ref:`ARVRInterface<class_arvrinterface>` **find_interface** **(** :ref:`String<class_string>` name **)** const
|
||||
- :ref:`ARVRInterface<class_arvrinterface>` **find_interface** **(** :ref:`String<class_string>` name **)** const
|
||||
|
||||
Find an interface by its name. Say that you're making a game that uses specific capabilities of an AR/VR platform you can find the interface for that platform by name and initialize it.
|
||||
|
||||
.. _class_ARVRServer_get_interface:
|
||||
|
||||
- :ref:`ARVRInterface<class_arvrinterface>` **get_interface** **(** :ref:`int<class_int>` idx **)** const
|
||||
- :ref:`ARVRInterface<class_arvrinterface>` **get_interface** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Get the interface registered at a given index in our list of interfaces.
|
||||
|
||||
.. _class_ARVRServer_get_interface_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_interface_count** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_interface_count** **(** **)** const
|
||||
|
||||
Get the number of interfaces currently registered with the AR/VR server. If you're game supports multiple AR/VR platforms you can look throught the available interface and either present the user with a selection or simply try an initialize each interface and use the first one that returns true.
|
||||
|
||||
.. _class_ARVRServer_get_reference_frame:
|
||||
|
||||
- :ref:`Transform<class_transform>` **get_reference_frame** **(** **)** const
|
||||
- :ref:`Transform<class_transform>` **get_reference_frame** **(** **)** const
|
||||
|
||||
Gets our reference frame transform, mostly used internally and exposed for GDNative build interfaces.
|
||||
|
||||
.. _class_ARVRServer_get_tracker:
|
||||
|
||||
- :ref:`ARVRPositionalTracker<class_arvrpositionaltracker>` **get_tracker** **(** :ref:`int<class_int>` idx **)** const
|
||||
- :ref:`ARVRPositionalTracker<class_arvrpositionaltracker>` **get_tracker** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Get the positional tracker at the given ID.
|
||||
|
||||
.. _class_ARVRServer_get_tracker_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_tracker_count** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_tracker_count** **(** **)** const
|
||||
|
||||
Get the number of trackers currently registered.
|
||||
|
||||
.. _class_ARVRServer_get_world_scale:
|
||||
|
||||
- :ref:`float<class_float>` **get_world_scale** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_world_scale** **(** **)** const
|
||||
|
||||
Returns our world scale (see ARVROrigin for more information).
|
||||
|
||||
.. _class_ARVRServer_remove_interface:
|
||||
|
||||
- void **remove_interface** **(** :ref:`ARVRInterface<class_arvrinterface>` interface **)**
|
||||
- void **remove_interface** **(** :ref:`ARVRInterface<class_arvrinterface>` interface **)**
|
||||
|
||||
Removes a registered interface, again exposed mostly for GDNative based interfaces.
|
||||
|
||||
.. _class_ARVRServer_set_primary_interface:
|
||||
|
||||
- void **set_primary_interface** **(** :ref:`ARVRInterface<class_arvrinterface>` interface **)**
|
||||
- void **set_primary_interface** **(** :ref:`ARVRInterface<class_arvrinterface>` interface **)**
|
||||
|
||||
Changes the primary interface to the specified interface. Again mostly exposed for GDNative interfaces.
|
||||
|
||||
.. _class_ARVRServer_set_world_scale:
|
||||
|
||||
- void **set_world_scale** **(** :ref:`float<class_float>` arg0 **)**
|
||||
- void **set_world_scale** **(** :ref:`float<class_float>` arg0 **)**
|
||||
|
||||
Changing the world scale, see the ARVROrigin documentation for more information.
|
||||
|
||||
|
||||
@@ -19,41 +19,41 @@ AStar class representation that uses vectors as edges.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_compute_cost<class_AStar__compute_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>` position, :ref:`float<class_float>` weight_scale=1.0 **)** |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`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:`disconnect_points<class_AStar_disconnect_points>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_available_point_id<class_AStar_get_available_point_id>` **(** **)** const |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_closest_point<class_AStar_get_closest_point>` **(** :ref:`Vector3<class_vector3>` to_position **)** const |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_closest_position_in_segment<class_AStar_get_closest_position_in_segment>` **(** :ref:`Vector3<class_vector3>` to_position **)** const |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolIntArray<class_poolintarray>` | :ref:`get_id_path<class_AStar_get_id_path>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolVector3Array<class_poolvector3array>` | :ref:`get_point_path<class_AStar_get_point_path>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_point_position<class_AStar_get_point_position>` **(** :ref:`int<class_int>` id **)** const |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_point_weight_scale<class_AStar_get_point_weight_scale>` **(** :ref:`int<class_int>` id **)** const |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_points<class_AStar_get_points>` **(** **)** |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_point<class_AStar_has_point>` **(** :ref:`int<class_int>` id **)** const |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_point<class_AStar_remove_point>` **(** :ref:`int<class_int>` id **)** |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_compute_cost<class_AStar__compute_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>` position, :ref:`float<class_float>` weight_scale=1.0 **)** |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`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:`disconnect_points<class_AStar_disconnect_points>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_available_point_id<class_AStar_get_available_point_id>` **(** **)** const |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_closest_point<class_AStar_get_closest_point>` **(** :ref:`Vector3<class_vector3>` to_position **)** const |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_closest_position_in_segment<class_AStar_get_closest_position_in_segment>` **(** :ref:`Vector3<class_vector3>` to_position **)** const |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolIntArray<class_poolintarray>` | :ref:`get_id_path<class_AStar_get_id_path>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolVector3Array<class_poolvector3array>` | :ref:`get_point_path<class_AStar_get_point_path>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_point_position<class_AStar_get_point_position>` **(** :ref:`int<class_int>` id **)** const |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_point_weight_scale<class_AStar_get_point_weight_scale>` **(** :ref:`int<class_int>` id **)** const |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_points<class_AStar_get_points>` **(** **)** |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_point<class_AStar_has_point>` **(** :ref:`int<class_int>` id **)** const |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_point<class_AStar_remove_point>` **(** :ref:`int<class_int>` id **)** |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -67,19 +67,19 @@ Member Function Description
|
||||
|
||||
.. _class_AStar__compute_cost:
|
||||
|
||||
- void **_compute_cost** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** virtual
|
||||
- void **_compute_cost** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** virtual
|
||||
|
||||
Called when computing the cost between two connected points.
|
||||
|
||||
.. _class_AStar__estimate_cost:
|
||||
|
||||
- void **_estimate_cost** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** virtual
|
||||
- void **_estimate_cost** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** virtual
|
||||
|
||||
Called when estimating the cost between a point and the path's ending point.
|
||||
|
||||
.. _class_AStar_add_point:
|
||||
|
||||
- void **add_point** **(** :ref:`int<class_int>` id, :ref:`Vector3<class_vector3>` position, :ref:`float<class_float>` weight_scale=1.0 **)**
|
||||
- void **add_point** **(** :ref:`int<class_int>` id, :ref:`Vector3<class_vector3>` position, :ref:`float<class_float>` weight_scale=1.0 **)**
|
||||
|
||||
Adds a new point at the given position with the given identifier. The algorithm prefers points with lower ``weight_scale`` to form a path. The ``id`` must be 0 or larger, and the ``weight_scale`` must be 1 or larger.
|
||||
|
||||
@@ -91,19 +91,19 @@ Adds a new point at the given position with the given identifier. The algorithm
|
||||
|
||||
.. _class_AStar_are_points_connected:
|
||||
|
||||
- :ref:`bool<class_bool>` **are_points_connected** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** const
|
||||
- :ref:`bool<class_bool>` **are_points_connected** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** const
|
||||
|
||||
Returns whether there is a connection/segment between the given points.
|
||||
|
||||
.. _class_AStar_clear:
|
||||
|
||||
- void **clear** **(** **)**
|
||||
- void **clear** **(** **)**
|
||||
|
||||
Clears all the points and segments.
|
||||
|
||||
.. _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=true **)**
|
||||
|
||||
Creates a segment between the given points.
|
||||
|
||||
@@ -119,25 +119,25 @@ Creates a segment between the given points.
|
||||
|
||||
.. _class_AStar_disconnect_points:
|
||||
|
||||
- void **disconnect_points** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)**
|
||||
- void **disconnect_points** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)**
|
||||
|
||||
Deletes the segment between the given points.
|
||||
|
||||
.. _class_AStar_get_available_point_id:
|
||||
|
||||
- :ref:`int<class_int>` **get_available_point_id** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_available_point_id** **(** **)** const
|
||||
|
||||
Returns an id with no point associated to it.
|
||||
|
||||
.. _class_AStar_get_closest_point:
|
||||
|
||||
- :ref:`int<class_int>` **get_closest_point** **(** :ref:`Vector3<class_vector3>` to_position **)** const
|
||||
- :ref:`int<class_int>` **get_closest_point** **(** :ref:`Vector3<class_vector3>` to_position **)** const
|
||||
|
||||
Returns the id of the closest point to ``to_position``. Returns -1 if there are no points in the points pool.
|
||||
|
||||
.. _class_AStar_get_closest_position_in_segment:
|
||||
|
||||
- :ref:`Vector3<class_vector3>` **get_closest_position_in_segment** **(** :ref:`Vector3<class_vector3>` to_position **)** const
|
||||
- :ref:`Vector3<class_vector3>` **get_closest_position_in_segment** **(** :ref:`Vector3<class_vector3>` to_position **)** const
|
||||
|
||||
Returns the closest position to ``to_position`` that resides inside a segment between two connected points.
|
||||
|
||||
@@ -156,7 +156,7 @@ The result is in the segment that goes from ``y=0`` to ``y=5``. It's the closest
|
||||
|
||||
.. _class_AStar_get_id_path:
|
||||
|
||||
- :ref:`PoolIntArray<class_poolintarray>` **get_id_path** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)**
|
||||
- :ref:`PoolIntArray<class_poolintarray>` **get_id_path** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)**
|
||||
|
||||
Returns an array with the ids of the points that form the path found by AStar between the given points. The array is ordered from the starting point to the ending point of the path.
|
||||
|
||||
@@ -181,35 +181,35 @@ If you change the 2nd point's weight to 3, then the result will be ``[1, 4, 3]``
|
||||
|
||||
.. _class_AStar_get_point_path:
|
||||
|
||||
- :ref:`PoolVector3Array<class_poolvector3array>` **get_point_path** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)**
|
||||
- :ref:`PoolVector3Array<class_poolvector3array>` **get_point_path** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)**
|
||||
|
||||
Returns an array with the points that are in the path found by AStar between the given points. The array is ordered from the starting point to the ending point of the path.
|
||||
|
||||
.. _class_AStar_get_point_position:
|
||||
|
||||
- :ref:`Vector3<class_vector3>` **get_point_position** **(** :ref:`int<class_int>` id **)** const
|
||||
- :ref:`Vector3<class_vector3>` **get_point_position** **(** :ref:`int<class_int>` id **)** const
|
||||
|
||||
Returns the position of the point associated with the given id.
|
||||
|
||||
.. _class_AStar_get_point_weight_scale:
|
||||
|
||||
- :ref:`float<class_float>` **get_point_weight_scale** **(** :ref:`int<class_int>` id **)** const
|
||||
- :ref:`float<class_float>` **get_point_weight_scale** **(** :ref:`int<class_int>` id **)** const
|
||||
|
||||
Returns the weight scale of the point associated with the given id.
|
||||
|
||||
.. _class_AStar_get_points:
|
||||
|
||||
- :ref:`Array<class_array>` **get_points** **(** **)**
|
||||
- :ref:`Array<class_array>` **get_points** **(** **)**
|
||||
|
||||
.. _class_AStar_has_point:
|
||||
|
||||
- :ref:`bool<class_bool>` **has_point** **(** :ref:`int<class_int>` id **)** const
|
||||
- :ref:`bool<class_bool>` **has_point** **(** :ref:`int<class_int>` id **)** const
|
||||
|
||||
Returns whether a point associated with the given id exists.
|
||||
|
||||
.. _class_AStar_remove_point:
|
||||
|
||||
- void **remove_point** **(** :ref:`int<class_int>` id **)**
|
||||
- void **remove_point** **(** :ref:`int<class_int>` id **)**
|
||||
|
||||
Removes the point associated with the given id from the points pool.
|
||||
|
||||
|
||||
@@ -19,19 +19,19 @@ Packs multiple small textures in a single, bigger one. Helps to optimize video m
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Texture<class_texture>` | :ref:`get_atlas<class_AtlasTexture_get_atlas>` **(** **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Rect2<class_rect2>` | :ref:`get_margin<class_AtlasTexture_get_margin>` **(** **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Rect2<class_rect2>` | :ref:`get_region<class_AtlasTexture_get_region>` **(** **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_atlas<class_AtlasTexture_set_atlas>` **(** :ref:`Texture<class_texture>` atlas **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_margin<class_AtlasTexture_set_margin>` **(** :ref:`Rect2<class_rect2>` margin **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_region<class_AtlasTexture_set_region>` **(** :ref:`Rect2<class_rect2>` region **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Texture<class_texture>` | :ref:`get_atlas<class_AtlasTexture_get_atlas>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Rect2<class_rect2>` | :ref:`get_margin<class_AtlasTexture_get_margin>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Rect2<class_rect2>` | :ref:`get_region<class_AtlasTexture_get_region>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_atlas<class_AtlasTexture_set_atlas>` **(** :ref:`Texture<class_texture>` atlas **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_margin<class_AtlasTexture_set_margin>` **(** :ref:`Rect2<class_rect2>` margin **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_region<class_AtlasTexture_set_region>` **(** :ref:`Rect2<class_rect2>` region **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -61,26 +61,26 @@ Member Function Description
|
||||
|
||||
.. _class_AtlasTexture_get_atlas:
|
||||
|
||||
- :ref:`Texture<class_texture>` **get_atlas** **(** **)** const
|
||||
- :ref:`Texture<class_texture>` **get_atlas** **(** **)** const
|
||||
|
||||
.. _class_AtlasTexture_get_margin:
|
||||
|
||||
- :ref:`Rect2<class_rect2>` **get_margin** **(** **)** const
|
||||
- :ref:`Rect2<class_rect2>` **get_margin** **(** **)** const
|
||||
|
||||
.. _class_AtlasTexture_get_region:
|
||||
|
||||
- :ref:`Rect2<class_rect2>` **get_region** **(** **)** const
|
||||
- :ref:`Rect2<class_rect2>` **get_region** **(** **)** const
|
||||
|
||||
.. _class_AtlasTexture_set_atlas:
|
||||
|
||||
- void **set_atlas** **(** :ref:`Texture<class_texture>` atlas **)**
|
||||
- void **set_atlas** **(** :ref:`Texture<class_texture>` atlas **)**
|
||||
|
||||
.. _class_AtlasTexture_set_margin:
|
||||
|
||||
- void **set_margin** **(** :ref:`Rect2<class_rect2>` margin **)**
|
||||
- void **set_margin** **(** :ref:`Rect2<class_rect2>` margin **)**
|
||||
|
||||
.. _class_AtlasTexture_set_region:
|
||||
|
||||
- void **set_region** **(** :ref:`Rect2<class_rect2>` region **)**
|
||||
- void **set_region** **(** :ref:`Rect2<class_rect2>` region **)**
|
||||
|
||||
|
||||
|
||||
@@ -21,11 +21,11 @@ Increases or decreases the volume of the selected audio bus.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_volume_db<class_AudioEffectAmplify_get_volume_db>` **(** **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_volume_db<class_AudioEffectAmplify_set_volume_db>` **(** :ref:`float<class_float>` volume **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_volume_db<class_AudioEffectAmplify_get_volume_db>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_volume_db<class_AudioEffectAmplify_set_volume_db>` **(** :ref:`float<class_float>` volume **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -45,10 +45,10 @@ Member Function Description
|
||||
|
||||
.. _class_AudioEffectAmplify_get_volume_db:
|
||||
|
||||
- :ref:`float<class_float>` **get_volume_db** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_volume_db** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectAmplify_set_volume_db:
|
||||
|
||||
- void **set_volume_db** **(** :ref:`float<class_float>` volume **)**
|
||||
- void **set_volume_db** **(** :ref:`float<class_float>` volume **)**
|
||||
|
||||
|
||||
|
||||
@@ -19,43 +19,43 @@ Adds a chorus audio effect.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_dry<class_AudioEffectChorus_get_dry>` **(** **)** const |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_voice_count<class_AudioEffectChorus_get_voice_count>` **(** **)** const |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_voice_cutoff_hz<class_AudioEffectChorus_get_voice_cutoff_hz>` **(** :ref:`int<class_int>` voice_idx **)** const |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_voice_delay_ms<class_AudioEffectChorus_get_voice_delay_ms>` **(** :ref:`int<class_int>` voice_idx **)** const |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_voice_depth_ms<class_AudioEffectChorus_get_voice_depth_ms>` **(** :ref:`int<class_int>` voice_idx **)** const |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_voice_level_db<class_AudioEffectChorus_get_voice_level_db>` **(** :ref:`int<class_int>` voice_idx **)** const |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_voice_pan<class_AudioEffectChorus_get_voice_pan>` **(** :ref:`int<class_int>` voice_idx **)** const |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_voice_rate_hz<class_AudioEffectChorus_get_voice_rate_hz>` **(** :ref:`int<class_int>` voice_idx **)** const |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_wet<class_AudioEffectChorus_get_wet>` **(** **)** const |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_dry<class_AudioEffectChorus_set_dry>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_voice_count<class_AudioEffectChorus_set_voice_count>` **(** :ref:`int<class_int>` voices **)** |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_voice_cutoff_hz<class_AudioEffectChorus_set_voice_cutoff_hz>` **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` cutoff_hz **)** |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_voice_delay_ms<class_AudioEffectChorus_set_voice_delay_ms>` **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` delay_ms **)** |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_voice_depth_ms<class_AudioEffectChorus_set_voice_depth_ms>` **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` depth_ms **)** |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_voice_level_db<class_AudioEffectChorus_set_voice_level_db>` **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` level_db **)** |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_voice_pan<class_AudioEffectChorus_set_voice_pan>` **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` pan **)** |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_voice_rate_hz<class_AudioEffectChorus_set_voice_rate_hz>` **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` rate_hz **)** |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_wet<class_AudioEffectChorus_set_wet>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_dry<class_AudioEffectChorus_get_dry>` **(** **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_voice_count<class_AudioEffectChorus_get_voice_count>` **(** **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_voice_cutoff_hz<class_AudioEffectChorus_get_voice_cutoff_hz>` **(** :ref:`int<class_int>` voice_idx **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_voice_delay_ms<class_AudioEffectChorus_get_voice_delay_ms>` **(** :ref:`int<class_int>` voice_idx **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_voice_depth_ms<class_AudioEffectChorus_get_voice_depth_ms>` **(** :ref:`int<class_int>` voice_idx **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_voice_level_db<class_AudioEffectChorus_get_voice_level_db>` **(** :ref:`int<class_int>` voice_idx **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_voice_pan<class_AudioEffectChorus_get_voice_pan>` **(** :ref:`int<class_int>` voice_idx **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_voice_rate_hz<class_AudioEffectChorus_get_voice_rate_hz>` **(** :ref:`int<class_int>` voice_idx **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_wet<class_AudioEffectChorus_get_wet>` **(** **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_dry<class_AudioEffectChorus_set_dry>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_voice_count<class_AudioEffectChorus_set_voice_count>` **(** :ref:`int<class_int>` voices **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_voice_cutoff_hz<class_AudioEffectChorus_set_voice_cutoff_hz>` **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` cutoff_hz **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_voice_delay_ms<class_AudioEffectChorus_set_voice_delay_ms>` **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` delay_ms **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_voice_depth_ms<class_AudioEffectChorus_set_voice_depth_ms>` **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` depth_ms **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_voice_level_db<class_AudioEffectChorus_set_voice_level_db>` **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` level_db **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_voice_pan<class_AudioEffectChorus_set_voice_pan>` **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` pan **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_voice_rate_hz<class_AudioEffectChorus_set_voice_rate_hz>` **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` rate_hz **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_wet<class_AudioEffectChorus_set_wet>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -179,109 +179,109 @@ Member Function Description
|
||||
|
||||
.. _class_AudioEffectChorus_get_dry:
|
||||
|
||||
- :ref:`float<class_float>` **get_dry** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_dry** **(** **)** const
|
||||
|
||||
Returns the set dry ratio.
|
||||
|
||||
.. _class_AudioEffectChorus_get_voice_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_voice_count** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_voice_count** **(** **)** const
|
||||
|
||||
Returns the set voice count.
|
||||
|
||||
.. _class_AudioEffectChorus_get_voice_cutoff_hz:
|
||||
|
||||
- :ref:`float<class_float>` **get_voice_cutoff_hz** **(** :ref:`int<class_int>` voice_idx **)** const
|
||||
- :ref:`float<class_float>` **get_voice_cutoff_hz** **(** :ref:`int<class_int>` voice_idx **)** const
|
||||
|
||||
Returns the voice's set cutoff frequency.
|
||||
|
||||
.. _class_AudioEffectChorus_get_voice_delay_ms:
|
||||
|
||||
- :ref:`float<class_float>` **get_voice_delay_ms** **(** :ref:`int<class_int>` voice_idx **)** const
|
||||
- :ref:`float<class_float>` **get_voice_delay_ms** **(** :ref:`int<class_int>` voice_idx **)** const
|
||||
|
||||
Returns the voice's set delay.
|
||||
|
||||
.. _class_AudioEffectChorus_get_voice_depth_ms:
|
||||
|
||||
- :ref:`float<class_float>` **get_voice_depth_ms** **(** :ref:`int<class_int>` voice_idx **)** const
|
||||
- :ref:`float<class_float>` **get_voice_depth_ms** **(** :ref:`int<class_int>` voice_idx **)** const
|
||||
|
||||
Returns the voice's set filter depth.
|
||||
|
||||
.. _class_AudioEffectChorus_get_voice_level_db:
|
||||
|
||||
- :ref:`float<class_float>` **get_voice_level_db** **(** :ref:`int<class_int>` voice_idx **)** const
|
||||
- :ref:`float<class_float>` **get_voice_level_db** **(** :ref:`int<class_int>` voice_idx **)** const
|
||||
|
||||
Returns the voice's set maximum volume.
|
||||
|
||||
.. _class_AudioEffectChorus_get_voice_pan:
|
||||
|
||||
- :ref:`float<class_float>` **get_voice_pan** **(** :ref:`int<class_int>` voice_idx **)** const
|
||||
- :ref:`float<class_float>` **get_voice_pan** **(** :ref:`int<class_int>` voice_idx **)** const
|
||||
|
||||
Returns the voice's set pan.
|
||||
|
||||
.. _class_AudioEffectChorus_get_voice_rate_hz:
|
||||
|
||||
- :ref:`float<class_float>` **get_voice_rate_hz** **(** :ref:`int<class_int>` voice_idx **)** const
|
||||
- :ref:`float<class_float>` **get_voice_rate_hz** **(** :ref:`int<class_int>` voice_idx **)** const
|
||||
|
||||
Returns the voice filter's set rate in cycles.
|
||||
|
||||
.. _class_AudioEffectChorus_get_wet:
|
||||
|
||||
- :ref:`float<class_float>` **get_wet** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_wet** **(** **)** const
|
||||
|
||||
Returns the set applied wetness of the effect.
|
||||
|
||||
.. _class_AudioEffectChorus_set_dry:
|
||||
|
||||
- void **set_dry** **(** :ref:`float<class_float>` amount **)**
|
||||
- void **set_dry** **(** :ref:`float<class_float>` amount **)**
|
||||
|
||||
Returns the set applied dryness of the effect.
|
||||
|
||||
.. _class_AudioEffectChorus_set_voice_count:
|
||||
|
||||
- void **set_voice_count** **(** :ref:`int<class_int>` voices **)**
|
||||
- void **set_voice_count** **(** :ref:`int<class_int>` voices **)**
|
||||
|
||||
Set the number of voices in the effect's filter.
|
||||
|
||||
.. _class_AudioEffectChorus_set_voice_cutoff_hz:
|
||||
|
||||
- void **set_voice_cutoff_hz** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` cutoff_hz **)**
|
||||
- void **set_voice_cutoff_hz** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` cutoff_hz **)**
|
||||
|
||||
Set the cutoff frequency of the voice. The maximum frequency the voice may affect.
|
||||
|
||||
.. _class_AudioEffectChorus_set_voice_delay_ms:
|
||||
|
||||
- void **set_voice_delay_ms** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` delay_ms **)**
|
||||
- void **set_voice_delay_ms** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` delay_ms **)**
|
||||
|
||||
Set the delay of the voice's signal.
|
||||
|
||||
.. _class_AudioEffectChorus_set_voice_depth_ms:
|
||||
|
||||
- void **set_voice_depth_ms** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` depth_ms **)**
|
||||
- void **set_voice_depth_ms** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` depth_ms **)**
|
||||
|
||||
Set the filter depth of the voice's signal.
|
||||
|
||||
.. _class_AudioEffectChorus_set_voice_level_db:
|
||||
|
||||
- void **set_voice_level_db** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` level_db **)**
|
||||
- void **set_voice_level_db** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` level_db **)**
|
||||
|
||||
Set the volume level of the voice.
|
||||
|
||||
.. _class_AudioEffectChorus_set_voice_pan:
|
||||
|
||||
- void **set_voice_pan** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` pan **)**
|
||||
- void **set_voice_pan** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` pan **)**
|
||||
|
||||
Set the pan level of the voice.
|
||||
|
||||
.. _class_AudioEffectChorus_set_voice_rate_hz:
|
||||
|
||||
- void **set_voice_rate_hz** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` rate_hz **)**
|
||||
- void **set_voice_rate_hz** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` rate_hz **)**
|
||||
|
||||
Set the voice filter's rate.
|
||||
|
||||
.. _class_AudioEffectChorus_set_wet:
|
||||
|
||||
- void **set_wet** **(** :ref:`float<class_float>` amount **)**
|
||||
- void **set_wet** **(** :ref:`float<class_float>` amount **)**
|
||||
|
||||
Set the amount of effect.
|
||||
|
||||
|
||||
@@ -21,35 +21,35 @@ Reduces sounds that exceed a certain threshold level, smooths out the dynamics a
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_attack_us<class_AudioEffectCompressor_get_attack_us>` **(** **)** const |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_gain<class_AudioEffectCompressor_get_gain>` **(** **)** const |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_mix<class_AudioEffectCompressor_get_mix>` **(** **)** const |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_ratio<class_AudioEffectCompressor_get_ratio>` **(** **)** const |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_release_ms<class_AudioEffectCompressor_get_release_ms>` **(** **)** const |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_sidechain<class_AudioEffectCompressor_get_sidechain>` **(** **)** const |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_threshold<class_AudioEffectCompressor_get_threshold>` **(** **)** const |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_attack_us<class_AudioEffectCompressor_set_attack_us>` **(** :ref:`float<class_float>` attack_us **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_gain<class_AudioEffectCompressor_set_gain>` **(** :ref:`float<class_float>` gain **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_mix<class_AudioEffectCompressor_set_mix>` **(** :ref:`float<class_float>` mix **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_ratio<class_AudioEffectCompressor_set_ratio>` **(** :ref:`float<class_float>` ratio **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_release_ms<class_AudioEffectCompressor_set_release_ms>` **(** :ref:`float<class_float>` release_ms **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_sidechain<class_AudioEffectCompressor_set_sidechain>` **(** :ref:`String<class_string>` sidechain **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_threshold<class_AudioEffectCompressor_set_threshold>` **(** :ref:`float<class_float>` threshold **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_attack_us<class_AudioEffectCompressor_get_attack_us>` **(** **)** const |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_gain<class_AudioEffectCompressor_get_gain>` **(** **)** const |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_mix<class_AudioEffectCompressor_get_mix>` **(** **)** const |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_ratio<class_AudioEffectCompressor_get_ratio>` **(** **)** const |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_release_ms<class_AudioEffectCompressor_get_release_ms>` **(** **)** const |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_sidechain<class_AudioEffectCompressor_get_sidechain>` **(** **)** const |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_threshold<class_AudioEffectCompressor_get_threshold>` **(** **)** const |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_attack_us<class_AudioEffectCompressor_set_attack_us>` **(** :ref:`float<class_float>` attack_us **)** |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_gain<class_AudioEffectCompressor_set_gain>` **(** :ref:`float<class_float>` gain **)** |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_mix<class_AudioEffectCompressor_set_mix>` **(** :ref:`float<class_float>` mix **)** |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_ratio<class_AudioEffectCompressor_set_ratio>` **(** :ref:`float<class_float>` ratio **)** |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_release_ms<class_AudioEffectCompressor_set_release_ms>` **(** :ref:`float<class_float>` release_ms **)** |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_sidechain<class_AudioEffectCompressor_set_sidechain>` **(** :ref:`String<class_string>` sidechain **)** |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_threshold<class_AudioEffectCompressor_set_threshold>` **(** :ref:`float<class_float>` threshold **)** |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -103,58 +103,58 @@ Member Function Description
|
||||
|
||||
.. _class_AudioEffectCompressor_get_attack_us:
|
||||
|
||||
- :ref:`float<class_float>` **get_attack_us** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_attack_us** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectCompressor_get_gain:
|
||||
|
||||
- :ref:`float<class_float>` **get_gain** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_gain** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectCompressor_get_mix:
|
||||
|
||||
- :ref:`float<class_float>` **get_mix** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_mix** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectCompressor_get_ratio:
|
||||
|
||||
- :ref:`float<class_float>` **get_ratio** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_ratio** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectCompressor_get_release_ms:
|
||||
|
||||
- :ref:`float<class_float>` **get_release_ms** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_release_ms** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectCompressor_get_sidechain:
|
||||
|
||||
- :ref:`String<class_string>` **get_sidechain** **(** **)** const
|
||||
- :ref:`String<class_string>` **get_sidechain** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectCompressor_get_threshold:
|
||||
|
||||
- :ref:`float<class_float>` **get_threshold** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_threshold** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectCompressor_set_attack_us:
|
||||
|
||||
- void **set_attack_us** **(** :ref:`float<class_float>` attack_us **)**
|
||||
- void **set_attack_us** **(** :ref:`float<class_float>` attack_us **)**
|
||||
|
||||
.. _class_AudioEffectCompressor_set_gain:
|
||||
|
||||
- void **set_gain** **(** :ref:`float<class_float>` gain **)**
|
||||
- void **set_gain** **(** :ref:`float<class_float>` gain **)**
|
||||
|
||||
.. _class_AudioEffectCompressor_set_mix:
|
||||
|
||||
- void **set_mix** **(** :ref:`float<class_float>` mix **)**
|
||||
- void **set_mix** **(** :ref:`float<class_float>` mix **)**
|
||||
|
||||
.. _class_AudioEffectCompressor_set_ratio:
|
||||
|
||||
- void **set_ratio** **(** :ref:`float<class_float>` ratio **)**
|
||||
- void **set_ratio** **(** :ref:`float<class_float>` ratio **)**
|
||||
|
||||
.. _class_AudioEffectCompressor_set_release_ms:
|
||||
|
||||
- void **set_release_ms** **(** :ref:`float<class_float>` release_ms **)**
|
||||
- void **set_release_ms** **(** :ref:`float<class_float>` release_ms **)**
|
||||
|
||||
.. _class_AudioEffectCompressor_set_sidechain:
|
||||
|
||||
- void **set_sidechain** **(** :ref:`String<class_string>` sidechain **)**
|
||||
- void **set_sidechain** **(** :ref:`String<class_string>` sidechain **)**
|
||||
|
||||
.. _class_AudioEffectCompressor_set_threshold:
|
||||
|
||||
- void **set_threshold** **(** :ref:`float<class_float>` threshold **)**
|
||||
- void **set_threshold** **(** :ref:`float<class_float>` threshold **)**
|
||||
|
||||
|
||||
|
||||
@@ -21,59 +21,59 @@ Two tap delay and feedback options.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_dry<class_AudioEffectDelay_get_dry>` **(** **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_feedback_delay_ms<class_AudioEffectDelay_get_feedback_delay_ms>` **(** **)** const |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_feedback_level_db<class_AudioEffectDelay_get_feedback_level_db>` **(** **)** const |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_feedback_lowpass<class_AudioEffectDelay_get_feedback_lowpass>` **(** **)** const |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_tap1_delay_ms<class_AudioEffectDelay_get_tap1_delay_ms>` **(** **)** const |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_tap1_level_db<class_AudioEffectDelay_get_tap1_level_db>` **(** **)** const |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_tap1_pan<class_AudioEffectDelay_get_tap1_pan>` **(** **)** const |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_tap2_delay_ms<class_AudioEffectDelay_get_tap2_delay_ms>` **(** **)** const |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_tap2_level_db<class_AudioEffectDelay_get_tap2_level_db>` **(** **)** const |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_tap2_pan<class_AudioEffectDelay_get_tap2_pan>` **(** **)** const |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_feedback_active<class_AudioEffectDelay_is_feedback_active>` **(** **)** const |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_tap1_active<class_AudioEffectDelay_is_tap1_active>` **(** **)** const |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_tap2_active<class_AudioEffectDelay_is_tap2_active>` **(** **)** const |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_dry<class_AudioEffectDelay_set_dry>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_feedback_active<class_AudioEffectDelay_set_feedback_active>` **(** :ref:`bool<class_bool>` amount **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_feedback_delay_ms<class_AudioEffectDelay_set_feedback_delay_ms>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_feedback_level_db<class_AudioEffectDelay_set_feedback_level_db>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_feedback_lowpass<class_AudioEffectDelay_set_feedback_lowpass>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_tap1_active<class_AudioEffectDelay_set_tap1_active>` **(** :ref:`bool<class_bool>` amount **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_tap1_delay_ms<class_AudioEffectDelay_set_tap1_delay_ms>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_tap1_level_db<class_AudioEffectDelay_set_tap1_level_db>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_tap1_pan<class_AudioEffectDelay_set_tap1_pan>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_tap2_active<class_AudioEffectDelay_set_tap2_active>` **(** :ref:`bool<class_bool>` amount **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_tap2_delay_ms<class_AudioEffectDelay_set_tap2_delay_ms>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_tap2_level_db<class_AudioEffectDelay_set_tap2_level_db>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_tap2_pan<class_AudioEffectDelay_set_tap2_pan>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_dry<class_AudioEffectDelay_get_dry>` **(** **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_feedback_delay_ms<class_AudioEffectDelay_get_feedback_delay_ms>` **(** **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_feedback_level_db<class_AudioEffectDelay_get_feedback_level_db>` **(** **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_feedback_lowpass<class_AudioEffectDelay_get_feedback_lowpass>` **(** **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_tap1_delay_ms<class_AudioEffectDelay_get_tap1_delay_ms>` **(** **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_tap1_level_db<class_AudioEffectDelay_get_tap1_level_db>` **(** **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_tap1_pan<class_AudioEffectDelay_get_tap1_pan>` **(** **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_tap2_delay_ms<class_AudioEffectDelay_get_tap2_delay_ms>` **(** **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_tap2_level_db<class_AudioEffectDelay_get_tap2_level_db>` **(** **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_tap2_pan<class_AudioEffectDelay_get_tap2_pan>` **(** **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_feedback_active<class_AudioEffectDelay_is_feedback_active>` **(** **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_tap1_active<class_AudioEffectDelay_is_tap1_active>` **(** **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_tap2_active<class_AudioEffectDelay_is_tap2_active>` **(** **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_dry<class_AudioEffectDelay_set_dry>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_feedback_active<class_AudioEffectDelay_set_feedback_active>` **(** :ref:`bool<class_bool>` amount **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_feedback_delay_ms<class_AudioEffectDelay_set_feedback_delay_ms>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_feedback_level_db<class_AudioEffectDelay_set_feedback_level_db>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_feedback_lowpass<class_AudioEffectDelay_set_feedback_lowpass>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_tap1_active<class_AudioEffectDelay_set_tap1_active>` **(** :ref:`bool<class_bool>` amount **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_tap1_delay_ms<class_AudioEffectDelay_set_tap1_delay_ms>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_tap1_level_db<class_AudioEffectDelay_set_tap1_level_db>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_tap1_pan<class_AudioEffectDelay_set_tap1_pan>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_tap2_active<class_AudioEffectDelay_set_tap2_active>` **(** :ref:`bool<class_bool>` amount **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_tap2_delay_ms<class_AudioEffectDelay_set_tap2_delay_ms>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_tap2_level_db<class_AudioEffectDelay_set_tap2_level_db>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_tap2_pan<class_AudioEffectDelay_set_tap2_pan>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -141,106 +141,106 @@ Member Function Description
|
||||
|
||||
.. _class_AudioEffectDelay_get_dry:
|
||||
|
||||
- :ref:`float<class_float>` **get_dry** **(** **)**
|
||||
- :ref:`float<class_float>` **get_dry** **(** **)**
|
||||
|
||||
.. _class_AudioEffectDelay_get_feedback_delay_ms:
|
||||
|
||||
- :ref:`float<class_float>` **get_feedback_delay_ms** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_feedback_delay_ms** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectDelay_get_feedback_level_db:
|
||||
|
||||
- :ref:`float<class_float>` **get_feedback_level_db** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_feedback_level_db** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectDelay_get_feedback_lowpass:
|
||||
|
||||
- :ref:`float<class_float>` **get_feedback_lowpass** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_feedback_lowpass** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectDelay_get_tap1_delay_ms:
|
||||
|
||||
- :ref:`float<class_float>` **get_tap1_delay_ms** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_tap1_delay_ms** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectDelay_get_tap1_level_db:
|
||||
|
||||
- :ref:`float<class_float>` **get_tap1_level_db** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_tap1_level_db** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectDelay_get_tap1_pan:
|
||||
|
||||
- :ref:`float<class_float>` **get_tap1_pan** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_tap1_pan** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectDelay_get_tap2_delay_ms:
|
||||
|
||||
- :ref:`float<class_float>` **get_tap2_delay_ms** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_tap2_delay_ms** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectDelay_get_tap2_level_db:
|
||||
|
||||
- :ref:`float<class_float>` **get_tap2_level_db** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_tap2_level_db** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectDelay_get_tap2_pan:
|
||||
|
||||
- :ref:`float<class_float>` **get_tap2_pan** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_tap2_pan** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectDelay_is_feedback_active:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_feedback_active** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_feedback_active** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectDelay_is_tap1_active:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_tap1_active** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_tap1_active** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectDelay_is_tap2_active:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_tap2_active** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_tap2_active** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectDelay_set_dry:
|
||||
|
||||
- void **set_dry** **(** :ref:`float<class_float>` amount **)**
|
||||
- void **set_dry** **(** :ref:`float<class_float>` amount **)**
|
||||
|
||||
.. _class_AudioEffectDelay_set_feedback_active:
|
||||
|
||||
- void **set_feedback_active** **(** :ref:`bool<class_bool>` amount **)**
|
||||
- void **set_feedback_active** **(** :ref:`bool<class_bool>` amount **)**
|
||||
|
||||
.. _class_AudioEffectDelay_set_feedback_delay_ms:
|
||||
|
||||
- void **set_feedback_delay_ms** **(** :ref:`float<class_float>` amount **)**
|
||||
- void **set_feedback_delay_ms** **(** :ref:`float<class_float>` amount **)**
|
||||
|
||||
.. _class_AudioEffectDelay_set_feedback_level_db:
|
||||
|
||||
- void **set_feedback_level_db** **(** :ref:`float<class_float>` amount **)**
|
||||
- void **set_feedback_level_db** **(** :ref:`float<class_float>` amount **)**
|
||||
|
||||
.. _class_AudioEffectDelay_set_feedback_lowpass:
|
||||
|
||||
- void **set_feedback_lowpass** **(** :ref:`float<class_float>` amount **)**
|
||||
- void **set_feedback_lowpass** **(** :ref:`float<class_float>` amount **)**
|
||||
|
||||
.. _class_AudioEffectDelay_set_tap1_active:
|
||||
|
||||
- void **set_tap1_active** **(** :ref:`bool<class_bool>` amount **)**
|
||||
- void **set_tap1_active** **(** :ref:`bool<class_bool>` amount **)**
|
||||
|
||||
.. _class_AudioEffectDelay_set_tap1_delay_ms:
|
||||
|
||||
- void **set_tap1_delay_ms** **(** :ref:`float<class_float>` amount **)**
|
||||
- void **set_tap1_delay_ms** **(** :ref:`float<class_float>` amount **)**
|
||||
|
||||
.. _class_AudioEffectDelay_set_tap1_level_db:
|
||||
|
||||
- void **set_tap1_level_db** **(** :ref:`float<class_float>` amount **)**
|
||||
- void **set_tap1_level_db** **(** :ref:`float<class_float>` amount **)**
|
||||
|
||||
.. _class_AudioEffectDelay_set_tap1_pan:
|
||||
|
||||
- void **set_tap1_pan** **(** :ref:`float<class_float>` amount **)**
|
||||
- void **set_tap1_pan** **(** :ref:`float<class_float>` amount **)**
|
||||
|
||||
.. _class_AudioEffectDelay_set_tap2_active:
|
||||
|
||||
- void **set_tap2_active** **(** :ref:`bool<class_bool>` amount **)**
|
||||
- void **set_tap2_active** **(** :ref:`bool<class_bool>` amount **)**
|
||||
|
||||
.. _class_AudioEffectDelay_set_tap2_delay_ms:
|
||||
|
||||
- void **set_tap2_delay_ms** **(** :ref:`float<class_float>` amount **)**
|
||||
- void **set_tap2_delay_ms** **(** :ref:`float<class_float>` amount **)**
|
||||
|
||||
.. _class_AudioEffectDelay_set_tap2_level_db:
|
||||
|
||||
- void **set_tap2_level_db** **(** :ref:`float<class_float>` amount **)**
|
||||
- void **set_tap2_level_db** **(** :ref:`float<class_float>` amount **)**
|
||||
|
||||
.. _class_AudioEffectDelay_set_tap2_pan:
|
||||
|
||||
- void **set_tap2_pan** **(** :ref:`float<class_float>` amount **)**
|
||||
- void **set_tap2_pan** **(** :ref:`float<class_float>` amount **)**
|
||||
|
||||
|
||||
|
||||
@@ -21,27 +21,27 @@ Modify the sound to make it dirty.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_drive<class_AudioEffectDistortion_get_drive>` **(** **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_keep_hf_hz<class_AudioEffectDistortion_get_keep_hf_hz>` **(** **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_mode<class_AudioEffectDistortion_get_mode>` **(** **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_post_gain<class_AudioEffectDistortion_get_post_gain>` **(** **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_pre_gain<class_AudioEffectDistortion_get_pre_gain>` **(** **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_drive<class_AudioEffectDistortion_set_drive>` **(** :ref:`float<class_float>` drive **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_keep_hf_hz<class_AudioEffectDistortion_set_keep_hf_hz>` **(** :ref:`float<class_float>` keep_hf_hz **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_mode<class_AudioEffectDistortion_set_mode>` **(** :ref:`int<class_int>` mode **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_post_gain<class_AudioEffectDistortion_set_post_gain>` **(** :ref:`float<class_float>` post_gain **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_pre_gain<class_AudioEffectDistortion_set_pre_gain>` **(** :ref:`float<class_float>` pre_gain **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_drive<class_AudioEffectDistortion_get_drive>` **(** **)** const |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_keep_hf_hz<class_AudioEffectDistortion_get_keep_hf_hz>` **(** **)** const |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_mode<class_AudioEffectDistortion_get_mode>` **(** **)** const |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_post_gain<class_AudioEffectDistortion_get_post_gain>` **(** **)** const |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_pre_gain<class_AudioEffectDistortion_get_pre_gain>` **(** **)** const |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_drive<class_AudioEffectDistortion_set_drive>` **(** :ref:`float<class_float>` drive **)** |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_keep_hf_hz<class_AudioEffectDistortion_set_keep_hf_hz>` **(** :ref:`float<class_float>` keep_hf_hz **)** |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_mode<class_AudioEffectDistortion_set_mode>` **(** :ref:`int<class_int>` mode **)** |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_post_gain<class_AudioEffectDistortion_set_post_gain>` **(** :ref:`float<class_float>` post_gain **)** |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_pre_gain<class_AudioEffectDistortion_set_pre_gain>` **(** :ref:`float<class_float>` pre_gain **)** |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -88,42 +88,42 @@ Member Function Description
|
||||
|
||||
.. _class_AudioEffectDistortion_get_drive:
|
||||
|
||||
- :ref:`float<class_float>` **get_drive** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_drive** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectDistortion_get_keep_hf_hz:
|
||||
|
||||
- :ref:`float<class_float>` **get_keep_hf_hz** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_keep_hf_hz** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectDistortion_get_mode:
|
||||
|
||||
- :ref:`int<class_int>` **get_mode** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_mode** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectDistortion_get_post_gain:
|
||||
|
||||
- :ref:`float<class_float>` **get_post_gain** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_post_gain** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectDistortion_get_pre_gain:
|
||||
|
||||
- :ref:`float<class_float>` **get_pre_gain** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_pre_gain** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectDistortion_set_drive:
|
||||
|
||||
- void **set_drive** **(** :ref:`float<class_float>` drive **)**
|
||||
- void **set_drive** **(** :ref:`float<class_float>` drive **)**
|
||||
|
||||
.. _class_AudioEffectDistortion_set_keep_hf_hz:
|
||||
|
||||
- void **set_keep_hf_hz** **(** :ref:`float<class_float>` keep_hf_hz **)**
|
||||
- void **set_keep_hf_hz** **(** :ref:`float<class_float>` keep_hf_hz **)**
|
||||
|
||||
.. _class_AudioEffectDistortion_set_mode:
|
||||
|
||||
- void **set_mode** **(** :ref:`int<class_int>` mode **)**
|
||||
- void **set_mode** **(** :ref:`int<class_int>` mode **)**
|
||||
|
||||
.. _class_AudioEffectDistortion_set_post_gain:
|
||||
|
||||
- void **set_post_gain** **(** :ref:`float<class_float>` post_gain **)**
|
||||
- void **set_post_gain** **(** :ref:`float<class_float>` post_gain **)**
|
||||
|
||||
.. _class_AudioEffectDistortion_set_pre_gain:
|
||||
|
||||
- void **set_pre_gain** **(** :ref:`float<class_float>` pre_gain **)**
|
||||
- void **set_pre_gain** **(** :ref:`float<class_float>` pre_gain **)**
|
||||
|
||||
|
||||
|
||||
@@ -23,13 +23,13 @@ Use it to create a custom equalizer if :ref:`AudioEffectEQ6<class_audioeffecteq6
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_band_count<class_AudioEffectEQ_get_band_count>` **(** **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_band_gain_db<class_AudioEffectEQ_get_band_gain_db>` **(** :ref:`int<class_int>` band_idx **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_band_gain_db<class_AudioEffectEQ_set_band_gain_db>` **(** :ref:`int<class_int>` band_idx, :ref:`float<class_float>` volume_db **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_band_count<class_AudioEffectEQ_get_band_count>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_band_gain_db<class_AudioEffectEQ_get_band_gain_db>` **(** :ref:`int<class_int>` band_idx **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_band_gain_db<class_AudioEffectEQ_set_band_gain_db>` **(** :ref:`int<class_int>` band_idx, :ref:`float<class_float>` volume_db **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -41,19 +41,19 @@ Member Function Description
|
||||
|
||||
.. _class_AudioEffectEQ_get_band_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_band_count** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_band_count** **(** **)** const
|
||||
|
||||
Returns the number of bands of the equalizer.
|
||||
|
||||
.. _class_AudioEffectEQ_get_band_gain_db:
|
||||
|
||||
- :ref:`float<class_float>` **get_band_gain_db** **(** :ref:`int<class_int>` band_idx **)** const
|
||||
- :ref:`float<class_float>` **get_band_gain_db** **(** :ref:`int<class_int>` band_idx **)** const
|
||||
|
||||
Returns the band's gain at the specified index, in dB.
|
||||
|
||||
.. _class_AudioEffectEQ_set_band_gain_db:
|
||||
|
||||
- void **set_band_gain_db** **(** :ref:`int<class_int>` band_idx, :ref:`float<class_float>` volume_db **)**
|
||||
- void **set_band_gain_db** **(** :ref:`int<class_int>` band_idx, :ref:`float<class_float>` volume_db **)**
|
||||
|
||||
Sets band's gain at the specified index, in dB.
|
||||
|
||||
|
||||
@@ -21,23 +21,23 @@ Brief Description
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_cutoff<class_AudioEffectFilter_get_cutoff>` **(** **)** const |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_db<class_AudioEffectFilter_get_db>` **(** **)** const |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_gain<class_AudioEffectFilter_get_gain>` **(** **)** const |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_resonance<class_AudioEffectFilter_get_resonance>` **(** **)** const |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_cutoff<class_AudioEffectFilter_set_cutoff>` **(** :ref:`float<class_float>` freq **)** |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_db<class_AudioEffectFilter_set_db>` **(** :ref:`int<class_int>` amount **)** |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_gain<class_AudioEffectFilter_set_gain>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_resonance<class_AudioEffectFilter_set_resonance>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_cutoff<class_AudioEffectFilter_get_cutoff>` **(** **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_db<class_AudioEffectFilter_get_db>` **(** **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_gain<class_AudioEffectFilter_get_gain>` **(** **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_resonance<class_AudioEffectFilter_get_resonance>` **(** **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_cutoff<class_AudioEffectFilter_set_cutoff>` **(** :ref:`float<class_float>` freq **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_db<class_AudioEffectFilter_set_db>` **(** :ref:`int<class_int>` amount **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_gain<class_AudioEffectFilter_set_gain>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_resonance<class_AudioEffectFilter_set_resonance>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -72,34 +72,34 @@ Member Function Description
|
||||
|
||||
.. _class_AudioEffectFilter_get_cutoff:
|
||||
|
||||
- :ref:`float<class_float>` **get_cutoff** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_cutoff** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectFilter_get_db:
|
||||
|
||||
- :ref:`int<class_int>` **get_db** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_db** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectFilter_get_gain:
|
||||
|
||||
- :ref:`float<class_float>` **get_gain** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_gain** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectFilter_get_resonance:
|
||||
|
||||
- :ref:`float<class_float>` **get_resonance** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_resonance** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectFilter_set_cutoff:
|
||||
|
||||
- void **set_cutoff** **(** :ref:`float<class_float>` freq **)**
|
||||
- void **set_cutoff** **(** :ref:`float<class_float>` freq **)**
|
||||
|
||||
.. _class_AudioEffectFilter_set_db:
|
||||
|
||||
- void **set_db** **(** :ref:`int<class_int>` amount **)**
|
||||
- void **set_db** **(** :ref:`int<class_int>` amount **)**
|
||||
|
||||
.. _class_AudioEffectFilter_set_gain:
|
||||
|
||||
- void **set_gain** **(** :ref:`float<class_float>` amount **)**
|
||||
- void **set_gain** **(** :ref:`float<class_float>` amount **)**
|
||||
|
||||
.. _class_AudioEffectFilter_set_resonance:
|
||||
|
||||
- void **set_resonance** **(** :ref:`float<class_float>` amount **)**
|
||||
- void **set_resonance** **(** :ref:`float<class_float>` amount **)**
|
||||
|
||||
|
||||
|
||||
@@ -19,23 +19,23 @@ Adds a soft clip Limiter audio effect to an Audio bus.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_ceiling_db<class_AudioEffectLimiter_get_ceiling_db>` **(** **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_soft_clip_db<class_AudioEffectLimiter_get_soft_clip_db>` **(** **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_soft_clip_ratio<class_AudioEffectLimiter_get_soft_clip_ratio>` **(** **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_threshold_db<class_AudioEffectLimiter_get_threshold_db>` **(** **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_ceiling_db<class_AudioEffectLimiter_set_ceiling_db>` **(** :ref:`float<class_float>` ceiling **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_soft_clip_db<class_AudioEffectLimiter_set_soft_clip_db>` **(** :ref:`float<class_float>` soft_clip **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_soft_clip_ratio<class_AudioEffectLimiter_set_soft_clip_ratio>` **(** :ref:`float<class_float>` soft_clip **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_threshold_db<class_AudioEffectLimiter_set_threshold_db>` **(** :ref:`float<class_float>` threshold **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_ceiling_db<class_AudioEffectLimiter_get_ceiling_db>` **(** **)** const |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_soft_clip_db<class_AudioEffectLimiter_get_soft_clip_db>` **(** **)** const |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_soft_clip_ratio<class_AudioEffectLimiter_get_soft_clip_ratio>` **(** **)** const |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_threshold_db<class_AudioEffectLimiter_get_threshold_db>` **(** **)** const |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_ceiling_db<class_AudioEffectLimiter_set_ceiling_db>` **(** :ref:`float<class_float>` ceiling **)** |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_soft_clip_db<class_AudioEffectLimiter_set_soft_clip_db>` **(** :ref:`float<class_float>` soft_clip **)** |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_soft_clip_ratio<class_AudioEffectLimiter_set_soft_clip_ratio>` **(** :ref:`float<class_float>` soft_clip **)** |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_threshold_db<class_AudioEffectLimiter_set_threshold_db>` **(** :ref:`float<class_float>` threshold **)** |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -69,34 +69,34 @@ Member Function Description
|
||||
|
||||
.. _class_AudioEffectLimiter_get_ceiling_db:
|
||||
|
||||
- :ref:`float<class_float>` **get_ceiling_db** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_ceiling_db** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectLimiter_get_soft_clip_db:
|
||||
|
||||
- :ref:`float<class_float>` **get_soft_clip_db** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_soft_clip_db** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectLimiter_get_soft_clip_ratio:
|
||||
|
||||
- :ref:`float<class_float>` **get_soft_clip_ratio** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_soft_clip_ratio** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectLimiter_get_threshold_db:
|
||||
|
||||
- :ref:`float<class_float>` **get_threshold_db** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_threshold_db** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectLimiter_set_ceiling_db:
|
||||
|
||||
- void **set_ceiling_db** **(** :ref:`float<class_float>` ceiling **)**
|
||||
- void **set_ceiling_db** **(** :ref:`float<class_float>` ceiling **)**
|
||||
|
||||
.. _class_AudioEffectLimiter_set_soft_clip_db:
|
||||
|
||||
- void **set_soft_clip_db** **(** :ref:`float<class_float>` soft_clip **)**
|
||||
- void **set_soft_clip_db** **(** :ref:`float<class_float>` soft_clip **)**
|
||||
|
||||
.. _class_AudioEffectLimiter_set_soft_clip_ratio:
|
||||
|
||||
- void **set_soft_clip_ratio** **(** :ref:`float<class_float>` soft_clip **)**
|
||||
- void **set_soft_clip_ratio** **(** :ref:`float<class_float>` soft_clip **)**
|
||||
|
||||
.. _class_AudioEffectLimiter_set_threshold_db:
|
||||
|
||||
- void **set_threshold_db** **(** :ref:`float<class_float>` threshold **)**
|
||||
- void **set_threshold_db** **(** :ref:`float<class_float>` threshold **)**
|
||||
|
||||
|
||||
|
||||
@@ -19,11 +19,11 @@ Adds a Panner audio effect to an Audio bus. Pans sound left or right.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_pan<class_AudioEffectPanner_get_pan>` **(** **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_pan<class_AudioEffectPanner_set_pan>` **(** :ref:`float<class_float>` cpanume **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------+
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_pan<class_AudioEffectPanner_get_pan>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_pan<class_AudioEffectPanner_set_pan>` **(** :ref:`float<class_float>` cpanume **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -43,10 +43,10 @@ Member Function Description
|
||||
|
||||
.. _class_AudioEffectPanner_get_pan:
|
||||
|
||||
- :ref:`float<class_float>` **get_pan** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_pan** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectPanner_set_pan:
|
||||
|
||||
- void **set_pan** **(** :ref:`float<class_float>` cpanume **)**
|
||||
- void **set_pan** **(** :ref:`float<class_float>` cpanume **)**
|
||||
|
||||
|
||||
|
||||
@@ -21,27 +21,27 @@ Combines the original signal with a copy that is slightly out of phase with the
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_depth<class_AudioEffectPhaser_get_depth>` **(** **)** const |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_feedback<class_AudioEffectPhaser_get_feedback>` **(** **)** const |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_range_max_hz<class_AudioEffectPhaser_get_range_max_hz>` **(** **)** const |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_range_min_hz<class_AudioEffectPhaser_get_range_min_hz>` **(** **)** const |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_rate_hz<class_AudioEffectPhaser_get_rate_hz>` **(** **)** const |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_depth<class_AudioEffectPhaser_set_depth>` **(** :ref:`float<class_float>` depth **)** |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_feedback<class_AudioEffectPhaser_set_feedback>` **(** :ref:`float<class_float>` fbk **)** |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_range_max_hz<class_AudioEffectPhaser_set_range_max_hz>` **(** :ref:`float<class_float>` hz **)** |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_range_min_hz<class_AudioEffectPhaser_set_range_min_hz>` **(** :ref:`float<class_float>` hz **)** |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_rate_hz<class_AudioEffectPhaser_set_rate_hz>` **(** :ref:`float<class_float>` hz **)** |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_depth<class_AudioEffectPhaser_get_depth>` **(** **)** const |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_feedback<class_AudioEffectPhaser_get_feedback>` **(** **)** const |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_range_max_hz<class_AudioEffectPhaser_get_range_max_hz>` **(** **)** const |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_range_min_hz<class_AudioEffectPhaser_get_range_min_hz>` **(** **)** const |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_rate_hz<class_AudioEffectPhaser_get_rate_hz>` **(** **)** const |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_depth<class_AudioEffectPhaser_set_depth>` **(** :ref:`float<class_float>` depth **)** |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_feedback<class_AudioEffectPhaser_set_feedback>` **(** :ref:`float<class_float>` fbk **)** |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_range_max_hz<class_AudioEffectPhaser_set_range_max_hz>` **(** :ref:`float<class_float>` hz **)** |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_range_min_hz<class_AudioEffectPhaser_set_range_min_hz>` **(** :ref:`float<class_float>` hz **)** |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_rate_hz<class_AudioEffectPhaser_set_rate_hz>` **(** :ref:`float<class_float>` hz **)** |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -77,42 +77,42 @@ Member Function Description
|
||||
|
||||
.. _class_AudioEffectPhaser_get_depth:
|
||||
|
||||
- :ref:`float<class_float>` **get_depth** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_depth** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectPhaser_get_feedback:
|
||||
|
||||
- :ref:`float<class_float>` **get_feedback** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_feedback** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectPhaser_get_range_max_hz:
|
||||
|
||||
- :ref:`float<class_float>` **get_range_max_hz** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_range_max_hz** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectPhaser_get_range_min_hz:
|
||||
|
||||
- :ref:`float<class_float>` **get_range_min_hz** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_range_min_hz** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectPhaser_get_rate_hz:
|
||||
|
||||
- :ref:`float<class_float>` **get_rate_hz** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_rate_hz** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectPhaser_set_depth:
|
||||
|
||||
- void **set_depth** **(** :ref:`float<class_float>` depth **)**
|
||||
- void **set_depth** **(** :ref:`float<class_float>` depth **)**
|
||||
|
||||
.. _class_AudioEffectPhaser_set_feedback:
|
||||
|
||||
- void **set_feedback** **(** :ref:`float<class_float>` fbk **)**
|
||||
- void **set_feedback** **(** :ref:`float<class_float>` fbk **)**
|
||||
|
||||
.. _class_AudioEffectPhaser_set_range_max_hz:
|
||||
|
||||
- void **set_range_max_hz** **(** :ref:`float<class_float>` hz **)**
|
||||
- void **set_range_max_hz** **(** :ref:`float<class_float>` hz **)**
|
||||
|
||||
.. _class_AudioEffectPhaser_set_range_min_hz:
|
||||
|
||||
- void **set_range_min_hz** **(** :ref:`float<class_float>` hz **)**
|
||||
- void **set_range_min_hz** **(** :ref:`float<class_float>` hz **)**
|
||||
|
||||
.. _class_AudioEffectPhaser_set_rate_hz:
|
||||
|
||||
- void **set_rate_hz** **(** :ref:`float<class_float>` hz **)**
|
||||
- void **set_rate_hz** **(** :ref:`float<class_float>` hz **)**
|
||||
|
||||
|
||||
|
||||
@@ -21,11 +21,11 @@ Raises or lowers the pitch of original sound.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_pitch_scale<class_AudioEffectPitchShift_get_pitch_scale>` **(** **)** const |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_pitch_scale<class_AudioEffectPitchShift_set_pitch_scale>` **(** :ref:`float<class_float>` rate **)** |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_pitch_scale<class_AudioEffectPitchShift_get_pitch_scale>` **(** **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_pitch_scale<class_AudioEffectPitchShift_set_pitch_scale>` **(** :ref:`float<class_float>` rate **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -45,10 +45,10 @@ Member Function Description
|
||||
|
||||
.. _class_AudioEffectPitchShift_get_pitch_scale:
|
||||
|
||||
- :ref:`float<class_float>` **get_pitch_scale** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_pitch_scale** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectPitchShift_set_pitch_scale:
|
||||
|
||||
- void **set_pitch_scale** **(** :ref:`float<class_float>` rate **)**
|
||||
- void **set_pitch_scale** **(** :ref:`float<class_float>` rate **)**
|
||||
|
||||
|
||||
|
||||
@@ -21,39 +21,39 @@ Simulates the sound of acoustic environments such as rooms, concert halls, caver
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_damping<class_AudioEffectReverb_get_damping>` **(** **)** const |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_dry<class_AudioEffectReverb_get_dry>` **(** **)** const |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_hpf<class_AudioEffectReverb_get_hpf>` **(** **)** const |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_predelay_feedback<class_AudioEffectReverb_get_predelay_feedback>` **(** **)** const |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_predelay_msec<class_AudioEffectReverb_get_predelay_msec>` **(** **)** const |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_room_size<class_AudioEffectReverb_get_room_size>` **(** **)** const |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_spread<class_AudioEffectReverb_get_spread>` **(** **)** const |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_wet<class_AudioEffectReverb_get_wet>` **(** **)** const |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_damping<class_AudioEffectReverb_set_damping>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_dry<class_AudioEffectReverb_set_dry>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_hpf<class_AudioEffectReverb_set_hpf>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_predelay_feedback<class_AudioEffectReverb_set_predelay_feedback>` **(** :ref:`float<class_float>` feedback **)** |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_predelay_msec<class_AudioEffectReverb_set_predelay_msec>` **(** :ref:`float<class_float>` msec **)** |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_room_size<class_AudioEffectReverb_set_room_size>` **(** :ref:`float<class_float>` size **)** |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_spread<class_AudioEffectReverb_set_spread>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_wet<class_AudioEffectReverb_set_wet>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_damping<class_AudioEffectReverb_get_damping>` **(** **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_dry<class_AudioEffectReverb_get_dry>` **(** **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_hpf<class_AudioEffectReverb_get_hpf>` **(** **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_predelay_feedback<class_AudioEffectReverb_get_predelay_feedback>` **(** **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_predelay_msec<class_AudioEffectReverb_get_predelay_msec>` **(** **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_room_size<class_AudioEffectReverb_get_room_size>` **(** **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_spread<class_AudioEffectReverb_get_spread>` **(** **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_wet<class_AudioEffectReverb_get_wet>` **(** **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_damping<class_AudioEffectReverb_set_damping>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_dry<class_AudioEffectReverb_set_dry>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_hpf<class_AudioEffectReverb_set_hpf>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_predelay_feedback<class_AudioEffectReverb_set_predelay_feedback>` **(** :ref:`float<class_float>` feedback **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_predelay_msec<class_AudioEffectReverb_set_predelay_msec>` **(** :ref:`float<class_float>` msec **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_room_size<class_AudioEffectReverb_set_room_size>` **(** :ref:`float<class_float>` size **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_spread<class_AudioEffectReverb_set_spread>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_wet<class_AudioEffectReverb_set_wet>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -101,66 +101,66 @@ Member Function Description
|
||||
|
||||
.. _class_AudioEffectReverb_get_damping:
|
||||
|
||||
- :ref:`float<class_float>` **get_damping** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_damping** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectReverb_get_dry:
|
||||
|
||||
- :ref:`float<class_float>` **get_dry** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_dry** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectReverb_get_hpf:
|
||||
|
||||
- :ref:`float<class_float>` **get_hpf** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_hpf** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectReverb_get_predelay_feedback:
|
||||
|
||||
- :ref:`float<class_float>` **get_predelay_feedback** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_predelay_feedback** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectReverb_get_predelay_msec:
|
||||
|
||||
- :ref:`float<class_float>` **get_predelay_msec** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_predelay_msec** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectReverb_get_room_size:
|
||||
|
||||
- :ref:`float<class_float>` **get_room_size** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_room_size** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectReverb_get_spread:
|
||||
|
||||
- :ref:`float<class_float>` **get_spread** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_spread** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectReverb_get_wet:
|
||||
|
||||
- :ref:`float<class_float>` **get_wet** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_wet** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectReverb_set_damping:
|
||||
|
||||
- void **set_damping** **(** :ref:`float<class_float>` amount **)**
|
||||
- void **set_damping** **(** :ref:`float<class_float>` amount **)**
|
||||
|
||||
.. _class_AudioEffectReverb_set_dry:
|
||||
|
||||
- void **set_dry** **(** :ref:`float<class_float>` amount **)**
|
||||
- void **set_dry** **(** :ref:`float<class_float>` amount **)**
|
||||
|
||||
.. _class_AudioEffectReverb_set_hpf:
|
||||
|
||||
- void **set_hpf** **(** :ref:`float<class_float>` amount **)**
|
||||
- void **set_hpf** **(** :ref:`float<class_float>` amount **)**
|
||||
|
||||
.. _class_AudioEffectReverb_set_predelay_feedback:
|
||||
|
||||
- void **set_predelay_feedback** **(** :ref:`float<class_float>` feedback **)**
|
||||
- void **set_predelay_feedback** **(** :ref:`float<class_float>` feedback **)**
|
||||
|
||||
.. _class_AudioEffectReverb_set_predelay_msec:
|
||||
|
||||
- void **set_predelay_msec** **(** :ref:`float<class_float>` msec **)**
|
||||
- void **set_predelay_msec** **(** :ref:`float<class_float>` msec **)**
|
||||
|
||||
.. _class_AudioEffectReverb_set_room_size:
|
||||
|
||||
- void **set_room_size** **(** :ref:`float<class_float>` size **)**
|
||||
- void **set_room_size** **(** :ref:`float<class_float>` size **)**
|
||||
|
||||
.. _class_AudioEffectReverb_set_spread:
|
||||
|
||||
- void **set_spread** **(** :ref:`float<class_float>` amount **)**
|
||||
- void **set_spread** **(** :ref:`float<class_float>` amount **)**
|
||||
|
||||
.. _class_AudioEffectReverb_set_wet:
|
||||
|
||||
- void **set_wet** **(** :ref:`float<class_float>` amount **)**
|
||||
- void **set_wet** **(** :ref:`float<class_float>` amount **)**
|
||||
|
||||
|
||||
|
||||
@@ -19,19 +19,19 @@ Brief Description
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_pan_pullout<class_AudioEffectStereoEnhance_get_pan_pullout>` **(** **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_surround<class_AudioEffectStereoEnhance_get_surround>` **(** **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_time_pullout<class_AudioEffectStereoEnhance_get_time_pullout>` **(** **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_pan_pullout<class_AudioEffectStereoEnhance_set_pan_pullout>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_surround<class_AudioEffectStereoEnhance_set_surround>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_time_pullout<class_AudioEffectStereoEnhance_set_time_pullout>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_pan_pullout<class_AudioEffectStereoEnhance_get_pan_pullout>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_surround<class_AudioEffectStereoEnhance_get_surround>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_time_pullout<class_AudioEffectStereoEnhance_get_time_pullout>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_pan_pullout<class_AudioEffectStereoEnhance_set_pan_pullout>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_surround<class_AudioEffectStereoEnhance_set_surround>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_time_pullout<class_AudioEffectStereoEnhance_set_time_pullout>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -54,26 +54,26 @@ Member Function Description
|
||||
|
||||
.. _class_AudioEffectStereoEnhance_get_pan_pullout:
|
||||
|
||||
- :ref:`float<class_float>` **get_pan_pullout** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_pan_pullout** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectStereoEnhance_get_surround:
|
||||
|
||||
- :ref:`float<class_float>` **get_surround** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_surround** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectStereoEnhance_get_time_pullout:
|
||||
|
||||
- :ref:`float<class_float>` **get_time_pullout** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_time_pullout** **(** **)** const
|
||||
|
||||
.. _class_AudioEffectStereoEnhance_set_pan_pullout:
|
||||
|
||||
- void **set_pan_pullout** **(** :ref:`float<class_float>` amount **)**
|
||||
- void **set_pan_pullout** **(** :ref:`float<class_float>` amount **)**
|
||||
|
||||
.. _class_AudioEffectStereoEnhance_set_surround:
|
||||
|
||||
- void **set_surround** **(** :ref:`float<class_float>` amount **)**
|
||||
- void **set_surround** **(** :ref:`float<class_float>` amount **)**
|
||||
|
||||
.. _class_AudioEffectStereoEnhance_set_time_pullout:
|
||||
|
||||
- void **set_time_pullout** **(** :ref:`float<class_float>` amount **)**
|
||||
- void **set_time_pullout** **(** :ref:`float<class_float>` amount **)**
|
||||
|
||||
|
||||
|
||||
@@ -19,80 +19,80 @@ Server interface for low level audio access.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_bus<class_AudioServer_add_bus>` **(** :ref:`int<class_int>` at_position=-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_position=-1 **)** |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AudioBusLayout<class_audiobuslayout>` | :ref:`generate_bus_layout<class_AudioServer_generate_bus_layout>` **(** **)** const |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_bus_count<class_AudioServer_get_bus_count>` **(** **)** const |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`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:`String<class_string>` | :ref:`get_bus_name<class_AudioServer_get_bus_name>` **(** :ref:`int<class_int>` bus_idx **)** const |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_bus_peak_volume_left_db<class_AudioServer_get_bus_peak_volume_left_db>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` channel **)** const |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_bus_peak_volume_right_db<class_AudioServer_get_bus_peak_volume_right_db>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` channel **)** const |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_bus_send<class_AudioServer_get_bus_send>` **(** :ref:`int<class_int>` bus_idx **)** const |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_bus_volume_db<class_AudioServer_get_bus_volume_db>` **(** :ref:`int<class_int>` bus_idx **)** const |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_mix_rate<class_AudioServer_get_mix_rate>` **(** **)** const |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_speaker_mode<class_AudioServer_get_speaker_mode>` **(** **)** const |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_bus_bypassing_effects<class_AudioServer_is_bus_bypassing_effects>` **(** :ref:`int<class_int>` bus_idx **)** const |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_bus_effect_enabled<class_AudioServer_is_bus_effect_enabled>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)** const |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_bus_mute<class_AudioServer_is_bus_mute>` **(** :ref:`int<class_int>` bus_idx **)** const |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_bus_solo<class_AudioServer_is_bus_solo>` **(** :ref:`int<class_int>` bus_idx **)** const |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`lock<class_AudioServer_lock>` **(** **)** |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`move_bus<class_AudioServer_move_bus>` **(** :ref:`int<class_int>` index, :ref:`int<class_int>` to_index **)** |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_bus<class_AudioServer_remove_bus>` **(** :ref:`int<class_int>` index **)** |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_bus_effect<class_AudioServer_remove_bus_effect>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)** |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bus_bypass_effects<class_AudioServer_set_bus_bypass_effects>` **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)** |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bus_count<class_AudioServer_set_bus_count>` **(** :ref:`int<class_int>` amount **)** |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bus_effect_enabled<class_AudioServer_set_bus_effect_enabled>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx, :ref:`bool<class_bool>` enabled **)** |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bus_layout<class_AudioServer_set_bus_layout>` **(** :ref:`AudioBusLayout<class_audiobuslayout>` bus_layout **)** |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bus_mute<class_AudioServer_set_bus_mute>` **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)** |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bus_name<class_AudioServer_set_bus_name>` **(** :ref:`int<class_int>` bus_idx, :ref:`String<class_string>` name **)** |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bus_send<class_AudioServer_set_bus_send>` **(** :ref:`int<class_int>` bus_idx, :ref:`String<class_string>` send **)** |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bus_solo<class_AudioServer_set_bus_solo>` **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)** |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bus_volume_db<class_AudioServer_set_bus_volume_db>` **(** :ref:`int<class_int>` bus_idx, :ref:`float<class_float>` volume_db **)** |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`swap_bus_effects<class_AudioServer_swap_bus_effects>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx, :ref:`int<class_int>` by_effect_idx **)** |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`unlock<class_AudioServer_unlock>` **(** **)** |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_bus<class_AudioServer_add_bus>` **(** :ref:`int<class_int>` at_position=-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_position=-1 **)** |
|
||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`AudioBusLayout<class_audiobuslayout>` | :ref:`generate_bus_layout<class_AudioServer_generate_bus_layout>` **(** **)** const |
|
||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_bus_count<class_AudioServer_get_bus_count>` **(** **)** const |
|
||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`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:`String<class_string>` | :ref:`get_bus_name<class_AudioServer_get_bus_name>` **(** :ref:`int<class_int>` bus_idx **)** const |
|
||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_bus_peak_volume_left_db<class_AudioServer_get_bus_peak_volume_left_db>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` channel **)** const |
|
||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_bus_peak_volume_right_db<class_AudioServer_get_bus_peak_volume_right_db>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` channel **)** const |
|
||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_bus_send<class_AudioServer_get_bus_send>` **(** :ref:`int<class_int>` bus_idx **)** const |
|
||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_bus_volume_db<class_AudioServer_get_bus_volume_db>` **(** :ref:`int<class_int>` bus_idx **)** const |
|
||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_mix_rate<class_AudioServer_get_mix_rate>` **(** **)** const |
|
||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_speaker_mode<class_AudioServer_get_speaker_mode>` **(** **)** const |
|
||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_bus_bypassing_effects<class_AudioServer_is_bus_bypassing_effects>` **(** :ref:`int<class_int>` bus_idx **)** const |
|
||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_bus_effect_enabled<class_AudioServer_is_bus_effect_enabled>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)** const |
|
||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_bus_mute<class_AudioServer_is_bus_mute>` **(** :ref:`int<class_int>` bus_idx **)** const |
|
||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_bus_solo<class_AudioServer_is_bus_solo>` **(** :ref:`int<class_int>` bus_idx **)** const |
|
||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`lock<class_AudioServer_lock>` **(** **)** |
|
||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`move_bus<class_AudioServer_move_bus>` **(** :ref:`int<class_int>` index, :ref:`int<class_int>` to_index **)** |
|
||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_bus<class_AudioServer_remove_bus>` **(** :ref:`int<class_int>` index **)** |
|
||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_bus_effect<class_AudioServer_remove_bus_effect>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)** |
|
||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bus_bypass_effects<class_AudioServer_set_bus_bypass_effects>` **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)** |
|
||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bus_count<class_AudioServer_set_bus_count>` **(** :ref:`int<class_int>` amount **)** |
|
||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bus_effect_enabled<class_AudioServer_set_bus_effect_enabled>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx, :ref:`bool<class_bool>` enabled **)** |
|
||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bus_layout<class_AudioServer_set_bus_layout>` **(** :ref:`AudioBusLayout<class_audiobuslayout>` bus_layout **)** |
|
||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bus_mute<class_AudioServer_set_bus_mute>` **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)** |
|
||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bus_name<class_AudioServer_set_bus_name>` **(** :ref:`int<class_int>` bus_idx, :ref:`String<class_string>` name **)** |
|
||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bus_send<class_AudioServer_set_bus_send>` **(** :ref:`int<class_int>` bus_idx, :ref:`String<class_string>` send **)** |
|
||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bus_solo<class_AudioServer_set_bus_solo>` **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)** |
|
||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bus_volume_db<class_AudioServer_set_bus_volume_db>` **(** :ref:`int<class_int>` bus_idx, :ref:`float<class_float>` volume_db **)** |
|
||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`swap_bus_effects<class_AudioServer_swap_bus_effects>` **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx, :ref:`int<class_int>` by_effect_idx **)** |
|
||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`unlock<class_AudioServer_unlock>` **(** **)** |
|
||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_AudioServer_bus_layout_changed:
|
||||
|
||||
- **bus_layout_changed** **(** **)**
|
||||
- **bus_layout_changed** **(** **)**
|
||||
|
||||
Emitted when the :ref:`AudioBusLayout<class_audiobuslayout>` changes.
|
||||
|
||||
@@ -114,199 +114,199 @@ Member Function Description
|
||||
|
||||
.. _class_AudioServer_add_bus:
|
||||
|
||||
- void **add_bus** **(** :ref:`int<class_int>` at_position=-1 **)**
|
||||
- void **add_bus** **(** :ref:`int<class_int>` at_position=-1 **)**
|
||||
|
||||
Adds a bus at ``at_position``.
|
||||
|
||||
.. _class_AudioServer_add_bus_effect:
|
||||
|
||||
- void **add_bus_effect** **(** :ref:`int<class_int>` bus_idx, :ref:`AudioEffect<class_audioeffect>` effect, :ref:`int<class_int>` at_position=-1 **)**
|
||||
- void **add_bus_effect** **(** :ref:`int<class_int>` bus_idx, :ref:`AudioEffect<class_audioeffect>` effect, :ref:`int<class_int>` at_position=-1 **)**
|
||||
|
||||
Adds an :ref:`AudioEffect<class_audioeffect>` effect to the bus ``bus_idx`` at ``at_position``.
|
||||
|
||||
.. _class_AudioServer_generate_bus_layout:
|
||||
|
||||
- :ref:`AudioBusLayout<class_audiobuslayout>` **generate_bus_layout** **(** **)** const
|
||||
- :ref:`AudioBusLayout<class_audiobuslayout>` **generate_bus_layout** **(** **)** const
|
||||
|
||||
Generates an :ref:`AudioBusLayout<class_audiobuslayout>` using the available busses and effects.
|
||||
|
||||
.. _class_AudioServer_get_bus_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_bus_count** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_bus_count** **(** **)** const
|
||||
|
||||
Returns the number of available busses.
|
||||
|
||||
.. _class_AudioServer_get_bus_effect:
|
||||
|
||||
- :ref:`AudioEffect<class_audioeffect>` **get_bus_effect** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)**
|
||||
- :ref:`AudioEffect<class_audioeffect>` **get_bus_effect** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)**
|
||||
|
||||
Returns the :ref:`AudioEffect<class_audioeffect>` at position ``effect_idx`` in bus ``bus_idx``.
|
||||
|
||||
.. _class_AudioServer_get_bus_effect_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_bus_effect_count** **(** :ref:`int<class_int>` bus_idx **)**
|
||||
- :ref:`int<class_int>` **get_bus_effect_count** **(** :ref:`int<class_int>` bus_idx **)**
|
||||
|
||||
Returns the number of effects on the bus at ``bus_idx``.
|
||||
|
||||
.. _class_AudioServer_get_bus_index:
|
||||
|
||||
- :ref:`int<class_int>` **get_bus_index** **(** :ref:`String<class_string>` bus_name **)** const
|
||||
- :ref:`int<class_int>` **get_bus_index** **(** :ref:`String<class_string>` bus_name **)** const
|
||||
|
||||
Returns the index of the bus with the name ``bus_name``.
|
||||
|
||||
.. _class_AudioServer_get_bus_name:
|
||||
|
||||
- :ref:`String<class_string>` **get_bus_name** **(** :ref:`int<class_int>` bus_idx **)** const
|
||||
- :ref:`String<class_string>` **get_bus_name** **(** :ref:`int<class_int>` bus_idx **)** const
|
||||
|
||||
Returns the name of the bus with the index ``bus_idx``.
|
||||
|
||||
.. _class_AudioServer_get_bus_peak_volume_left_db:
|
||||
|
||||
- :ref:`float<class_float>` **get_bus_peak_volume_left_db** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` channel **)** const
|
||||
- :ref:`float<class_float>` **get_bus_peak_volume_left_db** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` channel **)** const
|
||||
|
||||
Returns the peak volume of the left speaker at bus index ``bus_idx`` and channel index ``channel``.
|
||||
|
||||
.. _class_AudioServer_get_bus_peak_volume_right_db:
|
||||
|
||||
- :ref:`float<class_float>` **get_bus_peak_volume_right_db** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` channel **)** const
|
||||
- :ref:`float<class_float>` **get_bus_peak_volume_right_db** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` channel **)** const
|
||||
|
||||
Returns the peak volume of the right speaker at bus index ``bus_idx`` and channel index ``channel``.
|
||||
|
||||
.. _class_AudioServer_get_bus_send:
|
||||
|
||||
- :ref:`String<class_string>` **get_bus_send** **(** :ref:`int<class_int>` bus_idx **)** const
|
||||
- :ref:`String<class_string>` **get_bus_send** **(** :ref:`int<class_int>` bus_idx **)** const
|
||||
|
||||
Returns the name of the bus that the bus at index ``bus_idx`` sends to.
|
||||
|
||||
.. _class_AudioServer_get_bus_volume_db:
|
||||
|
||||
- :ref:`float<class_float>` **get_bus_volume_db** **(** :ref:`int<class_int>` bus_idx **)** const
|
||||
- :ref:`float<class_float>` **get_bus_volume_db** **(** :ref:`int<class_int>` bus_idx **)** const
|
||||
|
||||
Returns the volume of the bus at index ``bus_idx`` in dB.
|
||||
|
||||
.. _class_AudioServer_get_mix_rate:
|
||||
|
||||
- :ref:`float<class_float>` **get_mix_rate** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_mix_rate** **(** **)** const
|
||||
|
||||
Returns the sample rate at the output of the audioserver.
|
||||
|
||||
.. _class_AudioServer_get_speaker_mode:
|
||||
|
||||
- :ref:`int<class_int>` **get_speaker_mode** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_speaker_mode** **(** **)** const
|
||||
|
||||
Returns the speaker configuration.
|
||||
|
||||
.. _class_AudioServer_is_bus_bypassing_effects:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_bus_bypassing_effects** **(** :ref:`int<class_int>` bus_idx **)** const
|
||||
- :ref:`bool<class_bool>` **is_bus_bypassing_effects** **(** :ref:`int<class_int>` bus_idx **)** const
|
||||
|
||||
If ``true`` the bus at index ``bus_idx`` is bypassing effects.
|
||||
|
||||
.. _class_AudioServer_is_bus_effect_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_bus_effect_enabled** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)** const
|
||||
- :ref:`bool<class_bool>` **is_bus_effect_enabled** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)** const
|
||||
|
||||
If ``true`` the effect at index ``effect_idx`` on the bus at index ``bus_idx`` is enabled.
|
||||
|
||||
.. _class_AudioServer_is_bus_mute:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_bus_mute** **(** :ref:`int<class_int>` bus_idx **)** const
|
||||
- :ref:`bool<class_bool>` **is_bus_mute** **(** :ref:`int<class_int>` bus_idx **)** const
|
||||
|
||||
If ``true`` the bus at index ``bus_idx`` is muted.
|
||||
|
||||
.. _class_AudioServer_is_bus_solo:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_bus_solo** **(** :ref:`int<class_int>` bus_idx **)** const
|
||||
- :ref:`bool<class_bool>` **is_bus_solo** **(** :ref:`int<class_int>` bus_idx **)** const
|
||||
|
||||
If ``true`` the bus at index ``bus_idx`` is in solo mode.
|
||||
|
||||
.. _class_AudioServer_lock:
|
||||
|
||||
- void **lock** **(** **)**
|
||||
- void **lock** **(** **)**
|
||||
|
||||
Locks the audio drivers mainloop. Remember to unlock it afterwards.
|
||||
|
||||
.. _class_AudioServer_move_bus:
|
||||
|
||||
- void **move_bus** **(** :ref:`int<class_int>` index, :ref:`int<class_int>` to_index **)**
|
||||
- void **move_bus** **(** :ref:`int<class_int>` index, :ref:`int<class_int>` to_index **)**
|
||||
|
||||
Moves the bus from index ``index`` to index ``to_index``.
|
||||
|
||||
.. _class_AudioServer_remove_bus:
|
||||
|
||||
- void **remove_bus** **(** :ref:`int<class_int>` index **)**
|
||||
- void **remove_bus** **(** :ref:`int<class_int>` index **)**
|
||||
|
||||
Removes the bus at index ``index``.
|
||||
|
||||
.. _class_AudioServer_remove_bus_effect:
|
||||
|
||||
- void **remove_bus_effect** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)**
|
||||
- void **remove_bus_effect** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx **)**
|
||||
|
||||
Removes the effect at index ``effect_idx`` from the bus at index ``bus_idx``.
|
||||
|
||||
.. _class_AudioServer_set_bus_bypass_effects:
|
||||
|
||||
- void **set_bus_bypass_effects** **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)**
|
||||
- void **set_bus_bypass_effects** **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
If ``true`` the bus at index ``bus_idx`` is bypassing effects.
|
||||
|
||||
.. _class_AudioServer_set_bus_count:
|
||||
|
||||
- void **set_bus_count** **(** :ref:`int<class_int>` amount **)**
|
||||
- void **set_bus_count** **(** :ref:`int<class_int>` amount **)**
|
||||
|
||||
Adds and removes busses to make the number of busses match ``amount``.
|
||||
|
||||
.. _class_AudioServer_set_bus_effect_enabled:
|
||||
|
||||
- void **set_bus_effect_enabled** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx, :ref:`bool<class_bool>` enabled **)**
|
||||
- void **set_bus_effect_enabled** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx, :ref:`bool<class_bool>` enabled **)**
|
||||
|
||||
If ``true`` the effect at index ``effect_idx`` on the bus at index ``bus_idx`` is enabled.
|
||||
|
||||
.. _class_AudioServer_set_bus_layout:
|
||||
|
||||
- void **set_bus_layout** **(** :ref:`AudioBusLayout<class_audiobuslayout>` bus_layout **)**
|
||||
- void **set_bus_layout** **(** :ref:`AudioBusLayout<class_audiobuslayout>` bus_layout **)**
|
||||
|
||||
Overwrites the currently used :ref:`AudioBusLayout<class_audiobuslayout>`.
|
||||
|
||||
.. _class_AudioServer_set_bus_mute:
|
||||
|
||||
- void **set_bus_mute** **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)**
|
||||
- void **set_bus_mute** **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
If ``true`` the bus at index ``bus_idx`` is muted.
|
||||
|
||||
.. _class_AudioServer_set_bus_name:
|
||||
|
||||
- void **set_bus_name** **(** :ref:`int<class_int>` bus_idx, :ref:`String<class_string>` name **)**
|
||||
- void **set_bus_name** **(** :ref:`int<class_int>` bus_idx, :ref:`String<class_string>` name **)**
|
||||
|
||||
Sets the name of the bus at index ``bus_idx`` to ``name``.
|
||||
|
||||
.. _class_AudioServer_set_bus_send:
|
||||
|
||||
- void **set_bus_send** **(** :ref:`int<class_int>` bus_idx, :ref:`String<class_string>` send **)**
|
||||
- void **set_bus_send** **(** :ref:`int<class_int>` bus_idx, :ref:`String<class_string>` send **)**
|
||||
|
||||
Connects the output of the bus at ``bus_idx`` to the bus named ``send[/send].
|
||||
|
||||
.. _class_AudioServer_set_bus_solo:
|
||||
|
||||
- void **set_bus_solo** **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)**
|
||||
- void **set_bus_solo** **(** :ref:`int<class_int>` bus_idx, :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
If ``true`` the bus at index ``bus_idx`` is in solo mode.
|
||||
|
||||
.. _class_AudioServer_set_bus_volume_db:
|
||||
|
||||
- void **set_bus_volume_db** **(** :ref:`int<class_int>` bus_idx, :ref:`float<class_float>` volume_db **)**
|
||||
- void **set_bus_volume_db** **(** :ref:`int<class_int>` bus_idx, :ref:`float<class_float>` volume_db **)**
|
||||
|
||||
Sets the volume of the bus at index ``bus_idx`` to ``volume_db``.
|
||||
|
||||
.. _class_AudioServer_swap_bus_effects:
|
||||
|
||||
- void **swap_bus_effects** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx, :ref:`int<class_int>` by_effect_idx **)**
|
||||
- void **swap_bus_effects** **(** :ref:`int<class_int>` bus_idx, :ref:`int<class_int>` effect_idx, :ref:`int<class_int>` by_effect_idx **)**
|
||||
|
||||
Swaps the position of two effects in bus ``bus_idx``.
|
||||
|
||||
.. _class_AudioServer_unlock:
|
||||
|
||||
- void **unlock** **(** **)**
|
||||
- void **unlock** **(** **)**
|
||||
|
||||
Unlocks the audiodriver's main loop. After locking it always unlock it.
|
||||
|
||||
|
||||
@@ -19,19 +19,19 @@ OGG Vorbis audio stream driver.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolByteArray<class_poolbytearray>` | :ref:`get_data<class_AudioStreamOGGVorbis_get_data>` **(** **)** const |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_loop_offset<class_AudioStreamOGGVorbis_get_loop_offset>` **(** **)** const |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_loop<class_AudioStreamOGGVorbis_has_loop>` **(** **)** const |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| 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 **)** |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolByteArray<class_poolbytearray>` | :ref:`get_data<class_AudioStreamOGGVorbis_get_data>` **(** **)** const |
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_loop_offset<class_AudioStreamOGGVorbis_get_loop_offset>` **(** **)** const |
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_loop<class_AudioStreamOGGVorbis_has_loop>` **(** **)** const |
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
| 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
|
||||
----------------
|
||||
@@ -59,26 +59,26 @@ Member Function Description
|
||||
|
||||
.. _class_AudioStreamOGGVorbis_get_data:
|
||||
|
||||
- :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
|
||||
- :ref:`float<class_float>` **get_loop_offset** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamOGGVorbis_has_loop:
|
||||
|
||||
- :ref:`bool<class_bool>` **has_loop** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **has_loop** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamOGGVorbis_set_data:
|
||||
|
||||
- void **set_data** **(** :ref:`PoolByteArray<class_poolbytearray>` data **)**
|
||||
- void **set_data** **(** :ref:`PoolByteArray<class_poolbytearray>` data **)**
|
||||
|
||||
.. _class_AudioStreamOGGVorbis_set_loop:
|
||||
|
||||
- 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 **)**
|
||||
- void **set_loop_offset** **(** :ref:`float<class_float>` seconds **)**
|
||||
|
||||
|
||||
|
||||
@@ -19,44 +19,44 @@ Plays back audio.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`float<class_float>` | :ref:`get_playback_position<class_AudioStreamPlayer_get_playback_position>` **(** **)** |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`bool<class_bool>` | :ref:`is_autoplay_enabled<class_AudioStreamPlayer_is_autoplay_enabled>` **(** **)** |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AudioStreamPlayer_is_playing>` **(** **)** const |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`play<class_AudioStreamPlayer_play>` **(** :ref:`float<class_float>` from_position=0.0 **)** |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`seek<class_AudioStreamPlayer_seek>` **(** :ref:`float<class_float>` to_position **)** |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
| 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_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_volume_db<class_AudioStreamPlayer_set_volume_db>` **(** :ref:`float<class_float>` volume_db **)** |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`stop<class_AudioStreamPlayer_stop>` **(** **)** |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`float<class_float>` | :ref:`get_playback_position<class_AudioStreamPlayer_get_playback_position>` **(** **)** |
|
||||
+----------------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`bool<class_bool>` | :ref:`is_autoplay_enabled<class_AudioStreamPlayer_is_autoplay_enabled>` **(** **)** |
|
||||
+----------------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AudioStreamPlayer_is_playing>` **(** **)** const |
|
||||
+----------------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`play<class_AudioStreamPlayer_play>` **(** :ref:`float<class_float>` from_position=0.0 **)** |
|
||||
+----------------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`seek<class_AudioStreamPlayer_seek>` **(** :ref:`float<class_float>` to_position **)** |
|
||||
+----------------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| 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_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_volume_db<class_AudioStreamPlayer_set_volume_db>` **(** :ref:`float<class_float>` volume_db **)** |
|
||||
+----------------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`stop<class_AudioStreamPlayer_stop>` **(** **)** |
|
||||
+----------------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_AudioStreamPlayer_finished:
|
||||
|
||||
- **finished** **(** **)**
|
||||
- **finished** **(** **)**
|
||||
|
||||
Emitted when the audio stops playing.
|
||||
|
||||
@@ -106,69 +106,69 @@ Member Function Description
|
||||
|
||||
.. _class_AudioStreamPlayer_get_bus:
|
||||
|
||||
- :ref:`String<class_string>` **get_bus** **(** **)** const
|
||||
- :ref:`String<class_string>` **get_bus** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamPlayer_get_mix_target:
|
||||
|
||||
- :ref:`int<class_int>` **get_mix_target** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_mix_target** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamPlayer_get_playback_position:
|
||||
|
||||
- :ref:`float<class_float>` **get_playback_position** **(** **)**
|
||||
- :ref:`float<class_float>` **get_playback_position** **(** **)**
|
||||
|
||||
Returns the position in the :ref:`AudioStream<class_audiostream>`.
|
||||
|
||||
.. _class_AudioStreamPlayer_get_stream:
|
||||
|
||||
- :ref:`AudioStream<class_audiostream>` **get_stream** **(** **)** const
|
||||
- :ref:`AudioStream<class_audiostream>` **get_stream** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamPlayer_get_volume_db:
|
||||
|
||||
- :ref:`float<class_float>` **get_volume_db** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_volume_db** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamPlayer_is_autoplay_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_autoplay_enabled** **(** **)**
|
||||
- :ref:`bool<class_bool>` **is_autoplay_enabled** **(** **)**
|
||||
|
||||
.. _class_AudioStreamPlayer_is_playing:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_playing** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_playing** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamPlayer_play:
|
||||
|
||||
- void **play** **(** :ref:`float<class_float>` from_position=0.0 **)**
|
||||
- void **play** **(** :ref:`float<class_float>` from_position=0.0 **)**
|
||||
|
||||
Plays the audio from the given position 'from_position', in seconds.
|
||||
|
||||
.. _class_AudioStreamPlayer_seek:
|
||||
|
||||
- void **seek** **(** :ref:`float<class_float>` to_position **)**
|
||||
- void **seek** **(** :ref:`float<class_float>` to_position **)**
|
||||
|
||||
Sets the position from which audio will be played, in seconds.
|
||||
|
||||
.. _class_AudioStreamPlayer_set_autoplay:
|
||||
|
||||
- void **set_autoplay** **(** :ref:`bool<class_bool>` enable **)**
|
||||
- void **set_autoplay** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
.. _class_AudioStreamPlayer_set_bus:
|
||||
|
||||
- void **set_bus** **(** :ref:`String<class_string>` bus **)**
|
||||
- void **set_bus** **(** :ref:`String<class_string>` bus **)**
|
||||
|
||||
.. _class_AudioStreamPlayer_set_mix_target:
|
||||
|
||||
- void **set_mix_target** **(** :ref:`int<class_int>` mix_target **)**
|
||||
- void **set_mix_target** **(** :ref:`int<class_int>` mix_target **)**
|
||||
|
||||
.. _class_AudioStreamPlayer_set_stream:
|
||||
|
||||
- void **set_stream** **(** :ref:`AudioStream<class_audiostream>` stream **)**
|
||||
- void **set_stream** **(** :ref:`AudioStream<class_audiostream>` stream **)**
|
||||
|
||||
.. _class_AudioStreamPlayer_set_volume_db:
|
||||
|
||||
- void **set_volume_db** **(** :ref:`float<class_float>` volume_db **)**
|
||||
- void **set_volume_db** **(** :ref:`float<class_float>` volume_db **)**
|
||||
|
||||
.. _class_AudioStreamPlayer_stop:
|
||||
|
||||
- void **stop** **(** **)**
|
||||
- void **stop** **(** **)**
|
||||
|
||||
Stops the audio.
|
||||
|
||||
|
||||
@@ -19,52 +19,52 @@ Plays audio in 2D.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`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_playback_position<class_AudioStreamPlayer2D_get_playback_position>` **(** **)** |
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`bool<class_bool>` | :ref:`is_autoplay_enabled<class_AudioStreamPlayer2D_is_autoplay_enabled>` **(** **)** |
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AudioStreamPlayer2D_is_playing>` **(** **)** const |
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`play<class_AudioStreamPlayer2D_play>` **(** :ref:`float<class_float>` from_position=0.0 **)** |
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`seek<class_AudioStreamPlayer2D_seek>` **(** :ref:`float<class_float>` to_position **)** |
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| 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_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_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_volume_db<class_AudioStreamPlayer2D_set_volume_db>` **(** :ref:`float<class_float>` volume_db **)** |
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`stop<class_AudioStreamPlayer2D_stop>` **(** **)** |
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`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_playback_position<class_AudioStreamPlayer2D_get_playback_position>` **(** **)** |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`bool<class_bool>` | :ref:`is_autoplay_enabled<class_AudioStreamPlayer2D_is_autoplay_enabled>` **(** **)** |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AudioStreamPlayer2D_is_playing>` **(** **)** const |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`play<class_AudioStreamPlayer2D_play>` **(** :ref:`float<class_float>` from_position=0.0 **)** |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`seek<class_AudioStreamPlayer2D_seek>` **(** :ref:`float<class_float>` to_position **)** |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
| 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_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_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_volume_db<class_AudioStreamPlayer2D_set_volume_db>` **(** :ref:`float<class_float>` volume_db **)** |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`stop<class_AudioStreamPlayer2D_stop>` **(** **)** |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_AudioStreamPlayer2D_finished:
|
||||
|
||||
- **finished** **(** **)**
|
||||
- **finished** **(** **)**
|
||||
|
||||
Emitted when the audio stops playing.
|
||||
|
||||
@@ -115,85 +115,85 @@ Member Function Description
|
||||
|
||||
.. _class_AudioStreamPlayer2D_get_area_mask:
|
||||
|
||||
- :ref:`int<class_int>` **get_area_mask** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_area_mask** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamPlayer2D_get_attenuation:
|
||||
|
||||
- :ref:`float<class_float>` **get_attenuation** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_attenuation** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamPlayer2D_get_bus:
|
||||
|
||||
- :ref:`String<class_string>` **get_bus** **(** **)** const
|
||||
- :ref:`String<class_string>` **get_bus** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamPlayer2D_get_max_distance:
|
||||
|
||||
- :ref:`float<class_float>` **get_max_distance** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_max_distance** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamPlayer2D_get_playback_position:
|
||||
|
||||
- :ref:`float<class_float>` **get_playback_position** **(** **)**
|
||||
- :ref:`float<class_float>` **get_playback_position** **(** **)**
|
||||
|
||||
Returns the position in the :ref:`AudioStream<class_audiostream>`.
|
||||
|
||||
.. _class_AudioStreamPlayer2D_get_stream:
|
||||
|
||||
- :ref:`AudioStream<class_audiostream>` **get_stream** **(** **)** const
|
||||
- :ref:`AudioStream<class_audiostream>` **get_stream** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamPlayer2D_get_volume_db:
|
||||
|
||||
- :ref:`float<class_float>` **get_volume_db** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_volume_db** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamPlayer2D_is_autoplay_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_autoplay_enabled** **(** **)**
|
||||
- :ref:`bool<class_bool>` **is_autoplay_enabled** **(** **)**
|
||||
|
||||
.. _class_AudioStreamPlayer2D_is_playing:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_playing** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_playing** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamPlayer2D_play:
|
||||
|
||||
- void **play** **(** :ref:`float<class_float>` from_position=0.0 **)**
|
||||
- void **play** **(** :ref:`float<class_float>` from_position=0.0 **)**
|
||||
|
||||
Plays the audio from the given position 'from_position', in seconds.
|
||||
|
||||
.. _class_AudioStreamPlayer2D_seek:
|
||||
|
||||
- void **seek** **(** :ref:`float<class_float>` to_position **)**
|
||||
- void **seek** **(** :ref:`float<class_float>` to_position **)**
|
||||
|
||||
Sets the position from which audio will be played, in seconds.
|
||||
|
||||
.. _class_AudioStreamPlayer2D_set_area_mask:
|
||||
|
||||
- void **set_area_mask** **(** :ref:`int<class_int>` mask **)**
|
||||
- void **set_area_mask** **(** :ref:`int<class_int>` mask **)**
|
||||
|
||||
.. _class_AudioStreamPlayer2D_set_attenuation:
|
||||
|
||||
- void **set_attenuation** **(** :ref:`float<class_float>` curve **)**
|
||||
- void **set_attenuation** **(** :ref:`float<class_float>` curve **)**
|
||||
|
||||
.. _class_AudioStreamPlayer2D_set_autoplay:
|
||||
|
||||
- void **set_autoplay** **(** :ref:`bool<class_bool>` enable **)**
|
||||
- void **set_autoplay** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
.. _class_AudioStreamPlayer2D_set_bus:
|
||||
|
||||
- void **set_bus** **(** :ref:`String<class_string>` bus **)**
|
||||
- void **set_bus** **(** :ref:`String<class_string>` bus **)**
|
||||
|
||||
.. _class_AudioStreamPlayer2D_set_max_distance:
|
||||
|
||||
- void **set_max_distance** **(** :ref:`float<class_float>` pixels **)**
|
||||
- void **set_max_distance** **(** :ref:`float<class_float>` pixels **)**
|
||||
|
||||
.. _class_AudioStreamPlayer2D_set_stream:
|
||||
|
||||
- void **set_stream** **(** :ref:`AudioStream<class_audiostream>` stream **)**
|
||||
- void **set_stream** **(** :ref:`AudioStream<class_audiostream>` stream **)**
|
||||
|
||||
.. _class_AudioStreamPlayer2D_set_volume_db:
|
||||
|
||||
- void **set_volume_db** **(** :ref:`float<class_float>` volume_db **)**
|
||||
- void **set_volume_db** **(** :ref:`float<class_float>` volume_db **)**
|
||||
|
||||
.. _class_AudioStreamPlayer2D_stop:
|
||||
|
||||
- void **stop** **(** **)**
|
||||
- void **stop** **(** **)**
|
||||
|
||||
Stops the audio.
|
||||
|
||||
|
||||
@@ -19,88 +19,88 @@ Plays 3D sound in 3D space
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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_db<class_AudioStreamPlayer3D_get_attenuation_filter_db>` **(** **)** 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:`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_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_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:`float<class_float>` | :ref:`get_playback_position<class_AudioStreamPlayer3D_get_playback_position>` **(** **)** |
|
||||
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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_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_emission_angle_enabled<class_AudioStreamPlayer3D_is_emission_angle_enabled>` **(** **)** const |
|
||||
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AudioStreamPlayer3D_is_playing>` **(** **)** const |
|
||||
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`play<class_AudioStreamPlayer3D_play>` **(** :ref:`float<class_float>` from_position=0.0 **)** |
|
||||
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`seek<class_AudioStreamPlayer3D_seek>` **(** :ref:`float<class_float>` to_position **)** |
|
||||
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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_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_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_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_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_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_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_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:`stop<class_AudioStreamPlayer3D_stop>` **(** **)** |
|
||||
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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_db<class_AudioStreamPlayer3D_get_attenuation_filter_db>` **(** **)** 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:`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_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_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:`float<class_float>` | :ref:`get_playback_position<class_AudioStreamPlayer3D_get_playback_position>` **(** **)** |
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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_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_emission_angle_enabled<class_AudioStreamPlayer3D_is_emission_angle_enabled>` **(** **)** const |
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AudioStreamPlayer3D_is_playing>` **(** **)** const |
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`play<class_AudioStreamPlayer3D_play>` **(** :ref:`float<class_float>` from_position=0.0 **)** |
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`seek<class_AudioStreamPlayer3D_seek>` **(** :ref:`float<class_float>` to_position **)** |
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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_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_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_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_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_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_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_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:`stop<class_AudioStreamPlayer3D_stop>` **(** **)** |
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_AudioStreamPlayer3D_finished:
|
||||
|
||||
- **finished** **(** **)**
|
||||
- **finished** **(** **)**
|
||||
|
||||
Fires when the audio stops playing.
|
||||
|
||||
@@ -199,157 +199,157 @@ Member Function Description
|
||||
|
||||
.. _class_AudioStreamPlayer3D_get_area_mask:
|
||||
|
||||
- :ref:`int<class_int>` **get_area_mask** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_area_mask** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamPlayer3D_get_attenuation_filter_cutoff_hz:
|
||||
|
||||
- :ref:`float<class_float>` **get_attenuation_filter_cutoff_hz** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_attenuation_filter_cutoff_hz** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamPlayer3D_get_attenuation_filter_db:
|
||||
|
||||
- :ref:`float<class_float>` **get_attenuation_filter_db** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_attenuation_filter_db** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamPlayer3D_get_attenuation_model:
|
||||
|
||||
- :ref:`int<class_int>` **get_attenuation_model** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_attenuation_model** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamPlayer3D_get_bus:
|
||||
|
||||
- :ref:`String<class_string>` **get_bus** **(** **)** const
|
||||
- :ref:`String<class_string>` **get_bus** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamPlayer3D_get_doppler_tracking:
|
||||
|
||||
- :ref:`int<class_int>` **get_doppler_tracking** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_doppler_tracking** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamPlayer3D_get_emission_angle:
|
||||
|
||||
- :ref:`float<class_float>` **get_emission_angle** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_emission_angle** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamPlayer3D_get_emission_angle_filter_attenuation_db:
|
||||
|
||||
- :ref:`float<class_float>` **get_emission_angle_filter_attenuation_db** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_emission_angle_filter_attenuation_db** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamPlayer3D_get_max_db:
|
||||
|
||||
- :ref:`float<class_float>` **get_max_db** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_max_db** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamPlayer3D_get_max_distance:
|
||||
|
||||
- :ref:`float<class_float>` **get_max_distance** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_max_distance** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamPlayer3D_get_out_of_range_mode:
|
||||
|
||||
- :ref:`int<class_int>` **get_out_of_range_mode** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_out_of_range_mode** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamPlayer3D_get_playback_position:
|
||||
|
||||
- :ref:`float<class_float>` **get_playback_position** **(** **)**
|
||||
- :ref:`float<class_float>` **get_playback_position** **(** **)**
|
||||
|
||||
Returns the position in the :ref:`AudioStream<class_audiostream>`.
|
||||
|
||||
.. _class_AudioStreamPlayer3D_get_stream:
|
||||
|
||||
- :ref:`AudioStream<class_audiostream>` **get_stream** **(** **)** const
|
||||
- :ref:`AudioStream<class_audiostream>` **get_stream** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamPlayer3D_get_unit_db:
|
||||
|
||||
- :ref:`float<class_float>` **get_unit_db** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_unit_db** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamPlayer3D_get_unit_size:
|
||||
|
||||
- :ref:`float<class_float>` **get_unit_size** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_unit_size** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamPlayer3D_is_autoplay_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_autoplay_enabled** **(** **)**
|
||||
- :ref:`bool<class_bool>` **is_autoplay_enabled** **(** **)**
|
||||
|
||||
.. _class_AudioStreamPlayer3D_is_emission_angle_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_emission_angle_enabled** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_emission_angle_enabled** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamPlayer3D_is_playing:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_playing** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_playing** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamPlayer3D_play:
|
||||
|
||||
- void **play** **(** :ref:`float<class_float>` from_position=0.0 **)**
|
||||
- void **play** **(** :ref:`float<class_float>` from_position=0.0 **)**
|
||||
|
||||
Plays the audio from the given position 'from_position', in seconds.
|
||||
|
||||
.. _class_AudioStreamPlayer3D_seek:
|
||||
|
||||
- void **seek** **(** :ref:`float<class_float>` to_position **)**
|
||||
- void **seek** **(** :ref:`float<class_float>` to_position **)**
|
||||
|
||||
Sets the position from which audio will be played, in seconds.
|
||||
|
||||
.. _class_AudioStreamPlayer3D_set_area_mask:
|
||||
|
||||
- void **set_area_mask** **(** :ref:`int<class_int>` mask **)**
|
||||
- void **set_area_mask** **(** :ref:`int<class_int>` mask **)**
|
||||
|
||||
.. _class_AudioStreamPlayer3D_set_attenuation_filter_cutoff_hz:
|
||||
|
||||
- void **set_attenuation_filter_cutoff_hz** **(** :ref:`float<class_float>` degrees **)**
|
||||
- void **set_attenuation_filter_cutoff_hz** **(** :ref:`float<class_float>` degrees **)**
|
||||
|
||||
.. _class_AudioStreamPlayer3D_set_attenuation_filter_db:
|
||||
|
||||
- void **set_attenuation_filter_db** **(** :ref:`float<class_float>` db **)**
|
||||
- void **set_attenuation_filter_db** **(** :ref:`float<class_float>` db **)**
|
||||
|
||||
.. _class_AudioStreamPlayer3D_set_attenuation_model:
|
||||
|
||||
- void **set_attenuation_model** **(** :ref:`int<class_int>` model **)**
|
||||
- void **set_attenuation_model** **(** :ref:`int<class_int>` model **)**
|
||||
|
||||
.. _class_AudioStreamPlayer3D_set_autoplay:
|
||||
|
||||
- void **set_autoplay** **(** :ref:`bool<class_bool>` enable **)**
|
||||
- void **set_autoplay** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
.. _class_AudioStreamPlayer3D_set_bus:
|
||||
|
||||
- void **set_bus** **(** :ref:`String<class_string>` bus **)**
|
||||
- void **set_bus** **(** :ref:`String<class_string>` bus **)**
|
||||
|
||||
.. _class_AudioStreamPlayer3D_set_doppler_tracking:
|
||||
|
||||
- void **set_doppler_tracking** **(** :ref:`int<class_int>` mode **)**
|
||||
- void **set_doppler_tracking** **(** :ref:`int<class_int>` mode **)**
|
||||
|
||||
.. _class_AudioStreamPlayer3D_set_emission_angle:
|
||||
|
||||
- void **set_emission_angle** **(** :ref:`float<class_float>` degrees **)**
|
||||
- void **set_emission_angle** **(** :ref:`float<class_float>` degrees **)**
|
||||
|
||||
.. _class_AudioStreamPlayer3D_set_emission_angle_enabled:
|
||||
|
||||
- void **set_emission_angle_enabled** **(** :ref:`bool<class_bool>` enabled **)**
|
||||
- void **set_emission_angle_enabled** **(** :ref:`bool<class_bool>` enabled **)**
|
||||
|
||||
.. _class_AudioStreamPlayer3D_set_emission_angle_filter_attenuation_db:
|
||||
|
||||
- void **set_emission_angle_filter_attenuation_db** **(** :ref:`float<class_float>` db **)**
|
||||
- void **set_emission_angle_filter_attenuation_db** **(** :ref:`float<class_float>` db **)**
|
||||
|
||||
.. _class_AudioStreamPlayer3D_set_max_db:
|
||||
|
||||
- void **set_max_db** **(** :ref:`float<class_float>` max_db **)**
|
||||
- void **set_max_db** **(** :ref:`float<class_float>` max_db **)**
|
||||
|
||||
.. _class_AudioStreamPlayer3D_set_max_distance:
|
||||
|
||||
- void **set_max_distance** **(** :ref:`float<class_float>` metres **)**
|
||||
- void **set_max_distance** **(** :ref:`float<class_float>` metres **)**
|
||||
|
||||
.. _class_AudioStreamPlayer3D_set_out_of_range_mode:
|
||||
|
||||
- void **set_out_of_range_mode** **(** :ref:`int<class_int>` mode **)**
|
||||
- void **set_out_of_range_mode** **(** :ref:`int<class_int>` mode **)**
|
||||
|
||||
.. _class_AudioStreamPlayer3D_set_stream:
|
||||
|
||||
- void **set_stream** **(** :ref:`AudioStream<class_audiostream>` stream **)**
|
||||
- void **set_stream** **(** :ref:`AudioStream<class_audiostream>` stream **)**
|
||||
|
||||
.. _class_AudioStreamPlayer3D_set_unit_db:
|
||||
|
||||
- void **set_unit_db** **(** :ref:`float<class_float>` unit_db **)**
|
||||
- void **set_unit_db** **(** :ref:`float<class_float>` unit_db **)**
|
||||
|
||||
.. _class_AudioStreamPlayer3D_set_unit_size:
|
||||
|
||||
- void **set_unit_size** **(** :ref:`float<class_float>` unit_size **)**
|
||||
- void **set_unit_size** **(** :ref:`float<class_float>` unit_size **)**
|
||||
|
||||
.. _class_AudioStreamPlayer3D_stop:
|
||||
|
||||
- void **stop** **(** **)**
|
||||
- void **stop** **(** **)**
|
||||
|
||||
Stops the audio.
|
||||
|
||||
|
||||
@@ -19,15 +19,15 @@ Plays audio with random pitch tweaking.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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 |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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 **)** |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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 |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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 **)** |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -51,18 +51,18 @@ Member Function Description
|
||||
|
||||
.. _class_AudioStreamRandomPitch_get_audio_stream:
|
||||
|
||||
- :ref:`AudioStream<class_audiostream>` **get_audio_stream** **(** **)** const
|
||||
- :ref:`AudioStream<class_audiostream>` **get_audio_stream** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamRandomPitch_get_random_pitch:
|
||||
|
||||
- :ref:`float<class_float>` **get_random_pitch** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_random_pitch** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamRandomPitch_set_audio_stream:
|
||||
|
||||
- void **set_audio_stream** **(** :ref:`AudioStream<class_audiostream>` stream **)**
|
||||
- void **set_audio_stream** **(** :ref:`AudioStream<class_audiostream>` stream **)**
|
||||
|
||||
.. _class_AudioStreamRandomPitch_set_random_pitch:
|
||||
|
||||
- void **set_random_pitch** **(** :ref:`float<class_float>` scale **)**
|
||||
- void **set_random_pitch** **(** :ref:`float<class_float>` scale **)**
|
||||
|
||||
|
||||
|
||||
@@ -19,35 +19,35 @@ Plays audio.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolByteArray<class_poolbytearray>` | :ref:`get_data<class_AudioStreamSample_get_data>` **(** **)** const |
|
||||
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_format<class_AudioStreamSample_get_format>` **(** **)** const |
|
||||
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_loop_begin<class_AudioStreamSample_get_loop_begin>` **(** **)** const |
|
||||
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_loop_end<class_AudioStreamSample_get_loop_end>` **(** **)** const |
|
||||
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_loop_mode<class_AudioStreamSample_get_loop_mode>` **(** **)** const |
|
||||
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_mix_rate<class_AudioStreamSample_get_mix_rate>` **(** **)** const |
|
||||
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_stereo<class_AudioStreamSample_is_stereo>` **(** **)** const |
|
||||
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_data<class_AudioStreamSample_set_data>` **(** :ref:`PoolByteArray<class_poolbytearray>` data **)** |
|
||||
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_format<class_AudioStreamSample_set_format>` **(** :ref:`int<class_int>` format **)** |
|
||||
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_loop_begin<class_AudioStreamSample_set_loop_begin>` **(** :ref:`int<class_int>` loop_begin **)** |
|
||||
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_loop_end<class_AudioStreamSample_set_loop_end>` **(** :ref:`int<class_int>` loop_end **)** |
|
||||
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_loop_mode<class_AudioStreamSample_set_loop_mode>` **(** :ref:`int<class_int>` loop_mode **)** |
|
||||
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_mix_rate<class_AudioStreamSample_set_mix_rate>` **(** :ref:`int<class_int>` mix_rate **)** |
|
||||
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_stereo<class_AudioStreamSample_set_stereo>` **(** :ref:`bool<class_bool>` stereo **)** |
|
||||
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolByteArray<class_poolbytearray>` | :ref:`get_data<class_AudioStreamSample_get_data>` **(** **)** const |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_format<class_AudioStreamSample_get_format>` **(** **)** const |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_loop_begin<class_AudioStreamSample_get_loop_begin>` **(** **)** const |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_loop_end<class_AudioStreamSample_get_loop_end>` **(** **)** const |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_loop_mode<class_AudioStreamSample_get_loop_mode>` **(** **)** const |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_mix_rate<class_AudioStreamSample_get_mix_rate>` **(** **)** const |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_stereo<class_AudioStreamSample_is_stereo>` **(** **)** const |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_data<class_AudioStreamSample_set_data>` **(** :ref:`PoolByteArray<class_poolbytearray>` data **)** |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_format<class_AudioStreamSample_set_format>` **(** :ref:`int<class_int>` format **)** |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_loop_begin<class_AudioStreamSample_set_loop_begin>` **(** :ref:`int<class_int>` loop_begin **)** |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_loop_end<class_AudioStreamSample_set_loop_end>` **(** :ref:`int<class_int>` loop_end **)** |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_loop_mode<class_AudioStreamSample_set_loop_mode>` **(** :ref:`int<class_int>` loop_mode **)** |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_mix_rate<class_AudioStreamSample_set_mix_rate>` **(** :ref:`int<class_int>` mix_rate **)** |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_stereo<class_AudioStreamSample_set_stereo>` **(** :ref:`bool<class_bool>` stereo **)** |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -101,58 +101,58 @@ Member Function Description
|
||||
|
||||
.. _class_AudioStreamSample_get_data:
|
||||
|
||||
- :ref:`PoolByteArray<class_poolbytearray>` **get_data** **(** **)** const
|
||||
- :ref:`PoolByteArray<class_poolbytearray>` **get_data** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamSample_get_format:
|
||||
|
||||
- :ref:`int<class_int>` **get_format** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_format** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamSample_get_loop_begin:
|
||||
|
||||
- :ref:`int<class_int>` **get_loop_begin** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_loop_begin** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamSample_get_loop_end:
|
||||
|
||||
- :ref:`int<class_int>` **get_loop_end** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_loop_end** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamSample_get_loop_mode:
|
||||
|
||||
- :ref:`int<class_int>` **get_loop_mode** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_loop_mode** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamSample_get_mix_rate:
|
||||
|
||||
- :ref:`int<class_int>` **get_mix_rate** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_mix_rate** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamSample_is_stereo:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_stereo** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_stereo** **(** **)** const
|
||||
|
||||
.. _class_AudioStreamSample_set_data:
|
||||
|
||||
- void **set_data** **(** :ref:`PoolByteArray<class_poolbytearray>` data **)**
|
||||
- void **set_data** **(** :ref:`PoolByteArray<class_poolbytearray>` data **)**
|
||||
|
||||
.. _class_AudioStreamSample_set_format:
|
||||
|
||||
- void **set_format** **(** :ref:`int<class_int>` format **)**
|
||||
- void **set_format** **(** :ref:`int<class_int>` format **)**
|
||||
|
||||
.. _class_AudioStreamSample_set_loop_begin:
|
||||
|
||||
- void **set_loop_begin** **(** :ref:`int<class_int>` loop_begin **)**
|
||||
- void **set_loop_begin** **(** :ref:`int<class_int>` loop_begin **)**
|
||||
|
||||
.. _class_AudioStreamSample_set_loop_end:
|
||||
|
||||
- void **set_loop_end** **(** :ref:`int<class_int>` loop_end **)**
|
||||
- void **set_loop_end** **(** :ref:`int<class_int>` loop_end **)**
|
||||
|
||||
.. _class_AudioStreamSample_set_loop_mode:
|
||||
|
||||
- void **set_loop_mode** **(** :ref:`int<class_int>` loop_mode **)**
|
||||
- void **set_loop_mode** **(** :ref:`int<class_int>` loop_mode **)**
|
||||
|
||||
.. _class_AudioStreamSample_set_mix_rate:
|
||||
|
||||
- void **set_mix_rate** **(** :ref:`int<class_int>` mix_rate **)**
|
||||
- void **set_mix_rate** **(** :ref:`int<class_int>` mix_rate **)**
|
||||
|
||||
.. _class_AudioStreamSample_set_stereo:
|
||||
|
||||
- void **set_stereo** **(** :ref:`bool<class_bool>` stereo **)**
|
||||
- void **set_stereo** **(** :ref:`bool<class_bool>` stereo **)**
|
||||
|
||||
|
||||
|
||||
@@ -19,15 +19,15 @@ Copies a region of the screen (or the whole screen) to a buffer so it can be acc
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_copy_mode<class_BackBufferCopy_get_copy_mode>` **(** **)** const |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Rect2<class_rect2>` | :ref:`get_rect<class_BackBufferCopy_get_rect>` **(** **)** const |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_copy_mode<class_BackBufferCopy_set_copy_mode>` **(** :ref:`int<class_int>` copy_mode **)** |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_rect<class_BackBufferCopy_set_rect>` **(** :ref:`Rect2<class_rect2>` rect **)** |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_copy_mode<class_BackBufferCopy_get_copy_mode>` **(** **)** const |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Rect2<class_rect2>` | :ref:`get_rect<class_BackBufferCopy_get_rect>` **(** **)** const |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_copy_mode<class_BackBufferCopy_set_copy_mode>` **(** :ref:`int<class_int>` copy_mode **)** |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_rect<class_BackBufferCopy_set_rect>` **(** :ref:`Rect2<class_rect2>` rect **)** |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -58,25 +58,25 @@ Member Function Description
|
||||
|
||||
.. _class_BackBufferCopy_get_copy_mode:
|
||||
|
||||
- :ref:`int<class_int>` **get_copy_mode** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_copy_mode** **(** **)** const
|
||||
|
||||
Return the copy mode currently applied to the BackBufferCopy. See ``COPY_MODE\_\*`` constants.
|
||||
|
||||
.. _class_BackBufferCopy_get_rect:
|
||||
|
||||
- :ref:`Rect2<class_rect2>` **get_rect** **(** **)** const
|
||||
- :ref:`Rect2<class_rect2>` **get_rect** **(** **)** const
|
||||
|
||||
Return the area covered by the BackBufferCopy.
|
||||
|
||||
.. _class_BackBufferCopy_set_copy_mode:
|
||||
|
||||
- void **set_copy_mode** **(** :ref:`int<class_int>` copy_mode **)**
|
||||
- void **set_copy_mode** **(** :ref:`int<class_int>` copy_mode **)**
|
||||
|
||||
Set the copy mode of the BackBufferCopy. See ``COPY_MODE\_\*`` constants.
|
||||
|
||||
.. _class_BackBufferCopy_set_rect:
|
||||
|
||||
- void **set_rect** **(** :ref:`Rect2<class_rect2>` rect **)**
|
||||
- void **set_rect** **(** :ref:`Rect2<class_rect2>` rect **)**
|
||||
|
||||
Defines the area covered by the BackBufferCopy.
|
||||
|
||||
|
||||
@@ -21,68 +21,68 @@ Provides a base class for different kinds of buttons.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_pressed<class_BaseButton__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:`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_enabled_focus_mode<class_BaseButton_get_enabled_focus_mode>` **(** **)** 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_hovered<class_BaseButton_is_hovered>` **(** **)** const |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_pressed<class_BaseButton_is_pressed>` **(** **)** const |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_toggle_mode<class_BaseButton_is_toggle_mode>` **(** **)** const |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_action_mode<class_BaseButton_set_action_mode>` **(** :ref:`int<class_int>` mode **)** |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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_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_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:`_pressed<class_BaseButton__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:`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_enabled_focus_mode<class_BaseButton_get_enabled_focus_mode>` **(** **)** 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_hovered<class_BaseButton_is_hovered>` **(** **)** const |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_pressed<class_BaseButton_is_pressed>` **(** **)** const |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_toggle_mode<class_BaseButton_is_toggle_mode>` **(** **)** const |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_action_mode<class_BaseButton_set_action_mode>` **(** :ref:`int<class_int>` mode **)** |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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_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_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 **)** |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_BaseButton_button_down:
|
||||
|
||||
- **button_down** **(** **)**
|
||||
- **button_down** **(** **)**
|
||||
|
||||
Emitted when the button starts being held down.
|
||||
|
||||
.. _class_BaseButton_button_up:
|
||||
|
||||
- **button_up** **(** **)**
|
||||
- **button_up** **(** **)**
|
||||
|
||||
Emitted when the button stops being held down.
|
||||
|
||||
.. _class_BaseButton_pressed:
|
||||
|
||||
- **pressed** **(** **)**
|
||||
- **pressed** **(** **)**
|
||||
|
||||
This signal is emitted every time the button is toggled or pressed (i.e. activated, so on ``button_down`` if "Click on press" is active and on ``button_up`` otherwise).
|
||||
|
||||
.. _class_BaseButton_toggled:
|
||||
|
||||
- **toggled** **(** :ref:`bool<class_bool>` pressed **)**
|
||||
- **toggled** **(** :ref:`bool<class_bool>` pressed **)**
|
||||
|
||||
This signal is emitted when the button was just toggled between pressed and normal states (only if toggle_mode is active). The new state is contained in the *pressed* argument.
|
||||
|
||||
@@ -139,101 +139,101 @@ Member Function Description
|
||||
|
||||
.. _class_BaseButton__pressed:
|
||||
|
||||
- void **_pressed** **(** **)** virtual
|
||||
- void **_pressed** **(** **)** virtual
|
||||
|
||||
Called when button is pressed.
|
||||
|
||||
.. _class_BaseButton__toggled:
|
||||
|
||||
- void **_toggled** **(** :ref:`bool<class_bool>` pressed **)** virtual
|
||||
- void **_toggled** **(** :ref:`bool<class_bool>` pressed **)** virtual
|
||||
|
||||
Called when button is toggled (only if toggle_mode is active).
|
||||
|
||||
.. _class_BaseButton_get_action_mode:
|
||||
|
||||
- :ref:`int<class_int>` **get_action_mode** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_action_mode** **(** **)** const
|
||||
|
||||
Return the current mode of action (see :ref:`set_action_mode<class_BaseButton_set_action_mode>`) (one of the ACTION_MODE\_\* constants).
|
||||
|
||||
.. _class_BaseButton_get_button_group:
|
||||
|
||||
- :ref:`ButtonGroup<class_buttongroup>` **get_button_group** **(** **)** const
|
||||
- :ref:`ButtonGroup<class_buttongroup>` **get_button_group** **(** **)** const
|
||||
|
||||
.. _class_BaseButton_get_draw_mode:
|
||||
|
||||
- :ref:`int<class_int>` **get_draw_mode** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_draw_mode** **(** **)** const
|
||||
|
||||
Return the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overriding _draw() or connecting to "draw" signal. The visual state of the button is defined by the DRAW\_\* enum.
|
||||
|
||||
.. _class_BaseButton_get_enabled_focus_mode:
|
||||
|
||||
- :ref:`int<class_int>` **get_enabled_focus_mode** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_enabled_focus_mode** **(** **)** const
|
||||
|
||||
Returns focus access mode used when switching between enabled/disabled (see :ref:`Control.set_focus_mode<class_Control_set_focus_mode>` and :ref:`set_disabled<class_BaseButton_set_disabled>`).
|
||||
|
||||
.. _class_BaseButton_get_shortcut:
|
||||
|
||||
- :ref:`ShortCut<class_shortcut>` **get_shortcut** **(** **)** const
|
||||
- :ref:`ShortCut<class_shortcut>` **get_shortcut** **(** **)** const
|
||||
|
||||
.. _class_BaseButton_is_disabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_disabled** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_disabled** **(** **)** const
|
||||
|
||||
Return whether the button is in disabled state (see :ref:`set_disabled<class_BaseButton_set_disabled>`).
|
||||
|
||||
.. _class_BaseButton_is_hovered:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_hovered** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_hovered** **(** **)** const
|
||||
|
||||
Return true if mouse entered the button before it exit.
|
||||
|
||||
.. _class_BaseButton_is_pressed:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_pressed** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_pressed** **(** **)** const
|
||||
|
||||
If toggle_mode is active, return whether the button is toggled. If toggle_mode is not active, return whether the button is pressed down.
|
||||
|
||||
.. _class_BaseButton_is_toggle_mode:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_toggle_mode** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_toggle_mode** **(** **)** const
|
||||
|
||||
Return the toggle_mode property (see :ref:`set_toggle_mode<class_BaseButton_set_toggle_mode>`).
|
||||
|
||||
.. _class_BaseButton_set_action_mode:
|
||||
|
||||
- void **set_action_mode** **(** :ref:`int<class_int>` mode **)**
|
||||
- void **set_action_mode** **(** :ref:`int<class_int>` mode **)**
|
||||
|
||||
Set the current mode of action, determining when the button is considered clicked (see the ACTION_MODE\_\* constants).
|
||||
|
||||
.. _class_BaseButton_set_button_group:
|
||||
|
||||
- void **set_button_group** **(** :ref:`ButtonGroup<class_buttongroup>` button_group **)**
|
||||
- void **set_button_group** **(** :ref:`ButtonGroup<class_buttongroup>` button_group **)**
|
||||
|
||||
.. _class_BaseButton_set_disabled:
|
||||
|
||||
- void **set_disabled** **(** :ref:`bool<class_bool>` disabled **)**
|
||||
- void **set_disabled** **(** :ref:`bool<class_bool>` disabled **)**
|
||||
|
||||
Set the button into disabled state. When a button is disabled, it can't be clicked or toggled.
|
||||
|
||||
.. _class_BaseButton_set_enabled_focus_mode:
|
||||
|
||||
- void **set_enabled_focus_mode** **(** :ref:`int<class_int>` mode **)**
|
||||
- void **set_enabled_focus_mode** **(** :ref:`int<class_int>` mode **)**
|
||||
|
||||
Sets the focus access mode to use when switching between enabled/disabled (see :ref:`Control.set_focus_mode<class_Control_set_focus_mode>` and :ref:`set_disabled<class_BaseButton_set_disabled>`).
|
||||
|
||||
.. _class_BaseButton_set_pressed:
|
||||
|
||||
- void **set_pressed** **(** :ref:`bool<class_bool>` pressed **)**
|
||||
- void **set_pressed** **(** :ref:`bool<class_bool>` pressed **)**
|
||||
|
||||
Set the button to pressed state (only if toggle_mode is active).
|
||||
|
||||
.. _class_BaseButton_set_shortcut:
|
||||
|
||||
- void **set_shortcut** **(** :ref:`ShortCut<class_shortcut>` shortcut **)**
|
||||
- void **set_shortcut** **(** :ref:`ShortCut<class_shortcut>` shortcut **)**
|
||||
|
||||
.. _class_BaseButton_set_toggle_mode:
|
||||
|
||||
- void **set_toggle_mode** **(** :ref:`bool<class_bool>` enabled **)**
|
||||
- void **set_toggle_mode** **(** :ref:`bool<class_bool>` enabled **)**
|
||||
|
||||
Set the button toggle_mode property. Toggle mode makes the button flip state between pressed and unpressed each time its area is clicked.
|
||||
|
||||
|
||||
@@ -17,43 +17,43 @@ Brief Description
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_basis>` | :ref:`Basis<class_Basis_Basis>` **(** :ref:`Quat<class_quat>` from **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_basis>` | :ref:`Basis<class_Basis_Basis>` **(** :ref:`Vector3<class_vector3>` euler **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_basis>` | :ref:`Basis<class_Basis_Basis>` **(** :ref:`Vector3<class_vector3>` axis, :ref:`float<class_float>` phi **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_basis>` | :ref:`Basis<class_Basis_Basis>` **(** :ref:`Vector3<class_vector3>` x_axis, :ref:`Vector3<class_vector3>` y_axis, :ref:`Vector3<class_vector3>` z_axis **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`determinant<class_Basis_determinant>` **(** **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_euler<class_Basis_get_euler>` **(** **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_orthogonal_index<class_Basis_get_orthogonal_index>` **(** **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_scale<class_Basis_get_scale>` **(** **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_basis>` | :ref:`inverse<class_Basis_inverse>` **(** **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_basis>` | :ref:`orthonormalized<class_Basis_orthonormalized>` **(** **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_basis>` | :ref:`rotated<class_Basis_rotated>` **(** :ref:`Vector3<class_vector3>` axis, :ref:`float<class_float>` phi **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_basis>` | :ref:`scaled<class_Basis_scaled>` **(** :ref:`Vector3<class_vector3>` scale **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`tdotz<class_Basis_tdotz>` **(** :ref:`Vector3<class_vector3>` with **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_basis>` | :ref:`transposed<class_Basis_transposed>` **(** **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`xform<class_Basis_xform>` **(** :ref:`Vector3<class_vector3>` v **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`xform_inv<class_Basis_xform_inv>` **(** :ref:`Vector3<class_vector3>` v **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_basis>` | :ref:`Basis<class_Basis_Basis>` **(** :ref:`Quat<class_quat>` from **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_basis>` | :ref:`Basis<class_Basis_Basis>` **(** :ref:`Vector3<class_vector3>` euler **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_basis>` | :ref:`Basis<class_Basis_Basis>` **(** :ref:`Vector3<class_vector3>` axis, :ref:`float<class_float>` phi **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_basis>` | :ref:`Basis<class_Basis_Basis>` **(** :ref:`Vector3<class_vector3>` x_axis, :ref:`Vector3<class_vector3>` y_axis, :ref:`Vector3<class_vector3>` z_axis **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`determinant<class_Basis_determinant>` **(** **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_euler<class_Basis_get_euler>` **(** **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_orthogonal_index<class_Basis_get_orthogonal_index>` **(** **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_scale<class_Basis_get_scale>` **(** **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_basis>` | :ref:`inverse<class_Basis_inverse>` **(** **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_basis>` | :ref:`orthonormalized<class_Basis_orthonormalized>` **(** **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_basis>` | :ref:`rotated<class_Basis_rotated>` **(** :ref:`Vector3<class_vector3>` axis, :ref:`float<class_float>` phi **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_basis>` | :ref:`scaled<class_Basis_scaled>` **(** :ref:`Vector3<class_vector3>` scale **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`tdotz<class_Basis_tdotz>` **(** :ref:`Vector3<class_vector3>` with **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_basis>` | :ref:`transposed<class_Basis_transposed>` **(** **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`xform<class_Basis_xform>` **(** :ref:`Vector3<class_vector3>` v **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`xform_inv<class_Basis_xform_inv>` **(** :ref:`Vector3<class_vector3>` v **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -83,109 +83,109 @@ Member Function Description
|
||||
|
||||
.. _class_Basis_Basis:
|
||||
|
||||
- :ref:`Basis<class_basis>` **Basis** **(** :ref:`Quat<class_quat>` from **)**
|
||||
- :ref:`Basis<class_basis>` **Basis** **(** :ref:`Quat<class_quat>` from **)**
|
||||
|
||||
Create a rotation matrix from the given quaternion.
|
||||
|
||||
.. _class_Basis_Basis:
|
||||
|
||||
- :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 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:
|
||||
|
||||
- :ref:`Basis<class_basis>` **Basis** **(** :ref:`Vector3<class_vector3>` axis, :ref:`float<class_float>` phi **)**
|
||||
- :ref:`Basis<class_basis>` **Basis** **(** :ref:`Vector3<class_vector3>` axis, :ref:`float<class_float>` phi **)**
|
||||
|
||||
Create a rotation matrix which rotates around the given axis by the specified angle. The axis must be a normalized vector.
|
||||
|
||||
.. _class_Basis_Basis:
|
||||
|
||||
- :ref:`Basis<class_basis>` **Basis** **(** :ref:`Vector3<class_vector3>` x_axis, :ref:`Vector3<class_vector3>` y_axis, :ref:`Vector3<class_vector3>` z_axis **)**
|
||||
- :ref:`Basis<class_basis>` **Basis** **(** :ref:`Vector3<class_vector3>` x_axis, :ref:`Vector3<class_vector3>` y_axis, :ref:`Vector3<class_vector3>` z_axis **)**
|
||||
|
||||
Create a matrix from 3 axis vectors.
|
||||
|
||||
.. _class_Basis_determinant:
|
||||
|
||||
- :ref:`float<class_float>` **determinant** **(** **)**
|
||||
- :ref:`float<class_float>` **determinant** **(** **)**
|
||||
|
||||
Return the determinant of the matrix.
|
||||
|
||||
.. _class_Basis_get_euler:
|
||||
|
||||
- :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 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:
|
||||
|
||||
- :ref:`int<class_int>` **get_orthogonal_index** **(** **)**
|
||||
- :ref:`int<class_int>` **get_orthogonal_index** **(** **)**
|
||||
|
||||
This function considers a discretization of rotations into 24 points on unit sphere, lying along the vectors (x,y,z) with each component being either -1,0 or 1, and returns the index of the point best representing the orientation of the object. It is mainly used by the grid map editor. For further details, refer to Godot source code.
|
||||
|
||||
.. _class_Basis_get_scale:
|
||||
|
||||
- :ref:`Vector3<class_vector3>` **get_scale** **(** **)**
|
||||
- :ref:`Vector3<class_vector3>` **get_scale** **(** **)**
|
||||
|
||||
Assuming that the matrix is the combination of a rotation and scaling, return the absolute value of scaling factors along each axis.
|
||||
|
||||
.. _class_Basis_inverse:
|
||||
|
||||
- :ref:`Basis<class_basis>` **inverse** **(** **)**
|
||||
- :ref:`Basis<class_basis>` **inverse** **(** **)**
|
||||
|
||||
Return the inverse of the matrix.
|
||||
|
||||
.. _class_Basis_orthonormalized:
|
||||
|
||||
- :ref:`Basis<class_basis>` **orthonormalized** **(** **)**
|
||||
- :ref:`Basis<class_basis>` **orthonormalized** **(** **)**
|
||||
|
||||
Return the orthonormalized version of the matrix (useful to call from time to time to avoid rounding error for orthogonal matrices). This performs a Gram-Schmidt orthonormalization on the basis of the matrix.
|
||||
|
||||
.. _class_Basis_rotated:
|
||||
|
||||
- :ref:`Basis<class_basis>` **rotated** **(** :ref:`Vector3<class_vector3>` axis, :ref:`float<class_float>` phi **)**
|
||||
- :ref:`Basis<class_basis>` **rotated** **(** :ref:`Vector3<class_vector3>` axis, :ref:`float<class_float>` phi **)**
|
||||
|
||||
Introduce an additional rotation around the given axis by phi (radians). Only relevant when the matrix is being used as a part of :ref:`Transform<class_transform>`. The axis must be a normalized vector.
|
||||
|
||||
.. _class_Basis_scaled:
|
||||
|
||||
- :ref:`Basis<class_basis>` **scaled** **(** :ref:`Vector3<class_vector3>` scale **)**
|
||||
- :ref:`Basis<class_basis>` **scaled** **(** :ref:`Vector3<class_vector3>` scale **)**
|
||||
|
||||
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_tdotx:
|
||||
|
||||
- :ref:`float<class_float>` **tdotx** **(** :ref:`Vector3<class_vector3>` with **)**
|
||||
- :ref:`float<class_float>` **tdotx** **(** :ref:`Vector3<class_vector3>` with **)**
|
||||
|
||||
Transposed dot product with the x axis of the matrix.
|
||||
|
||||
.. _class_Basis_tdoty:
|
||||
|
||||
- :ref:`float<class_float>` **tdoty** **(** :ref:`Vector3<class_vector3>` with **)**
|
||||
- :ref:`float<class_float>` **tdoty** **(** :ref:`Vector3<class_vector3>` with **)**
|
||||
|
||||
Transposed dot product with the y axis of the matrix.
|
||||
|
||||
.. _class_Basis_tdotz:
|
||||
|
||||
- :ref:`float<class_float>` **tdotz** **(** :ref:`Vector3<class_vector3>` with **)**
|
||||
- :ref:`float<class_float>` **tdotz** **(** :ref:`Vector3<class_vector3>` with **)**
|
||||
|
||||
Transposed dot product with the z axis of the matrix.
|
||||
|
||||
.. _class_Basis_transposed:
|
||||
|
||||
- :ref:`Basis<class_basis>` **transposed** **(** **)**
|
||||
- :ref:`Basis<class_basis>` **transposed** **(** **)**
|
||||
|
||||
Return the transposed version of the matrix.
|
||||
|
||||
.. _class_Basis_xform:
|
||||
|
||||
- :ref:`Vector3<class_vector3>` **xform** **(** :ref:`Vector3<class_vector3>` v **)**
|
||||
- :ref:`Vector3<class_vector3>` **xform** **(** :ref:`Vector3<class_vector3>` v **)**
|
||||
|
||||
Return a vector transformed (multiplied) by the matrix.
|
||||
|
||||
.. _class_Basis_xform_inv:
|
||||
|
||||
- :ref:`Vector3<class_vector3>` **xform_inv** **(** :ref:`Vector3<class_vector3>` v **)**
|
||||
- :ref:`Vector3<class_vector3>` **xform_inv** **(** :ref:`Vector3<class_vector3>` v **)**
|
||||
|
||||
Return a vector transformed (multiplied) by the transposed matrix. Note that this results in a multiplication by the inverse of the matrix only if it represents a rotation-reflection.
|
||||
|
||||
|
||||
@@ -19,21 +19,21 @@ Boolean matrix.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`create<class_BitMap_create>` **(** :ref:`Vector2<class_vector2>` size **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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>` position **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_size<class_BitMap_get_size>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_true_bit_count<class_BitMap_get_true_bit_count>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bit<class_BitMap_set_bit>` **(** :ref:`Vector2<class_vector2>` position, :ref:`bool<class_bool>` bit **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bit_rect<class_BitMap_set_bit_rect>` **(** :ref:`Rect2<class_rect2>` p_rect, :ref:`bool<class_bool>` bit **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`create<class_BitMap_create>` **(** :ref:`Vector2<class_vector2>` size **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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>` position **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_size<class_BitMap_get_size>` **(** **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_true_bit_count<class_BitMap_get_true_bit_count>` **(** **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bit<class_BitMap_set_bit>` **(** :ref:`Vector2<class_vector2>` position, :ref:`bool<class_bool>` bit **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bit_rect<class_BitMap_set_bit_rect>` **(** :ref:`Rect2<class_rect2>` p_rect, :ref:`bool<class_bool>` bit **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -57,43 +57,43 @@ Member Function Description
|
||||
|
||||
.. _class_BitMap_create:
|
||||
|
||||
- void **create** **(** :ref:`Vector2<class_vector2>` size **)**
|
||||
- void **create** **(** :ref:`Vector2<class_vector2>` size **)**
|
||||
|
||||
Creates a bitmap with the specified size, filled with false.
|
||||
|
||||
.. _class_BitMap_create_from_image_alpha:
|
||||
|
||||
- void **create_from_image_alpha** **(** :ref:`Image<class_image>` image **)**
|
||||
- void **create_from_image_alpha** **(** :ref:`Image<class_image>` image **)**
|
||||
|
||||
Creates a bitmap that matches the given image dimensions, every element of the bitmap is set to false if the alpha value of the image at that position is 0, and true in other case.
|
||||
|
||||
.. _class_BitMap_get_bit:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_bit** **(** :ref:`Vector2<class_vector2>` position **)** const
|
||||
- :ref:`bool<class_bool>` **get_bit** **(** :ref:`Vector2<class_vector2>` position **)** const
|
||||
|
||||
Returns bitmap's value at the specified position.
|
||||
|
||||
.. _class_BitMap_get_size:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **get_size** **(** **)** const
|
||||
- :ref:`Vector2<class_vector2>` **get_size** **(** **)** const
|
||||
|
||||
Returns bitmap's dimensions.
|
||||
|
||||
.. _class_BitMap_get_true_bit_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_true_bit_count** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_true_bit_count** **(** **)** const
|
||||
|
||||
Returns the amount of bitmap elements that are set to true.
|
||||
|
||||
.. _class_BitMap_set_bit:
|
||||
|
||||
- void **set_bit** **(** :ref:`Vector2<class_vector2>` position, :ref:`bool<class_bool>` bit **)**
|
||||
- void **set_bit** **(** :ref:`Vector2<class_vector2>` position, :ref:`bool<class_bool>` bit **)**
|
||||
|
||||
Sets the bitmap's element at the specified position, to the specified value.
|
||||
|
||||
.. _class_BitMap_set_bit_rect:
|
||||
|
||||
- void **set_bit_rect** **(** :ref:`Rect2<class_rect2>` p_rect, :ref:`bool<class_bool>` bit **)**
|
||||
- void **set_bit_rect** **(** :ref:`Rect2<class_rect2>` p_rect, :ref:`bool<class_bool>` bit **)**
|
||||
|
||||
Sets a rectangular portion of the bitmap to the specified value.
|
||||
|
||||
|
||||
@@ -19,35 +19,35 @@ Renders text using ``\*.fnt`` fonts.
|
||||
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_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:`clear<class_BitmapFont_clear>` **(** **)** |
|
||||
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`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:`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 |
|
||||
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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_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:`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_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:`clear<class_BitmapFont_clear>` **(** **)** |
|
||||
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`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:`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 |
|
||||
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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_fallback<class_BitmapFont_set_fallback>` **(** :ref:`BitmapFont<class_bitmapfont>` fallback **)** |
|
||||
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_height<class_BitmapFont_set_height>` **(** :ref:`float<class_float>` px **)** |
|
||||
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -91,85 +91,85 @@ Member Function Description
|
||||
|
||||
.. _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=Vector2( 0, 0 ), :ref:`float<class_float>` advance=-1 **)**
|
||||
|
||||
Adds a character to the font, where ``character`` is the unicode value, ``texture`` is the texture index, ``rect`` is the region in the texture (in pixels!), ``align`` is the (optional) alignment for the character and ``advance`` is the (optional) advance.
|
||||
|
||||
.. _class_BitmapFont_add_kerning_pair:
|
||||
|
||||
- void **add_kerning_pair** **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b, :ref:`int<class_int>` kerning **)**
|
||||
- void **add_kerning_pair** **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b, :ref:`int<class_int>` kerning **)**
|
||||
|
||||
Adds a kerning pair to the :ref:`BitmapFont<class_bitmapfont>` as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character.
|
||||
|
||||
.. _class_BitmapFont_add_texture:
|
||||
|
||||
- void **add_texture** **(** :ref:`Texture<class_texture>` texture **)**
|
||||
- void **add_texture** **(** :ref:`Texture<class_texture>` texture **)**
|
||||
|
||||
Adds a texture to the :ref:`BitmapFont<class_bitmapfont>`.
|
||||
|
||||
.. _class_BitmapFont_clear:
|
||||
|
||||
- void **clear** **(** **)**
|
||||
- void **clear** **(** **)**
|
||||
|
||||
Clears all the font data and settings.
|
||||
|
||||
.. _class_BitmapFont_create_from_fnt:
|
||||
|
||||
- :ref:`int<class_int>` **create_from_fnt** **(** :ref:`String<class_string>` path **)**
|
||||
- :ref:`int<class_int>` **create_from_fnt** **(** :ref:`String<class_string>` path **)**
|
||||
|
||||
Creates a BitmapFont from the ``\*.fnt`` file at ``path``.
|
||||
|
||||
.. _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=0 **)** const
|
||||
|
||||
Returns the size of a character, optionally taking kerning into account if the next character is provided.
|
||||
|
||||
.. _class_BitmapFont_get_fallback:
|
||||
|
||||
- :ref:`BitmapFont<class_bitmapfont>` **get_fallback** **(** **)** const
|
||||
- :ref:`BitmapFont<class_bitmapfont>` **get_fallback** **(** **)** const
|
||||
|
||||
Returns the fallback BitmapFont.
|
||||
|
||||
.. _class_BitmapFont_get_kerning_pair:
|
||||
|
||||
- :ref:`int<class_int>` **get_kerning_pair** **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b **)** const
|
||||
- :ref:`int<class_int>` **get_kerning_pair** **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b **)** const
|
||||
|
||||
Returns a kerning pair as a difference.
|
||||
|
||||
.. _class_BitmapFont_get_texture:
|
||||
|
||||
- :ref:`Texture<class_texture>` **get_texture** **(** :ref:`int<class_int>` idx **)** const
|
||||
- :ref:`Texture<class_texture>` **get_texture** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Returns the font atlas texture at index ``idx``.
|
||||
|
||||
.. _class_BitmapFont_get_texture_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_texture_count** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_texture_count** **(** **)** const
|
||||
|
||||
Returns the number of textures in the BitmapFont atlas.
|
||||
|
||||
.. _class_BitmapFont_set_ascent:
|
||||
|
||||
- void **set_ascent** **(** :ref:`float<class_float>` px **)**
|
||||
- void **set_ascent** **(** :ref:`float<class_float>` px **)**
|
||||
|
||||
Sets the font ascent (number of pixels above the baseline).
|
||||
|
||||
.. _class_BitmapFont_set_distance_field_hint:
|
||||
|
||||
- void **set_distance_field_hint** **(** :ref:`bool<class_bool>` enable **)**
|
||||
- void **set_distance_field_hint** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
If ``true`` distance field hint is enabled.
|
||||
|
||||
.. _class_BitmapFont_set_fallback:
|
||||
|
||||
- void **set_fallback** **(** :ref:`BitmapFont<class_bitmapfont>` fallback **)**
|
||||
- void **set_fallback** **(** :ref:`BitmapFont<class_bitmapfont>` fallback **)**
|
||||
|
||||
Sets the fallback BitmapFont.
|
||||
|
||||
.. _class_BitmapFont_set_height:
|
||||
|
||||
- void **set_height** **(** :ref:`float<class_float>` px **)**
|
||||
- void **set_height** **(** :ref:`float<class_float>` px **)**
|
||||
|
||||
Sets the total font height (ascent plus descent) in pixels.
|
||||
|
||||
|
||||
@@ -19,11 +19,11 @@ A node that will attach to a bone.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_bone_name<class_BoneAttachment_get_bone_name>` **(** **)** const |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bone_name<class_BoneAttachment_set_bone_name>` **(** :ref:`String<class_string>` bone_name **)** |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_bone_name<class_BoneAttachment_get_bone_name>` **(** **)** const |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bone_name<class_BoneAttachment_set_bone_name>` **(** :ref:`String<class_string>` bone_name **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -35,13 +35,13 @@ Member Function Description
|
||||
|
||||
.. _class_BoneAttachment_get_bone_name:
|
||||
|
||||
- :ref:`String<class_string>` **get_bone_name** **(** **)** const
|
||||
- :ref:`String<class_string>` **get_bone_name** **(** **)** const
|
||||
|
||||
Returns the name of the bone node attached to.
|
||||
|
||||
.. _class_BoneAttachment_set_bone_name:
|
||||
|
||||
- void **set_bone_name** **(** :ref:`String<class_string>` bone_name **)**
|
||||
- void **set_bone_name** **(** :ref:`String<class_string>` bone_name **)**
|
||||
|
||||
Changes the name of the bone node
|
||||
|
||||
|
||||
@@ -17,13 +17,13 @@ Boolean built-in type
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`bool<class_bool_bool>` **(** :ref:`int<class_int>` from **)** |
|
||||
+--------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`bool<class_bool_bool>` **(** :ref:`float<class_float>` from **)** |
|
||||
+--------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`bool<class_bool_bool>` **(** :ref:`String<class_string>` from **)** |
|
||||
+--------------------------+-----------------------------------------------------------------------------+
|
||||
+--------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`bool<class_bool_bool>` **(** :ref:`int<class_int>` from **)** |
|
||||
+--------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`bool<class_bool_bool>` **(** :ref:`float<class_float>` from **)** |
|
||||
+--------------------------+---------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`bool<class_bool_bool>` **(** :ref:`String<class_string>` from **)** |
|
||||
+--------------------------+---------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -35,19 +35,19 @@ Member Function Description
|
||||
|
||||
.. _class_bool_bool:
|
||||
|
||||
- :ref:`bool<class_bool>` **bool** **(** :ref:`int<class_int>` from **)**
|
||||
- :ref:`bool<class_bool>` **bool** **(** :ref:`int<class_int>` from **)**
|
||||
|
||||
Cast an :ref:`int<class_int>` value to a boolean value, this method will return true if called with an integer value different to 0 and false in other case.
|
||||
|
||||
.. _class_bool_bool:
|
||||
|
||||
- :ref:`bool<class_bool>` **bool** **(** :ref:`float<class_float>` from **)**
|
||||
- :ref:`bool<class_bool>` **bool** **(** :ref:`float<class_float>` from **)**
|
||||
|
||||
Cast a :ref:`float<class_float>` value to a boolean value, this method will return true if called with a floating point value different to 0 and false in other case.
|
||||
|
||||
.. _class_bool_bool:
|
||||
|
||||
- :ref:`bool<class_bool>` **bool** **(** :ref:`String<class_string>` from **)**
|
||||
- :ref:`bool<class_bool>` **bool** **(** :ref:`String<class_string>` from **)**
|
||||
|
||||
Cast a :ref:`String<class_string>` value to a boolean value, this method will return true if called with a non empty string and false in other case. Examples: ``bool('False')`` returns true, ``bool('')``. returns false
|
||||
|
||||
|
||||
@@ -21,13 +21,13 @@ Base class for box containers.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------+------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_spacer<class_BoxContainer_add_spacer>` **(** :ref:`bool<class_bool>` begin **)** |
|
||||
+------------------------+------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_alignment<class_BoxContainer_get_alignment>` **(** **)** const |
|
||||
+------------------------+------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_alignment<class_BoxContainer_set_alignment>` **(** :ref:`int<class_int>` alignment **)** |
|
||||
+------------------------+------------------------------------------------------------------------------------------------------+
|
||||
+------------------------+----------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_spacer<class_BoxContainer_add_spacer>` **(** :ref:`bool<class_bool>` begin **)** |
|
||||
+------------------------+----------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_alignment<class_BoxContainer_get_alignment>` **(** **)** const |
|
||||
+------------------------+----------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_alignment<class_BoxContainer_set_alignment>` **(** :ref:`int<class_int>` alignment **)** |
|
||||
+------------------------+----------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -54,19 +54,19 @@ Member Function Description
|
||||
|
||||
.. _class_BoxContainer_add_spacer:
|
||||
|
||||
- void **add_spacer** **(** :ref:`bool<class_bool>` begin **)**
|
||||
- void **add_spacer** **(** :ref:`bool<class_bool>` begin **)**
|
||||
|
||||
Adds a control to the box as a spacer. If ``true``, *begin* will insert the spacer control in front of other children.
|
||||
|
||||
.. _class_BoxContainer_get_alignment:
|
||||
|
||||
- :ref:`int<class_int>` **get_alignment** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_alignment** **(** **)** const
|
||||
|
||||
Return the alignment of children in the container.
|
||||
|
||||
.. _class_BoxContainer_set_alignment:
|
||||
|
||||
- void **set_alignment** **(** :ref:`int<class_int>` alignment **)**
|
||||
- void **set_alignment** **(** :ref:`int<class_int>` alignment **)**
|
||||
|
||||
Set the alignment of children in the container(Must be one of ALIGN_BEGIN, ALIGN_CENTER or ALIGN_END).
|
||||
|
||||
|
||||
@@ -19,11 +19,11 @@ Box shape resource.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_extents<class_BoxShape_get_extents>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_extents<class_BoxShape_set_extents>` **(** :ref:`Vector3<class_vector3>` extents **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_extents<class_BoxShape_get_extents>` **(** **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_extents<class_BoxShape_set_extents>` **(** :ref:`Vector3<class_vector3>` extents **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -43,13 +43,13 @@ Member Function Description
|
||||
|
||||
.. _class_BoxShape_get_extents:
|
||||
|
||||
- :ref:`Vector3<class_vector3>` **get_extents** **(** **)** const
|
||||
- :ref:`Vector3<class_vector3>` **get_extents** **(** **)** const
|
||||
|
||||
Return the half extents of the shape.
|
||||
|
||||
.. _class_BoxShape_set_extents:
|
||||
|
||||
- void **set_extents** **(** :ref:`Vector3<class_vector3>` extents **)**
|
||||
- void **set_extents** **(** :ref:`Vector3<class_vector3>` extents **)**
|
||||
|
||||
Set the half extents for the shape.
|
||||
|
||||
|
||||
@@ -21,27 +21,27 @@ Standard themed Button.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Texture<class_texture>` | :ref:`get_button_icon<class_Button_get_button_icon>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_clip_text<class_Button_get_clip_text>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_text<class_Button_get_text>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_text_align<class_Button_get_text_align>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_flat<class_Button_is_flat>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_button_icon<class_Button_set_button_icon>` **(** :ref:`Texture<class_texture>` texture **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_clip_text<class_Button_set_clip_text>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_flat<class_Button_set_flat>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_text<class_Button_set_text>` **(** :ref:`String<class_string>` text **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_text_align<class_Button_set_text_align>` **(** :ref:`int<class_int>` align **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Texture<class_texture>` | :ref:`get_button_icon<class_Button_get_button_icon>` **(** **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_clip_text<class_Button_get_clip_text>` **(** **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_text<class_Button_get_text>` **(** **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_text_align<class_Button_get_text_align>` **(** **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_flat<class_Button_is_flat>` **(** **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_button_icon<class_Button_set_button_icon>` **(** :ref:`Texture<class_texture>` texture **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_clip_text<class_Button_set_clip_text>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_flat<class_Button_set_flat>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_text<class_Button_set_text>` **(** :ref:`String<class_string>` text **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_text_align<class_Button_set_text_align>` **(** :ref:`int<class_int>` align **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -84,42 +84,42 @@ Member Function Description
|
||||
|
||||
.. _class_Button_get_button_icon:
|
||||
|
||||
- :ref:`Texture<class_texture>` **get_button_icon** **(** **)** const
|
||||
- :ref:`Texture<class_texture>` **get_button_icon** **(** **)** const
|
||||
|
||||
.. _class_Button_get_clip_text:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_clip_text** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **get_clip_text** **(** **)** const
|
||||
|
||||
.. _class_Button_get_text:
|
||||
|
||||
- :ref:`String<class_string>` **get_text** **(** **)** const
|
||||
- :ref:`String<class_string>` **get_text** **(** **)** const
|
||||
|
||||
.. _class_Button_get_text_align:
|
||||
|
||||
- :ref:`int<class_int>` **get_text_align** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_text_align** **(** **)** const
|
||||
|
||||
.. _class_Button_is_flat:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_flat** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_flat** **(** **)** const
|
||||
|
||||
.. _class_Button_set_button_icon:
|
||||
|
||||
- void **set_button_icon** **(** :ref:`Texture<class_texture>` texture **)**
|
||||
- void **set_button_icon** **(** :ref:`Texture<class_texture>` texture **)**
|
||||
|
||||
.. _class_Button_set_clip_text:
|
||||
|
||||
- void **set_clip_text** **(** :ref:`bool<class_bool>` enabled **)**
|
||||
- void **set_clip_text** **(** :ref:`bool<class_bool>` enabled **)**
|
||||
|
||||
.. _class_Button_set_flat:
|
||||
|
||||
- void **set_flat** **(** :ref:`bool<class_bool>` enabled **)**
|
||||
- void **set_flat** **(** :ref:`bool<class_bool>` enabled **)**
|
||||
|
||||
.. _class_Button_set_text:
|
||||
|
||||
- void **set_text** **(** :ref:`String<class_string>` text **)**
|
||||
- void **set_text** **(** :ref:`String<class_string>` text **)**
|
||||
|
||||
.. _class_Button_set_text_align:
|
||||
|
||||
- void **set_text_align** **(** :ref:`int<class_int>` align **)**
|
||||
- void **set_text_align** **(** :ref:`int<class_int>` align **)**
|
||||
|
||||
|
||||
|
||||
@@ -19,9 +19,9 @@ Group of Buttons.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------------+------------------------------------------------------------------------------+
|
||||
| :ref:`BaseButton<class_basebutton>` | :ref:`get_pressed_button<class_ButtonGroup_get_pressed_button>` **(** **)** |
|
||||
+--------------------------------------+------------------------------------------------------------------------------+
|
||||
+--------------------------------------+-----------------------------------------------------------------------------+
|
||||
| :ref:`BaseButton<class_basebutton>` | :ref:`get_pressed_button<class_ButtonGroup_get_pressed_button>` **(** **)** |
|
||||
+--------------------------------------+-----------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -33,7 +33,7 @@ Member Function Description
|
||||
|
||||
.. _class_ButtonGroup_get_pressed_button:
|
||||
|
||||
- :ref:`BaseButton<class_basebutton>` **get_pressed_button** **(** **)**
|
||||
- :ref:`BaseButton<class_basebutton>` **get_pressed_button** **(** **)**
|
||||
|
||||
Return the pressed button.
|
||||
|
||||
|
||||
@@ -21,65 +21,65 @@ Camera node, displays from a point of view.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_current<class_Camera_clear_current>` **(** **)** |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform<class_transform>` | :ref:`get_camera_transform<class_Camera_get_camera_transform>` **(** **)** const |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_cull_mask<class_Camera_get_cull_mask>` **(** **)** const |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_doppler_tracking<class_Camera_get_doppler_tracking>` **(** **)** const |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Environment<class_environment>` | :ref:`get_environment<class_Camera_get_environment>` **(** **)** const |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_fov<class_Camera_get_fov>` **(** **)** const |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_h_offset<class_Camera_get_h_offset>` **(** **)** const |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_keep_aspect_mode<class_Camera_get_keep_aspect_mode>` **(** **)** const |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_projection<class_Camera_get_projection>` **(** **)** const |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_size<class_Camera_get_size>` **(** **)** const |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_v_offset<class_Camera_get_v_offset>` **(** **)** const |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_zfar<class_Camera_get_zfar>` **(** **)** const |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_znear<class_Camera_get_znear>` **(** **)** const |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_current<class_Camera_is_current>` **(** **)** const |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_position_behind<class_Camera_is_position_behind>` **(** :ref:`Vector3<class_vector3>` world_point **)** const |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`make_current<class_Camera_make_current>` **(** **)** |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`project_local_ray_normal<class_Camera_project_local_ray_normal>` **(** :ref:`Vector2<class_vector2>` screen_point **)** const |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`project_position<class_Camera_project_position>` **(** :ref:`Vector2<class_vector2>` screen_point **)** const |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`project_ray_normal<class_Camera_project_ray_normal>` **(** :ref:`Vector2<class_vector2>` screen_point **)** const |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`project_ray_origin<class_Camera_project_ray_origin>` **(** :ref:`Vector2<class_vector2>` screen_point **)** const |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_cull_mask<class_Camera_set_cull_mask>` **(** :ref:`int<class_int>` mask **)** |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_doppler_tracking<class_Camera_set_doppler_tracking>` **(** :ref:`int<class_int>` mode **)** |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_environment<class_Camera_set_environment>` **(** :ref:`Environment<class_environment>` env **)** |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_h_offset<class_Camera_set_h_offset>` **(** :ref:`float<class_float>` ofs **)** |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_keep_aspect_mode<class_Camera_set_keep_aspect_mode>` **(** :ref:`int<class_int>` mode **)** |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_orthogonal<class_Camera_set_orthogonal>` **(** :ref:`float<class_float>` size, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)** |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_perspective<class_Camera_set_perspective>` **(** :ref:`float<class_float>` fov, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)** |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_v_offset<class_Camera_set_v_offset>` **(** :ref:`float<class_float>` ofs **)** |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`unproject_position<class_Camera_unproject_position>` **(** :ref:`Vector3<class_vector3>` world_point **)** const |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_current<class_Camera_clear_current>` **(** **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform<class_transform>` | :ref:`get_camera_transform<class_Camera_get_camera_transform>` **(** **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_cull_mask<class_Camera_get_cull_mask>` **(** **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_doppler_tracking<class_Camera_get_doppler_tracking>` **(** **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Environment<class_environment>` | :ref:`get_environment<class_Camera_get_environment>` **(** **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_fov<class_Camera_get_fov>` **(** **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_h_offset<class_Camera_get_h_offset>` **(** **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_keep_aspect_mode<class_Camera_get_keep_aspect_mode>` **(** **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_projection<class_Camera_get_projection>` **(** **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_size<class_Camera_get_size>` **(** **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_v_offset<class_Camera_get_v_offset>` **(** **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_zfar<class_Camera_get_zfar>` **(** **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_znear<class_Camera_get_znear>` **(** **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_current<class_Camera_is_current>` **(** **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_position_behind<class_Camera_is_position_behind>` **(** :ref:`Vector3<class_vector3>` world_point **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`make_current<class_Camera_make_current>` **(** **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`project_local_ray_normal<class_Camera_project_local_ray_normal>` **(** :ref:`Vector2<class_vector2>` screen_point **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`project_position<class_Camera_project_position>` **(** :ref:`Vector2<class_vector2>` screen_point **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`project_ray_normal<class_Camera_project_ray_normal>` **(** :ref:`Vector2<class_vector2>` screen_point **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`project_ray_origin<class_Camera_project_ray_origin>` **(** :ref:`Vector2<class_vector2>` screen_point **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_cull_mask<class_Camera_set_cull_mask>` **(** :ref:`int<class_int>` mask **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_doppler_tracking<class_Camera_set_doppler_tracking>` **(** :ref:`int<class_int>` mode **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_environment<class_Camera_set_environment>` **(** :ref:`Environment<class_environment>` env **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_h_offset<class_Camera_set_h_offset>` **(** :ref:`float<class_float>` ofs **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_keep_aspect_mode<class_Camera_set_keep_aspect_mode>` **(** :ref:`int<class_int>` mode **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_orthogonal<class_Camera_set_orthogonal>` **(** :ref:`float<class_float>` size, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_perspective<class_Camera_set_perspective>` **(** :ref:`float<class_float>` fov, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_v_offset<class_Camera_set_v_offset>` **(** :ref:`float<class_float>` ofs **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`unproject_position<class_Camera_unproject_position>` **(** :ref:`Vector3<class_vector3>` world_point **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Numeric Constants
|
||||
-----------------
|
||||
@@ -102,169 +102,169 @@ Member Function Description
|
||||
|
||||
.. _class_Camera_clear_current:
|
||||
|
||||
- void **clear_current** **(** **)**
|
||||
- void **clear_current** **(** **)**
|
||||
|
||||
If this is the current Camera, remove it from being current. If it is inside the node tree, request to make the next Camera current, if any.
|
||||
|
||||
.. _class_Camera_get_camera_transform:
|
||||
|
||||
- :ref:`Transform<class_transform>` **get_camera_transform** **(** **)** const
|
||||
- :ref:`Transform<class_transform>` **get_camera_transform** **(** **)** const
|
||||
|
||||
Get the camera transform. Subclassed cameras (such as CharacterCamera) may provide different transforms than the :ref:`Node<class_node>` transform.
|
||||
|
||||
.. _class_Camera_get_cull_mask:
|
||||
|
||||
- :ref:`int<class_int>` **get_cull_mask** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_cull_mask** **(** **)** const
|
||||
|
||||
Returns the culling mask, describing which 3D render layers are rendered by this Camera.
|
||||
|
||||
.. _class_Camera_get_doppler_tracking:
|
||||
|
||||
- :ref:`int<class_int>` **get_doppler_tracking** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_doppler_tracking** **(** **)** const
|
||||
|
||||
.. _class_Camera_get_environment:
|
||||
|
||||
- :ref:`Environment<class_environment>` **get_environment** **(** **)** const
|
||||
- :ref:`Environment<class_environment>` **get_environment** **(** **)** const
|
||||
|
||||
Returns the :ref:`Environment<class_environment>` used by this Camera.
|
||||
|
||||
.. _class_Camera_get_fov:
|
||||
|
||||
- :ref:`float<class_float>` **get_fov** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_fov** **(** **)** const
|
||||
|
||||
Returns the *FOV* Y angle in degrees (FOV means Field of View).
|
||||
|
||||
.. _class_Camera_get_h_offset:
|
||||
|
||||
- :ref:`float<class_float>` **get_h_offset** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_h_offset** **(** **)** const
|
||||
|
||||
Returns the horizontal (X) offset of the Camera viewport.
|
||||
|
||||
.. _class_Camera_get_keep_aspect_mode:
|
||||
|
||||
- :ref:`int<class_int>` **get_keep_aspect_mode** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_keep_aspect_mode** **(** **)** const
|
||||
|
||||
Returns the current mode for keeping the aspect ratio. See ``KEEP\_\*`` constants.
|
||||
|
||||
.. _class_Camera_get_projection:
|
||||
|
||||
- :ref:`int<class_int>` **get_projection** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_projection** **(** **)** const
|
||||
|
||||
Returns the Camera's projection. See PROJECTION\_\* constants.
|
||||
|
||||
.. _class_Camera_get_size:
|
||||
|
||||
- :ref:`float<class_float>` **get_size** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_size** **(** **)** const
|
||||
|
||||
.. _class_Camera_get_v_offset:
|
||||
|
||||
- :ref:`float<class_float>` **get_v_offset** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_v_offset** **(** **)** const
|
||||
|
||||
Returns the vertical (Y) offset of the Camera viewport.
|
||||
|
||||
.. _class_Camera_get_zfar:
|
||||
|
||||
- :ref:`float<class_float>` **get_zfar** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_zfar** **(** **)** const
|
||||
|
||||
Returns the far clip plane in world space units.
|
||||
|
||||
.. _class_Camera_get_znear:
|
||||
|
||||
- :ref:`float<class_float>` **get_znear** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_znear** **(** **)** const
|
||||
|
||||
Returns the near clip plane in world space units.
|
||||
|
||||
.. _class_Camera_is_current:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_current** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_current** **(** **)** const
|
||||
|
||||
Returns ``true`` if the Camera is the current one in the :ref:`Viewport<class_viewport>`, or plans to become current (if outside the scene tree).
|
||||
|
||||
.. _class_Camera_is_position_behind:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_position_behind** **(** :ref:`Vector3<class_vector3>` world_point **)** const
|
||||
- :ref:`bool<class_bool>` **is_position_behind** **(** :ref:`Vector3<class_vector3>` world_point **)** const
|
||||
|
||||
Returns ``true`` if the given position is behind the Camera.
|
||||
|
||||
.. _class_Camera_make_current:
|
||||
|
||||
- void **make_current** **(** **)**
|
||||
- void **make_current** **(** **)**
|
||||
|
||||
Make this camera the current Camera for the :ref:`Viewport<class_viewport>` (see class description). If the Camera Node is outside the scene tree, it will attempt to become current once it's added.
|
||||
|
||||
.. _class_Camera_project_local_ray_normal:
|
||||
|
||||
- :ref:`Vector3<class_vector3>` **project_local_ray_normal** **(** :ref:`Vector2<class_vector2>` screen_point **)** const
|
||||
- :ref:`Vector3<class_vector3>` **project_local_ray_normal** **(** :ref:`Vector2<class_vector2>` screen_point **)** const
|
||||
|
||||
.. _class_Camera_project_position:
|
||||
|
||||
- :ref:`Vector3<class_vector3>` **project_position** **(** :ref:`Vector2<class_vector2>` screen_point **)** const
|
||||
- :ref:`Vector3<class_vector3>` **project_position** **(** :ref:`Vector2<class_vector2>` screen_point **)** const
|
||||
|
||||
Returns how a 2D coordinate in the Viewport rectangle maps to a 3D point in worldspace.
|
||||
|
||||
.. _class_Camera_project_ray_normal:
|
||||
|
||||
- :ref:`Vector3<class_vector3>` **project_ray_normal** **(** :ref:`Vector2<class_vector2>` screen_point **)** const
|
||||
- :ref:`Vector3<class_vector3>` **project_ray_normal** **(** :ref:`Vector2<class_vector2>` screen_point **)** const
|
||||
|
||||
Returns a normal vector in worldspace, that is the result of projecting a point on the :ref:`Viewport<class_viewport>` rectangle by the camera projection. This is useful for casting rays in the form of (origin, normal) for object intersection or picking.
|
||||
|
||||
.. _class_Camera_project_ray_origin:
|
||||
|
||||
- :ref:`Vector3<class_vector3>` **project_ray_origin** **(** :ref:`Vector2<class_vector2>` screen_point **)** const
|
||||
- :ref:`Vector3<class_vector3>` **project_ray_origin** **(** :ref:`Vector2<class_vector2>` screen_point **)** const
|
||||
|
||||
Returns a 3D position in worldspace, that is the result of projecting a point on the :ref:`Viewport<class_viewport>` rectangle by the camera projection. This is useful for casting rays in the form of (origin, normal) for object intersection or picking.
|
||||
|
||||
.. _class_Camera_set_cull_mask:
|
||||
|
||||
- void **set_cull_mask** **(** :ref:`int<class_int>` mask **)**
|
||||
- void **set_cull_mask** **(** :ref:`int<class_int>` mask **)**
|
||||
|
||||
Sets the cull mask, describing which 3D render layers are rendered by this Camera.
|
||||
|
||||
.. _class_Camera_set_doppler_tracking:
|
||||
|
||||
- void **set_doppler_tracking** **(** :ref:`int<class_int>` mode **)**
|
||||
- void **set_doppler_tracking** **(** :ref:`int<class_int>` mode **)**
|
||||
|
||||
Changes Doppler effect tracking. See ``DOPPLER\_\*`` constants.
|
||||
|
||||
.. _class_Camera_set_environment:
|
||||
|
||||
- void **set_environment** **(** :ref:`Environment<class_environment>` env **)**
|
||||
- void **set_environment** **(** :ref:`Environment<class_environment>` env **)**
|
||||
|
||||
Sets the :ref:`Environment<class_environment>` to use for this Camera.
|
||||
|
||||
.. _class_Camera_set_h_offset:
|
||||
|
||||
- void **set_h_offset** **(** :ref:`float<class_float>` ofs **)**
|
||||
- void **set_h_offset** **(** :ref:`float<class_float>` ofs **)**
|
||||
|
||||
Sets the horizontal (X) offset of the Camera viewport.
|
||||
|
||||
.. _class_Camera_set_keep_aspect_mode:
|
||||
|
||||
- void **set_keep_aspect_mode** **(** :ref:`int<class_int>` mode **)**
|
||||
- void **set_keep_aspect_mode** **(** :ref:`int<class_int>` mode **)**
|
||||
|
||||
Sets the mode for keeping the aspect ratio. See ``KEEP\_\*`` constants.
|
||||
|
||||
.. _class_Camera_set_orthogonal:
|
||||
|
||||
- void **set_orthogonal** **(** :ref:`float<class_float>` size, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)**
|
||||
- void **set_orthogonal** **(** :ref:`float<class_float>` size, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)**
|
||||
|
||||
Set the camera projection to orthogonal mode, by specifying a width and the *near* and *far* clip planes in worldspace units. (As a hint, 2D games often use this projection, with values specified in pixels)
|
||||
|
||||
.. _class_Camera_set_perspective:
|
||||
|
||||
- void **set_perspective** **(** :ref:`float<class_float>` fov, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)**
|
||||
- void **set_perspective** **(** :ref:`float<class_float>` fov, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)**
|
||||
|
||||
Set the camera projection to perspective mode, by specifying a *FOV* Y angle in degrees (FOV means Field of View), and the *near* and *far* clip planes in worldspace units.
|
||||
|
||||
.. _class_Camera_set_v_offset:
|
||||
|
||||
- void **set_v_offset** **(** :ref:`float<class_float>` ofs **)**
|
||||
- void **set_v_offset** **(** :ref:`float<class_float>` ofs **)**
|
||||
|
||||
Sets the vertical (Y) offset of the Camera viewport.
|
||||
|
||||
.. _class_Camera_unproject_position:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **unproject_position** **(** :ref:`Vector3<class_vector3>` world_point **)** const
|
||||
- :ref:`Vector2<class_vector2>` **unproject_position** **(** :ref:`Vector3<class_vector3>` world_point **)** const
|
||||
|
||||
Returns how a 3D point in worldspace maps to a 2D coordinate in the :ref:`Viewport<class_viewport>` rectangle.
|
||||
|
||||
|
||||
@@ -19,91 +19,91 @@ Camera node for 2D scenes.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`align<class_Camera2D_align>` **(** **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_current<class_Camera2D_clear_current>` **(** **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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:`Vector2<class_vector2>` | :ref:`get_camera_position<class_Camera2D_get_camera_position>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_camera_screen_center<class_Camera2D_get_camera_screen_center>` **(** **)** 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_follow_smoothing<class_Camera2D_get_follow_smoothing>` **(** **)** 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:`Vector2<class_vector2>` | :ref:`get_offset<class_Camera2D_get_offset>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_v_offset<class_Camera2D_get_v_offset>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_zoom<class_Camera2D_get_zoom>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_current<class_Camera2D_is_current>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_follow_smoothing_enabled<class_Camera2D_is_follow_smoothing_enabled>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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_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_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_v_drag_enabled<class_Camera2D_is_v_drag_enabled>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`make_current<class_Camera2D_make_current>` **(** **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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_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_enable_follow_smoothing<class_Camera2D_set_enable_follow_smoothing>` **(** :ref:`bool<class_bool>` follow_smoothing **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_follow_smoothing<class_Camera2D_set_follow_smoothing>` **(** :ref:`float<class_float>` follow_smoothing **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_h_drag_enabled<class_Camera2D_set_h_drag_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_h_offset<class_Camera2D_set_h_offset>` **(** :ref:`float<class_float>` ofs **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_limit<class_Camera2D_set_limit>` **(** :ref:`int<class_int>` margin, :ref:`int<class_int>` limit **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_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_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_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_v_drag_enabled<class_Camera2D_set_v_drag_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_v_offset<class_Camera2D_set_v_offset>` **(** :ref:`float<class_float>` ofs **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_zoom<class_Camera2D_set_zoom>` **(** :ref:`Vector2<class_vector2>` zoom **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`align<class_Camera2D_align>` **(** **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_current<class_Camera2D_clear_current>` **(** **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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:`Vector2<class_vector2>` | :ref:`get_camera_position<class_Camera2D_get_camera_position>` **(** **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_camera_screen_center<class_Camera2D_get_camera_screen_center>` **(** **)** 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_follow_smoothing<class_Camera2D_get_follow_smoothing>` **(** **)** 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:`Vector2<class_vector2>` | :ref:`get_offset<class_Camera2D_get_offset>` **(** **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_v_offset<class_Camera2D_get_v_offset>` **(** **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_zoom<class_Camera2D_get_zoom>` **(** **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_current<class_Camera2D_is_current>` **(** **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_follow_smoothing_enabled<class_Camera2D_is_follow_smoothing_enabled>` **(** **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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_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_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_v_drag_enabled<class_Camera2D_is_v_drag_enabled>` **(** **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`make_current<class_Camera2D_make_current>` **(** **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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_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_enable_follow_smoothing<class_Camera2D_set_enable_follow_smoothing>` **(** :ref:`bool<class_bool>` follow_smoothing **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_follow_smoothing<class_Camera2D_set_follow_smoothing>` **(** :ref:`float<class_float>` follow_smoothing **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_h_drag_enabled<class_Camera2D_set_h_drag_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_h_offset<class_Camera2D_set_h_offset>` **(** :ref:`float<class_float>` ofs **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_limit<class_Camera2D_set_limit>` **(** :ref:`int<class_int>` margin, :ref:`int<class_int>` limit **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_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_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_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_v_drag_enabled<class_Camera2D_set_v_drag_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_v_offset<class_Camera2D_set_v_offset>` **(** :ref:`float<class_float>` ofs **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_zoom<class_Camera2D_set_zoom>` **(** :ref:`Vector2<class_vector2>` zoom **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -211,119 +211,119 @@ Member Function Description
|
||||
|
||||
.. _class_Camera2D_align:
|
||||
|
||||
- void **align** **(** **)**
|
||||
- void **align** **(** **)**
|
||||
|
||||
Align the camera to the tracked node
|
||||
|
||||
.. _class_Camera2D_clear_current:
|
||||
|
||||
- void **clear_current** **(** **)**
|
||||
- void **clear_current** **(** **)**
|
||||
|
||||
.. _class_Camera2D_force_update_scroll:
|
||||
|
||||
- void **force_update_scroll** **(** **)**
|
||||
- void **force_update_scroll** **(** **)**
|
||||
|
||||
Force the camera to update scroll immediately.
|
||||
|
||||
.. _class_Camera2D_get_anchor_mode:
|
||||
|
||||
- :ref:`int<class_int>` **get_anchor_mode** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_anchor_mode** **(** **)** const
|
||||
|
||||
.. _class_Camera2D_get_camera_position:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **get_camera_position** **(** **)** const
|
||||
- :ref:`Vector2<class_vector2>` **get_camera_position** **(** **)** const
|
||||
|
||||
Return the camera position.
|
||||
|
||||
.. _class_Camera2D_get_camera_screen_center:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **get_camera_screen_center** **(** **)** const
|
||||
- :ref:`Vector2<class_vector2>` **get_camera_screen_center** **(** **)** const
|
||||
|
||||
.. _class_Camera2D_get_custom_viewport:
|
||||
|
||||
- :ref:`Node<class_node>` **get_custom_viewport** **(** **)** const
|
||||
- :ref:`Node<class_node>` **get_custom_viewport** **(** **)** const
|
||||
|
||||
.. _class_Camera2D_get_drag_margin:
|
||||
|
||||
- :ref:`float<class_float>` **get_drag_margin** **(** :ref:`int<class_int>` margin **)** const
|
||||
- :ref:`float<class_float>` **get_drag_margin** **(** :ref:`int<class_int>` margin **)** const
|
||||
|
||||
Return the margins needed to drag the camera (see :ref:`set_drag_margin<class_Camera2D_set_drag_margin>`).
|
||||
|
||||
.. _class_Camera2D_get_follow_smoothing:
|
||||
|
||||
- :ref:`float<class_float>` **get_follow_smoothing** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_follow_smoothing** **(** **)** const
|
||||
|
||||
.. _class_Camera2D_get_h_offset:
|
||||
|
||||
- :ref:`float<class_float>` **get_h_offset** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_h_offset** **(** **)** const
|
||||
|
||||
.. _class_Camera2D_get_limit:
|
||||
|
||||
- :ref:`int<class_int>` **get_limit** **(** :ref:`int<class_int>` margin **)** const
|
||||
- :ref:`int<class_int>` **get_limit** **(** :ref:`int<class_int>` margin **)** const
|
||||
|
||||
Return the scrolling limit in pixels.
|
||||
|
||||
.. _class_Camera2D_get_offset:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **get_offset** **(** **)** const
|
||||
- :ref:`Vector2<class_vector2>` **get_offset** **(** **)** const
|
||||
|
||||
Return the scroll offset.
|
||||
|
||||
.. _class_Camera2D_get_v_offset:
|
||||
|
||||
- :ref:`float<class_float>` **get_v_offset** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_v_offset** **(** **)** const
|
||||
|
||||
.. _class_Camera2D_get_zoom:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **get_zoom** **(** **)** const
|
||||
- :ref:`Vector2<class_vector2>` **get_zoom** **(** **)** const
|
||||
|
||||
.. _class_Camera2D_is_current:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_current** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_current** **(** **)** const
|
||||
|
||||
Return true of this is the current camera (see :ref:`make_current<class_Camera2D_make_current>`).
|
||||
|
||||
.. _class_Camera2D_is_follow_smoothing_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_follow_smoothing_enabled** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_follow_smoothing_enabled** **(** **)** const
|
||||
|
||||
.. _class_Camera2D_is_h_drag_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_h_drag_enabled** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_h_drag_enabled** **(** **)** const
|
||||
|
||||
.. _class_Camera2D_is_limit_drawing_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_limit_drawing_enabled** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_limit_drawing_enabled** **(** **)** const
|
||||
|
||||
.. _class_Camera2D_is_limit_smoothing_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_limit_smoothing_enabled** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_limit_smoothing_enabled** **(** **)** const
|
||||
|
||||
.. _class_Camera2D_is_margin_drawing_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_margin_drawing_enabled** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_margin_drawing_enabled** **(** **)** const
|
||||
|
||||
.. _class_Camera2D_is_rotating:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_rotating** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_rotating** **(** **)** const
|
||||
|
||||
.. _class_Camera2D_is_screen_drawing_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_screen_drawing_enabled** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_screen_drawing_enabled** **(** **)** const
|
||||
|
||||
.. _class_Camera2D_is_v_drag_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_v_drag_enabled** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_v_drag_enabled** **(** **)** const
|
||||
|
||||
.. _class_Camera2D_make_current:
|
||||
|
||||
- void **make_current** **(** **)**
|
||||
- void **make_current** **(** **)**
|
||||
|
||||
Make this the current 2D camera for the scene (viewport and layer), in case there's many cameras in the scene.
|
||||
|
||||
.. _class_Camera2D_reset_smoothing:
|
||||
|
||||
- void **reset_smoothing** **(** **)**
|
||||
- void **reset_smoothing** **(** **)**
|
||||
|
||||
Set the camera's position immediately to its current smoothing destination.
|
||||
|
||||
@@ -331,47 +331,47 @@ This has no effect if smoothing is disabled.
|
||||
|
||||
.. _class_Camera2D_set_anchor_mode:
|
||||
|
||||
- void **set_anchor_mode** **(** :ref:`int<class_int>` anchor_mode **)**
|
||||
- void **set_anchor_mode** **(** :ref:`int<class_int>` anchor_mode **)**
|
||||
|
||||
.. _class_Camera2D_set_custom_viewport:
|
||||
|
||||
- void **set_custom_viewport** **(** :ref:`Node<class_node>` viewport **)**
|
||||
- void **set_custom_viewport** **(** :ref:`Node<class_node>` viewport **)**
|
||||
|
||||
.. _class_Camera2D_set_drag_margin:
|
||||
|
||||
- void **set_drag_margin** **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` drag_margin **)**
|
||||
- void **set_drag_margin** **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` drag_margin **)**
|
||||
|
||||
Set the margins needed to drag the camera (relative to the screen size). Margin uses the MARGIN\_\* enum. Drag margins of 0,0,0,0 will keep the camera at the center of the screen, while drag margins of 1,1,1,1 will only move when the camera is at the edges.
|
||||
|
||||
.. _class_Camera2D_set_enable_follow_smoothing:
|
||||
|
||||
- void **set_enable_follow_smoothing** **(** :ref:`bool<class_bool>` follow_smoothing **)**
|
||||
- void **set_enable_follow_smoothing** **(** :ref:`bool<class_bool>` follow_smoothing **)**
|
||||
|
||||
.. _class_Camera2D_set_follow_smoothing:
|
||||
|
||||
- void **set_follow_smoothing** **(** :ref:`float<class_float>` follow_smoothing **)**
|
||||
- void **set_follow_smoothing** **(** :ref:`float<class_float>` follow_smoothing **)**
|
||||
|
||||
.. _class_Camera2D_set_h_drag_enabled:
|
||||
|
||||
- void **set_h_drag_enabled** **(** :ref:`bool<class_bool>` enabled **)**
|
||||
- void **set_h_drag_enabled** **(** :ref:`bool<class_bool>` enabled **)**
|
||||
|
||||
.. _class_Camera2D_set_h_offset:
|
||||
|
||||
- void **set_h_offset** **(** :ref:`float<class_float>` ofs **)**
|
||||
- void **set_h_offset** **(** :ref:`float<class_float>` ofs **)**
|
||||
|
||||
.. _class_Camera2D_set_limit:
|
||||
|
||||
- void **set_limit** **(** :ref:`int<class_int>` margin, :ref:`int<class_int>` limit **)**
|
||||
- void **set_limit** **(** :ref:`int<class_int>` margin, :ref:`int<class_int>` limit **)**
|
||||
|
||||
Set the scrolling limit in pixels.
|
||||
|
||||
.. _class_Camera2D_set_limit_drawing_enabled:
|
||||
|
||||
- void **set_limit_drawing_enabled** **(** :ref:`bool<class_bool>` limit_drawing_enabled **)**
|
||||
- void **set_limit_drawing_enabled** **(** :ref:`bool<class_bool>` limit_drawing_enabled **)**
|
||||
|
||||
.. _class_Camera2D_set_limit_smoothing_enabled:
|
||||
|
||||
- void **set_limit_smoothing_enabled** **(** :ref:`bool<class_bool>` limit_smoothing_enabled **)**
|
||||
- void **set_limit_smoothing_enabled** **(** :ref:`bool<class_bool>` limit_smoothing_enabled **)**
|
||||
|
||||
Smooth camera when reaching camera limits.
|
||||
|
||||
@@ -379,32 +379,32 @@ This requires camera smoothing being enabled to have a noticeable effect.
|
||||
|
||||
.. _class_Camera2D_set_margin_drawing_enabled:
|
||||
|
||||
- void **set_margin_drawing_enabled** **(** :ref:`bool<class_bool>` margin_drawing_enabled **)**
|
||||
- void **set_margin_drawing_enabled** **(** :ref:`bool<class_bool>` margin_drawing_enabled **)**
|
||||
|
||||
.. _class_Camera2D_set_offset:
|
||||
|
||||
- void **set_offset** **(** :ref:`Vector2<class_vector2>` offset **)**
|
||||
- void **set_offset** **(** :ref:`Vector2<class_vector2>` offset **)**
|
||||
|
||||
Set the scroll offset. Useful for looking around or camera shake animations.
|
||||
|
||||
.. _class_Camera2D_set_rotating:
|
||||
|
||||
- void **set_rotating** **(** :ref:`bool<class_bool>` rotating **)**
|
||||
- void **set_rotating** **(** :ref:`bool<class_bool>` rotating **)**
|
||||
|
||||
.. _class_Camera2D_set_screen_drawing_enabled:
|
||||
|
||||
- void **set_screen_drawing_enabled** **(** :ref:`bool<class_bool>` screen_drawing_enabled **)**
|
||||
- void **set_screen_drawing_enabled** **(** :ref:`bool<class_bool>` screen_drawing_enabled **)**
|
||||
|
||||
.. _class_Camera2D_set_v_drag_enabled:
|
||||
|
||||
- void **set_v_drag_enabled** **(** :ref:`bool<class_bool>` enabled **)**
|
||||
- void **set_v_drag_enabled** **(** :ref:`bool<class_bool>` enabled **)**
|
||||
|
||||
.. _class_Camera2D_set_v_offset:
|
||||
|
||||
- void **set_v_offset** **(** :ref:`float<class_float>` ofs **)**
|
||||
- void **set_v_offset** **(** :ref:`float<class_float>` ofs **)**
|
||||
|
||||
.. _class_Camera2D_set_zoom:
|
||||
|
||||
- void **set_zoom** **(** :ref:`Vector2<class_vector2>` zoom **)**
|
||||
- void **set_zoom** **(** :ref:`Vector2<class_vector2>` zoom **)**
|
||||
|
||||
|
||||
|
||||
@@ -21,152 +21,152 @@ Base class of anything 2D.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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>` position, :ref:`String<class_string>` char, :ref:`String<class_string>` next, :ref:`Color<class_color>` modulate=Color( 1, 1, 1, 1 ) **)** |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_circle<class_CanvasItem_draw_circle>` **(** :ref:`Vector2<class_vector2>` position, :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, :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=1.0, :ref:`bool<class_bool>` antialiased=false **)** |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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, :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=1.0, :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=1.0, :ref:`bool<class_bool>` antialiased=false **)** |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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.0, :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_set_transform<class_CanvasItem_draw_set_transform>` **(** :ref:`Vector2<class_vector2>` position, :ref:`float<class_float>` rotation, :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_string<class_CanvasItem_draw_string>` **(** :ref:`Font<class_font>` font, :ref:`Vector2<class_vector2>` position, :ref:`String<class_string>` text, :ref:`Color<class_color>` modulate=Color( 1, 1, 1, 1 ), :ref:`int<class_int>` clip_w=-1 **)** |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_style_box<class_CanvasItem_draw_style_box>` **(** :ref:`StyleBox<class_stylebox>` style_box, :ref:`Rect2<class_rect2>` rect **)** |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_texture<class_CanvasItem_draw_texture>` **(** :ref:`Texture<class_texture>` texture, :ref:`Vector2<class_vector2>` position, :ref:`Color<class_color>` modulate=Color( 1, 1, 1, 1 ), :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_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 **)** |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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_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 **)** |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`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:`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:`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:`int<class_int>` | :ref:`get_light_mask<class_CanvasItem_get_light_mask>` **(** **)** const |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_local_mouse_position<class_CanvasItem_get_local_mouse_position>` **(** **)** 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_self_modulate<class_CanvasItem_get_self_modulate>` **(** **)** 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:`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:`World2D<class_world2d>` | :ref:`get_world_2d<class_CanvasItem_get_world_2d>` **(** **)** const |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`hide<class_CanvasItem_hide>` **(** **)** |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_draw_behind_parent_enabled<class_CanvasItem_is_draw_behind_parent_enabled>` **(** **)** const |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_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_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_in_tree<class_CanvasItem_is_visible_in_tree>` **(** **)** const |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`make_canvas_position_local<class_CanvasItem_make_canvas_position_local>` **(** :ref:`Vector2<class_vector2>` screen_point **)** 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_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_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_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_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_visible<class_CanvasItem_set_visible>` **(** :ref:`bool<class_bool>` visible **)** |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`show<class_CanvasItem_show>` **(** **)** |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`update<class_CanvasItem_update>` **(** **)** |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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>` position, :ref:`String<class_string>` char, :ref:`String<class_string>` next, :ref:`Color<class_color>` modulate=Color( 1, 1, 1, 1 ) **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_circle<class_CanvasItem_draw_circle>` **(** :ref:`Vector2<class_vector2>` position, :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, :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=1.0, :ref:`bool<class_bool>` antialiased=false **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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, :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=1.0, :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=1.0, :ref:`bool<class_bool>` antialiased=false **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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.0, :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_set_transform<class_CanvasItem_draw_set_transform>` **(** :ref:`Vector2<class_vector2>` position, :ref:`float<class_float>` rotation, :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_string<class_CanvasItem_draw_string>` **(** :ref:`Font<class_font>` font, :ref:`Vector2<class_vector2>` position, :ref:`String<class_string>` text, :ref:`Color<class_color>` modulate=Color( 1, 1, 1, 1 ), :ref:`int<class_int>` clip_w=-1 **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_style_box<class_CanvasItem_draw_style_box>` **(** :ref:`StyleBox<class_stylebox>` style_box, :ref:`Rect2<class_rect2>` rect **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`draw_texture<class_CanvasItem_draw_texture>` **(** :ref:`Texture<class_texture>` texture, :ref:`Vector2<class_vector2>` position, :ref:`Color<class_color>` modulate=Color( 1, 1, 1, 1 ), :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_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 **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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_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 **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`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:`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:`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:`int<class_int>` | :ref:`get_light_mask<class_CanvasItem_get_light_mask>` **(** **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_local_mouse_position<class_CanvasItem_get_local_mouse_position>` **(** **)** 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_self_modulate<class_CanvasItem_get_self_modulate>` **(** **)** 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:`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:`World2D<class_world2d>` | :ref:`get_world_2d<class_CanvasItem_get_world_2d>` **(** **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`hide<class_CanvasItem_hide>` **(** **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_draw_behind_parent_enabled<class_CanvasItem_is_draw_behind_parent_enabled>` **(** **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_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_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_in_tree<class_CanvasItem_is_visible_in_tree>` **(** **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`make_canvas_position_local<class_CanvasItem_make_canvas_position_local>` **(** :ref:`Vector2<class_vector2>` screen_point **)** 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_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_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_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_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_visible<class_CanvasItem_set_visible>` **(** :ref:`bool<class_bool>` visible **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`show<class_CanvasItem_show>` **(** **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`update<class_CanvasItem_update>` **(** **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_CanvasItem_draw:
|
||||
|
||||
- **draw** **(** **)**
|
||||
- **draw** **(** **)**
|
||||
|
||||
Emitted when the CanvasItem must redraw. This can only be connected realtime, as deferred will not allow drawing.
|
||||
|
||||
.. _class_CanvasItem_hide:
|
||||
|
||||
- **hide** **(** **)**
|
||||
- **hide** **(** **)**
|
||||
|
||||
Emitted when becoming hidden.
|
||||
|
||||
.. _class_CanvasItem_item_rect_changed:
|
||||
|
||||
- **item_rect_changed** **(** **)**
|
||||
- **item_rect_changed** **(** **)**
|
||||
|
||||
Emitted when the item rect has changed.
|
||||
|
||||
.. _class_CanvasItem_visibility_changed:
|
||||
|
||||
- **visibility_changed** **(** **)**
|
||||
- **visibility_changed** **(** **)**
|
||||
|
||||
Emitted when the visibility (hidden/visible) changes.
|
||||
|
||||
@@ -239,327 +239,327 @@ Member Function Description
|
||||
|
||||
.. _class_CanvasItem__draw:
|
||||
|
||||
- void **_draw** **(** **)** virtual
|
||||
- void **_draw** **(** **)** virtual
|
||||
|
||||
Called (if exists) to draw the canvas item.
|
||||
|
||||
.. _class_CanvasItem_draw_char:
|
||||
|
||||
- :ref:`float<class_float>` **draw_char** **(** :ref:`Font<class_font>` font, :ref:`Vector2<class_vector2>` position, :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>` position, :ref:`String<class_string>` char, :ref:`String<class_string>` next, :ref:`Color<class_color>` modulate=Color( 1, 1, 1, 1 ) **)**
|
||||
|
||||
Draw a string character using a custom font. Returns the advance, depending on the char width and kerning with an optional next char.
|
||||
|
||||
.. _class_CanvasItem_draw_circle:
|
||||
|
||||
- void **draw_circle** **(** :ref:`Vector2<class_vector2>` position, :ref:`float<class_float>` radius, :ref:`Color<class_color>` color **)**
|
||||
- void **draw_circle** **(** :ref:`Vector2<class_vector2>` position, :ref:`float<class_float>` radius, :ref:`Color<class_color>` color **)**
|
||||
|
||||
Draw a colored circle.
|
||||
|
||||
.. _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, :ref:`bool<class_bool>` antialiased=false **)**
|
||||
- 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, :ref:`bool<class_bool>` antialiased=false **)**
|
||||
|
||||
Draw a colored polygon of any amount of points, convex or concave.
|
||||
|
||||
.. _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.0, :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=1.0, :ref:`bool<class_bool>` antialiased=false **)**
|
||||
|
||||
Draw a line from a 2D point to another, with a given color and width. It can be optionally antialiased.
|
||||
|
||||
.. _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, :ref:`bool<class_bool>` antialiased=false **)**
|
||||
- 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, :ref:`bool<class_bool>` antialiased=false **)**
|
||||
|
||||
Draw a polygon of any amount of points, convex or concave.
|
||||
|
||||
.. _class_CanvasItem_draw_polyline:
|
||||
|
||||
- void **draw_polyline** **(** :ref:`PoolVector2Array<class_poolvector2array>` points, :ref:`Color<class_color>` color, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)**
|
||||
- void **draw_polyline** **(** :ref:`PoolVector2Array<class_poolvector2array>` points, :ref:`Color<class_color>` color, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)**
|
||||
|
||||
.. _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.0, :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=1.0, :ref:`bool<class_bool>` antialiased=false **)**
|
||||
|
||||
.. _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.0, :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=1.0, :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.
|
||||
|
||||
.. _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=true **)**
|
||||
|
||||
Draw a colored rectangle.
|
||||
|
||||
.. _class_CanvasItem_draw_set_transform:
|
||||
|
||||
- void **draw_set_transform** **(** :ref:`Vector2<class_vector2>` position, :ref:`float<class_float>` rotation, :ref:`Vector2<class_vector2>` scale **)**
|
||||
- void **draw_set_transform** **(** :ref:`Vector2<class_vector2>` position, :ref:`float<class_float>` rotation, :ref:`Vector2<class_vector2>` scale **)**
|
||||
|
||||
Set a custom transform for drawing. Anything drawn afterwards will be transformed by this.
|
||||
|
||||
.. _class_CanvasItem_draw_set_transform_matrix:
|
||||
|
||||
- void **draw_set_transform_matrix** **(** :ref:`Transform2D<class_transform2d>` xform **)**
|
||||
- void **draw_set_transform_matrix** **(** :ref:`Transform2D<class_transform2d>` xform **)**
|
||||
|
||||
.. _class_CanvasItem_draw_string:
|
||||
|
||||
- void **draw_string** **(** :ref:`Font<class_font>` font, :ref:`Vector2<class_vector2>` position, :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>` position, :ref:`String<class_string>` text, :ref:`Color<class_color>` modulate=Color( 1, 1, 1, 1 ), :ref:`int<class_int>` clip_w=-1 **)**
|
||||
|
||||
Draw a string using a custom font.
|
||||
|
||||
.. _class_CanvasItem_draw_style_box:
|
||||
|
||||
- void **draw_style_box** **(** :ref:`StyleBox<class_stylebox>` style_box, :ref:`Rect2<class_rect2>` rect **)**
|
||||
- void **draw_style_box** **(** :ref:`StyleBox<class_stylebox>` style_box, :ref:`Rect2<class_rect2>` rect **)**
|
||||
|
||||
Draw a styled rectangle.
|
||||
|
||||
.. _class_CanvasItem_draw_texture:
|
||||
|
||||
- void **draw_texture** **(** :ref:`Texture<class_texture>` texture, :ref:`Vector2<class_vector2>` position, :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>` position, :ref:`Color<class_color>` modulate=Color( 1, 1, 1, 1 ), :ref:`Texture<class_texture>` normal_map=null **)**
|
||||
|
||||
Draw a texture at a given position.
|
||||
|
||||
.. _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=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=false, :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.
|
||||
|
||||
.. _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=false, :ref:`Texture<class_texture>` normal_map=null, :ref:`bool<class_bool>` clip_uv=true **)**
|
||||
|
||||
Draw a textured rectangle region at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture.
|
||||
|
||||
.. _class_CanvasItem_edit_get_state:
|
||||
|
||||
- :ref:`Variant<class_variant>` **edit_get_state** **(** **)** const
|
||||
- :ref:`Variant<class_variant>` **edit_get_state** **(** **)** const
|
||||
|
||||
Used for editing, returns an opaque value representing the transform state.
|
||||
|
||||
.. _class_CanvasItem_edit_rotate:
|
||||
|
||||
- void **edit_rotate** **(** :ref:`float<class_float>` degrees **)**
|
||||
- void **edit_rotate** **(** :ref:`float<class_float>` degrees **)**
|
||||
|
||||
Used for editing, handle rotation.
|
||||
|
||||
.. _class_CanvasItem_edit_set_rect:
|
||||
|
||||
- void **edit_set_rect** **(** :ref:`Rect2<class_rect2>` rect **)**
|
||||
- void **edit_set_rect** **(** :ref:`Rect2<class_rect2>` rect **)**
|
||||
|
||||
.. _class_CanvasItem_edit_set_state:
|
||||
|
||||
- void **edit_set_state** **(** :ref:`Variant<class_variant>` state **)**
|
||||
- void **edit_set_state** **(** :ref:`Variant<class_variant>` state **)**
|
||||
|
||||
Set the transform state of this CanvasItem. For :ref:`Node2D<class_node2d>`, this is an :ref:`Array<class_array>` with (in order) a :ref:`Vector2<class_vector2>` for position, a float for rotation (radians) and another :ref:`Vector2<class_vector2>` for scale. For :ref:`Control<class_control>` this is a :ref:`Rect2<class_rect2>` with the position and size.
|
||||
|
||||
.. _class_CanvasItem_get_canvas:
|
||||
|
||||
- :ref:`RID<class_rid>` **get_canvas** **(** **)** const
|
||||
- :ref:`RID<class_rid>` **get_canvas** **(** **)** const
|
||||
|
||||
Return the :ref:`RID<class_rid>` of the :ref:`World2D<class_world2d>` canvas where this item is in.
|
||||
|
||||
.. _class_CanvasItem_get_canvas_item:
|
||||
|
||||
- :ref:`RID<class_rid>` **get_canvas_item** **(** **)** const
|
||||
- :ref:`RID<class_rid>` **get_canvas_item** **(** **)** const
|
||||
|
||||
Return the canvas item RID used by :ref:`VisualServer<class_visualserver>` for this item.
|
||||
|
||||
.. _class_CanvasItem_get_canvas_transform:
|
||||
|
||||
- :ref:`Transform2D<class_transform2d>` **get_canvas_transform** **(** **)** const
|
||||
- :ref:`Transform2D<class_transform2d>` **get_canvas_transform** **(** **)** const
|
||||
|
||||
Get the transform matrix of this item's canvas.
|
||||
|
||||
.. _class_CanvasItem_get_global_mouse_position:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **get_global_mouse_position** **(** **)** const
|
||||
- :ref:`Vector2<class_vector2>` **get_global_mouse_position** **(** **)** const
|
||||
|
||||
Get the global position of the mouse.
|
||||
|
||||
.. _class_CanvasItem_get_global_transform:
|
||||
|
||||
- :ref:`Transform2D<class_transform2d>` **get_global_transform** **(** **)** const
|
||||
- :ref:`Transform2D<class_transform2d>` **get_global_transform** **(** **)** const
|
||||
|
||||
Get the global transform matrix of this item.
|
||||
|
||||
.. _class_CanvasItem_get_global_transform_with_canvas:
|
||||
|
||||
- :ref:`Transform2D<class_transform2d>` **get_global_transform_with_canvas** **(** **)** const
|
||||
- :ref:`Transform2D<class_transform2d>` **get_global_transform_with_canvas** **(** **)** const
|
||||
|
||||
Get the global transform matrix of this item in relation to the canvas.
|
||||
|
||||
.. _class_CanvasItem_get_item_and_children_rect:
|
||||
|
||||
- :ref:`Rect2<class_rect2>` **get_item_and_children_rect** **(** **)** const
|
||||
- :ref:`Rect2<class_rect2>` **get_item_and_children_rect** **(** **)** const
|
||||
|
||||
Get a :ref:`Rect2<class_rect2>` with the boundaries of this item and its children.
|
||||
|
||||
.. _class_CanvasItem_get_item_rect:
|
||||
|
||||
- :ref:`Rect2<class_rect2>` **get_item_rect** **(** **)** const
|
||||
- :ref:`Rect2<class_rect2>` **get_item_rect** **(** **)** const
|
||||
|
||||
Return a rect containing the editable boundaries of the item.
|
||||
|
||||
.. _class_CanvasItem_get_light_mask:
|
||||
|
||||
- :ref:`int<class_int>` **get_light_mask** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_light_mask** **(** **)** const
|
||||
|
||||
Get this item's light mask number.
|
||||
|
||||
.. _class_CanvasItem_get_local_mouse_position:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **get_local_mouse_position** **(** **)** const
|
||||
- :ref:`Vector2<class_vector2>` **get_local_mouse_position** **(** **)** const
|
||||
|
||||
Get the mouse position relative to this item's position.
|
||||
|
||||
.. _class_CanvasItem_get_material:
|
||||
|
||||
- :ref:`Material<class_material>` **get_material** **(** **)** const
|
||||
- :ref:`Material<class_material>` **get_material** **(** **)** const
|
||||
|
||||
Get the material of this item.
|
||||
|
||||
.. _class_CanvasItem_get_modulate:
|
||||
|
||||
- :ref:`Color<class_color>` **get_modulate** **(** **)** const
|
||||
- :ref:`Color<class_color>` **get_modulate** **(** **)** const
|
||||
|
||||
Get the modulate of the CanvasItem, which affects children items too.
|
||||
|
||||
.. _class_CanvasItem_get_self_modulate:
|
||||
|
||||
- :ref:`Color<class_color>` **get_self_modulate** **(** **)** const
|
||||
- :ref:`Color<class_color>` **get_self_modulate** **(** **)** const
|
||||
|
||||
Get the self-modulate of the CanvasItem.
|
||||
|
||||
.. _class_CanvasItem_get_transform:
|
||||
|
||||
- :ref:`Transform2D<class_transform2d>` **get_transform** **(** **)** const
|
||||
- :ref:`Transform2D<class_transform2d>` **get_transform** **(** **)** const
|
||||
|
||||
Get the transform matrix of this item.
|
||||
|
||||
.. _class_CanvasItem_get_use_parent_material:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_use_parent_material** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **get_use_parent_material** **(** **)** const
|
||||
|
||||
Get whether this item uses its parent's material.
|
||||
|
||||
.. _class_CanvasItem_get_viewport_rect:
|
||||
|
||||
- :ref:`Rect2<class_rect2>` **get_viewport_rect** **(** **)** const
|
||||
- :ref:`Rect2<class_rect2>` **get_viewport_rect** **(** **)** const
|
||||
|
||||
Get the viewport's boundaries as a :ref:`Rect2<class_rect2>`.
|
||||
|
||||
.. _class_CanvasItem_get_viewport_transform:
|
||||
|
||||
- :ref:`Transform2D<class_transform2d>` **get_viewport_transform** **(** **)** const
|
||||
- :ref:`Transform2D<class_transform2d>` **get_viewport_transform** **(** **)** const
|
||||
|
||||
Get this item's transform in relation to the viewport.
|
||||
|
||||
.. _class_CanvasItem_get_world_2d:
|
||||
|
||||
- :ref:`World2D<class_world2d>` **get_world_2d** **(** **)** const
|
||||
- :ref:`World2D<class_world2d>` **get_world_2d** **(** **)** const
|
||||
|
||||
Get the :ref:`World2D<class_world2d>` where this item is in.
|
||||
|
||||
.. _class_CanvasItem_hide:
|
||||
|
||||
- void **hide** **(** **)**
|
||||
- void **hide** **(** **)**
|
||||
|
||||
Hide the CanvasItem currently visible.
|
||||
|
||||
.. _class_CanvasItem_is_draw_behind_parent_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_draw_behind_parent_enabled** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_draw_behind_parent_enabled** **(** **)** const
|
||||
|
||||
Return whether the item is drawn behind its parent.
|
||||
|
||||
.. _class_CanvasItem_is_local_transform_notification_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_local_transform_notification_enabled** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_local_transform_notification_enabled** **(** **)** const
|
||||
|
||||
.. _class_CanvasItem_is_set_as_toplevel:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_set_as_toplevel** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_set_as_toplevel** **(** **)** const
|
||||
|
||||
Return if set as toplevel. See :ref:`set_as_toplevel<class_CanvasItem_set_as_toplevel>`.
|
||||
|
||||
.. _class_CanvasItem_is_transform_notification_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_transform_notification_enabled** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_transform_notification_enabled** **(** **)** const
|
||||
|
||||
.. _class_CanvasItem_is_visible:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_visible** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_visible** **(** **)** const
|
||||
|
||||
Return true if this CanvasItem is visible. It may be invisible because itself or a parent canvas item is hidden.
|
||||
|
||||
.. _class_CanvasItem_is_visible_in_tree:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_visible_in_tree** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_visible_in_tree** **(** **)** const
|
||||
|
||||
.. _class_CanvasItem_make_canvas_position_local:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **make_canvas_position_local** **(** :ref:`Vector2<class_vector2>` screen_point **)** const
|
||||
- :ref:`Vector2<class_vector2>` **make_canvas_position_local** **(** :ref:`Vector2<class_vector2>` screen_point **)** const
|
||||
|
||||
.. _class_CanvasItem_make_input_local:
|
||||
|
||||
- :ref:`InputEvent<class_inputevent>` **make_input_local** **(** :ref:`InputEvent<class_inputevent>` event **)** const
|
||||
- :ref:`InputEvent<class_inputevent>` **make_input_local** **(** :ref:`InputEvent<class_inputevent>` event **)** const
|
||||
|
||||
.. _class_CanvasItem_set_as_toplevel:
|
||||
|
||||
- void **set_as_toplevel** **(** :ref:`bool<class_bool>` enable **)**
|
||||
- void **set_as_toplevel** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
Set as top level. This means that it will not inherit transform from parent canvas items.
|
||||
|
||||
.. _class_CanvasItem_set_draw_behind_parent:
|
||||
|
||||
- void **set_draw_behind_parent** **(** :ref:`bool<class_bool>` enable **)**
|
||||
- void **set_draw_behind_parent** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
Set whether the canvas item is drawn behind its parent.
|
||||
|
||||
.. _class_CanvasItem_set_light_mask:
|
||||
|
||||
- void **set_light_mask** **(** :ref:`int<class_int>` light_mask **)**
|
||||
- void **set_light_mask** **(** :ref:`int<class_int>` light_mask **)**
|
||||
|
||||
Set the ligtht mask number of this item.
|
||||
|
||||
.. _class_CanvasItem_set_material:
|
||||
|
||||
- void **set_material** **(** :ref:`Material<class_material>` material **)**
|
||||
- void **set_material** **(** :ref:`Material<class_material>` material **)**
|
||||
|
||||
Set the material of this item.
|
||||
|
||||
.. _class_CanvasItem_set_modulate:
|
||||
|
||||
- void **set_modulate** **(** :ref:`Color<class_color>` modulate **)**
|
||||
- void **set_modulate** **(** :ref:`Color<class_color>` modulate **)**
|
||||
|
||||
Set the modulate of the CanvasItem. This *affects* the modulation of children items.
|
||||
|
||||
.. _class_CanvasItem_set_notify_local_transform:
|
||||
|
||||
- void **set_notify_local_transform** **(** :ref:`bool<class_bool>` enable **)**
|
||||
- void **set_notify_local_transform** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
.. _class_CanvasItem_set_notify_transform:
|
||||
|
||||
- void **set_notify_transform** **(** :ref:`bool<class_bool>` enable **)**
|
||||
- void **set_notify_transform** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
.. _class_CanvasItem_set_self_modulate:
|
||||
|
||||
- void **set_self_modulate** **(** :ref:`Color<class_color>` self_modulate **)**
|
||||
- void **set_self_modulate** **(** :ref:`Color<class_color>` self_modulate **)**
|
||||
|
||||
Set the self-modulate of the CanvasItem. This does not affect the modulation of children items.
|
||||
|
||||
.. _class_CanvasItem_set_use_parent_material:
|
||||
|
||||
- void **set_use_parent_material** **(** :ref:`bool<class_bool>` enable **)**
|
||||
- void **set_use_parent_material** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
Set whether or not this item should use its parent's material.
|
||||
|
||||
.. _class_CanvasItem_set_visible:
|
||||
|
||||
- void **set_visible** **(** :ref:`bool<class_bool>` visible **)**
|
||||
- void **set_visible** **(** :ref:`bool<class_bool>` visible **)**
|
||||
|
||||
Set whether this item should be visible or not.
|
||||
|
||||
@@ -567,13 +567,13 @@ Note that a hidden CanvasItem will make all children hidden too, so no matter wh
|
||||
|
||||
.. _class_CanvasItem_show:
|
||||
|
||||
- void **show** **(** **)**
|
||||
- void **show** **(** **)**
|
||||
|
||||
Show the CanvasItem currently hidden.
|
||||
|
||||
.. _class_CanvasItem_update:
|
||||
|
||||
- void **update** **(** **)**
|
||||
- void **update** **(** **)**
|
||||
|
||||
Queue the CanvasItem for update. ``NOTIFICATION_DRAW`` will be called on idle time to request redraw.
|
||||
|
||||
|
||||
@@ -19,15 +19,15 @@ Brief Description
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_blend_mode<class_CanvasItemMaterial_get_blend_mode>` **(** **)** const |
|
||||
+------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_light_mode<class_CanvasItemMaterial_get_light_mode>` **(** **)** const |
|
||||
+------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_blend_mode<class_CanvasItemMaterial_set_blend_mode>` **(** :ref:`int<class_int>` blend_mode **)** |
|
||||
+------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_light_mode<class_CanvasItemMaterial_set_light_mode>` **(** :ref:`int<class_int>` light_mode **)** |
|
||||
+------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_blend_mode<class_CanvasItemMaterial_get_blend_mode>` **(** **)** const |
|
||||
+------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_light_mode<class_CanvasItemMaterial_get_light_mode>` **(** **)** const |
|
||||
+------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_blend_mode<class_CanvasItemMaterial_set_blend_mode>` **(** :ref:`int<class_int>` blend_mode **)** |
|
||||
+------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_light_mode<class_CanvasItemMaterial_set_light_mode>` **(** :ref:`int<class_int>` light_mode **)** |
|
||||
+------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -58,18 +58,18 @@ Member Function Description
|
||||
|
||||
.. _class_CanvasItemMaterial_get_blend_mode:
|
||||
|
||||
- :ref:`int<class_int>` **get_blend_mode** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_blend_mode** **(** **)** const
|
||||
|
||||
.. _class_CanvasItemMaterial_get_light_mode:
|
||||
|
||||
- :ref:`int<class_int>` **get_light_mode** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_light_mode** **(** **)** const
|
||||
|
||||
.. _class_CanvasItemMaterial_set_blend_mode:
|
||||
|
||||
- void **set_blend_mode** **(** :ref:`int<class_int>` blend_mode **)**
|
||||
- void **set_blend_mode** **(** :ref:`int<class_int>` blend_mode **)**
|
||||
|
||||
.. _class_CanvasItemMaterial_set_light_mode:
|
||||
|
||||
- void **set_light_mode** **(** :ref:`int<class_int>` light_mode **)**
|
||||
- void **set_light_mode** **(** :ref:`int<class_int>` light_mode **)**
|
||||
|
||||
|
||||
|
||||
@@ -21,37 +21,37 @@ Canvas drawing layer.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`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_rotationd<class_CanvasLayer_get_rotationd>` **(** **)** 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:`World2D<class_world2d>` | :ref:`get_world_2d<class_CanvasLayer_get_world_2d>` **(** **)** const |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||
| 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_offset<class_CanvasLayer_set_offset>` **(** :ref:`Vector2<class_vector2>` offset **)** |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_rotation<class_CanvasLayer_set_rotation>` **(** :ref:`float<class_float>` radians **)** |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_rotationd<class_CanvasLayer_set_rotationd>` **(** :ref:`float<class_float>` degrees **)** |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_scale<class_CanvasLayer_set_scale>` **(** :ref:`Vector2<class_vector2>` scale **)** |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_transform<class_CanvasLayer_set_transform>` **(** :ref:`Transform2D<class_transform2d>` transform **)** |
|
||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`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_rotationd<class_CanvasLayer_get_rotationd>` **(** **)** 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:`World2D<class_world2d>` | :ref:`get_world_2d<class_CanvasLayer_get_world_2d>` **(** **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
| 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_offset<class_CanvasLayer_set_offset>` **(** :ref:`Vector2<class_vector2>` offset **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_rotation<class_CanvasLayer_set_rotation>` **(** :ref:`float<class_float>` radians **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_rotationd<class_CanvasLayer_set_rotationd>` **(** :ref:`float<class_float>` degrees **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_scale<class_CanvasLayer_set_scale>` **(** :ref:`Vector2<class_vector2>` scale **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_transform<class_CanvasLayer_set_transform>` **(** :ref:`Transform2D<class_transform2d>` transform **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -83,87 +83,87 @@ Member Function Description
|
||||
|
||||
.. _class_CanvasLayer_get_custom_viewport:
|
||||
|
||||
- :ref:`Node<class_node>` **get_custom_viewport** **(** **)** const
|
||||
- :ref:`Node<class_node>` **get_custom_viewport** **(** **)** const
|
||||
|
||||
.. _class_CanvasLayer_get_layer:
|
||||
|
||||
- :ref:`int<class_int>` **get_layer** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_layer** **(** **)** const
|
||||
|
||||
Return the layer index, determines the draw order, a lower value will be below a higher one.
|
||||
|
||||
.. _class_CanvasLayer_get_offset:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **get_offset** **(** **)** const
|
||||
- :ref:`Vector2<class_vector2>` **get_offset** **(** **)** const
|
||||
|
||||
Return the base offset for this layer (helper).
|
||||
|
||||
.. _class_CanvasLayer_get_rotation:
|
||||
|
||||
- :ref:`float<class_float>` **get_rotation** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_rotation** **(** **)** const
|
||||
|
||||
Return the base rotation for this layer in radians (helper).
|
||||
|
||||
.. _class_CanvasLayer_get_rotationd:
|
||||
|
||||
- :ref:`float<class_float>` **get_rotationd** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_rotationd** **(** **)** const
|
||||
|
||||
Return the base rotation for this layer in degrees.
|
||||
|
||||
.. _class_CanvasLayer_get_scale:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **get_scale** **(** **)** const
|
||||
- :ref:`Vector2<class_vector2>` **get_scale** **(** **)** const
|
||||
|
||||
Return the base scale for this layer (helper).
|
||||
|
||||
.. _class_CanvasLayer_get_transform:
|
||||
|
||||
- :ref:`Transform2D<class_transform2d>` **get_transform** **(** **)** const
|
||||
- :ref:`Transform2D<class_transform2d>` **get_transform** **(** **)** const
|
||||
|
||||
Return the base transform for this layer.
|
||||
|
||||
.. _class_CanvasLayer_get_world_2d:
|
||||
|
||||
- :ref:`World2D<class_world2d>` **get_world_2d** **(** **)** const
|
||||
- :ref:`World2D<class_world2d>` **get_world_2d** **(** **)** const
|
||||
|
||||
Return the :ref:`World2D<class_world2d>` used by this layer.
|
||||
|
||||
.. _class_CanvasLayer_set_custom_viewport:
|
||||
|
||||
- void **set_custom_viewport** **(** :ref:`Node<class_node>` viewport **)**
|
||||
- void **set_custom_viewport** **(** :ref:`Node<class_node>` viewport **)**
|
||||
|
||||
.. _class_CanvasLayer_set_layer:
|
||||
|
||||
- void **set_layer** **(** :ref:`int<class_int>` layer **)**
|
||||
- void **set_layer** **(** :ref:`int<class_int>` layer **)**
|
||||
|
||||
Set the layer index, determines the draw order, a lower value will be below a higher one.
|
||||
|
||||
.. _class_CanvasLayer_set_offset:
|
||||
|
||||
- void **set_offset** **(** :ref:`Vector2<class_vector2>` offset **)**
|
||||
- void **set_offset** **(** :ref:`Vector2<class_vector2>` offset **)**
|
||||
|
||||
Set the base offset for this layer (helper).
|
||||
|
||||
.. _class_CanvasLayer_set_rotation:
|
||||
|
||||
- void **set_rotation** **(** :ref:`float<class_float>` radians **)**
|
||||
- void **set_rotation** **(** :ref:`float<class_float>` radians **)**
|
||||
|
||||
Set the base rotation for this layer in radians (helper).
|
||||
|
||||
.. _class_CanvasLayer_set_rotationd:
|
||||
|
||||
- void **set_rotationd** **(** :ref:`float<class_float>` degrees **)**
|
||||
- void **set_rotationd** **(** :ref:`float<class_float>` degrees **)**
|
||||
|
||||
Set the base rotation for this layer in degrees (helper).
|
||||
|
||||
.. _class_CanvasLayer_set_scale:
|
||||
|
||||
- void **set_scale** **(** :ref:`Vector2<class_vector2>` scale **)**
|
||||
- void **set_scale** **(** :ref:`Vector2<class_vector2>` scale **)**
|
||||
|
||||
Set the base scale for this layer (helper).
|
||||
|
||||
.. _class_CanvasLayer_set_transform:
|
||||
|
||||
- void **set_transform** **(** :ref:`Transform2D<class_transform2d>` transform **)**
|
||||
- void **set_transform** **(** :ref:`Transform2D<class_transform2d>` transform **)**
|
||||
|
||||
Set the base transform for this layer.
|
||||
|
||||
|
||||
@@ -19,11 +19,11 @@ Tint the entire canvas.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------+------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`get_color<class_CanvasModulate_get_color>` **(** **)** const |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_color<class_CanvasModulate_set_color>` **(** :ref:`Color<class_color>` color **)** |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------+
|
||||
+----------------------------+----------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`get_color<class_CanvasModulate_get_color>` **(** **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_color<class_CanvasModulate_set_color>` **(** :ref:`Color<class_color>` color **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -43,13 +43,13 @@ Member Function Description
|
||||
|
||||
.. _class_CanvasModulate_get_color:
|
||||
|
||||
- :ref:`Color<class_color>` **get_color** **(** **)** const
|
||||
- :ref:`Color<class_color>` **get_color** **(** **)** const
|
||||
|
||||
Gets the canvas tint color
|
||||
|
||||
.. _class_CanvasModulate_set_color:
|
||||
|
||||
- void **set_color** **(** :ref:`Color<class_color>` color **)**
|
||||
- void **set_color** **(** :ref:`Color<class_color>` color **)**
|
||||
|
||||
Sets the canvas tint color
|
||||
|
||||
|
||||
@@ -19,23 +19,23 @@ Class representing a capsule-shaped :ref:`PrimitiveMesh<class_primitivemesh>`.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_mid_height<class_CapsuleMesh_get_mid_height>` **(** **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_radial_segments<class_CapsuleMesh_get_radial_segments>` **(** **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_radius<class_CapsuleMesh_get_radius>` **(** **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_rings<class_CapsuleMesh_get_rings>` **(** **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_mid_height<class_CapsuleMesh_set_mid_height>` **(** :ref:`float<class_float>` mid_height **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_radial_segments<class_CapsuleMesh_set_radial_segments>` **(** :ref:`int<class_int>` segments **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_radius<class_CapsuleMesh_set_radius>` **(** :ref:`float<class_float>` radius **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_rings<class_CapsuleMesh_set_rings>` **(** :ref:`int<class_int>` rings **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_mid_height<class_CapsuleMesh_get_mid_height>` **(** **)** const |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_radial_segments<class_CapsuleMesh_get_radial_segments>` **(** **)** const |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_radius<class_CapsuleMesh_get_radius>` **(** **)** const |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_rings<class_CapsuleMesh_get_rings>` **(** **)** const |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_mid_height<class_CapsuleMesh_set_mid_height>` **(** :ref:`float<class_float>` mid_height **)** |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_radial_segments<class_CapsuleMesh_set_radial_segments>` **(** :ref:`int<class_int>` segments **)** |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_radius<class_CapsuleMesh_set_radius>` **(** :ref:`float<class_float>` radius **)** |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_rings<class_CapsuleMesh_set_rings>` **(** :ref:`int<class_int>` rings **)** |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -67,34 +67,34 @@ Member Function Description
|
||||
|
||||
.. _class_CapsuleMesh_get_mid_height:
|
||||
|
||||
- :ref:`float<class_float>` **get_mid_height** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_mid_height** **(** **)** const
|
||||
|
||||
.. _class_CapsuleMesh_get_radial_segments:
|
||||
|
||||
- :ref:`int<class_int>` **get_radial_segments** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_radial_segments** **(** **)** const
|
||||
|
||||
.. _class_CapsuleMesh_get_radius:
|
||||
|
||||
- :ref:`float<class_float>` **get_radius** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_radius** **(** **)** const
|
||||
|
||||
.. _class_CapsuleMesh_get_rings:
|
||||
|
||||
- :ref:`int<class_int>` **get_rings** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_rings** **(** **)** const
|
||||
|
||||
.. _class_CapsuleMesh_set_mid_height:
|
||||
|
||||
- void **set_mid_height** **(** :ref:`float<class_float>` mid_height **)**
|
||||
- void **set_mid_height** **(** :ref:`float<class_float>` mid_height **)**
|
||||
|
||||
.. _class_CapsuleMesh_set_radial_segments:
|
||||
|
||||
- void **set_radial_segments** **(** :ref:`int<class_int>` segments **)**
|
||||
- void **set_radial_segments** **(** :ref:`int<class_int>` segments **)**
|
||||
|
||||
.. _class_CapsuleMesh_set_radius:
|
||||
|
||||
- void **set_radius** **(** :ref:`float<class_float>` radius **)**
|
||||
- void **set_radius** **(** :ref:`float<class_float>` radius **)**
|
||||
|
||||
.. _class_CapsuleMesh_set_rings:
|
||||
|
||||
- void **set_rings** **(** :ref:`int<class_int>` rings **)**
|
||||
- void **set_rings** **(** :ref:`int<class_int>` rings **)**
|
||||
|
||||
|
||||
|
||||
@@ -19,15 +19,15 @@ Capsule shape for collisions.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_height<class_CapsuleShape_get_height>` **(** **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_radius<class_CapsuleShape_get_radius>` **(** **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_height<class_CapsuleShape_set_height>` **(** :ref:`float<class_float>` height **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_radius<class_CapsuleShape_set_radius>` **(** :ref:`float<class_float>` radius **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------+
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_height<class_CapsuleShape_get_height>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_radius<class_CapsuleShape_get_radius>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_height<class_CapsuleShape_set_height>` **(** :ref:`float<class_float>` height **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_radius<class_CapsuleShape_set_radius>` **(** :ref:`float<class_float>` radius **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -51,25 +51,25 @@ Member Function Description
|
||||
|
||||
.. _class_CapsuleShape_get_height:
|
||||
|
||||
- :ref:`float<class_float>` **get_height** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_height** **(** **)** const
|
||||
|
||||
Return the capsule height.
|
||||
|
||||
.. _class_CapsuleShape_get_radius:
|
||||
|
||||
- :ref:`float<class_float>` **get_radius** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_radius** **(** **)** const
|
||||
|
||||
Return the capsule radius.
|
||||
|
||||
.. _class_CapsuleShape_set_height:
|
||||
|
||||
- void **set_height** **(** :ref:`float<class_float>` height **)**
|
||||
- void **set_height** **(** :ref:`float<class_float>` height **)**
|
||||
|
||||
Set the capsule height.
|
||||
|
||||
.. _class_CapsuleShape_set_radius:
|
||||
|
||||
- void **set_radius** **(** :ref:`float<class_float>` radius **)**
|
||||
- void **set_radius** **(** :ref:`float<class_float>` radius **)**
|
||||
|
||||
Set the capsule radius.
|
||||
|
||||
|
||||
@@ -19,15 +19,15 @@ Capsule shape for 2D collisions.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_height<class_CapsuleShape2D_get_height>` **(** **)** const |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_radius<class_CapsuleShape2D_get_radius>` **(** **)** const |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_height<class_CapsuleShape2D_set_height>` **(** :ref:`float<class_float>` height **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_radius<class_CapsuleShape2D_set_radius>` **(** :ref:`float<class_float>` radius **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------+
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_height<class_CapsuleShape2D_get_height>` **(** **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_radius<class_CapsuleShape2D_get_radius>` **(** **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_height<class_CapsuleShape2D_set_height>` **(** :ref:`float<class_float>` height **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_radius<class_CapsuleShape2D_set_radius>` **(** :ref:`float<class_float>` radius **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -51,25 +51,25 @@ Member Function Description
|
||||
|
||||
.. _class_CapsuleShape2D_get_height:
|
||||
|
||||
- :ref:`float<class_float>` **get_height** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_height** **(** **)** const
|
||||
|
||||
Return the height of the :ref:`CapsuleShape2D<class_capsuleshape2d>`.
|
||||
|
||||
.. _class_CapsuleShape2D_get_radius:
|
||||
|
||||
- :ref:`float<class_float>` **get_radius** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_radius** **(** **)** const
|
||||
|
||||
Return the radius of the :ref:`CapsuleShape2D<class_capsuleshape2d>`.
|
||||
|
||||
.. _class_CapsuleShape2D_set_height:
|
||||
|
||||
- void **set_height** **(** :ref:`float<class_float>` height **)**
|
||||
- void **set_height** **(** :ref:`float<class_float>` height **)**
|
||||
|
||||
Set the height of the :ref:`CapsuleShape2D<class_capsuleshape2d>`.
|
||||
|
||||
.. _class_CapsuleShape2D_set_radius:
|
||||
|
||||
- void **set_radius** **(** :ref:`float<class_float>` radius **)**
|
||||
- void **set_radius** **(** :ref:`float<class_float>` radius **)**
|
||||
|
||||
Set the radius of the :ref:`CapsuleShape2D<class_capsuleshape2d>`.
|
||||
|
||||
|
||||
@@ -19,11 +19,11 @@ Keeps children controls centered.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_using_top_left<class_CenterContainer_is_using_top_left>` **(** **)** const |
|
||||
+--------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_use_top_left<class_CenterContainer_set_use_top_left>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_using_top_left<class_CenterContainer_is_using_top_left>` **(** **)** const |
|
||||
+--------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_use_top_left<class_CenterContainer_set_use_top_left>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -43,13 +43,13 @@ Member Function Description
|
||||
|
||||
.. _class_CenterContainer_is_using_top_left:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_using_top_left** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_using_top_left** **(** **)** const
|
||||
|
||||
Should put children to the top left corner instead of center of the container.
|
||||
|
||||
.. _class_CenterContainer_set_use_top_left:
|
||||
|
||||
- void **set_use_top_left** **(** :ref:`bool<class_bool>` enable **)**
|
||||
- void **set_use_top_left** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
This function will anchor the container children to the top left corner of the the container boundaries, moving all its children to that position, (the children new center will be the top left corner of the container).
|
||||
|
||||
|
||||
@@ -19,11 +19,11 @@ Circular shape for 2D collisions.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_radius<class_CircleShape2D_get_radius>` **(** **)** const |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_radius<class_CircleShape2D_set_radius>` **(** :ref:`float<class_float>` radius **)** |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------+
|
||||
+----------------------------+------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_radius<class_CircleShape2D_get_radius>` **(** **)** const |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_radius<class_CircleShape2D_set_radius>` **(** :ref:`float<class_float>` radius **)** |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -43,13 +43,13 @@ Member Function Description
|
||||
|
||||
.. _class_CircleShape2D_get_radius:
|
||||
|
||||
- :ref:`float<class_float>` **get_radius** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_radius** **(** **)** const
|
||||
|
||||
Return the radius of the circle shape.
|
||||
|
||||
.. _class_CircleShape2D_set_radius:
|
||||
|
||||
- void **set_radius** **(** :ref:`float<class_float>` radius **)**
|
||||
- void **set_radius** **(** :ref:`float<class_float>` radius **)**
|
||||
|
||||
Set the radius of the circle shape.
|
||||
|
||||
|
||||
@@ -19,47 +19,47 @@ Class information repository.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`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:`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:`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:`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:`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:`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_signal<class_ClassDB_class_has_signal>` **(** :ref:`String<class_string>` class, :ref:`String<class_string>` signal **)** 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_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:`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_parent_class<class_ClassDB_is_parent_class>` **(** :ref:`String<class_string>` class, :ref:`String<class_string>` inherits **)** 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:`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:`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:`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:`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:`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:`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_signal<class_ClassDB_class_has_signal>` **(** :ref:`String<class_string>` class, :ref:`String<class_string>` signal **)** 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_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:`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_parent_class<class_ClassDB_is_parent_class>` **(** :ref:`String<class_string>` class, :ref:`String<class_string>` inherits **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -71,119 +71,119 @@ Member Function Description
|
||||
|
||||
.. _class_ClassDB_can_instance:
|
||||
|
||||
- :ref:`bool<class_bool>` **can_instance** **(** :ref:`String<class_string>` class **)** const
|
||||
- :ref:`bool<class_bool>` **can_instance** **(** :ref:`String<class_string>` class **)** const
|
||||
|
||||
Returns true if you can instance objects from the specified 'class', false in other case.
|
||||
|
||||
.. _class_ClassDB_class_exists:
|
||||
|
||||
- :ref:`bool<class_bool>` **class_exists** **(** :ref:`String<class_string>` class **)** const
|
||||
- :ref:`bool<class_bool>` **class_exists** **(** :ref:`String<class_string>` class **)** const
|
||||
|
||||
Returns whether the specified 'class' is available or not.
|
||||
|
||||
.. _class_ClassDB_class_get_category:
|
||||
|
||||
- :ref:`String<class_string>` **class_get_category** **(** :ref:`String<class_string>` class **)** const
|
||||
- :ref:`String<class_string>` **class_get_category** **(** :ref:`String<class_string>` class **)** const
|
||||
|
||||
.. _class_ClassDB_class_get_integer_constant:
|
||||
|
||||
- :ref:`int<class_int>` **class_get_integer_constant** **(** :ref:`String<class_string>` class, :ref:`String<class_string>` name **)** const
|
||||
- :ref:`int<class_int>` **class_get_integer_constant** **(** :ref:`String<class_string>` class, :ref:`String<class_string>` name **)** const
|
||||
|
||||
Returns the value of the integer constant 'name' of 'class' or its ancestry. Always returns 0 when the constant could not be found.
|
||||
|
||||
.. _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=false **)** const
|
||||
|
||||
Returns an array with the names all the integer constants of 'class' or its ancestry.
|
||||
|
||||
.. _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=false **)** const
|
||||
|
||||
Returns an array with all the methods of 'class' or its ancestry if 'no_inheritance' is false. Every element of the array is a :ref:`Dictionary<class_dictionary>` with the following keys: args, default_args, flags, id, name, return: (class_name, hint, hint_string, name, type, usage).
|
||||
|
||||
.. _class_ClassDB_class_get_property:
|
||||
|
||||
- :ref:`Variant<class_variant>` **class_get_property** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` property **)** const
|
||||
- :ref:`Variant<class_variant>` **class_get_property** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` property **)** const
|
||||
|
||||
Returns the value of 'property' of 'class' or its ancestry.
|
||||
|
||||
.. _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=false **)** const
|
||||
|
||||
Returns an array with all the properties of 'class' or its ancestry if 'no_inheritance' is false.
|
||||
|
||||
.. _class_ClassDB_class_get_signal:
|
||||
|
||||
- :ref:`Dictionary<class_dictionary>` **class_get_signal** **(** :ref:`String<class_string>` class, :ref:`String<class_string>` signal **)** const
|
||||
- :ref:`Dictionary<class_dictionary>` **class_get_signal** **(** :ref:`String<class_string>` class, :ref:`String<class_string>` signal **)** const
|
||||
|
||||
Returns the 'signal' data of 'class' or its ancestry. The returned value is a :ref:`Dictionary<class_dictionary>` with the following keys: args, default_args, flags, id, name, return: (class_name, hint, hint_string, name, type, usage).
|
||||
|
||||
.. _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=false **)** const
|
||||
|
||||
Returns an array with all the signals of 'class' or its ancestry if 'no_inheritance' is false. Every element of the array is a :ref:`Dictionary<class_dictionary>` as described in class_get_signal.
|
||||
|
||||
.. _class_ClassDB_class_has_integer_constant:
|
||||
|
||||
- :ref:`bool<class_bool>` **class_has_integer_constant** **(** :ref:`String<class_string>` class, :ref:`String<class_string>` name **)** const
|
||||
- :ref:`bool<class_bool>` **class_has_integer_constant** **(** :ref:`String<class_string>` class, :ref:`String<class_string>` name **)** const
|
||||
|
||||
Return whether 'class' or its ancestry has an integer constant called 'name' or not.
|
||||
|
||||
.. _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=false **)** const
|
||||
|
||||
Return whether 'class' (or its ancestry if 'no_inheritance' is false) has a method called 'method' or not.
|
||||
|
||||
.. _class_ClassDB_class_has_signal:
|
||||
|
||||
- :ref:`bool<class_bool>` **class_has_signal** **(** :ref:`String<class_string>` class, :ref:`String<class_string>` signal **)** const
|
||||
- :ref:`bool<class_bool>` **class_has_signal** **(** :ref:`String<class_string>` class, :ref:`String<class_string>` signal **)** const
|
||||
|
||||
Return whether 'class' or its ancestry has a signal called 'signal' or not.
|
||||
|
||||
.. _class_ClassDB_class_set_property:
|
||||
|
||||
- :ref:`int<class_int>` **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
|
||||
|
||||
Sets 'property' value of 'class' to 'value'.
|
||||
|
||||
.. _class_ClassDB_get_class_list:
|
||||
|
||||
- :ref:`PoolStringArray<class_poolstringarray>` **get_class_list** **(** **)** const
|
||||
- :ref:`PoolStringArray<class_poolstringarray>` **get_class_list** **(** **)** const
|
||||
|
||||
Returns the names of all the classes available.
|
||||
|
||||
.. _class_ClassDB_get_inheriters_from_class:
|
||||
|
||||
- :ref:`PoolStringArray<class_poolstringarray>` **get_inheriters_from_class** **(** :ref:`String<class_string>` class **)** const
|
||||
- :ref:`PoolStringArray<class_poolstringarray>` **get_inheriters_from_class** **(** :ref:`String<class_string>` class **)** const
|
||||
|
||||
Returns the names of all the classes that directly or indirectly inherit from 'class'.
|
||||
|
||||
.. _class_ClassDB_get_parent_class:
|
||||
|
||||
- :ref:`String<class_string>` **get_parent_class** **(** :ref:`String<class_string>` class **)** const
|
||||
- :ref:`String<class_string>` **get_parent_class** **(** :ref:`String<class_string>` class **)** const
|
||||
|
||||
Returns the parent class of 'class'.
|
||||
|
||||
.. _class_ClassDB_instance:
|
||||
|
||||
- :ref:`Variant<class_variant>` **instance** **(** :ref:`String<class_string>` class **)** const
|
||||
- :ref:`Variant<class_variant>` **instance** **(** :ref:`String<class_string>` class **)** const
|
||||
|
||||
Creates an instance of 'class'.
|
||||
|
||||
.. _class_ClassDB_is_class_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_class_enabled** **(** :ref:`String<class_string>` class **)** const
|
||||
- :ref:`bool<class_bool>` **is_class_enabled** **(** :ref:`String<class_string>` class **)** const
|
||||
|
||||
Returns whether this class is enabled or not.
|
||||
|
||||
.. _class_ClassDB_is_parent_class:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_parent_class** **(** :ref:`String<class_string>` class, :ref:`String<class_string>` inherits **)** const
|
||||
- :ref:`bool<class_bool>` **is_parent_class** **(** :ref:`String<class_string>` class, :ref:`String<class_string>` inherits **)** const
|
||||
|
||||
Returns whether 'inherits' is an ancestor of 'class' or not.
|
||||
|
||||
|
||||
@@ -21,66 +21,66 @@ Base node for collision objects.
|
||||
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_position, :ref:`Vector3<class_vector3>` click_normal, :ref:`int<class_int>` shape_idx **)** virtual |
|
||||
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`Array<class_array>` | :ref:`get_shape_owners<class_CollisionObject_get_shape_owners>` **(** **)** |
|
||||
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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_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 **)** |
|
||||
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_input_event<class_CollisionObject__input_event>` **(** :ref:`Object<class_object>` camera, :ref:`InputEvent<class_inputevent>` event, :ref:`Vector3<class_vector3>` click_position, :ref:`Vector3<class_vector3>` click_normal, :ref:`int<class_int>` shape_idx **)** virtual |
|
||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`Array<class_array>` | :ref:`get_shape_owners<class_CollisionObject_get_shape_owners>` **(** **)** |
|
||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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_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
|
||||
-------
|
||||
|
||||
.. _class_CollisionObject_input_event:
|
||||
|
||||
- **input_event** **(** :ref:`Object<class_object>` camera, :ref:`Object<class_object>` event, :ref:`Vector3<class_vector3>` click_position, :ref:`Vector3<class_vector3>` click_normal, :ref:`int<class_int>` shape_idx **)**
|
||||
- **input_event** **(** :ref:`Object<class_object>` camera, :ref:`Object<class_object>` event, :ref:`Vector3<class_vector3>` click_position, :ref:`Vector3<class_vector3>` click_normal, :ref:`int<class_int>` shape_idx **)**
|
||||
|
||||
.. _class_CollisionObject_mouse_entered:
|
||||
|
||||
- **mouse_entered** **(** **)**
|
||||
- **mouse_entered** **(** **)**
|
||||
|
||||
Emitted when the mouse pointer enters any of this object's shapes.
|
||||
|
||||
.. _class_CollisionObject_mouse_exited:
|
||||
|
||||
- **mouse_exited** **(** **)**
|
||||
- **mouse_exited** **(** **)**
|
||||
|
||||
Emitted when the mouse pointer exits all this object's shapes.
|
||||
|
||||
@@ -107,115 +107,115 @@ Member Function Description
|
||||
|
||||
.. _class_CollisionObject__input_event:
|
||||
|
||||
- void **_input_event** **(** :ref:`Object<class_object>` camera, :ref:`InputEvent<class_inputevent>` event, :ref:`Vector3<class_vector3>` click_position, :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_position, :ref:`Vector3<class_vector3>` click_normal, :ref:`int<class_int>` shape_idx **)** virtual
|
||||
|
||||
.. _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 a new shape owner for the given object. Returns ``owner_id`` of the new owner for future reference.
|
||||
|
||||
.. _class_CollisionObject_get_capture_input_on_drag:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_capture_input_on_drag** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **get_capture_input_on_drag** **(** **)** const
|
||||
|
||||
.. _class_CollisionObject_get_rid:
|
||||
|
||||
- :ref:`RID<class_rid>` **get_rid** **(** **)** const
|
||||
- :ref:`RID<class_rid>` **get_rid** **(** **)** const
|
||||
|
||||
Returns the object's :ref:`RID<class_rid>`.
|
||||
|
||||
.. _class_CollisionObject_get_shape_owners:
|
||||
|
||||
- :ref:`Array<class_array>` **get_shape_owners** **(** **)**
|
||||
- :ref:`Array<class_array>` **get_shape_owners** **(** **)**
|
||||
|
||||
Returns an :ref:`Array<class_array>` of ``owner_id`` identifiers. You can use these ids in other methods that take ``owner_id`` as an argument.
|
||||
|
||||
.. _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
|
||||
- :ref:`bool<class_bool>` **is_shape_owner_disabled** **(** :ref:`int<class_int>` owner_id **)** const
|
||||
|
||||
If ``true`` the shape owner and its shapes are disabled.
|
||||
|
||||
.. _class_CollisionObject_remove_shape_owner:
|
||||
|
||||
- void **remove_shape_owner** **(** :ref:`int<class_int>` owner_id **)**
|
||||
- void **remove_shape_owner** **(** :ref:`int<class_int>` owner_id **)**
|
||||
|
||||
Removes the given shape owner.
|
||||
|
||||
.. _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 **)**
|
||||
|
||||
.. _class_CollisionObject_set_ray_pickable:
|
||||
|
||||
- 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
|
||||
- :ref:`int<class_int>` **shape_find_owner** **(** :ref:`int<class_int>` shape_index **)** const
|
||||
|
||||
Returns the ``owner_id`` of the given shape.
|
||||
|
||||
.. _class_CollisionObject_shape_owner_add_shape:
|
||||
|
||||
- void **shape_owner_add_shape** **(** :ref:`int<class_int>` owner_id, :ref:`Shape<class_shape>` shape **)**
|
||||
- void **shape_owner_add_shape** **(** :ref:`int<class_int>` owner_id, :ref:`Shape<class_shape>` shape **)**
|
||||
|
||||
Adds a :ref:`Shape<class_shape>` to the shape owner.
|
||||
|
||||
.. _class_CollisionObject_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 **)**
|
||||
|
||||
Removes all shapes from the shape owner.
|
||||
|
||||
.. _class_CollisionObject_shape_owner_get_owner:
|
||||
|
||||
- :ref:`Object<class_object>` **shape_owner_get_owner** **(** :ref:`int<class_int>` owner_id **)** const
|
||||
- :ref:`Object<class_object>` **shape_owner_get_owner** **(** :ref:`int<class_int>` owner_id **)** const
|
||||
|
||||
Returns the parent object of the given shape 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 **)** const
|
||||
- :ref:`Shape<class_shape>` **shape_owner_get_shape** **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** const
|
||||
|
||||
Returns the :ref:`Shape<class_shape>` with the given id from the given shape owner.
|
||||
|
||||
.. _class_CollisionObject_shape_owner_get_shape_count:
|
||||
|
||||
- :ref:`int<class_int>` **shape_owner_get_shape_count** **(** :ref:`int<class_int>` owner_id **)** const
|
||||
- :ref:`int<class_int>` **shape_owner_get_shape_count** **(** :ref:`int<class_int>` owner_id **)** const
|
||||
|
||||
Returns the number of shapes the given shape owner contains.
|
||||
|
||||
.. _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
|
||||
- :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
|
||||
- :ref:`Transform<class_transform>` **shape_owner_get_transform** **(** :ref:`int<class_int>` owner_id **)** const
|
||||
|
||||
Returns the shape owner's :ref:`Transform<class_transform>`.
|
||||
|
||||
.. _class_CollisionObject_shape_owner_remove_shape:
|
||||
|
||||
- void **shape_owner_remove_shape** **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)**
|
||||
- void **shape_owner_remove_shape** **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)**
|
||||
|
||||
Removes a shape from the given shape owner.
|
||||
|
||||
.. _class_CollisionObject_shape_owner_set_disabled:
|
||||
|
||||
- void **shape_owner_set_disabled** **(** :ref:`int<class_int>` owner_id, :ref:`bool<class_bool>` disabled **)**
|
||||
- void **shape_owner_set_disabled** **(** :ref:`int<class_int>` owner_id, :ref:`bool<class_bool>` disabled **)**
|
||||
|
||||
If ``true`` disables the given shape owner.
|
||||
|
||||
.. _class_CollisionObject_shape_owner_set_transform:
|
||||
|
||||
- void **shape_owner_set_transform** **(** :ref:`int<class_int>` owner_id, :ref:`Transform<class_transform>` transform **)**
|
||||
- void **shape_owner_set_transform** **(** :ref:`int<class_int>` owner_id, :ref:`Transform<class_transform>` transform **)**
|
||||
|
||||
Sets the :ref:`Transform<class_transform>` of the given shape owner.
|
||||
|
||||
|
||||
@@ -21,68 +21,68 @@ Base node for 2D collision objects.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_input_event<class_CollisionObject2D__input_event>` **(** :ref:`Object<class_object>` viewport, :ref:`InputEvent<class_inputevent>` event, :ref:`int<class_int>` shape_idx **)** virtual |
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`create_shape_owner<class_CollisionObject2D_create_shape_owner>` **(** :ref:`Object<class_object>` owner **)** |
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`RID<class_rid>` | :ref:`get_rid<class_CollisionObject2D_get_rid>` **(** **)** const |
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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 **)** |
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Object<class_object>` | :ref:`shape_owner_get_owner<class_CollisionObject2D_shape_owner_get_owner>` **(** :ref:`int<class_int>` owner_id **)** const |
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`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_set_disabled<class_CollisionObject2D_shape_owner_set_disabled>` **(** :ref:`int<class_int>` owner_id, :ref:`bool<class_bool>` disabled **)** |
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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 **)** |
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_input_event<class_CollisionObject2D__input_event>` **(** :ref:`Object<class_object>` viewport, :ref:`InputEvent<class_inputevent>` event, :ref:`int<class_int>` shape_idx **)** virtual |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`create_shape_owner<class_CollisionObject2D_create_shape_owner>` **(** :ref:`Object<class_object>` owner **)** |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`RID<class_rid>` | :ref:`get_rid<class_CollisionObject2D_get_rid>` **(** **)** const |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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 **)** |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Object<class_object>` | :ref:`shape_owner_get_owner<class_CollisionObject2D_shape_owner_get_owner>` **(** :ref:`int<class_int>` owner_id **)** const |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`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_set_disabled<class_CollisionObject2D_shape_owner_set_disabled>` **(** :ref:`int<class_int>` owner_id, :ref:`bool<class_bool>` disabled **)** |
|
||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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
|
||||
-------
|
||||
|
||||
.. _class_CollisionObject2D_input_event:
|
||||
|
||||
- **input_event** **(** :ref:`Object<class_object>` viewport, :ref:`Object<class_object>` event, :ref:`int<class_int>` shape_idx **)**
|
||||
- **input_event** **(** :ref:`Object<class_object>` viewport, :ref:`Object<class_object>` event, :ref:`int<class_int>` shape_idx **)**
|
||||
|
||||
Emitted when an input event occurs and ``input_pickable`` is ``true``.
|
||||
|
||||
.. _class_CollisionObject2D_mouse_entered:
|
||||
|
||||
- **mouse_entered** **(** **)**
|
||||
- **mouse_entered** **(** **)**
|
||||
|
||||
Emitted when the mouse pointer enters any of this object's shapes.
|
||||
|
||||
.. _class_CollisionObject2D_mouse_exited:
|
||||
|
||||
- **mouse_exited** **(** **)**
|
||||
- **mouse_exited** **(** **)**
|
||||
|
||||
Emitted when the mouse pointer exits all this object's shapes.
|
||||
|
||||
@@ -105,119 +105,119 @@ Member Function Description
|
||||
|
||||
.. _class_CollisionObject2D__input_event:
|
||||
|
||||
- void **_input_event** **(** :ref:`Object<class_object>` viewport, :ref:`InputEvent<class_inputevent>` event, :ref:`int<class_int>` shape_idx **)** virtual
|
||||
- void **_input_event** **(** :ref:`Object<class_object>` viewport, :ref:`InputEvent<class_inputevent>` event, :ref:`int<class_int>` shape_idx **)** virtual
|
||||
|
||||
.. _class_CollisionObject2D_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 a new shape owner for the given object. Returns ``owner_id`` of the new owner for future reference.
|
||||
|
||||
.. _class_CollisionObject2D_get_rid:
|
||||
|
||||
- :ref:`RID<class_rid>` **get_rid** **(** **)** const
|
||||
- :ref:`RID<class_rid>` **get_rid** **(** **)** const
|
||||
|
||||
Returns the object's :ref:`RID<class_rid>`.
|
||||
|
||||
.. _class_CollisionObject2D_get_shape_owners:
|
||||
|
||||
- :ref:`Array<class_array>` **get_shape_owners** **(** **)**
|
||||
- :ref:`Array<class_array>` **get_shape_owners** **(** **)**
|
||||
|
||||
Returns an :ref:`Array<class_array>` of ``owner_id`` identifiers. You can use these ids in other methods that take ``owner_id`` as an argument.
|
||||
|
||||
.. _class_CollisionObject2D_is_pickable:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_pickable** **(** **)** const
|
||||
- :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
|
||||
- :ref:`bool<class_bool>` **is_shape_owner_disabled** **(** :ref:`int<class_int>` owner_id **)** const
|
||||
|
||||
If ``true`` the shape owner and its shapes are disabled.
|
||||
|
||||
.. _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
|
||||
- :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 **)**
|
||||
- void **remove_shape_owner** **(** :ref:`int<class_int>` owner_id **)**
|
||||
|
||||
Removes the given shape owner.
|
||||
|
||||
.. _class_CollisionObject2D_set_pickable:
|
||||
|
||||
- void **set_pickable** **(** :ref:`bool<class_bool>` enabled **)**
|
||||
- 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
|
||||
- :ref:`int<class_int>` **shape_find_owner** **(** :ref:`int<class_int>` shape_index **)** const
|
||||
|
||||
Returns the ``owner_id`` of the given shape.
|
||||
|
||||
.. _class_CollisionObject2D_shape_owner_add_shape:
|
||||
|
||||
- void **shape_owner_add_shape** **(** :ref:`int<class_int>` owner_id, :ref:`Shape2D<class_shape2d>` shape **)**
|
||||
- void **shape_owner_add_shape** **(** :ref:`int<class_int>` owner_id, :ref:`Shape2D<class_shape2d>` shape **)**
|
||||
|
||||
Adds a :ref:`Shape2D<class_shape2d>` to the shape owner.
|
||||
|
||||
.. _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 **)**
|
||||
|
||||
Removes all shapes from the shape owner.
|
||||
|
||||
.. _class_CollisionObject2D_shape_owner_get_owner:
|
||||
|
||||
- :ref:`Object<class_object>` **shape_owner_get_owner** **(** :ref:`int<class_int>` owner_id **)** const
|
||||
- :ref:`Object<class_object>` **shape_owner_get_owner** **(** :ref:`int<class_int>` owner_id **)** const
|
||||
|
||||
Returns the parent object of the given shape owner.
|
||||
|
||||
.. _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 **)** const
|
||||
- :ref:`Shape2D<class_shape2d>` **shape_owner_get_shape** **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** const
|
||||
|
||||
Returns the :ref:`Shape2D<class_shape2d>` with the given id from the given shape owner.
|
||||
|
||||
.. _class_CollisionObject2D_shape_owner_get_shape_count:
|
||||
|
||||
- :ref:`int<class_int>` **shape_owner_get_shape_count** **(** :ref:`int<class_int>` owner_id **)** const
|
||||
- :ref:`int<class_int>` **shape_owner_get_shape_count** **(** :ref:`int<class_int>` owner_id **)** const
|
||||
|
||||
Returns the number of shapes the given shape owner contains.
|
||||
|
||||
.. _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
|
||||
- :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:
|
||||
|
||||
- :ref:`Transform2D<class_transform2d>` **shape_owner_get_transform** **(** :ref:`int<class_int>` owner_id **)** const
|
||||
- :ref:`Transform2D<class_transform2d>` **shape_owner_get_transform** **(** :ref:`int<class_int>` owner_id **)** const
|
||||
|
||||
Returns the shape owner's :ref:`Transform2D<class_transform2d>`.
|
||||
|
||||
.. _class_CollisionObject2D_shape_owner_remove_shape:
|
||||
|
||||
- void **shape_owner_remove_shape** **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)**
|
||||
- void **shape_owner_remove_shape** **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)**
|
||||
|
||||
Removes a shape from the given shape owner.
|
||||
|
||||
.. _class_CollisionObject2D_shape_owner_set_disabled:
|
||||
|
||||
- void **shape_owner_set_disabled** **(** :ref:`int<class_int>` owner_id, :ref:`bool<class_bool>` disabled **)**
|
||||
- void **shape_owner_set_disabled** **(** :ref:`int<class_int>` owner_id, :ref:`bool<class_bool>` disabled **)**
|
||||
|
||||
If ``true`` disables the given shape owner.
|
||||
|
||||
.. _class_CollisionObject2D_shape_owner_set_one_way_collision:
|
||||
|
||||
- void **shape_owner_set_one_way_collision** **(** :ref:`int<class_int>` owner_id, :ref:`bool<class_bool>` enable **)**
|
||||
- void **shape_owner_set_one_way_collision** **(** :ref:`int<class_int>` owner_id, :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
.. _class_CollisionObject2D_shape_owner_set_transform:
|
||||
|
||||
- void **shape_owner_set_transform** **(** :ref:`int<class_int>` owner_id, :ref:`Transform2D<class_transform2d>` transform **)**
|
||||
- void **shape_owner_set_transform** **(** :ref:`int<class_int>` owner_id, :ref:`Transform2D<class_transform2d>` transform **)**
|
||||
|
||||
Sets the :ref:`Transform2D<class_transform2d>` of the given shape owner.
|
||||
|
||||
|
||||
@@ -19,19 +19,19 @@ Editor-only class for defining a collision polygon in 3D space.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_depth<class_CollisionPolygon_get_depth>` **(** **)** const |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolVector2Array<class_poolvector2array>` | :ref:`get_polygon<class_CollisionPolygon_get_polygon>` **(** **)** const |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_disabled<class_CollisionPolygon_is_disabled>` **(** **)** const |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_depth<class_CollisionPolygon_set_depth>` **(** :ref:`float<class_float>` depth **)** |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_disabled<class_CollisionPolygon_set_disabled>` **(** :ref:`bool<class_bool>` disabled **)** |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_polygon<class_CollisionPolygon_set_polygon>` **(** :ref:`PoolVector2Array<class_poolvector2array>` polygon **)** |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_depth<class_CollisionPolygon_get_depth>` **(** **)** const |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolVector2Array<class_poolvector2array>` | :ref:`get_polygon<class_CollisionPolygon_get_polygon>` **(** **)** const |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_disabled<class_CollisionPolygon_is_disabled>` **(** **)** const |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_depth<class_CollisionPolygon_set_depth>` **(** :ref:`float<class_float>` depth **)** |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_disabled<class_CollisionPolygon_set_disabled>` **(** :ref:`bool<class_bool>` disabled **)** |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_polygon<class_CollisionPolygon_set_polygon>` **(** :ref:`PoolVector2Array<class_poolvector2array>` polygon **)** |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -59,26 +59,26 @@ Member Function Description
|
||||
|
||||
.. _class_CollisionPolygon_get_depth:
|
||||
|
||||
- :ref:`float<class_float>` **get_depth** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_depth** **(** **)** const
|
||||
|
||||
.. _class_CollisionPolygon_get_polygon:
|
||||
|
||||
- :ref:`PoolVector2Array<class_poolvector2array>` **get_polygon** **(** **)** const
|
||||
- :ref:`PoolVector2Array<class_poolvector2array>` **get_polygon** **(** **)** const
|
||||
|
||||
.. _class_CollisionPolygon_is_disabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_disabled** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_disabled** **(** **)** const
|
||||
|
||||
.. _class_CollisionPolygon_set_depth:
|
||||
|
||||
- void **set_depth** **(** :ref:`float<class_float>` depth **)**
|
||||
- void **set_depth** **(** :ref:`float<class_float>` depth **)**
|
||||
|
||||
.. _class_CollisionPolygon_set_disabled:
|
||||
|
||||
- void **set_disabled** **(** :ref:`bool<class_bool>` disabled **)**
|
||||
- void **set_disabled** **(** :ref:`bool<class_bool>` disabled **)**
|
||||
|
||||
.. _class_CollisionPolygon_set_polygon:
|
||||
|
||||
- void **set_polygon** **(** :ref:`PoolVector2Array<class_poolvector2array>` polygon **)**
|
||||
- void **set_polygon** **(** :ref:`PoolVector2Array<class_poolvector2array>` polygon **)**
|
||||
|
||||
|
||||
|
||||
@@ -19,23 +19,23 @@ Defines a 2D collision polygon.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_build_mode<class_CollisionPolygon2D_get_build_mode>` **(** **)** const |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolVector2Array<class_poolvector2array>` | :ref:`get_polygon<class_CollisionPolygon2D_get_polygon>` **(** **)** const |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_disabled<class_CollisionPolygon2D_is_disabled>` **(** **)** const |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_one_way_collision_enabled<class_CollisionPolygon2D_is_one_way_collision_enabled>` **(** **)** const |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_build_mode<class_CollisionPolygon2D_set_build_mode>` **(** :ref:`int<class_int>` build_mode **)** |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_disabled<class_CollisionPolygon2D_set_disabled>` **(** :ref:`bool<class_bool>` disabled **)** |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_one_way_collision<class_CollisionPolygon2D_set_one_way_collision>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_polygon<class_CollisionPolygon2D_set_polygon>` **(** :ref:`PoolVector2Array<class_poolvector2array>` polygon **)** |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_build_mode<class_CollisionPolygon2D_get_build_mode>` **(** **)** const |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolVector2Array<class_poolvector2array>` | :ref:`get_polygon<class_CollisionPolygon2D_get_polygon>` **(** **)** const |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_disabled<class_CollisionPolygon2D_is_disabled>` **(** **)** const |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_one_way_collision_enabled<class_CollisionPolygon2D_is_one_way_collision_enabled>` **(** **)** const |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_build_mode<class_CollisionPolygon2D_set_build_mode>` **(** :ref:`int<class_int>` build_mode **)** |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_disabled<class_CollisionPolygon2D_set_disabled>` **(** :ref:`bool<class_bool>` disabled **)** |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_one_way_collision<class_CollisionPolygon2D_set_one_way_collision>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_polygon<class_CollisionPolygon2D_set_polygon>` **(** :ref:`PoolVector2Array<class_poolvector2array>` polygon **)** |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -73,41 +73,41 @@ Member Function Description
|
||||
|
||||
.. _class_CollisionPolygon2D_get_build_mode:
|
||||
|
||||
- :ref:`int<class_int>` **get_build_mode** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_build_mode** **(** **)** const
|
||||
|
||||
Return whether the polygon is a :ref:`ConvexPolygonShape2D<class_convexpolygonshape2d>` (``build_mode==0``), or a :ref:`ConcavePolygonShape2D<class_concavepolygonshape2d>` (``build_mode==1``).
|
||||
|
||||
.. _class_CollisionPolygon2D_get_polygon:
|
||||
|
||||
- :ref:`PoolVector2Array<class_poolvector2array>` **get_polygon** **(** **)** const
|
||||
- :ref:`PoolVector2Array<class_poolvector2array>` **get_polygon** **(** **)** const
|
||||
|
||||
Return the list of points that define the polygon.
|
||||
|
||||
.. _class_CollisionPolygon2D_is_disabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_disabled** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_disabled** **(** **)** const
|
||||
|
||||
.. _class_CollisionPolygon2D_is_one_way_collision_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_one_way_collision_enabled** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_one_way_collision_enabled** **(** **)** const
|
||||
|
||||
.. _class_CollisionPolygon2D_set_build_mode:
|
||||
|
||||
- void **set_build_mode** **(** :ref:`int<class_int>` build_mode **)**
|
||||
- void **set_build_mode** **(** :ref:`int<class_int>` build_mode **)**
|
||||
|
||||
Set whether the polygon is to be a :ref:`ConvexPolygonShape2D<class_convexpolygonshape2d>` (``build_mode==0``), or a :ref:`ConcavePolygonShape2D<class_concavepolygonshape2d>` (``build_mode==1``).
|
||||
|
||||
.. _class_CollisionPolygon2D_set_disabled:
|
||||
|
||||
- void **set_disabled** **(** :ref:`bool<class_bool>` disabled **)**
|
||||
- void **set_disabled** **(** :ref:`bool<class_bool>` disabled **)**
|
||||
|
||||
.. _class_CollisionPolygon2D_set_one_way_collision:
|
||||
|
||||
- void **set_one_way_collision** **(** :ref:`bool<class_bool>` enabled **)**
|
||||
- void **set_one_way_collision** **(** :ref:`bool<class_bool>` enabled **)**
|
||||
|
||||
.. _class_CollisionPolygon2D_set_polygon:
|
||||
|
||||
- void **set_polygon** **(** :ref:`PoolVector2Array<class_poolvector2array>` polygon **)**
|
||||
- void **set_polygon** **(** :ref:`PoolVector2Array<class_poolvector2array>` polygon **)**
|
||||
|
||||
Set the array of points forming the polygon.
|
||||
|
||||
|
||||
@@ -19,19 +19,19 @@ Node that represents collision shape data in 3D space.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Shape<class_shape>` | :ref:`get_shape<class_CollisionShape_get_shape>` **(** **)** 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:`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_shape<class_CollisionShape_set_shape>` **(** :ref:`Shape<class_shape>` shape **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Shape<class_shape>` | :ref:`get_shape<class_CollisionShape_get_shape>` **(** **)** 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:`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_shape<class_CollisionShape_set_shape>` **(** :ref:`Shape<class_shape>` shape **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -55,30 +55,30 @@ Member Function Description
|
||||
|
||||
.. _class_CollisionShape_get_shape:
|
||||
|
||||
- :ref:`Shape<class_shape>` **get_shape** **(** **)** const
|
||||
- :ref:`Shape<class_shape>` **get_shape** **(** **)** const
|
||||
|
||||
.. _class_CollisionShape_is_disabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_disabled** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_disabled** **(** **)** const
|
||||
|
||||
.. _class_CollisionShape_make_convex_from_brothers:
|
||||
|
||||
- void **make_convex_from_brothers** **(** **)**
|
||||
- void **make_convex_from_brothers** **(** **)**
|
||||
|
||||
Sets the collision shape's shape to the addition of all its convexed :ref:`MeshInstance<class_meshinstance>` siblings geometry.
|
||||
|
||||
.. _class_CollisionShape_resource_changed:
|
||||
|
||||
- void **resource_changed** **(** :ref:`Resource<class_resource>` resource **)**
|
||||
- void **resource_changed** **(** :ref:`Resource<class_resource>` resource **)**
|
||||
|
||||
If this method exists within a script it will be called whenever the shape resource has been modified.
|
||||
|
||||
.. _class_CollisionShape_set_disabled:
|
||||
|
||||
- void **set_disabled** **(** :ref:`bool<class_bool>` enable **)**
|
||||
- void **set_disabled** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
.. _class_CollisionShape_set_shape:
|
||||
|
||||
- void **set_shape** **(** :ref:`Shape<class_shape>` shape **)**
|
||||
- void **set_shape** **(** :ref:`Shape<class_shape>` shape **)**
|
||||
|
||||
|
||||
|
||||
@@ -19,19 +19,19 @@ Node that represents collision shape data in 2D space.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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_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_one_way_collision<class_CollisionShape2D_set_one_way_collision>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_shape<class_CollisionShape2D_set_shape>` **(** :ref:`Shape2D<class_shape2d>` shape **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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_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_one_way_collision<class_CollisionShape2D_set_one_way_collision>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_shape<class_CollisionShape2D_set_shape>` **(** :ref:`Shape2D<class_shape2d>` shape **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -59,26 +59,26 @@ Member Function Description
|
||||
|
||||
.. _class_CollisionShape2D_get_shape:
|
||||
|
||||
- :ref:`Shape2D<class_shape2d>` **get_shape** **(** **)** const
|
||||
- :ref:`Shape2D<class_shape2d>` **get_shape** **(** **)** const
|
||||
|
||||
.. _class_CollisionShape2D_is_disabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_disabled** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_disabled** **(** **)** const
|
||||
|
||||
.. _class_CollisionShape2D_is_one_way_collision_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_one_way_collision_enabled** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_one_way_collision_enabled** **(** **)** const
|
||||
|
||||
.. _class_CollisionShape2D_set_disabled:
|
||||
|
||||
- void **set_disabled** **(** :ref:`bool<class_bool>` disabled **)**
|
||||
- void **set_disabled** **(** :ref:`bool<class_bool>` disabled **)**
|
||||
|
||||
.. _class_CollisionShape2D_set_one_way_collision:
|
||||
|
||||
- void **set_one_way_collision** **(** :ref:`bool<class_bool>` enabled **)**
|
||||
- void **set_one_way_collision** **(** :ref:`bool<class_bool>` enabled **)**
|
||||
|
||||
.. _class_CollisionShape2D_set_shape:
|
||||
|
||||
- void **set_shape** **(** :ref:`Shape2D<class_shape2d>` shape **)**
|
||||
- void **set_shape** **(** :ref:`Shape2D<class_shape2d>` shape **)**
|
||||
|
||||
|
||||
|
||||
@@ -17,31 +17,31 @@ Color in RGBA format with some support for ARGB format.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`Color<class_Color_Color>` **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b, :ref:`float<class_float>` a **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`Color<class_Color_Color>` **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`Color<class_Color_Color>` **(** :ref:`int<class_int>` from **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`Color<class_Color_Color>` **(** :ref:`String<class_string>` from **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`blend<class_Color_blend>` **(** :ref:`Color<class_color>` over **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`contrasted<class_Color_contrasted>` **(** **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`gray<class_Color_gray>` **(** **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`inverted<class_Color_inverted>` **(** **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`linear_interpolate<class_Color_linear_interpolate>` **(** :ref:`Color<class_color>` b, :ref:`float<class_float>` t **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`to_argb32<class_Color_to_argb32>` **(** **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`to_html<class_Color_to_html>` **(** :ref:`bool<class_bool>` with_alpha=True **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`to_rgba32<class_Color_to_rgba32>` **(** **)** |
|
||||
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`Color<class_Color_Color>` **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b, :ref:`float<class_float>` a **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`Color<class_Color_Color>` **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`Color<class_Color_Color>` **(** :ref:`int<class_int>` from **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`Color<class_Color_Color>` **(** :ref:`String<class_string>` from **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`blend<class_Color_blend>` **(** :ref:`Color<class_color>` over **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`contrasted<class_Color_contrasted>` **(** **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`gray<class_Color_gray>` **(** **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`inverted<class_Color_inverted>` **(** **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`linear_interpolate<class_Color_linear_interpolate>` **(** :ref:`Color<class_color>` b, :ref:`float<class_float>` t **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`to_argb32<class_Color_to_argb32>` **(** **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`to_html<class_Color_to_html>` **(** :ref:`bool<class_bool>` with_alpha=True **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`to_rgba32<class_Color_to_rgba32>` **(** **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -101,7 +101,7 @@ Member Function Description
|
||||
|
||||
.. _class_Color_Color:
|
||||
|
||||
- :ref:`Color<class_color>` **Color** **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b, :ref:`float<class_float>` a **)**
|
||||
- :ref:`Color<class_color>` **Color** **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b, :ref:`float<class_float>` a **)**
|
||||
|
||||
Constructs a color from an RGBA profile using values between 0 and 1 (float).
|
||||
|
||||
@@ -111,7 +111,7 @@ Constructs a color from an RGBA profile using values between 0 and 1 (float).
|
||||
|
||||
.. _class_Color_Color:
|
||||
|
||||
- :ref:`Color<class_color>` **Color** **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b **)**
|
||||
- :ref:`Color<class_color>` **Color** **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b **)**
|
||||
|
||||
Constructs a color from an RGB profile using values between 0 and 1 (float). Alpha will always be 1.
|
||||
|
||||
@@ -121,7 +121,7 @@ Constructs a color from an RGB profile using values between 0 and 1 (float). Alp
|
||||
|
||||
.. _class_Color_Color:
|
||||
|
||||
- :ref:`Color<class_color>` **Color** **(** :ref:`int<class_int>` from **)**
|
||||
- :ref:`Color<class_color>` **Color** **(** :ref:`int<class_int>` from **)**
|
||||
|
||||
Constructs a color from a 32-bit integer (each byte represents a component of the RGBA profile).
|
||||
|
||||
@@ -131,7 +131,7 @@ Constructs a color from a 32-bit integer (each byte represents a component of th
|
||||
|
||||
.. _class_Color_Color:
|
||||
|
||||
- :ref:`Color<class_color>` **Color** **(** :ref:`String<class_string>` from **)**
|
||||
- :ref:`Color<class_color>` **Color** **(** :ref:`String<class_string>` from **)**
|
||||
|
||||
Constructs a color from an HTML hexadecimal color string in ARGB or RGB format.
|
||||
|
||||
@@ -155,7 +155,7 @@ The following string formats are supported:
|
||||
|
||||
.. _class_Color_blend:
|
||||
|
||||
- :ref:`Color<class_color>` **blend** **(** :ref:`Color<class_color>` over **)**
|
||||
- :ref:`Color<class_color>` **blend** **(** :ref:`Color<class_color>` over **)**
|
||||
|
||||
Returns a new color resulting from blending this color over another color. If the color is opaque, the result would also be opaque. The other color could then take a range of values with different alpha values.
|
||||
|
||||
@@ -167,7 +167,7 @@ Returns a new color resulting from blending this color over another color. If th
|
||||
|
||||
.. _class_Color_contrasted:
|
||||
|
||||
- :ref:`Color<class_color>` **contrasted** **(** **)**
|
||||
- :ref:`Color<class_color>` **contrasted** **(** **)**
|
||||
|
||||
Returns the most contrasting color.
|
||||
|
||||
@@ -178,7 +178,7 @@ Returns the most contrasting color.
|
||||
|
||||
.. _class_Color_gray:
|
||||
|
||||
- :ref:`float<class_float>` **gray** **(** **)**
|
||||
- :ref:`float<class_float>` **gray** **(** **)**
|
||||
|
||||
Returns the color's grayscale.
|
||||
|
||||
@@ -191,7 +191,7 @@ The gray is calculated by (r + g + b) / 3.
|
||||
|
||||
.. _class_Color_inverted:
|
||||
|
||||
- :ref:`Color<class_color>` **inverted** **(** **)**
|
||||
- :ref:`Color<class_color>` **inverted** **(** **)**
|
||||
|
||||
Returns the inverted color (1-r, 1-g, 1-b, 1-a).
|
||||
|
||||
@@ -202,7 +202,7 @@ Returns the inverted color (1-r, 1-g, 1-b, 1-a).
|
||||
|
||||
.. _class_Color_linear_interpolate:
|
||||
|
||||
- :ref:`Color<class_color>` **linear_interpolate** **(** :ref:`Color<class_color>` b, :ref:`float<class_float>` t **)**
|
||||
- :ref:`Color<class_color>` **linear_interpolate** **(** :ref:`Color<class_color>` b, :ref:`float<class_float>` t **)**
|
||||
|
||||
Returns the color of the linear interpolation with another color. The value t is between 0 and 1 (float).
|
||||
|
||||
@@ -214,7 +214,7 @@ Returns the color of the linear interpolation with another color. The value t is
|
||||
|
||||
.. _class_Color_to_argb32:
|
||||
|
||||
- :ref:`int<class_int>` **to_argb32** **(** **)**
|
||||
- :ref:`int<class_int>` **to_argb32** **(** **)**
|
||||
|
||||
Returns the color's 32-bit integer in ARGB format (each byte represents a component of the ARGB profile). More compatible with DirectX.
|
||||
|
||||
@@ -225,7 +225,7 @@ Returns the color's 32-bit integer in ARGB format (each byte represents a compon
|
||||
|
||||
.. _class_Color_to_html:
|
||||
|
||||
- :ref:`String<class_string>` **to_html** **(** :ref:`bool<class_bool>` with_alpha=True **)**
|
||||
- :ref:`String<class_string>` **to_html** **(** :ref:`bool<class_bool>` with_alpha=True **)**
|
||||
|
||||
Returns the color's HTML hexadecimal color string in ARGB format (ex: ``ff34f822``).
|
||||
|
||||
@@ -239,7 +239,7 @@ Optionally flag 'false' to not include alpha in hexadecimal string.
|
||||
|
||||
.. _class_Color_to_rgba32:
|
||||
|
||||
- :ref:`int<class_int>` **to_rgba32** **(** **)**
|
||||
- :ref:`int<class_int>` **to_rgba32** **(** **)**
|
||||
|
||||
Returns the color's 32-bit integer in ARGB format (each byte represents a component of the ARGB profile).
|
||||
|
||||
|
||||
@@ -19,28 +19,28 @@ Color picker control.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------+
|
||||
| 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:`bool<class_bool>` | :ref:`is_editing_alpha<class_ColorPicker_is_editing_alpha>` **(** **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_raw_mode<class_ColorPicker_is_raw_mode>` **(** **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_edit_alpha<class_ColorPicker_set_edit_alpha>` **(** :ref:`bool<class_bool>` show **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_pick_color<class_ColorPicker_set_pick_color>` **(** :ref:`Color<class_color>` color **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_raw_mode<class_ColorPicker_set_raw_mode>` **(** :ref:`bool<class_bool>` mode **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------+
|
||||
| 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:`bool<class_bool>` | :ref:`is_editing_alpha<class_ColorPicker_is_editing_alpha>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_raw_mode<class_ColorPicker_is_raw_mode>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_edit_alpha<class_ColorPicker_set_edit_alpha>` **(** :ref:`bool<class_bool>` show **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_pick_color<class_ColorPicker_set_pick_color>` **(** :ref:`Color<class_color>` color **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_raw_mode<class_ColorPicker_set_raw_mode>` **(** :ref:`bool<class_bool>` mode **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_ColorPicker_color_changed:
|
||||
|
||||
- **color_changed** **(** :ref:`Color<class_color>` color **)**
|
||||
- **color_changed** **(** :ref:`Color<class_color>` color **)**
|
||||
|
||||
Emitted when the color is changed.
|
||||
|
||||
@@ -55,43 +55,43 @@ Member Function Description
|
||||
|
||||
.. _class_ColorPicker_add_preset:
|
||||
|
||||
- void **add_preset** **(** :ref:`Color<class_color>` color **)**
|
||||
- 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.
|
||||
|
||||
.. _class_ColorPicker_get_pick_color:
|
||||
|
||||
- :ref:`Color<class_color>` **get_pick_color** **(** **)** const
|
||||
- :ref:`Color<class_color>` **get_pick_color** **(** **)** const
|
||||
|
||||
Gets the current color.
|
||||
|
||||
.. _class_ColorPicker_is_editing_alpha:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_editing_alpha** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_editing_alpha** **(** **)** const
|
||||
|
||||
Returns whether the color has transparency or not.
|
||||
|
||||
.. _class_ColorPicker_is_raw_mode:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_raw_mode** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_raw_mode** **(** **)** const
|
||||
|
||||
Returns whether this color picker is in raw mode or not, raw mode will allow the color R, G, B component values to go beyond 1, you have to consider that the max value for color components is 1, going beyond that value will not have effect in the color, but can be used for special operations that require it (like tinting without darkening or rendering sprites in HDR).
|
||||
|
||||
.. _class_ColorPicker_set_edit_alpha:
|
||||
|
||||
- void **set_edit_alpha** **(** :ref:`bool<class_bool>` show **)**
|
||||
- void **set_edit_alpha** **(** :ref:`bool<class_bool>` show **)**
|
||||
|
||||
Set true if you want the color to have an alpha channel (transparency), or false if you want a solid color.
|
||||
|
||||
.. _class_ColorPicker_set_pick_color:
|
||||
|
||||
- void **set_pick_color** **(** :ref:`Color<class_color>` color **)**
|
||||
- void **set_pick_color** **(** :ref:`Color<class_color>` color **)**
|
||||
|
||||
Select the current color.
|
||||
|
||||
.. _class_ColorPicker_set_raw_mode:
|
||||
|
||||
- void **set_raw_mode** **(** :ref:`bool<class_bool>` mode **)**
|
||||
- void **set_raw_mode** **(** :ref:`bool<class_bool>` mode **)**
|
||||
|
||||
Set whether this color picker is using raw mode or not, see :ref:`is_raw_mode<class_ColorPicker_is_raw_mode>`.
|
||||
|
||||
|
||||
@@ -19,24 +19,24 @@ Button that pops out a :ref:`ColorPicker<class_colorpicker>`
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`get_pick_color<class_ColorPickerButton_get_pick_color>` **(** **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`ColorPicker<class_colorpicker>` | :ref:`get_picker<class_ColorPickerButton_get_picker>` **(** **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_editing_alpha<class_ColorPickerButton_is_editing_alpha>` **(** **)** const |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_edit_alpha<class_ColorPickerButton_set_edit_alpha>` **(** :ref:`bool<class_bool>` show **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_pick_color<class_ColorPickerButton_set_pick_color>` **(** :ref:`Color<class_color>` color **)** |
|
||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`get_pick_color<class_ColorPickerButton_get_pick_color>` **(** **)** const |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`ColorPicker<class_colorpicker>` | :ref:`get_picker<class_ColorPickerButton_get_picker>` **(** **)** |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_editing_alpha<class_ColorPickerButton_is_editing_alpha>` **(** **)** const |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_edit_alpha<class_ColorPickerButton_set_edit_alpha>` **(** :ref:`bool<class_bool>` show **)** |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_pick_color<class_ColorPickerButton_set_pick_color>` **(** :ref:`Color<class_color>` color **)** |
|
||||
+----------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_ColorPickerButton_color_changed:
|
||||
|
||||
- **color_changed** **(** :ref:`Color<class_color>` color **)**
|
||||
- **color_changed** **(** :ref:`Color<class_color>` color **)**
|
||||
|
||||
Emitted when the color is changed.
|
||||
|
||||
@@ -63,27 +63,27 @@ Member Function Description
|
||||
|
||||
.. _class_ColorPickerButton_get_pick_color:
|
||||
|
||||
- :ref:`Color<class_color>` **get_pick_color** **(** **)** const
|
||||
- :ref:`Color<class_color>` **get_pick_color** **(** **)** const
|
||||
|
||||
.. _class_ColorPickerButton_get_picker:
|
||||
|
||||
- :ref:`ColorPicker<class_colorpicker>` **get_picker** **(** **)**
|
||||
- :ref:`ColorPicker<class_colorpicker>` **get_picker** **(** **)**
|
||||
|
||||
.. _class_ColorPickerButton_is_editing_alpha:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_editing_alpha** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_editing_alpha** **(** **)** const
|
||||
|
||||
See :ref:`ColorPicker.is_edit_alpha<class_ColorPicker_is_edit_alpha>`
|
||||
|
||||
.. _class_ColorPickerButton_set_edit_alpha:
|
||||
|
||||
- void **set_edit_alpha** **(** :ref:`bool<class_bool>` show **)**
|
||||
- void **set_edit_alpha** **(** :ref:`bool<class_bool>` show **)**
|
||||
|
||||
See :ref:`ColorPicker.set_edit_alpha<class_ColorPicker_set_edit_alpha>`
|
||||
|
||||
.. _class_ColorPickerButton_set_pick_color:
|
||||
|
||||
- void **set_pick_color** **(** :ref:`Color<class_color>` color **)**
|
||||
- void **set_pick_color** **(** :ref:`Color<class_color>` color **)**
|
||||
|
||||
Set new color to ColorRect.
|
||||
|
||||
|
||||
@@ -19,11 +19,11 @@ Colored rect for canvas.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`get_frame_color<class_ColorRect_get_frame_color>` **(** **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_frame_color<class_ColorRect_set_frame_color>` **(** :ref:`Color<class_color>` color **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`get_frame_color<class_ColorRect_get_frame_color>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_frame_color<class_ColorRect_set_frame_color>` **(** :ref:`Color<class_color>` color **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -47,7 +47,7 @@ Member Function Description
|
||||
|
||||
.. _class_ColorRect_get_frame_color:
|
||||
|
||||
- :ref:`Color<class_color>` **get_frame_color** **(** **)** const
|
||||
- :ref:`Color<class_color>` **get_frame_color** **(** **)** const
|
||||
|
||||
Return the color in RGBA format.
|
||||
|
||||
@@ -58,7 +58,7 @@ Return the color in RGBA format.
|
||||
|
||||
.. _class_ColorRect_set_frame_color:
|
||||
|
||||
- void **set_frame_color** **(** :ref:`Color<class_color>` color **)**
|
||||
- void **set_frame_color** **(** :ref:`Color<class_color>` color **)**
|
||||
|
||||
Set new color to ColorRect.
|
||||
|
||||
|
||||
@@ -19,11 +19,11 @@ Concave polygon shape.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolVector3Array<class_poolvector3array>` | :ref:`get_faces<class_ConcavePolygonShape_get_faces>` **(** **)** const |
|
||||
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_faces<class_ConcavePolygonShape_set_faces>` **(** :ref:`PoolVector3Array<class_poolvector3array>` faces **)** |
|
||||
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolVector3Array<class_poolvector3array>` | :ref:`get_faces<class_ConcavePolygonShape_get_faces>` **(** **)** const |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_faces<class_ConcavePolygonShape_set_faces>` **(** :ref:`PoolVector3Array<class_poolvector3array>` faces **)** |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -35,13 +35,13 @@ Member Function Description
|
||||
|
||||
.. _class_ConcavePolygonShape_get_faces:
|
||||
|
||||
- :ref:`PoolVector3Array<class_poolvector3array>` **get_faces** **(** **)** const
|
||||
- :ref:`PoolVector3Array<class_poolvector3array>` **get_faces** **(** **)** const
|
||||
|
||||
Return the faces (an array of triangles).
|
||||
|
||||
.. _class_ConcavePolygonShape_set_faces:
|
||||
|
||||
- void **set_faces** **(** :ref:`PoolVector3Array<class_poolvector3array>` faces **)**
|
||||
- void **set_faces** **(** :ref:`PoolVector3Array<class_poolvector3array>` faces **)**
|
||||
|
||||
Set the faces (an array of triangles).
|
||||
|
||||
|
||||
@@ -19,11 +19,11 @@ Concave polygon 2D shape resource for physics.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolVector2Array<class_poolvector2array>` | :ref:`get_segments<class_ConcavePolygonShape2D_get_segments>` **(** **)** const |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_segments<class_ConcavePolygonShape2D_set_segments>` **(** :ref:`PoolVector2Array<class_poolvector2array>` segments **)** |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolVector2Array<class_poolvector2array>` | :ref:`get_segments<class_ConcavePolygonShape2D_get_segments>` **(** **)** const |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_segments<class_ConcavePolygonShape2D_set_segments>` **(** :ref:`PoolVector2Array<class_poolvector2array>` segments **)** |
|
||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -45,13 +45,13 @@ Member Function Description
|
||||
|
||||
.. _class_ConcavePolygonShape2D_get_segments:
|
||||
|
||||
- :ref:`PoolVector2Array<class_poolvector2array>` **get_segments** **(** **)** const
|
||||
- :ref:`PoolVector2Array<class_poolvector2array>` **get_segments** **(** **)** const
|
||||
|
||||
Return the array of segments.
|
||||
|
||||
.. _class_ConcavePolygonShape2D_set_segments:
|
||||
|
||||
- void **set_segments** **(** :ref:`PoolVector2Array<class_poolvector2array>` segments **)**
|
||||
- void **set_segments** **(** :ref:`PoolVector2Array<class_poolvector2array>` segments **)**
|
||||
|
||||
Set the array of segments.
|
||||
|
||||
|
||||
@@ -19,11 +19,11 @@ A twist joint between two 3D bodies
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_param<class_ConeTwistJoint_get_param>` **(** :ref:`int<class_int>` param **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_param<class_ConeTwistJoint_set_param>` **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_param<class_ConeTwistJoint_get_param>` **(** :ref:`int<class_int>` param **)** const |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_param<class_ConeTwistJoint_set_param>` **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -93,10 +93,10 @@ Member Function Description
|
||||
|
||||
.. _class_ConeTwistJoint_get_param:
|
||||
|
||||
- :ref:`float<class_float>` **get_param** **(** :ref:`int<class_int>` param **)** const
|
||||
- :ref:`float<class_float>` **get_param** **(** :ref:`int<class_int>` param **)** const
|
||||
|
||||
.. _class_ConeTwistJoint_set_param:
|
||||
|
||||
- void **set_param** **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)**
|
||||
- void **set_param** **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)**
|
||||
|
||||
|
||||
|
||||
@@ -19,25 +19,25 @@ Helper class to handle INI-style files.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`erase_section<class_ConfigFile_erase_section>` **(** :ref:`String<class_string>` section **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_section_keys<class_ConfigFile_get_section_keys>` **(** :ref:`String<class_string>` section **)** 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:`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:`int<class_int>` | :ref:`load<class_ConfigFile_load>` **(** :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:`erase_section<class_ConfigFile_erase_section>` **(** :ref:`String<class_string>` section **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_section_keys<class_ConfigFile_get_section_keys>` **(** :ref:`String<class_string>` section **)** 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:`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:`int<class_int>` | :ref:`load<class_ConfigFile_load>` **(** :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 **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -73,55 +73,55 @@ Member Function Description
|
||||
|
||||
.. _class_ConfigFile_erase_section:
|
||||
|
||||
- void **erase_section** **(** :ref:`String<class_string>` section **)**
|
||||
- void **erase_section** **(** :ref:`String<class_string>` section **)**
|
||||
|
||||
Deletes the specified section along with all the key-value pairs inside.
|
||||
|
||||
.. _class_ConfigFile_get_section_keys:
|
||||
|
||||
- :ref:`PoolStringArray<class_poolstringarray>` **get_section_keys** **(** :ref:`String<class_string>` section **)** const
|
||||
- :ref:`PoolStringArray<class_poolstringarray>` **get_section_keys** **(** :ref:`String<class_string>` section **)** const
|
||||
|
||||
Returns an array of all defined key identifiers in the specified section.
|
||||
|
||||
.. _class_ConfigFile_get_sections:
|
||||
|
||||
- :ref:`PoolStringArray<class_poolstringarray>` **get_sections** **(** **)** const
|
||||
- :ref:`PoolStringArray<class_poolstringarray>` **get_sections** **(** **)** const
|
||||
|
||||
Returns an array of all defined section identifiers.
|
||||
|
||||
.. _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
|
||||
|
||||
Returns 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, or ``null`` if it is omitted.
|
||||
|
||||
.. _class_ConfigFile_has_section:
|
||||
|
||||
- :ref:`bool<class_bool>` **has_section** **(** :ref:`String<class_string>` section **)** const
|
||||
- :ref:`bool<class_bool>` **has_section** **(** :ref:`String<class_string>` section **)** const
|
||||
|
||||
Returns ``true`` if the specified section exists.
|
||||
|
||||
.. _class_ConfigFile_has_section_key:
|
||||
|
||||
- :ref:`bool<class_bool>` **has_section_key** **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key **)** const
|
||||
- :ref:`bool<class_bool>` **has_section_key** **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key **)** const
|
||||
|
||||
Returns ``true`` if the specified section-key pair exists.
|
||||
|
||||
.. _class_ConfigFile_load:
|
||||
|
||||
- :ref:`int<class_int>` **load** **(** :ref:`String<class_string>` path **)**
|
||||
- :ref:`int<class_int>` **load** **(** :ref:`String<class_string>` path **)**
|
||||
|
||||
Loads the config file specified as a parameter. The file's contents are parsed and loaded in the ConfigFile object which the method was called on. Returns one of the ``OK``, ``FAILED`` or ``ERR\_\*`` constants listed in :ref:`@Global Scope<class_@global scope>`. If the load was successful, the return value is ``OK``.
|
||||
|
||||
.. _class_ConfigFile_save:
|
||||
|
||||
- :ref:`int<class_int>` **save** **(** :ref:`String<class_string>` path **)**
|
||||
- :ref:`int<class_int>` **save** **(** :ref:`String<class_string>` path **)**
|
||||
|
||||
Saves the contents of the ConfigFile object to the file specified as a parameter. The output file uses an INI-style structure. Returns one of the ``OK``, ``FAILED`` or ``ERR\_\*`` constants listed in :ref:`@Global Scope<class_@global scope>`. If the load was successful, the return value is ``OK``.
|
||||
|
||||
.. _class_ConfigFile_set_value:
|
||||
|
||||
- void **set_value** **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, :ref:`Variant<class_variant>` value **)**
|
||||
- void **set_value** **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, :ref:`Variant<class_variant>` value **)**
|
||||
|
||||
Assigns a value to the specified key of the the specified section. If the section and/or the key do not exist, they are created. Passing a ``null`` value deletes the specified key if it exists, and deletes the section if it ends up empty once the key has been removed.
|
||||
|
||||
|
||||
@@ -21,9 +21,9 @@ Dialog for confirmation of actions.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------+---------------------------------------------------------------------+
|
||||
| :ref:`Button<class_button>` | :ref:`get_cancel<class_ConfirmationDialog_get_cancel>` **(** **)** |
|
||||
+------------------------------+---------------------------------------------------------------------+
|
||||
+------------------------------+--------------------------------------------------------------------+
|
||||
| :ref:`Button<class_button>` | :ref:`get_cancel<class_ConfirmationDialog_get_cancel>` **(** **)** |
|
||||
+------------------------------+--------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -35,7 +35,7 @@ Member Function Description
|
||||
|
||||
.. _class_ConfirmationDialog_get_cancel:
|
||||
|
||||
- :ref:`Button<class_button>` **get_cancel** **(** **)**
|
||||
- :ref:`Button<class_button>` **get_cancel** **(** **)**
|
||||
|
||||
Return the cancel button.
|
||||
|
||||
|
||||
@@ -21,18 +21,18 @@ Base node for containers.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+-------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`fit_child_in_rect<class_Container_fit_child_in_rect>` **(** :ref:`Control<class_control>` child, :ref:`Rect2<class_rect2>` rect **)** |
|
||||
+-------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`queue_sort<class_Container_queue_sort>` **(** **)** |
|
||||
+-------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`fit_child_in_rect<class_Container_fit_child_in_rect>` **(** :ref:`Control<class_control>` child, :ref:`Rect2<class_rect2>` rect **)** |
|
||||
+-------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`queue_sort<class_Container_queue_sort>` **(** **)** |
|
||||
+-------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_Container_sort_children:
|
||||
|
||||
- **sort_children** **(** **)**
|
||||
- **sort_children** **(** **)**
|
||||
|
||||
Emitted when sorting the children is needed.
|
||||
|
||||
@@ -54,13 +54,13 @@ Member Function Description
|
||||
|
||||
.. _class_Container_fit_child_in_rect:
|
||||
|
||||
- void **fit_child_in_rect** **(** :ref:`Control<class_control>` child, :ref:`Rect2<class_rect2>` rect **)**
|
||||
- void **fit_child_in_rect** **(** :ref:`Control<class_control>` child, :ref:`Rect2<class_rect2>` rect **)**
|
||||
|
||||
Fit a child control in a given rect. This is mainly a helper for creating custom container classes.
|
||||
|
||||
.. _class_Container_queue_sort:
|
||||
|
||||
- void **queue_sort** **(** **)**
|
||||
- void **queue_sort** **(** **)**
|
||||
|
||||
Queue resort of the contained children. This is called automatically anyway, but can be called upon request.
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -19,11 +19,11 @@ Convex polygon shape for 3D physics.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolVector3Array<class_poolvector3array>` | :ref:`get_points<class_ConvexPolygonShape_get_points>` **(** **)** const |
|
||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_points<class_ConvexPolygonShape_set_points>` **(** :ref:`PoolVector3Array<class_poolvector3array>` points **)** |
|
||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolVector3Array<class_poolvector3array>` | :ref:`get_points<class_ConvexPolygonShape_get_points>` **(** **)** const |
|
||||
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_points<class_ConvexPolygonShape_set_points>` **(** :ref:`PoolVector3Array<class_poolvector3array>` points **)** |
|
||||
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -43,10 +43,10 @@ Member Function Description
|
||||
|
||||
.. _class_ConvexPolygonShape_get_points:
|
||||
|
||||
- :ref:`PoolVector3Array<class_poolvector3array>` **get_points** **(** **)** const
|
||||
- :ref:`PoolVector3Array<class_poolvector3array>` **get_points** **(** **)** const
|
||||
|
||||
.. _class_ConvexPolygonShape_set_points:
|
||||
|
||||
- void **set_points** **(** :ref:`PoolVector3Array<class_poolvector3array>` points **)**
|
||||
- void **set_points** **(** :ref:`PoolVector3Array<class_poolvector3array>` points **)**
|
||||
|
||||
|
||||
|
||||
@@ -19,13 +19,13 @@ Convex Polygon Shape for 2D physics.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolVector2Array<class_poolvector2array>` | :ref:`get_points<class_ConvexPolygonShape2D_get_points>` **(** **)** const |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_cloud<class_ConvexPolygonShape2D_set_point_cloud>` **(** :ref:`PoolVector2Array<class_poolvector2array>` point_cloud **)** |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_points<class_ConvexPolygonShape2D_set_points>` **(** :ref:`PoolVector2Array<class_poolvector2array>` points **)** |
|
||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolVector2Array<class_poolvector2array>` | :ref:`get_points<class_ConvexPolygonShape2D_get_points>` **(** **)** const |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_cloud<class_ConvexPolygonShape2D_set_point_cloud>` **(** :ref:`PoolVector2Array<class_poolvector2array>` point_cloud **)** |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_points<class_ConvexPolygonShape2D_set_points>` **(** :ref:`PoolVector2Array<class_poolvector2array>` points **)** |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -47,19 +47,19 @@ Member Function Description
|
||||
|
||||
.. _class_ConvexPolygonShape2D_get_points:
|
||||
|
||||
- :ref:`PoolVector2Array<class_poolvector2array>` **get_points** **(** **)** const
|
||||
- :ref:`PoolVector2Array<class_poolvector2array>` **get_points** **(** **)** const
|
||||
|
||||
Returns a list of points in either clockwise or counter clockwise order, forming a convex polygon.
|
||||
|
||||
.. _class_ConvexPolygonShape2D_set_point_cloud:
|
||||
|
||||
- void **set_point_cloud** **(** :ref:`PoolVector2Array<class_poolvector2array>` point_cloud **)**
|
||||
- void **set_point_cloud** **(** :ref:`PoolVector2Array<class_poolvector2array>` point_cloud **)**
|
||||
|
||||
Currently, this method does nothing.
|
||||
|
||||
.. _class_ConvexPolygonShape2D_set_points:
|
||||
|
||||
- void **set_points** **(** :ref:`PoolVector2Array<class_poolvector2array>` points **)**
|
||||
- void **set_points** **(** :ref:`PoolVector2Array<class_poolvector2array>` points **)**
|
||||
|
||||
Sets a list of points in either clockwise or counter clockwise order, forming a convex polygon.
|
||||
|
||||
|
||||
@@ -19,15 +19,15 @@ Brief Description
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------+--------------------------------------------------------+
|
||||
| :ref:`Object<class_object>` | :ref:`new<class_CSharpScript_new>` **(** **)** vararg |
|
||||
+------------------------------+--------------------------------------------------------+
|
||||
+------------------------------+-------------------------------------------------------+
|
||||
| :ref:`Object<class_object>` | :ref:`new<class_CSharpScript_new>` **(** **)** vararg |
|
||||
+------------------------------+-------------------------------------------------------+
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_CSharpScript_new:
|
||||
|
||||
- :ref:`Object<class_object>` **new** **(** **)** vararg
|
||||
- :ref:`Object<class_object>` **new** **(** **)** vararg
|
||||
|
||||
|
||||
|
||||
@@ -19,27 +19,27 @@ Brief Description
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_flags<class_CubeMap_get_flags>` **(** **)** const |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_height<class_CubeMap_get_height>` **(** **)** const |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_lossy_storage_quality<class_CubeMap_get_lossy_storage_quality>` **(** **)** const |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`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_width<class_CubeMap_get_width>` **(** **)** const |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_flags<class_CubeMap_set_flags>` **(** :ref:`int<class_int>` flags **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_lossy_storage_quality<class_CubeMap_set_lossy_storage_quality>` **(** :ref:`float<class_float>` quality **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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 **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_flags<class_CubeMap_get_flags>` **(** **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_height<class_CubeMap_get_height>` **(** **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_lossy_storage_quality<class_CubeMap_get_lossy_storage_quality>` **(** **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`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_width<class_CubeMap_get_width>` **(** **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_flags<class_CubeMap_set_flags>` **(** :ref:`int<class_int>` flags **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_lossy_storage_quality<class_CubeMap_set_lossy_storage_quality>` **(** :ref:`float<class_float>` quality **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_side<class_CubeMap_set_side>` **(** :ref:`int<class_int>` side, :ref:`Image<class_image>` image **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_storage<class_CubeMap_set_storage>` **(** :ref:`int<class_int>` mode **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Numeric Constants
|
||||
-----------------
|
||||
@@ -63,42 +63,42 @@ Member Function Description
|
||||
|
||||
.. _class_CubeMap_get_flags:
|
||||
|
||||
- :ref:`int<class_int>` **get_flags** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_flags** **(** **)** const
|
||||
|
||||
.. _class_CubeMap_get_height:
|
||||
|
||||
- :ref:`int<class_int>` **get_height** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_height** **(** **)** const
|
||||
|
||||
.. _class_CubeMap_get_lossy_storage_quality:
|
||||
|
||||
- :ref:`float<class_float>` **get_lossy_storage_quality** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_lossy_storage_quality** **(** **)** const
|
||||
|
||||
.. _class_CubeMap_get_side:
|
||||
|
||||
- :ref:`Image<class_image>` **get_side** **(** :ref:`int<class_int>` side **)** const
|
||||
- :ref:`Image<class_image>` **get_side** **(** :ref:`int<class_int>` side **)** const
|
||||
|
||||
.. _class_CubeMap_get_storage:
|
||||
|
||||
- :ref:`int<class_int>` **get_storage** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_storage** **(** **)** const
|
||||
|
||||
.. _class_CubeMap_get_width:
|
||||
|
||||
- :ref:`int<class_int>` **get_width** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_width** **(** **)** const
|
||||
|
||||
.. _class_CubeMap_set_flags:
|
||||
|
||||
- void **set_flags** **(** :ref:`int<class_int>` flags **)**
|
||||
- void **set_flags** **(** :ref:`int<class_int>` flags **)**
|
||||
|
||||
.. _class_CubeMap_set_lossy_storage_quality:
|
||||
|
||||
- void **set_lossy_storage_quality** **(** :ref:`float<class_float>` quality **)**
|
||||
- void **set_lossy_storage_quality** **(** :ref:`float<class_float>` quality **)**
|
||||
|
||||
.. _class_CubeMap_set_side:
|
||||
|
||||
- void **set_side** **(** :ref:`int<class_int>` side, :ref:`Image<class_image>` image **)**
|
||||
- void **set_side** **(** :ref:`int<class_int>` side, :ref:`Image<class_image>` image **)**
|
||||
|
||||
.. _class_CubeMap_set_storage:
|
||||
|
||||
- void **set_storage** **(** :ref:`int<class_int>` mode **)**
|
||||
- void **set_storage** **(** :ref:`int<class_int>` mode **)**
|
||||
|
||||
|
||||
|
||||
@@ -19,23 +19,23 @@ Generate an axis-aligned cuboid :ref:`PrimitiveMesh<class_primitivemesh>`.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_size<class_CubeMesh_get_size>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_subdivide_depth<class_CubeMesh_get_subdivide_depth>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_subdivide_height<class_CubeMesh_get_subdivide_height>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_subdivide_width<class_CubeMesh_get_subdivide_width>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_size<class_CubeMesh_set_size>` **(** :ref:`Vector3<class_vector3>` size **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_subdivide_depth<class_CubeMesh_set_subdivide_depth>` **(** :ref:`int<class_int>` divisions **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_subdivide_height<class_CubeMesh_set_subdivide_height>` **(** :ref:`int<class_int>` divisions **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_subdivide_width<class_CubeMesh_set_subdivide_width>` **(** :ref:`int<class_int>` subdivide **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_size<class_CubeMesh_get_size>` **(** **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_subdivide_depth<class_CubeMesh_get_subdivide_depth>` **(** **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_subdivide_height<class_CubeMesh_get_subdivide_height>` **(** **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_subdivide_width<class_CubeMesh_get_subdivide_width>` **(** **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_size<class_CubeMesh_set_size>` **(** :ref:`Vector3<class_vector3>` size **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_subdivide_depth<class_CubeMesh_set_subdivide_depth>` **(** :ref:`int<class_int>` divisions **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_subdivide_height<class_CubeMesh_set_subdivide_height>` **(** :ref:`int<class_int>` divisions **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_subdivide_width<class_CubeMesh_set_subdivide_width>` **(** :ref:`int<class_int>` subdivide **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -67,34 +67,34 @@ Member Function Description
|
||||
|
||||
.. _class_CubeMesh_get_size:
|
||||
|
||||
- :ref:`Vector3<class_vector3>` **get_size** **(** **)** const
|
||||
- :ref:`Vector3<class_vector3>` **get_size** **(** **)** const
|
||||
|
||||
.. _class_CubeMesh_get_subdivide_depth:
|
||||
|
||||
- :ref:`int<class_int>` **get_subdivide_depth** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_subdivide_depth** **(** **)** const
|
||||
|
||||
.. _class_CubeMesh_get_subdivide_height:
|
||||
|
||||
- :ref:`int<class_int>` **get_subdivide_height** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_subdivide_height** **(** **)** const
|
||||
|
||||
.. _class_CubeMesh_get_subdivide_width:
|
||||
|
||||
- :ref:`int<class_int>` **get_subdivide_width** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_subdivide_width** **(** **)** const
|
||||
|
||||
.. _class_CubeMesh_set_size:
|
||||
|
||||
- void **set_size** **(** :ref:`Vector3<class_vector3>` size **)**
|
||||
- void **set_size** **(** :ref:`Vector3<class_vector3>` size **)**
|
||||
|
||||
.. _class_CubeMesh_set_subdivide_depth:
|
||||
|
||||
- void **set_subdivide_depth** **(** :ref:`int<class_int>` divisions **)**
|
||||
- void **set_subdivide_depth** **(** :ref:`int<class_int>` divisions **)**
|
||||
|
||||
.. _class_CubeMesh_set_subdivide_height:
|
||||
|
||||
- void **set_subdivide_height** **(** :ref:`int<class_int>` divisions **)**
|
||||
- void **set_subdivide_height** **(** :ref:`int<class_int>` divisions **)**
|
||||
|
||||
.. _class_CubeMesh_set_subdivide_width:
|
||||
|
||||
- void **set_subdivide_width** **(** :ref:`int<class_int>` subdivide **)**
|
||||
- void **set_subdivide_width** **(** :ref:`int<class_int>` subdivide **)**
|
||||
|
||||
|
||||
|
||||
@@ -19,62 +19,62 @@ Brief Description
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`add_point<class_Curve_add_point>` **(** :ref:`Vector2<class_vector2>` position, :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 **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`bake<class_Curve_bake>` **(** **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clean_dupes<class_Curve_clean_dupes>` **(** **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_points<class_Curve_clear_points>` **(** **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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_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:`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_position<class_Curve_get_point_position>` **(** :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:`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 **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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_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_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 **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :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_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 **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`add_point<class_Curve_add_point>` **(** :ref:`Vector2<class_vector2>` position, :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 **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`bake<class_Curve_bake>` **(** **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clean_dupes<class_Curve_clean_dupes>` **(** **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_points<class_Curve_clear_points>` **(** **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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_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:`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_position<class_Curve_get_point_position>` **(** :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:`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 **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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_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_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 **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :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_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 **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_Curve_range_changed:
|
||||
|
||||
- **range_changed** **(** **)**
|
||||
- **range_changed** **(** **)**
|
||||
|
||||
|
||||
Member Variables
|
||||
@@ -109,98 +109,98 @@ Member Function Description
|
||||
|
||||
.. _class_Curve_add_point:
|
||||
|
||||
- :ref:`int<class_int>` **add_point** **(** :ref:`Vector2<class_vector2>` position, :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>` position, :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 **)**
|
||||
|
||||
.. _class_Curve_bake:
|
||||
|
||||
- void **bake** **(** **)**
|
||||
- void **bake** **(** **)**
|
||||
|
||||
.. _class_Curve_clean_dupes:
|
||||
|
||||
- void **clean_dupes** **(** **)**
|
||||
- void **clean_dupes** **(** **)**
|
||||
|
||||
.. _class_Curve_clear_points:
|
||||
|
||||
- void **clear_points** **(** **)**
|
||||
- void **clear_points** **(** **)**
|
||||
|
||||
.. _class_Curve_get_bake_resolution:
|
||||
|
||||
- :ref:`int<class_int>` **get_bake_resolution** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_bake_resolution** **(** **)** const
|
||||
|
||||
.. _class_Curve_get_max_value:
|
||||
|
||||
- :ref:`float<class_float>` **get_max_value** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_max_value** **(** **)** const
|
||||
|
||||
.. _class_Curve_get_min_value:
|
||||
|
||||
- :ref:`float<class_float>` **get_min_value** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_min_value** **(** **)** const
|
||||
|
||||
.. _class_Curve_get_point_left_mode:
|
||||
|
||||
- :ref:`int<class_int>` **get_point_left_mode** **(** :ref:`int<class_int>` index **)** const
|
||||
- :ref:`int<class_int>` **get_point_left_mode** **(** :ref:`int<class_int>` index **)** const
|
||||
|
||||
.. _class_Curve_get_point_left_tangent:
|
||||
|
||||
- :ref:`float<class_float>` **get_point_left_tangent** **(** :ref:`int<class_int>` index **)** const
|
||||
- :ref:`float<class_float>` **get_point_left_tangent** **(** :ref:`int<class_int>` index **)** const
|
||||
|
||||
.. _class_Curve_get_point_position:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **get_point_position** **(** :ref:`int<class_int>` index **)** const
|
||||
- :ref:`Vector2<class_vector2>` **get_point_position** **(** :ref:`int<class_int>` index **)** const
|
||||
|
||||
.. _class_Curve_get_point_right_mode:
|
||||
|
||||
- :ref:`int<class_int>` **get_point_right_mode** **(** :ref:`int<class_int>` index **)** const
|
||||
- :ref:`int<class_int>` **get_point_right_mode** **(** :ref:`int<class_int>` index **)** const
|
||||
|
||||
.. _class_Curve_get_point_right_tangent:
|
||||
|
||||
- :ref:`float<class_float>` **get_point_right_tangent** **(** :ref:`int<class_int>` index **)** const
|
||||
- :ref:`float<class_float>` **get_point_right_tangent** **(** :ref:`int<class_int>` index **)** const
|
||||
|
||||
.. _class_Curve_interpolate:
|
||||
|
||||
- :ref:`float<class_float>` **interpolate** **(** :ref:`float<class_float>` offset **)** const
|
||||
- :ref:`float<class_float>` **interpolate** **(** :ref:`float<class_float>` offset **)** const
|
||||
|
||||
.. _class_Curve_interpolate_baked:
|
||||
|
||||
- :ref:`float<class_float>` **interpolate_baked** **(** :ref:`float<class_float>` offset **)**
|
||||
- :ref:`float<class_float>` **interpolate_baked** **(** :ref:`float<class_float>` offset **)**
|
||||
|
||||
.. _class_Curve_remove_point:
|
||||
|
||||
- void **remove_point** **(** :ref:`int<class_int>` index **)**
|
||||
- void **remove_point** **(** :ref:`int<class_int>` index **)**
|
||||
|
||||
.. _class_Curve_set_bake_resolution:
|
||||
|
||||
- void **set_bake_resolution** **(** :ref:`int<class_int>` resolution **)**
|
||||
- void **set_bake_resolution** **(** :ref:`int<class_int>` resolution **)**
|
||||
|
||||
.. _class_Curve_set_max_value:
|
||||
|
||||
- void **set_max_value** **(** :ref:`float<class_float>` max **)**
|
||||
- void **set_max_value** **(** :ref:`float<class_float>` max **)**
|
||||
|
||||
.. _class_Curve_set_min_value:
|
||||
|
||||
- void **set_min_value** **(** :ref:`float<class_float>` min **)**
|
||||
- void **set_min_value** **(** :ref:`float<class_float>` min **)**
|
||||
|
||||
.. _class_Curve_set_point_left_mode:
|
||||
|
||||
- void **set_point_left_mode** **(** :ref:`int<class_int>` index, :ref:`int<class_int>` mode **)**
|
||||
- void **set_point_left_mode** **(** :ref:`int<class_int>` index, :ref:`int<class_int>` mode **)**
|
||||
|
||||
.. _class_Curve_set_point_left_tangent:
|
||||
|
||||
- void **set_point_left_tangent** **(** :ref:`int<class_int>` index, :ref:`float<class_float>` tangent **)**
|
||||
- void **set_point_left_tangent** **(** :ref:`int<class_int>` index, :ref:`float<class_float>` tangent **)**
|
||||
|
||||
.. _class_Curve_set_point_offset:
|
||||
|
||||
- :ref:`int<class_int>` **set_point_offset** **(** :ref:`int<class_int>` index, :ref:`float<class_float>` offset **)**
|
||||
- :ref:`int<class_int>` **set_point_offset** **(** :ref:`int<class_int>` index, :ref:`float<class_float>` offset **)**
|
||||
|
||||
.. _class_Curve_set_point_right_mode:
|
||||
|
||||
- void **set_point_right_mode** **(** :ref:`int<class_int>` index, :ref:`int<class_int>` mode **)**
|
||||
- void **set_point_right_mode** **(** :ref:`int<class_int>` index, :ref:`int<class_int>` mode **)**
|
||||
|
||||
.. _class_Curve_set_point_right_tangent:
|
||||
|
||||
- void **set_point_right_tangent** **(** :ref:`int<class_int>` index, :ref:`float<class_float>` tangent **)**
|
||||
- void **set_point_right_tangent** **(** :ref:`int<class_int>` index, :ref:`float<class_float>` tangent **)**
|
||||
|
||||
.. _class_Curve_set_point_value:
|
||||
|
||||
- void **set_point_value** **(** :ref:`int<class_int>` index, :ref:`float<class_float>` y **)**
|
||||
- void **set_point_value** **(** :ref:`int<class_int>` index, :ref:`float<class_float>` y **)**
|
||||
|
||||
|
||||
|
||||
@@ -19,43 +19,43 @@ Describes a Bezier curve in 2D space.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_point<class_Curve2D_add_point>` **(** :ref:`Vector2<class_vector2>` position, :ref:`Vector2<class_vector2>` in=Vector2( 0, 0 ), :ref:`Vector2<class_vector2>` out=Vector2( 0, 0 ), :ref:`int<class_int>` at_position=-1 **)** |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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_baked_length<class_Curve2D_get_baked_length>` **(** **)** 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:`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_position<class_Curve2D_get_point_position>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`interpolate<class_Curve2D_interpolate>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` t **)** const |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`interpolate_baked<class_Curve2D_interpolate_baked>` **(** :ref:`float<class_float>` offset, :ref:`bool<class_bool>` cubic=false **)** const |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`interpolatef<class_Curve2D_interpolatef>` **(** :ref:`float<class_float>` fofs **)** const |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_point<class_Curve2D_remove_point>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bake_interval<class_Curve2D_set_bake_interval>` **(** :ref:`float<class_float>` distance **)** |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_in<class_Curve2D_set_point_in>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` position **)** |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_out<class_Curve2D_set_point_out>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` position **)** |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_position<class_Curve2D_set_point_position>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` position **)** |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolVector2Array<class_poolvector2array>` | :ref:`tessellate<class_Curve2D_tessellate>` **(** :ref:`int<class_int>` max_stages=5, :ref:`float<class_float>` tolerance_degrees=4 **)** const |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_point<class_Curve2D_add_point>` **(** :ref:`Vector2<class_vector2>` position, :ref:`Vector2<class_vector2>` in=Vector2( 0, 0 ), :ref:`Vector2<class_vector2>` out=Vector2( 0, 0 ), :ref:`int<class_int>` at_position=-1 **)** |
|
||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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_baked_length<class_Curve2D_get_baked_length>` **(** **)** 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:`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_position<class_Curve2D_get_point_position>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`interpolate<class_Curve2D_interpolate>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` t **)** const |
|
||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`interpolate_baked<class_Curve2D_interpolate_baked>` **(** :ref:`float<class_float>` offset, :ref:`bool<class_bool>` cubic=false **)** const |
|
||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`interpolatef<class_Curve2D_interpolatef>` **(** :ref:`float<class_float>` fofs **)** const |
|
||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_point<class_Curve2D_remove_point>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bake_interval<class_Curve2D_set_bake_interval>` **(** :ref:`float<class_float>` distance **)** |
|
||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_in<class_Curve2D_set_point_in>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` position **)** |
|
||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_out<class_Curve2D_set_point_out>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` position **)** |
|
||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_position<class_Curve2D_set_point_position>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` position **)** |
|
||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolVector2Array<class_poolvector2array>` | :ref:`tessellate<class_Curve2D_tessellate>` **(** :ref:`int<class_int>` max_stages=5, :ref:`float<class_float>` tolerance_degrees=4 **)** const |
|
||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -81,7 +81,7 @@ Member Function Description
|
||||
|
||||
.. _class_Curve2D_add_point:
|
||||
|
||||
- void **add_point** **(** :ref:`Vector2<class_vector2>` position, :ref:`Vector2<class_vector2>` in=Vector2( 0, 0 ), :ref:`Vector2<class_vector2>` out=Vector2( 0, 0 ), :ref:`int<class_int>` at_position=-1 **)**
|
||||
- void **add_point** **(** :ref:`Vector2<class_vector2>` position, :ref:`Vector2<class_vector2>` in=Vector2( 0, 0 ), :ref:`Vector2<class_vector2>` out=Vector2( 0, 0 ), :ref:`int<class_int>` at_position=-1 **)**
|
||||
|
||||
Adds a point to a curve, at "position", with control points "in" and "out".
|
||||
|
||||
@@ -89,53 +89,53 @@ If "at_position" is given, the point is inserted before the point number "at_pos
|
||||
|
||||
.. _class_Curve2D_clear_points:
|
||||
|
||||
- void **clear_points** **(** **)**
|
||||
- void **clear_points** **(** **)**
|
||||
|
||||
.. _class_Curve2D_get_bake_interval:
|
||||
|
||||
- :ref:`float<class_float>` **get_bake_interval** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_bake_interval** **(** **)** const
|
||||
|
||||
Returns the distance between two adjacent cached points.
|
||||
|
||||
.. _class_Curve2D_get_baked_length:
|
||||
|
||||
- :ref:`float<class_float>` **get_baked_length** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_baked_length** **(** **)** const
|
||||
|
||||
Returns the total length of the curve, based on the cached points. Given enough density (see :ref:`set_bake_interval<class_Curve2D_set_bake_interval>`), it should be approximate enough.
|
||||
|
||||
.. _class_Curve2D_get_baked_points:
|
||||
|
||||
- :ref:`PoolVector2Array<class_poolvector2array>` **get_baked_points** **(** **)** const
|
||||
- :ref:`PoolVector2Array<class_poolvector2array>` **get_baked_points** **(** **)** const
|
||||
|
||||
Returns the cache of points as a :ref:`PoolVector2Array<class_poolvector2array>`.
|
||||
|
||||
.. _class_Curve2D_get_point_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_point_count** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_point_count** **(** **)** const
|
||||
|
||||
Returns the number of points describing the curve.
|
||||
|
||||
.. _class_Curve2D_get_point_in:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **get_point_in** **(** :ref:`int<class_int>` idx **)** const
|
||||
- :ref:`Vector2<class_vector2>` **get_point_in** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Returns the position of the control point leading to the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0).
|
||||
|
||||
.. _class_Curve2D_get_point_out:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **get_point_out** **(** :ref:`int<class_int>` idx **)** const
|
||||
- :ref:`Vector2<class_vector2>` **get_point_out** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Returns the position of the control point leading out of the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0).
|
||||
|
||||
.. _class_Curve2D_get_point_position:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **get_point_position** **(** :ref:`int<class_int>` idx **)** const
|
||||
- :ref:`Vector2<class_vector2>` **get_point_position** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Returns the position of the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0).
|
||||
|
||||
.. _class_Curve2D_interpolate:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **interpolate** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` t **)** const
|
||||
- :ref:`Vector2<class_vector2>` **interpolate** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` t **)** const
|
||||
|
||||
Returns the position between the vertex "idx" and the vertex "idx"+1, where "t" controls if the point is the first vertex (t = 0.0), the last vertex (t = 1.0), or in between. Values of "t" outside the range (0.0 >= t <=1) give strange, but predictable results.
|
||||
|
||||
@@ -143,7 +143,7 @@ If "idx" is out of bounds it is truncated to the first or last vertex, and "t" i
|
||||
|
||||
.. _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=false **)** const
|
||||
|
||||
Returns a point within the curve at position "offset", where "offset" is measured as a pixel distance along the curve.
|
||||
|
||||
@@ -153,43 +153,43 @@ Cubic interpolation tends to follow the curves better, but linear is faster (and
|
||||
|
||||
.. _class_Curve2D_interpolatef:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **interpolatef** **(** :ref:`float<class_float>` fofs **)** const
|
||||
- :ref:`Vector2<class_vector2>` **interpolatef** **(** :ref:`float<class_float>` fofs **)** const
|
||||
|
||||
Returns the position at the vertex "fofs". It calls :ref:`interpolate<class_Curve2D_interpolate>` using the integer part of fofs as "idx", and its fractional part as "t".
|
||||
|
||||
.. _class_Curve2D_remove_point:
|
||||
|
||||
- void **remove_point** **(** :ref:`int<class_int>` idx **)**
|
||||
- void **remove_point** **(** :ref:`int<class_int>` idx **)**
|
||||
|
||||
Deletes the point "idx" from the curve. Sends an error to the console if "idx" is out of bounds.
|
||||
|
||||
.. _class_Curve2D_set_bake_interval:
|
||||
|
||||
- void **set_bake_interval** **(** :ref:`float<class_float>` distance **)**
|
||||
- void **set_bake_interval** **(** :ref:`float<class_float>` distance **)**
|
||||
|
||||
Sets the distance in pixels between two adjacent cached points. Changing it forces the cache to be recomputed the next time a xxx_baked_xxx function is called. The less distance, the more points the cache will have, and the more memory it will consume, so use with care.
|
||||
|
||||
.. _class_Curve2D_set_point_in:
|
||||
|
||||
- void **set_point_in** **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` position **)**
|
||||
- void **set_point_in** **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` position **)**
|
||||
|
||||
Sets the position of the control point leading to the vertex "idx". If the index is out of bounds, the function sends an error to the console.
|
||||
|
||||
.. _class_Curve2D_set_point_out:
|
||||
|
||||
- void **set_point_out** **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` position **)**
|
||||
- void **set_point_out** **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` position **)**
|
||||
|
||||
Sets the position of the control point leading out of the vertex "idx". If the index is out of bounds, the function sends an error to the console.
|
||||
|
||||
.. _class_Curve2D_set_point_position:
|
||||
|
||||
- void **set_point_position** **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` position **)**
|
||||
- void **set_point_position** **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` position **)**
|
||||
|
||||
Sets the position for the vertex "idx". If the index is out of bounds, the function sends an error to the console.
|
||||
|
||||
.. _class_Curve2D_tessellate:
|
||||
|
||||
- :ref:`PoolVector2Array<class_poolvector2array>` **tessellate** **(** :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=5, :ref:`float<class_float>` tolerance_degrees=4 **)** 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.
|
||||
|
||||
|
||||
@@ -19,49 +19,49 @@ Describes a Bezier curve in 3D space.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_point<class_Curve3D_add_point>` **(** :ref:`Vector3<class_vector3>` position, :ref:`Vector3<class_vector3>` in=Vector3( 0, 0, 0 ), :ref:`Vector3<class_vector3>` out=Vector3( 0, 0, 0 ), :ref:`int<class_int>` at_position=-1 **)** |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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_baked_length<class_Curve3D_get_baked_length>` **(** **)** 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:`int<class_int>` | :ref:`get_point_count<class_Curve3D_get_point_count>` **(** **)** const |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_point_in<class_Curve3D_get_point_in>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_point_out<class_Curve3D_get_point_out>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_point_position<class_Curve3D_get_point_position>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_point_tilt<class_Curve3D_get_point_tilt>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`interpolate<class_Curve3D_interpolate>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` t **)** const |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`interpolate_baked<class_Curve3D_interpolate_baked>` **(** :ref:`float<class_float>` offset, :ref:`bool<class_bool>` cubic=false **)** const |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`interpolatef<class_Curve3D_interpolatef>` **(** :ref:`float<class_float>` fofs **)** const |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_point<class_Curve3D_remove_point>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bake_interval<class_Curve3D_set_bake_interval>` **(** :ref:`float<class_float>` distance **)** |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_in<class_Curve3D_set_point_in>` **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` position **)** |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_out<class_Curve3D_set_point_out>` **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` position **)** |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_position<class_Curve3D_set_point_position>` **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` position **)** |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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:`tessellate<class_Curve3D_tessellate>` **(** :ref:`int<class_int>` max_stages=5, :ref:`float<class_float>` tolerance_degrees=4 **)** const |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_point<class_Curve3D_add_point>` **(** :ref:`Vector3<class_vector3>` position, :ref:`Vector3<class_vector3>` in=Vector3( 0, 0, 0 ), :ref:`Vector3<class_vector3>` out=Vector3( 0, 0, 0 ), :ref:`int<class_int>` at_position=-1 **)** |
|
||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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_baked_length<class_Curve3D_get_baked_length>` **(** **)** 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:`int<class_int>` | :ref:`get_point_count<class_Curve3D_get_point_count>` **(** **)** const |
|
||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_point_in<class_Curve3D_get_point_in>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_point_out<class_Curve3D_get_point_out>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_point_position<class_Curve3D_get_point_position>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_point_tilt<class_Curve3D_get_point_tilt>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`interpolate<class_Curve3D_interpolate>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` t **)** const |
|
||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`interpolate_baked<class_Curve3D_interpolate_baked>` **(** :ref:`float<class_float>` offset, :ref:`bool<class_bool>` cubic=false **)** const |
|
||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`interpolatef<class_Curve3D_interpolatef>` **(** :ref:`float<class_float>` fofs **)** const |
|
||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_point<class_Curve3D_remove_point>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bake_interval<class_Curve3D_set_bake_interval>` **(** :ref:`float<class_float>` distance **)** |
|
||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_in<class_Curve3D_set_point_in>` **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` position **)** |
|
||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_out<class_Curve3D_set_point_out>` **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` position **)** |
|
||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_point_position<class_Curve3D_set_point_position>` **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` position **)** |
|
||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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:`tessellate<class_Curve3D_tessellate>` **(** :ref:`int<class_int>` max_stages=5, :ref:`float<class_float>` tolerance_degrees=4 **)** const |
|
||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -87,7 +87,7 @@ Member Function Description
|
||||
|
||||
.. _class_Curve3D_add_point:
|
||||
|
||||
- void **add_point** **(** :ref:`Vector3<class_vector3>` position, :ref:`Vector3<class_vector3>` in=Vector3( 0, 0, 0 ), :ref:`Vector3<class_vector3>` out=Vector3( 0, 0, 0 ), :ref:`int<class_int>` at_position=-1 **)**
|
||||
- void **add_point** **(** :ref:`Vector3<class_vector3>` position, :ref:`Vector3<class_vector3>` in=Vector3( 0, 0, 0 ), :ref:`Vector3<class_vector3>` out=Vector3( 0, 0, 0 ), :ref:`int<class_int>` at_position=-1 **)**
|
||||
|
||||
Adds a point to a curve, at "position", with control points "in" and "out".
|
||||
|
||||
@@ -95,65 +95,65 @@ If "at_position" is given, the point is inserted before the point number "at_pos
|
||||
|
||||
.. _class_Curve3D_clear_points:
|
||||
|
||||
- void **clear_points** **(** **)**
|
||||
- void **clear_points** **(** **)**
|
||||
|
||||
.. _class_Curve3D_get_bake_interval:
|
||||
|
||||
- :ref:`float<class_float>` **get_bake_interval** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_bake_interval** **(** **)** const
|
||||
|
||||
Returns the distance between two adjacent cached points.
|
||||
|
||||
.. _class_Curve3D_get_baked_length:
|
||||
|
||||
- :ref:`float<class_float>` **get_baked_length** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_baked_length** **(** **)** const
|
||||
|
||||
Returns the total length of the curve, based on the cached points. Given enough density (see :ref:`set_bake_interval<class_Curve3D_set_bake_interval>`), it should be approximate enough.
|
||||
|
||||
.. _class_Curve3D_get_baked_points:
|
||||
|
||||
- :ref:`PoolVector3Array<class_poolvector3array>` **get_baked_points** **(** **)** const
|
||||
- :ref:`PoolVector3Array<class_poolvector3array>` **get_baked_points** **(** **)** const
|
||||
|
||||
Returns the cache of points as a :ref:`PoolVector3Array<class_poolvector3array>`.
|
||||
|
||||
.. _class_Curve3D_get_baked_tilts:
|
||||
|
||||
- :ref:`PoolRealArray<class_poolrealarray>` **get_baked_tilts** **(** **)** const
|
||||
- :ref:`PoolRealArray<class_poolrealarray>` **get_baked_tilts** **(** **)** const
|
||||
|
||||
Returns the cache of tilts as a RealArray.
|
||||
|
||||
.. _class_Curve3D_get_point_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_point_count** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_point_count** **(** **)** const
|
||||
|
||||
Returns the number of points describing the curve.
|
||||
|
||||
.. _class_Curve3D_get_point_in:
|
||||
|
||||
- :ref:`Vector3<class_vector3>` **get_point_in** **(** :ref:`int<class_int>` idx **)** const
|
||||
- :ref:`Vector3<class_vector3>` **get_point_in** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Returns the position of the control point leading to the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0, 0).
|
||||
|
||||
.. _class_Curve3D_get_point_out:
|
||||
|
||||
- :ref:`Vector3<class_vector3>` **get_point_out** **(** :ref:`int<class_int>` idx **)** const
|
||||
- :ref:`Vector3<class_vector3>` **get_point_out** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Returns the position of the control point leading out of the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0, 0).
|
||||
|
||||
.. _class_Curve3D_get_point_position:
|
||||
|
||||
- :ref:`Vector3<class_vector3>` **get_point_position** **(** :ref:`int<class_int>` idx **)** const
|
||||
- :ref:`Vector3<class_vector3>` **get_point_position** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Returns the position of the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0, 0).
|
||||
|
||||
.. _class_Curve3D_get_point_tilt:
|
||||
|
||||
- :ref:`float<class_float>` **get_point_tilt** **(** :ref:`int<class_int>` idx **)** const
|
||||
- :ref:`float<class_float>` **get_point_tilt** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Returns the tilt angle in radians for the point "idx". If the index is out of bounds, the function sends an error to the console, and returns 0.
|
||||
|
||||
.. _class_Curve3D_interpolate:
|
||||
|
||||
- :ref:`Vector3<class_vector3>` **interpolate** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` t **)** const
|
||||
- :ref:`Vector3<class_vector3>` **interpolate** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` t **)** const
|
||||
|
||||
Returns the position between the vertex "idx" and the vertex "idx"+1, where "t" controls if the point is the first vertex (t = 0.0), the last vertex (t = 1.0), or in between. Values of "t" outside the range (0.0 >= t <=1) give strange, but predictable results.
|
||||
|
||||
@@ -161,7 +161,7 @@ If "idx" is out of bounds it is truncated to the first or last vertex, and "t" i
|
||||
|
||||
.. _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=false **)** const
|
||||
|
||||
Returns a point within the curve at position "offset", where "offset" is measured as a distance in 3D units along the curve.
|
||||
|
||||
@@ -171,43 +171,43 @@ Cubic interpolation tends to follow the curves better, but linear is faster (and
|
||||
|
||||
.. _class_Curve3D_interpolatef:
|
||||
|
||||
- :ref:`Vector3<class_vector3>` **interpolatef** **(** :ref:`float<class_float>` fofs **)** const
|
||||
- :ref:`Vector3<class_vector3>` **interpolatef** **(** :ref:`float<class_float>` fofs **)** const
|
||||
|
||||
Returns the position at the vertex "fofs". It calls :ref:`interpolate<class_Curve3D_interpolate>` using the integer part of fofs as "idx", and its fractional part as "t".
|
||||
|
||||
.. _class_Curve3D_remove_point:
|
||||
|
||||
- void **remove_point** **(** :ref:`int<class_int>` idx **)**
|
||||
- void **remove_point** **(** :ref:`int<class_int>` idx **)**
|
||||
|
||||
Deletes the point "idx" from the curve. Sends an error to the console if "idx" is out of bounds.
|
||||
|
||||
.. _class_Curve3D_set_bake_interval:
|
||||
|
||||
- void **set_bake_interval** **(** :ref:`float<class_float>` distance **)**
|
||||
- void **set_bake_interval** **(** :ref:`float<class_float>` distance **)**
|
||||
|
||||
Sets the distance in 3D units between two adjacent cached points. Changing it forces the cache to be recomputed the next time a xxx_baked_xxx function is called. The less distance, the more points the cache will have, and the more memory it will consume, so use with care.
|
||||
|
||||
.. _class_Curve3D_set_point_in:
|
||||
|
||||
- void **set_point_in** **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` position **)**
|
||||
- void **set_point_in** **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` position **)**
|
||||
|
||||
Sets the position of the control point leading to the vertex "idx". If the index is out of bounds, the function sends an error to the console.
|
||||
|
||||
.. _class_Curve3D_set_point_out:
|
||||
|
||||
- void **set_point_out** **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` position **)**
|
||||
- void **set_point_out** **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` position **)**
|
||||
|
||||
Sets the position of the control point leading out of the vertex "idx". If the index is out of bounds, the function sends an error to the console.
|
||||
|
||||
.. _class_Curve3D_set_point_position:
|
||||
|
||||
- void **set_point_position** **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` position **)**
|
||||
- void **set_point_position** **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` position **)**
|
||||
|
||||
Sets the position for the vertex "idx". If the index is out of bounds, the function sends an error to the console.
|
||||
|
||||
.. _class_Curve3D_set_point_tilt:
|
||||
|
||||
- void **set_point_tilt** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` tilt **)**
|
||||
- void **set_point_tilt** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` tilt **)**
|
||||
|
||||
Sets the tilt angle in radians for the point "idx". If the index is out of bounds, the function sends an error to the console.
|
||||
|
||||
@@ -215,7 +215,7 @@ The tilt controls the rotation along the look-at axis an object traveling the pa
|
||||
|
||||
.. _class_Curve3D_tessellate:
|
||||
|
||||
- :ref:`PoolVector3Array<class_poolvector3array>` **tessellate** **(** :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=5, :ref:`float<class_float>` tolerance_degrees=4 **)** 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.
|
||||
|
||||
|
||||
@@ -19,13 +19,13 @@ Brief Description
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------+----------------------------------------------------------------------------------------------+
|
||||
| :ref:`Curve<class_curve>` | :ref:`get_curve<class_CurveTexture_get_curve>` **(** **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_curve<class_CurveTexture_set_curve>` **(** :ref:`Curve<class_curve>` curve **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_width<class_CurveTexture_set_width>` **(** :ref:`int<class_int>` width **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------+
|
||||
+----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| :ref:`Curve<class_curve>` | :ref:`get_curve<class_CurveTexture_get_curve>` **(** **)** const |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_curve<class_CurveTexture_set_curve>` **(** :ref:`Curve<class_curve>` curve **)** |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_width<class_CurveTexture_set_width>` **(** :ref:`int<class_int>` width **)** |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -44,14 +44,14 @@ Member Function Description
|
||||
|
||||
.. _class_CurveTexture_get_curve:
|
||||
|
||||
- :ref:`Curve<class_curve>` **get_curve** **(** **)** const
|
||||
- :ref:`Curve<class_curve>` **get_curve** **(** **)** const
|
||||
|
||||
.. _class_CurveTexture_set_curve:
|
||||
|
||||
- void **set_curve** **(** :ref:`Curve<class_curve>` curve **)**
|
||||
- void **set_curve** **(** :ref:`Curve<class_curve>` curve **)**
|
||||
|
||||
.. _class_CurveTexture_set_width:
|
||||
|
||||
- void **set_width** **(** :ref:`int<class_int>` width **)**
|
||||
- void **set_width** **(** :ref:`int<class_int>` width **)**
|
||||
|
||||
|
||||
|
||||
@@ -19,27 +19,27 @@ Class representing a cylindrical :ref:`PrimitiveMesh<class_primitivemesh>`.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_bottom_radius<class_CylinderMesh_get_bottom_radius>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_height<class_CylinderMesh_get_height>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_radial_segments<class_CylinderMesh_get_radial_segments>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_rings<class_CylinderMesh_get_rings>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_top_radius<class_CylinderMesh_get_top_radius>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bottom_radius<class_CylinderMesh_set_bottom_radius>` **(** :ref:`float<class_float>` radius **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_height<class_CylinderMesh_set_height>` **(** :ref:`float<class_float>` height **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_radial_segments<class_CylinderMesh_set_radial_segments>` **(** :ref:`int<class_int>` segments **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_rings<class_CylinderMesh_set_rings>` **(** :ref:`int<class_int>` rings **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_top_radius<class_CylinderMesh_set_top_radius>` **(** :ref:`float<class_float>` radius **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_bottom_radius<class_CylinderMesh_get_bottom_radius>` **(** **)** const |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_height<class_CylinderMesh_get_height>` **(** **)** const |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_radial_segments<class_CylinderMesh_get_radial_segments>` **(** **)** const |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_rings<class_CylinderMesh_get_rings>` **(** **)** const |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_top_radius<class_CylinderMesh_get_top_radius>` **(** **)** const |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bottom_radius<class_CylinderMesh_set_bottom_radius>` **(** :ref:`float<class_float>` radius **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_height<class_CylinderMesh_set_height>` **(** :ref:`float<class_float>` height **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_radial_segments<class_CylinderMesh_set_radial_segments>` **(** :ref:`int<class_int>` segments **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_rings<class_CylinderMesh_set_rings>` **(** :ref:`int<class_int>` rings **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_top_radius<class_CylinderMesh_set_top_radius>` **(** :ref:`float<class_float>` radius **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -75,42 +75,42 @@ Member Function Description
|
||||
|
||||
.. _class_CylinderMesh_get_bottom_radius:
|
||||
|
||||
- :ref:`float<class_float>` **get_bottom_radius** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_bottom_radius** **(** **)** const
|
||||
|
||||
.. _class_CylinderMesh_get_height:
|
||||
|
||||
- :ref:`float<class_float>` **get_height** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_height** **(** **)** const
|
||||
|
||||
.. _class_CylinderMesh_get_radial_segments:
|
||||
|
||||
- :ref:`int<class_int>` **get_radial_segments** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_radial_segments** **(** **)** const
|
||||
|
||||
.. _class_CylinderMesh_get_rings:
|
||||
|
||||
- :ref:`int<class_int>` **get_rings** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_rings** **(** **)** const
|
||||
|
||||
.. _class_CylinderMesh_get_top_radius:
|
||||
|
||||
- :ref:`float<class_float>` **get_top_radius** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_top_radius** **(** **)** const
|
||||
|
||||
.. _class_CylinderMesh_set_bottom_radius:
|
||||
|
||||
- void **set_bottom_radius** **(** :ref:`float<class_float>` radius **)**
|
||||
- void **set_bottom_radius** **(** :ref:`float<class_float>` radius **)**
|
||||
|
||||
.. _class_CylinderMesh_set_height:
|
||||
|
||||
- void **set_height** **(** :ref:`float<class_float>` height **)**
|
||||
- void **set_height** **(** :ref:`float<class_float>` height **)**
|
||||
|
||||
.. _class_CylinderMesh_set_radial_segments:
|
||||
|
||||
- void **set_radial_segments** **(** :ref:`int<class_int>` segments **)**
|
||||
- void **set_radial_segments** **(** :ref:`int<class_int>` segments **)**
|
||||
|
||||
.. _class_CylinderMesh_set_rings:
|
||||
|
||||
- void **set_rings** **(** :ref:`int<class_int>` rings **)**
|
||||
- void **set_rings** **(** :ref:`int<class_int>` rings **)**
|
||||
|
||||
.. _class_CylinderMesh_set_top_radius:
|
||||
|
||||
- void **set_top_radius** **(** :ref:`float<class_float>` radius **)**
|
||||
- void **set_top_radius** **(** :ref:`float<class_float>` radius **)**
|
||||
|
||||
|
||||
|
||||
@@ -19,23 +19,23 @@ Damped spring constraint for 2D physics.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_damping<class_DampedSpringJoint2D_get_damping>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_length<class_DampedSpringJoint2D_get_length>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_rest_length<class_DampedSpringJoint2D_get_rest_length>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_stiffness<class_DampedSpringJoint2D_get_stiffness>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_damping<class_DampedSpringJoint2D_set_damping>` **(** :ref:`float<class_float>` damping **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_length<class_DampedSpringJoint2D_set_length>` **(** :ref:`float<class_float>` length **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_rest_length<class_DampedSpringJoint2D_set_rest_length>` **(** :ref:`float<class_float>` rest_length **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_stiffness<class_DampedSpringJoint2D_set_stiffness>` **(** :ref:`float<class_float>` stiffness **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_damping<class_DampedSpringJoint2D_get_damping>` **(** **)** const |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_length<class_DampedSpringJoint2D_get_length>` **(** **)** const |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_rest_length<class_DampedSpringJoint2D_get_rest_length>` **(** **)** const |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_stiffness<class_DampedSpringJoint2D_get_stiffness>` **(** **)** const |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_damping<class_DampedSpringJoint2D_set_damping>` **(** :ref:`float<class_float>` damping **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_length<class_DampedSpringJoint2D_set_length>` **(** :ref:`float<class_float>` length **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_rest_length<class_DampedSpringJoint2D_set_rest_length>` **(** :ref:`float<class_float>` rest_length **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_stiffness<class_DampedSpringJoint2D_set_stiffness>` **(** :ref:`float<class_float>` stiffness **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -67,49 +67,49 @@ Member Function Description
|
||||
|
||||
.. _class_DampedSpringJoint2D_get_damping:
|
||||
|
||||
- :ref:`float<class_float>` **get_damping** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_damping** **(** **)** const
|
||||
|
||||
Return the damping ratio of the spring joint. A value of 0 indicates an undamped spring, while 1 causes the system to reach equilibrium as fast as possible (critical damping).
|
||||
|
||||
.. _class_DampedSpringJoint2D_get_length:
|
||||
|
||||
- :ref:`float<class_float>` **get_length** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_length** **(** **)** const
|
||||
|
||||
Return the maximum length of the spring joint.
|
||||
|
||||
.. _class_DampedSpringJoint2D_get_rest_length:
|
||||
|
||||
- :ref:`float<class_float>` **get_rest_length** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_rest_length** **(** **)** const
|
||||
|
||||
Return the resting length of the spring joint. The joint will always try to go to back this length when pulled apart.
|
||||
|
||||
.. _class_DampedSpringJoint2D_get_stiffness:
|
||||
|
||||
- :ref:`float<class_float>` **get_stiffness** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_stiffness** **(** **)** const
|
||||
|
||||
Return the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length.
|
||||
|
||||
.. _class_DampedSpringJoint2D_set_damping:
|
||||
|
||||
- void **set_damping** **(** :ref:`float<class_float>` damping **)**
|
||||
- void **set_damping** **(** :ref:`float<class_float>` damping **)**
|
||||
|
||||
Set the damping ratio of the spring joint. A value of 0 indicates an undamped spring, while 1 causes the system to reach equilibrium as fast as possible (critical damping).
|
||||
|
||||
.. _class_DampedSpringJoint2D_set_length:
|
||||
|
||||
- void **set_length** **(** :ref:`float<class_float>` length **)**
|
||||
- void **set_length** **(** :ref:`float<class_float>` length **)**
|
||||
|
||||
Set the maximum length of the spring joint.
|
||||
|
||||
.. _class_DampedSpringJoint2D_set_rest_length:
|
||||
|
||||
- void **set_rest_length** **(** :ref:`float<class_float>` rest_length **)**
|
||||
- void **set_rest_length** **(** :ref:`float<class_float>` rest_length **)**
|
||||
|
||||
Set the resting length of the spring joint. The joint will always try to go to back this length when pulled apart.
|
||||
|
||||
.. _class_DampedSpringJoint2D_set_stiffness:
|
||||
|
||||
- void **set_stiffness** **(** :ref:`float<class_float>` stiffness **)**
|
||||
- void **set_stiffness** **(** :ref:`float<class_float>` stiffness **)**
|
||||
|
||||
Set the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length.
|
||||
|
||||
|
||||
@@ -17,25 +17,25 @@ Dictionary type.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------+---------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear<class_Dictionary_clear>` **(** **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`empty<class_Dictionary_empty>` **(** **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------+
|
||||
| void | :ref:`erase<class_Dictionary_erase>` **(** var key **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has<class_Dictionary_has>` **(** var key **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_all<class_Dictionary_has_all>` **(** :ref:`Array<class_array>` keys **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`hash<class_Dictionary_hash>` **(** **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`keys<class_Dictionary_keys>` **(** **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`size<class_Dictionary_size>` **(** **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`values<class_Dictionary_values>` **(** **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------+
|
||||
+----------------------------+-------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear<class_Dictionary_clear>` **(** **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`empty<class_Dictionary_empty>` **(** **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------+
|
||||
| void | :ref:`erase<class_Dictionary_erase>` **(** var key **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has<class_Dictionary_has>` **(** var key **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_all<class_Dictionary_has_all>` **(** :ref:`Array<class_array>` keys **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`hash<class_Dictionary_hash>` **(** **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`keys<class_Dictionary_keys>` **(** **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`size<class_Dictionary_size>` **(** **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`values<class_Dictionary_values>` **(** **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -47,55 +47,55 @@ Member Function Description
|
||||
|
||||
.. _class_Dictionary_clear:
|
||||
|
||||
- void **clear** **(** **)**
|
||||
- void **clear** **(** **)**
|
||||
|
||||
Clear the dictionary, removing all key/value pairs.
|
||||
|
||||
.. _class_Dictionary_empty:
|
||||
|
||||
- :ref:`bool<class_bool>` **empty** **(** **)**
|
||||
- :ref:`bool<class_bool>` **empty** **(** **)**
|
||||
|
||||
Return true if the dictionary is empty.
|
||||
|
||||
.. _class_Dictionary_erase:
|
||||
|
||||
- void **erase** **(** var key **)**
|
||||
- void **erase** **(** var key **)**
|
||||
|
||||
Erase a dictionary key/value pair by key.
|
||||
|
||||
.. _class_Dictionary_has:
|
||||
|
||||
- :ref:`bool<class_bool>` **has** **(** var key **)**
|
||||
- :ref:`bool<class_bool>` **has** **(** var key **)**
|
||||
|
||||
Return true if the dictionary has a given key.
|
||||
|
||||
.. _class_Dictionary_has_all:
|
||||
|
||||
- :ref:`bool<class_bool>` **has_all** **(** :ref:`Array<class_array>` keys **)**
|
||||
- :ref:`bool<class_bool>` **has_all** **(** :ref:`Array<class_array>` keys **)**
|
||||
|
||||
Return true if the dictionary has all of the keys in the given array.
|
||||
|
||||
.. _class_Dictionary_hash:
|
||||
|
||||
- :ref:`int<class_int>` **hash** **(** **)**
|
||||
- :ref:`int<class_int>` **hash** **(** **)**
|
||||
|
||||
Return a hashed integer value representing the dictionary contents.
|
||||
|
||||
.. _class_Dictionary_keys:
|
||||
|
||||
- :ref:`Array<class_array>` **keys** **(** **)**
|
||||
- :ref:`Array<class_array>` **keys** **(** **)**
|
||||
|
||||
Return the list of keys in the :ref:`Dictionary<class_dictionary>`.
|
||||
|
||||
.. _class_Dictionary_size:
|
||||
|
||||
- :ref:`int<class_int>` **size** **(** **)**
|
||||
- :ref:`int<class_int>` **size** **(** **)**
|
||||
|
||||
Return the size of the dictionary (in pairs).
|
||||
|
||||
.. _class_Dictionary_values:
|
||||
|
||||
- :ref:`Array<class_array>` **values** **(** **)**
|
||||
- :ref:`Array<class_array>` **values** **(** **)**
|
||||
|
||||
Return the list of values in the :ref:`Dictionary<class_dictionary>`.
|
||||
|
||||
|
||||
@@ -19,19 +19,19 @@ Directional Light, such as the Sun or the Moon.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_shadow_depth_range<class_DirectionalLight_get_shadow_depth_range>` **(** **)** const |
|
||||
+--------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_shadow_mode<class_DirectionalLight_get_shadow_mode>` **(** **)** const |
|
||||
+--------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_blend_splits_enabled<class_DirectionalLight_is_blend_splits_enabled>` **(** **)** const |
|
||||
+--------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_blend_splits<class_DirectionalLight_set_blend_splits>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||
+--------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_shadow_depth_range<class_DirectionalLight_set_shadow_depth_range>` **(** :ref:`int<class_int>` mode **)** |
|
||||
+--------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_shadow_mode<class_DirectionalLight_set_shadow_mode>` **(** :ref:`int<class_int>` mode **)** |
|
||||
+--------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_shadow_depth_range<class_DirectionalLight_get_shadow_depth_range>` **(** **)** const |
|
||||
+--------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_shadow_mode<class_DirectionalLight_get_shadow_mode>` **(** **)** const |
|
||||
+--------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_blend_splits_enabled<class_DirectionalLight_is_blend_splits_enabled>` **(** **)** const |
|
||||
+--------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_blend_splits<class_DirectionalLight_set_blend_splits>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||
+--------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_shadow_depth_range<class_DirectionalLight_set_shadow_depth_range>` **(** :ref:`int<class_int>` mode **)** |
|
||||
+--------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_shadow_mode<class_DirectionalLight_set_shadow_mode>` **(** :ref:`int<class_int>` mode **)** |
|
||||
+--------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -92,26 +92,26 @@ Member Function Description
|
||||
|
||||
.. _class_DirectionalLight_get_shadow_depth_range:
|
||||
|
||||
- :ref:`int<class_int>` **get_shadow_depth_range** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_shadow_depth_range** **(** **)** const
|
||||
|
||||
.. _class_DirectionalLight_get_shadow_mode:
|
||||
|
||||
- :ref:`int<class_int>` **get_shadow_mode** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_shadow_mode** **(** **)** const
|
||||
|
||||
.. _class_DirectionalLight_is_blend_splits_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_blend_splits_enabled** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_blend_splits_enabled** **(** **)** const
|
||||
|
||||
.. _class_DirectionalLight_set_blend_splits:
|
||||
|
||||
- void **set_blend_splits** **(** :ref:`bool<class_bool>` enabled **)**
|
||||
- void **set_blend_splits** **(** :ref:`bool<class_bool>` enabled **)**
|
||||
|
||||
.. _class_DirectionalLight_set_shadow_depth_range:
|
||||
|
||||
- void **set_shadow_depth_range** **(** :ref:`int<class_int>` mode **)**
|
||||
- void **set_shadow_depth_range** **(** :ref:`int<class_int>` mode **)**
|
||||
|
||||
.. _class_DirectionalLight_set_shadow_mode:
|
||||
|
||||
- void **set_shadow_mode** **(** :ref:`int<class_int>` mode **)**
|
||||
- void **set_shadow_mode** **(** :ref:`int<class_int>` mode **)**
|
||||
|
||||
|
||||
|
||||
@@ -19,43 +19,43 @@ Type used to handle the filesystem.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`change_dir<class_Directory_change_dir>` **(** :ref:`String<class_string>` todir **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`dir_exists<class_Directory_dir_exists>` **(** :ref:`String<class_string>` path **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`file_exists<class_Directory_file_exists>` **(** :ref:`String<class_string>` path **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_current_dir<class_Directory_get_current_dir>` **(** **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_current_drive<class_Directory_get_current_drive>` **(** **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_drive<class_Directory_get_drive>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_drive_count<class_Directory_get_drive_count>` **(** **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_next<class_Directory_get_next>` **(** **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_space_left<class_Directory_get_space_left>` **(** **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`list_dir_begin<class_Directory_list_dir_begin>` **(** :ref:`bool<class_bool>` skip_navigational=false, :ref:`bool<class_bool>` skip_hidden=false **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`list_dir_end<class_Directory_list_dir_end>` **(** **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`make_dir<class_Directory_make_dir>` **(** :ref:`String<class_string>` path **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`make_dir_recursive<class_Directory_make_dir_recursive>` **(** :ref:`String<class_string>` path **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`open<class_Directory_open>` **(** :ref:`String<class_string>` path **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`remove<class_Directory_remove>` **(** :ref:`String<class_string>` path **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`rename<class_Directory_rename>` **(** :ref:`String<class_string>` from, :ref:`String<class_string>` to **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`change_dir<class_Directory_change_dir>` **(** :ref:`String<class_string>` todir **)** |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`dir_exists<class_Directory_dir_exists>` **(** :ref:`String<class_string>` path **)** |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`file_exists<class_Directory_file_exists>` **(** :ref:`String<class_string>` path **)** |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_current_dir<class_Directory_get_current_dir>` **(** **)** |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_current_drive<class_Directory_get_current_drive>` **(** **)** |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_drive<class_Directory_get_drive>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_drive_count<class_Directory_get_drive_count>` **(** **)** |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_next<class_Directory_get_next>` **(** **)** |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_space_left<class_Directory_get_space_left>` **(** **)** |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`list_dir_begin<class_Directory_list_dir_begin>` **(** :ref:`bool<class_bool>` skip_navigational=false, :ref:`bool<class_bool>` skip_hidden=false **)** |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`list_dir_end<class_Directory_list_dir_end>` **(** **)** |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`make_dir<class_Directory_make_dir>` **(** :ref:`String<class_string>` path **)** |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`make_dir_recursive<class_Directory_make_dir_recursive>` **(** :ref:`String<class_string>` path **)** |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`open<class_Directory_open>` **(** :ref:`String<class_string>` path **)** |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`remove<class_Directory_remove>` **(** :ref:`String<class_string>` path **)** |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`rename<class_Directory_rename>` **(** :ref:`String<class_string>` from, :ref:`String<class_string>` to **)** |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -85,7 +85,7 @@ Member Function Description
|
||||
|
||||
.. _class_Directory_change_dir:
|
||||
|
||||
- :ref:`int<class_int>` **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``).
|
||||
|
||||
@@ -93,7 +93,7 @@ The method returns one of the error code constants defined in :ref:`@Global Scop
|
||||
|
||||
.. _class_Directory_copy:
|
||||
|
||||
- :ref:`int<class_int>` **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.
|
||||
|
||||
@@ -101,49 +101,49 @@ Returns one of the error code constants defined in :ref:`@Global Scope<class_@gl
|
||||
|
||||
.. _class_Directory_current_is_dir:
|
||||
|
||||
- :ref:`bool<class_bool>` **current_is_dir** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **current_is_dir** **(** **)** const
|
||||
|
||||
Return whether the current item processed with the last :ref:`get_next<class_Directory_get_next>` call is a directory (``.`` and ``..`` are considered directories).
|
||||
|
||||
.. _class_Directory_dir_exists:
|
||||
|
||||
- :ref:`bool<class_bool>` **dir_exists** **(** :ref:`String<class_string>` path **)**
|
||||
- :ref:`bool<class_bool>` **dir_exists** **(** :ref:`String<class_string>` path **)**
|
||||
|
||||
Return whether the target directory exists. The argument can be relative to the current directory, or an absolute path.
|
||||
|
||||
.. _class_Directory_file_exists:
|
||||
|
||||
- :ref:`bool<class_bool>` **file_exists** **(** :ref:`String<class_string>` path **)**
|
||||
- :ref:`bool<class_bool>` **file_exists** **(** :ref:`String<class_string>` path **)**
|
||||
|
||||
Return whether the target file exists. The argument can be relative to the current directory, or an absolute path.
|
||||
|
||||
.. _class_Directory_get_current_dir:
|
||||
|
||||
- :ref:`String<class_string>` **get_current_dir** **(** **)**
|
||||
- :ref:`String<class_string>` **get_current_dir** **(** **)**
|
||||
|
||||
Return the absolute path to the currently opened directory (e.g. ``res://folder`` or ``C:\tmp\folder``).
|
||||
|
||||
.. _class_Directory_get_current_drive:
|
||||
|
||||
- :ref:`int<class_int>` **get_current_drive** **(** **)**
|
||||
- :ref:`int<class_int>` **get_current_drive** **(** **)**
|
||||
|
||||
Returns the currently opened directory's drive index. See :ref:`get_drive<class_Directory_get_drive>` to convert returned index to the name of the drive.
|
||||
|
||||
.. _class_Directory_get_drive:
|
||||
|
||||
- :ref:`String<class_string>` **get_drive** **(** :ref:`int<class_int>` idx **)**
|
||||
- :ref:`String<class_string>` **get_drive** **(** :ref:`int<class_int>` idx **)**
|
||||
|
||||
On Windows, return the name of the drive (partition) passed as an argument (e.g. ``C:``). On other platforms, or if the requested drive does not existed, the method returns an empty String.
|
||||
|
||||
.. _class_Directory_get_drive_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_drive_count** **(** **)**
|
||||
- :ref:`int<class_int>` **get_drive_count** **(** **)**
|
||||
|
||||
On Windows, return the number of drives (partitions) mounted on the current filesystem. On other platforms, the method returns 0.
|
||||
|
||||
.. _class_Directory_get_next:
|
||||
|
||||
- :ref:`String<class_string>` **get_next** **(** **)**
|
||||
- :ref:`String<class_string>` **get_next** **(** **)**
|
||||
|
||||
Return the next element (file or directory) in the current directory (including ``.`` and ``..``, unless ``skip_navigational`` was given to :ref:`list_dir_begin<class_Directory_list_dir_begin>`).
|
||||
|
||||
@@ -151,13 +151,13 @@ The name of the file or directory is returned (and not its full path). Once the
|
||||
|
||||
.. _class_Directory_get_space_left:
|
||||
|
||||
- :ref:`int<class_int>` **get_space_left** **(** **)**
|
||||
- :ref:`int<class_int>` **get_space_left** **(** **)**
|
||||
|
||||
On Unix desktop systems, return the available space on the current directory's disk. On other platforms, this information is not available and the method returns 0 or -1.
|
||||
|
||||
.. _class_Directory_list_dir_begin:
|
||||
|
||||
- :ref:`int<class_int>` **list_dir_begin** **(** :ref:`bool<class_bool>` skip_navigational=false, :ref:`bool<class_bool>` skip_hidden=false **)**
|
||||
- :ref:`int<class_int>` **list_dir_begin** **(** :ref:`bool<class_bool>` skip_navigational=false, :ref:`bool<class_bool>` skip_hidden=false **)**
|
||||
|
||||
Initialise the stream used to list all files and directories using the :ref:`get_next<class_Directory_get_next>` function, closing the current opened stream if needed. Once the stream has been processed, it should typically be closed with :ref:`list_dir_end<class_Directory_list_dir_end>`.
|
||||
|
||||
@@ -167,13 +167,13 @@ If you pass ``skip_hidden``, then hidden files would be filtered out.
|
||||
|
||||
.. _class_Directory_list_dir_end:
|
||||
|
||||
- void **list_dir_end** **(** **)**
|
||||
- void **list_dir_end** **(** **)**
|
||||
|
||||
Close the current stream opened with :ref:`list_dir_begin<class_Directory_list_dir_begin>` (whether it has been fully processed with :ref:`get_next<class_Directory_get_next>` or not does not matter).
|
||||
|
||||
.. _class_Directory_make_dir:
|
||||
|
||||
- :ref:`int<class_int>` **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>`).
|
||||
|
||||
@@ -181,7 +181,7 @@ The method returns one of the error code constants defined in :ref:`@Global Scop
|
||||
|
||||
.. _class_Directory_make_dir_recursive:
|
||||
|
||||
- :ref:`int<class_int>` **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.
|
||||
|
||||
@@ -189,7 +189,7 @@ Return one of the error code constants defined in :ref:`@Global Scope<class_@glo
|
||||
|
||||
.. _class_Directory_open:
|
||||
|
||||
- :ref:`int<class_int>` **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``).
|
||||
|
||||
@@ -197,7 +197,7 @@ The method returns one of the error code constants defined in :ref:`@Global Scop
|
||||
|
||||
.. _class_Directory_remove:
|
||||
|
||||
- :ref:`int<class_int>` **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.
|
||||
|
||||
@@ -205,7 +205,7 @@ Return one of the error code constants defined in :ref:`@Global Scope<class_@glo
|
||||
|
||||
.. _class_Directory_rename:
|
||||
|
||||
- :ref:`int<class_int>` **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.
|
||||
|
||||
|
||||
@@ -19,37 +19,37 @@ DynamicFont renders vector font files at runtime.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_fallback<class_DynamicFont_add_fallback>` **(** :ref:`DynamicFontData<class_dynamicfontdata>` data **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`DynamicFontData<class_dynamicfontdata>` | :ref:`get_fallback<class_DynamicFont_get_fallback>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_fallback_count<class_DynamicFont_get_fallback_count>` **(** **)** const |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`DynamicFontData<class_dynamicfontdata>` | :ref:`get_font_data<class_DynamicFont_get_font_data>` **(** **)** const |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_size<class_DynamicFont_get_size>` **(** **)** const |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_spacing<class_DynamicFont_get_spacing>` **(** :ref:`int<class_int>` type **)** const |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_use_filter<class_DynamicFont_get_use_filter>` **(** **)** const |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_use_mipmaps<class_DynamicFont_get_use_mipmaps>` **(** **)** const |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_fallback<class_DynamicFont_remove_fallback>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_fallback<class_DynamicFont_set_fallback>` **(** :ref:`int<class_int>` idx, :ref:`DynamicFontData<class_dynamicfontdata>` data **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_font_data<class_DynamicFont_set_font_data>` **(** :ref:`DynamicFontData<class_dynamicfontdata>` data **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_size<class_DynamicFont_set_size>` **(** :ref:`int<class_int>` data **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_spacing<class_DynamicFont_set_spacing>` **(** :ref:`int<class_int>` type, :ref:`int<class_int>` value **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_use_filter<class_DynamicFont_set_use_filter>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_use_mipmaps<class_DynamicFont_set_use_mipmaps>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_fallback<class_DynamicFont_add_fallback>` **(** :ref:`DynamicFontData<class_dynamicfontdata>` data **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`DynamicFontData<class_dynamicfontdata>` | :ref:`get_fallback<class_DynamicFont_get_fallback>` **(** :ref:`int<class_int>` idx **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_fallback_count<class_DynamicFont_get_fallback_count>` **(** **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`DynamicFontData<class_dynamicfontdata>` | :ref:`get_font_data<class_DynamicFont_get_font_data>` **(** **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_size<class_DynamicFont_get_size>` **(** **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_spacing<class_DynamicFont_get_spacing>` **(** :ref:`int<class_int>` type **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_use_filter<class_DynamicFont_get_use_filter>` **(** **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_use_mipmaps<class_DynamicFont_get_use_mipmaps>` **(** **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_fallback<class_DynamicFont_remove_fallback>` **(** :ref:`int<class_int>` idx **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_fallback<class_DynamicFont_set_fallback>` **(** :ref:`int<class_int>` idx, :ref:`DynamicFontData<class_dynamicfontdata>` data **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_font_data<class_DynamicFont_set_font_data>` **(** :ref:`DynamicFontData<class_dynamicfontdata>` data **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_size<class_DynamicFont_set_size>` **(** :ref:`int<class_int>` data **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_spacing<class_DynamicFont_set_spacing>` **(** :ref:`int<class_int>` type, :ref:`int<class_int>` value **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_use_filter<class_DynamicFont_set_use_filter>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_use_mipmaps<class_DynamicFont_set_use_mipmaps>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -105,89 +105,89 @@ Member Function Description
|
||||
|
||||
.. _class_DynamicFont_add_fallback:
|
||||
|
||||
- void **add_fallback** **(** :ref:`DynamicFontData<class_dynamicfontdata>` data **)**
|
||||
- void **add_fallback** **(** :ref:`DynamicFontData<class_dynamicfontdata>` data **)**
|
||||
|
||||
Adds a fallback font.
|
||||
|
||||
.. _class_DynamicFont_get_fallback:
|
||||
|
||||
- :ref:`DynamicFontData<class_dynamicfontdata>` **get_fallback** **(** :ref:`int<class_int>` idx **)** const
|
||||
- :ref:`DynamicFontData<class_dynamicfontdata>` **get_fallback** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Returns the fallback font at index ``idx``.
|
||||
|
||||
.. _class_DynamicFont_get_fallback_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_fallback_count** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_fallback_count** **(** **)** const
|
||||
|
||||
Returns the number of fallback fonts.
|
||||
|
||||
.. _class_DynamicFont_get_font_data:
|
||||
|
||||
- :ref:`DynamicFontData<class_dynamicfontdata>` **get_font_data** **(** **)** const
|
||||
- :ref:`DynamicFontData<class_dynamicfontdata>` **get_font_data** **(** **)** const
|
||||
|
||||
.. _class_DynamicFont_get_size:
|
||||
|
||||
- :ref:`int<class_int>` **get_size** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_size** **(** **)** const
|
||||
|
||||
Returns the font size in pixels.
|
||||
|
||||
.. _class_DynamicFont_get_spacing:
|
||||
|
||||
- :ref:`int<class_int>` **get_spacing** **(** :ref:`int<class_int>` type **)** const
|
||||
- :ref:`int<class_int>` **get_spacing** **(** :ref:`int<class_int>` type **)** const
|
||||
|
||||
Returns the given type of spacing in pixels. See ``SPACING\_\*`` constants.
|
||||
|
||||
.. _class_DynamicFont_get_use_filter:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_use_filter** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **get_use_filter** **(** **)** const
|
||||
|
||||
Returns ``true`` if filtering is used.
|
||||
|
||||
.. _class_DynamicFont_get_use_mipmaps:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_use_mipmaps** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **get_use_mipmaps** **(** **)** const
|
||||
|
||||
Returns ``true`` if mipmapping is used.
|
||||
|
||||
.. _class_DynamicFont_remove_fallback:
|
||||
|
||||
- void **remove_fallback** **(** :ref:`int<class_int>` idx **)**
|
||||
- void **remove_fallback** **(** :ref:`int<class_int>` idx **)**
|
||||
|
||||
Removes the fallback font at index ``idx``.
|
||||
|
||||
.. _class_DynamicFont_set_fallback:
|
||||
|
||||
- void **set_fallback** **(** :ref:`int<class_int>` idx, :ref:`DynamicFontData<class_dynamicfontdata>` data **)**
|
||||
- void **set_fallback** **(** :ref:`int<class_int>` idx, :ref:`DynamicFontData<class_dynamicfontdata>` data **)**
|
||||
|
||||
Sets the fallback font at index ``idx``.
|
||||
|
||||
.. _class_DynamicFont_set_font_data:
|
||||
|
||||
- void **set_font_data** **(** :ref:`DynamicFontData<class_dynamicfontdata>` data **)**
|
||||
- void **set_font_data** **(** :ref:`DynamicFontData<class_dynamicfontdata>` data **)**
|
||||
|
||||
Sets the :ref:`DynamicFontData<class_dynamicfontdata>`.
|
||||
|
||||
.. _class_DynamicFont_set_size:
|
||||
|
||||
- void **set_size** **(** :ref:`int<class_int>` data **)**
|
||||
- void **set_size** **(** :ref:`int<class_int>` data **)**
|
||||
|
||||
Sets the font size.
|
||||
|
||||
.. _class_DynamicFont_set_spacing:
|
||||
|
||||
- void **set_spacing** **(** :ref:`int<class_int>` type, :ref:`int<class_int>` value **)**
|
||||
- void **set_spacing** **(** :ref:`int<class_int>` type, :ref:`int<class_int>` value **)**
|
||||
|
||||
Sets the spacing of the given type. See ``SPACING\_\*`` constants.
|
||||
|
||||
.. _class_DynamicFont_set_use_filter:
|
||||
|
||||
- void **set_use_filter** **(** :ref:`bool<class_bool>` enable **)**
|
||||
- void **set_use_filter** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
Set to ``true`` to use filtering.
|
||||
|
||||
.. _class_DynamicFont_set_use_mipmaps:
|
||||
|
||||
- void **set_use_mipmaps** **(** :ref:`bool<class_bool>` enable **)**
|
||||
- void **set_use_mipmaps** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
Set to ``true`` to use mipmapping.
|
||||
|
||||
|
||||
@@ -19,11 +19,11 @@ Used with :ref:`DynamicFont<class_dynamicfont>` to describe the location of a fo
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_font_path<class_DynamicFontData_get_font_path>` **(** **)** const |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_font_path<class_DynamicFontData_set_font_path>` **(** :ref:`String<class_string>` path **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_font_path<class_DynamicFontData_get_font_path>` **(** **)** const |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_font_path<class_DynamicFontData_set_font_path>` **(** :ref:`String<class_string>` path **)** |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -43,13 +43,13 @@ Member Function Description
|
||||
|
||||
.. _class_DynamicFontData_get_font_path:
|
||||
|
||||
- :ref:`String<class_string>` **get_font_path** **(** **)** const
|
||||
- :ref:`String<class_string>` **get_font_path** **(** **)** const
|
||||
|
||||
Returns the font path.
|
||||
|
||||
.. _class_DynamicFontData_set_font_path:
|
||||
|
||||
- void **set_font_path** **(** :ref:`String<class_string>` path **)**
|
||||
- void **set_font_path** **(** :ref:`String<class_string>` path **)**
|
||||
|
||||
Sets the font path.
|
||||
|
||||
|
||||
@@ -19,39 +19,39 @@ Brief Description
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_export_begin<class_EditorExportPlugin__export_begin>` **(** :ref:`PoolStringArray<class_poolstringarray>` features **)** virtual |
|
||||
+-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_export_file<class_EditorExportPlugin__export_file>` **(** :ref:`String<class_string>` path, :ref:`String<class_string>` type, :ref:`PoolStringArray<class_poolstringarray>` features **)** virtual |
|
||||
+-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_file<class_EditorExportPlugin_add_file>` **(** :ref:`String<class_string>` path, :ref:`PoolByteArray<class_poolbytearray>` file, :ref:`bool<class_bool>` remap **)** |
|
||||
+-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_shared_object<class_EditorExportPlugin_add_shared_object>` **(** :ref:`String<class_string>` path **)** |
|
||||
+-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`skip<class_EditorExportPlugin_skip>` **(** **)** |
|
||||
+-------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_export_begin<class_EditorExportPlugin__export_begin>` **(** :ref:`PoolStringArray<class_poolstringarray>` features **)** virtual |
|
||||
+-------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_export_file<class_EditorExportPlugin__export_file>` **(** :ref:`String<class_string>` path, :ref:`String<class_string>` type, :ref:`PoolStringArray<class_poolstringarray>` features **)** virtual |
|
||||
+-------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_file<class_EditorExportPlugin_add_file>` **(** :ref:`String<class_string>` path, :ref:`PoolByteArray<class_poolbytearray>` file, :ref:`bool<class_bool>` remap **)** |
|
||||
+-------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_shared_object<class_EditorExportPlugin_add_shared_object>` **(** :ref:`String<class_string>` path **)** |
|
||||
+-------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`skip<class_EditorExportPlugin_skip>` **(** **)** |
|
||||
+-------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_EditorExportPlugin__export_begin:
|
||||
|
||||
- void **_export_begin** **(** :ref:`PoolStringArray<class_poolstringarray>` features **)** virtual
|
||||
- void **_export_begin** **(** :ref:`PoolStringArray<class_poolstringarray>` features **)** virtual
|
||||
|
||||
.. _class_EditorExportPlugin__export_file:
|
||||
|
||||
- void **_export_file** **(** :ref:`String<class_string>` path, :ref:`String<class_string>` type, :ref:`PoolStringArray<class_poolstringarray>` features **)** virtual
|
||||
- void **_export_file** **(** :ref:`String<class_string>` path, :ref:`String<class_string>` type, :ref:`PoolStringArray<class_poolstringarray>` features **)** virtual
|
||||
|
||||
.. _class_EditorExportPlugin_add_file:
|
||||
|
||||
- void **add_file** **(** :ref:`String<class_string>` path, :ref:`PoolByteArray<class_poolbytearray>` file, :ref:`bool<class_bool>` remap **)**
|
||||
- void **add_file** **(** :ref:`String<class_string>` path, :ref:`PoolByteArray<class_poolbytearray>` file, :ref:`bool<class_bool>` remap **)**
|
||||
|
||||
.. _class_EditorExportPlugin_add_shared_object:
|
||||
|
||||
- void **add_shared_object** **(** :ref:`String<class_string>` path **)**
|
||||
- void **add_shared_object** **(** :ref:`String<class_string>` path **)**
|
||||
|
||||
.. _class_EditorExportPlugin_skip:
|
||||
|
||||
- void **skip** **(** **)**
|
||||
- void **skip** **(** **)**
|
||||
|
||||
|
||||
|
||||
@@ -19,62 +19,62 @@ Brief Description
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_filter<class_EditorFileDialog_add_filter>` **(** :ref:`String<class_string>` filter **)** |
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_filters<class_EditorFileDialog_clear_filters>` **(** **)** |
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_access<class_EditorFileDialog_get_access>` **(** **)** const |
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_current_dir<class_EditorFileDialog_get_current_dir>` **(** **)** const |
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_current_file<class_EditorFileDialog_get_current_file>` **(** **)** const |
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_current_path<class_EditorFileDialog_get_current_path>` **(** **)** const |
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_display_mode<class_EditorFileDialog_get_display_mode>` **(** **)** const |
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_mode<class_EditorFileDialog_get_mode>` **(** **)** const |
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`VBoxContainer<class_vboxcontainer>` | :ref:`get_vbox<class_EditorFileDialog_get_vbox>` **(** **)** |
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`invalidate<class_EditorFileDialog_invalidate>` **(** **)** |
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_overwrite_warning_disabled<class_EditorFileDialog_is_overwrite_warning_disabled>` **(** **)** const |
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_showing_hidden_files<class_EditorFileDialog_is_showing_hidden_files>` **(** **)** const |
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_access<class_EditorFileDialog_set_access>` **(** :ref:`int<class_int>` access **)** |
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_current_dir<class_EditorFileDialog_set_current_dir>` **(** :ref:`String<class_string>` dir **)** |
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_current_file<class_EditorFileDialog_set_current_file>` **(** :ref:`String<class_string>` file **)** |
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_current_path<class_EditorFileDialog_set_current_path>` **(** :ref:`String<class_string>` path **)** |
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_disable_overwrite_warning<class_EditorFileDialog_set_disable_overwrite_warning>` **(** :ref:`bool<class_bool>` disable **)** |
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_display_mode<class_EditorFileDialog_set_display_mode>` **(** :ref:`int<class_int>` mode **)** |
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_mode<class_EditorFileDialog_set_mode>` **(** :ref:`int<class_int>` mode **)** |
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_show_hidden_files<class_EditorFileDialog_set_show_hidden_files>` **(** :ref:`bool<class_bool>` show **)** |
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_filter<class_EditorFileDialog_add_filter>` **(** :ref:`String<class_string>` filter **)** |
|
||||
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_filters<class_EditorFileDialog_clear_filters>` **(** **)** |
|
||||
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_access<class_EditorFileDialog_get_access>` **(** **)** const |
|
||||
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_current_dir<class_EditorFileDialog_get_current_dir>` **(** **)** const |
|
||||
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_current_file<class_EditorFileDialog_get_current_file>` **(** **)** const |
|
||||
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_current_path<class_EditorFileDialog_get_current_path>` **(** **)** const |
|
||||
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_display_mode<class_EditorFileDialog_get_display_mode>` **(** **)** const |
|
||||
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_mode<class_EditorFileDialog_get_mode>` **(** **)** const |
|
||||
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`VBoxContainer<class_vboxcontainer>` | :ref:`get_vbox<class_EditorFileDialog_get_vbox>` **(** **)** |
|
||||
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`invalidate<class_EditorFileDialog_invalidate>` **(** **)** |
|
||||
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_overwrite_warning_disabled<class_EditorFileDialog_is_overwrite_warning_disabled>` **(** **)** const |
|
||||
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_showing_hidden_files<class_EditorFileDialog_is_showing_hidden_files>` **(** **)** const |
|
||||
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_access<class_EditorFileDialog_set_access>` **(** :ref:`int<class_int>` access **)** |
|
||||
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_current_dir<class_EditorFileDialog_set_current_dir>` **(** :ref:`String<class_string>` dir **)** |
|
||||
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_current_file<class_EditorFileDialog_set_current_file>` **(** :ref:`String<class_string>` file **)** |
|
||||
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_current_path<class_EditorFileDialog_set_current_path>` **(** :ref:`String<class_string>` path **)** |
|
||||
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_disable_overwrite_warning<class_EditorFileDialog_set_disable_overwrite_warning>` **(** :ref:`bool<class_bool>` disable **)** |
|
||||
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_display_mode<class_EditorFileDialog_set_display_mode>` **(** :ref:`int<class_int>` mode **)** |
|
||||
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_mode<class_EditorFileDialog_set_mode>` **(** :ref:`int<class_int>` mode **)** |
|
||||
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_show_hidden_files<class_EditorFileDialog_set_show_hidden_files>` **(** :ref:`bool<class_bool>` show **)** |
|
||||
+--------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_EditorFileDialog_dir_selected:
|
||||
|
||||
- **dir_selected** **(** :ref:`String<class_string>` dir **)**
|
||||
- **dir_selected** **(** :ref:`String<class_string>` dir **)**
|
||||
|
||||
.. _class_EditorFileDialog_file_selected:
|
||||
|
||||
- **file_selected** **(** :ref:`String<class_string>` path **)**
|
||||
- **file_selected** **(** :ref:`String<class_string>` path **)**
|
||||
|
||||
.. _class_EditorFileDialog_files_selected:
|
||||
|
||||
- **files_selected** **(** :ref:`PoolStringArray<class_poolstringarray>` paths **)**
|
||||
- **files_selected** **(** :ref:`PoolStringArray<class_poolstringarray>` paths **)**
|
||||
|
||||
|
||||
Numeric Constants
|
||||
@@ -96,82 +96,82 @@ Member Function Description
|
||||
|
||||
.. _class_EditorFileDialog_add_filter:
|
||||
|
||||
- void **add_filter** **(** :ref:`String<class_string>` filter **)**
|
||||
- void **add_filter** **(** :ref:`String<class_string>` filter **)**
|
||||
|
||||
.. _class_EditorFileDialog_clear_filters:
|
||||
|
||||
- void **clear_filters** **(** **)**
|
||||
- void **clear_filters** **(** **)**
|
||||
|
||||
.. _class_EditorFileDialog_get_access:
|
||||
|
||||
- :ref:`int<class_int>` **get_access** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_access** **(** **)** const
|
||||
|
||||
.. _class_EditorFileDialog_get_current_dir:
|
||||
|
||||
- :ref:`String<class_string>` **get_current_dir** **(** **)** const
|
||||
- :ref:`String<class_string>` **get_current_dir** **(** **)** const
|
||||
|
||||
.. _class_EditorFileDialog_get_current_file:
|
||||
|
||||
- :ref:`String<class_string>` **get_current_file** **(** **)** const
|
||||
- :ref:`String<class_string>` **get_current_file** **(** **)** const
|
||||
|
||||
.. _class_EditorFileDialog_get_current_path:
|
||||
|
||||
- :ref:`String<class_string>` **get_current_path** **(** **)** const
|
||||
- :ref:`String<class_string>` **get_current_path** **(** **)** const
|
||||
|
||||
.. _class_EditorFileDialog_get_display_mode:
|
||||
|
||||
- :ref:`int<class_int>` **get_display_mode** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_display_mode** **(** **)** const
|
||||
|
||||
.. _class_EditorFileDialog_get_mode:
|
||||
|
||||
- :ref:`int<class_int>` **get_mode** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_mode** **(** **)** const
|
||||
|
||||
.. _class_EditorFileDialog_get_vbox:
|
||||
|
||||
- :ref:`VBoxContainer<class_vboxcontainer>` **get_vbox** **(** **)**
|
||||
- :ref:`VBoxContainer<class_vboxcontainer>` **get_vbox** **(** **)**
|
||||
|
||||
.. _class_EditorFileDialog_invalidate:
|
||||
|
||||
- void **invalidate** **(** **)**
|
||||
- void **invalidate** **(** **)**
|
||||
|
||||
.. _class_EditorFileDialog_is_overwrite_warning_disabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_overwrite_warning_disabled** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_overwrite_warning_disabled** **(** **)** const
|
||||
|
||||
.. _class_EditorFileDialog_is_showing_hidden_files:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_showing_hidden_files** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_showing_hidden_files** **(** **)** const
|
||||
|
||||
.. _class_EditorFileDialog_set_access:
|
||||
|
||||
- void **set_access** **(** :ref:`int<class_int>` access **)**
|
||||
- void **set_access** **(** :ref:`int<class_int>` access **)**
|
||||
|
||||
.. _class_EditorFileDialog_set_current_dir:
|
||||
|
||||
- void **set_current_dir** **(** :ref:`String<class_string>` dir **)**
|
||||
- void **set_current_dir** **(** :ref:`String<class_string>` dir **)**
|
||||
|
||||
.. _class_EditorFileDialog_set_current_file:
|
||||
|
||||
- void **set_current_file** **(** :ref:`String<class_string>` file **)**
|
||||
- void **set_current_file** **(** :ref:`String<class_string>` file **)**
|
||||
|
||||
.. _class_EditorFileDialog_set_current_path:
|
||||
|
||||
- void **set_current_path** **(** :ref:`String<class_string>` path **)**
|
||||
- void **set_current_path** **(** :ref:`String<class_string>` path **)**
|
||||
|
||||
.. _class_EditorFileDialog_set_disable_overwrite_warning:
|
||||
|
||||
- void **set_disable_overwrite_warning** **(** :ref:`bool<class_bool>` disable **)**
|
||||
- void **set_disable_overwrite_warning** **(** :ref:`bool<class_bool>` disable **)**
|
||||
|
||||
.. _class_EditorFileDialog_set_display_mode:
|
||||
|
||||
- void **set_display_mode** **(** :ref:`int<class_int>` mode **)**
|
||||
- void **set_display_mode** **(** :ref:`int<class_int>` mode **)**
|
||||
|
||||
.. _class_EditorFileDialog_set_mode:
|
||||
|
||||
- void **set_mode** **(** :ref:`int<class_int>` mode **)**
|
||||
- void **set_mode** **(** :ref:`int<class_int>` mode **)**
|
||||
|
||||
.. _class_EditorFileDialog_set_show_hidden_files:
|
||||
|
||||
- void **set_show_hidden_files** **(** :ref:`bool<class_bool>` show **)**
|
||||
- void **set_show_hidden_files** **(** :ref:`bool<class_bool>` show **)**
|
||||
|
||||
|
||||
|
||||
@@ -19,40 +19,40 @@ Resource filesystem, as the editor sees it.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_file_type<class_EditorFileSystem_get_file_type>` **(** :ref:`String<class_string>` path **)** const |
|
||||
+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`EditorFileSystemDirectory<class_editorfilesystemdirectory>` | :ref:`get_filesystem<class_EditorFileSystem_get_filesystem>` **(** **)** |
|
||||
+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`EditorFileSystemDirectory<class_editorfilesystemdirectory>` | :ref:`get_filesystem_path<class_EditorFileSystem_get_filesystem_path>` **(** :ref:`String<class_string>` path **)** |
|
||||
+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_scanning_progress<class_EditorFileSystem_get_scanning_progress>` **(** **)** const |
|
||||
+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_scanning<class_EditorFileSystem_is_scanning>` **(** **)** const |
|
||||
+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`scan<class_EditorFileSystem_scan>` **(** **)** |
|
||||
+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`scan_sources<class_EditorFileSystem_scan_sources>` **(** **)** |
|
||||
+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`update_file<class_EditorFileSystem_update_file>` **(** :ref:`String<class_string>` path **)** |
|
||||
+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_file_type<class_EditorFileSystem_get_file_type>` **(** :ref:`String<class_string>` path **)** const |
|
||||
+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`EditorFileSystemDirectory<class_editorfilesystemdirectory>` | :ref:`get_filesystem<class_EditorFileSystem_get_filesystem>` **(** **)** |
|
||||
+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`EditorFileSystemDirectory<class_editorfilesystemdirectory>` | :ref:`get_filesystem_path<class_EditorFileSystem_get_filesystem_path>` **(** :ref:`String<class_string>` path **)** |
|
||||
+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_scanning_progress<class_EditorFileSystem_get_scanning_progress>` **(** **)** const |
|
||||
+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_scanning<class_EditorFileSystem_is_scanning>` **(** **)** const |
|
||||
+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`scan<class_EditorFileSystem_scan>` **(** **)** |
|
||||
+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`scan_sources<class_EditorFileSystem_scan_sources>` **(** **)** |
|
||||
+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`update_file<class_EditorFileSystem_update_file>` **(** :ref:`String<class_string>` path **)** |
|
||||
+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_EditorFileSystem_filesystem_changed:
|
||||
|
||||
- **filesystem_changed** **(** **)**
|
||||
- **filesystem_changed** **(** **)**
|
||||
|
||||
Emitted if the filesystem changed.
|
||||
|
||||
.. _class_EditorFileSystem_resources_reimported:
|
||||
|
||||
- **resources_reimported** **(** :ref:`PoolStringArray<class_poolstringarray>` resources **)**
|
||||
- **resources_reimported** **(** :ref:`PoolStringArray<class_poolstringarray>` resources **)**
|
||||
|
||||
.. _class_EditorFileSystem_sources_changed:
|
||||
|
||||
- **sources_changed** **(** :ref:`bool<class_bool>` exist **)**
|
||||
- **sources_changed** **(** :ref:`bool<class_bool>` exist **)**
|
||||
|
||||
Emitted if the source of any imported file changed.
|
||||
|
||||
@@ -67,47 +67,47 @@ Member Function Description
|
||||
|
||||
.. _class_EditorFileSystem_get_file_type:
|
||||
|
||||
- :ref:`String<class_string>` **get_file_type** **(** :ref:`String<class_string>` path **)** const
|
||||
- :ref:`String<class_string>` **get_file_type** **(** :ref:`String<class_string>` path **)** const
|
||||
|
||||
Get the type of the file, given the full path.
|
||||
|
||||
.. _class_EditorFileSystem_get_filesystem:
|
||||
|
||||
- :ref:`EditorFileSystemDirectory<class_editorfilesystemdirectory>` **get_filesystem** **(** **)**
|
||||
- :ref:`EditorFileSystemDirectory<class_editorfilesystemdirectory>` **get_filesystem** **(** **)**
|
||||
|
||||
Get the root directory object.
|
||||
|
||||
.. _class_EditorFileSystem_get_filesystem_path:
|
||||
|
||||
- :ref:`EditorFileSystemDirectory<class_editorfilesystemdirectory>` **get_filesystem_path** **(** :ref:`String<class_string>` path **)**
|
||||
- :ref:`EditorFileSystemDirectory<class_editorfilesystemdirectory>` **get_filesystem_path** **(** :ref:`String<class_string>` path **)**
|
||||
|
||||
.. _class_EditorFileSystem_get_scanning_progress:
|
||||
|
||||
- :ref:`float<class_float>` **get_scanning_progress** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_scanning_progress** **(** **)** const
|
||||
|
||||
Return the scan progress for 0 to 1 if the FS is being scanned.
|
||||
|
||||
.. _class_EditorFileSystem_is_scanning:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_scanning** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_scanning** **(** **)** const
|
||||
|
||||
Return true of the filesystem is being scanned.
|
||||
|
||||
.. _class_EditorFileSystem_scan:
|
||||
|
||||
- void **scan** **(** **)**
|
||||
- void **scan** **(** **)**
|
||||
|
||||
Scan the filesystem for changes.
|
||||
|
||||
.. _class_EditorFileSystem_scan_sources:
|
||||
|
||||
- void **scan_sources** **(** **)**
|
||||
- void **scan_sources** **(** **)**
|
||||
|
||||
Check if the source of any imported resource changed.
|
||||
|
||||
.. _class_EditorFileSystem_update_file:
|
||||
|
||||
- void **update_file** **(** :ref:`String<class_string>` path **)**
|
||||
- void **update_file** **(** :ref:`String<class_string>` path **)**
|
||||
|
||||
Update a file information. Call this if an external program (not Godot) modified the file.
|
||||
|
||||
|
||||
@@ -19,81 +19,81 @@ A diretory for the resource filesystem.
|
||||
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_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:`int<class_int>` | :ref:`get_file_count<class_EditorFileSystemDirectory_get_file_count>` **(** **)** 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_path<class_EditorFileSystemDirectory_get_file_path>` **(** :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_name<class_EditorFileSystemDirectory_get_name>` **(** **)** |
|
||||
+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`EditorFileSystemDirectory<class_editorfilesystemdirectory>` | :ref:`get_parent<class_EditorFileSystemDirectory_get_parent>` **(** **)** |
|
||||
+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_path<class_EditorFileSystemDirectory_get_path>` **(** **)** 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 |
|
||||
+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :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:`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:`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_path<class_EditorFileSystemDirectory_get_file_path>` **(** :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_name<class_EditorFileSystemDirectory_get_name>` **(** **)** |
|
||||
+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`EditorFileSystemDirectory<class_editorfilesystemdirectory>` | :ref:`get_parent<class_EditorFileSystemDirectory_get_parent>` **(** **)** |
|
||||
+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_path<class_EditorFileSystemDirectory_get_path>` **(** **)** 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
|
||||
---------------------------
|
||||
|
||||
.. _class_EditorFileSystemDirectory_find_dir_index:
|
||||
|
||||
- :ref:`int<class_int>` **find_dir_index** **(** :ref:`String<class_string>` name **)** const
|
||||
- :ref:`int<class_int>` **find_dir_index** **(** :ref:`String<class_string>` name **)** const
|
||||
|
||||
.. _class_EditorFileSystemDirectory_find_file_index:
|
||||
|
||||
- :ref:`int<class_int>` **find_file_index** **(** :ref:`String<class_string>` name **)** const
|
||||
- :ref:`int<class_int>` **find_file_index** **(** :ref:`String<class_string>` name **)** const
|
||||
|
||||
.. _class_EditorFileSystemDirectory_get_file:
|
||||
|
||||
- :ref:`String<class_string>` **get_file** **(** :ref:`int<class_int>` idx **)** const
|
||||
- :ref:`String<class_string>` **get_file** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
.. _class_EditorFileSystemDirectory_get_file_count:
|
||||
|
||||
- :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
|
||||
- :ref:`bool<class_bool>` **get_file_import_is_valid** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
.. _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
|
||||
|
||||
.. _class_EditorFileSystemDirectory_get_file_type:
|
||||
|
||||
- :ref:`String<class_string>` **get_file_type** **(** :ref:`int<class_int>` idx **)** const
|
||||
- :ref:`String<class_string>` **get_file_type** **(** :ref:`int<class_int>` idx **)** const
|
||||
|
||||
.. _class_EditorFileSystemDirectory_get_name:
|
||||
|
||||
- :ref:`String<class_string>` **get_name** **(** **)**
|
||||
- :ref:`String<class_string>` **get_name** **(** **)**
|
||||
|
||||
.. _class_EditorFileSystemDirectory_get_parent:
|
||||
|
||||
- :ref:`EditorFileSystemDirectory<class_editorfilesystemdirectory>` **get_parent** **(** **)**
|
||||
- :ref:`EditorFileSystemDirectory<class_editorfilesystemdirectory>` **get_parent** **(** **)**
|
||||
|
||||
.. _class_EditorFileSystemDirectory_get_path:
|
||||
|
||||
- :ref:`String<class_string>` **get_path** **(** **)** const
|
||||
- :ref:`String<class_string>` **get_path** **(** **)** const
|
||||
|
||||
.. _class_EditorFileSystemDirectory_get_subdir:
|
||||
|
||||
- :ref:`EditorFileSystemDirectory<class_editorfilesystemdirectory>` **get_subdir** **(** :ref:`int<class_int>` idx **)**
|
||||
- :ref:`EditorFileSystemDirectory<class_editorfilesystemdirectory>` **get_subdir** **(** :ref:`int<class_int>` idx **)**
|
||||
|
||||
.. _class_EditorFileSystemDirectory_get_subdir_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_subdir_count** **(** **)** const
|
||||
- :ref:`int<class_int>` **get_subdir_count** **(** **)** const
|
||||
|
||||
|
||||
|
||||
@@ -19,27 +19,27 @@ Registers a custom resource importer in the editor. Use the class to parse any f
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_import_options<class_EditorImportPlugin_get_import_options>` **(** :ref:`int<class_int>` preset **)** virtual |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_importer_name<class_EditorImportPlugin_get_importer_name>` **(** **)** virtual |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_option_visibility<class_EditorImportPlugin_get_option_visibility>` **(** :ref:`String<class_string>` option, :ref:`Dictionary<class_dictionary>` options **)** virtual |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_preset_count<class_EditorImportPlugin_get_preset_count>` **(** **)** virtual |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_preset_name<class_EditorImportPlugin_get_preset_name>` **(** :ref:`int<class_int>` preset **)** virtual |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_recognized_extensions<class_EditorImportPlugin_get_recognized_extensions>` **(** **)** virtual |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_resource_type<class_EditorImportPlugin_get_resource_type>` **(** **)** virtual |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_save_extension<class_EditorImportPlugin_get_save_extension>` **(** **)** virtual |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_visible_name<class_EditorImportPlugin_get_visible_name>` **(** **)** virtual |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`import<class_EditorImportPlugin_import>` **(** :ref:`String<class_string>` source_file, :ref:`String<class_string>` save_path, :ref:`Dictionary<class_dictionary>` options, :ref:`Array<class_array>` r_platform_variants, :ref:`Array<class_array>` r_gen_files **)** virtual |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_import_options<class_EditorImportPlugin_get_import_options>` **(** :ref:`int<class_int>` preset **)** virtual |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_importer_name<class_EditorImportPlugin_get_importer_name>` **(** **)** virtual |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_option_visibility<class_EditorImportPlugin_get_option_visibility>` **(** :ref:`String<class_string>` option, :ref:`Dictionary<class_dictionary>` options **)** virtual |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_preset_count<class_EditorImportPlugin_get_preset_count>` **(** **)** virtual |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_preset_name<class_EditorImportPlugin_get_preset_name>` **(** :ref:`int<class_int>` preset **)** virtual |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_recognized_extensions<class_EditorImportPlugin_get_recognized_extensions>` **(** **)** virtual |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_resource_type<class_EditorImportPlugin_get_resource_type>` **(** **)** virtual |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_save_extension<class_EditorImportPlugin_get_save_extension>` **(** **)** virtual |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_visible_name<class_EditorImportPlugin_get_visible_name>` **(** **)** virtual |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`import<class_EditorImportPlugin_import>` **(** :ref:`String<class_string>` source_file, :ref:`String<class_string>` save_path, :ref:`Dictionary<class_dictionary>` options, :ref:`Array<class_array>` r_platform_variants, :ref:`Array<class_array>` r_gen_files **)** virtual |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -101,58 +101,58 @@ Member Function Description
|
||||
|
||||
.. _class_EditorImportPlugin_get_import_options:
|
||||
|
||||
- :ref:`Array<class_array>` **get_import_options** **(** :ref:`int<class_int>` preset **)** virtual
|
||||
- :ref:`Array<class_array>` **get_import_options** **(** :ref:`int<class_int>` preset **)** virtual
|
||||
|
||||
Get the options and default values for the preset at this index. Returns an Array of Dictionaries with the following keys: "name", "default_value", "property_hint" (optional), "hint_string" (optional), "usage" (optional).
|
||||
|
||||
.. _class_EditorImportPlugin_get_importer_name:
|
||||
|
||||
- :ref:`String<class_string>` **get_importer_name** **(** **)** virtual
|
||||
- :ref:`String<class_string>` **get_importer_name** **(** **)** virtual
|
||||
|
||||
Get the unique name of the importer.
|
||||
|
||||
.. _class_EditorImportPlugin_get_option_visibility:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_option_visibility** **(** :ref:`String<class_string>` option, :ref:`Dictionary<class_dictionary>` options **)** virtual
|
||||
- :ref:`bool<class_bool>` **get_option_visibility** **(** :ref:`String<class_string>` option, :ref:`Dictionary<class_dictionary>` options **)** virtual
|
||||
|
||||
.. _class_EditorImportPlugin_get_preset_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_preset_count** **(** **)** virtual
|
||||
- :ref:`int<class_int>` **get_preset_count** **(** **)** virtual
|
||||
|
||||
Get the number of initial presets defined by the plugin. Use :ref:`get_import_options<class_EditorImportPlugin_get_import_options>` to get the default options for the preset and :ref:`get_preset_name<class_EditorImportPlugin_get_preset_name>` to get the name of the preset.
|
||||
|
||||
.. _class_EditorImportPlugin_get_preset_name:
|
||||
|
||||
- :ref:`String<class_string>` **get_preset_name** **(** :ref:`int<class_int>` preset **)** virtual
|
||||
- :ref:`String<class_string>` **get_preset_name** **(** :ref:`int<class_int>` preset **)** virtual
|
||||
|
||||
Get the name of the options preset at this index.
|
||||
|
||||
.. _class_EditorImportPlugin_get_recognized_extensions:
|
||||
|
||||
- :ref:`Array<class_array>` **get_recognized_extensions** **(** **)** virtual
|
||||
- :ref:`Array<class_array>` **get_recognized_extensions** **(** **)** virtual
|
||||
|
||||
Get the list of file extensions to associate with this loader (case insensitive). e.g. "obj".
|
||||
|
||||
.. _class_EditorImportPlugin_get_resource_type:
|
||||
|
||||
- :ref:`String<class_string>` **get_resource_type** **(** **)** virtual
|
||||
- :ref:`String<class_string>` **get_resource_type** **(** **)** virtual
|
||||
|
||||
Get the godot resource type associated with this loader. e.g. "Mesh" or "Animation".
|
||||
|
||||
.. _class_EditorImportPlugin_get_save_extension:
|
||||
|
||||
- :ref:`String<class_string>` **get_save_extension** **(** **)** virtual
|
||||
- :ref:`String<class_string>` **get_save_extension** **(** **)** virtual
|
||||
|
||||
Get the extension used to save this resource in the ``.import`` directory.
|
||||
|
||||
.. _class_EditorImportPlugin_get_visible_name:
|
||||
|
||||
- :ref:`String<class_string>` **get_visible_name** **(** **)** virtual
|
||||
- :ref:`String<class_string>` **get_visible_name** **(** **)** virtual
|
||||
|
||||
Get the name to display in the import window.
|
||||
|
||||
.. _class_EditorImportPlugin_import:
|
||||
|
||||
- :ref:`int<class_int>` **import** **(** :ref:`String<class_string>` source_file, :ref:`String<class_string>` save_path, :ref:`Dictionary<class_dictionary>` options, :ref:`Array<class_array>` r_platform_variants, :ref:`Array<class_array>` r_gen_files **)** virtual
|
||||
- :ref:`int<class_int>` **import** **(** :ref:`String<class_string>` source_file, :ref:`String<class_string>` save_path, :ref:`Dictionary<class_dictionary>` options, :ref:`Array<class_array>` r_platform_variants, :ref:`Array<class_array>` r_gen_files **)** virtual
|
||||
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user