mirror of
https://github.com/stan220/godot-docs.git
synced 2026-09-08 18:29:11 +00:00
Sync classref with current source
This commit is contained in:
Rémi Verschelde
+177
-161
@@ -17,163 +17,167 @@ Built-in GDScript functions.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Color<class_color>` | :ref:`Color8<class_@GDScript_Color8>` **(** :ref:`int<class_int>` r8, :ref:`int<class_int>` g8, :ref:`int<class_int>` b8, :ref:`int<class_int>` a8 **)** |
|
| :ref:`Color<class_color>` | :ref:`Color8<class_@GDScript_Color8>` **(** :ref:`int<class_int>` r8, :ref:`int<class_int>` g8, :ref:`int<class_int>` b8, :ref:`int<class_int>` a8 **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Color<class_color>` | :ref:`ColorN<class_@GDScript_ColorN>` **(** :ref:`String<class_string>` name, :ref:`float<class_float>` alpha **)** |
|
| :ref:`Color<class_color>` | :ref:`ColorN<class_@GDScript_ColorN>` **(** :ref:`String<class_string>` name, :ref:`float<class_float>` alpha **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`abs<class_@GDScript_abs>` **(** :ref:`float<class_float>` s **)** |
|
| :ref:`float<class_float>` | :ref:`abs<class_@GDScript_abs>` **(** :ref:`float<class_float>` s **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`acos<class_@GDScript_acos>` **(** :ref:`float<class_float>` s **)** |
|
| :ref:`float<class_float>` | :ref:`acos<class_@GDScript_acos>` **(** :ref:`float<class_float>` s **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`asin<class_@GDScript_asin>` **(** :ref:`float<class_float>` s **)** |
|
| :ref:`float<class_float>` | :ref:`asin<class_@GDScript_asin>` **(** :ref:`float<class_float>` s **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`assert<class_@GDScript_assert>` **(** :ref:`bool<class_bool>` condition **)** |
|
| void | :ref:`assert<class_@GDScript_assert>` **(** :ref:`bool<class_bool>` condition **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`atan<class_@GDScript_atan>` **(** :ref:`float<class_float>` s **)** |
|
| :ref:`float<class_float>` | :ref:`atan<class_@GDScript_atan>` **(** :ref:`float<class_float>` s **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`atan2<class_@GDScript_atan2>` **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)** |
|
| :ref:`float<class_float>` | :ref:`atan2<class_@GDScript_atan2>` **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Variant<class_variant>` | :ref:`bytes2var<class_@GDScript_bytes2var>` **(** :ref:`PoolByteArray<class_poolbytearray>` bytes **)** |
|
| :ref:`Variant<class_variant>` | :ref:`bytes2var<class_@GDScript_bytes2var>` **(** :ref:`PoolByteArray<class_poolbytearray>` bytes **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`ceil<class_@GDScript_ceil>` **(** :ref:`float<class_float>` s **)** |
|
| :ref:`Vector2<class_vector2>` | :ref:`cartesian2polar<class_@GDScript_cartesian2polar>` **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`char<class_@GDScript_char>` **(** :ref:`int<class_int>` ascii **)** |
|
| :ref:`float<class_float>` | :ref:`ceil<class_@GDScript_ceil>` **(** :ref:`float<class_float>` s **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`clamp<class_@GDScript_clamp>` **(** :ref:`float<class_float>` val, :ref:`float<class_float>` min, :ref:`float<class_float>` max **)** |
|
| :ref:`String<class_string>` | :ref:`char<class_@GDScript_char>` **(** :ref:`int<class_int>` ascii **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Object<class_object>` | :ref:`convert<class_@GDScript_convert>` **(** :ref:`Variant<class_variant>` what, :ref:`int<class_int>` type **)** |
|
| :ref:`float<class_float>` | :ref:`clamp<class_@GDScript_clamp>` **(** :ref:`float<class_float>` val, :ref:`float<class_float>` min, :ref:`float<class_float>` max **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`cos<class_@GDScript_cos>` **(** :ref:`float<class_float>` s **)** |
|
| :ref:`Object<class_object>` | :ref:`convert<class_@GDScript_convert>` **(** :ref:`Variant<class_variant>` what, :ref:`int<class_int>` type **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`cosh<class_@GDScript_cosh>` **(** :ref:`float<class_float>` s **)** |
|
| :ref:`float<class_float>` | :ref:`cos<class_@GDScript_cos>` **(** :ref:`float<class_float>` s **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`db2linear<class_@GDScript_db2linear>` **(** :ref:`float<class_float>` db **)** |
|
| :ref:`float<class_float>` | :ref:`cosh<class_@GDScript_cosh>` **(** :ref:`float<class_float>` s **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`decimals<class_@GDScript_decimals>` **(** :ref:`float<class_float>` step **)** |
|
| :ref:`float<class_float>` | :ref:`db2linear<class_@GDScript_db2linear>` **(** :ref:`float<class_float>` db **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :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:`decimals<class_@GDScript_decimals>` **(** :ref:`float<class_float>` step **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`deg2rad<class_@GDScript_deg2rad>` **(** :ref:`float<class_float>` deg **)** |
|
| :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:`Object<class_object>` | :ref:`dict2inst<class_@GDScript_dict2inst>` **(** :ref:`Dictionary<class_dictionary>` dict **)** |
|
| :ref:`float<class_float>` | :ref:`deg2rad<class_@GDScript_deg2rad>` **(** :ref:`float<class_float>` deg **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`ease<class_@GDScript_ease>` **(** :ref:`float<class_float>` s, :ref:`float<class_float>` curve **)** |
|
| :ref:`Object<class_object>` | :ref:`dict2inst<class_@GDScript_dict2inst>` **(** :ref:`Dictionary<class_dictionary>` dict **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`exp<class_@GDScript_exp>` **(** :ref:`float<class_float>` s **)** |
|
| :ref:`float<class_float>` | :ref:`ease<class_@GDScript_ease>` **(** :ref:`float<class_float>` s, :ref:`float<class_float>` curve **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`floor<class_@GDScript_floor>` **(** :ref:`float<class_float>` s **)** |
|
| :ref:`float<class_float>` | :ref:`exp<class_@GDScript_exp>` **(** :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:`floor<class_@GDScript_floor>` **(** :ref:`float<class_float>` s **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`fposmod<class_@GDScript_fposmod>` **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)** |
|
| :ref:`float<class_float>` | :ref:`fmod<class_@GDScript_fmod>` **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Object<class_object>` | :ref:`funcref<class_@GDScript_funcref>` **(** :ref:`Object<class_object>` instance, :ref:`String<class_string>` funcname **)** |
|
| :ref:`float<class_float>` | :ref:`fposmod<class_@GDScript_fposmod>` **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`hash<class_@GDScript_hash>` **(** :ref:`Variant<class_variant>` var **)** |
|
| :ref:`Object<class_object>` | :ref:`funcref<class_@GDScript_funcref>` **(** :ref:`Object<class_object>` instance, :ref:`String<class_string>` funcname **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Dictionary<class_dictionary>` | :ref:`inst2dict<class_@GDScript_inst2dict>` **(** :ref:`Object<class_object>` inst **)** |
|
| :ref:`int<class_int>` | :ref:`hash<class_@GDScript_hash>` **(** :ref:`Variant<class_variant>` var **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Object<class_object>` | :ref:`instance_from_id<class_@GDScript_instance_from_id>` **(** :ref:`int<class_int>` instance_id **)** |
|
| :ref:`Dictionary<class_dictionary>` | :ref:`inst2dict<class_@GDScript_inst2dict>` **(** :ref:`Object<class_object>` inst **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :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:`Object<class_object>` | :ref:`instance_from_id<class_@GDScript_instance_from_id>` **(** :ref:`int<class_int>` instance_id **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_inf<class_@GDScript_is_inf>` **(** :ref:`float<class_float>` s **)** |
|
| :ref:`float<class_float>` | :ref:`inverse_lerp<class_@GDScript_inverse_lerp>` **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` value **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_nan<class_@GDScript_is_nan>` **(** :ref:`float<class_float>` s **)** |
|
| :ref:`bool<class_bool>` | :ref:`is_inf<class_@GDScript_is_inf>` **(** :ref:`float<class_float>` s **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`len<class_@GDScript_len>` **(** :ref:`Variant<class_variant>` var **)** |
|
| :ref:`bool<class_bool>` | :ref:`is_nan<class_@GDScript_is_nan>` **(** :ref:`float<class_float>` s **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`lerp<class_@GDScript_lerp>` **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` weight **)** |
|
| :ref:`int<class_int>` | :ref:`len<class_@GDScript_len>` **(** :ref:`Variant<class_variant>` var **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`linear2db<class_@GDScript_linear2db>` **(** :ref:`float<class_float>` nrg **)** |
|
| :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:`Object<class_object>` | :ref:`load<class_@GDScript_load>` **(** :ref:`String<class_string>` path **)** |
|
| :ref:`float<class_float>` | :ref:`linear2db<class_@GDScript_linear2db>` **(** :ref:`float<class_float>` nrg **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`log<class_@GDScript_log>` **(** :ref:`float<class_float>` s **)** |
|
| :ref:`Object<class_object>` | :ref:`load<class_@GDScript_load>` **(** :ref:`String<class_string>` path **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`max<class_@GDScript_max>` **(** :ref:`float<class_float>` a, :ref:`float<class_float>` b **)** |
|
| :ref:`float<class_float>` | :ref:`log<class_@GDScript_log>` **(** :ref:`float<class_float>` s **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`min<class_@GDScript_min>` **(** :ref:`float<class_float>` a, :ref:`float<class_float>` b **)** |
|
| :ref:`float<class_float>` | :ref:`max<class_@GDScript_max>` **(** :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:`float<class_float>` | :ref:`min<class_@GDScript_min>` **(** :ref:`float<class_float>` a, :ref:`float<class_float>` b **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Variant<class_variant>` | :ref:`parse_json<class_@GDScript_parse_json>` **(** :ref:`String<class_string>` json **)** |
|
| :ref:`int<class_int>` | :ref:`nearest_po2<class_@GDScript_nearest_po2>` **(** :ref:`int<class_int>` val **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`pow<class_@GDScript_pow>` **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)** |
|
| :ref:`Variant<class_variant>` | :ref:`parse_json<class_@GDScript_parse_json>` **(** :ref:`String<class_string>` json **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Resource<class_resource>` | :ref:`preload<class_@GDScript_preload>` **(** :ref:`String<class_string>` path **)** |
|
| :ref:`Vector2<class_vector2>` | :ref:`polar2cartesian<class_@GDScript_polar2cartesian>` **(** :ref:`float<class_float>` r, :ref:`float<class_float>` th **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`print<class_@GDScript_print>` **(** **)** vararg |
|
| :ref:`float<class_float>` | :ref:`pow<class_@GDScript_pow>` **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`print_stack<class_@GDScript_print_stack>` **(** **)** |
|
| :ref:`Resource<class_resource>` | :ref:`preload<class_@GDScript_preload>` **(** :ref:`String<class_string>` path **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`printerr<class_@GDScript_printerr>` **(** **)** vararg |
|
| void | :ref:`print<class_@GDScript_print>` **(** **)** vararg |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`printraw<class_@GDScript_printraw>` **(** **)** vararg |
|
| void | :ref:`print_stack<class_@GDScript_print_stack>` **(** **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`prints<class_@GDScript_prints>` **(** **)** vararg |
|
| void | :ref:`printerr<class_@GDScript_printerr>` **(** **)** vararg |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`printt<class_@GDScript_printt>` **(** **)** vararg |
|
| void | :ref:`printraw<class_@GDScript_printraw>` **(** **)** vararg |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`rad2deg<class_@GDScript_rad2deg>` **(** :ref:`float<class_float>` rad **)** |
|
| void | :ref:`prints<class_@GDScript_prints>` **(** **)** vararg |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`rand_range<class_@GDScript_rand_range>` **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to **)** |
|
| void | :ref:`printt<class_@GDScript_printt>` **(** **)** vararg |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Array<class_array>` | :ref:`rand_seed<class_@GDScript_rand_seed>` **(** :ref:`int<class_int>` seed **)** |
|
| :ref:`float<class_float>` | :ref:`rad2deg<class_@GDScript_rad2deg>` **(** :ref:`float<class_float>` rad **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`randf<class_@GDScript_randf>` **(** **)** |
|
| :ref:`float<class_float>` | :ref:`rand_range<class_@GDScript_rand_range>` **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`randi<class_@GDScript_randi>` **(** **)** |
|
| :ref:`Array<class_array>` | :ref:`rand_seed<class_@GDScript_rand_seed>` **(** :ref:`int<class_int>` seed **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`randomize<class_@GDScript_randomize>` **(** **)** |
|
| :ref:`float<class_float>` | :ref:`randf<class_@GDScript_randf>` **(** **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Array<class_array>` | :ref:`range<class_@GDScript_range>` **(** **)** vararg |
|
| :ref:`int<class_int>` | :ref:`randi<class_@GDScript_randi>` **(** **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :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 **)** |
|
| void | :ref:`randomize<class_@GDScript_randomize>` **(** **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`round<class_@GDScript_round>` **(** :ref:`float<class_float>` s **)** |
|
| :ref:`Array<class_array>` | :ref:`range<class_@GDScript_range>` **(** **)** vararg |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`seed<class_@GDScript_seed>` **(** :ref:`int<class_int>` seed **)** |
|
| :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:`sign<class_@GDScript_sign>` **(** :ref:`float<class_float>` s **)** |
|
| :ref:`float<class_float>` | :ref:`round<class_@GDScript_round>` **(** :ref:`float<class_float>` s **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`sin<class_@GDScript_sin>` **(** :ref:`float<class_float>` s **)** |
|
| void | :ref:`seed<class_@GDScript_seed>` **(** :ref:`int<class_int>` seed **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`sinh<class_@GDScript_sinh>` **(** :ref:`float<class_float>` s **)** |
|
| :ref:`float<class_float>` | :ref:`sign<class_@GDScript_sign>` **(** :ref:`float<class_float>` s **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`sqrt<class_@GDScript_sqrt>` **(** :ref:`float<class_float>` s **)** |
|
| :ref:`float<class_float>` | :ref:`sin<class_@GDScript_sin>` **(** :ref:`float<class_float>` s **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`stepify<class_@GDScript_stepify>` **(** :ref:`float<class_float>` s, :ref:`float<class_float>` step **)** |
|
| :ref:`float<class_float>` | :ref:`sinh<class_@GDScript_sinh>` **(** :ref:`float<class_float>` s **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`str<class_@GDScript_str>` **(** **)** vararg |
|
| :ref:`float<class_float>` | :ref:`sqrt<class_@GDScript_sqrt>` **(** :ref:`float<class_float>` s **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Variant<class_variant>` | :ref:`str2var<class_@GDScript_str2var>` **(** :ref:`String<class_string>` string **)** |
|
| :ref:`float<class_float>` | :ref:`stepify<class_@GDScript_stepify>` **(** :ref:`float<class_float>` s, :ref:`float<class_float>` step **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`tan<class_@GDScript_tan>` **(** :ref:`float<class_float>` s **)** |
|
| :ref:`String<class_string>` | :ref:`str<class_@GDScript_str>` **(** **)** vararg |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`tanh<class_@GDScript_tanh>` **(** :ref:`float<class_float>` s **)** |
|
| :ref:`Variant<class_variant>` | :ref:`str2var<class_@GDScript_str2var>` **(** :ref:`String<class_string>` string **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`to_json<class_@GDScript_to_json>` **(** :ref:`Variant<class_variant>` var **)** |
|
| :ref:`float<class_float>` | :ref:`tan<class_@GDScript_tan>` **(** :ref:`float<class_float>` s **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`type_exists<class_@GDScript_type_exists>` **(** :ref:`String<class_string>` type **)** |
|
| :ref:`float<class_float>` | :ref:`tanh<class_@GDScript_tanh>` **(** :ref:`float<class_float>` s **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`typeof<class_@GDScript_typeof>` **(** :ref:`Variant<class_variant>` what **)** |
|
| :ref:`String<class_string>` | :ref:`to_json<class_@GDScript_to_json>` **(** :ref:`Variant<class_variant>` var **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`validate_json<class_@GDScript_validate_json>` **(** :ref:`String<class_string>` json **)** |
|
| :ref:`bool<class_bool>` | :ref:`type_exists<class_@GDScript_type_exists>` **(** :ref:`String<class_string>` type **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`PoolByteArray<class_poolbytearray>` | :ref:`var2bytes<class_@GDScript_var2bytes>` **(** :ref:`Variant<class_variant>` var **)** |
|
| :ref:`int<class_int>` | :ref:`typeof<class_@GDScript_typeof>` **(** :ref:`Variant<class_variant>` what **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`var2str<class_@GDScript_var2str>` **(** :ref:`Variant<class_variant>` var **)** |
|
| :ref:`String<class_string>` | :ref:`validate_json<class_@GDScript_validate_json>` **(** :ref:`String<class_string>` json **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Object<class_object>` | :ref:`weakref<class_@GDScript_weakref>` **(** :ref:`Object<class_object>` obj **)** |
|
| :ref:`PoolByteArray<class_poolbytearray>` | :ref:`var2bytes<class_@GDScript_var2bytes>` **(** :ref:`Variant<class_variant>` var **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`wrapf<class_@GDScript_wrapf>` **(** :ref:`float<class_float>` value, :ref:`float<class_float>` min, :ref:`float<class_float>` max **)** |
|
| :ref:`String<class_string>` | :ref:`var2str<class_@GDScript_var2str>` **(** :ref:`Variant<class_variant>` var **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`wrapi<class_@GDScript_wrapi>` **(** :ref:`int<class_int>` value, :ref:`int<class_int>` min, :ref:`int<class_int>` max **)** |
|
| :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:`float<class_float>` | :ref:`wrapf<class_@GDScript_wrapf>` **(** :ref:`float<class_float>` value, :ref:`float<class_float>` min, :ref:`float<class_float>` max **)** |
|
||||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`int<class_int>` | :ref:`wrapi<class_@GDScript_wrapi>` **(** :ref:`int<class_int>` value, :ref:`int<class_int>` min, :ref:`int<class_int>` max **)** |
|
||||||
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`GDScriptFunctionState<class_gdscriptfunctionstate>` | :ref:`yield<class_@GDScript_yield>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` signal **)** |
|
||||||
|
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Numeric Constants
|
Numeric Constants
|
||||||
-----------------
|
-----------------
|
||||||
@@ -296,6 +300,12 @@ Returns the arc tangent of ``y/x`` in radians. Use to get the angle of tangent `
|
|||||||
|
|
||||||
Decodes a byte array back to a value.
|
Decodes a byte array back to a value.
|
||||||
|
|
||||||
|
.. _class_@GDScript_cartesian2polar:
|
||||||
|
|
||||||
|
- :ref:`Vector2<class_vector2>` **cartesian2polar** **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)**
|
||||||
|
|
||||||
|
Converts a 2D point expressed in the cartesian coordinate system (x and y axis) to the polar coordinate system (a distance from the origin and an angle).
|
||||||
|
|
||||||
.. _class_@GDScript_ceil:
|
.. _class_@GDScript_ceil:
|
||||||
|
|
||||||
- :ref:`float<class_float>` **ceil** **(** :ref:`float<class_float>` s **)**
|
- :ref:`float<class_float>` **ceil** **(** :ref:`float<class_float>` s **)**
|
||||||
@@ -340,7 +350,7 @@ Clamps ``val`` and returns a value not less than ``min`` and not more than ``max
|
|||||||
|
|
||||||
- :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>`.
|
Converts from a type to another in the best way possible. The ``type`` parameter uses the enum TYPE\_\* in :ref:`@GlobalScope<class_@globalscope>`.
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
@@ -667,6 +677,12 @@ Be aware that the JSON specification does not define integer or float types, but
|
|||||||
else:
|
else:
|
||||||
print("unexpected results")
|
print("unexpected results")
|
||||||
|
|
||||||
|
.. _class_@GDScript_polar2cartesian:
|
||||||
|
|
||||||
|
- :ref:`Vector2<class_vector2>` **polar2cartesian** **(** :ref:`float<class_float>` r, :ref:`float<class_float>` th **)**
|
||||||
|
|
||||||
|
Converts a 2D point expressed in the polar coordinate system (a distance from the origin ``r`` and an angle ``th``) to the cartesian coordinate system (x and y axis).
|
||||||
|
|
||||||
.. _class_@GDScript_pow:
|
.. _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 **)**
|
||||||
@@ -996,7 +1012,7 @@ Returns whether the given class exists in :ref:`ClassDB<class_classdb>`.
|
|||||||
|
|
||||||
- :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>`.
|
Returns the internal type of the given Variant object, using the TYPE\_\* enum in :ref:`@GlobalScope<class_@globalscope>`.
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
@@ -1103,9 +1119,9 @@ Usable for creating loop-alike behavior or infinite surfaces.
|
|||||||
|
|
||||||
.. _class_@GDScript_yield:
|
.. _class_@GDScript_yield:
|
||||||
|
|
||||||
- :ref:`GDFunctionState<class_gdfunctionstate>` **yield** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` signal **)**
|
- :ref:`GDScriptFunctionState<class_gdscriptfunctionstate>` **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.
|
Stops the function execution and returns the current state. Call :ref:`GDScriptFunctionState.resume<class_GDScriptFunctionState_resume>` on the state to resume execution. This invalidates the state.
|
||||||
|
|
||||||
Returns anything that was passed to the resume function call. If passed an object and a signal, the execution is resumed when the object's signal is emitted.
|
Returns anything that was passed to the resume function call. If passed an object and a signal, the execution is resumed when the object's signal is emitted.
|
||||||
|
|
||||||
|
|||||||
@@ -1,11 +1,11 @@
|
|||||||
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
||||||
.. DO NOT EDIT THIS FILE, but the @Global Scope.xml source instead.
|
.. DO NOT EDIT THIS FILE, but the @GlobalScope.xml source instead.
|
||||||
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
||||||
|
|
||||||
.. _class_@Global Scope:
|
.. _class_@GlobalScope:
|
||||||
|
|
||||||
@Global Scope
|
@GlobalScope
|
||||||
=============
|
============
|
||||||
|
|
||||||
**Category:** Core
|
**Category:** Core
|
||||||
|
|
||||||
@@ -17,83 +17,91 @@ Global scope constants and variables.
|
|||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
.. _class_@Global Scope_ARVRServer:
|
.. _class_@GlobalScope_ARVRServer:
|
||||||
|
|
||||||
- :ref:`ARVRServer<class_arvrserver>` **ARVRServer** - :ref:`ARVRServer<class_arvrserver>` singleton
|
- :ref:`ARVRServer<class_arvrserver>` **ARVRServer** - :ref:`ARVRServer<class_arvrserver>` singleton
|
||||||
|
|
||||||
.. _class_@Global Scope_AudioServer:
|
.. _class_@GlobalScope_AudioServer:
|
||||||
|
|
||||||
- :ref:`AudioServer<class_audioserver>` **AudioServer** - :ref:`AudioServer<class_audioserver>` singleton
|
- :ref:`AudioServer<class_audioserver>` **AudioServer** - :ref:`AudioServer<class_audioserver>` singleton
|
||||||
|
|
||||||
.. _class_@Global Scope_ClassDB:
|
.. _class_@GlobalScope_ClassDB:
|
||||||
|
|
||||||
- :ref:`ClassDB<class_classdb>` **ClassDB** - :ref:`ClassDB<class_classdb>` singleton
|
- :ref:`ClassDB<class_classdb>` **ClassDB** - :ref:`ClassDB<class_classdb>` singleton
|
||||||
|
|
||||||
.. _class_@Global Scope_Engine:
|
.. _class_@GlobalScope_Engine:
|
||||||
|
|
||||||
- :ref:`Engine<class_engine>` **Engine** - :ref:`Engine<class_engine>` singleton
|
- :ref:`Engine<class_engine>` **Engine** - :ref:`Engine<class_engine>` singleton
|
||||||
|
|
||||||
.. _class_@Global Scope_Geometry:
|
.. _class_@GlobalScope_Geometry:
|
||||||
|
|
||||||
- :ref:`Geometry<class_geometry>` **Geometry** - :ref:`Geometry<class_geometry>` singleton
|
- :ref:`Geometry<class_geometry>` **Geometry** - :ref:`Geometry<class_geometry>` singleton
|
||||||
|
|
||||||
.. _class_@Global Scope_GodotSharp:
|
.. _class_@GlobalScope_GodotSharp:
|
||||||
|
|
||||||
- :ref:`GodotSharp<class_godotsharp>` **GodotSharp** - :ref:`GodotSharp<class_godotsharp>` singleton
|
- :ref:`GodotSharp<class_godotsharp>` **GodotSharp** - :ref:`GodotSharp<class_godotsharp>` singleton
|
||||||
|
|
||||||
.. _class_@Global Scope_IP:
|
.. _class_@GlobalScope_IP:
|
||||||
|
|
||||||
- :ref:`IP<class_ip>` **IP** - :ref:`IP<class_ip>` singleton
|
- :ref:`IP<class_ip>` **IP** - :ref:`IP<class_ip>` singleton
|
||||||
|
|
||||||
.. _class_@Global Scope_Input:
|
.. _class_@GlobalScope_Input:
|
||||||
|
|
||||||
- :ref:`Input<class_input>` **Input** - :ref:`Input<class_input>` singleton
|
- :ref:`Input<class_input>` **Input** - :ref:`Input<class_input>` singleton
|
||||||
|
|
||||||
.. _class_@Global Scope_InputMap:
|
.. _class_@GlobalScope_InputMap:
|
||||||
|
|
||||||
- :ref:`InputMap<class_inputmap>` **InputMap** - :ref:`InputMap<class_inputmap>` singleton
|
- :ref:`InputMap<class_inputmap>` **InputMap** - :ref:`InputMap<class_inputmap>` singleton
|
||||||
|
|
||||||
.. _class_@Global Scope_JSON:
|
.. _class_@GlobalScope_JSON:
|
||||||
|
|
||||||
- :ref:`JSON<class_json>` **JSON** - :ref:`JSON<class_json>` singleton
|
- :ref:`JSON<class_json>` **JSON** - :ref:`JSON<class_json>` singleton
|
||||||
|
|
||||||
.. _class_@Global Scope_Marshalls:
|
.. _class_@GlobalScope_JavaScript:
|
||||||
|
|
||||||
|
- :ref:`JavaScript<class_javascript>` **JavaScript**
|
||||||
|
|
||||||
|
.. _class_@GlobalScope_Marshalls:
|
||||||
|
|
||||||
- :ref:`Reference<class_reference>` **Marshalls** - :ref:`Marshalls<class_marshalls>` singleton
|
- :ref:`Reference<class_reference>` **Marshalls** - :ref:`Marshalls<class_marshalls>` singleton
|
||||||
|
|
||||||
.. _class_@Global Scope_OS:
|
.. _class_@GlobalScope_OS:
|
||||||
|
|
||||||
- :ref:`OS<class_os>` **OS** - :ref:`OS<class_os>` singleton
|
- :ref:`OS<class_os>` **OS** - :ref:`OS<class_os>` singleton
|
||||||
|
|
||||||
.. _class_@Global Scope_Performance:
|
.. _class_@GlobalScope_Performance:
|
||||||
|
|
||||||
- :ref:`Performance<class_performance>` **Performance** - :ref:`Performance<class_performance>` singleton
|
- :ref:`Performance<class_performance>` **Performance** - :ref:`Performance<class_performance>` singleton
|
||||||
|
|
||||||
.. _class_@Global Scope_Physics2DServer:
|
.. _class_@GlobalScope_Physics2DServer:
|
||||||
|
|
||||||
- :ref:`Physics2DServer<class_physics2dserver>` **Physics2DServer** - :ref:`Physics2DServer<class_physics2dserver>` singleton
|
- :ref:`Physics2DServer<class_physics2dserver>` **Physics2DServer** - :ref:`Physics2DServer<class_physics2dserver>` singleton
|
||||||
|
|
||||||
.. _class_@Global Scope_PhysicsServer:
|
.. _class_@GlobalScope_PhysicsServer:
|
||||||
|
|
||||||
- :ref:`PhysicsServer<class_physicsserver>` **PhysicsServer** - :ref:`PhysicsServer<class_physicsserver>` singleton
|
- :ref:`PhysicsServer<class_physicsserver>` **PhysicsServer** - :ref:`PhysicsServer<class_physicsserver>` singleton
|
||||||
|
|
||||||
.. _class_@Global Scope_ProjectSettings:
|
.. _class_@GlobalScope_ProjectSettings:
|
||||||
|
|
||||||
- :ref:`ProjectSettings<class_projectsettings>` **ProjectSettings** - :ref:`ProjectSettings<class_projectsettings>` singleton
|
- :ref:`ProjectSettings<class_projectsettings>` **ProjectSettings** - :ref:`ProjectSettings<class_projectsettings>` singleton
|
||||||
|
|
||||||
.. _class_@Global Scope_ResourceLoader:
|
.. _class_@GlobalScope_ResourceLoader:
|
||||||
|
|
||||||
- :ref:`ResourceLoader<class_resourceloader>` **ResourceLoader** - :ref:`ResourceLoader<class_resourceloader>` singleton
|
- :ref:`ResourceLoader<class_resourceloader>` **ResourceLoader** - :ref:`ResourceLoader<class_resourceloader>` singleton
|
||||||
|
|
||||||
.. _class_@Global Scope_ResourceSaver:
|
.. _class_@GlobalScope_ResourceSaver:
|
||||||
|
|
||||||
- :ref:`ResourceSaver<class_resourcesaver>` **ResourceSaver** - :ref:`ResourceSaver<class_resourcesaver>` singleton
|
- :ref:`ResourceSaver<class_resourcesaver>` **ResourceSaver** - :ref:`ResourceSaver<class_resourcesaver>` singleton
|
||||||
|
|
||||||
.. _class_@Global Scope_TranslationServer:
|
.. _class_@GlobalScope_TranslationServer:
|
||||||
|
|
||||||
- :ref:`TranslationServer<class_translationserver>` **TranslationServer** - :ref:`TranslationServer<class_translationserver>` singleton
|
- :ref:`TranslationServer<class_translationserver>` **TranslationServer** - :ref:`TranslationServer<class_translationserver>` singleton
|
||||||
|
|
||||||
.. _class_@Global Scope_VisualServer:
|
.. _class_@GlobalScope_VisualScriptEditor:
|
||||||
|
|
||||||
|
- :ref:`VisualScriptEditor<class_visualscripteditor>` **VisualScriptEditor** - :ref:`VisualScriptEditor<class_visualscripteditor>` singleton
|
||||||
|
|
||||||
|
.. _class_@GlobalScope_VisualServer:
|
||||||
|
|
||||||
- :ref:`VisualServer<class_visualserver>` **VisualServer** - :ref:`VisualServer<class_visualserver>` singleton
|
- :ref:`VisualServer<class_visualserver>` **VisualServer** - :ref:`VisualServer<class_visualserver>` singleton
|
||||||
|
|
||||||
@@ -532,7 +540,7 @@ Numeric Constants
|
|||||||
- **TYPE_TRANSFORM2D** = **8** --- Variable is of type :ref:`Transform2D<class_transform2d>`.
|
- **TYPE_TRANSFORM2D** = **8** --- Variable is of type :ref:`Transform2D<class_transform2d>`.
|
||||||
- **TYPE_PLANE** = **9** --- Variable is of type :ref:`Plane<class_plane>`.
|
- **TYPE_PLANE** = **9** --- Variable is of type :ref:`Plane<class_plane>`.
|
||||||
- **TYPE_QUAT** = **10** --- Variable is of type :ref:`Quat<class_quat>`.
|
- **TYPE_QUAT** = **10** --- Variable is of type :ref:`Quat<class_quat>`.
|
||||||
- **TYPE_RECT3** = **11** --- Variable is of type :ref:`Rect3<class_rect3>`.
|
- **TYPE_AABB** = **11** --- Variable is of type :ref:`AABB<class_aabb>`.
|
||||||
- **TYPE_BASIS** = **12** --- Variable is of type :ref:`Basis<class_basis>`.
|
- **TYPE_BASIS** = **12** --- Variable is of type :ref:`Basis<class_basis>`.
|
||||||
- **TYPE_TRANSFORM** = **13** --- Variable is of type :ref:`Transform<class_transform>`.
|
- **TYPE_TRANSFORM** = **13** --- Variable is of type :ref:`Transform<class_transform>`.
|
||||||
- **TYPE_COLOR** = **14** --- Variable is of type :ref:`Color<class_color>`.
|
- **TYPE_COLOR** = **14** --- Variable is of type :ref:`Color<class_color>`.
|
||||||
@@ -0,0 +1,214 @@
|
|||||||
|
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
||||||
|
.. DO NOT EDIT THIS FILE, but the AABB.xml source instead.
|
||||||
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
||||||
|
|
||||||
|
.. _class_AABB:
|
||||||
|
|
||||||
|
AABB
|
||||||
|
====
|
||||||
|
|
||||||
|
**Category:** Built-In Types
|
||||||
|
|
||||||
|
Brief Description
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
Axis-Aligned Bounding Box.
|
||||||
|
|
||||||
|
Member Functions
|
||||||
|
----------------
|
||||||
|
|
||||||
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`AABB<class_aabb>` | :ref:`AABB<class_AABB_AABB>` **(** :ref:`Vector3<class_vector3>` position, :ref:`Vector3<class_vector3>` size **)** |
|
||||||
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`bool<class_bool>` | :ref:`encloses<class_AABB_encloses>` **(** :ref:`AABB<class_aabb>` with **)** |
|
||||||
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`AABB<class_aabb>` | :ref:`expand<class_AABB_expand>` **(** :ref:`Vector3<class_vector3>` to_point **)** |
|
||||||
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`float<class_float>` | :ref:`get_area<class_AABB_get_area>` **(** **)** |
|
||||||
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`Vector3<class_vector3>` | :ref:`get_endpoint<class_AABB_get_endpoint>` **(** :ref:`int<class_int>` idx **)** |
|
||||||
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`Vector3<class_vector3>` | :ref:`get_longest_axis<class_AABB_get_longest_axis>` **(** **)** |
|
||||||
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`int<class_int>` | :ref:`get_longest_axis_index<class_AABB_get_longest_axis_index>` **(** **)** |
|
||||||
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`float<class_float>` | :ref:`get_longest_axis_size<class_AABB_get_longest_axis_size>` **(** **)** |
|
||||||
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`Vector3<class_vector3>` | :ref:`get_shortest_axis<class_AABB_get_shortest_axis>` **(** **)** |
|
||||||
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`int<class_int>` | :ref:`get_shortest_axis_index<class_AABB_get_shortest_axis_index>` **(** **)** |
|
||||||
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`float<class_float>` | :ref:`get_shortest_axis_size<class_AABB_get_shortest_axis_size>` **(** **)** |
|
||||||
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`Vector3<class_vector3>` | :ref:`get_support<class_AABB_get_support>` **(** :ref:`Vector3<class_vector3>` dir **)** |
|
||||||
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`AABB<class_aabb>` | :ref:`grow<class_AABB_grow>` **(** :ref:`float<class_float>` by **)** |
|
||||||
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`bool<class_bool>` | :ref:`has_no_area<class_AABB_has_no_area>` **(** **)** |
|
||||||
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`bool<class_bool>` | :ref:`has_no_surface<class_AABB_has_no_surface>` **(** **)** |
|
||||||
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`bool<class_bool>` | :ref:`has_point<class_AABB_has_point>` **(** :ref:`Vector3<class_vector3>` point **)** |
|
||||||
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`AABB<class_aabb>` | :ref:`intersection<class_AABB_intersection>` **(** :ref:`AABB<class_aabb>` with **)** |
|
||||||
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`bool<class_bool>` | :ref:`intersects<class_AABB_intersects>` **(** :ref:`AABB<class_aabb>` with **)** |
|
||||||
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`bool<class_bool>` | :ref:`intersects_plane<class_AABB_intersects_plane>` **(** :ref:`Plane<class_plane>` plane **)** |
|
||||||
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`bool<class_bool>` | :ref:`intersects_segment<class_AABB_intersects_segment>` **(** :ref:`Vector3<class_vector3>` from, :ref:`Vector3<class_vector3>` to **)** |
|
||||||
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`AABB<class_aabb>` | :ref:`merge<class_AABB_merge>` **(** :ref:`AABB<class_aabb>` with **)** |
|
||||||
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
|
Member Variables
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. _class_AABB_end:
|
||||||
|
|
||||||
|
- :ref:`Vector3<class_vector3>` **end** - Ending corner.
|
||||||
|
|
||||||
|
.. _class_AABB_position:
|
||||||
|
|
||||||
|
- :ref:`Vector3<class_vector3>` **position** - Beginning corner.
|
||||||
|
|
||||||
|
.. _class_AABB_size:
|
||||||
|
|
||||||
|
- :ref:`Vector3<class_vector3>` **size** - Size from position to end.
|
||||||
|
|
||||||
|
|
||||||
|
Description
|
||||||
|
-----------
|
||||||
|
|
||||||
|
AABB consists of a position, a size, and several utility functions. It is typically used for fast overlap tests.
|
||||||
|
|
||||||
|
Member Function Description
|
||||||
|
---------------------------
|
||||||
|
|
||||||
|
.. _class_AABB_AABB:
|
||||||
|
|
||||||
|
- :ref:`AABB<class_aabb>` **AABB** **(** :ref:`Vector3<class_vector3>` position, :ref:`Vector3<class_vector3>` size **)**
|
||||||
|
|
||||||
|
Optional constructor, accepts position and size.
|
||||||
|
|
||||||
|
.. _class_AABB_encloses:
|
||||||
|
|
||||||
|
- :ref:`bool<class_bool>` **encloses** **(** :ref:`AABB<class_aabb>` with **)**
|
||||||
|
|
||||||
|
Returns ``true`` if this ``AABB`` completely encloses another one.
|
||||||
|
|
||||||
|
.. _class_AABB_expand:
|
||||||
|
|
||||||
|
- :ref:`AABB<class_aabb>` **expand** **(** :ref:`Vector3<class_vector3>` to_point **)**
|
||||||
|
|
||||||
|
Returns this ``AABB`` expanded to include a given point.
|
||||||
|
|
||||||
|
.. _class_AABB_get_area:
|
||||||
|
|
||||||
|
- :ref:`float<class_float>` **get_area** **(** **)**
|
||||||
|
|
||||||
|
Gets the area of the ``AABB``.
|
||||||
|
|
||||||
|
.. _class_AABB_get_endpoint:
|
||||||
|
|
||||||
|
- :ref:`Vector3<class_vector3>` **get_endpoint** **(** :ref:`int<class_int>` idx **)**
|
||||||
|
|
||||||
|
Gets the position of the 8 endpoints of the ``AABB`` in space.
|
||||||
|
|
||||||
|
.. _class_AABB_get_longest_axis:
|
||||||
|
|
||||||
|
- :ref:`Vector3<class_vector3>` **get_longest_axis** **(** **)**
|
||||||
|
|
||||||
|
Returns the normalized longest axis of the ``AABB``.
|
||||||
|
|
||||||
|
.. _class_AABB_get_longest_axis_index:
|
||||||
|
|
||||||
|
- :ref:`int<class_int>` **get_longest_axis_index** **(** **)**
|
||||||
|
|
||||||
|
Returns the index of the longest axis of the ``AABB`` (according to :ref:`Vector3<class_vector3>`::AXIS\* enum).
|
||||||
|
|
||||||
|
.. _class_AABB_get_longest_axis_size:
|
||||||
|
|
||||||
|
- :ref:`float<class_float>` **get_longest_axis_size** **(** **)**
|
||||||
|
|
||||||
|
Returns the scalar length of the longest axis of the ``AABB``.
|
||||||
|
|
||||||
|
.. _class_AABB_get_shortest_axis:
|
||||||
|
|
||||||
|
- :ref:`Vector3<class_vector3>` **get_shortest_axis** **(** **)**
|
||||||
|
|
||||||
|
Returns the normalized shortest axis of the ``AABB``.
|
||||||
|
|
||||||
|
.. _class_AABB_get_shortest_axis_index:
|
||||||
|
|
||||||
|
- :ref:`int<class_int>` **get_shortest_axis_index** **(** **)**
|
||||||
|
|
||||||
|
Returns the index of the shortest axis of the ``AABB`` (according to :ref:`Vector3<class_vector3>`::AXIS\* enum).
|
||||||
|
|
||||||
|
.. _class_AABB_get_shortest_axis_size:
|
||||||
|
|
||||||
|
- :ref:`float<class_float>` **get_shortest_axis_size** **(** **)**
|
||||||
|
|
||||||
|
Returns the scalar length of the shortest axis of the ``AABB``.
|
||||||
|
|
||||||
|
.. _class_AABB_get_support:
|
||||||
|
|
||||||
|
- :ref:`Vector3<class_vector3>` **get_support** **(** :ref:`Vector3<class_vector3>` dir **)**
|
||||||
|
|
||||||
|
Returns the support point in a given direction. This is useful for collision detection algorithms.
|
||||||
|
|
||||||
|
.. _class_AABB_grow:
|
||||||
|
|
||||||
|
- :ref:`AABB<class_aabb>` **grow** **(** :ref:`float<class_float>` by **)**
|
||||||
|
|
||||||
|
Returns a copy of the ``AABB`` grown a given amount of units towards all the sides.
|
||||||
|
|
||||||
|
.. _class_AABB_has_no_area:
|
||||||
|
|
||||||
|
- :ref:`bool<class_bool>` **has_no_area** **(** **)**
|
||||||
|
|
||||||
|
Returns ``true`` if the ``AABB`` is flat or empty.
|
||||||
|
|
||||||
|
.. _class_AABB_has_no_surface:
|
||||||
|
|
||||||
|
- :ref:`bool<class_bool>` **has_no_surface** **(** **)**
|
||||||
|
|
||||||
|
Returns ``true`` if the ``AABB`` is empty.
|
||||||
|
|
||||||
|
.. _class_AABB_has_point:
|
||||||
|
|
||||||
|
- :ref:`bool<class_bool>` **has_point** **(** :ref:`Vector3<class_vector3>` point **)**
|
||||||
|
|
||||||
|
Returns ``true`` if the ``AABB`` contains a point.
|
||||||
|
|
||||||
|
.. _class_AABB_intersection:
|
||||||
|
|
||||||
|
- :ref:`AABB<class_aabb>` **intersection** **(** :ref:`AABB<class_aabb>` with **)**
|
||||||
|
|
||||||
|
Returns the intersection between two ``AABB``. An empty AABB (size 0,0,0) is returned on failure.
|
||||||
|
|
||||||
|
.. _class_AABB_intersects:
|
||||||
|
|
||||||
|
- :ref:`bool<class_bool>` **intersects** **(** :ref:`AABB<class_aabb>` with **)**
|
||||||
|
|
||||||
|
Returns ``true`` if the ``AABB`` overlaps with another.
|
||||||
|
|
||||||
|
.. _class_AABB_intersects_plane:
|
||||||
|
|
||||||
|
- :ref:`bool<class_bool>` **intersects_plane** **(** :ref:`Plane<class_plane>` plane **)**
|
||||||
|
|
||||||
|
Returns ``true`` if the ``AABB`` is on both sides of a plane.
|
||||||
|
|
||||||
|
.. _class_AABB_intersects_segment:
|
||||||
|
|
||||||
|
- :ref:`bool<class_bool>` **intersects_segment** **(** :ref:`Vector3<class_vector3>` from, :ref:`Vector3<class_vector3>` to **)**
|
||||||
|
|
||||||
|
Returns ``true`` if the ``AABB`` intersects the line segment between ``from`` and ``to``.
|
||||||
|
|
||||||
|
.. _class_AABB_merge:
|
||||||
|
|
||||||
|
- :ref:`AABB<class_aabb>` **merge** **(** :ref:`AABB<class_aabb>` with **)**
|
||||||
|
|
||||||
|
Returns a larger AABB that contains this AABB and ``with``.
|
||||||
|
|
||||||
|
|
||||||
@@ -26,20 +26,12 @@ Member Functions
|
|||||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Button<class_button>` | :ref:`add_cancel<class_AcceptDialog_add_cancel>` **(** :ref:`String<class_string>` name **)** |
|
| :ref:`Button<class_button>` | :ref:`add_cancel<class_AcceptDialog_add_cancel>` **(** :ref:`String<class_string>` name **)** |
|
||||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`get_hide_on_ok<class_AcceptDialog_get_hide_on_ok>` **(** **)** const |
|
|
||||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`Label<class_label>` | :ref:`get_label<class_AcceptDialog_get_label>` **(** **)** |
|
| :ref:`Label<class_label>` | :ref:`get_label<class_AcceptDialog_get_label>` **(** **)** |
|
||||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Button<class_button>` | :ref:`get_ok<class_AcceptDialog_get_ok>` **(** **)** |
|
| :ref:`Button<class_button>` | :ref:`get_ok<class_AcceptDialog_get_ok>` **(** **)** |
|
||||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`get_text<class_AcceptDialog_get_text>` **(** **)** const |
|
|
||||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`register_text_enter<class_AcceptDialog_register_text_enter>` **(** :ref:`Node<class_node>` line_edit **)** |
|
| void | :ref:`register_text_enter<class_AcceptDialog_register_text_enter>` **(** :ref:`Node<class_node>` line_edit **)** |
|
||||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_hide_on_ok<class_AcceptDialog_set_hide_on_ok>` **(** :ref:`bool<class_bool>` enabled **)** |
|
|
||||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_text<class_AcceptDialog_set_text>` **(** :ref:`String<class_string>` text **)** |
|
|
||||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Signals
|
Signals
|
||||||
-------
|
-------
|
||||||
@@ -91,12 +83,6 @@ If ``true``, *right* will place the button to the right of any sibling buttons.
|
|||||||
|
|
||||||
Adds a button with label *name* and a cancel action to the dialog and returns the created button.
|
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
|
|
||||||
|
|
||||||
Return true if the dialog will be hidden when accepted (default true).
|
|
||||||
|
|
||||||
.. _class_AcceptDialog_get_label:
|
.. _class_AcceptDialog_get_label:
|
||||||
|
|
||||||
- :ref:`Label<class_label>` **get_label** **(** **)**
|
- :ref:`Label<class_label>` **get_label** **(** **)**
|
||||||
@@ -109,28 +95,10 @@ Return the label used for built-in text.
|
|||||||
|
|
||||||
Return the OK Button.
|
Return the OK Button.
|
||||||
|
|
||||||
.. _class_AcceptDialog_get_text:
|
|
||||||
|
|
||||||
- :ref:`String<class_string>` **get_text** **(** **)** const
|
|
||||||
|
|
||||||
Return the built-in label text.
|
|
||||||
|
|
||||||
.. _class_AcceptDialog_register_text_enter:
|
.. _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.
|
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 **)**
|
|
||||||
|
|
||||||
Set whether the dialog is hidden when accepted (default true).
|
|
||||||
|
|
||||||
.. _class_AcceptDialog_set_text:
|
|
||||||
|
|
||||||
- void **set_text** **(** :ref:`String<class_string>` text **)**
|
|
||||||
|
|
||||||
Set the built-in label text.
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -19,41 +19,13 @@ Sprite node that can use multiple textures for animation.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------+----------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`get_animation<class_AnimatedSprite_get_animation>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AnimatedSprite_is_playing>` **(** **)** const |
|
||||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------+----------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_frame<class_AnimatedSprite_get_frame>` **(** **)** const |
|
| void | :ref:`play<class_AnimatedSprite_play>` **(** :ref:`String<class_string>` anim="" **)** |
|
||||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------+----------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_offset<class_AnimatedSprite_get_offset>` **(** **)** const |
|
| void | :ref:`stop<class_AnimatedSprite_stop>` **(** **)** |
|
||||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------+----------------------------------------------------------------------------------------+
|
||||||
| :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
|
Signals
|
||||||
-------
|
-------
|
||||||
@@ -115,48 +87,6 @@ Animations are created using a :ref:`SpriteFrames<class_spriteframes>` resource,
|
|||||||
Member Function Description
|
Member Function Description
|
||||||
---------------------------
|
---------------------------
|
||||||
|
|
||||||
.. _class_AnimatedSprite_get_animation:
|
|
||||||
|
|
||||||
- :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
|
|
||||||
|
|
||||||
Return the visible frame index.
|
|
||||||
|
|
||||||
.. _class_AnimatedSprite_get_offset:
|
|
||||||
|
|
||||||
- :ref:`Vector2<class_vector2>` **get_offset** **(** **)** const
|
|
||||||
|
|
||||||
Return the offset of the sprite in the node origin.
|
|
||||||
|
|
||||||
.. _class_AnimatedSprite_get_sprite_frames:
|
|
||||||
|
|
||||||
- :ref:`SpriteFrames<class_spriteframes>` **get_sprite_frames** **(** **)** const
|
|
||||||
|
|
||||||
Get the :ref:`SpriteFrames<class_spriteframes>` resource, which contains all frames.
|
|
||||||
|
|
||||||
.. _class_AnimatedSprite_is_centered:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_centered** **(** **)** const
|
|
||||||
|
|
||||||
Return true when centered. See :ref:`set_centered<class_AnimatedSprite_set_centered>`.
|
|
||||||
|
|
||||||
.. _class_AnimatedSprite_is_flipped_h:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_flipped_h** **(** **)** const
|
|
||||||
|
|
||||||
Return true if sprite is flipped horizontally.
|
|
||||||
|
|
||||||
.. _class_AnimatedSprite_is_flipped_v:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_flipped_v** **(** **)** const
|
|
||||||
|
|
||||||
Return true if sprite is flipped vertically.
|
|
||||||
|
|
||||||
.. _class_AnimatedSprite_is_playing:
|
.. _class_AnimatedSprite_is_playing:
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_playing** **(** **)** const
|
- :ref:`bool<class_bool>` **is_playing** **(** **)** const
|
||||||
@@ -169,48 +99,6 @@ Return true if an animation if currently being played.
|
|||||||
|
|
||||||
Play the animation set in parameter. If no parameter is provided, the current animation is played.
|
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 **)**
|
|
||||||
|
|
||||||
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 **)**
|
|
||||||
|
|
||||||
When turned on, offset at (0,0) is the center of the sprite, when off, the top-left corner is.
|
|
||||||
|
|
||||||
.. _class_AnimatedSprite_set_flip_h:
|
|
||||||
|
|
||||||
- void **set_flip_h** **(** :ref:`bool<class_bool>` flip_h **)**
|
|
||||||
|
|
||||||
If true, sprite is flipped horizontally.
|
|
||||||
|
|
||||||
.. _class_AnimatedSprite_set_flip_v:
|
|
||||||
|
|
||||||
- void **set_flip_v** **(** :ref:`bool<class_bool>` flip_v **)**
|
|
||||||
|
|
||||||
If true, sprite is flipped vertically.
|
|
||||||
|
|
||||||
.. _class_AnimatedSprite_set_frame:
|
|
||||||
|
|
||||||
- void **set_frame** **(** :ref:`int<class_int>` frame **)**
|
|
||||||
|
|
||||||
Set the visible sprite frame index (from the list of frames inside the :ref:`SpriteFrames<class_spriteframes>` resource).
|
|
||||||
|
|
||||||
.. _class_AnimatedSprite_set_offset:
|
|
||||||
|
|
||||||
- void **set_offset** **(** :ref:`Vector2<class_vector2>` offset **)**
|
|
||||||
|
|
||||||
Set the offset of the sprite in the node origin. Position varies depending on whether it is centered or not.
|
|
||||||
|
|
||||||
.. _class_AnimatedSprite_set_sprite_frames:
|
|
||||||
|
|
||||||
- void **set_sprite_frames** **(** :ref:`SpriteFrames<class_spriteframes>` sprite_frames **)**
|
|
||||||
|
|
||||||
Set the :ref:`SpriteFrames<class_spriteframes>` resource, which contains all frames.
|
|
||||||
|
|
||||||
.. _class_AnimatedSprite_stop:
|
.. _class_AnimatedSprite_stop:
|
||||||
|
|
||||||
- void **stop** **(** **)**
|
- void **stop** **(** **)**
|
||||||
|
|||||||
@@ -19,25 +19,13 @@ Brief Description
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------+------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`get_animation<class_AnimatedSprite3D_get_animation>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AnimatedSprite3D_is_playing>` **(** **)** const |
|
||||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------+------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_frame<class_AnimatedSprite3D_get_frame>` **(** **)** const |
|
| void | :ref:`play<class_AnimatedSprite3D_play>` **(** :ref:`String<class_string>` anim="" **)** |
|
||||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------+------------------------------------------------------------------------------------------+
|
||||||
| :ref:`SpriteFrames<class_spriteframes>` | :ref:`get_sprite_frames<class_AnimatedSprite3D_get_sprite_frames>` **(** **)** const |
|
| void | :ref:`stop<class_AnimatedSprite3D_stop>` **(** **)** |
|
||||||
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------+------------------------------------------------------------------------------------------+
|
||||||
| :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
|
Signals
|
||||||
-------
|
-------
|
||||||
@@ -77,24 +65,6 @@ Animations are created using a :ref:`SpriteFrames<class_spriteframes>` resource,
|
|||||||
Member Function Description
|
Member Function Description
|
||||||
---------------------------
|
---------------------------
|
||||||
|
|
||||||
.. _class_AnimatedSprite3D_get_animation:
|
|
||||||
|
|
||||||
- :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
|
|
||||||
|
|
||||||
Return the visible frame index.
|
|
||||||
|
|
||||||
.. _class_AnimatedSprite3D_get_sprite_frames:
|
|
||||||
|
|
||||||
- :ref:`SpriteFrames<class_spriteframes>` **get_sprite_frames** **(** **)** const
|
|
||||||
|
|
||||||
Get the :ref:`SpriteFrames<class_spriteframes>` resource, which contains all frames.
|
|
||||||
|
|
||||||
.. _class_AnimatedSprite3D_is_playing:
|
.. _class_AnimatedSprite3D_is_playing:
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_playing** **(** **)** const
|
- :ref:`bool<class_bool>` **is_playing** **(** **)** const
|
||||||
@@ -107,24 +77,6 @@ Return true if an animation if currently being played.
|
|||||||
|
|
||||||
Play the animation set in parameter. If no parameter is provided, the current animation is played.
|
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 **)**
|
|
||||||
|
|
||||||
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 **)**
|
|
||||||
|
|
||||||
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 **)**
|
|
||||||
|
|
||||||
Set the :ref:`SpriteFrames<class_spriteframes>` resource, which contains all frames.
|
|
||||||
|
|
||||||
.. _class_AnimatedSprite3D_stop:
|
.. _class_AnimatedSprite3D_stop:
|
||||||
|
|
||||||
- void **stop** **(** **)**
|
- void **stop** **(** **)**
|
||||||
|
|||||||
@@ -38,8 +38,6 @@ Member Functions
|
|||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_animation_list<class_AnimationPlayer_get_animation_list>` **(** **)** const |
|
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_animation_list<class_AnimationPlayer_get_animation_list>` **(** **)** const |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_animation_process_mode<class_AnimationPlayer_get_animation_process_mode>` **(** **)** const |
|
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`String<class_string>` | :ref:`get_autoplay<class_AnimationPlayer_get_autoplay>` **(** **)** const |
|
| :ref:`String<class_string>` | :ref:`get_autoplay<class_AnimationPlayer_get_autoplay>` **(** **)** const |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_blend_time<class_AnimationPlayer_get_blend_time>` **(** :ref:`String<class_string>` anim_from, :ref:`String<class_string>` anim_to **)** const |
|
| :ref:`float<class_float>` | :ref:`get_blend_time<class_AnimationPlayer_get_blend_time>` **(** :ref:`String<class_string>` anim_from, :ref:`String<class_string>` anim_to **)** const |
|
||||||
@@ -50,12 +48,8 @@ Member Functions
|
|||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_current_animation_position<class_AnimationPlayer_get_current_animation_position>` **(** **)** 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:`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:`float<class_float>` | :ref:`get_speed_scale<class_AnimationPlayer_get_speed_scale>` **(** **)** const |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`has_animation<class_AnimationPlayer_has_animation>` **(** :ref:`String<class_string>` name **)** const |
|
| :ref:`bool<class_bool>` | :ref:`has_animation<class_AnimationPlayer_has_animation>` **(** :ref:`String<class_string>` name **)** const |
|
||||||
@@ -78,18 +72,12 @@ Member Functions
|
|||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_active<class_AnimationPlayer_set_active>` **(** :ref:`bool<class_bool>` active **)** |
|
| void | :ref:`set_active<class_AnimationPlayer_set_active>` **(** :ref:`bool<class_bool>` active **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_animation_process_mode<class_AnimationPlayer_set_animation_process_mode>` **(** :ref:`int<class_int>` mode **)** |
|
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_autoplay<class_AnimationPlayer_set_autoplay>` **(** :ref:`String<class_string>` name **)** |
|
| void | :ref:`set_autoplay<class_AnimationPlayer_set_autoplay>` **(** :ref:`String<class_string>` name **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_blend_time<class_AnimationPlayer_set_blend_time>` **(** :ref:`String<class_string>` anim_from, :ref:`String<class_string>` anim_to, :ref:`float<class_float>` sec **)** |
|
| void | :ref:`set_blend_time<class_AnimationPlayer_set_blend_time>` **(** :ref:`String<class_string>` anim_from, :ref:`String<class_string>` anim_to, :ref:`float<class_float>` sec **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_current_animation<class_AnimationPlayer_set_current_animation>` **(** :ref:`String<class_string>` anim **)** |
|
| void | :ref:`set_current_animation<class_AnimationPlayer_set_current_animation>` **(** :ref:`String<class_string>` anim **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_default_blend_time<class_AnimationPlayer_set_default_blend_time>` **(** :ref:`float<class_float>` sec **)** |
|
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_root<class_AnimationPlayer_set_root>` **(** :ref:`NodePath<class_nodepath>` path **)** |
|
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_speed_scale<class_AnimationPlayer_set_speed_scale>` **(** :ref:`float<class_float>` speed **)** |
|
| void | :ref:`set_speed_scale<class_AnimationPlayer_set_speed_scale>` **(** :ref:`float<class_float>` speed **)** |
|
||||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`stop<class_AnimationPlayer_stop>` **(** :ref:`bool<class_bool>` reset=true **)** |
|
| void | :ref:`stop<class_AnimationPlayer_stop>` **(** :ref:`bool<class_bool>` reset=true **)** |
|
||||||
@@ -203,12 +191,6 @@ Get an :ref:`Animation<class_animation>` resource by requesting a name.
|
|||||||
|
|
||||||
Get the list of names of the animations stored in the player.
|
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
|
|
||||||
|
|
||||||
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:
|
.. _class_AnimationPlayer_get_autoplay:
|
||||||
|
|
||||||
- :ref:`String<class_string>` **get_autoplay** **(** **)** const
|
- :ref:`String<class_string>` **get_autoplay** **(** **)** const
|
||||||
@@ -239,24 +221,12 @@ Get the length (in seconds) of the currently being played animation.
|
|||||||
|
|
||||||
Get the position (in seconds) of the currently being played animation.
|
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
|
|
||||||
|
|
||||||
Return the default blend time between animations.
|
|
||||||
|
|
||||||
.. _class_AnimationPlayer_get_position:
|
.. _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).
|
Return the playback position (in seconds) in an animation channel (or channel 0 if none is provided).
|
||||||
|
|
||||||
.. _class_AnimationPlayer_get_root:
|
|
||||||
|
|
||||||
- :ref:`NodePath<class_nodepath>` **get_root** **(** **)** const
|
|
||||||
|
|
||||||
Return path to root node (see :ref:`set_root<class_AnimationPlayer_set_root>`).
|
|
||||||
|
|
||||||
.. _class_AnimationPlayer_get_speed_scale:
|
.. _class_AnimationPlayer_get_speed_scale:
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_speed_scale** **(** **)** const
|
- :ref:`float<class_float>` **get_speed_scale** **(** **)** const
|
||||||
@@ -323,12 +293,6 @@ Seek the animation to a given position in time (in seconds). If 'update' is true
|
|||||||
|
|
||||||
Set the player as active (playing). If false, it will do nothing.
|
Set the player as active (playing). If false, it will do nothing.
|
||||||
|
|
||||||
.. _class_AnimationPlayer_set_animation_process_mode:
|
|
||||||
|
|
||||||
- void **set_animation_process_mode** **(** :ref:`int<class_int>` mode **)**
|
|
||||||
|
|
||||||
Set the mode in which the animation player processes. By default, it processes on idle time (framerate dependent), but using fixed time works well for animating static collision bodies in 2D and 3D. See enum ANIMATION_PROCESS\_\*.
|
|
||||||
|
|
||||||
.. _class_AnimationPlayer_set_autoplay:
|
.. _class_AnimationPlayer_set_autoplay:
|
||||||
|
|
||||||
- void **set_autoplay** **(** :ref:`String<class_string>` name **)**
|
- void **set_autoplay** **(** :ref:`String<class_string>` name **)**
|
||||||
@@ -347,18 +311,6 @@ Specify a blend time (in seconds) between two animations, referenced by their na
|
|||||||
|
|
||||||
Set the current animation (even if no playback occurs). Using set_current_animation() and set_active() are similar to calling play().
|
Set the current animation (even if no playback occurs). Using set_current_animation() and set_active() are similar to calling play().
|
||||||
|
|
||||||
.. _class_AnimationPlayer_set_default_blend_time:
|
|
||||||
|
|
||||||
- void **set_default_blend_time** **(** :ref:`float<class_float>` sec **)**
|
|
||||||
|
|
||||||
Set the default blend time between animations.
|
|
||||||
|
|
||||||
.. _class_AnimationPlayer_set_root:
|
|
||||||
|
|
||||||
- void **set_root** **(** :ref:`NodePath<class_nodepath>` path **)**
|
|
||||||
|
|
||||||
AnimationPlayer resolves animation track paths from this node (which is relative to itself), by default root is "..", but it can be changed.
|
|
||||||
|
|
||||||
.. _class_AnimationPlayer_set_speed_scale:
|
.. _class_AnimationPlayer_set_speed_scale:
|
||||||
|
|
||||||
- void **set_speed_scale** **(** :ref:`float<class_float>` speed **)**
|
- void **set_speed_scale** **(** :ref:`float<class_float>` speed **)**
|
||||||
|
|||||||
@@ -54,8 +54,6 @@ Member Functions
|
|||||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`disconnect_nodes<class_AnimationTreePlayer_disconnect_nodes>` **(** :ref:`String<class_string>` 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_base_path<class_AnimationTreePlayer_get_base_path>` **(** **)** const |
|
||||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`NodePath<class_nodepath>` | :ref:`get_master_player<class_AnimationTreePlayer_get_master_player>` **(** **)** const |
|
| :ref:`NodePath<class_nodepath>` | :ref:`get_master_player<class_AnimationTreePlayer_get_master_player>` **(** **)** const |
|
||||||
@@ -118,8 +116,6 @@ Member Functions
|
|||||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_active<class_AnimationTreePlayer_set_active>` **(** :ref:`bool<class_bool>` enabled **)** |
|
| 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_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 **)** |
|
| void | :ref:`set_master_player<class_AnimationTreePlayer_set_master_player>` **(** :ref:`NodePath<class_nodepath>` nodepath **)** |
|
||||||
@@ -273,12 +269,6 @@ Connects node ``id`` to ``dst_id`` at the specified input slot.
|
|||||||
|
|
||||||
Disconnects nodes connected to ``id`` at the specified input slot.
|
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
|
|
||||||
|
|
||||||
Returns playback process mode of this AnimationTreePlayer.
|
|
||||||
|
|
||||||
.. _class_AnimationTreePlayer_get_base_path:
|
.. _class_AnimationTreePlayer_get_base_path:
|
||||||
|
|
||||||
- :ref:`NodePath<class_nodepath>` **get_base_path** **(** **)** const
|
- :ref:`NodePath<class_nodepath>` **get_base_path** **(** **)** const
|
||||||
@@ -455,12 +445,6 @@ Resets this AnimationTreePlayer.
|
|||||||
|
|
||||||
Sets whether this AnimationTreePlayer is active. AnimationTreePlayer will start processing if set to active.
|
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 **)**
|
|
||||||
|
|
||||||
Sets process mode (ANIMATION_PROCESS\_\*) of this AnimationTreePlayer.
|
|
||||||
|
|
||||||
.. _class_AnimationTreePlayer_set_base_path:
|
.. _class_AnimationTreePlayer_set_base_path:
|
||||||
|
|
||||||
- void **set_base_path** **(** :ref:`NodePath<class_nodepath>` path **)**
|
- void **set_base_path** **(** :ref:`NodePath<class_nodepath>` path **)**
|
||||||
|
|||||||
+18
-306
@@ -19,95 +19,23 @@ General purpose area node for detection and 3D physics influence.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_angular_damp<class_Area_get_angular_damp>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`get_collision_layer_bit<class_Area_get_collision_layer_bit>` **(** :ref:`int<class_int>` bit **)** const |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`get_audio_bus<class_Area_get_audio_bus>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`get_collision_mask_bit<class_Area_get_collision_mask_bit>` **(** :ref:`int<class_int>` bit **)** const |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_collision_layer<class_Area_get_collision_layer>` **(** **)** const |
|
| :ref:`Array<class_array>` | :ref:`get_overlapping_areas<class_Area_get_overlapping_areas>` **(** **)** const |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`get_collision_layer_bit<class_Area_get_collision_layer_bit>` **(** :ref:`int<class_int>` bit **)** const |
|
| :ref:`Array<class_array>` | :ref:`get_overlapping_bodies<class_Area_get_overlapping_bodies>` **(** **)** const |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_collision_mask<class_Area_get_collision_mask>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`overlaps_area<class_Area_overlaps_area>` **(** :ref:`Node<class_node>` area **)** const |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`get_collision_mask_bit<class_Area_get_collision_mask_bit>` **(** :ref:`int<class_int>` bit **)** const |
|
| :ref:`bool<class_bool>` | :ref:`overlaps_body<class_Area_overlaps_body>` **(** :ref:`Node<class_node>` body **)** const |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_gravity<class_Area_get_gravity>` **(** **)** const |
|
| void | :ref:`set_collision_layer_bit<class_Area_set_collision_layer_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_gravity_distance_scale<class_Area_get_gravity_distance_scale>` **(** **)** const |
|
| void | :ref:`set_collision_mask_bit<class_Area_set_collision_mask_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
|
||||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :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
|
Signals
|
||||||
-------
|
-------
|
||||||
@@ -254,69 +182,23 @@ Description
|
|||||||
Member Function Description
|
Member Function Description
|
||||||
---------------------------
|
---------------------------
|
||||||
|
|
||||||
.. _class_Area_get_angular_damp:
|
|
||||||
|
|
||||||
- :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
|
|
||||||
|
|
||||||
.. _class_Area_get_collision_layer:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_collision_layer** **(** **)** const
|
|
||||||
|
|
||||||
Return the physics layer this area is in.
|
|
||||||
|
|
||||||
.. _class_Area_get_collision_layer_bit:
|
.. _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.
|
Return an individual bit on the layer mask.
|
||||||
|
|
||||||
.. _class_Area_get_collision_mask:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_collision_mask** **(** **)** const
|
|
||||||
|
|
||||||
Return the physics layers this area can scan for collisions.
|
|
||||||
|
|
||||||
.. _class_Area_get_collision_mask_bit:
|
.. _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.
|
Return an individual bit on the collision mask.
|
||||||
|
|
||||||
.. _class_Area_get_gravity:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_gravity** **(** **)** const
|
|
||||||
|
|
||||||
Return the gravity intensity.
|
|
||||||
|
|
||||||
.. _class_Area_get_gravity_distance_scale:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_gravity_distance_scale** **(** **)** const
|
|
||||||
|
|
||||||
Return the falloff factor for point gravity.
|
|
||||||
|
|
||||||
.. _class_Area_get_gravity_vector:
|
|
||||||
|
|
||||||
- :ref:`Vector3<class_vector3>` **get_gravity_vector** **(** **)** const
|
|
||||||
|
|
||||||
Return the gravity vector. If gravity is a point (see :ref:`is_gravity_a_point<class_Area_is_gravity_a_point>`), this will be the attraction center.
|
|
||||||
|
|
||||||
.. _class_Area_get_linear_damp:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_linear_damp** **(** **)** const
|
|
||||||
|
|
||||||
Return the linear damp rate.
|
|
||||||
|
|
||||||
.. _class_Area_get_overlapping_areas:
|
.. _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 ``Area``s.
|
Returns a list of intersecting ``Area``\ s.
|
||||||
|
|
||||||
.. _class_Area_get_overlapping_bodies:
|
.. _class_Area_get_overlapping_bodies:
|
||||||
|
|
||||||
@@ -324,56 +206,6 @@ Returns a list of intersecting ``Area``s.
|
|||||||
|
|
||||||
Returns a list of intersecting :ref:`PhysicsBody<class_physicsbody>`\ s.
|
Returns a list of intersecting :ref:`PhysicsBody<class_physicsbody>`\ s.
|
||||||
|
|
||||||
.. _class_Area_get_priority:
|
|
||||||
|
|
||||||
- :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
|
|
||||||
|
|
||||||
.. _class_Area_get_reverb_bus:
|
|
||||||
|
|
||||||
- :ref:`String<class_string>` **get_reverb_bus** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Area_get_reverb_uniformity:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_reverb_uniformity** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Area_get_space_override_mode:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_space_override_mode** **(** **)** const
|
|
||||||
|
|
||||||
Return the space override mode.
|
|
||||||
|
|
||||||
.. _class_Area_is_gravity_a_point:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_gravity_a_point** **(** **)** const
|
|
||||||
|
|
||||||
Return whether gravity is a point. A point gravity will attract objects towards it, as opposed to a gravity vector, which moves them in a given direction.
|
|
||||||
|
|
||||||
.. _class_Area_is_monitorable:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_monitorable** **(** **)** const
|
|
||||||
|
|
||||||
Return whether this area can be detected by other, monitoring, areas.
|
|
||||||
|
|
||||||
.. _class_Area_is_monitoring:
|
|
||||||
|
|
||||||
- :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
|
|
||||||
|
|
||||||
.. _class_Area_is_using_reverb_bus:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_using_reverb_bus** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Area_overlaps_area:
|
.. _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
|
||||||
@@ -386,136 +218,16 @@ If ``true`` the given area overlaps the Area.
|
|||||||
|
|
||||||
If ``true`` the given body overlaps the Area.
|
If ``true`` the given body overlaps the Area.
|
||||||
|
|
||||||
.. _class_Area_set_angular_damp:
|
|
||||||
|
|
||||||
- void **set_angular_damp** **(** :ref:`float<class_float>` angular_damp **)**
|
|
||||||
|
|
||||||
Set the rate at which objects stop spinning in this area, if there are not any other forces making it spin. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops.
|
|
||||||
|
|
||||||
In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second.
|
|
||||||
|
|
||||||
.. _class_Area_set_audio_bus:
|
|
||||||
|
|
||||||
- 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 **)**
|
|
||||||
|
|
||||||
.. _class_Area_set_collision_layer:
|
|
||||||
|
|
||||||
- void **set_collision_layer** **(** :ref:`int<class_int>` collision_layer **)**
|
|
||||||
|
|
||||||
Set the physics layers this area is in.
|
|
||||||
|
|
||||||
Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using :ref:`set_collision_mask<class_Area_set_collision_mask>`.
|
|
||||||
|
|
||||||
A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A.
|
|
||||||
|
|
||||||
.. _class_Area_set_collision_layer_bit:
|
.. _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.
|
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 **)**
|
|
||||||
|
|
||||||
Set the physics layers this area can scan for collisions.
|
|
||||||
|
|
||||||
.. _class_Area_set_collision_mask_bit:
|
.. _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.
|
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 **)**
|
|
||||||
|
|
||||||
Set the gravity intensity. This is useful to alter the force of gravity without altering its direction.
|
|
||||||
|
|
||||||
This value multiplies the gravity vector, whether it is the given vector (:ref:`set_gravity_vector<class_Area_set_gravity_vector>`), or a calculated one (when using a center of gravity).
|
|
||||||
|
|
||||||
.. _class_Area_set_gravity_distance_scale:
|
|
||||||
|
|
||||||
- void **set_gravity_distance_scale** **(** :ref:`float<class_float>` distance_scale **)**
|
|
||||||
|
|
||||||
Set the falloff factor for point gravity. The greater this value is, the faster the strength of gravity decreases with the square of distance.
|
|
||||||
|
|
||||||
.. _class_Area_set_gravity_is_point:
|
|
||||||
|
|
||||||
- void **set_gravity_is_point** **(** :ref:`bool<class_bool>` enable **)**
|
|
||||||
|
|
||||||
When overriding space parameters, this method sets whether this area has a center of gravity. To set/get the location of the center of gravity, use :ref:`set_gravity_vector<class_Area_set_gravity_vector>`/:ref:`get_gravity_vector<class_Area_get_gravity_vector>`.
|
|
||||||
|
|
||||||
.. _class_Area_set_gravity_vector:
|
|
||||||
|
|
||||||
- void **set_gravity_vector** **(** :ref:`Vector3<class_vector3>` vector **)**
|
|
||||||
|
|
||||||
Set the gravity vector. This vector does not have to be normalized.
|
|
||||||
|
|
||||||
If gravity is a point (see :ref:`is_gravity_a_point<class_Area_is_gravity_a_point>`), this will be the attraction center.
|
|
||||||
|
|
||||||
.. _class_Area_set_linear_damp:
|
|
||||||
|
|
||||||
- void **set_linear_damp** **(** :ref:`float<class_float>` linear_damp **)**
|
|
||||||
|
|
||||||
Set the rate at which objects stop moving in this area, if there are not any other forces moving it. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops.
|
|
||||||
|
|
||||||
In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second.
|
|
||||||
|
|
||||||
.. _class_Area_set_monitorable:
|
|
||||||
|
|
||||||
- void **set_monitorable** **(** :ref:`bool<class_bool>` enable **)**
|
|
||||||
|
|
||||||
Set whether this area can be detected by other, monitoring, areas. Only areas need to be marked as monitorable. Bodies are always so.
|
|
||||||
|
|
||||||
.. _class_Area_set_monitoring:
|
|
||||||
|
|
||||||
- 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 **)**
|
|
||||||
|
|
||||||
Set the order in which the area is processed. Greater values mean the area gets processed first. This is useful for areas which have a space override different from AREA_SPACE_OVERRIDE_DISABLED or AREA_SPACE_OVERRIDE_COMBINE, as they replace values, and are thus order-dependent.
|
|
||||||
|
|
||||||
Areas with the same priority value get evaluated in an unpredictable order, and should be differentiated if evaluation order is to be important.
|
|
||||||
|
|
||||||
.. _class_Area_set_reverb_amount:
|
|
||||||
|
|
||||||
- void **set_reverb_amount** **(** :ref:`float<class_float>` amount **)**
|
|
||||||
|
|
||||||
.. _class_Area_set_reverb_bus:
|
|
||||||
|
|
||||||
- void **set_reverb_bus** **(** :ref:`String<class_string>` name **)**
|
|
||||||
|
|
||||||
.. _class_Area_set_reverb_uniformity:
|
|
||||||
|
|
||||||
- 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 **)**
|
|
||||||
|
|
||||||
Set the space override mode. This mode controls how an area affects gravity and damp.
|
|
||||||
|
|
||||||
AREA_SPACE_OVERRIDE_DISABLED: This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them.
|
|
||||||
|
|
||||||
AREA_SPACE_OVERRIDE_COMBINE: This area adds its gravity/damp values to whatever has been calculated so far. This way, many overlapping areas can combine their physics to make interesting effects.
|
|
||||||
|
|
||||||
AREA_SPACE_OVERRIDE_COMBINE_REPLACE: This area adds its gravity/damp values to whatever has been calculated so far. Then stops taking into account the rest of the areas, even the default one.
|
|
||||||
|
|
||||||
AREA_SPACE_OVERRIDE_REPLACE: This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas.
|
|
||||||
|
|
||||||
AREA_SPACE_OVERRIDE_REPLACE_COMBINE: This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one.
|
|
||||||
|
|
||||||
.. _class_Area_set_use_reverb_bus:
|
|
||||||
|
|
||||||
- void **set_use_reverb_bus** **(** :ref:`bool<class_bool>` enable **)**
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
+18
-258
@@ -19,79 +19,23 @@ Brief Description
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_angular_damp<class_Area2D_get_angular_damp>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`get_collision_layer_bit<class_Area2D_get_collision_layer_bit>` **(** :ref:`int<class_int>` bit **)** const |
|
||||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`get_audio_bus_name<class_Area2D_get_audio_bus_name>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`get_collision_mask_bit<class_Area2D_get_collision_mask_bit>` **(** :ref:`int<class_int>` bit **)** const |
|
||||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_collision_layer<class_Area2D_get_collision_layer>` **(** **)** const |
|
| :ref:`Array<class_array>` | :ref:`get_overlapping_areas<class_Area2D_get_overlapping_areas>` **(** **)** const |
|
||||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`get_collision_layer_bit<class_Area2D_get_collision_layer_bit>` **(** :ref:`int<class_int>` bit **)** const |
|
| :ref:`Array<class_array>` | :ref:`get_overlapping_bodies<class_Area2D_get_overlapping_bodies>` **(** **)** const |
|
||||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_collision_mask<class_Area2D_get_collision_mask>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`overlaps_area<class_Area2D_overlaps_area>` **(** :ref:`Node<class_node>` area **)** const |
|
||||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`get_collision_mask_bit<class_Area2D_get_collision_mask_bit>` **(** :ref:`int<class_int>` bit **)** const |
|
| :ref:`bool<class_bool>` | :ref:`overlaps_body<class_Area2D_overlaps_body>` **(** :ref:`Node<class_node>` body **)** const |
|
||||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_gravity<class_Area2D_get_gravity>` **(** **)** const |
|
| void | :ref:`set_collision_layer_bit<class_Area2D_set_collision_layer_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
|
||||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_gravity_distance_scale<class_Area2D_get_gravity_distance_scale>` **(** **)** const |
|
| void | :ref:`set_collision_mask_bit<class_Area2D_set_collision_mask_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
|
||||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :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
|
Signals
|
||||||
-------
|
-------
|
||||||
@@ -222,69 +166,23 @@ Description
|
|||||||
Member Function Description
|
Member Function Description
|
||||||
---------------------------
|
---------------------------
|
||||||
|
|
||||||
.. _class_Area2D_get_angular_damp:
|
|
||||||
|
|
||||||
- :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
|
|
||||||
|
|
||||||
.. _class_Area2D_get_collision_layer:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_collision_layer** **(** **)** const
|
|
||||||
|
|
||||||
Return the physics layer this area is in.
|
|
||||||
|
|
||||||
.. _class_Area2D_get_collision_layer_bit:
|
.. _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.
|
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
|
|
||||||
|
|
||||||
Return the physics layers this area will scan to determine collisions.
|
|
||||||
|
|
||||||
.. _class_Area2D_get_collision_mask_bit:
|
.. _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.
|
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
|
|
||||||
|
|
||||||
Return the gravity intensity.
|
|
||||||
|
|
||||||
.. _class_Area2D_get_gravity_distance_scale:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_gravity_distance_scale** **(** **)** const
|
|
||||||
|
|
||||||
Return the falloff factor for point gravity.
|
|
||||||
|
|
||||||
.. _class_Area2D_get_gravity_vector:
|
|
||||||
|
|
||||||
- :ref:`Vector2<class_vector2>` **get_gravity_vector** **(** **)** const
|
|
||||||
|
|
||||||
Return the gravity vector. If gravity is a point (see :ref:`is_gravity_a_point<class_Area2D_is_gravity_a_point>`), this will be the attraction center.
|
|
||||||
|
|
||||||
.. _class_Area2D_get_linear_damp:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_linear_damp** **(** **)** const
|
|
||||||
|
|
||||||
Return the linear damp rate.
|
|
||||||
|
|
||||||
.. _class_Area2D_get_overlapping_areas:
|
.. _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 ``Area2D``s.
|
Returns a list of intersecting ``Area2D``\ s.
|
||||||
|
|
||||||
.. _class_Area2D_get_overlapping_bodies:
|
.. _class_Area2D_get_overlapping_bodies:
|
||||||
|
|
||||||
@@ -292,40 +190,6 @@ Returns a list of intersecting ``Area2D``s.
|
|||||||
|
|
||||||
Returns a list of intersecting :ref:`PhysicsBody2D<class_physicsbody2d>`\ s.
|
Returns a list of intersecting :ref:`PhysicsBody2D<class_physicsbody2d>`\ s.
|
||||||
|
|
||||||
.. _class_Area2D_get_priority:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_priority** **(** **)** const
|
|
||||||
|
|
||||||
Return the processing order of this area.
|
|
||||||
|
|
||||||
.. _class_Area2D_get_space_override_mode:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_space_override_mode** **(** **)** const
|
|
||||||
|
|
||||||
Return the space override mode.
|
|
||||||
|
|
||||||
.. _class_Area2D_is_gravity_a_point:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_gravity_a_point** **(** **)** const
|
|
||||||
|
|
||||||
Return whether gravity is a point. A point gravity will attract objects towards it, as opposed to a gravity vector, which moves them in a given direction.
|
|
||||||
|
|
||||||
.. _class_Area2D_is_monitorable:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_monitorable** **(** **)** const
|
|
||||||
|
|
||||||
Return whether this area can be detected by other, monitoring, areas.
|
|
||||||
|
|
||||||
.. _class_Area2D_is_monitoring:
|
|
||||||
|
|
||||||
- :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
|
|
||||||
|
|
||||||
.. _class_Area2D_overlaps_area:
|
.. _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
|
||||||
@@ -338,120 +202,16 @@ If ``true`` the given area overlaps the Area2D.
|
|||||||
|
|
||||||
If ``true`` the given body overlaps the Area2D.
|
If ``true`` the given body overlaps the Area2D.
|
||||||
|
|
||||||
.. _class_Area2D_set_angular_damp:
|
|
||||||
|
|
||||||
- void **set_angular_damp** **(** :ref:`float<class_float>` angular_damp **)**
|
|
||||||
|
|
||||||
Set the rate at which objects stop spinning in this area, if there are not any other forces making it spin. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops.
|
|
||||||
|
|
||||||
In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second.
|
|
||||||
|
|
||||||
.. _class_Area2D_set_audio_bus_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 **)**
|
|
||||||
|
|
||||||
.. _class_Area2D_set_collision_layer:
|
|
||||||
|
|
||||||
- void **set_collision_layer** **(** :ref:`int<class_int>` collision_layer **)**
|
|
||||||
|
|
||||||
Set the physics layers this area is in.
|
|
||||||
|
|
||||||
Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using :ref:`set_collision_mask<class_Area2D_set_collision_mask>`.
|
|
||||||
|
|
||||||
A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A.
|
|
||||||
|
|
||||||
.. _class_Area2D_set_collision_layer_bit:
|
.. _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.
|
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 **)**
|
|
||||||
|
|
||||||
Set the physics layers this area can scan for collisions.
|
|
||||||
|
|
||||||
.. _class_Area2D_set_collision_mask_bit:
|
.. _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.
|
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 **)**
|
|
||||||
|
|
||||||
Set the gravity intensity. This is useful to alter the force of gravity without altering its direction.
|
|
||||||
|
|
||||||
This value multiplies the gravity vector, whether it is the given vector (:ref:`set_gravity_vector<class_Area2D_set_gravity_vector>`), or a calculated one (when using a center of gravity).
|
|
||||||
|
|
||||||
.. _class_Area2D_set_gravity_distance_scale:
|
|
||||||
|
|
||||||
- void **set_gravity_distance_scale** **(** :ref:`float<class_float>` distance_scale **)**
|
|
||||||
|
|
||||||
Set the falloff factor for point gravity. The greater this value is, the faster the strength of gravity decreases with the square of distance.
|
|
||||||
|
|
||||||
.. _class_Area2D_set_gravity_is_point:
|
|
||||||
|
|
||||||
- void **set_gravity_is_point** **(** :ref:`bool<class_bool>` enable **)**
|
|
||||||
|
|
||||||
When overriding space parameters, this method sets whether this area has a center of gravity. To set/get the location of the center of gravity, use :ref:`set_gravity_vector<class_Area2D_set_gravity_vector>`/:ref:`get_gravity_vector<class_Area2D_get_gravity_vector>`.
|
|
||||||
|
|
||||||
.. _class_Area2D_set_gravity_vector:
|
|
||||||
|
|
||||||
- void **set_gravity_vector** **(** :ref:`Vector2<class_vector2>` vector **)**
|
|
||||||
|
|
||||||
Set the gravity vector. This vector does not have to be normalized.
|
|
||||||
|
|
||||||
If gravity is a point (see :ref:`is_gravity_a_point<class_Area2D_is_gravity_a_point>`), this will be the attraction center.
|
|
||||||
|
|
||||||
.. _class_Area2D_set_linear_damp:
|
|
||||||
|
|
||||||
- void **set_linear_damp** **(** :ref:`float<class_float>` linear_damp **)**
|
|
||||||
|
|
||||||
Set the rate at which objects stop moving in this area, if there are not any other forces moving it. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops.
|
|
||||||
|
|
||||||
In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second.
|
|
||||||
|
|
||||||
.. _class_Area2D_set_monitorable:
|
|
||||||
|
|
||||||
- void **set_monitorable** **(** :ref:`bool<class_bool>` enable **)**
|
|
||||||
|
|
||||||
Set whether this area can be detected by other, monitoring, areas. Only areas need to be marked as monitorable. Bodies are always so.
|
|
||||||
|
|
||||||
.. _class_Area2D_set_monitoring:
|
|
||||||
|
|
||||||
- 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 **)**
|
|
||||||
|
|
||||||
Set the order in which the area is processed. Greater values mean the area gets processed first. This is useful for areas which have a space override different from AREA_SPACE_OVERRIDE_DISABLED or AREA_SPACE_OVERRIDE_COMBINE, as they replace values, and are thus order-dependent.
|
|
||||||
|
|
||||||
Areas with the same priority value get evaluated in an unpredictable order, and should be differentiated if evaluation order is to be important.
|
|
||||||
|
|
||||||
.. _class_Area2D_set_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.
|
|
||||||
|
|
||||||
AREA_SPACE_OVERRIDE_DISABLED: This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them.
|
|
||||||
|
|
||||||
AREA_SPACE_OVERRIDE_COMBINE: This area adds its gravity/damp values to whatever has been calculated so far. This way, many overlapping areas can combine their physics to make interesting effects.
|
|
||||||
|
|
||||||
AREA_SPACE_OVERRIDE_COMBINE_REPLACE: This area adds its gravity/damp values to whatever has been calculated so far. Then stops taking into account the rest of the areas, even the default one.
|
|
||||||
|
|
||||||
AREA_SPACE_OVERRIDE_REPLACE: This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas.
|
|
||||||
|
|
||||||
AREA_SPACE_OVERRIDE_REPLACE_COMBINE: This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one.
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
+79
-63
@@ -17,69 +17,73 @@ Generic array datatype.
|
|||||||
Member Functions
|
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:`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:`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:`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:`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:`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:`PoolIntArray<class_poolintarray>` from **)** |
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`PoolByteArray<class_poolbytearray>` 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:`append<class_Array_append>` **(** var value **)** |
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| var | :ref:`back<class_Array_back>` **(** **)** |
|
| var | :ref:`back<class_Array_back>` **(** **)** |
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`clear<class_Array_clear>` **(** **)** |
|
| :ref:`int<class_int>` | :ref:`bsearch<class_Array_bsearch>` **(** var value, :ref:`bool<class_bool>` before=True **)** |
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`count<class_Array_count>` **(** var value **)** |
|
| :ref:`int<class_int>` | :ref:`bsearch_custom<class_Array_bsearch_custom>` **(** var value, :ref:`Object<class_object>` obj, :ref:`String<class_string>` func, :ref:`bool<class_bool>` before=True **)** |
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Array<class_array>` | :ref:`duplicate<class_Array_duplicate>` **(** **)** |
|
| void | :ref:`clear<class_Array_clear>` **(** **)** |
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`empty<class_Array_empty>` **(** **)** |
|
| :ref:`int<class_int>` | :ref:`count<class_Array_count>` **(** var value **)** |
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`erase<class_Array_erase>` **(** var value **)** |
|
| :ref:`Array<class_array>` | :ref:`duplicate<class_Array_duplicate>` **(** **)** |
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`find<class_Array_find>` **(** var what, :ref:`int<class_int>` from=0 **)** |
|
| :ref:`bool<class_bool>` | :ref:`empty<class_Array_empty>` **(** **)** |
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`find_last<class_Array_find_last>` **(** var value **)** |
|
| void | :ref:`erase<class_Array_erase>` **(** var value **)** |
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| var | :ref:`front<class_Array_front>` **(** **)** |
|
| :ref:`int<class_int>` | :ref:`find<class_Array_find>` **(** var what, :ref:`int<class_int>` from=0 **)** |
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`has<class_Array_has>` **(** var value **)** |
|
| :ref:`int<class_int>` | :ref:`find_last<class_Array_find_last>` **(** var value **)** |
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`hash<class_Array_hash>` **(** **)** |
|
| var | :ref:`front<class_Array_front>` **(** **)** |
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`insert<class_Array_insert>` **(** :ref:`int<class_int>` position, var value **)** |
|
| :ref:`bool<class_bool>` | :ref:`has<class_Array_has>` **(** var value **)** |
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`invert<class_Array_invert>` **(** **)** |
|
| :ref:`int<class_int>` | :ref:`hash<class_Array_hash>` **(** **)** |
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| var | :ref:`pop_back<class_Array_pop_back>` **(** **)** |
|
| void | :ref:`insert<class_Array_insert>` **(** :ref:`int<class_int>` position, var value **)** |
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| var | :ref:`pop_front<class_Array_pop_front>` **(** **)** |
|
| void | :ref:`invert<class_Array_invert>` **(** **)** |
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`push_back<class_Array_push_back>` **(** var value **)** |
|
| var | :ref:`pop_back<class_Array_pop_back>` **(** **)** |
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`push_front<class_Array_push_front>` **(** var value **)** |
|
| var | :ref:`pop_front<class_Array_pop_front>` **(** **)** |
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`remove<class_Array_remove>` **(** :ref:`int<class_int>` position **)** |
|
| void | :ref:`push_back<class_Array_push_back>` **(** var value **)** |
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`resize<class_Array_resize>` **(** :ref:`int<class_int>` size **)** |
|
| void | :ref:`push_front<class_Array_push_front>` **(** var value **)** |
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`rfind<class_Array_rfind>` **(** var what, :ref:`int<class_int>` from=-1 **)** |
|
| void | :ref:`remove<class_Array_remove>` **(** :ref:`int<class_int>` position **)** |
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`size<class_Array_size>` **(** **)** |
|
| void | :ref:`resize<class_Array_resize>` **(** :ref:`int<class_int>` size **)** |
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`sort<class_Array_sort>` **(** **)** |
|
| :ref:`int<class_int>` | :ref:`rfind<class_Array_rfind>` **(** var what, :ref:`int<class_int>` from=-1 **)** |
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`sort_custom<class_Array_sort_custom>` **(** :ref:`Object<class_object>` obj, :ref:`String<class_string>` func **)** |
|
| :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
|
Description
|
||||||
-----------
|
-----------
|
||||||
@@ -143,6 +147,18 @@ Append an element at the end of the array (alias of :ref:`push_back<class_Array_
|
|||||||
|
|
||||||
Returns the last element of the array if the array is not empty (size>0).
|
Returns the last element of the array if the array is not empty (size>0).
|
||||||
|
|
||||||
|
.. _class_Array_bsearch:
|
||||||
|
|
||||||
|
- :ref:`int<class_int>` **bsearch** **(** var value, :ref:`bool<class_bool>` before=True **)**
|
||||||
|
|
||||||
|
Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a before specifier can be passed. If false, the returned index comes after all existing entries of the value in the array. Note that calling bsearch on an unsorted array results in unexpected behavior.
|
||||||
|
|
||||||
|
.. _class_Array_bsearch_custom:
|
||||||
|
|
||||||
|
- :ref:`int<class_int>` **bsearch_custom** **(** var value, :ref:`Object<class_object>` obj, :ref:`String<class_string>` func, :ref:`bool<class_bool>` before=True **)**
|
||||||
|
|
||||||
|
Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search and a custom comparison method. Optionally, a before specifier can be passed. If false, the returned index comes after all existing entries of the value in the array. The custom method receives two arguments (an element from the array and the value searched for) and must return true if the first argument is less than the second, and return false otherwise. Note that calling bsearch on an unsorted array results in unexpected behavior.
|
||||||
|
|
||||||
.. _class_Array_clear:
|
.. _class_Array_clear:
|
||||||
|
|
||||||
- void **clear** **(** **)**
|
- void **clear** **(** **)**
|
||||||
|
|||||||
@@ -34,7 +34,7 @@ Member Functions
|
|||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`get_blend_shape_name<class_ArrayMesh_get_blend_shape_name>` **(** :ref:`int<class_int>` index **)** const |
|
| :ref:`String<class_string>` | :ref:`get_blend_shape_name<class_ArrayMesh_get_blend_shape_name>` **(** :ref:`int<class_int>` index **)** const |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Rect3<class_rect3>` | :ref:`get_custom_aabb<class_ArrayMesh_get_custom_aabb>` **(** **)** const |
|
| :ref:`AABB<class_aabb>` | :ref:`get_custom_aabb<class_ArrayMesh_get_custom_aabb>` **(** **)** const |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_surface_count<class_ArrayMesh_get_surface_count>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_surface_count<class_ArrayMesh_get_surface_count>` **(** **)** const |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -42,7 +42,7 @@ Member Functions
|
|||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_blend_shape_mode<class_ArrayMesh_set_blend_shape_mode>` **(** :ref:`int<class_int>` mode **)** |
|
| void | :ref:`set_blend_shape_mode<class_ArrayMesh_set_blend_shape_mode>` **(** :ref:`int<class_int>` mode **)** |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_custom_aabb<class_ArrayMesh_set_custom_aabb>` **(** :ref:`Rect3<class_rect3>` aabb **)** |
|
| void | :ref:`set_custom_aabb<class_ArrayMesh_set_custom_aabb>` **(** :ref:`AABB<class_aabb>` aabb **)** |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`surface_get_array_index_len<class_ArrayMesh_surface_get_array_index_len>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
| :ref:`int<class_int>` | :ref:`surface_get_array_index_len<class_ArrayMesh_surface_get_array_index_len>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -66,6 +66,8 @@ Member Functions
|
|||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`surface_set_name<class_ArrayMesh_surface_set_name>` **(** :ref:`int<class_int>` surf_idx, :ref:`String<class_string>` name **)** |
|
| void | :ref:`surface_set_name<class_ArrayMesh_surface_set_name>` **(** :ref:`int<class_int>` surf_idx, :ref:`String<class_string>` name **)** |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`surface_update_region<class_ArrayMesh_surface_update_region>` **(** :ref:`int<class_int>` surf_idx, :ref:`int<class_int>` offset, :ref:`PoolByteArray<class_poolbytearray>` data **)** |
|
||||||
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Numeric Constants
|
Numeric Constants
|
||||||
-----------------
|
-----------------
|
||||||
@@ -129,7 +131,7 @@ Surfaces are created to be rendered using a "primitive", which may be PRIMITIVE_
|
|||||||
|
|
||||||
.. _class_ArrayMesh_get_custom_aabb:
|
.. _class_ArrayMesh_get_custom_aabb:
|
||||||
|
|
||||||
- :ref:`Rect3<class_rect3>` **get_custom_aabb** **(** **)** const
|
- :ref:`AABB<class_aabb>` **get_custom_aabb** **(** **)** const
|
||||||
|
|
||||||
.. _class_ArrayMesh_get_surface_count:
|
.. _class_ArrayMesh_get_surface_count:
|
||||||
|
|
||||||
@@ -147,7 +149,7 @@ Return the amount of surfaces that the ``ArrayMesh`` holds.
|
|||||||
|
|
||||||
.. _class_ArrayMesh_set_custom_aabb:
|
.. _class_ArrayMesh_set_custom_aabb:
|
||||||
|
|
||||||
- void **set_custom_aabb** **(** :ref:`Rect3<class_rect3>` aabb **)**
|
- void **set_custom_aabb** **(** :ref:`AABB<class_aabb>` aabb **)**
|
||||||
|
|
||||||
.. _class_ArrayMesh_surface_get_array_index_len:
|
.. _class_ArrayMesh_surface_get_array_index_len:
|
||||||
|
|
||||||
@@ -207,4 +209,8 @@ Remove a surface at position surf_idx, shifting greater surfaces one surf_idx sl
|
|||||||
|
|
||||||
Set a :ref:`Material<class_material>` for a given surface. Surface will be rendered using this material.
|
Set a :ref:`Material<class_material>` for a given surface. Surface will be rendered using this material.
|
||||||
|
|
||||||
|
.. _class_ArrayMesh_surface_update_region:
|
||||||
|
|
||||||
|
- void **surface_update_region** **(** :ref:`int<class_int>` surf_idx, :ref:`int<class_int>` offset, :ref:`PoolByteArray<class_poolbytearray>` data **)**
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -19,19 +19,15 @@ Anchor point in AR Space
|
|||||||
Member Functions
|
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:`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:`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:`Plane<class_plane>` | :ref:`get_plane<class_ARVRAnchor_get_plane>` **(** **)** const |
|
| :ref:`Vector3<class_vector3>` | :ref:`get_size<class_ARVRAnchor_get_size>` **(** **)** 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
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
@@ -53,12 +49,6 @@ Keep in mind that as long as plane detection is enable the size, placing and ori
|
|||||||
Member Function Description
|
Member Function Description
|
||||||
---------------------------
|
---------------------------
|
||||||
|
|
||||||
.. _class_ARVRAnchor_get_anchor_id:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_anchor_id** **(** **)** const
|
|
||||||
|
|
||||||
Returns the anchor id for this anchor.
|
|
||||||
|
|
||||||
.. _class_ARVRAnchor_get_anchor_name:
|
.. _class_ARVRAnchor_get_anchor_name:
|
||||||
|
|
||||||
- :ref:`String<class_string>` **get_anchor_name** **(** **)** const
|
- :ref:`String<class_string>` **get_anchor_name** **(** **)** const
|
||||||
@@ -83,10 +73,4 @@ Returns a plane aligned with our anchor, handy for intersection testing
|
|||||||
|
|
||||||
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.
|
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 **)**
|
|
||||||
|
|
||||||
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,27 +19,19 @@ A spatial node representing a spatially tracked controller.
|
|||||||
Member Functions
|
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:`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:`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:`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:`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:`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 |
|
||||||
+------------------------------+------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_rumble<class_ARVRController_get_rumble>` **(** **)** 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 **)** |
|
|
||||||
+------------------------------+------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_rumble<class_ARVRController_set_rumble>` **(** :ref:`float<class_float>` rumble **)** |
|
|
||||||
+------------------------------+------------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Signals
|
Signals
|
||||||
-------
|
-------
|
||||||
@@ -81,12 +73,6 @@ The position of the controller node is automatically updated by the ARVR Server.
|
|||||||
Member Function Description
|
Member Function Description
|
||||||
---------------------------
|
---------------------------
|
||||||
|
|
||||||
.. _class_ARVRController_get_controller_id:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_controller_id** **(** **)** const
|
|
||||||
|
|
||||||
Returns the controller id currently assigned to this node.
|
|
||||||
|
|
||||||
.. _class_ARVRController_get_controller_name:
|
.. _class_ARVRController_get_controller_name:
|
||||||
|
|
||||||
- :ref:`String<class_string>` **get_controller_name** **(** **)** const
|
- :ref:`String<class_string>` **get_controller_name** **(** **)** const
|
||||||
@@ -117,24 +103,10 @@ Returns the value of the given axis for things like triggers, touchpads, etc. th
|
|||||||
|
|
||||||
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.
|
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_get_rumble:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_rumble** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_ARVRController_is_button_pressed:
|
.. _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?
|
Is the given button currently pressed?
|
||||||
|
|
||||||
.. _class_ARVRController_set_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.
|
|
||||||
|
|
||||||
.. _class_ARVRController_set_rumble:
|
|
||||||
|
|
||||||
- void **set_rumble** **(** :ref:`float<class_float>` rumble **)**
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -21,33 +21,21 @@ Base class for ARVR interface implementation.
|
|||||||
Member Functions
|
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:`int<class_int>` | :ref:`get_capabilities<class_ARVRInterface_get_capabilities>` **(** **)** const |
|
| :ref:`String<class_string>` | :ref:`get_name<class_ARVRInterface_get_name>` **(** **)** const |
|
||||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`get_name<class_ARVRInterface_get_name>` **(** **)** const |
|
| :ref:`Vector2<class_vector2>` | :ref:`get_render_targetsize<class_ARVRInterface_get_render_targetsize>` **(** **)** |
|
||||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------+
|
||||||
| :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:`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:`initialize<class_ARVRInterface_initialize>` **(** **)** |
|
| :ref:`bool<class_bool>` | :ref:`is_stereo<class_ARVRInterface_is_stereo>` **(** **)** |
|
||||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_initialized<class_ARVRInterface_is_initialized>` **(** **)** |
|
| void | :ref:`uninitialize<class_ARVRInterface_uninitialize>` **(** **)** |
|
||||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+---------------------------------------------------------------------------------------+
|
||||||
| :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
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
@@ -72,7 +60,7 @@ Numeric Constants
|
|||||||
- **ARVR_MONO** = **1** --- This interface can work with normal rendering output (non-HMD based AR).
|
- **ARVR_MONO** = **1** --- This interface can work with normal rendering output (non-HMD based AR).
|
||||||
- **ARVR_STEREO** = **2** --- This interface supports stereoscopic rendering.
|
- **ARVR_STEREO** = **2** --- This interface supports stereoscopic rendering.
|
||||||
- **ARVR_AR** = **4** --- This interface support AR (video background and real world tracking).
|
- **ARVR_AR** = **4** --- This interface support AR (video background and real world tracking).
|
||||||
- **ARVR_EXTERNAL** = **8** --- This interface outputs to an external device, if the main viewport is used the on screen output is an unmodified buffer of either the left or right eye (stretched if the viewport size is not changed to the same aspect ratio of get_recommended_render_targetsize. Using a seperate viewport node frees up the main viewport for other purposes.
|
- **ARVR_EXTERNAL** = **8** --- This interface outputs to an external device, if the main viewport is used the on screen output is an unmodified buffer of either the left or right eye (stretched if the viewport size is not changed to the same aspect ratio of get_render_targetsize. Using a seperate viewport node frees up the main viewport for other purposes.
|
||||||
- **EYE_MONO** = **0** --- Mono output, this is mostly used internally when retrieving positioning information for our camera node or when stereo scopic rendering is not supported.
|
- **EYE_MONO** = **0** --- Mono output, this is mostly used internally when retrieving positioning information for our camera node or when stereo scopic rendering is not supported.
|
||||||
- **EYE_LEFT** = **1** --- Left eye output, this is mostly used internally when rendering the image for the left eye and obtaining positioning and projection information.
|
- **EYE_LEFT** = **1** --- Left eye output, this is mostly used internally when rendering the image for the left eye and obtaining positioning and projection information.
|
||||||
- **EYE_RIGHT** = **2** --- Right eye output, this is mostly used internally when rendering the image for the right eye and obtaining positioning and projection information.
|
- **EYE_RIGHT** = **2** --- Right eye output, this is mostly used internally when rendering the image for the right eye and obtaining positioning and projection information.
|
||||||
@@ -92,12 +80,6 @@ Interfaces should be written in such a way that simply enabling them will give u
|
|||||||
Member Function Description
|
Member Function Description
|
||||||
---------------------------
|
---------------------------
|
||||||
|
|
||||||
.. _class_ARVRInterface_get_anchor_detection_is_enabled:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **get_anchor_detection_is_enabled** **(** **)** const
|
|
||||||
|
|
||||||
Returns true if achor detection is enabled (AR only).
|
|
||||||
|
|
||||||
.. _class_ARVRInterface_get_capabilities:
|
.. _class_ARVRInterface_get_capabilities:
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_capabilities** **(** **)** const
|
- :ref:`int<class_int>` **get_capabilities** **(** **)** const
|
||||||
@@ -110,9 +92,9 @@ Returns a combination of flags providing information about the capabilities of t
|
|||||||
|
|
||||||
Returns the name of this interface (OpenVR, OpenHMD, ARKit, etc).
|
Returns the name of this interface (OpenVR, OpenHMD, ARKit, etc).
|
||||||
|
|
||||||
.. _class_ARVRInterface_get_recommended_render_targetsize:
|
.. _class_ARVRInterface_get_render_targetsize:
|
||||||
|
|
||||||
- :ref:`Vector2<class_vector2>` **get_recommended_render_targetsize** **(** **)**
|
- :ref:`Vector2<class_vector2>` **get_render_targetsize** **(** **)**
|
||||||
|
|
||||||
Returns the resolution at which we should render our intermediate results before things like lens distortion are applied by the VR platform.
|
Returns the resolution at which we should render our intermediate results before things like lens distortion are applied by the VR platform.
|
||||||
|
|
||||||
@@ -136,42 +118,12 @@ If you do this for a platform that handles its own output (such as OpenVR) Godot
|
|||||||
|
|
||||||
While currently not used you can activate additional interfaces, you may wish to do this if you want to track controllers from other platforms. However at this point in time only one interface can render to an HMD.
|
While currently not used you can activate additional interfaces, you may wish to do this if you want to track controllers from other platforms. However at this point in time only one interface can render to an HMD.
|
||||||
|
|
||||||
.. _class_ARVRInterface_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** **(** **)**
|
|
||||||
|
|
||||||
Returns true if this interface is currently the primary interface (the interface responsible for showing the output).
|
|
||||||
|
|
||||||
.. _class_ARVRInterface_is_stereo:
|
.. _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.
|
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 **)**
|
|
||||||
|
|
||||||
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 **)**
|
|
||||||
|
|
||||||
Initialize/uninitialize this interface (same effect as calling initialize/uninitialize).
|
|
||||||
|
|
||||||
.. _class_ARVRInterface_set_is_primary:
|
|
||||||
|
|
||||||
- void **set_is_primary** **(** :ref:`bool<class_bool>` enable **)**
|
|
||||||
|
|
||||||
Set this interface to the primary interface (unset the old one).
|
|
||||||
|
|
||||||
.. _class_ARVRInterface_uninitialize:
|
.. _class_ARVRInterface_uninitialize:
|
||||||
|
|
||||||
- void **uninitialize** **(** **)**
|
- void **uninitialize** **(** **)**
|
||||||
|
|||||||
@@ -16,15 +16,6 @@ Brief Description
|
|||||||
|
|
||||||
Our origin point in AR/VR.
|
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 **)** |
|
|
||||||
+----------------------------+------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -46,23 +37,3 @@ It is the position of this node that you update when you're character needs to m
|
|||||||
|
|
||||||
So say that your character is driving a car, the ARVROrigin node should be a child node of this car. If you implement a teleport system to move your character, you change the position of this node. Etc.
|
So say that your character is driving a car, the ARVROrigin node should be a child node of this car. If you implement a teleport system to move your character, you change the position of this node. Etc.
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_ARVROrigin_get_world_scale:
|
|
||||||
|
|
||||||
- :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 **)**
|
|
||||||
|
|
||||||
Changes the world scaling factor.
|
|
||||||
|
|
||||||
Most AR/VR platforms will assume a unit size of 1 unit in your game world = 1 meter in the real world. This scale allows you to adjust this to the unit system you use in your game.
|
|
||||||
|
|
||||||
Note that this method is a passthrough to the ARVRServer itself.
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -30,8 +30,6 @@ Member Functions
|
|||||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector3<class_vector3>` | :ref:`get_position<class_ARVRPositionalTracker_get_position>` **(** **)** const |
|
| :ref:`Vector3<class_vector3>` | :ref:`get_position<class_ARVRPositionalTracker_get_position>` **(** **)** const |
|
||||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_rumble<class_ARVRPositionalTracker_get_rumble>` **(** **)** const |
|
|
||||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`bool<class_bool>` | :ref:`get_tracks_orientation<class_ARVRPositionalTracker_get_tracks_orientation>` **(** **)** 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:`bool<class_bool>` | :ref:`get_tracks_position<class_ARVRPositionalTracker_get_tracks_position>` **(** **)** const |
|
||||||
@@ -40,8 +38,6 @@ Member Functions
|
|||||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_type<class_ARVRPositionalTracker_get_type>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_type<class_ARVRPositionalTracker_get_type>` **(** **)** const |
|
||||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_rumble<class_ARVRPositionalTracker_set_rumble>` **(** :ref:`float<class_float>` rumble **)** |
|
|
||||||
+------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
@@ -100,10 +96,6 @@ Returns the orientation matrix of the controller.
|
|||||||
|
|
||||||
Returns the position of the controller adjusted by world scale.
|
Returns the position of the controller adjusted by world scale.
|
||||||
|
|
||||||
.. _class_ARVRPositionalTracker_get_rumble:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_rumble** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_ARVRPositionalTracker_get_tracks_orientation:
|
.. _class_ARVRPositionalTracker_get_tracks_orientation:
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **get_tracks_orientation** **(** **)** const
|
- :ref:`bool<class_bool>` **get_tracks_orientation** **(** **)** const
|
||||||
@@ -128,8 +120,4 @@ Returns the transform combining the orientation and position of this device.
|
|||||||
|
|
||||||
Type of tracker.
|
Type of tracker.
|
||||||
|
|
||||||
.. _class_ARVRPositionalTracker_set_rumble:
|
|
||||||
|
|
||||||
- void **set_rumble** **(** :ref:`float<class_float>` rumble **)**
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -19,8 +19,6 @@ This is our AR/VR Server.
|
|||||||
Member Functions
|
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 **)** |
|
| void | :ref:`center_on_hmd<class_ARVRServer_center_on_hmd>` **(** :ref:`bool<class_bool>` ignore_tilt, :ref:`bool<class_bool>` keep_height **)** |
|
||||||
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -30,20 +28,16 @@ Member Functions
|
|||||||
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_interface_count<class_ARVRServer_get_interface_count>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_interface_count<class_ARVRServer_get_interface_count>` **(** **)** const |
|
||||||
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`Array<class_array>` | :ref:`get_interfaces<class_ARVRServer_get_interfaces>` **(** **)** const |
|
||||||
|
+------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Transform<class_transform>` | :ref:`get_reference_frame<class_ARVRServer_get_reference_frame>` **(** **)** 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:`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:`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_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
|
Signals
|
||||||
-------
|
-------
|
||||||
@@ -99,12 +93,6 @@ The AR/VR Server is the heart of our AR/VR solution and handles all the processi
|
|||||||
Member Function Description
|
Member Function Description
|
||||||
---------------------------
|
---------------------------
|
||||||
|
|
||||||
.. _class_ARVRServer_add_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:
|
.. _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 **)**
|
||||||
@@ -139,6 +127,12 @@ Get the interface registered at a given index in our list of interfaces.
|
|||||||
|
|
||||||
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.
|
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_interfaces:
|
||||||
|
|
||||||
|
- :ref:`Array<class_array>` **get_interfaces** **(** **)** const
|
||||||
|
|
||||||
|
Returns a list of available interfaces with both id and name of the interface.
|
||||||
|
|
||||||
.. _class_ARVRServer_get_reference_frame:
|
.. _class_ARVRServer_get_reference_frame:
|
||||||
|
|
||||||
- :ref:`Transform<class_transform>` **get_reference_frame** **(** **)** const
|
- :ref:`Transform<class_transform>` **get_reference_frame** **(** **)** const
|
||||||
@@ -157,28 +151,10 @@ Get the positional tracker at the given ID.
|
|||||||
|
|
||||||
Get the number of trackers currently registered.
|
Get the number of trackers currently registered.
|
||||||
|
|
||||||
.. _class_ARVRServer_get_world_scale:
|
|
||||||
|
|
||||||
- :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 **)**
|
|
||||||
|
|
||||||
Removes a registered interface, again exposed mostly for GDNative based interfaces.
|
|
||||||
|
|
||||||
.. _class_ARVRServer_set_primary_interface:
|
.. _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.
|
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 **)**
|
|
||||||
|
|
||||||
Changing the world scale, see the ARVROrigin documentation for more information.
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -16,27 +16,6 @@ Brief Description
|
|||||||
|
|
||||||
Packs multiple small textures in a single, bigger one. Helps to optimize video memory costs and render calls.
|
Packs multiple small textures in a single, bigger one. Helps to optimize video memory costs and render calls.
|
||||||
|
|
||||||
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 |
|
|
||||||
+--------------------------------+-------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`bool<class_bool>` | :ref:`has_filter_clip<class_AtlasTexture_has_filter_clip>` **(** **)** const |
|
|
||||||
+--------------------------------+-------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_atlas<class_AtlasTexture_set_atlas>` **(** :ref:`Texture<class_texture>` atlas **)** |
|
|
||||||
+--------------------------------+-------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_filter_clip<class_AtlasTexture_set_filter_clip>` **(** :ref:`bool<class_bool>` enable **)** |
|
|
||||||
+--------------------------------+-------------------------------------------------------------------------------------------------------+
|
|
||||||
| 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
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -64,39 +43,3 @@ Description
|
|||||||
|
|
||||||
and a region that defines the actual area of the AtlasTexture.
|
and a region that defines the actual area of the AtlasTexture.
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_AtlasTexture_get_atlas:
|
|
||||||
|
|
||||||
- :ref:`Texture<class_texture>` **get_atlas** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AtlasTexture_get_margin:
|
|
||||||
|
|
||||||
- :ref:`Rect2<class_rect2>` **get_margin** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AtlasTexture_get_region:
|
|
||||||
|
|
||||||
- :ref:`Rect2<class_rect2>` **get_region** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AtlasTexture_has_filter_clip:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **has_filter_clip** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AtlasTexture_set_atlas:
|
|
||||||
|
|
||||||
- void **set_atlas** **(** :ref:`Texture<class_texture>` atlas **)**
|
|
||||||
|
|
||||||
.. _class_AtlasTexture_set_filter_clip:
|
|
||||||
|
|
||||||
- void **set_filter_clip** **(** :ref:`bool<class_bool>` enable **)**
|
|
||||||
|
|
||||||
.. _class_AtlasTexture_set_margin:
|
|
||||||
|
|
||||||
- void **set_margin** **(** :ref:`Rect2<class_rect2>` margin **)**
|
|
||||||
|
|
||||||
.. _class_AtlasTexture_set_region:
|
|
||||||
|
|
||||||
- void **set_region** **(** :ref:`Rect2<class_rect2>` region **)**
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -18,15 +18,6 @@ Adds a Amplify audio effect to an Audio bus.
|
|||||||
|
|
||||||
Increases or decreases the volume of the selected audio bus.
|
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 **)** |
|
|
||||||
+----------------------------+-----------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -40,15 +31,3 @@ Description
|
|||||||
|
|
||||||
Increases or decreases the volume being routed through the audio bus.
|
Increases or decreases the volume being routed through the audio bus.
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_AudioEffectAmplify_get_volume_db:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_volume_db** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectAmplify_set_volume_db:
|
|
||||||
|
|
||||||
- void **set_volume_db** **(** :ref:`float<class_float>` volume **)**
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -16,47 +16,6 @@ Brief Description
|
|||||||
|
|
||||||
Adds a chorus audio effect.
|
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 **)** |
|
|
||||||
+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -174,115 +133,3 @@ Description
|
|||||||
|
|
||||||
Adds a chorus audio effect. The effect applies a filter with voices to duplicate the audio source and manipulate it through the filter.
|
Adds a chorus audio effect. The effect applies a filter with voices to duplicate the audio source and manipulate it through the filter.
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_AudioEffectChorus_get_dry:
|
|
||||||
|
|
||||||
- :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
|
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
Returns the voice filter's set rate in cycles.
|
|
||||||
|
|
||||||
.. _class_AudioEffectChorus_get_wet:
|
|
||||||
|
|
||||||
- :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 **)**
|
|
||||||
|
|
||||||
Returns the set applied dryness of the effect.
|
|
||||||
|
|
||||||
.. _class_AudioEffectChorus_set_voice_count:
|
|
||||||
|
|
||||||
- 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 **)**
|
|
||||||
|
|
||||||
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 **)**
|
|
||||||
|
|
||||||
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 **)**
|
|
||||||
|
|
||||||
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 **)**
|
|
||||||
|
|
||||||
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 **)**
|
|
||||||
|
|
||||||
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 **)**
|
|
||||||
|
|
||||||
Set the voice filter's rate.
|
|
||||||
|
|
||||||
.. _class_AudioEffectChorus_set_wet:
|
|
||||||
|
|
||||||
- void **set_wet** **(** :ref:`float<class_float>` amount **)**
|
|
||||||
|
|
||||||
Set the amount of effect.
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -18,39 +18,6 @@ Adds a Compressor audio effect to an Audio bus.
|
|||||||
|
|
||||||
Reduces sounds that exceed a certain threshold level, smooths out the dynamics and increases the overall volume.
|
Reduces sounds that exceed a certain threshold level, smooths out the dynamics and increases the overall volume.
|
||||||
|
|
||||||
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 **)** |
|
|
||||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -98,63 +65,3 @@ Compressor has many uses in the mix:
|
|||||||
|
|
||||||
- Accentuates transients by using a wider attack, making effects sound more punchy.
|
- Accentuates transients by using a wider attack, making effects sound more punchy.
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_AudioEffectCompressor_get_attack_us:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_attack_us** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectCompressor_get_gain:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_gain** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectCompressor_get_mix:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_mix** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectCompressor_get_ratio:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_ratio** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectCompressor_get_release_ms:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_release_ms** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectCompressor_get_sidechain:
|
|
||||||
|
|
||||||
- :ref:`String<class_string>` **get_sidechain** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectCompressor_get_threshold:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_threshold** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectCompressor_set_attack_us:
|
|
||||||
|
|
||||||
- void **set_attack_us** **(** :ref:`float<class_float>` attack_us **)**
|
|
||||||
|
|
||||||
.. _class_AudioEffectCompressor_set_gain:
|
|
||||||
|
|
||||||
- void **set_gain** **(** :ref:`float<class_float>` gain **)**
|
|
||||||
|
|
||||||
.. _class_AudioEffectCompressor_set_mix:
|
|
||||||
|
|
||||||
- void **set_mix** **(** :ref:`float<class_float>` mix **)**
|
|
||||||
|
|
||||||
.. _class_AudioEffectCompressor_set_ratio:
|
|
||||||
|
|
||||||
- void **set_ratio** **(** :ref:`float<class_float>` ratio **)**
|
|
||||||
|
|
||||||
.. _class_AudioEffectCompressor_set_release_ms:
|
|
||||||
|
|
||||||
- void **set_release_ms** **(** :ref:`float<class_float>` release_ms **)**
|
|
||||||
|
|
||||||
.. _class_AudioEffectCompressor_set_sidechain:
|
|
||||||
|
|
||||||
- void **set_sidechain** **(** :ref:`String<class_string>` sidechain **)**
|
|
||||||
|
|
||||||
.. _class_AudioEffectCompressor_set_threshold:
|
|
||||||
|
|
||||||
- void **set_threshold** **(** :ref:`float<class_float>` threshold **)**
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -18,63 +18,6 @@ Adds a Delay audio effect to an Audio bus. Plays input signal back after a perio
|
|||||||
|
|
||||||
Two tap delay and feedback options.
|
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 **)** |
|
|
||||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -136,111 +79,3 @@ Description
|
|||||||
|
|
||||||
Plays input signal back after a period of time. The delayed signal may be played back multiple times to create the sound of a repeating, decaying echo. Delay effects range from a subtle echo effect to a pronounced blending of previous sounds with new sounds.
|
Plays input signal back after a period of time. The delayed signal may be played back multiple times to create the sound of a repeating, decaying echo. Delay effects range from a subtle echo effect to a pronounced blending of previous sounds with new sounds.
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_AudioEffectDelay_get_dry:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_dry** **(** **)**
|
|
||||||
|
|
||||||
.. _class_AudioEffectDelay_get_feedback_delay_ms:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_feedback_delay_ms** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectDelay_get_feedback_level_db:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_feedback_level_db** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectDelay_get_feedback_lowpass:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_feedback_lowpass** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectDelay_get_tap1_delay_ms:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_tap1_delay_ms** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectDelay_get_tap1_level_db:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_tap1_level_db** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectDelay_get_tap1_pan:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_tap1_pan** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectDelay_get_tap2_delay_ms:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_tap2_delay_ms** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectDelay_get_tap2_level_db:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_tap2_level_db** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectDelay_get_tap2_pan:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_tap2_pan** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectDelay_is_feedback_active:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_feedback_active** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectDelay_is_tap1_active:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_tap1_active** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectDelay_is_tap2_active:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_tap2_active** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectDelay_set_dry:
|
|
||||||
|
|
||||||
- void **set_dry** **(** :ref:`float<class_float>` amount **)**
|
|
||||||
|
|
||||||
.. _class_AudioEffectDelay_set_feedback_active:
|
|
||||||
|
|
||||||
- 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 **)**
|
|
||||||
|
|
||||||
.. _class_AudioEffectDelay_set_feedback_level_db:
|
|
||||||
|
|
||||||
- void **set_feedback_level_db** **(** :ref:`float<class_float>` amount **)**
|
|
||||||
|
|
||||||
.. _class_AudioEffectDelay_set_feedback_lowpass:
|
|
||||||
|
|
||||||
- void **set_feedback_lowpass** **(** :ref:`float<class_float>` amount **)**
|
|
||||||
|
|
||||||
.. _class_AudioEffectDelay_set_tap1_active:
|
|
||||||
|
|
||||||
- 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 **)**
|
|
||||||
|
|
||||||
.. _class_AudioEffectDelay_set_tap1_level_db:
|
|
||||||
|
|
||||||
- void **set_tap1_level_db** **(** :ref:`float<class_float>` amount **)**
|
|
||||||
|
|
||||||
.. _class_AudioEffectDelay_set_tap1_pan:
|
|
||||||
|
|
||||||
- void **set_tap1_pan** **(** :ref:`float<class_float>` amount **)**
|
|
||||||
|
|
||||||
.. _class_AudioEffectDelay_set_tap2_active:
|
|
||||||
|
|
||||||
- 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 **)**
|
|
||||||
|
|
||||||
.. _class_AudioEffectDelay_set_tap2_level_db:
|
|
||||||
|
|
||||||
- void **set_tap2_level_db** **(** :ref:`float<class_float>` amount **)**
|
|
||||||
|
|
||||||
.. _class_AudioEffectDelay_set_tap2_pan:
|
|
||||||
|
|
||||||
- void **set_tap2_pan** **(** :ref:`float<class_float>` amount **)**
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -18,31 +18,6 @@ Adds a Distortion audio effect to an Audio bus.
|
|||||||
|
|
||||||
Modify the sound to make it dirty.
|
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 **)** |
|
|
||||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -83,47 +58,3 @@ Modify the sound and make it dirty. Different types are available : clip, tan, l
|
|||||||
|
|
||||||
By distorting the waveform the frequency content change, which will often make the sound "crunchy" or "abrasive". For games, it can simulate sound coming from some saturated device or speaker very efficiently.
|
By distorting the waveform the frequency content change, which will often make the sound "crunchy" or "abrasive". For games, it can simulate sound coming from some saturated device or speaker very efficiently.
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_AudioEffectDistortion_get_drive:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_drive** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectDistortion_get_keep_hf_hz:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_keep_hf_hz** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectDistortion_get_mode:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_mode** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectDistortion_get_post_gain:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_post_gain** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectDistortion_get_pre_gain:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_pre_gain** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectDistortion_set_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 **)**
|
|
||||||
|
|
||||||
.. _class_AudioEffectDistortion_set_mode:
|
|
||||||
|
|
||||||
- void **set_mode** **(** :ref:`int<class_int>` mode **)**
|
|
||||||
|
|
||||||
.. _class_AudioEffectDistortion_set_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 **)**
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -18,27 +18,6 @@ Brief Description
|
|||||||
|
|
||||||
Adds a filter to the Audio Bus.
|
Adds a filter to the Audio Bus.
|
||||||
|
|
||||||
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 **)** |
|
|
||||||
+----------------------------+----------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -72,39 +51,3 @@ Description
|
|||||||
|
|
||||||
Allows frequencies other than the :ref:`cutoff_hz<class_AudioEffectFilter_cutoff_hz>` to pass.
|
Allows frequencies other than the :ref:`cutoff_hz<class_AudioEffectFilter_cutoff_hz>` to pass.
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_AudioEffectFilter_get_cutoff:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_cutoff** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectFilter_get_db:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_db** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectFilter_get_gain:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_gain** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectFilter_get_resonance:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_resonance** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectFilter_set_cutoff:
|
|
||||||
|
|
||||||
- void **set_cutoff** **(** :ref:`float<class_float>` freq **)**
|
|
||||||
|
|
||||||
.. _class_AudioEffectFilter_set_db:
|
|
||||||
|
|
||||||
- void **set_db** **(** :ref:`int<class_int>` amount **)**
|
|
||||||
|
|
||||||
.. _class_AudioEffectFilter_set_gain:
|
|
||||||
|
|
||||||
- void **set_gain** **(** :ref:`float<class_float>` amount **)**
|
|
||||||
|
|
||||||
.. _class_AudioEffectFilter_set_resonance:
|
|
||||||
|
|
||||||
- void **set_resonance** **(** :ref:`float<class_float>` amount **)**
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -16,27 +16,6 @@ Brief Description
|
|||||||
|
|
||||||
Adds a soft clip Limiter audio effect to an Audio bus.
|
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 **)** |
|
|
||||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -64,39 +43,3 @@ A limiter is similar to a compressor, but it’s less flexible and designed to d
|
|||||||
|
|
||||||
Soft clipping starts to reduce the peaks a little below the threshold level and progressively increases its effect as the input level increases such that the threshold is never exceeded.
|
Soft clipping starts to reduce the peaks a little below the threshold level and progressively increases its effect as the input level increases such that the threshold is never exceeded.
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_AudioEffectLimiter_get_ceiling_db:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_ceiling_db** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectLimiter_get_soft_clip_db:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_soft_clip_db** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectLimiter_get_soft_clip_ratio:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_soft_clip_ratio** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectLimiter_get_threshold_db:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_threshold_db** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectLimiter_set_ceiling_db:
|
|
||||||
|
|
||||||
- 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 **)**
|
|
||||||
|
|
||||||
.. _class_AudioEffectLimiter_set_soft_clip_ratio:
|
|
||||||
|
|
||||||
- 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 **)**
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -16,15 +16,6 @@ Brief Description
|
|||||||
|
|
||||||
Adds a Panner audio effect to an Audio bus. Pans sound left or right.
|
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 **)** |
|
|
||||||
+----------------------------+-----------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -38,15 +29,3 @@ Description
|
|||||||
|
|
||||||
Determines how much of an audio signal is sent to the left and right buses.
|
Determines how much of an audio signal is sent to the left and right buses.
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_AudioEffectPanner_get_pan:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_pan** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectPanner_set_pan:
|
|
||||||
|
|
||||||
- void **set_pan** **(** :ref:`float<class_float>` cpanume **)**
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -18,31 +18,6 @@ Adds a Phaser audio effect to an Audio bus.
|
|||||||
|
|
||||||
Combines the original signal with a copy that is slightly out of phase with the original.
|
Combines the original signal with a copy that is slightly out of phase with the original.
|
||||||
|
|
||||||
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 **)** |
|
|
||||||
+----------------------------+------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -72,47 +47,3 @@ Description
|
|||||||
|
|
||||||
Combines phase-shifted signals with the original signal. The movement of the phase-shifted signals is controlled using a Low Frequency Oscillator.
|
Combines phase-shifted signals with the original signal. The movement of the phase-shifted signals is controlled using a Low Frequency Oscillator.
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_AudioEffectPhaser_get_depth:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_depth** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectPhaser_get_feedback:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_feedback** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectPhaser_get_range_max_hz:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_range_max_hz** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectPhaser_get_range_min_hz:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_range_min_hz** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectPhaser_get_rate_hz:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_rate_hz** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectPhaser_set_depth:
|
|
||||||
|
|
||||||
- void **set_depth** **(** :ref:`float<class_float>` depth **)**
|
|
||||||
|
|
||||||
.. _class_AudioEffectPhaser_set_feedback:
|
|
||||||
|
|
||||||
- void **set_feedback** **(** :ref:`float<class_float>` fbk **)**
|
|
||||||
|
|
||||||
.. _class_AudioEffectPhaser_set_range_max_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 **)**
|
|
||||||
|
|
||||||
.. _class_AudioEffectPhaser_set_rate_hz:
|
|
||||||
|
|
||||||
- void **set_rate_hz** **(** :ref:`float<class_float>` hz **)**
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -18,15 +18,6 @@ Adds a Pitch shift audio effect to an Audio bus.
|
|||||||
|
|
||||||
Raises or lowers the pitch of original sound.
|
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 **)** |
|
|
||||||
+----------------------------+----------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -40,15 +31,3 @@ Description
|
|||||||
|
|
||||||
Allows modulation of pitch independently of tempo. All frequencies can be increased/decreased with minimal effect on transients.
|
Allows modulation of pitch independently of tempo. All frequencies can be increased/decreased with minimal effect on transients.
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_AudioEffectPitchShift_get_pitch_scale:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_pitch_scale** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectPitchShift_set_pitch_scale:
|
|
||||||
|
|
||||||
- void **set_pitch_scale** **(** :ref:`float<class_float>` rate **)**
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -21,39 +21,11 @@ Simulates the sound of acoustic environments such as rooms, concert halls, caver
|
|||||||
Member Functions
|
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_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_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
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
@@ -99,68 +71,12 @@ Simulates rooms of different sizes. Its parameters can be adjusted to simulate t
|
|||||||
Member Function Description
|
Member Function Description
|
||||||
---------------------------
|
---------------------------
|
||||||
|
|
||||||
.. _class_AudioEffectReverb_get_damping:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_damping** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectReverb_get_dry:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_dry** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectReverb_get_hpf:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_hpf** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectReverb_get_predelay_feedback:
|
.. _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
|
|
||||||
|
|
||||||
.. _class_AudioEffectReverb_get_room_size:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_room_size** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectReverb_get_spread:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_spread** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectReverb_get_wet:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_wet** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectReverb_set_damping:
|
|
||||||
|
|
||||||
- void **set_damping** **(** :ref:`float<class_float>` amount **)**
|
|
||||||
|
|
||||||
.. _class_AudioEffectReverb_set_dry:
|
|
||||||
|
|
||||||
- void **set_dry** **(** :ref:`float<class_float>` amount **)**
|
|
||||||
|
|
||||||
.. _class_AudioEffectReverb_set_hpf:
|
|
||||||
|
|
||||||
- void **set_hpf** **(** :ref:`float<class_float>` amount **)**
|
|
||||||
|
|
||||||
.. _class_AudioEffectReverb_set_predelay_feedback:
|
.. _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 **)**
|
|
||||||
|
|
||||||
.. _class_AudioEffectReverb_set_room_size:
|
|
||||||
|
|
||||||
- void **set_room_size** **(** :ref:`float<class_float>` size **)**
|
|
||||||
|
|
||||||
.. _class_AudioEffectReverb_set_spread:
|
|
||||||
|
|
||||||
- void **set_spread** **(** :ref:`float<class_float>` amount **)**
|
|
||||||
|
|
||||||
.. _class_AudioEffectReverb_set_wet:
|
|
||||||
|
|
||||||
- void **set_wet** **(** :ref:`float<class_float>` amount **)**
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -16,23 +16,6 @@ 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 **)** |
|
|
||||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -49,31 +32,3 @@ Member Variables
|
|||||||
- :ref:`float<class_float>` **time_pullout_ms**
|
- :ref:`float<class_float>` **time_pullout_ms**
|
||||||
|
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_AudioEffectStereoEnhance_get_pan_pullout:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_pan_pullout** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectStereoEnhance_get_surround:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_surround** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectStereoEnhance_get_time_pullout:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_time_pullout** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioEffectStereoEnhance_set_pan_pullout:
|
|
||||||
|
|
||||||
- void **set_pan_pullout** **(** :ref:`float<class_float>` amount **)**
|
|
||||||
|
|
||||||
.. _class_AudioEffectStereoEnhance_set_surround:
|
|
||||||
|
|
||||||
- void **set_surround** **(** :ref:`float<class_float>` amount **)**
|
|
||||||
|
|
||||||
.. _class_AudioEffectStereoEnhance_set_time_pullout:
|
|
||||||
|
|
||||||
- void **set_time_pullout** **(** :ref:`float<class_float>` amount **)**
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -284,7 +284,7 @@ Sets the name of the bus at index ``bus_idx`` to ``name``.
|
|||||||
|
|
||||||
- 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].
|
Connects the output of the bus at ``bus_idx`` to the bus named ``send``.
|
||||||
|
|
||||||
.. _class_AudioServer_set_bus_solo:
|
.. _class_AudioServer_set_bus_solo:
|
||||||
|
|
||||||
|
|||||||
@@ -16,23 +16,6 @@ Brief Description
|
|||||||
|
|
||||||
OGG Vorbis audio stream driver.
|
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 **)** |
|
|
||||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -54,31 +37,3 @@ Description
|
|||||||
|
|
||||||
OGG Vorbis audio stream driver.
|
OGG Vorbis audio stream driver.
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_AudioStreamOGGVorbis_get_data:
|
|
||||||
|
|
||||||
- :ref:`PoolByteArray<class_poolbytearray>` **get_data** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioStreamOGGVorbis_get_loop_offset:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_loop_offset** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioStreamOGGVorbis_has_loop:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **has_loop** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioStreamOGGVorbis_set_data:
|
|
||||||
|
|
||||||
- void **set_data** **(** :ref:`PoolByteArray<class_poolbytearray>` data **)**
|
|
||||||
|
|
||||||
.. _class_AudioStreamOGGVorbis_set_loop:
|
|
||||||
|
|
||||||
- void **set_loop** **(** :ref:`bool<class_bool>` enable **)**
|
|
||||||
|
|
||||||
.. _class_AudioStreamOGGVorbis_set_loop_offset:
|
|
||||||
|
|
||||||
- void **set_loop_offset** **(** :ref:`float<class_float>` seconds **)**
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -19,37 +19,15 @@ Plays back audio.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+----------------------------------------+----------------------------------------------------------------------------------------------------------------+
|
+----------------------------+---------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`get_bus<class_AudioStreamPlayer_get_bus>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_playback_position<class_AudioStreamPlayer_get_playback_position>` **(** **)** |
|
||||||
+----------------------------------------+----------------------------------------------------------------------------------------------------------------+
|
+----------------------------+---------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_mix_target<class_AudioStreamPlayer_get_mix_target>` **(** **)** const |
|
| void | :ref:`play<class_AudioStreamPlayer_play>` **(** :ref:`float<class_float>` from_position=0.0 **)** |
|
||||||
+----------------------------------------+----------------------------------------------------------------------------------------------------------------+
|
+----------------------------+---------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_playback_position<class_AudioStreamPlayer_get_playback_position>` **(** **)** |
|
| void | :ref:`seek<class_AudioStreamPlayer_seek>` **(** :ref:`float<class_float>` to_position **)** |
|
||||||
+----------------------------------------+----------------------------------------------------------------------------------------------------------------+
|
+----------------------------+---------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`AudioStream<class_audiostream>` | :ref:`get_stream<class_AudioStreamPlayer_get_stream>` **(** **)** const |
|
| void | :ref:`stop<class_AudioStreamPlayer_stop>` **(** **)** |
|
||||||
+----------------------------------------+----------------------------------------------------------------------------------------------------------------+
|
+----------------------------+---------------------------------------------------------------------------------------------------+
|
||||||
| :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
|
Signals
|
||||||
-------
|
-------
|
||||||
@@ -104,36 +82,12 @@ Plays background audio.
|
|||||||
Member Function Description
|
Member Function Description
|
||||||
---------------------------
|
---------------------------
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer_get_bus:
|
|
||||||
|
|
||||||
- :ref:`String<class_string>` **get_bus** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer_get_mix_target:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_mix_target** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer_get_playback_position:
|
.. _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>`.
|
Returns the position in the :ref:`AudioStream<class_audiostream>`.
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer_get_stream:
|
|
||||||
|
|
||||||
- :ref:`AudioStream<class_audiostream>` **get_stream** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer_get_volume_db:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_volume_db** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer_is_autoplay_enabled:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_autoplay_enabled** **(** **)**
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer_is_playing:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_playing** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer_play:
|
.. _class_AudioStreamPlayer_play:
|
||||||
|
|
||||||
- void **play** **(** :ref:`float<class_float>` from_position=0.0 **)**
|
- void **play** **(** :ref:`float<class_float>` from_position=0.0 **)**
|
||||||
@@ -146,26 +100,6 @@ Plays the audio from the given position 'from_position', in seconds.
|
|||||||
|
|
||||||
Sets the position from which audio will be played, in seconds.
|
Sets the position from which audio will be played, in seconds.
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer_set_autoplay:
|
|
||||||
|
|
||||||
- void **set_autoplay** **(** :ref:`bool<class_bool>` enable **)**
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer_set_bus:
|
|
||||||
|
|
||||||
- void **set_bus** **(** :ref:`String<class_string>` bus **)**
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer_set_mix_target:
|
|
||||||
|
|
||||||
- void **set_mix_target** **(** :ref:`int<class_int>` mix_target **)**
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer_set_stream:
|
|
||||||
|
|
||||||
- void **set_stream** **(** :ref:`AudioStream<class_audiostream>` stream **)**
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer_set_volume_db:
|
|
||||||
|
|
||||||
- void **set_volume_db** **(** :ref:`float<class_float>` volume_db **)**
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer_stop:
|
.. _class_AudioStreamPlayer_stop:
|
||||||
|
|
||||||
- void **stop** **(** **)**
|
- void **stop** **(** **)**
|
||||||
|
|||||||
@@ -19,45 +19,15 @@ Plays audio in 2D.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_area_mask<class_AudioStreamPlayer2D_get_area_mask>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_playback_position<class_AudioStreamPlayer2D_get_playback_position>` **(** **)** |
|
||||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_attenuation<class_AudioStreamPlayer2D_get_attenuation>` **(** **)** const |
|
| void | :ref:`play<class_AudioStreamPlayer2D_play>` **(** :ref:`float<class_float>` from_position=0.0 **)** |
|
||||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`get_bus<class_AudioStreamPlayer2D_get_bus>` **(** **)** const |
|
| void | :ref:`seek<class_AudioStreamPlayer2D_seek>` **(** :ref:`float<class_float>` to_position **)** |
|
||||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_max_distance<class_AudioStreamPlayer2D_get_max_distance>` **(** **)** const |
|
| void | :ref:`stop<class_AudioStreamPlayer2D_stop>` **(** **)** |
|
||||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------------------------------------------------------------------------------------------+
|
||||||
| :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
|
Signals
|
||||||
-------
|
-------
|
||||||
@@ -113,44 +83,12 @@ Plays audio that dampens with distance from screen center.
|
|||||||
Member Function Description
|
Member Function Description
|
||||||
---------------------------
|
---------------------------
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer2D_get_area_mask:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_area_mask** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer2D_get_attenuation:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_attenuation** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer2D_get_bus:
|
|
||||||
|
|
||||||
- :ref:`String<class_string>` **get_bus** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer2D_get_max_distance:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_max_distance** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer2D_get_playback_position:
|
.. _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>`.
|
Returns the position in the :ref:`AudioStream<class_audiostream>`.
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer2D_get_stream:
|
|
||||||
|
|
||||||
- :ref:`AudioStream<class_audiostream>` **get_stream** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer2D_get_volume_db:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_volume_db** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer2D_is_autoplay_enabled:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_autoplay_enabled** **(** **)**
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer2D_is_playing:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_playing** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer2D_play:
|
.. _class_AudioStreamPlayer2D_play:
|
||||||
|
|
||||||
- void **play** **(** :ref:`float<class_float>` from_position=0.0 **)**
|
- void **play** **(** :ref:`float<class_float>` from_position=0.0 **)**
|
||||||
@@ -163,34 +101,6 @@ Plays the audio from the given position 'from_position', in seconds.
|
|||||||
|
|
||||||
Sets the position from which audio will be played, in seconds.
|
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 **)**
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer2D_set_attenuation:
|
|
||||||
|
|
||||||
- void **set_attenuation** **(** :ref:`float<class_float>` curve **)**
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer2D_set_autoplay:
|
|
||||||
|
|
||||||
- void **set_autoplay** **(** :ref:`bool<class_bool>` enable **)**
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer2D_set_bus:
|
|
||||||
|
|
||||||
- void **set_bus** **(** :ref:`String<class_string>` bus **)**
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer2D_set_max_distance:
|
|
||||||
|
|
||||||
- void **set_max_distance** **(** :ref:`float<class_float>` pixels **)**
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer2D_set_stream:
|
|
||||||
|
|
||||||
- void **set_stream** **(** :ref:`AudioStream<class_audiostream>` stream **)**
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer2D_set_volume_db:
|
|
||||||
|
|
||||||
- void **set_volume_db** **(** :ref:`float<class_float>` volume_db **)**
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer2D_stop:
|
.. _class_AudioStreamPlayer2D_stop:
|
||||||
|
|
||||||
- void **stop** **(** **)**
|
- void **stop** **(** **)**
|
||||||
|
|||||||
@@ -19,81 +19,15 @@ Plays 3D sound in 3D space
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_area_mask<class_AudioStreamPlayer3D_get_area_mask>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_playback_position<class_AudioStreamPlayer3D_get_playback_position>` **(** **)** |
|
||||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_attenuation_filter_cutoff_hz<class_AudioStreamPlayer3D_get_attenuation_filter_cutoff_hz>` **(** **)** const |
|
| void | :ref:`play<class_AudioStreamPlayer3D_play>` **(** :ref:`float<class_float>` from_position=0.0 **)** |
|
||||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_attenuation_filter_db<class_AudioStreamPlayer3D_get_attenuation_filter_db>` **(** **)** const |
|
| void | :ref:`seek<class_AudioStreamPlayer3D_seek>` **(** :ref:`float<class_float>` to_position **)** |
|
||||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_attenuation_model<class_AudioStreamPlayer3D_get_attenuation_model>` **(** **)** const |
|
| void | :ref:`stop<class_AudioStreamPlayer3D_stop>` **(** **)** |
|
||||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------------------------------------------------------------------------------------------+
|
||||||
| :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
|
Signals
|
||||||
-------
|
-------
|
||||||
@@ -197,80 +131,12 @@ Plays a sound effect with directed sound effects, dampens with distance if neede
|
|||||||
Member Function Description
|
Member Function Description
|
||||||
---------------------------
|
---------------------------
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer3D_get_area_mask:
|
|
||||||
|
|
||||||
- :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
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer3D_get_attenuation_filter_db:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_attenuation_filter_db** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer3D_get_attenuation_model:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_attenuation_model** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer3D_get_bus:
|
|
||||||
|
|
||||||
- :ref:`String<class_string>` **get_bus** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer3D_get_doppler_tracking:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_doppler_tracking** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer3D_get_emission_angle:
|
|
||||||
|
|
||||||
- :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
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer3D_get_max_db:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_max_db** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer3D_get_max_distance:
|
|
||||||
|
|
||||||
- :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
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer3D_get_playback_position:
|
.. _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>`.
|
Returns the position in the :ref:`AudioStream<class_audiostream>`.
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer3D_get_stream:
|
|
||||||
|
|
||||||
- :ref:`AudioStream<class_audiostream>` **get_stream** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer3D_get_unit_db:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_unit_db** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer3D_get_unit_size:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_unit_size** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer3D_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
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer3D_is_playing:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_playing** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer3D_play:
|
.. _class_AudioStreamPlayer3D_play:
|
||||||
|
|
||||||
- void **play** **(** :ref:`float<class_float>` from_position=0.0 **)**
|
- void **play** **(** :ref:`float<class_float>` from_position=0.0 **)**
|
||||||
@@ -283,70 +149,6 @@ Plays the audio from the given position 'from_position', in seconds.
|
|||||||
|
|
||||||
Sets the position from which audio will be played, in seconds.
|
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 **)**
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer3D_set_attenuation_filter_cutoff_hz:
|
|
||||||
|
|
||||||
- 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 **)**
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer3D_set_attenuation_model:
|
|
||||||
|
|
||||||
- void **set_attenuation_model** **(** :ref:`int<class_int>` model **)**
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer3D_set_autoplay:
|
|
||||||
|
|
||||||
- void **set_autoplay** **(** :ref:`bool<class_bool>` enable **)**
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer3D_set_bus:
|
|
||||||
|
|
||||||
- void **set_bus** **(** :ref:`String<class_string>` bus **)**
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer3D_set_doppler_tracking:
|
|
||||||
|
|
||||||
- void **set_doppler_tracking** **(** :ref:`int<class_int>` mode **)**
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer3D_set_emission_angle:
|
|
||||||
|
|
||||||
- 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 **)**
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer3D_set_emission_angle_filter_attenuation_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 **)**
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer3D_set_max_distance:
|
|
||||||
|
|
||||||
- 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 **)**
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer3D_set_stream:
|
|
||||||
|
|
||||||
- void **set_stream** **(** :ref:`AudioStream<class_audiostream>` stream **)**
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer3D_set_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 **)**
|
|
||||||
|
|
||||||
.. _class_AudioStreamPlayer3D_stop:
|
.. _class_AudioStreamPlayer3D_stop:
|
||||||
|
|
||||||
- void **stop** **(** **)**
|
- void **stop** **(** **)**
|
||||||
|
|||||||
@@ -16,19 +16,6 @@ Brief Description
|
|||||||
|
|
||||||
Plays audio with random pitch tweaking.
|
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 **)** |
|
|
||||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -46,23 +33,3 @@ Description
|
|||||||
|
|
||||||
Randomly varies pitch on each start.
|
Randomly varies pitch on each start.
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_AudioStreamRandomPitch_get_audio_stream:
|
|
||||||
|
|
||||||
- :ref:`AudioStream<class_audiostream>` **get_audio_stream** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioStreamRandomPitch_get_random_pitch:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_random_pitch** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioStreamRandomPitch_set_audio_stream:
|
|
||||||
|
|
||||||
- void **set_audio_stream** **(** :ref:`AudioStream<class_audiostream>` stream **)**
|
|
||||||
|
|
||||||
.. _class_AudioStreamRandomPitch_set_random_pitch:
|
|
||||||
|
|
||||||
- void **set_random_pitch** **(** :ref:`float<class_float>` scale **)**
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -16,39 +16,6 @@ Brief Description
|
|||||||
|
|
||||||
Plays audio.
|
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 **)** |
|
|
||||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -96,63 +63,3 @@ Description
|
|||||||
|
|
||||||
Plays audio, can loop.
|
Plays audio, can loop.
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_AudioStreamSample_get_data:
|
|
||||||
|
|
||||||
- :ref:`PoolByteArray<class_poolbytearray>` **get_data** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioStreamSample_get_format:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_format** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioStreamSample_get_loop_begin:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_loop_begin** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioStreamSample_get_loop_end:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_loop_end** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioStreamSample_get_loop_mode:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_loop_mode** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioStreamSample_get_mix_rate:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_mix_rate** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioStreamSample_is_stereo:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_stereo** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_AudioStreamSample_set_data:
|
|
||||||
|
|
||||||
- void **set_data** **(** :ref:`PoolByteArray<class_poolbytearray>` data **)**
|
|
||||||
|
|
||||||
.. _class_AudioStreamSample_set_format:
|
|
||||||
|
|
||||||
- void **set_format** **(** :ref:`int<class_int>` format **)**
|
|
||||||
|
|
||||||
.. _class_AudioStreamSample_set_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 **)**
|
|
||||||
|
|
||||||
.. _class_AudioStreamSample_set_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 **)**
|
|
||||||
|
|
||||||
.. _class_AudioStreamSample_set_stereo:
|
|
||||||
|
|
||||||
- void **set_stereo** **(** :ref:`bool<class_bool>` stereo **)**
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -16,19 +16,6 @@ Brief Description
|
|||||||
|
|
||||||
Copies a region of the screen (or the whole screen) to a buffer so it can be accessed with the texscreen() shader instruction.
|
Copies a region of the screen (or the whole screen) to a buffer so it can be accessed with the texscreen() shader instruction.
|
||||||
|
|
||||||
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 **)** |
|
|
||||||
+----------------------------+------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -53,31 +40,3 @@ Description
|
|||||||
|
|
||||||
Node for back-buffering the currently displayed screen. The region defined in the BackBufferCopy node is bufferized with the content of the screen it covers, or the entire screen according to the copy mode set. Accessing this buffer is done with the texscreen() shader instruction.
|
Node for back-buffering the currently displayed screen. The region defined in the BackBufferCopy node is bufferized with the content of the screen it covers, or the entire screen according to the copy mode set. Accessing this buffer is done with the texscreen() shader instruction.
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_BackBufferCopy_get_copy_mode:
|
|
||||||
|
|
||||||
- :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
|
|
||||||
|
|
||||||
Return the area covered by the BackBufferCopy.
|
|
||||||
|
|
||||||
.. _class_BackBufferCopy_set_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 **)**
|
|
||||||
|
|
||||||
Defines the area covered by the BackBufferCopy.
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -21,43 +21,15 @@ Base class for different kinds of buttons.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------+------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`_pressed<class_BaseButton__pressed>` **(** **)** virtual |
|
| void | :ref:`_pressed<class_BaseButton__pressed>` **(** **)** virtual |
|
||||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------+------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`_toggled<class_BaseButton__toggled>` **(** :ref:`bool<class_bool>` pressed **)** virtual |
|
| void | :ref:`_toggled<class_BaseButton__toggled>` **(** :ref:`bool<class_bool>` pressed **)** virtual |
|
||||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------+------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_action_mode<class_BaseButton_get_action_mode>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_draw_mode<class_BaseButton_get_draw_mode>` **(** **)** const |
|
||||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------+------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`ButtonGroup<class_buttongroup>` | :ref:`get_button_group<class_BaseButton_get_button_group>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_hovered<class_BaseButton_is_hovered>` **(** **)** 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
|
Signals
|
||||||
-------
|
-------
|
||||||
@@ -149,92 +121,16 @@ Called when button is pressed.
|
|||||||
|
|
||||||
Called when button is toggled (only if toggle_mode is active).
|
Called when button is toggled (only if toggle_mode is active).
|
||||||
|
|
||||||
.. _class_BaseButton_get_action_mode:
|
|
||||||
|
|
||||||
- :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
|
|
||||||
|
|
||||||
.. _class_BaseButton_get_draw_mode:
|
.. _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.
|
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
|
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
.. _class_BaseButton_is_disabled:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_disabled** **(** **)** const
|
|
||||||
|
|
||||||
Return whether the button is in disabled state (see :ref:`set_disabled<class_BaseButton_set_disabled>`).
|
|
||||||
|
|
||||||
.. _class_BaseButton_is_hovered:
|
.. _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.
|
Return true if mouse entered the button before it exit.
|
||||||
|
|
||||||
.. _class_BaseButton_is_pressed:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_pressed** **(** **)** const
|
|
||||||
|
|
||||||
If toggle_mode is active, return whether the button is toggled. If toggle_mode is not active, return whether the button is pressed down.
|
|
||||||
|
|
||||||
.. _class_BaseButton_is_toggle_mode:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_toggle_mode** **(** **)** const
|
|
||||||
|
|
||||||
Return the toggle_mode property (see :ref:`set_toggle_mode<class_BaseButton_set_toggle_mode>`).
|
|
||||||
|
|
||||||
.. _class_BaseButton_set_action_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 **)**
|
|
||||||
|
|
||||||
.. _class_BaseButton_set_disabled:
|
|
||||||
|
|
||||||
- void **set_disabled** **(** :ref:`bool<class_bool>` disabled **)**
|
|
||||||
|
|
||||||
Set the button into disabled state. When a button is disabled, it can't be clicked or toggled.
|
|
||||||
|
|
||||||
.. _class_BaseButton_set_enabled_focus_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 **)**
|
|
||||||
|
|
||||||
Set the button to pressed state (only if toggle_mode is active).
|
|
||||||
|
|
||||||
.. _class_BaseButton_set_shortcut:
|
|
||||||
|
|
||||||
- void **set_shortcut** **(** :ref:`ShortCut<class_shortcut>` shortcut **)**
|
|
||||||
|
|
||||||
.. _class_BaseButton_set_toggle_mode:
|
|
||||||
|
|
||||||
- void **set_toggle_mode** **(** :ref:`bool<class_bool>` enabled **)**
|
|
||||||
|
|
||||||
Set the button toggle_mode property. Toggle mode makes the button flip state between pressed and unpressed each time its area is clicked.
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ 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:`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>` from **)** |
|
||||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :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>` axis, :ref:`float<class_float>` phi **)** |
|
||||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -89,7 +89,7 @@ Create a rotation matrix from the given quaternion.
|
|||||||
|
|
||||||
.. _class_Basis_Basis:
|
.. _class_Basis_Basis:
|
||||||
|
|
||||||
- :ref:`Basis<class_basis>` **Basis** **(** :ref:`Vector3<class_vector3>` euler **)**
|
- :ref:`Basis<class_basis>` **Basis** **(** :ref:`Vector3<class_vector3>` from **)**
|
||||||
|
|
||||||
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).
|
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).
|
||||||
|
|
||||||
|
|||||||
@@ -19,35 +19,25 @@ Renders text using ``\*.fnt`` fonts.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`add_char<class_BitmapFont_add_char>` **(** :ref:`int<class_int>` character, :ref:`int<class_int>` texture, :ref:`Rect2<class_rect2>` rect, :ref:`Vector2<class_vector2>` align=Vector2( 0, 0 ), :ref:`float<class_float>` advance=-1 **)** |
|
| void | :ref:`add_char<class_BitmapFont_add_char>` **(** :ref:`int<class_int>` character, :ref:`int<class_int>` texture, :ref:`Rect2<class_rect2>` rect, :ref:`Vector2<class_vector2>` align=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_kerning_pair<class_BitmapFont_add_kerning_pair>` **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b, :ref:`int<class_int>` kerning **)** |
|
||||||
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`add_texture<class_BitmapFont_add_texture>` **(** :ref:`Texture<class_texture>` texture **)** |
|
| void | :ref:`add_texture<class_BitmapFont_add_texture>` **(** :ref:`Texture<class_texture>` texture **)** |
|
||||||
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`clear<class_BitmapFont_clear>` **(** **)** |
|
| void | :ref:`clear<class_BitmapFont_clear>` **(** **)** |
|
||||||
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`create_from_fnt<class_BitmapFont_create_from_fnt>` **(** :ref:`String<class_string>` path **)** |
|
| :ref:`int<class_int>` | :ref:`create_from_fnt<class_BitmapFont_create_from_fnt>` **(** :ref:`String<class_string>` path **)** |
|
||||||
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_char_size<class_BitmapFont_get_char_size>` **(** :ref:`int<class_int>` char, :ref:`int<class_int>` next=0 **)** const |
|
| :ref:`Vector2<class_vector2>` | :ref:`get_char_size<class_BitmapFont_get_char_size>` **(** :ref:`int<class_int>` char, :ref:`int<class_int>` next=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:`int<class_int>` | :ref:`get_kerning_pair<class_BitmapFont_get_kerning_pair>` **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b **)** const |
|
| :ref:`Texture<class_texture>` | :ref:`get_texture<class_BitmapFont_get_texture>` **(** :ref:`int<class_int>` idx **)** const |
|
||||||
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Texture<class_texture>` | :ref:`get_texture<class_BitmapFont_get_texture>` **(** :ref:`int<class_int>` idx **)** const |
|
| :ref:`int<class_int>` | :ref:`get_texture_count<class_BitmapFont_get_texture_count>` **(** **)** const |
|
||||||
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_texture_count<class_BitmapFont_get_texture_count>` **(** **)** const |
|
|
||||||
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_ascent<class_BitmapFont_set_ascent>` **(** :ref:`float<class_float>` px **)** |
|
|
||||||
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_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
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
@@ -125,12 +115,6 @@ Creates a BitmapFont from the ``\*.fnt`` file at ``path``.
|
|||||||
|
|
||||||
Returns the size of a character, optionally taking kerning into account if the next character is provided.
|
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
|
|
||||||
|
|
||||||
Returns the fallback BitmapFont.
|
|
||||||
|
|
||||||
.. _class_BitmapFont_get_kerning_pair:
|
.. _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
|
||||||
@@ -149,28 +133,4 @@ Returns the font atlas texture at index ``idx``.
|
|||||||
|
|
||||||
Returns the number of textures in the BitmapFont atlas.
|
Returns the number of textures in the BitmapFont atlas.
|
||||||
|
|
||||||
.. _class_BitmapFont_set_ascent:
|
|
||||||
|
|
||||||
- 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 **)**
|
|
||||||
|
|
||||||
If ``true`` distance field hint is enabled.
|
|
||||||
|
|
||||||
.. _class_BitmapFont_set_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 **)**
|
|
||||||
|
|
||||||
Sets the total font height (ascent plus descent) in pixels.
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -21,13 +21,9 @@ Base class for box containers.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+------------------------+----------------------------------------------------------------------------------------------------+
|
+-------+--------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`add_spacer<class_BoxContainer_add_spacer>` **(** :ref:`bool<class_bool>` begin **)** |
|
| 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
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
@@ -58,16 +54,4 @@ Member Function Description
|
|||||||
|
|
||||||
Adds a control to the box as a spacer. If ``true``, *begin* will insert the spacer control in front of other children.
|
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
|
|
||||||
|
|
||||||
Return the alignment of children in the container.
|
|
||||||
|
|
||||||
.. _class_BoxContainer_set_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).
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -16,15 +16,6 @@ Brief Description
|
|||||||
|
|
||||||
Box shape resource.
|
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 **)** |
|
|
||||||
+--------------------------------+--------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -38,19 +29,3 @@ Description
|
|||||||
|
|
||||||
3D box shape that can be a child of a :ref:`PhysicsBody<class_physicsbody>` or :ref:`Area<class_area>`.
|
3D box shape that can be a child of a :ref:`PhysicsBody<class_physicsbody>` or :ref:`Area<class_area>`.
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_BoxShape_get_extents:
|
|
||||||
|
|
||||||
- :ref:`Vector3<class_vector3>` **get_extents** **(** **)** const
|
|
||||||
|
|
||||||
Return the half extents of the shape.
|
|
||||||
|
|
||||||
.. _class_BoxShape_set_extents:
|
|
||||||
|
|
||||||
- void **set_extents** **(** :ref:`Vector3<class_vector3>` extents **)**
|
|
||||||
|
|
||||||
Set the half extents for the shape.
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -18,31 +18,6 @@ Brief Description
|
|||||||
|
|
||||||
Standard themed Button.
|
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 **)** |
|
|
||||||
+--------------------------------+--------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -79,47 +54,3 @@ Description
|
|||||||
|
|
||||||
Button is the standard themed button. It can contain text and an icon, and will display them according to the current :ref:`Theme<class_theme>`.
|
Button is the standard themed button. It can contain text and an icon, and will display them according to the current :ref:`Theme<class_theme>`.
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_Button_get_button_icon:
|
|
||||||
|
|
||||||
- :ref:`Texture<class_texture>` **get_button_icon** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Button_get_clip_text:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **get_clip_text** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Button_get_text:
|
|
||||||
|
|
||||||
- :ref:`String<class_string>` **get_text** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Button_get_text_align:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_text_align** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Button_is_flat:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_flat** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Button_set_button_icon:
|
|
||||||
|
|
||||||
- void **set_button_icon** **(** :ref:`Texture<class_texture>` texture **)**
|
|
||||||
|
|
||||||
.. _class_Button_set_clip_text:
|
|
||||||
|
|
||||||
- void **set_clip_text** **(** :ref:`bool<class_bool>` enabled **)**
|
|
||||||
|
|
||||||
.. _class_Button_set_flat:
|
|
||||||
|
|
||||||
- void **set_flat** **(** :ref:`bool<class_bool>` enabled **)**
|
|
||||||
|
|
||||||
.. _class_Button_set_text:
|
|
||||||
|
|
||||||
- void **set_text** **(** :ref:`String<class_string>` text **)**
|
|
||||||
|
|
||||||
.. _class_Button_set_text_align:
|
|
||||||
|
|
||||||
- void **set_text_align** **(** :ref:`int<class_int>` align **)**
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
+27
-219
@@ -19,91 +19,33 @@ Camera node for 2D scenes.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`align<class_Camera2D_align>` **(** **)** |
|
| void | :ref:`align<class_Camera2D_align>` **(** **)** |
|
||||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`clear_current<class_Camera2D_clear_current>` **(** **)** |
|
| void | :ref:`clear_current<class_Camera2D_clear_current>` **(** **)** |
|
||||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`force_update_scroll<class_Camera2D_force_update_scroll>` **(** **)** |
|
| void | :ref:`force_update_scroll<class_Camera2D_force_update_scroll>` **(** **)** |
|
||||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_anchor_mode<class_Camera2D_get_anchor_mode>` **(** **)** const |
|
| :ref:`Vector2<class_vector2>` | :ref:`get_camera_position<class_Camera2D_get_camera_position>` **(** **)** 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:`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:`Node<class_node>` | :ref:`get_custom_viewport<class_Camera2D_get_custom_viewport>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_h_offset<class_Camera2D_get_h_offset>` **(** **)** 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_v_offset<class_Camera2D_get_v_offset>` **(** **)** const |
|
||||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_follow_smoothing<class_Camera2D_get_follow_smoothing>` **(** **)** const |
|
| void | :ref:`make_current<class_Camera2D_make_current>` **(** **)** |
|
||||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_h_offset<class_Camera2D_get_h_offset>` **(** **)** const |
|
| void | :ref:`reset_smoothing<class_Camera2D_reset_smoothing>` **(** **)** |
|
||||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_limit<class_Camera2D_get_limit>` **(** :ref:`int<class_int>` margin **)** const |
|
| void | :ref:`set_custom_viewport<class_Camera2D_set_custom_viewport>` **(** :ref:`Node<class_node>` viewport **)** |
|
||||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_offset<class_Camera2D_get_offset>` **(** **)** const |
|
| void | :ref:`set_h_offset<class_Camera2D_set_h_offset>` **(** :ref:`float<class_float>` ofs **)** |
|
||||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_v_offset<class_Camera2D_get_v_offset>` **(** **)** const |
|
| void | :ref:`set_v_offset<class_Camera2D_set_v_offset>` **(** :ref:`float<class_float>` ofs **)** |
|
||||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||||
| :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
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
@@ -225,10 +167,6 @@ Align the camera to the tracked node
|
|||||||
|
|
||||||
Force the camera to update scroll immediately.
|
Force the camera to update scroll immediately.
|
||||||
|
|
||||||
.. _class_Camera2D_get_anchor_mode:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_anchor_mode** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Camera2D_get_camera_position:
|
.. _class_Camera2D_get_camera_position:
|
||||||
|
|
||||||
- :ref:`Vector2<class_vector2>` **get_camera_position** **(** **)** const
|
- :ref:`Vector2<class_vector2>` **get_camera_position** **(** **)** const
|
||||||
@@ -243,78 +181,14 @@ Return the camera position.
|
|||||||
|
|
||||||
- :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
|
|
||||||
|
|
||||||
Return the margins needed to drag the camera (see :ref:`set_drag_margin<class_Camera2D_set_drag_margin>`).
|
|
||||||
|
|
||||||
.. _class_Camera2D_get_follow_smoothing:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_follow_smoothing** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Camera2D_get_h_offset:
|
.. _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
|
|
||||||
|
|
||||||
Return the scrolling limit in pixels.
|
|
||||||
|
|
||||||
.. _class_Camera2D_get_offset:
|
|
||||||
|
|
||||||
- :ref:`Vector2<class_vector2>` **get_offset** **(** **)** const
|
|
||||||
|
|
||||||
Return the scroll offset.
|
|
||||||
|
|
||||||
.. _class_Camera2D_get_v_offset:
|
.. _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
|
|
||||||
|
|
||||||
.. _class_Camera2D_is_current:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_current** **(** **)** const
|
|
||||||
|
|
||||||
Return true of this is the current camera (see :ref:`make_current<class_Camera2D_make_current>`).
|
|
||||||
|
|
||||||
.. _class_Camera2D_is_follow_smoothing_enabled:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_follow_smoothing_enabled** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Camera2D_is_h_drag_enabled:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_h_drag_enabled** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Camera2D_is_limit_drawing_enabled:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_limit_drawing_enabled** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Camera2D_is_limit_smoothing_enabled:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_limit_smoothing_enabled** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Camera2D_is_margin_drawing_enabled:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_margin_drawing_enabled** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Camera2D_is_rotating:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_rotating** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Camera2D_is_screen_drawing_enabled:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_screen_drawing_enabled** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Camera2D_is_v_drag_enabled:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_v_drag_enabled** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Camera2D_make_current:
|
.. _class_Camera2D_make_current:
|
||||||
|
|
||||||
- void **make_current** **(** **)**
|
- void **make_current** **(** **)**
|
||||||
@@ -329,82 +203,16 @@ Set the camera's position immediately to its current smoothing destination.
|
|||||||
|
|
||||||
This has no effect if smoothing is disabled.
|
This has no effect if smoothing is disabled.
|
||||||
|
|
||||||
.. _class_Camera2D_set_anchor_mode:
|
|
||||||
|
|
||||||
- void **set_anchor_mode** **(** :ref:`int<class_int>` anchor_mode **)**
|
|
||||||
|
|
||||||
.. _class_Camera2D_set_custom_viewport:
|
.. _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 **)**
|
|
||||||
|
|
||||||
Set the margins needed to drag the camera (relative to the screen size). Margin uses the MARGIN\_\* enum. Drag margins of 0,0,0,0 will keep the camera at the center of the screen, while drag margins of 1,1,1,1 will only move when the camera is at the edges.
|
|
||||||
|
|
||||||
.. _class_Camera2D_set_enable_follow_smoothing:
|
|
||||||
|
|
||||||
- void **set_enable_follow_smoothing** **(** :ref:`bool<class_bool>` follow_smoothing **)**
|
|
||||||
|
|
||||||
.. _class_Camera2D_set_follow_smoothing:
|
|
||||||
|
|
||||||
- void **set_follow_smoothing** **(** :ref:`float<class_float>` follow_smoothing **)**
|
|
||||||
|
|
||||||
.. _class_Camera2D_set_h_drag_enabled:
|
|
||||||
|
|
||||||
- void **set_h_drag_enabled** **(** :ref:`bool<class_bool>` enabled **)**
|
|
||||||
|
|
||||||
.. _class_Camera2D_set_h_offset:
|
.. _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 **)**
|
|
||||||
|
|
||||||
Set the scrolling limit in pixels.
|
|
||||||
|
|
||||||
.. _class_Camera2D_set_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 **)**
|
|
||||||
|
|
||||||
Smooth camera when reaching camera limits.
|
|
||||||
|
|
||||||
This requires camera smoothing being enabled to have a noticeable effect.
|
|
||||||
|
|
||||||
.. _class_Camera2D_set_margin_drawing_enabled:
|
|
||||||
|
|
||||||
- void **set_margin_drawing_enabled** **(** :ref:`bool<class_bool>` margin_drawing_enabled **)**
|
|
||||||
|
|
||||||
.. _class_Camera2D_set_offset:
|
|
||||||
|
|
||||||
- void **set_offset** **(** :ref:`Vector2<class_vector2>` offset **)**
|
|
||||||
|
|
||||||
Set the scroll offset. Useful for looking around or camera shake animations.
|
|
||||||
|
|
||||||
.. _class_Camera2D_set_rotating:
|
|
||||||
|
|
||||||
- void **set_rotating** **(** :ref:`bool<class_bool>` rotating **)**
|
|
||||||
|
|
||||||
.. _class_Camera2D_set_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 **)**
|
|
||||||
|
|
||||||
.. _class_Camera2D_set_v_offset:
|
.. _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 **)**
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -56,14 +56,6 @@ Member Functions
|
|||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`draw_texture_rect_region<class_CanvasItem_draw_texture_rect_region>` **(** :ref:`Texture<class_texture>` texture, :ref:`Rect2<class_rect2>` rect, :ref:`Rect2<class_rect2>` src_rect, :ref:`Color<class_color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=false, :ref:`Texture<class_texture>` normal_map=null, :ref:`bool<class_bool>` clip_uv=true **)** |
|
| void | :ref:`draw_texture_rect_region<class_CanvasItem_draw_texture_rect_region>` **(** :ref:`Texture<class_texture>` texture, :ref:`Rect2<class_rect2>` rect, :ref:`Rect2<class_rect2>` src_rect, :ref:`Color<class_color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=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<class_CanvasItem_get_canvas>` **(** **)** const |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`RID<class_rid>` | :ref:`get_canvas_item<class_CanvasItem_get_canvas_item>` **(** **)** const |
|
| :ref:`RID<class_rid>` | :ref:`get_canvas_item<class_CanvasItem_get_canvas_item>` **(** **)** const |
|
||||||
@@ -76,24 +68,10 @@ Member Functions
|
|||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Transform2D<class_transform2d>` | :ref:`get_global_transform_with_canvas<class_CanvasItem_get_global_transform_with_canvas>` **(** **)** const |
|
| :ref:`Transform2D<class_transform2d>` | :ref:`get_global_transform_with_canvas<class_CanvasItem_get_global_transform_with_canvas>` **(** **)** const |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Rect2<class_rect2>` | :ref:`get_item_and_children_rect<class_CanvasItem_get_item_and_children_rect>` **(** **)** const |
|
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`Rect2<class_rect2>` | :ref:`get_item_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:`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:`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:`Rect2<class_rect2>` | :ref:`get_viewport_rect<class_CanvasItem_get_viewport_rect>` **(** **)** const |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Transform2D<class_transform2d>` | :ref:`get_viewport_transform<class_CanvasItem_get_viewport_transform>` **(** **)** const |
|
| :ref:`Transform2D<class_transform2d>` | :ref:`get_viewport_transform<class_CanvasItem_get_viewport_transform>` **(** **)** const |
|
||||||
@@ -102,16 +80,12 @@ Member Functions
|
|||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`hide<class_CanvasItem_hide>` **(** **)** |
|
| void | :ref:`hide<class_CanvasItem_hide>` **(** **)** |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_draw_behind_parent_enabled<class_CanvasItem_is_draw_behind_parent_enabled>` **(** **)** const |
|
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_local_transform_notification_enabled<class_CanvasItem_is_local_transform_notification_enabled>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_local_transform_notification_enabled<class_CanvasItem_is_local_transform_notification_enabled>` **(** **)** const |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_set_as_toplevel<class_CanvasItem_is_set_as_toplevel>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_set_as_toplevel<class_CanvasItem_is_set_as_toplevel>` **(** **)** const |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_transform_notification_enabled<class_CanvasItem_is_transform_notification_enabled>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_transform_notification_enabled<class_CanvasItem_is_transform_notification_enabled>` **(** **)** const |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_visible<class_CanvasItem_is_visible>` **(** **)** const |
|
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_visible_in_tree<class_CanvasItem_is_visible_in_tree>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_visible_in_tree<class_CanvasItem_is_visible_in_tree>` **(** **)** const |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`make_canvas_position_local<class_CanvasItem_make_canvas_position_local>` **(** :ref:`Vector2<class_vector2>` screen_point **)** const |
|
| :ref:`Vector2<class_vector2>` | :ref:`make_canvas_position_local<class_CanvasItem_make_canvas_position_local>` **(** :ref:`Vector2<class_vector2>` screen_point **)** const |
|
||||||
@@ -120,24 +94,10 @@ Member Functions
|
|||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_as_toplevel<class_CanvasItem_set_as_toplevel>` **(** :ref:`bool<class_bool>` enable **)** |
|
| void | :ref:`set_as_toplevel<class_CanvasItem_set_as_toplevel>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_draw_behind_parent<class_CanvasItem_set_draw_behind_parent>` **(** :ref:`bool<class_bool>` enable **)** |
|
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_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_local_transform<class_CanvasItem_set_notify_local_transform>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_notify_transform<class_CanvasItem_set_notify_transform>` **(** :ref:`bool<class_bool>` enable **)** |
|
| void | :ref:`set_notify_transform<class_CanvasItem_set_notify_transform>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_self_modulate<class_CanvasItem_set_self_modulate>` **(** :ref:`Color<class_color>` self_modulate **)** |
|
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_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:`show<class_CanvasItem_show>` **(** **)** |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`update<class_CanvasItem_update>` **(** **)** |
|
| void | :ref:`update<class_CanvasItem_update>` **(** **)** |
|
||||||
@@ -333,28 +293,6 @@ Draw a textured rectangle at a given position, optionally modulated by a color.
|
|||||||
|
|
||||||
Draw a textured rectangle region at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture.
|
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
|
|
||||||
|
|
||||||
Used for editing, returns an opaque value representing the transform state.
|
|
||||||
|
|
||||||
.. _class_CanvasItem_edit_rotate:
|
|
||||||
|
|
||||||
- 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 **)**
|
|
||||||
|
|
||||||
.. _class_CanvasItem_edit_set_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:
|
.. _class_CanvasItem_get_canvas:
|
||||||
|
|
||||||
- :ref:`RID<class_rid>` **get_canvas** **(** **)** const
|
- :ref:`RID<class_rid>` **get_canvas** **(** **)** const
|
||||||
@@ -391,60 +329,18 @@ Get the global transform matrix of this item.
|
|||||||
|
|
||||||
Get the global transform matrix of this item in relation to the canvas.
|
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
|
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
Return a rect containing the editable boundaries of the item.
|
|
||||||
|
|
||||||
.. _class_CanvasItem_get_light_mask:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_light_mask** **(** **)** const
|
|
||||||
|
|
||||||
Get this item's light mask number.
|
|
||||||
|
|
||||||
.. _class_CanvasItem_get_local_mouse_position:
|
.. _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.
|
Get the mouse position relative to this item's position.
|
||||||
|
|
||||||
.. _class_CanvasItem_get_material:
|
|
||||||
|
|
||||||
- :ref:`Material<class_material>` **get_material** **(** **)** const
|
|
||||||
|
|
||||||
Get the material of this item.
|
|
||||||
|
|
||||||
.. _class_CanvasItem_get_modulate:
|
|
||||||
|
|
||||||
- :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
|
|
||||||
|
|
||||||
Get the self-modulate of the CanvasItem.
|
|
||||||
|
|
||||||
.. _class_CanvasItem_get_transform:
|
.. _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.
|
Get the transform matrix of this item.
|
||||||
|
|
||||||
.. _class_CanvasItem_get_use_parent_material:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **get_use_parent_material** **(** **)** const
|
|
||||||
|
|
||||||
Get whether this item uses its parent's material.
|
|
||||||
|
|
||||||
.. _class_CanvasItem_get_viewport_rect:
|
.. _class_CanvasItem_get_viewport_rect:
|
||||||
|
|
||||||
- :ref:`Rect2<class_rect2>` **get_viewport_rect** **(** **)** const
|
- :ref:`Rect2<class_rect2>` **get_viewport_rect** **(** **)** const
|
||||||
@@ -469,12 +365,6 @@ Get the :ref:`World2D<class_world2d>` where this item is in.
|
|||||||
|
|
||||||
Hide the CanvasItem currently visible.
|
Hide the CanvasItem currently visible.
|
||||||
|
|
||||||
.. _class_CanvasItem_is_draw_behind_parent_enabled:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_draw_behind_parent_enabled** **(** **)** const
|
|
||||||
|
|
||||||
Return whether the item is drawn behind its parent.
|
|
||||||
|
|
||||||
.. _class_CanvasItem_is_local_transform_notification_enabled:
|
.. _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
|
||||||
@@ -489,12 +379,6 @@ Return if set as toplevel. See :ref:`set_as_toplevel<class_CanvasItem_set_as_top
|
|||||||
|
|
||||||
- :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
|
|
||||||
|
|
||||||
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:
|
.. _class_CanvasItem_is_visible_in_tree:
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_visible_in_tree** **(** **)** const
|
- :ref:`bool<class_bool>` **is_visible_in_tree** **(** **)** const
|
||||||
@@ -513,30 +397,6 @@ Return true if this CanvasItem is visible. It may be invisible because itself or
|
|||||||
|
|
||||||
Set as top level. This means that it will not inherit transform from parent canvas items.
|
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 **)**
|
|
||||||
|
|
||||||
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 **)**
|
|
||||||
|
|
||||||
Set the ligtht mask number of this item.
|
|
||||||
|
|
||||||
.. _class_CanvasItem_set_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 **)**
|
|
||||||
|
|
||||||
Set the modulate of the CanvasItem. This *affects* the modulation of children items.
|
|
||||||
|
|
||||||
.. _class_CanvasItem_set_notify_local_transform:
|
.. _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 **)**
|
||||||
@@ -545,26 +405,6 @@ Set the modulate of the CanvasItem. This *affects* the modulation of children it
|
|||||||
|
|
||||||
- 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 **)**
|
|
||||||
|
|
||||||
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 **)**
|
|
||||||
|
|
||||||
Set whether or not this item should use its parent's material.
|
|
||||||
|
|
||||||
.. _class_CanvasItem_set_visible:
|
|
||||||
|
|
||||||
- void **set_visible** **(** :ref:`bool<class_bool>` visible **)**
|
|
||||||
|
|
||||||
Set whether this item should be visible or not.
|
|
||||||
|
|
||||||
Note that a hidden CanvasItem will make all children hidden too, so no matter what is set here this item won't be shown if its parent or grandparents nodes are hidden.
|
|
||||||
|
|
||||||
.. _class_CanvasItem_show:
|
.. _class_CanvasItem_show:
|
||||||
|
|
||||||
- void **show** **(** **)**
|
- void **show** **(** **)**
|
||||||
|
|||||||
@@ -16,19 +16,6 @@ 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 **)** |
|
|
||||||
+------------------------+-------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -53,23 +40,3 @@ Numeric Constants
|
|||||||
- **LIGHT_MODE_UNSHADED** = **1**
|
- **LIGHT_MODE_UNSHADED** = **1**
|
||||||
- **LIGHT_MODE_LIGHT_ONLY** = **2**
|
- **LIGHT_MODE_LIGHT_ONLY** = **2**
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_CanvasItemMaterial_get_blend_mode:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_blend_mode** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_CanvasItemMaterial_get_light_mode:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_light_mode** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_CanvasItemMaterial_set_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 **)**
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -24,32 +24,16 @@ Member Functions
|
|||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Node<class_node>` | :ref:`get_custom_viewport<class_CanvasLayer_get_custom_viewport>` **(** **)** const |
|
| :ref:`Node<class_node>` | :ref:`get_custom_viewport<class_CanvasLayer_get_custom_viewport>` **(** **)** const |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_layer<class_CanvasLayer_get_layer>` **(** **)** const |
|
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_offset<class_CanvasLayer_get_offset>` **(** **)** const |
|
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_rotation<class_CanvasLayer_get_rotation>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_rotation<class_CanvasLayer_get_rotation>` **(** **)** const |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_rotation_degrees<class_CanvasLayer_get_rotation_degrees>` **(** **)** const |
|
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_scale<class_CanvasLayer_get_scale>` **(** **)** const |
|
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`Transform2D<class_transform2d>` | :ref:`get_transform<class_CanvasLayer_get_transform>` **(** **)** const |
|
| :ref:`Transform2D<class_transform2d>` | :ref:`get_transform<class_CanvasLayer_get_transform>` **(** **)** const |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`World2D<class_world2d>` | :ref:`get_world_2d<class_CanvasLayer_get_world_2d>` **(** **)** const |
|
| :ref:`World2D<class_world2d>` | :ref:`get_world_2d<class_CanvasLayer_get_world_2d>` **(** **)** const |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_custom_viewport<class_CanvasLayer_set_custom_viewport>` **(** :ref:`Node<class_node>` viewport **)** |
|
| void | :ref:`set_custom_viewport<class_CanvasLayer_set_custom_viewport>` **(** :ref:`Node<class_node>` viewport **)** |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_layer<class_CanvasLayer_set_layer>` **(** :ref:`int<class_int>` layer **)** |
|
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_offset<class_CanvasLayer_set_offset>` **(** :ref:`Vector2<class_vector2>` offset **)** |
|
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_rotation<class_CanvasLayer_set_rotation>` **(** :ref:`float<class_float>` radians **)** |
|
| void | :ref:`set_rotation<class_CanvasLayer_set_rotation>` **(** :ref:`float<class_float>` radians **)** |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_rotation_degrees<class_CanvasLayer_set_rotation_degrees>` **(** :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 **)** |
|
| void | :ref:`set_transform<class_CanvasLayer_set_transform>` **(** :ref:`Transform2D<class_transform2d>` transform **)** |
|
||||||
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
@@ -85,36 +69,12 @@ Member Function Description
|
|||||||
|
|
||||||
- :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
|
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
Return the base offset for this layer (helper).
|
|
||||||
|
|
||||||
.. _class_CanvasLayer_get_rotation:
|
.. _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).
|
Return the base rotation for this layer in radians (helper).
|
||||||
|
|
||||||
.. _class_CanvasLayer_get_rotation_degrees:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_rotation_degrees** **(** **)** const
|
|
||||||
|
|
||||||
Return the base rotation for this layer in degrees.
|
|
||||||
|
|
||||||
.. _class_CanvasLayer_get_scale:
|
|
||||||
|
|
||||||
- :ref:`Vector2<class_vector2>` **get_scale** **(** **)** const
|
|
||||||
|
|
||||||
Return the base scale for this layer (helper).
|
|
||||||
|
|
||||||
.. _class_CanvasLayer_get_transform:
|
.. _class_CanvasLayer_get_transform:
|
||||||
|
|
||||||
- :ref:`Transform2D<class_transform2d>` **get_transform** **(** **)** const
|
- :ref:`Transform2D<class_transform2d>` **get_transform** **(** **)** const
|
||||||
@@ -131,36 +91,12 @@ Return the :ref:`World2D<class_world2d>` used by this layer.
|
|||||||
|
|
||||||
- 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 **)**
|
|
||||||
|
|
||||||
Set the layer index, determines the draw order, a lower value will be below a higher one.
|
|
||||||
|
|
||||||
.. _class_CanvasLayer_set_offset:
|
|
||||||
|
|
||||||
- void **set_offset** **(** :ref:`Vector2<class_vector2>` offset **)**
|
|
||||||
|
|
||||||
Set the base offset for this layer (helper).
|
|
||||||
|
|
||||||
.. _class_CanvasLayer_set_rotation:
|
.. _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).
|
Set the base rotation for this layer in radians (helper).
|
||||||
|
|
||||||
.. _class_CanvasLayer_set_rotation_degrees:
|
|
||||||
|
|
||||||
- void **set_rotation_degrees** **(** :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 **)**
|
|
||||||
|
|
||||||
Set the base scale for this layer (helper).
|
|
||||||
|
|
||||||
.. _class_CanvasLayer_set_transform:
|
.. _class_CanvasLayer_set_transform:
|
||||||
|
|
||||||
- void **set_transform** **(** :ref:`Transform2D<class_transform2d>` transform **)**
|
- void **set_transform** **(** :ref:`Transform2D<class_transform2d>` transform **)**
|
||||||
|
|||||||
@@ -16,15 +16,6 @@ Brief Description
|
|||||||
|
|
||||||
Tint the entire canvas.
|
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 **)** |
|
|
||||||
+----------------------------+----------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -38,19 +29,3 @@ Description
|
|||||||
|
|
||||||
``CanvasModulate`` tints the canvas elements using its assigned ``color``.
|
``CanvasModulate`` tints the canvas elements using its assigned ``color``.
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_CanvasModulate_get_color:
|
|
||||||
|
|
||||||
- :ref:`Color<class_color>` **get_color** **(** **)** const
|
|
||||||
|
|
||||||
Gets the canvas tint color
|
|
||||||
|
|
||||||
.. _class_CanvasModulate_set_color:
|
|
||||||
|
|
||||||
- void **set_color** **(** :ref:`Color<class_color>` color **)**
|
|
||||||
|
|
||||||
Sets the canvas tint color
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -16,27 +16,6 @@ Brief Description
|
|||||||
|
|
||||||
Class representing a capsule-shaped :ref:`PrimitiveMesh<class_primitivemesh>`.
|
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 **)** |
|
|
||||||
+----------------------------+--------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -62,39 +41,3 @@ Description
|
|||||||
|
|
||||||
Class representing a capsule-shaped :ref:`PrimitiveMesh<class_primitivemesh>`.
|
Class representing a capsule-shaped :ref:`PrimitiveMesh<class_primitivemesh>`.
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_CapsuleMesh_get_mid_height:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_mid_height** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_CapsuleMesh_get_radial_segments:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_radial_segments** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_CapsuleMesh_get_radius:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_radius** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_CapsuleMesh_get_rings:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_rings** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_CapsuleMesh_set_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 **)**
|
|
||||||
|
|
||||||
.. _class_CapsuleMesh_set_radius:
|
|
||||||
|
|
||||||
- void **set_radius** **(** :ref:`float<class_float>` radius **)**
|
|
||||||
|
|
||||||
.. _class_CapsuleMesh_set_rings:
|
|
||||||
|
|
||||||
- void **set_rings** **(** :ref:`int<class_int>` rings **)**
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -16,19 +16,6 @@ Brief Description
|
|||||||
|
|
||||||
Capsule shape for collisions.
|
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 **)** |
|
|
||||||
+----------------------------+-----------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -46,31 +33,3 @@ Description
|
|||||||
|
|
||||||
Capsule shape for collisions.
|
Capsule shape for collisions.
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_CapsuleShape_get_height:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_height** **(** **)** const
|
|
||||||
|
|
||||||
Return the capsule height.
|
|
||||||
|
|
||||||
.. _class_CapsuleShape_get_radius:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_radius** **(** **)** const
|
|
||||||
|
|
||||||
Return the capsule radius.
|
|
||||||
|
|
||||||
.. _class_CapsuleShape_set_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 **)**
|
|
||||||
|
|
||||||
Set the capsule radius.
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -16,19 +16,6 @@ Brief Description
|
|||||||
|
|
||||||
Capsule shape for 2D collisions.
|
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 **)** |
|
|
||||||
+----------------------------+-------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -46,31 +33,3 @@ Description
|
|||||||
|
|
||||||
Capsule shape for 2D collisions.
|
Capsule shape for 2D collisions.
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_CapsuleShape2D_get_height:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_height** **(** **)** const
|
|
||||||
|
|
||||||
Return the height of the ``CapsuleShape2D``.
|
|
||||||
|
|
||||||
.. _class_CapsuleShape2D_get_radius:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_radius** **(** **)** const
|
|
||||||
|
|
||||||
Return the radius of the ``CapsuleShape2D``.
|
|
||||||
|
|
||||||
.. _class_CapsuleShape2D_set_height:
|
|
||||||
|
|
||||||
- void **set_height** **(** :ref:`float<class_float>` height **)**
|
|
||||||
|
|
||||||
Set the height of the ``CapsuleShape2D``.
|
|
||||||
|
|
||||||
.. _class_CapsuleShape2D_set_radius:
|
|
||||||
|
|
||||||
- void **set_radius** **(** :ref:`float<class_float>` radius **)**
|
|
||||||
|
|
||||||
Set the radius of the ``CapsuleShape2D``.
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -16,15 +16,6 @@ Brief Description
|
|||||||
|
|
||||||
Keeps children controls centered.
|
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 **)** |
|
|
||||||
+--------------------------+------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -38,19 +29,3 @@ Description
|
|||||||
|
|
||||||
CenterContainer Keeps children controls centered. This container keeps all children to their minimum size, in the center.
|
CenterContainer Keeps children controls centered. This container keeps all children to their minimum size, in the center.
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_CenterContainer_is_using_top_left:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_using_top_left** **(** **)** const
|
|
||||||
|
|
||||||
Should put children to the top left corner instead of center of the container.
|
|
||||||
|
|
||||||
.. _class_CenterContainer_set_use_top_left:
|
|
||||||
|
|
||||||
- void **set_use_top_left** **(** :ref:`bool<class_bool>` enable **)**
|
|
||||||
|
|
||||||
This function will anchor the container children to the top left corner of the the container boundaries, moving all its children to that position, (the children new center will be the top left corner of the container).
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -16,15 +16,6 @@ Brief Description
|
|||||||
|
|
||||||
Circular shape for 2D collisions.
|
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 **)** |
|
|
||||||
+----------------------------+------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -38,19 +29,3 @@ Description
|
|||||||
|
|
||||||
Circular shape for 2D collisions. This shape is useful for modeling balls or small characters and its collision detection with everything else is very fast.
|
Circular shape for 2D collisions. This shape is useful for modeling balls or small characters and its collision detection with everything else is very fast.
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_CircleShape2D_get_radius:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_radius** **(** **)** const
|
|
||||||
|
|
||||||
Return the radius of the circle shape.
|
|
||||||
|
|
||||||
.. _class_CircleShape2D_set_radius:
|
|
||||||
|
|
||||||
- void **set_radius** **(** :ref:`float<class_float>` radius **)**
|
|
||||||
|
|
||||||
Set the radius of the circle shape.
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -26,22 +26,14 @@ Member Functions
|
|||||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`create_shape_owner<class_CollisionObject_create_shape_owner>` **(** :ref:`Object<class_object>` owner **)** |
|
| :ref:`int<class_int>` | :ref:`create_shape_owner<class_CollisionObject_create_shape_owner>` **(** :ref:`Object<class_object>` owner **)** |
|
||||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`get_capture_input_on_drag<class_CollisionObject_get_capture_input_on_drag>` **(** **)** const |
|
|
||||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`RID<class_rid>` | :ref:`get_rid<class_CollisionObject_get_rid>` **(** **)** const |
|
| :ref:`RID<class_rid>` | :ref:`get_rid<class_CollisionObject_get_rid>` **(** **)** const |
|
||||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Array<class_array>` | :ref:`get_shape_owners<class_CollisionObject_get_shape_owners>` **(** **)** |
|
| :ref:`Array<class_array>` | :ref:`get_shape_owners<class_CollisionObject_get_shape_owners>` **(** **)** |
|
||||||
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :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 |
|
| :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:`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 |
|
| :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_add_shape<class_CollisionObject_shape_owner_add_shape>` **(** :ref:`int<class_int>` owner_id, :ref:`Shape<class_shape>` shape **)** |
|
||||||
@@ -115,10 +107,6 @@ Member Function Description
|
|||||||
|
|
||||||
Creates a new shape owner for the given object. Returns ``owner_id`` of the new owner for future reference.
|
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
|
|
||||||
|
|
||||||
.. _class_CollisionObject_get_rid:
|
.. _class_CollisionObject_get_rid:
|
||||||
|
|
||||||
- :ref:`RID<class_rid>` **get_rid** **(** **)** const
|
- :ref:`RID<class_rid>` **get_rid** **(** **)** const
|
||||||
@@ -131,10 +119,6 @@ Returns the object's :ref:`RID<class_rid>`.
|
|||||||
|
|
||||||
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.
|
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
|
|
||||||
|
|
||||||
.. _class_CollisionObject_is_shape_owner_disabled:
|
.. _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
|
||||||
@@ -147,14 +131,6 @@ If ``true`` the shape owner and its shapes are disabled.
|
|||||||
|
|
||||||
Removes the given shape owner.
|
Removes the given shape owner.
|
||||||
|
|
||||||
.. _class_CollisionObject_set_capture_input_on_drag:
|
|
||||||
|
|
||||||
- void **set_capture_input_on_drag** **(** :ref:`bool<class_bool>` enable **)**
|
|
||||||
|
|
||||||
.. _class_CollisionObject_set_ray_pickable:
|
|
||||||
|
|
||||||
- void **set_ray_pickable** **(** :ref:`bool<class_bool>` ray_pickable **)**
|
|
||||||
|
|
||||||
.. _class_CollisionObject_shape_find_owner:
|
.. _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
|
||||||
|
|||||||
@@ -30,16 +30,12 @@ Member Functions
|
|||||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Array<class_array>` | :ref:`get_shape_owners<class_CollisionObject2D_get_shape_owners>` **(** **)** |
|
| :ref:`Array<class_array>` | :ref:`get_shape_owners<class_CollisionObject2D_get_shape_owners>` **(** **)** |
|
||||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_pickable<class_CollisionObject2D_is_pickable>` **(** **)** const |
|
|
||||||
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_shape_owner_disabled<class_CollisionObject2D_is_shape_owner_disabled>` **(** :ref:`int<class_int>` owner_id **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_shape_owner_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 |
|
| :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:`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 |
|
| :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_add_shape<class_CollisionObject2D_shape_owner_add_shape>` **(** :ref:`int<class_int>` owner_id, :ref:`Shape2D<class_shape2d>` shape **)** |
|
||||||
@@ -125,12 +121,6 @@ Returns the object's :ref:`RID<class_rid>`.
|
|||||||
|
|
||||||
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.
|
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
|
|
||||||
|
|
||||||
Return whether this object is pickable.
|
|
||||||
|
|
||||||
.. _class_CollisionObject2D_is_shape_owner_disabled:
|
.. _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
|
||||||
@@ -147,12 +137,6 @@ If ``true`` the shape owner and its shapes are disabled.
|
|||||||
|
|
||||||
Removes the given shape owner.
|
Removes the given shape owner.
|
||||||
|
|
||||||
.. _class_CollisionObject2D_set_pickable:
|
|
||||||
|
|
||||||
- void **set_pickable** **(** :ref:`bool<class_bool>` enabled **)**
|
|
||||||
|
|
||||||
Set whether this object is pickable. A pickable object can detect the mouse pointer enter/leave it and, if the mouse is inside it, report input events.
|
|
||||||
|
|
||||||
.. _class_CollisionObject2D_shape_find_owner:
|
.. _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
|
||||||
|
|||||||
@@ -16,23 +16,6 @@ Brief Description
|
|||||||
|
|
||||||
Editor-only class for defining a collision polygon in 3D space.
|
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 **)** |
|
|
||||||
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -54,31 +37,3 @@ Description
|
|||||||
|
|
||||||
Allows editing a collision polygon's vertices on a selected plane. Can also set a depth perpendicular to that plane. This class is only available in the editor. It will not appear in the scene tree at runtime. Creates a :ref:`Shape<class_shape>` for gameplay. Properties modified during gameplay will have no effect.
|
Allows editing a collision polygon's vertices on a selected plane. Can also set a depth perpendicular to that plane. This class is only available in the editor. It will not appear in the scene tree at runtime. Creates a :ref:`Shape<class_shape>` for gameplay. Properties modified during gameplay will have no effect.
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_CollisionPolygon_get_depth:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_depth** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_CollisionPolygon_get_polygon:
|
|
||||||
|
|
||||||
- :ref:`PoolVector2Array<class_poolvector2array>` **get_polygon** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_CollisionPolygon_is_disabled:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_disabled** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_CollisionPolygon_set_depth:
|
|
||||||
|
|
||||||
- void **set_depth** **(** :ref:`float<class_float>` depth **)**
|
|
||||||
|
|
||||||
.. _class_CollisionPolygon_set_disabled:
|
|
||||||
|
|
||||||
- void **set_disabled** **(** :ref:`bool<class_bool>` disabled **)**
|
|
||||||
|
|
||||||
.. _class_CollisionPolygon_set_polygon:
|
|
||||||
|
|
||||||
- void **set_polygon** **(** :ref:`PoolVector2Array<class_poolvector2array>` polygon **)**
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -16,27 +16,6 @@ Brief Description
|
|||||||
|
|
||||||
Defines a 2D collision polygon.
|
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 **)** |
|
|
||||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -68,49 +47,3 @@ Description
|
|||||||
|
|
||||||
Provides a 2D collision polygon to a :ref:`CollisionObject2D<class_collisionobject2d>` parent. Polygon can be drawn in the editor or specified by a list of vertices.
|
Provides a 2D collision polygon to a :ref:`CollisionObject2D<class_collisionobject2d>` parent. Polygon can be drawn in the editor or specified by a list of vertices.
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_CollisionPolygon2D_get_build_mode:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_build_mode** **(** **)** const
|
|
||||||
|
|
||||||
Return whether the polygon is a :ref:`ConvexPolygonShape2D<class_convexpolygonshape2d>` (``build_mode==0``), or a :ref:`ConcavePolygonShape2D<class_concavepolygonshape2d>` (``build_mode==1``).
|
|
||||||
|
|
||||||
.. _class_CollisionPolygon2D_get_polygon:
|
|
||||||
|
|
||||||
- :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
|
|
||||||
|
|
||||||
.. _class_CollisionPolygon2D_is_one_way_collision_enabled:
|
|
||||||
|
|
||||||
- :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 **)**
|
|
||||||
|
|
||||||
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 **)**
|
|
||||||
|
|
||||||
.. _class_CollisionPolygon2D_set_one_way_collision:
|
|
||||||
|
|
||||||
- void **set_one_way_collision** **(** :ref:`bool<class_bool>` enabled **)**
|
|
||||||
|
|
||||||
.. _class_CollisionPolygon2D_set_polygon:
|
|
||||||
|
|
||||||
- void **set_polygon** **(** :ref:`PoolVector2Array<class_poolvector2array>` polygon **)**
|
|
||||||
|
|
||||||
Set the array of points forming the polygon.
|
|
||||||
|
|
||||||
When editing the point list via the editor, depending on :ref:`get_build_mode<class_CollisionPolygon2D_get_build_mode>`, it has to be a list of points (for ``build_mode==0``), or a list of lines (for ``build_mode==1``). In the second case, the even elements of the array define the start point of the line, and the odd elements the end point.
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -19,19 +19,11 @@ Node that represents collision shape data in 3D space.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------+
|
+-------+---------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Shape<class_shape>` | :ref:`get_shape<class_CollisionShape_get_shape>` **(** **)** const |
|
| void | :ref:`make_convex_from_brothers<class_CollisionShape_make_convex_from_brothers>` **(** **)** |
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------+
|
+-------+---------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_disabled<class_CollisionShape_is_disabled>` **(** **)** const |
|
| void | :ref:`resource_changed<class_CollisionShape_resource_changed>` **(** :ref:`Resource<class_resource>` resource **)** |
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------+
|
+-------+---------------------------------------------------------------------------------------------------------------------+
|
||||||
| 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
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
@@ -53,14 +45,6 @@ Editor facility for creating and editing collision shapes in 3D space. You can u
|
|||||||
Member Function Description
|
Member Function Description
|
||||||
---------------------------
|
---------------------------
|
||||||
|
|
||||||
.. _class_CollisionShape_get_shape:
|
|
||||||
|
|
||||||
- :ref:`Shape<class_shape>` **get_shape** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_CollisionShape_is_disabled:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_disabled** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_CollisionShape_make_convex_from_brothers:
|
.. _class_CollisionShape_make_convex_from_brothers:
|
||||||
|
|
||||||
- void **make_convex_from_brothers** **(** **)**
|
- void **make_convex_from_brothers** **(** **)**
|
||||||
@@ -73,12 +57,4 @@ Sets the collision shape's shape to the addition of all its convexed :ref:`MeshI
|
|||||||
|
|
||||||
If this method exists within a script it will be called whenever the shape resource has been modified.
|
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 **)**
|
|
||||||
|
|
||||||
.. _class_CollisionShape_set_shape:
|
|
||||||
|
|
||||||
- void **set_shape** **(** :ref:`Shape<class_shape>` shape **)**
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -16,23 +16,6 @@ Brief Description
|
|||||||
|
|
||||||
Node that represents collision shape data in 2D space.
|
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 **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -54,31 +37,3 @@ Description
|
|||||||
|
|
||||||
Editor facility for creating and editing collision shapes in 2D space. You can use this node to represent all sorts of collision shapes, for example, add this to an :ref:`Area2D<class_area2d>` to give it a detection shape, or add it to a :ref:`PhysicsBody2D<class_physicsbody2d>` to give create solid object. **IMPORTANT**: this is an Editor-only helper to create shapes, use :ref:`get_shape<class_CollisionShape2D_get_shape>` to get the actual shape.
|
Editor facility for creating and editing collision shapes in 2D space. You can use this node to represent all sorts of collision shapes, for example, add this to an :ref:`Area2D<class_area2d>` to give it a detection shape, or add it to a :ref:`PhysicsBody2D<class_physicsbody2d>` to give create solid object. **IMPORTANT**: this is an Editor-only helper to create shapes, use :ref:`get_shape<class_CollisionShape2D_get_shape>` to get the actual shape.
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_CollisionShape2D_get_shape:
|
|
||||||
|
|
||||||
- :ref:`Shape2D<class_shape2d>` **get_shape** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_CollisionShape2D_is_disabled:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_disabled** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_CollisionShape2D_is_one_way_collision_enabled:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_one_way_collision_enabled** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_CollisionShape2D_set_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 **)**
|
|
||||||
|
|
||||||
.. _class_CollisionShape2D_set_shape:
|
|
||||||
|
|
||||||
- void **set_shape** **(** :ref:`Shape2D<class_shape2d>` shape **)**
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -30,10 +30,14 @@ Member Functions
|
|||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Color<class_color>` | :ref:`contrasted<class_Color_contrasted>` **(** **)** |
|
| :ref:`Color<class_color>` | :ref:`contrasted<class_Color_contrasted>` **(** **)** |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`Color<class_color>` | :ref:`darkened<class_Color_darkened>` **(** :ref:`float<class_float>` amount **)** |
|
||||||
|
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`gray<class_Color_gray>` **(** **)** |
|
| :ref:`float<class_float>` | :ref:`gray<class_Color_gray>` **(** **)** |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Color<class_color>` | :ref:`inverted<class_Color_inverted>` **(** **)** |
|
| :ref:`Color<class_color>` | :ref:`inverted<class_Color_inverted>` **(** **)** |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`Color<class_color>` | :ref:`lightened<class_Color_lightened>` **(** :ref:`float<class_float>` amount **)** |
|
||||||
|
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Color<class_color>` | :ref:`linear_interpolate<class_Color_linear_interpolate>` **(** :ref:`Color<class_color>` b, :ref:`float<class_float>` t **)** |
|
| :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:`int<class_int>` | :ref:`to_argb32<class_Color_to_argb32>` **(** **)** |
|
||||||
@@ -176,6 +180,17 @@ Returns the most contrasting color.
|
|||||||
var c = Color(.3, .4, .9)
|
var c = Color(.3, .4, .9)
|
||||||
var contrastedColor = c.contrasted() # a color of an RGBA(204, 229, 102, 255)
|
var contrastedColor = c.contrasted() # a color of an RGBA(204, 229, 102, 255)
|
||||||
|
|
||||||
|
.. _class_Color_darkened:
|
||||||
|
|
||||||
|
- :ref:`Color<class_color>` **darkened** **(** :ref:`float<class_float>` amount **)**
|
||||||
|
|
||||||
|
Returns a new color resulting from making this color darker by the specified percentage (0-1).
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
var green = Color(0.0, 1.0, 0.0)
|
||||||
|
var darkgreen = green.darkened(0.2) # 20% darker than regular green
|
||||||
|
|
||||||
.. _class_Color_gray:
|
.. _class_Color_gray:
|
||||||
|
|
||||||
- :ref:`float<class_float>` **gray** **(** **)**
|
- :ref:`float<class_float>` **gray** **(** **)**
|
||||||
@@ -200,6 +215,17 @@ Returns the inverted color (1-r, 1-g, 1-b, 1-a).
|
|||||||
var c = Color(.3, .4, .9)
|
var c = Color(.3, .4, .9)
|
||||||
var invertedColor = c.inverted() # a color of an RGBA(178, 153, 26, 255)
|
var invertedColor = c.inverted() # a color of an RGBA(178, 153, 26, 255)
|
||||||
|
|
||||||
|
.. _class_Color_lightened:
|
||||||
|
|
||||||
|
- :ref:`Color<class_color>` **lightened** **(** :ref:`float<class_float>` amount **)**
|
||||||
|
|
||||||
|
Returns a new color resulting from making this color lighter by the specified percentage (0-1).
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
var green = Color(0.0, 1.0, 0.0)
|
||||||
|
var lightgreen = green.lightened(0.2) # 20% lighter than regular green
|
||||||
|
|
||||||
.. _class_Color_linear_interpolate:
|
.. _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 **)**
|
||||||
|
|||||||
@@ -19,17 +19,9 @@ Button that pops out a :ref:`ColorPicker<class_colorpicker>`
|
|||||||
Member Functions
|
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:`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
|
Signals
|
||||||
-------
|
-------
|
||||||
@@ -61,37 +53,8 @@ Encapsulates a :ref:`ColorPicker<class_colorpicker>` making it accesible by pres
|
|||||||
Member Function Description
|
Member Function Description
|
||||||
---------------------------
|
---------------------------
|
||||||
|
|
||||||
.. _class_ColorPickerButton_get_pick_color:
|
|
||||||
|
|
||||||
- :ref:`Color<class_color>` **get_pick_color** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_ColorPickerButton_get_picker:
|
.. _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
|
|
||||||
|
|
||||||
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 **)**
|
|
||||||
|
|
||||||
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 **)**
|
|
||||||
|
|
||||||
Set new color to ColorRect.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
::
|
|
||||||
|
|
||||||
var cr = get_node("colorrect_node")
|
|
||||||
cr.set_frame_color(Color(1, 0, 0, 1)) # Set color rect node to red
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -16,15 +16,6 @@ Brief Description
|
|||||||
|
|
||||||
Colored rect for canvas.
|
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 **)** |
|
|
||||||
+----------------------------+-----------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -42,29 +33,3 @@ Description
|
|||||||
|
|
||||||
An object that is represented on the canvas as a rect with color. :ref:`Color<class_color>` is used to set or get color info for the rect.
|
An object that is represented on the canvas as a rect with color. :ref:`Color<class_color>` is used to set or get color info for the rect.
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_ColorRect_get_frame_color:
|
|
||||||
|
|
||||||
- :ref:`Color<class_color>` **get_frame_color** **(** **)** const
|
|
||||||
|
|
||||||
Return the color in RGBA format.
|
|
||||||
|
|
||||||
::
|
|
||||||
|
|
||||||
var cr = get_node("colorrect_node")
|
|
||||||
var c = cr.get_frame_color() # Default color is white
|
|
||||||
|
|
||||||
.. _class_ColorRect_set_frame_color:
|
|
||||||
|
|
||||||
- void **set_frame_color** **(** :ref:`Color<class_color>` color **)**
|
|
||||||
|
|
||||||
Set new color to ColorRect.
|
|
||||||
|
|
||||||
::
|
|
||||||
|
|
||||||
var cr = get_node("colorrect_node")
|
|
||||||
cr.set_frame_color(Color(1, 0, 0, 1)) # Set color rect node to red
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -16,15 +16,6 @@ Brief Description
|
|||||||
|
|
||||||
Concave polygon 2D shape resource for physics.
|
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 **)** |
|
|
||||||
+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -40,19 +31,3 @@ Concave polygon 2D shape resource for physics. It is made out of segments and is
|
|||||||
|
|
||||||
The main difference between a :ref:`ConvexPolygonShape2D<class_convexpolygonshape2d>` and a ``ConcavePolygonShape2D`` is that a concave polygon assumes it is concave and uses a more complex method of collision detection, and a convex one forces itself to be convex in order to speed up collision detection.
|
The main difference between a :ref:`ConvexPolygonShape2D<class_convexpolygonshape2d>` and a ``ConcavePolygonShape2D`` is that a concave polygon assumes it is concave and uses a more complex method of collision detection, and a convex one forces itself to be convex in order to speed up collision detection.
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_ConcavePolygonShape2D_get_segments:
|
|
||||||
|
|
||||||
- :ref:`PoolVector2Array<class_poolvector2array>` **get_segments** **(** **)** const
|
|
||||||
|
|
||||||
Return the array of segments.
|
|
||||||
|
|
||||||
.. _class_ConcavePolygonShape2D_set_segments:
|
|
||||||
|
|
||||||
- void **set_segments** **(** :ref:`PoolVector2Array<class_poolvector2array>` segments **)**
|
|
||||||
|
|
||||||
Set the array of segments.
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -16,15 +16,6 @@ Brief Description
|
|||||||
|
|
||||||
A twist joint between two 3D bodies
|
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 **)** |
|
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -88,15 +79,3 @@ The twist axis is initiated as the x-axis of the :ref:`Joint<class_joint>`.
|
|||||||
|
|
||||||
Once the Bodies swing, the twist axis is calculated as the middle of the x-axes of the Joint in the local space of the two Bodies.
|
Once the Bodies swing, the twist axis is calculated as the middle of the x-axes of the Joint in the local space of the two Bodies.
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_ConeTwistJoint_get_param:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_param** **(** :ref:`int<class_int>` param **)** const
|
|
||||||
|
|
||||||
.. _class_ConeTwistJoint_set_param:
|
|
||||||
|
|
||||||
- void **set_param** **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)**
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -111,13 +111,13 @@ Returns ``true`` if the specified section-key pair exists.
|
|||||||
|
|
||||||
- :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``.
|
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:`@GlobalScope<class_@globalscope>`. If the load was successful, the return value is ``OK``.
|
||||||
|
|
||||||
.. _class_ConfigFile_save:
|
.. _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``.
|
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:`@GlobalScope<class_@globalscope>`. If the load was successful, the return value is ``OK``.
|
||||||
|
|
||||||
.. _class_ConfigFile_set_value:
|
.. _class_ConfigFile_set_value:
|
||||||
|
|
||||||
|
|||||||
+10
-250
@@ -9,7 +9,7 @@ Control
|
|||||||
|
|
||||||
**Inherits:** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
|
**Inherits:** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
|
||||||
|
|
||||||
**Inherited By:** :ref:`TextureRect<class_texturerect>`, :ref:`ColorRect<class_colorrect>`, :ref:`Label<class_label>`, :ref:`Tabs<class_tabs>`, :ref:`GraphEdit<class_graphedit>`, :ref:`VideoPlayer<class_videoplayer>`, :ref:`NinePatchRect<class_ninepatchrect>`, :ref:`LineEdit<class_lineedit>`, :ref:`TextEdit<class_textedit>`, :ref:`BaseButton<class_basebutton>`, :ref:`Popup<class_popup>`, :ref:`Tree<class_tree>`, :ref:`Separator<class_separator>`, :ref:`ReferenceRect<class_referencerect>`, :ref:`Container<class_container>`, :ref:`Panel<class_panel>`, :ref:`TabContainer<class_tabcontainer>`, :ref:`Range<class_range>`, :ref:`RichTextLabel<class_richtextlabel>`, :ref:`ItemList<class_itemlist>`
|
**Inherited By:** :ref:`TextureRect<class_texturerect>`, :ref:`ColorRect<class_colorrect>`, :ref:`Label<class_label>`, :ref:`Tabs<class_tabs>`, :ref:`GraphEdit<class_graphedit>`, :ref:`VideoPlayer<class_videoplayer>`, :ref:`NinePatchRect<class_ninepatchrect>`, :ref:`LineEdit<class_lineedit>`, :ref:`Container<class_container>`, :ref:`TextEdit<class_textedit>`, :ref:`BaseButton<class_basebutton>`, :ref:`Popup<class_popup>`, :ref:`Tree<class_tree>`, :ref:`Separator<class_separator>`, :ref:`ReferenceRect<class_referencerect>`, :ref:`Panel<class_panel>`, :ref:`TabContainer<class_tabcontainer>`, :ref:`Range<class_range>`, :ref:`RichTextLabel<class_richtextlabel>`, :ref:`ItemList<class_itemlist>`
|
||||||
|
|
||||||
**Category:** Core
|
**Category:** Core
|
||||||
|
|
||||||
@@ -46,8 +46,6 @@ Member Functions
|
|||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`force_drag<class_Control_force_drag>` **(** :ref:`Variant<class_variant>` data, :ref:`Control<class_control>` preview **)** |
|
| void | :ref:`force_drag<class_Control_force_drag>` **(** :ref:`Variant<class_variant>` data, :ref:`Control<class_control>` preview **)** |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_anchor<class_Control_get_anchor>` **(** :ref:`int<class_int>` margin **)** const |
|
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_begin<class_Control_get_begin>` **(** **)** const |
|
| :ref:`Vector2<class_vector2>` | :ref:`get_begin<class_Control_get_begin>` **(** **)** const |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Color<class_color>` | :ref:`get_color<class_Control_get_color>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const |
|
| :ref:`Color<class_color>` | :ref:`get_color<class_Control_get_color>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const |
|
||||||
@@ -58,8 +56,6 @@ Member Functions
|
|||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_cursor_shape<class_Control_get_cursor_shape>` **(** :ref:`Vector2<class_vector2>` position=Vector2( 0, 0 ) **)** const |
|
| :ref:`int<class_int>` | :ref:`get_cursor_shape<class_Control_get_cursor_shape>` **(** :ref:`Vector2<class_vector2>` position=Vector2( 0, 0 ) **)** const |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_custom_minimum_size<class_Control_get_custom_minimum_size>` **(** **)** const |
|
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`int<class_int>` | :ref:`get_default_cursor_shape<class_Control_get_default_cursor_shape>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_default_cursor_shape<class_Control_get_default_cursor_shape>` **(** **)** const |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Object<class_object>` | :ref:`get_drag_data<class_Control_get_drag_data>` **(** :ref:`Vector2<class_vector2>` position **)** virtual |
|
| :ref:`Object<class_object>` | :ref:`get_drag_data<class_Control_get_drag_data>` **(** :ref:`Vector2<class_vector2>` position **)** virtual |
|
||||||
@@ -68,8 +64,6 @@ Member Functions
|
|||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_focus_mode<class_Control_get_focus_mode>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_focus_mode<class_Control_get_focus_mode>` **(** **)** const |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`NodePath<class_nodepath>` | :ref:`get_focus_neighbour<class_Control_get_focus_neighbour>` **(** :ref:`int<class_int>` margin **)** const |
|
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`Control<class_control>` | :ref:`get_focus_owner<class_Control_get_focus_owner>` **(** **)** const |
|
| :ref:`Control<class_control>` | :ref:`get_focus_owner<class_Control_get_focus_owner>` **(** **)** const |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Font<class_font>` | :ref:`get_font<class_Control_get_font>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const |
|
| :ref:`Font<class_font>` | :ref:`get_font<class_Control_get_font>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const |
|
||||||
@@ -78,48 +72,22 @@ Member Functions
|
|||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Rect2<class_rect2>` | :ref:`get_global_rect<class_Control_get_global_rect>` **(** **)** const |
|
| :ref:`Rect2<class_rect2>` | :ref:`get_global_rect<class_Control_get_global_rect>` **(** **)** const |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_h_grow_direction<class_Control_get_h_grow_direction>` **(** **)** const |
|
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`int<class_int>` | :ref:`get_h_size_flags<class_Control_get_h_size_flags>` **(** **)** const |
|
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`Texture<class_texture>` | :ref:`get_icon<class_Control_get_icon>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const |
|
| :ref:`Texture<class_texture>` | :ref:`get_icon<class_Control_get_icon>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_margin<class_Control_get_margin>` **(** :ref:`int<class_int>` margin **)** const |
|
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_minimum_size<class_Control_get_minimum_size>` **(** **)** const |
|
| :ref:`Vector2<class_vector2>` | :ref:`get_minimum_size<class_Control_get_minimum_size>` **(** **)** const |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_mouse_filter<class_Control_get_mouse_filter>` **(** **)** const |
|
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_parent_area_size<class_Control_get_parent_area_size>` **(** **)** const |
|
| :ref:`Vector2<class_vector2>` | :ref:`get_parent_area_size<class_Control_get_parent_area_size>` **(** **)** const |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Control<class_control>` | :ref:`get_parent_control<class_Control_get_parent_control>` **(** **)** const |
|
| :ref:`Control<class_control>` | :ref:`get_parent_control<class_Control_get_parent_control>` **(** **)** const |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_pivot_offset<class_Control_get_pivot_offset>` **(** **)** const |
|
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_position<class_Control_get_position>` **(** **)** const |
|
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`Rect2<class_rect2>` | :ref:`get_rect<class_Control_get_rect>` **(** **)** const |
|
| :ref:`Rect2<class_rect2>` | :ref:`get_rect<class_Control_get_rect>` **(** **)** const |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_rotation<class_Control_get_rotation>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_rotation<class_Control_get_rotation>` **(** **)** const |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_rotation_degrees<class_Control_get_rotation_degrees>` **(** **)** const |
|
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_scale<class_Control_get_scale>` **(** **)** const |
|
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`Vector2<class_vector2>` | :ref:`get_size<class_Control_get_size>` **(** **)** const |
|
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_stretch_ratio<class_Control_get_stretch_ratio>` **(** **)** const |
|
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`StyleBox<class_stylebox>` | :ref:`get_stylebox<class_Control_get_stylebox>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const |
|
| :ref:`StyleBox<class_stylebox>` | :ref:`get_stylebox<class_Control_get_stylebox>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Theme<class_theme>` | :ref:`get_theme<class_Control_get_theme>` **(** **)** const |
|
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`String<class_string>` | :ref:`get_tooltip<class_Control_get_tooltip>` **(** :ref:`Vector2<class_vector2>` at_position=Vector2( 0, 0 ) **)** const |
|
| :ref:`String<class_string>` | :ref:`get_tooltip<class_Control_get_tooltip>` **(** :ref:`Vector2<class_vector2>` at_position=Vector2( 0, 0 ) **)** const |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_v_grow_direction<class_Control_get_v_grow_direction>` **(** **)** const |
|
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`int<class_int>` | :ref:`get_v_size_flags<class_Control_get_v_size_flags>` **(** **)** const |
|
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`grab_click_focus<class_Control_grab_click_focus>` **(** **)** |
|
| void | :ref:`grab_click_focus<class_Control_grab_click_focus>` **(** **)** |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`grab_focus<class_Control_grab_focus>` **(** **)** |
|
| void | :ref:`grab_focus<class_Control_grab_focus>` **(** **)** |
|
||||||
@@ -148,8 +116,6 @@ Member Functions
|
|||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`has_stylebox_override<class_Control_has_stylebox_override>` **(** :ref:`String<class_string>` name **)** const |
|
| :ref:`bool<class_bool>` | :ref:`has_stylebox_override<class_Control_has_stylebox_override>` **(** :ref:`String<class_string>` name **)** const |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_clipping_contents<class_Control_is_clipping_contents>` **(** **)** |
|
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`minimum_size_changed<class_Control_minimum_size_changed>` **(** **)** |
|
| void | :ref:`minimum_size_changed<class_Control_minimum_size_changed>` **(** **)** |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`release_focus<class_Control_release_focus>` **(** **)** |
|
| void | :ref:`release_focus<class_Control_release_focus>` **(** **)** |
|
||||||
@@ -164,10 +130,6 @@ Member Functions
|
|||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_begin<class_Control_set_begin>` **(** :ref:`Vector2<class_vector2>` position **)** |
|
| void | :ref:`set_begin<class_Control_set_begin>` **(** :ref:`Vector2<class_vector2>` position **)** |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_clip_contents<class_Control_set_clip_contents>` **(** :ref:`bool<class_bool>` enable **)** |
|
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_custom_minimum_size<class_Control_set_custom_minimum_size>` **(** :ref:`Vector2<class_vector2>` size **)** |
|
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_default_cursor_shape<class_Control_set_default_cursor_shape>` **(** :ref:`int<class_int>` shape **)** |
|
| void | :ref:`set_default_cursor_shape<class_Control_set_default_cursor_shape>` **(** :ref:`int<class_int>` shape **)** |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_drag_forwarding<class_Control_set_drag_forwarding>` **(** :ref:`Control<class_control>` target **)** |
|
| void | :ref:`set_drag_forwarding<class_Control_set_drag_forwarding>` **(** :ref:`Control<class_control>` target **)** |
|
||||||
@@ -178,42 +140,12 @@ Member Functions
|
|||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_focus_mode<class_Control_set_focus_mode>` **(** :ref:`int<class_int>` mode **)** |
|
| void | :ref:`set_focus_mode<class_Control_set_focus_mode>` **(** :ref:`int<class_int>` mode **)** |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_focus_neighbour<class_Control_set_focus_neighbour>` **(** :ref:`int<class_int>` margin, :ref:`NodePath<class_nodepath>` neighbour **)** |
|
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_global_position<class_Control_set_global_position>` **(** :ref:`Vector2<class_vector2>` position **)** |
|
| void | :ref:`set_global_position<class_Control_set_global_position>` **(** :ref:`Vector2<class_vector2>` position **)** |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_h_grow_direction<class_Control_set_h_grow_direction>` **(** :ref:`int<class_int>` direction **)** |
|
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_h_size_flags<class_Control_set_h_size_flags>` **(** :ref:`int<class_int>` flags **)** |
|
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_margin<class_Control_set_margin>` **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` offset **)** |
|
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_margins_preset<class_Control_set_margins_preset>` **(** :ref:`int<class_int>` preset, :ref:`int<class_int>` resize_mode=0, :ref:`int<class_int>` margin=0 **)** |
|
| void | :ref:`set_margins_preset<class_Control_set_margins_preset>` **(** :ref:`int<class_int>` preset, :ref:`int<class_int>` resize_mode=0, :ref:`int<class_int>` margin=0 **)** |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_mouse_filter<class_Control_set_mouse_filter>` **(** :ref:`int<class_int>` filter **)** |
|
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_pivot_offset<class_Control_set_pivot_offset>` **(** :ref:`Vector2<class_vector2>` pivot_offset **)** |
|
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_position<class_Control_set_position>` **(** :ref:`Vector2<class_vector2>` position **)** |
|
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_rotation<class_Control_set_rotation>` **(** :ref:`float<class_float>` radians **)** |
|
| void | :ref:`set_rotation<class_Control_set_rotation>` **(** :ref:`float<class_float>` radians **)** |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_rotation_degrees<class_Control_set_rotation_degrees>` **(** :ref:`float<class_float>` degrees **)** |
|
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_scale<class_Control_set_scale>` **(** :ref:`Vector2<class_vector2>` scale **)** |
|
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_size<class_Control_set_size>` **(** :ref:`Vector2<class_vector2>` size **)** |
|
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_stretch_ratio<class_Control_set_stretch_ratio>` **(** :ref:`float<class_float>` ratio **)** |
|
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_theme<class_Control_set_theme>` **(** :ref:`Theme<class_theme>` theme **)** |
|
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_tooltip<class_Control_set_tooltip>` **(** :ref:`String<class_string>` tooltip **)** |
|
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_v_grow_direction<class_Control_set_v_grow_direction>` **(** :ref:`int<class_int>` direction **)** |
|
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_v_size_flags<class_Control_set_v_size_flags>` **(** :ref:`int<class_int>` flags **)** |
|
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`show_modal<class_Control_show_modal>` **(** :ref:`bool<class_bool>` exclusive=false **)** |
|
| void | :ref:`show_modal<class_Control_show_modal>` **(** :ref:`bool<class_bool>` exclusive=false **)** |
|
||||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`warp_mouse<class_Control_warp_mouse>` **(** :ref:`Vector2<class_vector2>` to_position **)** |
|
| void | :ref:`warp_mouse<class_Control_warp_mouse>` **(** :ref:`Vector2<class_vector2>` to_position **)** |
|
||||||
@@ -314,6 +246,14 @@ If the user presses Tab, Godot will give focus to the closest node to the right
|
|||||||
|
|
||||||
- :ref:`NodePath<class_nodepath>` **focus_neighbour_top** - Tells Godot which node it should give keyboard focus to if the user presses Shift+Tab, the top arrow on the keyboard or top on a gamepad. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the bottom of this one.
|
- :ref:`NodePath<class_nodepath>` **focus_neighbour_top** - Tells Godot which node it should give keyboard focus to if the user presses Shift+Tab, the top arrow on the keyboard or top on a gamepad. The node must be a ``Control``. If this property is not set, Godot will give focus to the closest ``Control`` to the bottom of this one.
|
||||||
|
|
||||||
|
.. _class_Control_focus_next:
|
||||||
|
|
||||||
|
- :ref:`NodePath<class_nodepath>` **focus_next**
|
||||||
|
|
||||||
|
.. _class_Control_focus_previous:
|
||||||
|
|
||||||
|
- :ref:`NodePath<class_nodepath>` **focus_previous**
|
||||||
|
|
||||||
.. _class_Control_grow_horizontal:
|
.. _class_Control_grow_horizontal:
|
||||||
|
|
||||||
- :ref:`int<class_int>` **grow_horizontal**
|
- :ref:`int<class_int>` **grow_horizontal**
|
||||||
@@ -506,7 +446,7 @@ Overrides the color in the theme resource the node uses.
|
|||||||
|
|
||||||
- void **add_constant_override** **(** :ref:`String<class_string>` name, :ref:`int<class_int>` constant **)**
|
- void **add_constant_override** **(** :ref:`String<class_string>` name, :ref:`int<class_int>` constant **)**
|
||||||
|
|
||||||
Overrides an integer constant in the theme resource the node uses. If the ``constant[code] is invalid, Godot clears the override. See [member Theme.INVALID_CONSTANT] for more information.
|
Overrides an integer constant in the :ref:`Theme<class_theme>` resource the node uses. If the ``constant`` is invalid, Godot clears the override. See :ref:`Theme.INVALID_CONSTANT<class_Theme_INVALID_CONSTANT>` for more information.
|
||||||
|
|
||||||
.. _class_Control_add_font_override:
|
.. _class_Control_add_font_override:
|
||||||
|
|
||||||
@@ -544,12 +484,6 @@ Overrides the ``name`` Stylebox in the theme resource the node uses. If ``styleb
|
|||||||
|
|
||||||
- void **force_drag** **(** :ref:`Variant<class_variant>` data, :ref:`Control<class_control>` preview **)**
|
- void **force_drag** **(** :ref:`Variant<class_variant>` data, :ref:`Control<class_control>` preview **)**
|
||||||
|
|
||||||
.. _class_Control_get_anchor:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_anchor** **(** :ref:`int<class_int>` margin **)** const
|
|
||||||
|
|
||||||
Return the anchor type (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) for a given margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM).
|
|
||||||
|
|
||||||
.. _class_Control_get_begin:
|
.. _class_Control_get_begin:
|
||||||
|
|
||||||
- :ref:`Vector2<class_vector2>` **get_begin** **(** **)** const
|
- :ref:`Vector2<class_vector2>` **get_begin** **(** **)** const
|
||||||
@@ -572,10 +506,6 @@ Return the anchor type (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) for a given marg
|
|||||||
|
|
||||||
Returns the mouse cursor shape the control displays on mouse hover, one of the ``CURSOR\_\*`` constants.
|
Returns the mouse cursor shape the control displays on mouse hover, one of the ``CURSOR\_\*`` constants.
|
||||||
|
|
||||||
.. _class_Control_get_custom_minimum_size:
|
|
||||||
|
|
||||||
- :ref:`Vector2<class_vector2>` **get_custom_minimum_size** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Control_get_default_cursor_shape:
|
.. _class_Control_get_default_cursor_shape:
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_default_cursor_shape** **(** **)** const
|
- :ref:`int<class_int>` **get_default_cursor_shape** **(** **)** const
|
||||||
@@ -598,12 +528,6 @@ Returns MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see :ref:
|
|||||||
|
|
||||||
Returns the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL) (see :ref:`set_focus_mode<class_Control_set_focus_mode>`).
|
Returns the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL) (see :ref:`set_focus_mode<class_Control_set_focus_mode>`).
|
||||||
|
|
||||||
.. _class_Control_get_focus_neighbour:
|
|
||||||
|
|
||||||
- :ref:`NodePath<class_nodepath>` **get_focus_neighbour** **(** :ref:`int<class_int>` margin **)** const
|
|
||||||
|
|
||||||
Return the forced neighbour for moving the input focus to. When pressing TAB or directional/joypad directions focus is moved to the next control in that direction. However, the neighbour to move to can be forced with this function.
|
|
||||||
|
|
||||||
.. _class_Control_get_focus_owner:
|
.. _class_Control_get_focus_owner:
|
||||||
|
|
||||||
- :ref:`Control<class_control>` **get_focus_owner** **(** **)** const
|
- :ref:`Control<class_control>` **get_focus_owner** **(** **)** const
|
||||||
@@ -626,38 +550,16 @@ Returns the Control position, relative to the top-left corner of the parent Cont
|
|||||||
|
|
||||||
Return position and size of the Control, relative to the top-left corner of the *window* Control. This is a helper (see :ref:`get_global_position<class_Control_get_global_position>`, :ref:`get_size<class_Control_get_size>`).
|
Return position and size of the Control, relative to the top-left corner of the *window* Control. This is a helper (see :ref:`get_global_position<class_Control_get_global_position>`, :ref:`get_size<class_Control_get_size>`).
|
||||||
|
|
||||||
.. _class_Control_get_h_grow_direction:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_h_grow_direction** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Control_get_h_size_flags:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_h_size_flags** **(** **)** const
|
|
||||||
|
|
||||||
Hint for containers, return horizontal positioning flags.
|
|
||||||
|
|
||||||
.. _class_Control_get_icon:
|
.. _class_Control_get_icon:
|
||||||
|
|
||||||
- :ref:`Texture<class_texture>` **get_icon** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const
|
- :ref:`Texture<class_texture>` **get_icon** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const
|
||||||
|
|
||||||
.. _class_Control_get_margin:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_margin** **(** :ref:`int<class_int>` margin **)** const
|
|
||||||
|
|
||||||
Return a margin offset. Margin can be one of (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Offset value being returned depends on the anchor mode.
|
|
||||||
|
|
||||||
.. _class_Control_get_minimum_size:
|
.. _class_Control_get_minimum_size:
|
||||||
|
|
||||||
- :ref:`Vector2<class_vector2>` **get_minimum_size** **(** **)** const
|
- :ref:`Vector2<class_vector2>` **get_minimum_size** **(** **)** const
|
||||||
|
|
||||||
Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size.
|
Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size.
|
||||||
|
|
||||||
.. _class_Control_get_mouse_filter:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_mouse_filter** **(** **)** const
|
|
||||||
|
|
||||||
Return when the control is ignoring mouse events (even touchpad events send mouse events).
|
|
||||||
|
|
||||||
.. _class_Control_get_parent_area_size:
|
.. _class_Control_get_parent_area_size:
|
||||||
|
|
||||||
- :ref:`Vector2<class_vector2>` **get_parent_area_size** **(** **)** const
|
- :ref:`Vector2<class_vector2>` **get_parent_area_size** **(** **)** const
|
||||||
@@ -666,16 +568,6 @@ Return when the control is ignoring mouse events (even touchpad events send mous
|
|||||||
|
|
||||||
- :ref:`Control<class_control>` **get_parent_control** **(** **)** const
|
- :ref:`Control<class_control>` **get_parent_control** **(** **)** const
|
||||||
|
|
||||||
.. _class_Control_get_pivot_offset:
|
|
||||||
|
|
||||||
- :ref:`Vector2<class_vector2>` **get_pivot_offset** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Control_get_position:
|
|
||||||
|
|
||||||
- :ref:`Vector2<class_vector2>` **get_position** **(** **)** const
|
|
||||||
|
|
||||||
Returns the Control position, relative to the top-left corner of the parent Control and independent of the anchor mode.
|
|
||||||
|
|
||||||
.. _class_Control_get_rect:
|
.. _class_Control_get_rect:
|
||||||
|
|
||||||
- :ref:`Rect2<class_rect2>` **get_rect** **(** **)** const
|
- :ref:`Rect2<class_rect2>` **get_rect** **(** **)** const
|
||||||
@@ -688,54 +580,16 @@ Return position and size of the Control, relative to the top-left corner of the
|
|||||||
|
|
||||||
Return the rotation (in radians)
|
Return the rotation (in radians)
|
||||||
|
|
||||||
.. _class_Control_get_rotation_degrees:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_rotation_degrees** **(** **)** const
|
|
||||||
|
|
||||||
Return the rotation (in degrees)
|
|
||||||
|
|
||||||
.. _class_Control_get_scale:
|
|
||||||
|
|
||||||
- :ref:`Vector2<class_vector2>` **get_scale** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Control_get_size:
|
|
||||||
|
|
||||||
- :ref:`Vector2<class_vector2>` **get_size** **(** **)** const
|
|
||||||
|
|
||||||
Returns the size of the Control, computed from all margins, however the size returned will **never be smaller than the minimum size reported by** :ref:`get_minimum_size<class_Control_get_minimum_size>`. This means that even if end position of the Control rectangle is smaller than the begin position, the Control will still display and interact correctly. (see description, :ref:`get_minimum_size<class_Control_get_minimum_size>`, :ref:`set_margin<class_Control_set_margin>`, :ref:`set_anchor<class_Control_set_anchor>`).
|
|
||||||
|
|
||||||
.. _class_Control_get_stretch_ratio:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_stretch_ratio** **(** **)** const
|
|
||||||
|
|
||||||
Hint for containers, return the stretch ratio. This value is relative to other stretch ratio, so if this control has 2 and another has 1, this one will be twice as big.
|
|
||||||
|
|
||||||
.. _class_Control_get_stylebox:
|
.. _class_Control_get_stylebox:
|
||||||
|
|
||||||
- :ref:`StyleBox<class_stylebox>` **get_stylebox** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const
|
- :ref:`StyleBox<class_stylebox>` **get_stylebox** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const
|
||||||
|
|
||||||
.. _class_Control_get_theme:
|
|
||||||
|
|
||||||
- :ref:`Theme<class_theme>` **get_theme** **(** **)** const
|
|
||||||
|
|
||||||
Return a :ref:`Theme<class_theme>` override, if one exists (see :ref:`set_theme<class_Control_set_theme>`).
|
|
||||||
|
|
||||||
.. _class_Control_get_tooltip:
|
.. _class_Control_get_tooltip:
|
||||||
|
|
||||||
- :ref:`String<class_string>` **get_tooltip** **(** :ref:`Vector2<class_vector2>` at_position=Vector2( 0, 0 ) **)** const
|
- :ref:`String<class_string>` **get_tooltip** **(** :ref:`Vector2<class_vector2>` at_position=Vector2( 0, 0 ) **)** const
|
||||||
|
|
||||||
Return the tooltip, which will appear when the cursor is resting over this control.
|
Return the tooltip, which will appear when the cursor is resting over this control.
|
||||||
|
|
||||||
.. _class_Control_get_v_grow_direction:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_v_grow_direction** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Control_get_v_size_flags:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_v_size_flags** **(** **)** const
|
|
||||||
|
|
||||||
Hint for containers, return vertical positioning flags.
|
|
||||||
|
|
||||||
.. _class_Control_grab_click_focus:
|
.. _class_Control_grab_click_focus:
|
||||||
|
|
||||||
- void **grab_click_focus** **(** **)**
|
- void **grab_click_focus** **(** **)**
|
||||||
@@ -796,10 +650,6 @@ Return whether the Control is the current focused control (see :ref:`set_focus_m
|
|||||||
|
|
||||||
- :ref:`bool<class_bool>` **has_stylebox_override** **(** :ref:`String<class_string>` name **)** const
|
- :ref:`bool<class_bool>` **has_stylebox_override** **(** :ref:`String<class_string>` name **)** const
|
||||||
|
|
||||||
.. _class_Control_is_clipping_contents:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_clipping_contents** **(** **)**
|
|
||||||
|
|
||||||
.. _class_Control_minimum_size_changed:
|
.. _class_Control_minimum_size_changed:
|
||||||
|
|
||||||
- void **minimum_size_changed** **(** **)**
|
- void **minimum_size_changed** **(** **)**
|
||||||
@@ -832,14 +682,6 @@ Give up the focus, no other control will be able to receive keyboard input.
|
|||||||
|
|
||||||
Sets MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see :ref:`set_margin<class_Control_set_margin>`).
|
Sets MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see :ref:`set_margin<class_Control_set_margin>`).
|
||||||
|
|
||||||
.. _class_Control_set_clip_contents:
|
|
||||||
|
|
||||||
- void **set_clip_contents** **(** :ref:`bool<class_bool>` enable **)**
|
|
||||||
|
|
||||||
.. _class_Control_set_custom_minimum_size:
|
|
||||||
|
|
||||||
- void **set_custom_minimum_size** **(** :ref:`Vector2<class_vector2>` size **)**
|
|
||||||
|
|
||||||
.. _class_Control_set_default_cursor_shape:
|
.. _class_Control_set_default_cursor_shape:
|
||||||
|
|
||||||
- void **set_default_cursor_shape** **(** :ref:`int<class_int>` shape **)**
|
- void **set_default_cursor_shape** **(** :ref:`int<class_int>` shape **)**
|
||||||
@@ -866,104 +708,22 @@ Sets MARGIN_RIGHT and MARGIN_BOTTOM at the same time. This is a helper (see :ref
|
|||||||
|
|
||||||
Set the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL). Only one Control can be focused at the same time, and it will receive keyboard signals.
|
Set the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL). Only one Control can be focused at the same time, and it will receive keyboard signals.
|
||||||
|
|
||||||
.. _class_Control_set_focus_neighbour:
|
|
||||||
|
|
||||||
- void **set_focus_neighbour** **(** :ref:`int<class_int>` margin, :ref:`NodePath<class_nodepath>` neighbour **)**
|
|
||||||
|
|
||||||
Force a neighbour for moving the input focus to. When pressing TAB or directional/joypad directions focus is moved to the next control in that direction. However, the neighbour to move to can be forced with this function.
|
|
||||||
|
|
||||||
.. _class_Control_set_global_position:
|
.. _class_Control_set_global_position:
|
||||||
|
|
||||||
- void **set_global_position** **(** :ref:`Vector2<class_vector2>` position **)**
|
- void **set_global_position** **(** :ref:`Vector2<class_vector2>` position **)**
|
||||||
|
|
||||||
Move the Control to a new position, relative to the top-left corner of the *window* Control, and without changing current anchor mode. (see :ref:`set_margin<class_Control_set_margin>`).
|
Move the Control to a new position, relative to the top-left corner of the *window* Control, and without changing current anchor mode. (see :ref:`set_margin<class_Control_set_margin>`).
|
||||||
|
|
||||||
.. _class_Control_set_h_grow_direction:
|
|
||||||
|
|
||||||
- void **set_h_grow_direction** **(** :ref:`int<class_int>` direction **)**
|
|
||||||
|
|
||||||
.. _class_Control_set_h_size_flags:
|
|
||||||
|
|
||||||
- void **set_h_size_flags** **(** :ref:`int<class_int>` flags **)**
|
|
||||||
|
|
||||||
Hint for containers, set horizontal positioning flags.
|
|
||||||
|
|
||||||
.. _class_Control_set_margin:
|
|
||||||
|
|
||||||
- void **set_margin** **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` offset **)**
|
|
||||||
|
|
||||||
Set a margin offset. Margin can be one of (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Offset value being set depends on the anchor mode.
|
|
||||||
|
|
||||||
.. _class_Control_set_margins_preset:
|
.. _class_Control_set_margins_preset:
|
||||||
|
|
||||||
- void **set_margins_preset** **(** :ref:`int<class_int>` preset, :ref:`int<class_int>` resize_mode=0, :ref:`int<class_int>` margin=0 **)**
|
- void **set_margins_preset** **(** :ref:`int<class_int>` preset, :ref:`int<class_int>` resize_mode=0, :ref:`int<class_int>` margin=0 **)**
|
||||||
|
|
||||||
.. _class_Control_set_mouse_filter:
|
|
||||||
|
|
||||||
- void **set_mouse_filter** **(** :ref:`int<class_int>` filter **)**
|
|
||||||
|
|
||||||
Set when the control is ignoring mouse events (even touchpad events send mouse events). (see the MOUSE_FILTER\_\* constants)
|
|
||||||
|
|
||||||
.. _class_Control_set_pivot_offset:
|
|
||||||
|
|
||||||
- void **set_pivot_offset** **(** :ref:`Vector2<class_vector2>` pivot_offset **)**
|
|
||||||
|
|
||||||
.. _class_Control_set_position:
|
|
||||||
|
|
||||||
- void **set_position** **(** :ref:`Vector2<class_vector2>` position **)**
|
|
||||||
|
|
||||||
Move the Control to a new position, relative to the top-left corner of the parent Control, changing all margins if needed and without changing current anchor mode. This is a helper (see :ref:`set_margin<class_Control_set_margin>`).
|
|
||||||
|
|
||||||
.. _class_Control_set_rotation:
|
.. _class_Control_set_rotation:
|
||||||
|
|
||||||
- void **set_rotation** **(** :ref:`float<class_float>` radians **)**
|
- void **set_rotation** **(** :ref:`float<class_float>` radians **)**
|
||||||
|
|
||||||
Set the rotation (in radians).
|
Set the rotation (in radians).
|
||||||
|
|
||||||
.. _class_Control_set_rotation_degrees:
|
|
||||||
|
|
||||||
- void **set_rotation_degrees** **(** :ref:`float<class_float>` degrees **)**
|
|
||||||
|
|
||||||
Set the rotation (in degrees).
|
|
||||||
|
|
||||||
.. _class_Control_set_scale:
|
|
||||||
|
|
||||||
- void **set_scale** **(** :ref:`Vector2<class_vector2>` scale **)**
|
|
||||||
|
|
||||||
.. _class_Control_set_size:
|
|
||||||
|
|
||||||
- void **set_size** **(** :ref:`Vector2<class_vector2>` size **)**
|
|
||||||
|
|
||||||
Changes MARGIN_RIGHT and MARGIN_BOTTOM to fit a given size. This is a helper (see :ref:`set_margin<class_Control_set_margin>`).
|
|
||||||
|
|
||||||
.. _class_Control_set_stretch_ratio:
|
|
||||||
|
|
||||||
- void **set_stretch_ratio** **(** :ref:`float<class_float>` ratio **)**
|
|
||||||
|
|
||||||
Hint for containers, set the stretch ratio. This value is relative to other stretch ratio, so if this control has 2 and another has 1, this one will be twice as big.
|
|
||||||
|
|
||||||
.. _class_Control_set_theme:
|
|
||||||
|
|
||||||
- void **set_theme** **(** :ref:`Theme<class_theme>` theme **)**
|
|
||||||
|
|
||||||
Overrides the whole :ref:`Theme<class_theme>` for this node and all its ``Control`` children.
|
|
||||||
|
|
||||||
.. _class_Control_set_tooltip:
|
|
||||||
|
|
||||||
- void **set_tooltip** **(** :ref:`String<class_string>` tooltip **)**
|
|
||||||
|
|
||||||
Changes the tooltip text. The tooltip appears when the user's mouse cursor stays idle over this control for a few moments.
|
|
||||||
|
|
||||||
.. _class_Control_set_v_grow_direction:
|
|
||||||
|
|
||||||
- void **set_v_grow_direction** **(** :ref:`int<class_int>` direction **)**
|
|
||||||
|
|
||||||
.. _class_Control_set_v_size_flags:
|
|
||||||
|
|
||||||
- void **set_v_size_flags** **(** :ref:`int<class_int>` flags **)**
|
|
||||||
|
|
||||||
Hint for containers, set vertical positioning flags.
|
|
||||||
|
|
||||||
.. _class_Control_show_modal:
|
.. _class_Control_show_modal:
|
||||||
|
|
||||||
- void **show_modal** **(** :ref:`bool<class_bool>` exclusive=false **)**
|
- void **show_modal** **(** :ref:`bool<class_bool>` exclusive=false **)**
|
||||||
|
|||||||
@@ -16,15 +16,6 @@ Brief Description
|
|||||||
|
|
||||||
Convex polygon shape for 3D physics.
|
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 **)** |
|
|
||||||
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -38,15 +29,3 @@ Description
|
|||||||
|
|
||||||
Convex polygon shape resource, which can be added to a :ref:`PhysicsBody<class_physicsbody>` or area.
|
Convex polygon shape resource, which can be added to a :ref:`PhysicsBody<class_physicsbody>` or area.
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_ConvexPolygonShape_get_points:
|
|
||||||
|
|
||||||
- :ref:`PoolVector3Array<class_poolvector3array>` **get_points** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_ConvexPolygonShape_set_points:
|
|
||||||
|
|
||||||
- void **set_points** **(** :ref:`PoolVector3Array<class_poolvector3array>` points **)**
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -19,13 +19,9 @@ Convex Polygon Shape for 2D physics.
|
|||||||
Member Functions
|
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_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
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
@@ -45,22 +41,10 @@ The main difference between a ``ConvexPolygonShape2D`` and a :ref:`ConcavePolygo
|
|||||||
Member Function Description
|
Member Function Description
|
||||||
---------------------------
|
---------------------------
|
||||||
|
|
||||||
.. _class_ConvexPolygonShape2D_get_points:
|
|
||||||
|
|
||||||
- :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:
|
.. _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.
|
Currently, this method does nothing.
|
||||||
|
|
||||||
.. _class_ConvexPolygonShape2D_set_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.
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
+13
-37
@@ -19,27 +19,19 @@ A CubeMap is a 6 sided 3D texture.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_flags<class_CubeMap_get_flags>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_flags<class_CubeMap_get_flags>` **(** **)** const |
|
||||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_height<class_CubeMap_get_height>` **(** **)** const |
|
| :ref:`int<class_int>` | :ref:`get_height<class_CubeMap_get_height>` **(** **)** const |
|
||||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_lossy_storage_quality<class_CubeMap_get_lossy_storage_quality>` **(** **)** const |
|
| :ref:`Image<class_image>` | :ref:`get_side<class_CubeMap_get_side>` **(** :ref:`int<class_int>` side **)** const |
|
||||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Image<class_image>` | :ref:`get_side<class_CubeMap_get_side>` **(** :ref:`int<class_int>` side **)** const |
|
| :ref:`int<class_int>` | :ref:`get_width<class_CubeMap_get_width>` **(** **)** const |
|
||||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_storage<class_CubeMap_get_storage>` **(** **)** const |
|
| void | :ref:`set_flags<class_CubeMap_set_flags>` **(** :ref:`int<class_int>` flags **)** |
|
||||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_width<class_CubeMap_get_width>` **(** **)** const |
|
| void | :ref:`set_side<class_CubeMap_set_side>` **(** :ref:`int<class_int>` side, :ref:`Image<class_image>` image **)** |
|
||||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||||
| 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 **)** |
|
|
||||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
@@ -88,20 +80,12 @@ Member Function Description
|
|||||||
|
|
||||||
Returns the CubeMap's height.
|
Returns the CubeMap's height.
|
||||||
|
|
||||||
.. _class_CubeMap_get_lossy_storage_quality:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_lossy_storage_quality** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_CubeMap_get_side:
|
.. _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
|
||||||
|
|
||||||
Returns an :ref:`Image<class_image>` for a side of the CubeMap using one of the ``SIDE\_\*`` constants or an integer 0-5.
|
Returns an :ref:`Image<class_image>` for a side of the CubeMap using one of the ``SIDE\_\*`` constants or an integer 0-5.
|
||||||
|
|
||||||
.. _class_CubeMap_get_storage:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_storage** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_CubeMap_get_width:
|
.. _class_CubeMap_get_width:
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_width** **(** **)** const
|
- :ref:`int<class_int>` **get_width** **(** **)** const
|
||||||
@@ -112,18 +96,10 @@ Returns the CubeMap's width.
|
|||||||
|
|
||||||
- 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 **)**
|
|
||||||
|
|
||||||
.. _class_CubeMap_set_side:
|
.. _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 **)**
|
||||||
|
|
||||||
Sets an :ref:`Image<class_image>` for a side of the CubeMap using one of the ``SIDE\_\*`` constants or an integer 0-5.
|
Sets an :ref:`Image<class_image>` for a side of the CubeMap using one of the ``SIDE\_\*`` constants or an integer 0-5.
|
||||||
|
|
||||||
.. _class_CubeMap_set_storage:
|
|
||||||
|
|
||||||
- void **set_storage** **(** :ref:`int<class_int>` mode **)**
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -16,27 +16,6 @@ Brief Description
|
|||||||
|
|
||||||
Generate an axis-aligned cuboid :ref:`PrimitiveMesh<class_primitivemesh>`.
|
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 **)** |
|
|
||||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -62,39 +41,3 @@ Description
|
|||||||
|
|
||||||
Generate an axis-aligned cuboid :ref:`PrimitiveMesh<class_primitivemesh>`.
|
Generate an axis-aligned cuboid :ref:`PrimitiveMesh<class_primitivemesh>`.
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_CubeMesh_get_size:
|
|
||||||
|
|
||||||
- :ref:`Vector3<class_vector3>` **get_size** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_CubeMesh_get_subdivide_depth:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_subdivide_depth** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_CubeMesh_get_subdivide_height:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_subdivide_height** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_CubeMesh_get_subdivide_width:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_subdivide_width** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_CubeMesh_set_size:
|
|
||||||
|
|
||||||
- void **set_size** **(** :ref:`Vector3<class_vector3>` size **)**
|
|
||||||
|
|
||||||
.. _class_CubeMesh_set_subdivide_depth:
|
|
||||||
|
|
||||||
- void **set_subdivide_depth** **(** :ref:`int<class_int>` divisions **)**
|
|
||||||
|
|
||||||
.. _class_CubeMesh_set_subdivide_height:
|
|
||||||
|
|
||||||
- void **set_subdivide_height** **(** :ref:`int<class_int>` divisions **)**
|
|
||||||
|
|
||||||
.. _class_CubeMesh_set_subdivide_width:
|
|
||||||
|
|
||||||
- void **set_subdivide_width** **(** :ref:`int<class_int>` subdivide **)**
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -28,12 +28,6 @@ Member Functions
|
|||||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`clear_points<class_Curve_clear_points>` **(** **)** |
|
| void | :ref:`clear_points<class_Curve_clear_points>` **(** **)** |
|
||||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_bake_resolution<class_Curve_get_bake_resolution>` **(** **)** const |
|
|
||||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`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:`int<class_int>` | :ref:`get_point_left_mode<class_Curve_get_point_left_mode>` **(** :ref:`int<class_int>` index **)** const |
|
||||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_point_left_tangent<class_Curve_get_point_left_tangent>` **(** :ref:`int<class_int>` index **)** const |
|
| :ref:`float<class_float>` | :ref:`get_point_left_tangent<class_Curve_get_point_left_tangent>` **(** :ref:`int<class_int>` index **)** const |
|
||||||
@@ -50,12 +44,6 @@ Member Functions
|
|||||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`remove_point<class_Curve_remove_point>` **(** :ref:`int<class_int>` index **)** |
|
| void | :ref:`remove_point<class_Curve_remove_point>` **(** :ref:`int<class_int>` index **)** |
|
||||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_bake_resolution<class_Curve_set_bake_resolution>` **(** :ref:`int<class_int>` resolution **)** |
|
|
||||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_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_mode<class_Curve_set_point_left_mode>` **(** :ref:`int<class_int>` index, :ref:`int<class_int>` mode **)** |
|
||||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_point_left_tangent<class_Curve_set_point_left_tangent>` **(** :ref:`int<class_int>` index, :ref:`float<class_float>` tangent **)** |
|
| void | :ref:`set_point_left_tangent<class_Curve_set_point_left_tangent>` **(** :ref:`int<class_int>` index, :ref:`float<class_float>` tangent **)** |
|
||||||
@@ -123,18 +111,6 @@ Member Function Description
|
|||||||
|
|
||||||
- void **clear_points** **(** **)**
|
- void **clear_points** **(** **)**
|
||||||
|
|
||||||
.. _class_Curve_get_bake_resolution:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_bake_resolution** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Curve_get_max_value:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_max_value** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Curve_get_min_value:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_min_value** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Curve_get_point_left_mode:
|
.. _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
|
||||||
@@ -167,18 +143,6 @@ Member Function Description
|
|||||||
|
|
||||||
- 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 **)**
|
|
||||||
|
|
||||||
.. _class_Curve_set_max_value:
|
|
||||||
|
|
||||||
- void **set_max_value** **(** :ref:`float<class_float>` max **)**
|
|
||||||
|
|
||||||
.. _class_Curve_set_min_value:
|
|
||||||
|
|
||||||
- void **set_min_value** **(** :ref:`float<class_float>` min **)**
|
|
||||||
|
|
||||||
.. _class_Curve_set_point_left_mode:
|
.. _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 **)**
|
||||||
|
|||||||
@@ -24,8 +24,6 @@ Member Functions
|
|||||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`clear_points<class_Curve2D_clear_points>` **(** **)** |
|
| void | :ref:`clear_points<class_Curve2D_clear_points>` **(** **)** |
|
||||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_bake_interval<class_Curve2D_get_bake_interval>` **(** **)** const |
|
|
||||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_baked_length<class_Curve2D_get_baked_length>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_baked_length<class_Curve2D_get_baked_length>` **(** **)** const |
|
||||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`PoolVector2Array<class_poolvector2array>` | :ref:`get_baked_points<class_Curve2D_get_baked_points>` **(** **)** const |
|
| :ref:`PoolVector2Array<class_poolvector2array>` | :ref:`get_baked_points<class_Curve2D_get_baked_points>` **(** **)** const |
|
||||||
@@ -46,8 +44,6 @@ Member Functions
|
|||||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`remove_point<class_Curve2D_remove_point>` **(** :ref:`int<class_int>` idx **)** |
|
| void | :ref:`remove_point<class_Curve2D_remove_point>` **(** :ref:`int<class_int>` idx **)** |
|
||||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_bake_interval<class_Curve2D_set_bake_interval>` **(** :ref:`float<class_float>` distance **)** |
|
|
||||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_point_in<class_Curve2D_set_point_in>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` position **)** |
|
| 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_out<class_Curve2D_set_point_out>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` position **)** |
|
||||||
@@ -93,12 +89,6 @@ If "at_position" is given, the point is inserted before the point number "at_pos
|
|||||||
|
|
||||||
Removes all points from the curve.
|
Removes all points from the curve.
|
||||||
|
|
||||||
.. _class_Curve2D_get_bake_interval:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_bake_interval** **(** **)** const
|
|
||||||
|
|
||||||
Returns the distance between two adjacent cached points.
|
|
||||||
|
|
||||||
.. _class_Curve2D_get_baked_length:
|
.. _class_Curve2D_get_baked_length:
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_baked_length** **(** **)** const
|
- :ref:`float<class_float>` **get_baked_length** **(** **)** const
|
||||||
@@ -165,12 +155,6 @@ Returns the position at the vertex "fofs". It calls :ref:`interpolate<class_Curv
|
|||||||
|
|
||||||
Deletes the point "idx" from the curve. Sends an error to the console if "idx" is out of bounds.
|
Deletes the point "idx" from the curve. Sends an error to the console if "idx" is out of bounds.
|
||||||
|
|
||||||
.. _class_Curve2D_set_bake_interval:
|
|
||||||
|
|
||||||
- void **set_bake_interval** **(** :ref:`float<class_float>` distance **)**
|
|
||||||
|
|
||||||
Sets the distance in pixels between two adjacent cached points. Changing it forces the cache to be recomputed the next time a xxx_baked_xxx function is called. The less distance, the more points the cache will have, and the more memory it will consume, so use with care.
|
|
||||||
|
|
||||||
.. _class_Curve2D_set_point_in:
|
.. _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 **)**
|
||||||
|
|||||||
@@ -24,8 +24,6 @@ Member Functions
|
|||||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`clear_points<class_Curve3D_clear_points>` **(** **)** |
|
| void | :ref:`clear_points<class_Curve3D_clear_points>` **(** **)** |
|
||||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_bake_interval<class_Curve3D_get_bake_interval>` **(** **)** const |
|
|
||||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_baked_length<class_Curve3D_get_baked_length>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_baked_length<class_Curve3D_get_baked_length>` **(** **)** const |
|
||||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`PoolVector3Array<class_poolvector3array>` | :ref:`get_baked_points<class_Curve3D_get_baked_points>` **(** **)** const |
|
| :ref:`PoolVector3Array<class_poolvector3array>` | :ref:`get_baked_points<class_Curve3D_get_baked_points>` **(** **)** const |
|
||||||
@@ -50,8 +48,6 @@ Member Functions
|
|||||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`remove_point<class_Curve3D_remove_point>` **(** :ref:`int<class_int>` idx **)** |
|
| void | :ref:`remove_point<class_Curve3D_remove_point>` **(** :ref:`int<class_int>` idx **)** |
|
||||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_bake_interval<class_Curve3D_set_bake_interval>` **(** :ref:`float<class_float>` distance **)** |
|
|
||||||
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_point_in<class_Curve3D_set_point_in>` **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` position **)** |
|
| 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_out<class_Curve3D_set_point_out>` **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` position **)** |
|
||||||
@@ -97,12 +93,6 @@ If "at_position" is given, the point is inserted before the point number "at_pos
|
|||||||
|
|
||||||
- void **clear_points** **(** **)**
|
- void **clear_points** **(** **)**
|
||||||
|
|
||||||
.. _class_Curve3D_get_bake_interval:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_bake_interval** **(** **)** const
|
|
||||||
|
|
||||||
Returns the distance between two adjacent cached points.
|
|
||||||
|
|
||||||
.. _class_Curve3D_get_baked_length:
|
.. _class_Curve3D_get_baked_length:
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_baked_length** **(** **)** const
|
- :ref:`float<class_float>` **get_baked_length** **(** **)** const
|
||||||
@@ -181,12 +171,6 @@ Returns the position at the vertex "fofs". It calls :ref:`interpolate<class_Curv
|
|||||||
|
|
||||||
Deletes the point "idx" from the curve. Sends an error to the console if "idx" is out of bounds.
|
Deletes the point "idx" from the curve. Sends an error to the console if "idx" is out of bounds.
|
||||||
|
|
||||||
.. _class_Curve3D_set_bake_interval:
|
|
||||||
|
|
||||||
- void **set_bake_interval** **(** :ref:`float<class_float>` distance **)**
|
|
||||||
|
|
||||||
Sets the distance in 3D units between two adjacent cached points. Changing it forces the cache to be recomputed the next time a xxx_baked_xxx function is called. The less distance, the more points the cache will have, and the more memory it will consume, so use with care.
|
|
||||||
|
|
||||||
.. _class_Curve3D_set_point_in:
|
.. _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 **)**
|
||||||
|
|||||||
@@ -16,17 +16,6 @@ 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 **)** |
|
|
||||||
+----------------------------+--------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -39,19 +28,3 @@ Member Variables
|
|||||||
- :ref:`int<class_int>` **width**
|
- :ref:`int<class_int>` **width**
|
||||||
|
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_CurveTexture_get_curve:
|
|
||||||
|
|
||||||
- :ref:`Curve<class_curve>` **get_curve** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_CurveTexture_set_curve:
|
|
||||||
|
|
||||||
- void **set_curve** **(** :ref:`Curve<class_curve>` curve **)**
|
|
||||||
|
|
||||||
.. _class_CurveTexture_set_width:
|
|
||||||
|
|
||||||
- void **set_width** **(** :ref:`int<class_int>` width **)**
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -16,31 +16,6 @@ Brief Description
|
|||||||
|
|
||||||
Class representing a cylindrical :ref:`PrimitiveMesh<class_primitivemesh>`.
|
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 **)** |
|
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -70,47 +45,3 @@ Description
|
|||||||
|
|
||||||
Class representing a cylindrical :ref:`PrimitiveMesh<class_primitivemesh>`.
|
Class representing a cylindrical :ref:`PrimitiveMesh<class_primitivemesh>`.
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_CylinderMesh_get_bottom_radius:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_bottom_radius** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_CylinderMesh_get_height:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_height** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_CylinderMesh_get_radial_segments:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_radial_segments** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_CylinderMesh_get_rings:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_rings** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_CylinderMesh_get_top_radius:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_top_radius** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_CylinderMesh_set_bottom_radius:
|
|
||||||
|
|
||||||
- void **set_bottom_radius** **(** :ref:`float<class_float>` radius **)**
|
|
||||||
|
|
||||||
.. _class_CylinderMesh_set_height:
|
|
||||||
|
|
||||||
- void **set_height** **(** :ref:`float<class_float>` height **)**
|
|
||||||
|
|
||||||
.. _class_CylinderMesh_set_radial_segments:
|
|
||||||
|
|
||||||
- void **set_radial_segments** **(** :ref:`int<class_int>` segments **)**
|
|
||||||
|
|
||||||
.. _class_CylinderMesh_set_rings:
|
|
||||||
|
|
||||||
- void **set_rings** **(** :ref:`int<class_int>` rings **)**
|
|
||||||
|
|
||||||
.. _class_CylinderMesh_set_top_radius:
|
|
||||||
|
|
||||||
- void **set_top_radius** **(** :ref:`float<class_float>` radius **)**
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -16,27 +16,6 @@ Brief Description
|
|||||||
|
|
||||||
Damped spring constraint for 2D physics.
|
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 **)** |
|
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -62,55 +41,3 @@ Description
|
|||||||
|
|
||||||
Damped spring constraint for 2D physics. This resembles a spring joint that always wants to go back to a given length.
|
Damped spring constraint for 2D physics. This resembles a spring joint that always wants to go back to a given length.
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_DampedSpringJoint2D_get_damping:
|
|
||||||
|
|
||||||
- :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
|
|
||||||
|
|
||||||
Return the maximum length of the spring joint.
|
|
||||||
|
|
||||||
.. _class_DampedSpringJoint2D_get_rest_length:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_rest_length** **(** **)** const
|
|
||||||
|
|
||||||
Return the resting length of the spring joint. The joint will always try to go to back this length when pulled apart.
|
|
||||||
|
|
||||||
.. _class_DampedSpringJoint2D_get_stiffness:
|
|
||||||
|
|
||||||
- :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 **)**
|
|
||||||
|
|
||||||
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 **)**
|
|
||||||
|
|
||||||
Set the maximum length of the spring joint.
|
|
||||||
|
|
||||||
.. _class_DampedSpringJoint2D_set_rest_length:
|
|
||||||
|
|
||||||
- void **set_rest_length** **(** :ref:`float<class_float>` rest_length **)**
|
|
||||||
|
|
||||||
Set the resting length of the spring joint. The joint will always try to go to back this length when pulled apart.
|
|
||||||
|
|
||||||
.. _class_DampedSpringJoint2D_set_stiffness:
|
|
||||||
|
|
||||||
- void **set_stiffness** **(** :ref:`float<class_float>` stiffness **)**
|
|
||||||
|
|
||||||
Set the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length.
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -16,23 +16,6 @@ Brief Description
|
|||||||
|
|
||||||
Directional Light, such as the Sun or the Moon.
|
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 **)** |
|
|
||||||
+--------------------------+---------------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -87,31 +70,3 @@ Description
|
|||||||
|
|
||||||
A DirectionalLight is a type of :ref:`Light<class_light>` node that emits light constantly in one direction (the negative z axis of the node). It is used lights with strong intensity that are located far away from the scene to model sunlight or moonlight. The worldspace location of the DirectionalLight transform (origin) is ignored, only the basis is used do determine light direction.
|
A DirectionalLight is a type of :ref:`Light<class_light>` node that emits light constantly in one direction (the negative z axis of the node). It is used lights with strong intensity that are located far away from the scene to model sunlight or moonlight. The worldspace location of the DirectionalLight transform (origin) is ignored, only the basis is used do determine light direction.
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_DirectionalLight_get_shadow_depth_range:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_shadow_depth_range** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_DirectionalLight_get_shadow_mode:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_shadow_mode** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_DirectionalLight_is_blend_splits_enabled:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_blend_splits_enabled** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_DirectionalLight_set_blend_splits:
|
|
||||||
|
|
||||||
- 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 **)**
|
|
||||||
|
|
||||||
.. _class_DirectionalLight_set_shadow_mode:
|
|
||||||
|
|
||||||
- void **set_shadow_mode** **(** :ref:`int<class_int>` mode **)**
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -89,7 +89,7 @@ Member Function Description
|
|||||||
|
|
||||||
Change the currently opened directory to the one passed as an argument. The argument can be relative to the current directory (e.g. ``newdir`` or ``../newdir``), or an absolute path (e.g. ``/tmp/newdir`` or ``res://somedir/newdir``).
|
Change the currently opened directory to the one passed as an argument. The argument can be relative to the current directory (e.g. ``newdir`` or ``../newdir``), or an absolute path (e.g. ``/tmp/newdir`` or ``res://somedir/newdir``).
|
||||||
|
|
||||||
The method returns one of the error code constants defined in :ref:`@Global Scope<class_@global scope>` (OK or ERR\_\*).
|
The method returns one of the error code constants defined in :ref:`@GlobalScope<class_@globalscope>` (OK or ERR\_\*).
|
||||||
|
|
||||||
.. _class_Directory_copy:
|
.. _class_Directory_copy:
|
||||||
|
|
||||||
@@ -97,7 +97,7 @@ The method returns one of the error code constants defined in :ref:`@Global Scop
|
|||||||
|
|
||||||
Copy the *from* file to the *to* destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten.
|
Copy the *from* file to the *to* destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten.
|
||||||
|
|
||||||
Returns one of the error code constants defined in :ref:`@Global Scope<class_@global scope>` (OK, FAILED or ERR\_\*).
|
Returns one of the error code constants defined in :ref:`@GlobalScope<class_@globalscope>` (OK, FAILED or ERR\_\*).
|
||||||
|
|
||||||
.. _class_Directory_current_is_dir:
|
.. _class_Directory_current_is_dir:
|
||||||
|
|
||||||
@@ -177,7 +177,7 @@ Close the current stream opened with :ref:`list_dir_begin<class_Directory_list_d
|
|||||||
|
|
||||||
Create a directory. The argument can be relative to the current directory, or an absolute path. The target directory should be placed in an already existing directory (to create the full path recursively, see :ref:`make_dir_recursive<class_Directory_make_dir_recursive>`).
|
Create a directory. The argument can be relative to the current directory, or an absolute path. The target directory should be placed in an already existing directory (to create the full path recursively, see :ref:`make_dir_recursive<class_Directory_make_dir_recursive>`).
|
||||||
|
|
||||||
The method returns one of the error code constants defined in :ref:`@Global Scope<class_@global scope>` (OK, FAILED or ERR\_\*).
|
The method returns one of the error code constants defined in :ref:`@GlobalScope<class_@globalscope>` (OK, FAILED or ERR\_\*).
|
||||||
|
|
||||||
.. _class_Directory_make_dir_recursive:
|
.. _class_Directory_make_dir_recursive:
|
||||||
|
|
||||||
@@ -185,7 +185,7 @@ The method returns one of the error code constants defined in :ref:`@Global Scop
|
|||||||
|
|
||||||
Create a target directory and all necessary intermediate directories in its path, by calling :ref:`make_dir<class_Directory_make_dir>` recursively. The argument can be relative to the current directory, or an absolute path.
|
Create a target directory and all necessary intermediate directories in its path, by calling :ref:`make_dir<class_Directory_make_dir>` recursively. The argument can be relative to the current directory, or an absolute path.
|
||||||
|
|
||||||
Return one of the error code constants defined in :ref:`@Global Scope<class_@global scope>` (OK, FAILED or ERR\_\*).
|
Return one of the error code constants defined in :ref:`@GlobalScope<class_@globalscope>` (OK, FAILED or ERR\_\*).
|
||||||
|
|
||||||
.. _class_Directory_open:
|
.. _class_Directory_open:
|
||||||
|
|
||||||
@@ -193,7 +193,7 @@ Return one of the error code constants defined in :ref:`@Global Scope<class_@glo
|
|||||||
|
|
||||||
Open an existing directory of the filesystem. The *path* argument can be within the project tree (``res://folder``), the user directory (``user://folder``) or an absolute path of the user filesystem (e.g. ``/tmp/folder`` or ``C:\tmp\folder``).
|
Open an existing directory of the filesystem. The *path* argument can be within the project tree (``res://folder``), the user directory (``user://folder``) or an absolute path of the user filesystem (e.g. ``/tmp/folder`` or ``C:\tmp\folder``).
|
||||||
|
|
||||||
The method returns one of the error code constants defined in :ref:`@Global Scope<class_@global scope>` (OK or ERR\_\*).
|
The method returns one of the error code constants defined in :ref:`@GlobalScope<class_@globalscope>` (OK or ERR\_\*).
|
||||||
|
|
||||||
.. _class_Directory_remove:
|
.. _class_Directory_remove:
|
||||||
|
|
||||||
@@ -201,7 +201,7 @@ The method returns one of the error code constants defined in :ref:`@Global Scop
|
|||||||
|
|
||||||
Delete the target file or an empty directory. The argument can be relative to the current directory, or an absolute path. If the target directory is not empty, the operation will fail.
|
Delete the target file or an empty directory. The argument can be relative to the current directory, or an absolute path. If the target directory is not empty, the operation will fail.
|
||||||
|
|
||||||
Return one of the error code constants defined in :ref:`@Global Scope<class_@global scope>` (OK or FAILED).
|
Return one of the error code constants defined in :ref:`@GlobalScope<class_@globalscope>` (OK or FAILED).
|
||||||
|
|
||||||
.. _class_Directory_rename:
|
.. _class_Directory_rename:
|
||||||
|
|
||||||
@@ -209,6 +209,6 @@ Return one of the error code constants defined in :ref:`@Global Scope<class_@glo
|
|||||||
|
|
||||||
Rename (move) the *from* file to the *to* destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten.
|
Rename (move) the *from* file to the *to* destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten.
|
||||||
|
|
||||||
Return one of the error code constants defined in :ref:`@Global Scope<class_@global scope>` (OK or FAILED).
|
Return one of the error code constants defined in :ref:`@GlobalScope<class_@globalscope>` (OK or FAILED).
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -26,30 +26,10 @@ Member Functions
|
|||||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_fallback_count<class_DynamicFont_get_fallback_count>` **(** **)** 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:`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_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
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
@@ -121,34 +101,6 @@ Returns the fallback font at index ``idx``.
|
|||||||
|
|
||||||
Returns the number of fallback fonts.
|
Returns the number of fallback fonts.
|
||||||
|
|
||||||
.. _class_DynamicFont_get_font_data:
|
|
||||||
|
|
||||||
- :ref:`DynamicFontData<class_dynamicfontdata>` **get_font_data** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_DynamicFont_get_size:
|
|
||||||
|
|
||||||
- :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
|
|
||||||
|
|
||||||
Returns the given type of spacing in pixels. See ``SPACING\_\*`` constants.
|
|
||||||
|
|
||||||
.. _class_DynamicFont_get_use_filter:
|
|
||||||
|
|
||||||
- :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
|
|
||||||
|
|
||||||
Returns ``true`` if mipmapping is used.
|
|
||||||
|
|
||||||
.. _class_DynamicFont_remove_fallback:
|
.. _class_DynamicFont_remove_fallback:
|
||||||
|
|
||||||
- void **remove_fallback** **(** :ref:`int<class_int>` idx **)**
|
- void **remove_fallback** **(** :ref:`int<class_int>` idx **)**
|
||||||
@@ -161,34 +113,4 @@ Removes the fallback font at index ``idx``.
|
|||||||
|
|
||||||
Sets the fallback font at index ``idx``.
|
Sets the fallback font at index ``idx``.
|
||||||
|
|
||||||
.. _class_DynamicFont_set_font_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 **)**
|
|
||||||
|
|
||||||
Sets the font size.
|
|
||||||
|
|
||||||
.. _class_DynamicFont_set_spacing:
|
|
||||||
|
|
||||||
- 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 **)**
|
|
||||||
|
|
||||||
Set to ``true`` to use filtering.
|
|
||||||
|
|
||||||
.. _class_DynamicFont_set_use_mipmaps:
|
|
||||||
|
|
||||||
- void **set_use_mipmaps** **(** :ref:`bool<class_bool>` enable **)**
|
|
||||||
|
|
||||||
Set to ``true`` to use mipmapping.
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -16,15 +16,6 @@ Brief Description
|
|||||||
|
|
||||||
Used with :ref:`DynamicFont<class_dynamicfont>` to describe the location of a font file.
|
Used with :ref:`DynamicFont<class_dynamicfont>` to describe the location of a font file.
|
||||||
|
|
||||||
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 **)** |
|
|
||||||
+------------------------------+--------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -38,19 +29,3 @@ Description
|
|||||||
|
|
||||||
Used with :ref:`DynamicFont<class_dynamicfont>` to describe the location of a vector font file for dynamic rendering at runtime.
|
Used with :ref:`DynamicFont<class_dynamicfont>` to describe the location of a vector font file for dynamic rendering at runtime.
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_DynamicFontData_get_font_path:
|
|
||||||
|
|
||||||
- :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 **)**
|
|
||||||
|
|
||||||
Sets the font path.
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -19,24 +19,34 @@ Brief Description
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+-------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`_export_begin<class_EditorExportPlugin__export_begin>` **(** :ref:`PoolStringArray<class_poolstringarray>` features **)** virtual |
|
| void | :ref:`_export_begin<class_EditorExportPlugin__export_begin>` **(** :ref:`PoolStringArray<class_poolstringarray>` features, :ref:`bool<class_bool>` is_debug, :ref:`String<class_string>` path, :ref:`int<class_int>` flags **)** 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:`_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_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:`add_ios_bundle_file<class_EditorExportPlugin_add_ios_bundle_file>` **(** :ref:`String<class_string>` path **)** |
|
||||||
+-------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`skip<class_EditorExportPlugin_skip>` **(** **)** |
|
| void | :ref:`add_ios_cpp_code<class_EditorExportPlugin_add_ios_cpp_code>` **(** :ref:`String<class_string>` code **)** |
|
||||||
+-------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`add_ios_framework<class_EditorExportPlugin_add_ios_framework>` **(** :ref:`String<class_string>` path **)** |
|
||||||
|
+-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`add_ios_linker_flags<class_EditorExportPlugin_add_ios_linker_flags>` **(** :ref:`String<class_string>` flags **)** |
|
||||||
|
+-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`add_ios_plist_content<class_EditorExportPlugin_add_ios_plist_content>` **(** :ref:`String<class_string>` plist_content **)** |
|
||||||
|
+-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`add_shared_object<class_EditorExportPlugin_add_shared_object>` **(** :ref:`String<class_string>` path, :ref:`PoolStringArray<class_poolstringarray>` tags **)** |
|
||||||
|
+-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`skip<class_EditorExportPlugin_skip>` **(** **)** |
|
||||||
|
+-------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Member Function Description
|
Member Function Description
|
||||||
---------------------------
|
---------------------------
|
||||||
|
|
||||||
.. _class_EditorExportPlugin__export_begin:
|
.. _class_EditorExportPlugin__export_begin:
|
||||||
|
|
||||||
- void **_export_begin** **(** :ref:`PoolStringArray<class_poolstringarray>` features **)** virtual
|
- void **_export_begin** **(** :ref:`PoolStringArray<class_poolstringarray>` features, :ref:`bool<class_bool>` is_debug, :ref:`String<class_string>` path, :ref:`int<class_int>` flags **)** virtual
|
||||||
|
|
||||||
.. _class_EditorExportPlugin__export_file:
|
.. _class_EditorExportPlugin__export_file:
|
||||||
|
|
||||||
@@ -46,9 +56,29 @@ Member Function Description
|
|||||||
|
|
||||||
- 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_ios_bundle_file:
|
||||||
|
|
||||||
|
- void **add_ios_bundle_file** **(** :ref:`String<class_string>` path **)**
|
||||||
|
|
||||||
|
.. _class_EditorExportPlugin_add_ios_cpp_code:
|
||||||
|
|
||||||
|
- void **add_ios_cpp_code** **(** :ref:`String<class_string>` code **)**
|
||||||
|
|
||||||
|
.. _class_EditorExportPlugin_add_ios_framework:
|
||||||
|
|
||||||
|
- void **add_ios_framework** **(** :ref:`String<class_string>` path **)**
|
||||||
|
|
||||||
|
.. _class_EditorExportPlugin_add_ios_linker_flags:
|
||||||
|
|
||||||
|
- void **add_ios_linker_flags** **(** :ref:`String<class_string>` flags **)**
|
||||||
|
|
||||||
|
.. _class_EditorExportPlugin_add_ios_plist_content:
|
||||||
|
|
||||||
|
- void **add_ios_plist_content** **(** :ref:`String<class_string>` plist_content **)**
|
||||||
|
|
||||||
.. _class_EditorExportPlugin_add_shared_object:
|
.. _class_EditorExportPlugin_add_shared_object:
|
||||||
|
|
||||||
- void **add_shared_object** **(** :ref:`String<class_string>` path **)**
|
- void **add_shared_object** **(** :ref:`String<class_string>` path, :ref:`PoolStringArray<class_poolstringarray>` tags **)**
|
||||||
|
|
||||||
.. _class_EditorExportPlugin_skip:
|
.. _class_EditorExportPlugin_skip:
|
||||||
|
|
||||||
|
|||||||
@@ -149,7 +149,7 @@ Reloads the scene at the given path.
|
|||||||
|
|
||||||
- :ref:`int<class_int>` **save_scene** **(** **)**
|
- :ref:`int<class_int>` **save_scene** **(** **)**
|
||||||
|
|
||||||
Saves the scene. Returns either OK or ERR_CANT_CREATE. See :ref:`@Global Scope<class_@global scope>` constants.
|
Saves the scene. Returns either OK or ERR_CANT_CREATE. See :ref:`@GlobalScope<class_@globalscope>` constants.
|
||||||
|
|
||||||
.. _class_EditorInterface_save_scene_as:
|
.. _class_EditorInterface_save_scene_as:
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,33 @@
|
|||||||
|
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
||||||
|
.. DO NOT EDIT THIS FILE, but the EditorScenePostImport.xml source instead.
|
||||||
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
||||||
|
|
||||||
|
.. _class_EditorScenePostImport:
|
||||||
|
|
||||||
|
EditorScenePostImport
|
||||||
|
=====================
|
||||||
|
|
||||||
|
**Inherits:** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||||
|
|
||||||
|
**Category:** Core
|
||||||
|
|
||||||
|
Brief Description
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Member Functions
|
||||||
|
----------------
|
||||||
|
|
||||||
|
+-------+-------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| void | :ref:`post_import<class_EditorScenePostImport_post_import>` **(** :ref:`Object<class_object>` scene **)** virtual |
|
||||||
|
+-------+-------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
|
Member Function Description
|
||||||
|
---------------------------
|
||||||
|
|
||||||
|
.. _class_EditorScenePostImport_post_import:
|
||||||
|
|
||||||
|
- void **post_import** **(** :ref:`Object<class_object>` scene **)** virtual
|
||||||
|
|
||||||
|
|
||||||
@@ -26,13 +26,13 @@ Member Functions
|
|||||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_favorite_dirs<class_EditorSettings_get_favorite_dirs>` **(** **)** const |
|
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_favorite_dirs<class_EditorSettings_get_favorite_dirs>` **(** **)** const |
|
||||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`get_project_settings_path<class_EditorSettings_get_project_settings_path>` **(** **)** const |
|
| :ref:`String<class_string>` | :ref:`get_project_settings_dir<class_EditorSettings_get_project_settings_dir>` **(** **)** const |
|
||||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_recent_dirs<class_EditorSettings_get_recent_dirs>` **(** **)** const |
|
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_recent_dirs<class_EditorSettings_get_recent_dirs>` **(** **)** const |
|
||||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Variant<class_variant>` | :ref:`get_setting<class_EditorSettings_get_setting>` **(** :ref:`String<class_string>` name **)** const |
|
| :ref:`Variant<class_variant>` | :ref:`get_setting<class_EditorSettings_get_setting>` **(** :ref:`String<class_string>` name **)** const |
|
||||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`get_settings_path<class_EditorSettings_get_settings_path>` **(** **)** const |
|
| :ref:`String<class_string>` | :ref:`get_settings_dir<class_EditorSettings_get_settings_dir>` **(** **)** const |
|
||||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`has_setting<class_EditorSettings_has_setting>` **(** :ref:`String<class_string>` name **)** const |
|
| :ref:`bool<class_bool>` | :ref:`has_setting<class_EditorSettings_has_setting>` **(** :ref:`String<class_string>` name **)** const |
|
||||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -77,7 +77,7 @@ Member Function Description
|
|||||||
|
|
||||||
- void **add_property_info** **(** :ref:`Dictionary<class_dictionary>` info **)**
|
- void **add_property_info** **(** :ref:`Dictionary<class_dictionary>` info **)**
|
||||||
|
|
||||||
Add a custom property info to a property. The dictionary must contain: name::ref:`String<class_string>`(the name of the property) and type::ref:`int<class_int>`(see TYPE\_\* in :ref:`@Global Scope<class_@global scope>`), and optionally hint::ref:`int<class_int>`(see PROPERTY_HINT\_\* in :ref:`@Global Scope<class_@global scope>`), hint_string::ref:`String<class_string>`.
|
Add a custom property info to a property. The dictionary must contain: name::ref:`String<class_string>`(the name of the property) and type::ref:`int<class_int>`(see TYPE\_\* in :ref:`@GlobalScope<class_@globalscope>`), and optionally hint::ref:`int<class_int>`(see PROPERTY_HINT\_\* in :ref:`@GlobalScope<class_@globalscope>`), hint_string::ref:`String<class_string>`.
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
@@ -106,9 +106,9 @@ Erase a given setting (pass full property path).
|
|||||||
|
|
||||||
Get the list of favorite directories for this project.
|
Get the list of favorite directories for this project.
|
||||||
|
|
||||||
.. _class_EditorSettings_get_project_settings_path:
|
.. _class_EditorSettings_get_project_settings_dir:
|
||||||
|
|
||||||
- :ref:`String<class_string>` **get_project_settings_path** **(** **)** const
|
- :ref:`String<class_string>` **get_project_settings_dir** **(** **)** const
|
||||||
|
|
||||||
Get the specific project settings path. Projects all have a unique sub-directory inside the settings path where project specific settings are saved.
|
Get the specific project settings path. Projects all have a unique sub-directory inside the settings path where project specific settings are saved.
|
||||||
|
|
||||||
@@ -122,9 +122,9 @@ Get the list of recently visited folders in the file dialog for this project.
|
|||||||
|
|
||||||
- :ref:`Variant<class_variant>` **get_setting** **(** :ref:`String<class_string>` name **)** const
|
- :ref:`Variant<class_variant>` **get_setting** **(** :ref:`String<class_string>` name **)** const
|
||||||
|
|
||||||
.. _class_EditorSettings_get_settings_path:
|
.. _class_EditorSettings_get_settings_dir:
|
||||||
|
|
||||||
- :ref:`String<class_string>` **get_settings_path** **(** **)** const
|
- :ref:`String<class_string>` **get_settings_dir** **(** **)** const
|
||||||
|
|
||||||
Get the global settings path for the engine. Inside this path you can find some standard paths such as:
|
Get the global settings path for the engine. Inside this path you can find some standard paths such as:
|
||||||
|
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ Member Functions
|
|||||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`add_collision_segments<class_EditorSpatialGizmo_add_collision_segments>` **(** :ref:`PoolVector3Array<class_poolvector3array>` segments **)** |
|
| void | :ref:`add_collision_segments<class_EditorSpatialGizmo_add_collision_segments>` **(** :ref:`PoolVector3Array<class_poolvector3array>` segments **)** |
|
||||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`add_collision_triangles<class_EditorSpatialGizmo_add_collision_triangles>` **(** :ref:`TriangleMesh<class_trianglemesh>` triangles, :ref:`Rect3<class_rect3>` bounds **)** |
|
| void | :ref:`add_collision_triangles<class_EditorSpatialGizmo_add_collision_triangles>` **(** :ref:`TriangleMesh<class_trianglemesh>` triangles, :ref:`AABB<class_aabb>` bounds **)** |
|
||||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`add_handles<class_EditorSpatialGizmo_add_handles>` **(** :ref:`PoolVector3Array<class_poolvector3array>` handles, :ref:`bool<class_bool>` billboard=false, :ref:`bool<class_bool>` secondary=false **)** |
|
| void | :ref:`add_handles<class_EditorSpatialGizmo_add_handles>` **(** :ref:`PoolVector3Array<class_poolvector3array>` handles, :ref:`bool<class_bool>` billboard=false, :ref:`bool<class_bool>` secondary=false **)** |
|
||||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
@@ -61,7 +61,7 @@ Member Function Description
|
|||||||
|
|
||||||
.. _class_EditorSpatialGizmo_add_collision_triangles:
|
.. _class_EditorSpatialGizmo_add_collision_triangles:
|
||||||
|
|
||||||
- void **add_collision_triangles** **(** :ref:`TriangleMesh<class_trianglemesh>` triangles, :ref:`Rect3<class_rect3>` bounds **)**
|
- void **add_collision_triangles** **(** :ref:`TriangleMesh<class_trianglemesh>` triangles, :ref:`AABB<class_aabb>` bounds **)**
|
||||||
|
|
||||||
Add collision triangles to the gizmo for picking. A :ref:`TriangleMesh<class_trianglemesh>` can be generated from a regular :ref:`Mesh<class_mesh>` too. Call this function during :ref:`redraw<class_EditorSpatialGizmo_redraw>`.
|
Add collision triangles to the gizmo for picking. A :ref:`TriangleMesh<class_trianglemesh>` can be generated from a regular :ref:`Mesh<class_mesh>` too. Call this function during :ref:`redraw<class_EditorSpatialGizmo_redraw>`.
|
||||||
|
|
||||||
|
|||||||
@@ -28,12 +28,16 @@ Member Functions
|
|||||||
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`MainLoop<class_mainloop>` | :ref:`get_main_loop<class_Engine_get_main_loop>` **(** **)** const |
|
| :ref:`MainLoop<class_mainloop>` | :ref:`get_main_loop<class_Engine_get_main_loop>` **(** **)** const |
|
||||||
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`Object<class_object>` | :ref:`get_singleton<class_Engine_get_singleton>` **(** :ref:`String<class_string>` name **)** const |
|
||||||
|
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_target_fps<class_Engine_get_target_fps>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_target_fps<class_Engine_get_target_fps>` **(** **)** const |
|
||||||
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_time_scale<class_Engine_get_time_scale>` **(** **)** |
|
| :ref:`float<class_float>` | :ref:`get_time_scale<class_Engine_get_time_scale>` **(** **)** |
|
||||||
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Dictionary<class_dictionary>` | :ref:`get_version_info<class_Engine_get_version_info>` **(** **)** const |
|
| :ref:`Dictionary<class_dictionary>` | :ref:`get_version_info<class_Engine_get_version_info>` **(** **)** const |
|
||||||
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| :ref:`bool<class_bool>` | :ref:`has_singleton<class_Engine_has_singleton>` **(** :ref:`String<class_string>` name **)** const |
|
||||||
|
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_editor_hint<class_Engine_is_editor_hint>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_editor_hint<class_Engine_is_editor_hint>` **(** **)** const |
|
||||||
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_in_physics_frame<class_Engine_is_in_physics_frame>` **(** **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_in_physics_frame<class_Engine_is_in_physics_frame>` **(** **)** const |
|
||||||
@@ -79,6 +83,10 @@ Returns the number of fixed iterations per second (for fixed process and physics
|
|||||||
|
|
||||||
Returns the main loop object (see :ref:`MainLoop<class_mainloop>` and :ref:`SceneTree<class_scenetree>`).
|
Returns the main loop object (see :ref:`MainLoop<class_mainloop>` and :ref:`SceneTree<class_scenetree>`).
|
||||||
|
|
||||||
|
.. _class_Engine_get_singleton:
|
||||||
|
|
||||||
|
- :ref:`Object<class_object>` **get_singleton** **(** :ref:`String<class_string>` name **)** const
|
||||||
|
|
||||||
.. _class_Engine_get_target_fps:
|
.. _class_Engine_get_target_fps:
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_target_fps** **(** **)** const
|
- :ref:`float<class_float>` **get_target_fps** **(** **)** const
|
||||||
@@ -107,9 +115,13 @@ Returns the current engine version information in a Dictionary.
|
|||||||
|
|
||||||
"status" - Holds the status (e.g. "beta", "rc1", "rc2", ... "stable") as a String
|
"status" - Holds the status (e.g. "beta", "rc1", "rc2", ... "stable") as a String
|
||||||
|
|
||||||
"revision" - Holds the revision (e.g. "custom-build") as a String
|
"build" - Holds the build name (e.g. "custom-build") as a String
|
||||||
|
|
||||||
"string" - major + minor + patch + status + revision in a single String
|
"string" - major + minor + patch + status + build in a single String
|
||||||
|
|
||||||
|
.. _class_Engine_has_singleton:
|
||||||
|
|
||||||
|
- :ref:`bool<class_bool>` **has_singleton** **(** :ref:`String<class_string>` name **)** const
|
||||||
|
|
||||||
.. _class_Engine_is_editor_hint:
|
.. _class_Engine_is_editor_hint:
|
||||||
|
|
||||||
|
|||||||
@@ -16,295 +16,6 @@ Brief Description
|
|||||||
|
|
||||||
Resource for environment nodes (like :ref:`WorldEnvironment<class_worldenvironment>`) that define multiple rendering options.
|
Resource for environment nodes (like :ref:`WorldEnvironment<class_worldenvironment>`) that define multiple rendering options.
|
||||||
|
|
||||||
Member Functions
|
|
||||||
----------------
|
|
||||||
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_adjustment_brightness<class_Environment_get_adjustment_brightness>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`Texture<class_texture>` | :ref:`get_adjustment_color_correction<class_Environment_get_adjustment_color_correction>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_adjustment_contrast<class_Environment_get_adjustment_contrast>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_adjustment_saturation<class_Environment_get_adjustment_saturation>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`Color<class_color>` | :ref:`get_ambient_light_color<class_Environment_get_ambient_light_color>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_ambient_light_energy<class_Environment_get_ambient_light_energy>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_ambient_light_sky_contribution<class_Environment_get_ambient_light_sky_contribution>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`int<class_int>` | :ref:`get_background<class_Environment_get_background>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`Color<class_color>` | :ref:`get_bg_color<class_Environment_get_bg_color>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_bg_energy<class_Environment_get_bg_energy>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`int<class_int>` | :ref:`get_canvas_max_layer<class_Environment_get_canvas_max_layer>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_dof_blur_far_amount<class_Environment_get_dof_blur_far_amount>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_dof_blur_far_distance<class_Environment_get_dof_blur_far_distance>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`int<class_int>` | :ref:`get_dof_blur_far_quality<class_Environment_get_dof_blur_far_quality>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_dof_blur_far_transition<class_Environment_get_dof_blur_far_transition>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_dof_blur_near_amount<class_Environment_get_dof_blur_near_amount>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_dof_blur_near_distance<class_Environment_get_dof_blur_near_distance>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`int<class_int>` | :ref:`get_dof_blur_near_quality<class_Environment_get_dof_blur_near_quality>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_dof_blur_near_transition<class_Environment_get_dof_blur_near_transition>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`Color<class_color>` | :ref:`get_fog_color<class_Environment_get_fog_color>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_fog_depth_begin<class_Environment_get_fog_depth_begin>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_fog_depth_curve<class_Environment_get_fog_depth_curve>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_fog_height_curve<class_Environment_get_fog_height_curve>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_fog_height_max<class_Environment_get_fog_height_max>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_fog_height_min<class_Environment_get_fog_height_min>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_fog_sun_amount<class_Environment_get_fog_sun_amount>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`Color<class_color>` | :ref:`get_fog_sun_color<class_Environment_get_fog_sun_color>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_fog_transmit_curve<class_Environment_get_fog_transmit_curve>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`int<class_int>` | :ref:`get_glow_blend_mode<class_Environment_get_glow_blend_mode>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_glow_bloom<class_Environment_get_glow_bloom>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_glow_hdr_bleed_scale<class_Environment_get_glow_hdr_bleed_scale>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_glow_hdr_bleed_threshold<class_Environment_get_glow_hdr_bleed_threshold>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_glow_intensity<class_Environment_get_glow_intensity>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_glow_strength<class_Environment_get_glow_strength>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`Sky<class_sky>` | :ref:`get_sky<class_Environment_get_sky>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_sky_custom_fov<class_Environment_get_sky_custom_fov>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_ssao_bias<class_Environment_get_ssao_bias>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`int<class_int>` | :ref:`get_ssao_blur<class_Environment_get_ssao_blur>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`Color<class_color>` | :ref:`get_ssao_color<class_Environment_get_ssao_color>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_ssao_direct_light_affect<class_Environment_get_ssao_direct_light_affect>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_ssao_edge_sharpness<class_Environment_get_ssao_edge_sharpness>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_ssao_intensity<class_Environment_get_ssao_intensity>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_ssao_intensity2<class_Environment_get_ssao_intensity2>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`int<class_int>` | :ref:`get_ssao_quality<class_Environment_get_ssao_quality>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_ssao_radius<class_Environment_get_ssao_radius>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_ssao_radius2<class_Environment_get_ssao_radius2>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_ssr_depth_tolerance<class_Environment_get_ssr_depth_tolerance>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_ssr_fade_in<class_Environment_get_ssr_fade_in>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_ssr_fade_out<class_Environment_get_ssr_fade_out>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`int<class_int>` | :ref:`get_ssr_max_steps<class_Environment_get_ssr_max_steps>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`bool<class_bool>` | :ref:`get_tonemap_auto_exposure<class_Environment_get_tonemap_auto_exposure>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_tonemap_auto_exposure_grey<class_Environment_get_tonemap_auto_exposure_grey>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_tonemap_auto_exposure_max<class_Environment_get_tonemap_auto_exposure_max>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_tonemap_auto_exposure_min<class_Environment_get_tonemap_auto_exposure_min>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_tonemap_auto_exposure_speed<class_Environment_get_tonemap_auto_exposure_speed>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_tonemap_exposure<class_Environment_get_tonemap_exposure>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_tonemap_white<class_Environment_get_tonemap_white>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`int<class_int>` | :ref:`get_tonemapper<class_Environment_get_tonemapper>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_adjustment_enabled<class_Environment_is_adjustment_enabled>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_dof_blur_far_enabled<class_Environment_is_dof_blur_far_enabled>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_dof_blur_near_enabled<class_Environment_is_dof_blur_near_enabled>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_fog_depth_enabled<class_Environment_is_fog_depth_enabled>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_fog_enabled<class_Environment_is_fog_enabled>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_fog_height_enabled<class_Environment_is_fog_height_enabled>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_fog_transmit_enabled<class_Environment_is_fog_transmit_enabled>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_glow_bicubic_upscale_enabled<class_Environment_is_glow_bicubic_upscale_enabled>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_glow_enabled<class_Environment_is_glow_enabled>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_glow_level_enabled<class_Environment_is_glow_level_enabled>` **(** :ref:`int<class_int>` idx **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_ssao_enabled<class_Environment_is_ssao_enabled>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_ssr_enabled<class_Environment_is_ssr_enabled>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_ssr_rough<class_Environment_is_ssr_rough>` **(** **)** const |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_adjustment_brightness<class_Environment_set_adjustment_brightness>` **(** :ref:`float<class_float>` brightness **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_adjustment_color_correction<class_Environment_set_adjustment_color_correction>` **(** :ref:`Texture<class_texture>` color_correction **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_adjustment_contrast<class_Environment_set_adjustment_contrast>` **(** :ref:`float<class_float>` contrast **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_adjustment_enable<class_Environment_set_adjustment_enable>` **(** :ref:`bool<class_bool>` enabled **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_adjustment_saturation<class_Environment_set_adjustment_saturation>` **(** :ref:`float<class_float>` saturation **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_ambient_light_color<class_Environment_set_ambient_light_color>` **(** :ref:`Color<class_color>` color **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_ambient_light_energy<class_Environment_set_ambient_light_energy>` **(** :ref:`float<class_float>` energy **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_ambient_light_sky_contribution<class_Environment_set_ambient_light_sky_contribution>` **(** :ref:`float<class_float>` energy **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_background<class_Environment_set_background>` **(** :ref:`int<class_int>` mode **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_bg_color<class_Environment_set_bg_color>` **(** :ref:`Color<class_color>` color **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_bg_energy<class_Environment_set_bg_energy>` **(** :ref:`float<class_float>` energy **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_canvas_max_layer<class_Environment_set_canvas_max_layer>` **(** :ref:`int<class_int>` layer **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_dof_blur_far_amount<class_Environment_set_dof_blur_far_amount>` **(** :ref:`float<class_float>` intensity **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_dof_blur_far_distance<class_Environment_set_dof_blur_far_distance>` **(** :ref:`float<class_float>` intensity **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_dof_blur_far_enabled<class_Environment_set_dof_blur_far_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_dof_blur_far_quality<class_Environment_set_dof_blur_far_quality>` **(** :ref:`int<class_int>` intensity **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_dof_blur_far_transition<class_Environment_set_dof_blur_far_transition>` **(** :ref:`float<class_float>` intensity **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_dof_blur_near_amount<class_Environment_set_dof_blur_near_amount>` **(** :ref:`float<class_float>` intensity **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_dof_blur_near_distance<class_Environment_set_dof_blur_near_distance>` **(** :ref:`float<class_float>` intensity **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_dof_blur_near_enabled<class_Environment_set_dof_blur_near_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_dof_blur_near_quality<class_Environment_set_dof_blur_near_quality>` **(** :ref:`int<class_int>` level **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_dof_blur_near_transition<class_Environment_set_dof_blur_near_transition>` **(** :ref:`float<class_float>` intensity **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_fog_color<class_Environment_set_fog_color>` **(** :ref:`Color<class_color>` color **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_fog_depth_begin<class_Environment_set_fog_depth_begin>` **(** :ref:`float<class_float>` distance **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_fog_depth_curve<class_Environment_set_fog_depth_curve>` **(** :ref:`float<class_float>` curve **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_fog_depth_enabled<class_Environment_set_fog_depth_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_fog_enabled<class_Environment_set_fog_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_fog_height_curve<class_Environment_set_fog_height_curve>` **(** :ref:`float<class_float>` curve **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_fog_height_enabled<class_Environment_set_fog_height_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_fog_height_max<class_Environment_set_fog_height_max>` **(** :ref:`float<class_float>` height **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_fog_height_min<class_Environment_set_fog_height_min>` **(** :ref:`float<class_float>` height **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_fog_sun_amount<class_Environment_set_fog_sun_amount>` **(** :ref:`float<class_float>` amount **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_fog_sun_color<class_Environment_set_fog_sun_color>` **(** :ref:`Color<class_color>` color **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_fog_transmit_curve<class_Environment_set_fog_transmit_curve>` **(** :ref:`float<class_float>` curve **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_fog_transmit_enabled<class_Environment_set_fog_transmit_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_glow_bicubic_upscale<class_Environment_set_glow_bicubic_upscale>` **(** :ref:`bool<class_bool>` enabled **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_glow_blend_mode<class_Environment_set_glow_blend_mode>` **(** :ref:`int<class_int>` mode **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_glow_bloom<class_Environment_set_glow_bloom>` **(** :ref:`float<class_float>` amount **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_glow_enabled<class_Environment_set_glow_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_glow_hdr_bleed_scale<class_Environment_set_glow_hdr_bleed_scale>` **(** :ref:`float<class_float>` scale **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_glow_hdr_bleed_threshold<class_Environment_set_glow_hdr_bleed_threshold>` **(** :ref:`float<class_float>` threshold **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_glow_intensity<class_Environment_set_glow_intensity>` **(** :ref:`float<class_float>` intensity **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_glow_level<class_Environment_set_glow_level>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enabled **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_glow_strength<class_Environment_set_glow_strength>` **(** :ref:`float<class_float>` strength **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_sky<class_Environment_set_sky>` **(** :ref:`Sky<class_sky>` sky **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_sky_custom_fov<class_Environment_set_sky_custom_fov>` **(** :ref:`float<class_float>` scale **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_ssao_bias<class_Environment_set_ssao_bias>` **(** :ref:`float<class_float>` bias **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_ssao_blur<class_Environment_set_ssao_blur>` **(** :ref:`int<class_int>` mode **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_ssao_color<class_Environment_set_ssao_color>` **(** :ref:`Color<class_color>` color **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_ssao_direct_light_affect<class_Environment_set_ssao_direct_light_affect>` **(** :ref:`float<class_float>` amount **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_ssao_edge_sharpness<class_Environment_set_ssao_edge_sharpness>` **(** :ref:`float<class_float>` edge_sharpness **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_ssao_enabled<class_Environment_set_ssao_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_ssao_intensity<class_Environment_set_ssao_intensity>` **(** :ref:`float<class_float>` intensity **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_ssao_intensity2<class_Environment_set_ssao_intensity2>` **(** :ref:`float<class_float>` intensity **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_ssao_quality<class_Environment_set_ssao_quality>` **(** :ref:`int<class_int>` quality **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_ssao_radius<class_Environment_set_ssao_radius>` **(** :ref:`float<class_float>` radius **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_ssao_radius2<class_Environment_set_ssao_radius2>` **(** :ref:`float<class_float>` radius **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_ssr_depth_tolerance<class_Environment_set_ssr_depth_tolerance>` **(** :ref:`float<class_float>` depth_tolerance **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_ssr_enabled<class_Environment_set_ssr_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_ssr_fade_in<class_Environment_set_ssr_fade_in>` **(** :ref:`float<class_float>` fade_in **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_ssr_fade_out<class_Environment_set_ssr_fade_out>` **(** :ref:`float<class_float>` fade_out **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_ssr_max_steps<class_Environment_set_ssr_max_steps>` **(** :ref:`int<class_int>` max_steps **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_ssr_rough<class_Environment_set_ssr_rough>` **(** :ref:`bool<class_bool>` rough **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_tonemap_auto_exposure<class_Environment_set_tonemap_auto_exposure>` **(** :ref:`bool<class_bool>` auto_exposure **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_tonemap_auto_exposure_grey<class_Environment_set_tonemap_auto_exposure_grey>` **(** :ref:`float<class_float>` exposure_grey **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_tonemap_auto_exposure_max<class_Environment_set_tonemap_auto_exposure_max>` **(** :ref:`float<class_float>` exposure_max **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_tonemap_auto_exposure_min<class_Environment_set_tonemap_auto_exposure_min>` **(** :ref:`float<class_float>` exposure_min **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_tonemap_auto_exposure_speed<class_Environment_set_tonemap_auto_exposure_speed>` **(** :ref:`float<class_float>` exposure_speed **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_tonemap_exposure<class_Environment_set_tonemap_exposure>` **(** :ref:`float<class_float>` exposure **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_tonemap_white<class_Environment_set_tonemap_white>` **(** :ref:`float<class_float>` white **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_tonemapper<class_Environment_set_tonemapper>` **(** :ref:`int<class_int>` mode **)** |
|
|
||||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -661,575 +372,3 @@ Resource for environment nodes (like :ref:`WorldEnvironment<class_worldenvironme
|
|||||||
|
|
||||||
- Adjustments
|
- Adjustments
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_Environment_get_adjustment_brightness:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_adjustment_brightness** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_adjustment_color_correction:
|
|
||||||
|
|
||||||
- :ref:`Texture<class_texture>` **get_adjustment_color_correction** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_adjustment_contrast:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_adjustment_contrast** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_adjustment_saturation:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_adjustment_saturation** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_ambient_light_color:
|
|
||||||
|
|
||||||
- :ref:`Color<class_color>` **get_ambient_light_color** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_ambient_light_energy:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_ambient_light_energy** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_ambient_light_sky_contribution:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_ambient_light_sky_contribution** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_background:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_background** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_bg_color:
|
|
||||||
|
|
||||||
- :ref:`Color<class_color>` **get_bg_color** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_bg_energy:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_bg_energy** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_canvas_max_layer:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_canvas_max_layer** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_dof_blur_far_amount:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_dof_blur_far_amount** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_dof_blur_far_distance:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_dof_blur_far_distance** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_dof_blur_far_quality:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_dof_blur_far_quality** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_dof_blur_far_transition:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_dof_blur_far_transition** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_dof_blur_near_amount:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_dof_blur_near_amount** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_dof_blur_near_distance:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_dof_blur_near_distance** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_dof_blur_near_quality:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_dof_blur_near_quality** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_dof_blur_near_transition:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_dof_blur_near_transition** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_fog_color:
|
|
||||||
|
|
||||||
- :ref:`Color<class_color>` **get_fog_color** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_fog_depth_begin:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_fog_depth_begin** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_fog_depth_curve:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_fog_depth_curve** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_fog_height_curve:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_fog_height_curve** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_fog_height_max:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_fog_height_max** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_fog_height_min:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_fog_height_min** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_fog_sun_amount:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_fog_sun_amount** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_fog_sun_color:
|
|
||||||
|
|
||||||
- :ref:`Color<class_color>` **get_fog_sun_color** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_fog_transmit_curve:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_fog_transmit_curve** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_glow_blend_mode:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_glow_blend_mode** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_glow_bloom:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_glow_bloom** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_glow_hdr_bleed_scale:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_glow_hdr_bleed_scale** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_glow_hdr_bleed_threshold:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_glow_hdr_bleed_threshold** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_glow_intensity:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_glow_intensity** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_glow_strength:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_glow_strength** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_sky:
|
|
||||||
|
|
||||||
- :ref:`Sky<class_sky>` **get_sky** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_sky_custom_fov:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_sky_custom_fov** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_ssao_bias:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_ssao_bias** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_ssao_blur:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_ssao_blur** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_ssao_color:
|
|
||||||
|
|
||||||
- :ref:`Color<class_color>` **get_ssao_color** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_ssao_direct_light_affect:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_ssao_direct_light_affect** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_ssao_edge_sharpness:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_ssao_edge_sharpness** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_ssao_intensity:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_ssao_intensity** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_ssao_intensity2:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_ssao_intensity2** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_ssao_quality:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_ssao_quality** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_ssao_radius:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_ssao_radius** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_ssao_radius2:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_ssao_radius2** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_ssr_depth_tolerance:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_ssr_depth_tolerance** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_ssr_fade_in:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_ssr_fade_in** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_ssr_fade_out:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_ssr_fade_out** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_ssr_max_steps:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_ssr_max_steps** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_tonemap_auto_exposure:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **get_tonemap_auto_exposure** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_tonemap_auto_exposure_grey:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_tonemap_auto_exposure_grey** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_tonemap_auto_exposure_max:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_tonemap_auto_exposure_max** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_tonemap_auto_exposure_min:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_tonemap_auto_exposure_min** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_tonemap_auto_exposure_speed:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_tonemap_auto_exposure_speed** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_tonemap_exposure:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_tonemap_exposure** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_tonemap_white:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_tonemap_white** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_get_tonemapper:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_tonemapper** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_is_adjustment_enabled:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_adjustment_enabled** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_is_dof_blur_far_enabled:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_dof_blur_far_enabled** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_is_dof_blur_near_enabled:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_dof_blur_near_enabled** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_is_fog_depth_enabled:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_fog_depth_enabled** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_is_fog_enabled:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_fog_enabled** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_is_fog_height_enabled:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_fog_height_enabled** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_is_fog_transmit_enabled:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_fog_transmit_enabled** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_is_glow_bicubic_upscale_enabled:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_glow_bicubic_upscale_enabled** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_is_glow_enabled:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_glow_enabled** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_is_glow_level_enabled:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_glow_level_enabled** **(** :ref:`int<class_int>` idx **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_is_ssao_enabled:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_ssao_enabled** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_is_ssr_enabled:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_ssr_enabled** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_is_ssr_rough:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_ssr_rough** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_Environment_set_adjustment_brightness:
|
|
||||||
|
|
||||||
- void **set_adjustment_brightness** **(** :ref:`float<class_float>` brightness **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_adjustment_color_correction:
|
|
||||||
|
|
||||||
- void **set_adjustment_color_correction** **(** :ref:`Texture<class_texture>` color_correction **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_adjustment_contrast:
|
|
||||||
|
|
||||||
- void **set_adjustment_contrast** **(** :ref:`float<class_float>` contrast **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_adjustment_enable:
|
|
||||||
|
|
||||||
- void **set_adjustment_enable** **(** :ref:`bool<class_bool>` enabled **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_adjustment_saturation:
|
|
||||||
|
|
||||||
- void **set_adjustment_saturation** **(** :ref:`float<class_float>` saturation **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_ambient_light_color:
|
|
||||||
|
|
||||||
- void **set_ambient_light_color** **(** :ref:`Color<class_color>` color **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_ambient_light_energy:
|
|
||||||
|
|
||||||
- void **set_ambient_light_energy** **(** :ref:`float<class_float>` energy **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_ambient_light_sky_contribution:
|
|
||||||
|
|
||||||
- void **set_ambient_light_sky_contribution** **(** :ref:`float<class_float>` energy **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_background:
|
|
||||||
|
|
||||||
- void **set_background** **(** :ref:`int<class_int>` mode **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_bg_color:
|
|
||||||
|
|
||||||
- void **set_bg_color** **(** :ref:`Color<class_color>` color **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_bg_energy:
|
|
||||||
|
|
||||||
- void **set_bg_energy** **(** :ref:`float<class_float>` energy **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_canvas_max_layer:
|
|
||||||
|
|
||||||
- void **set_canvas_max_layer** **(** :ref:`int<class_int>` layer **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_dof_blur_far_amount:
|
|
||||||
|
|
||||||
- void **set_dof_blur_far_amount** **(** :ref:`float<class_float>` intensity **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_dof_blur_far_distance:
|
|
||||||
|
|
||||||
- void **set_dof_blur_far_distance** **(** :ref:`float<class_float>` intensity **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_dof_blur_far_enabled:
|
|
||||||
|
|
||||||
- void **set_dof_blur_far_enabled** **(** :ref:`bool<class_bool>` enabled **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_dof_blur_far_quality:
|
|
||||||
|
|
||||||
- void **set_dof_blur_far_quality** **(** :ref:`int<class_int>` intensity **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_dof_blur_far_transition:
|
|
||||||
|
|
||||||
- void **set_dof_blur_far_transition** **(** :ref:`float<class_float>` intensity **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_dof_blur_near_amount:
|
|
||||||
|
|
||||||
- void **set_dof_blur_near_amount** **(** :ref:`float<class_float>` intensity **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_dof_blur_near_distance:
|
|
||||||
|
|
||||||
- void **set_dof_blur_near_distance** **(** :ref:`float<class_float>` intensity **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_dof_blur_near_enabled:
|
|
||||||
|
|
||||||
- void **set_dof_blur_near_enabled** **(** :ref:`bool<class_bool>` enabled **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_dof_blur_near_quality:
|
|
||||||
|
|
||||||
- void **set_dof_blur_near_quality** **(** :ref:`int<class_int>` level **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_dof_blur_near_transition:
|
|
||||||
|
|
||||||
- void **set_dof_blur_near_transition** **(** :ref:`float<class_float>` intensity **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_fog_color:
|
|
||||||
|
|
||||||
- void **set_fog_color** **(** :ref:`Color<class_color>` color **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_fog_depth_begin:
|
|
||||||
|
|
||||||
- void **set_fog_depth_begin** **(** :ref:`float<class_float>` distance **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_fog_depth_curve:
|
|
||||||
|
|
||||||
- void **set_fog_depth_curve** **(** :ref:`float<class_float>` curve **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_fog_depth_enabled:
|
|
||||||
|
|
||||||
- void **set_fog_depth_enabled** **(** :ref:`bool<class_bool>` enabled **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_fog_enabled:
|
|
||||||
|
|
||||||
- void **set_fog_enabled** **(** :ref:`bool<class_bool>` enabled **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_fog_height_curve:
|
|
||||||
|
|
||||||
- void **set_fog_height_curve** **(** :ref:`float<class_float>` curve **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_fog_height_enabled:
|
|
||||||
|
|
||||||
- void **set_fog_height_enabled** **(** :ref:`bool<class_bool>` enabled **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_fog_height_max:
|
|
||||||
|
|
||||||
- void **set_fog_height_max** **(** :ref:`float<class_float>` height **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_fog_height_min:
|
|
||||||
|
|
||||||
- void **set_fog_height_min** **(** :ref:`float<class_float>` height **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_fog_sun_amount:
|
|
||||||
|
|
||||||
- void **set_fog_sun_amount** **(** :ref:`float<class_float>` amount **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_fog_sun_color:
|
|
||||||
|
|
||||||
- void **set_fog_sun_color** **(** :ref:`Color<class_color>` color **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_fog_transmit_curve:
|
|
||||||
|
|
||||||
- void **set_fog_transmit_curve** **(** :ref:`float<class_float>` curve **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_fog_transmit_enabled:
|
|
||||||
|
|
||||||
- void **set_fog_transmit_enabled** **(** :ref:`bool<class_bool>` enabled **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_glow_bicubic_upscale:
|
|
||||||
|
|
||||||
- void **set_glow_bicubic_upscale** **(** :ref:`bool<class_bool>` enabled **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_glow_blend_mode:
|
|
||||||
|
|
||||||
- void **set_glow_blend_mode** **(** :ref:`int<class_int>` mode **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_glow_bloom:
|
|
||||||
|
|
||||||
- void **set_glow_bloom** **(** :ref:`float<class_float>` amount **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_glow_enabled:
|
|
||||||
|
|
||||||
- void **set_glow_enabled** **(** :ref:`bool<class_bool>` enabled **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_glow_hdr_bleed_scale:
|
|
||||||
|
|
||||||
- void **set_glow_hdr_bleed_scale** **(** :ref:`float<class_float>` scale **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_glow_hdr_bleed_threshold:
|
|
||||||
|
|
||||||
- void **set_glow_hdr_bleed_threshold** **(** :ref:`float<class_float>` threshold **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_glow_intensity:
|
|
||||||
|
|
||||||
- void **set_glow_intensity** **(** :ref:`float<class_float>` intensity **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_glow_level:
|
|
||||||
|
|
||||||
- void **set_glow_level** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enabled **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_glow_strength:
|
|
||||||
|
|
||||||
- void **set_glow_strength** **(** :ref:`float<class_float>` strength **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_sky:
|
|
||||||
|
|
||||||
- void **set_sky** **(** :ref:`Sky<class_sky>` sky **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_sky_custom_fov:
|
|
||||||
|
|
||||||
- void **set_sky_custom_fov** **(** :ref:`float<class_float>` scale **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_ssao_bias:
|
|
||||||
|
|
||||||
- void **set_ssao_bias** **(** :ref:`float<class_float>` bias **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_ssao_blur:
|
|
||||||
|
|
||||||
- void **set_ssao_blur** **(** :ref:`int<class_int>` mode **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_ssao_color:
|
|
||||||
|
|
||||||
- void **set_ssao_color** **(** :ref:`Color<class_color>` color **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_ssao_direct_light_affect:
|
|
||||||
|
|
||||||
- void **set_ssao_direct_light_affect** **(** :ref:`float<class_float>` amount **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_ssao_edge_sharpness:
|
|
||||||
|
|
||||||
- void **set_ssao_edge_sharpness** **(** :ref:`float<class_float>` edge_sharpness **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_ssao_enabled:
|
|
||||||
|
|
||||||
- void **set_ssao_enabled** **(** :ref:`bool<class_bool>` enabled **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_ssao_intensity:
|
|
||||||
|
|
||||||
- void **set_ssao_intensity** **(** :ref:`float<class_float>` intensity **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_ssao_intensity2:
|
|
||||||
|
|
||||||
- void **set_ssao_intensity2** **(** :ref:`float<class_float>` intensity **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_ssao_quality:
|
|
||||||
|
|
||||||
- void **set_ssao_quality** **(** :ref:`int<class_int>` quality **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_ssao_radius:
|
|
||||||
|
|
||||||
- void **set_ssao_radius** **(** :ref:`float<class_float>` radius **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_ssao_radius2:
|
|
||||||
|
|
||||||
- void **set_ssao_radius2** **(** :ref:`float<class_float>` radius **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_ssr_depth_tolerance:
|
|
||||||
|
|
||||||
- void **set_ssr_depth_tolerance** **(** :ref:`float<class_float>` depth_tolerance **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_ssr_enabled:
|
|
||||||
|
|
||||||
- void **set_ssr_enabled** **(** :ref:`bool<class_bool>` enabled **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_ssr_fade_in:
|
|
||||||
|
|
||||||
- void **set_ssr_fade_in** **(** :ref:`float<class_float>` fade_in **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_ssr_fade_out:
|
|
||||||
|
|
||||||
- void **set_ssr_fade_out** **(** :ref:`float<class_float>` fade_out **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_ssr_max_steps:
|
|
||||||
|
|
||||||
- void **set_ssr_max_steps** **(** :ref:`int<class_int>` max_steps **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_ssr_rough:
|
|
||||||
|
|
||||||
- void **set_ssr_rough** **(** :ref:`bool<class_bool>` rough **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_tonemap_auto_exposure:
|
|
||||||
|
|
||||||
- void **set_tonemap_auto_exposure** **(** :ref:`bool<class_bool>` auto_exposure **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_tonemap_auto_exposure_grey:
|
|
||||||
|
|
||||||
- void **set_tonemap_auto_exposure_grey** **(** :ref:`float<class_float>` exposure_grey **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_tonemap_auto_exposure_max:
|
|
||||||
|
|
||||||
- void **set_tonemap_auto_exposure_max** **(** :ref:`float<class_float>` exposure_max **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_tonemap_auto_exposure_min:
|
|
||||||
|
|
||||||
- void **set_tonemap_auto_exposure_min** **(** :ref:`float<class_float>` exposure_min **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_tonemap_auto_exposure_speed:
|
|
||||||
|
|
||||||
- void **set_tonemap_auto_exposure_speed** **(** :ref:`float<class_float>` exposure_speed **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_tonemap_exposure:
|
|
||||||
|
|
||||||
- void **set_tonemap_exposure** **(** :ref:`float<class_float>` exposure **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_tonemap_white:
|
|
||||||
|
|
||||||
- void **set_tonemap_white** **(** :ref:`float<class_float>` white **)**
|
|
||||||
|
|
||||||
.. _class_Environment_set_tonemapper:
|
|
||||||
|
|
||||||
- void **set_tonemapper** **(** :ref:`int<class_int>` mode **)**
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -220,7 +220,7 @@ Returns ``true`` if endian swap is enabled for this file.
|
|||||||
|
|
||||||
- :ref:`int<class_int>` **get_error** **(** **)** const
|
- :ref:`int<class_int>` **get_error** **(** **)** const
|
||||||
|
|
||||||
Returns the last error that happened when trying to perform operations. Compare with the ``ERR_FILE\_\*`` constants from :ref:`@Global Scope<class_@global scope>`.
|
Returns the last error that happened when trying to perform operations. Compare with the ``ERR_FILE\_\*`` constants from :ref:`@GlobalScope<class_@globalscope>`.
|
||||||
|
|
||||||
.. _class_File_get_float:
|
.. _class_File_get_float:
|
||||||
|
|
||||||
|
|||||||
@@ -19,43 +19,27 @@ Dialog for selecting files or directories in the filesystem.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`add_filter<class_FileDialog_add_filter>` **(** :ref:`String<class_string>` filter **)** |
|
| void | :ref:`add_filter<class_FileDialog_add_filter>` **(** :ref:`String<class_string>` filter **)** |
|
||||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`clear_filters<class_FileDialog_clear_filters>` **(** **)** |
|
| void | :ref:`clear_filters<class_FileDialog_clear_filters>` **(** **)** |
|
||||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_access<class_FileDialog_get_access>` **(** **)** const |
|
| :ref:`String<class_string>` | :ref:`get_current_dir<class_FileDialog_get_current_dir>` **(** **)** const |
|
||||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`get_current_dir<class_FileDialog_get_current_dir>` **(** **)** const |
|
| :ref:`String<class_string>` | :ref:`get_current_file<class_FileDialog_get_current_file>` **(** **)** const |
|
||||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`get_current_file<class_FileDialog_get_current_file>` **(** **)** const |
|
| :ref:`String<class_string>` | :ref:`get_current_path<class_FileDialog_get_current_path>` **(** **)** const |
|
||||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`get_current_path<class_FileDialog_get_current_path>` **(** **)** const |
|
| :ref:`VBoxContainer<class_vboxcontainer>` | :ref:`get_vbox<class_FileDialog_get_vbox>` **(** **)** |
|
||||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_filters<class_FileDialog_get_filters>` **(** **)** const |
|
| void | :ref:`invalidate<class_FileDialog_invalidate>` **(** **)** |
|
||||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_mode<class_FileDialog_get_mode>` **(** **)** const |
|
| void | :ref:`set_current_dir<class_FileDialog_set_current_dir>` **(** :ref:`String<class_string>` dir **)** |
|
||||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`VBoxContainer<class_vboxcontainer>` | :ref:`get_vbox<class_FileDialog_get_vbox>` **(** **)** |
|
| void | :ref:`set_current_file<class_FileDialog_set_current_file>` **(** :ref:`String<class_string>` file **)** |
|
||||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`invalidate<class_FileDialog_invalidate>` **(** **)** |
|
| void | :ref:`set_current_path<class_FileDialog_set_current_path>` **(** :ref:`String<class_string>` path **)** |
|
||||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------------------+---------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_showing_hidden_files<class_FileDialog_is_showing_hidden_files>` **(** **)** const |
|
|
||||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_access<class_FileDialog_set_access>` **(** :ref:`int<class_int>` access **)** |
|
|
||||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_current_dir<class_FileDialog_set_current_dir>` **(** :ref:`String<class_string>` dir **)** |
|
|
||||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_current_file<class_FileDialog_set_current_file>` **(** :ref:`String<class_string>` file **)** |
|
|
||||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_current_path<class_FileDialog_set_current_path>` **(** :ref:`String<class_string>` path **)** |
|
|
||||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_filters<class_FileDialog_set_filters>` **(** :ref:`PoolStringArray<class_poolstringarray>` filters **)** |
|
|
||||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_mode<class_FileDialog_set_mode>` **(** :ref:`int<class_int>` mode **)** |
|
|
||||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_show_hidden_files<class_FileDialog_set_show_hidden_files>` **(** :ref:`bool<class_bool>` show **)** |
|
|
||||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Signals
|
Signals
|
||||||
-------
|
-------
|
||||||
@@ -131,12 +115,6 @@ Add a custom filter. Filter format is: "mask ; description", example (C++): dial
|
|||||||
|
|
||||||
Clear all the added filters in the dialog.
|
Clear all the added filters in the dialog.
|
||||||
|
|
||||||
.. _class_FileDialog_get_access:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_access** **(** **)** const
|
|
||||||
|
|
||||||
Return the file access permission of the dialog.
|
|
||||||
|
|
||||||
.. _class_FileDialog_get_current_dir:
|
.. _class_FileDialog_get_current_dir:
|
||||||
|
|
||||||
- :ref:`String<class_string>` **get_current_dir** **(** **)** const
|
- :ref:`String<class_string>` **get_current_dir** **(** **)** const
|
||||||
@@ -155,16 +133,6 @@ Get the current selected file of the file dialog (empty if none).
|
|||||||
|
|
||||||
Get the current selected path (directory and file) of the file dialog (empty if none).
|
Get the current selected path (directory and file) of the file dialog (empty if none).
|
||||||
|
|
||||||
.. _class_FileDialog_get_filters:
|
|
||||||
|
|
||||||
- :ref:`PoolStringArray<class_poolstringarray>` **get_filters** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_FileDialog_get_mode:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_mode** **(** **)** const
|
|
||||||
|
|
||||||
Get the file dialog mode from the MODE\_\* enum.
|
|
||||||
|
|
||||||
.. _class_FileDialog_get_vbox:
|
.. _class_FileDialog_get_vbox:
|
||||||
|
|
||||||
- :ref:`VBoxContainer<class_vboxcontainer>` **get_vbox** **(** **)**
|
- :ref:`VBoxContainer<class_vboxcontainer>` **get_vbox** **(** **)**
|
||||||
@@ -177,18 +145,6 @@ Return the vertical box container of the dialog, custom controls can be added to
|
|||||||
|
|
||||||
Invalidate and update the current dialog content list.
|
Invalidate and update the current dialog content list.
|
||||||
|
|
||||||
.. _class_FileDialog_is_showing_hidden_files:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_showing_hidden_files** **(** **)** const
|
|
||||||
|
|
||||||
Return true if the dialog allows show hidden files.
|
|
||||||
|
|
||||||
.. _class_FileDialog_set_access:
|
|
||||||
|
|
||||||
- void **set_access** **(** :ref:`int<class_int>` access **)**
|
|
||||||
|
|
||||||
Set the file access permission of the dialog(Must be one of ACCESS_RESOURCES, ACCESS_USERDATA or ACCESS_FILESYSTEM).
|
|
||||||
|
|
||||||
.. _class_FileDialog_set_current_dir:
|
.. _class_FileDialog_set_current_dir:
|
||||||
|
|
||||||
- void **set_current_dir** **(** :ref:`String<class_string>` dir **)**
|
- void **set_current_dir** **(** :ref:`String<class_string>` dir **)**
|
||||||
@@ -207,20 +163,4 @@ Set the current selected file name of the file dialog.
|
|||||||
|
|
||||||
Set the current selected file path of the file dialog.
|
Set the current selected file path of the file dialog.
|
||||||
|
|
||||||
.. _class_FileDialog_set_filters:
|
|
||||||
|
|
||||||
- void **set_filters** **(** :ref:`PoolStringArray<class_poolstringarray>` filters **)**
|
|
||||||
|
|
||||||
.. _class_FileDialog_set_mode:
|
|
||||||
|
|
||||||
- void **set_mode** **(** :ref:`int<class_int>` mode **)**
|
|
||||||
|
|
||||||
Set the file dialog mode from the MODE\_\* enum.
|
|
||||||
|
|
||||||
.. _class_FileDialog_set_show_hidden_files:
|
|
||||||
|
|
||||||
- void **set_show_hidden_files** **(** :ref:`bool<class_bool>` show **)**
|
|
||||||
|
|
||||||
Set the dialog should show hidden files.
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -19,17 +19,13 @@ Brief Description
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Variant<class_variant>` | :ref:`call_native<class_GDNative_call_native>` **(** :ref:`String<class_string>` calling_type, :ref:`String<class_string>` procedure_name, :ref:`Array<class_array>` arguments **)** |
|
| :ref:`Variant<class_variant>` | :ref:`call_native<class_GDNative_call_native>` **(** :ref:`String<class_string>` calling_type, :ref:`String<class_string>` procedure_name, :ref:`Array<class_array>` arguments **)** |
|
||||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`GDNativeLibrary<class_gdnativelibrary>` | :ref:`get_library<class_GDNative_get_library>` **(** **)** |
|
| :ref:`bool<class_bool>` | :ref:`initialize<class_GDNative_initialize>` **(** **)** |
|
||||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`initialize<class_GDNative_initialize>` **(** **)** |
|
| :ref:`bool<class_bool>` | :ref:`terminate<class_GDNative_terminate>` **(** **)** |
|
||||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_library<class_GDNative_set_library>` **(** :ref:`GDNativeLibrary<class_gdnativelibrary>` library **)** |
|
|
||||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`bool<class_bool>` | :ref:`terminate<class_GDNative_terminate>` **(** **)** |
|
|
||||||
+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
@@ -46,18 +42,10 @@ Member Function Description
|
|||||||
|
|
||||||
- :ref:`Variant<class_variant>` **call_native** **(** :ref:`String<class_string>` calling_type, :ref:`String<class_string>` procedure_name, :ref:`Array<class_array>` arguments **)**
|
- :ref:`Variant<class_variant>` **call_native** **(** :ref:`String<class_string>` calling_type, :ref:`String<class_string>` procedure_name, :ref:`Array<class_array>` arguments **)**
|
||||||
|
|
||||||
.. _class_GDNative_get_library:
|
|
||||||
|
|
||||||
- :ref:`GDNativeLibrary<class_gdnativelibrary>` **get_library** **(** **)**
|
|
||||||
|
|
||||||
.. _class_GDNative_initialize:
|
.. _class_GDNative_initialize:
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **initialize** **(** **)**
|
- :ref:`bool<class_bool>` **initialize** **(** **)**
|
||||||
|
|
||||||
.. _class_GDNative_set_library:
|
|
||||||
|
|
||||||
- void **set_library** **(** :ref:`GDNativeLibrary<class_gdnativelibrary>` library **)**
|
|
||||||
|
|
||||||
.. _class_GDNative_terminate:
|
.. _class_GDNative_terminate:
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **terminate** **(** **)**
|
- :ref:`bool<class_bool>` **terminate** **(** **)**
|
||||||
|
|||||||
@@ -19,47 +19,43 @@ Brief Description
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+---------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`get_active_library_path<class_GDNativeLibrary_get_active_library_path>` **(** **)** const |
|
| :ref:`ConfigFile<class_configfile>` | :ref:`get_config_file<class_GDNativeLibrary_get_config_file>` **(** **)** |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+---------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`String<class_string>` | :ref:`get_library_path<class_GDNativeLibrary_get_library_path>` **(** :ref:`String<class_string>` platform **)** const |
|
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_current_dependencies<class_GDNativeLibrary_get_current_dependencies>` **(** **)** const |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+---------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_singleton_gdnative<class_GDNativeLibrary_is_singleton_gdnative>` **(** **)** const |
|
| :ref:`String<class_string>` | :ref:`get_current_library_path<class_GDNativeLibrary_get_current_library_path>` **(** **)** const |
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------------------------+---------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_library_path<class_GDNativeLibrary_set_library_path>` **(** :ref:`String<class_string>` platform, :ref:`String<class_string>` path **)** |
|
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_singleton_gdnative<class_GDNativeLibrary_set_singleton_gdnative>` **(** :ref:`bool<class_bool>` singleton **)** |
|
|
||||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
.. _class_GDNativeLibrary_singleton_gdnative:
|
.. _class_GDNativeLibrary_load_once:
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **singleton_gdnative**
|
- :ref:`bool<class_bool>` **load_once**
|
||||||
|
|
||||||
|
.. _class_GDNativeLibrary_singleton:
|
||||||
|
|
||||||
|
- :ref:`bool<class_bool>` **singleton**
|
||||||
|
|
||||||
|
.. _class_GDNativeLibrary_symbol_prefix:
|
||||||
|
|
||||||
|
- :ref:`String<class_string>` **symbol_prefix**
|
||||||
|
|
||||||
|
|
||||||
Member Function Description
|
Member Function Description
|
||||||
---------------------------
|
---------------------------
|
||||||
|
|
||||||
.. _class_GDNativeLibrary_get_active_library_path:
|
.. _class_GDNativeLibrary_get_config_file:
|
||||||
|
|
||||||
- :ref:`String<class_string>` **get_active_library_path** **(** **)** const
|
- :ref:`ConfigFile<class_configfile>` **get_config_file** **(** **)**
|
||||||
|
|
||||||
.. _class_GDNativeLibrary_get_library_path:
|
.. _class_GDNativeLibrary_get_current_dependencies:
|
||||||
|
|
||||||
- :ref:`String<class_string>` **get_library_path** **(** :ref:`String<class_string>` platform **)** const
|
- :ref:`PoolStringArray<class_poolstringarray>` **get_current_dependencies** **(** **)** const
|
||||||
|
|
||||||
.. _class_GDNativeLibrary_is_singleton_gdnative:
|
.. _class_GDNativeLibrary_get_current_library_path:
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_singleton_gdnative** **(** **)** const
|
- :ref:`String<class_string>` **get_current_library_path** **(** **)** const
|
||||||
|
|
||||||
.. _class_GDNativeLibrary_set_library_path:
|
|
||||||
|
|
||||||
- void **set_library_path** **(** :ref:`String<class_string>` platform, :ref:`String<class_string>` path **)**
|
|
||||||
|
|
||||||
.. _class_GDNativeLibrary_set_singleton_gdnative:
|
|
||||||
|
|
||||||
- void **set_singleton_gdnative** **(** :ref:`bool<class_bool>` singleton **)**
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,11 +1,11 @@
|
|||||||
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
||||||
.. DO NOT EDIT THIS FILE, but the GDFunctionState.xml source instead.
|
.. DO NOT EDIT THIS FILE, but the GDScriptFunctionState.xml source instead.
|
||||||
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
||||||
|
|
||||||
.. _class_GDFunctionState:
|
.. _class_GDScriptFunctionState:
|
||||||
|
|
||||||
GDFunctionState
|
GDScriptFunctionState
|
||||||
===============
|
=====================
|
||||||
|
|
||||||
**Inherits:** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
**Inherits:** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||||
|
|
||||||
@@ -19,16 +19,16 @@ State of a function call after yielding.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_valid<class_GDFunctionState_is_valid>` **(** :ref:`bool<class_bool>` extended_check=false **)** const |
|
| :ref:`bool<class_bool>` | :ref:`is_valid<class_GDScriptFunctionState_is_valid>` **(** :ref:`bool<class_bool>` extended_check=false **)** const |
|
||||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Variant<class_variant>` | :ref:`resume<class_GDFunctionState_resume>` **(** :ref:`Variant<class_variant>` arg=null **)** |
|
| :ref:`Variant<class_variant>` | :ref:`resume<class_GDScriptFunctionState_resume>` **(** :ref:`Variant<class_variant>` arg=null **)** |
|
||||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------+
|
+--------------------------------+----------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Signals
|
Signals
|
||||||
-------
|
-------
|
||||||
|
|
||||||
.. _class_GDFunctionState_completed:
|
.. _class_GDScriptFunctionState_completed:
|
||||||
|
|
||||||
- **completed** **(** :ref:`Nil<class_nil>` result **)**
|
- **completed** **(** :ref:`Nil<class_nil>` result **)**
|
||||||
|
|
||||||
@@ -36,20 +36,20 @@ Signals
|
|||||||
Description
|
Description
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
Calling :ref:`@GDScript.yield<class_@GDScript_yield>` within a function will cause that function to yield and return its current state as an object of this type. The yielded function call can then be resumed later by calling :ref:`resume<class_GDFunctionState_resume>` on this state object.
|
Calling :ref:`@GDScript.yield<class_@GDScript_yield>` within a function will cause that function to yield and return its current state as an object of this type. The yielded function call can then be resumed later by calling :ref:`resume<class_GDScriptFunctionState_resume>` on this state object.
|
||||||
|
|
||||||
Member Function Description
|
Member Function Description
|
||||||
---------------------------
|
---------------------------
|
||||||
|
|
||||||
.. _class_GDFunctionState_is_valid:
|
.. _class_GDScriptFunctionState_is_valid:
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_valid** **(** :ref:`bool<class_bool>` extended_check=false **)** const
|
- :ref:`bool<class_bool>` **is_valid** **(** :ref:`bool<class_bool>` extended_check=false **)** const
|
||||||
|
|
||||||
Check whether the function call may be resumed. This is not the case if the function state was already resumed.
|
Check whether the function call may be resumed. This is not the case if the function state was already resumed.
|
||||||
|
|
||||||
If ``extended_check`` is enabled, it also checks if the associated script and object still exist. The extended check is done in debug mode as part of :ref:`GDFunctionState.resume<class_GDFunctionState_resume>`, but you can use this if you know you may be trying to resume without knowing for sure the object and/or script have survived up to that point.
|
If ``extended_check`` is enabled, it also checks if the associated script and object still exist. The extended check is done in debug mode as part of :ref:`GDScriptFunctionState.resume<class_GDScriptFunctionState_resume>`, but you can use this if you know you may be trying to resume without knowing for sure the object and/or script have survived up to that point.
|
||||||
|
|
||||||
.. _class_GDFunctionState_resume:
|
.. _class_GDScriptFunctionState_resume:
|
||||||
|
|
||||||
- :ref:`Variant<class_variant>` **resume** **(** :ref:`Variant<class_variant>` arg=null **)**
|
- :ref:`Variant<class_variant>` **resume** **(** :ref:`Variant<class_variant>` arg=null **)**
|
||||||
|
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
||||||
.. DO NOT EDIT THIS FILE, but the GDNativeClass.xml source instead.
|
.. DO NOT EDIT THIS FILE, but the GDScriptNativeClass.xml source instead.
|
||||||
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
||||||
|
|
||||||
.. _class_GDNativeClass:
|
.. _class_GDScriptNativeClass:
|
||||||
|
|
||||||
GDNativeClass
|
GDScriptNativeClass
|
||||||
=============
|
===================
|
||||||
|
|
||||||
**Inherits:** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
**Inherits:** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||||
|
|
||||||
@@ -19,14 +19,14 @@ Brief Description
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+--------------------------------+-------------------------------------------------+
|
+--------------------------------+-------------------------------------------------------+
|
||||||
| :ref:`Variant<class_variant>` | :ref:`new<class_GDNativeClass_new>` **(** **)** |
|
| :ref:`Variant<class_variant>` | :ref:`new<class_GDScriptNativeClass_new>` **(** **)** |
|
||||||
+--------------------------------+-------------------------------------------------+
|
+--------------------------------+-------------------------------------------------------+
|
||||||
|
|
||||||
Member Function Description
|
Member Function Description
|
||||||
---------------------------
|
---------------------------
|
||||||
|
|
||||||
.. _class_GDNativeClass_new:
|
.. _class_GDScriptNativeClass_new:
|
||||||
|
|
||||||
- :ref:`Variant<class_variant>` **new** **(** **)**
|
- :ref:`Variant<class_variant>` **new** **(** **)**
|
||||||
|
|
||||||
@@ -16,35 +16,6 @@ Brief Description
|
|||||||
|
|
||||||
The generic 6 degrees of freedom joint can implement a variety of joint-types by locking certain axes' rotation or translation.
|
The generic 6 degrees of freedom joint can implement a variety of joint-types by locking certain axes' rotation or translation.
|
||||||
|
|
||||||
Member Functions
|
|
||||||
----------------
|
|
||||||
|
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`bool<class_bool>` | :ref:`get_flag_x<class_Generic6DOFJoint_get_flag_x>` **(** :ref:`int<class_int>` flag **)** const |
|
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`bool<class_bool>` | :ref:`get_flag_y<class_Generic6DOFJoint_get_flag_y>` **(** :ref:`int<class_int>` flag **)** const |
|
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`bool<class_bool>` | :ref:`get_flag_z<class_Generic6DOFJoint_get_flag_z>` **(** :ref:`int<class_int>` flag **)** const |
|
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_param_x<class_Generic6DOFJoint_get_param_x>` **(** :ref:`int<class_int>` param **)** const |
|
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_param_y<class_Generic6DOFJoint_get_param_y>` **(** :ref:`int<class_int>` param **)** const |
|
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_param_z<class_Generic6DOFJoint_get_param_z>` **(** :ref:`int<class_int>` param **)** const |
|
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_flag_x<class_Generic6DOFJoint_set_flag_x>` **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` value **)** |
|
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_flag_y<class_Generic6DOFJoint_set_flag_y>` **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` value **)** |
|
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_flag_z<class_Generic6DOFJoint_set_flag_z>` **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` value **)** |
|
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_param_x<class_Generic6DOFJoint_set_param_x>` **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
|
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_param_y<class_Generic6DOFJoint_set_param_y>` **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
|
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_param_z<class_Generic6DOFJoint_set_param_z>` **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
|
|
||||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -283,55 +254,3 @@ Description
|
|||||||
|
|
||||||
The first 3 dof axes are linear axes, which represent translation of Bodies, and the latter 3 dof axes represent the angular motion. Each axis can be either locked, or limited.
|
The first 3 dof axes are linear axes, which represent translation of Bodies, and the latter 3 dof axes represent the angular motion. Each axis can be either locked, or limited.
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_Generic6DOFJoint_get_flag_x:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **get_flag_x** **(** :ref:`int<class_int>` flag **)** const
|
|
||||||
|
|
||||||
.. _class_Generic6DOFJoint_get_flag_y:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **get_flag_y** **(** :ref:`int<class_int>` flag **)** const
|
|
||||||
|
|
||||||
.. _class_Generic6DOFJoint_get_flag_z:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **get_flag_z** **(** :ref:`int<class_int>` flag **)** const
|
|
||||||
|
|
||||||
.. _class_Generic6DOFJoint_get_param_x:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_param_x** **(** :ref:`int<class_int>` param **)** const
|
|
||||||
|
|
||||||
.. _class_Generic6DOFJoint_get_param_y:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_param_y** **(** :ref:`int<class_int>` param **)** const
|
|
||||||
|
|
||||||
.. _class_Generic6DOFJoint_get_param_z:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_param_z** **(** :ref:`int<class_int>` param **)** const
|
|
||||||
|
|
||||||
.. _class_Generic6DOFJoint_set_flag_x:
|
|
||||||
|
|
||||||
- void **set_flag_x** **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` value **)**
|
|
||||||
|
|
||||||
.. _class_Generic6DOFJoint_set_flag_y:
|
|
||||||
|
|
||||||
- void **set_flag_y** **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` value **)**
|
|
||||||
|
|
||||||
.. _class_Generic6DOFJoint_set_flag_z:
|
|
||||||
|
|
||||||
- void **set_flag_z** **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` value **)**
|
|
||||||
|
|
||||||
.. _class_Generic6DOFJoint_set_param_x:
|
|
||||||
|
|
||||||
- void **set_param_x** **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)**
|
|
||||||
|
|
||||||
.. _class_Generic6DOFJoint_set_param_y:
|
|
||||||
|
|
||||||
- void **set_param_y** **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)**
|
|
||||||
|
|
||||||
.. _class_Generic6DOFJoint_set_param_z:
|
|
||||||
|
|
||||||
- void **set_param_z** **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)**
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -18,43 +18,6 @@ Brief Description
|
|||||||
|
|
||||||
Base node for geometry based visual instances.
|
Base node for geometry based visual instances.
|
||||||
|
|
||||||
Member Functions
|
|
||||||
----------------
|
|
||||||
|
|
||||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`int<class_int>` | :ref:`get_cast_shadows_setting<class_GeometryInstance_get_cast_shadows_setting>` **(** **)** const |
|
|
||||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_extra_cull_margin<class_GeometryInstance_get_extra_cull_margin>` **(** **)** const |
|
|
||||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`bool<class_bool>` | :ref:`get_flag<class_GeometryInstance_get_flag>` **(** :ref:`int<class_int>` flag **)** const |
|
|
||||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_lod_max_distance<class_GeometryInstance_get_lod_max_distance>` **(** **)** const |
|
|
||||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_lod_max_hysteresis<class_GeometryInstance_get_lod_max_hysteresis>` **(** **)** const |
|
|
||||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_lod_min_distance<class_GeometryInstance_get_lod_min_distance>` **(** **)** const |
|
|
||||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_lod_min_hysteresis<class_GeometryInstance_get_lod_min_hysteresis>` **(** **)** const |
|
|
||||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`Material<class_material>` | :ref:`get_material_override<class_GeometryInstance_get_material_override>` **(** **)** const |
|
|
||||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_cast_shadows_setting<class_GeometryInstance_set_cast_shadows_setting>` **(** :ref:`int<class_int>` shadow_casting_setting **)** |
|
|
||||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_extra_cull_margin<class_GeometryInstance_set_extra_cull_margin>` **(** :ref:`float<class_float>` margin **)** |
|
|
||||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_flag<class_GeometryInstance_set_flag>` **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` value **)** |
|
|
||||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_lod_max_distance<class_GeometryInstance_set_lod_max_distance>` **(** :ref:`float<class_float>` mode **)** |
|
|
||||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_lod_max_hysteresis<class_GeometryInstance_set_lod_max_hysteresis>` **(** :ref:`float<class_float>` mode **)** |
|
|
||||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_lod_min_distance<class_GeometryInstance_set_lod_min_distance>` **(** :ref:`float<class_float>` mode **)** |
|
|
||||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_lod_min_hysteresis<class_GeometryInstance_set_lod_min_hysteresis>` **(** :ref:`float<class_float>` mode **)** |
|
|
||||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_material_override<class_GeometryInstance_set_material_override>` **(** :ref:`Material<class_material>` material **)** |
|
|
||||||
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -106,75 +69,3 @@ Description
|
|||||||
|
|
||||||
Base node for geometry based visual instances. Shares some common functionality like visibility and custom materials.
|
Base node for geometry based visual instances. Shares some common functionality like visibility and custom materials.
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_GeometryInstance_get_cast_shadows_setting:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_cast_shadows_setting** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_GeometryInstance_get_extra_cull_margin:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_extra_cull_margin** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_GeometryInstance_get_flag:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **get_flag** **(** :ref:`int<class_int>` flag **)** const
|
|
||||||
|
|
||||||
.. _class_GeometryInstance_get_lod_max_distance:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_lod_max_distance** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_GeometryInstance_get_lod_max_hysteresis:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_lod_max_hysteresis** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_GeometryInstance_get_lod_min_distance:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_lod_min_distance** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_GeometryInstance_get_lod_min_hysteresis:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_lod_min_hysteresis** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_GeometryInstance_get_material_override:
|
|
||||||
|
|
||||||
- :ref:`Material<class_material>` **get_material_override** **(** **)** const
|
|
||||||
|
|
||||||
Return the material override for the whole geometry.
|
|
||||||
|
|
||||||
.. _class_GeometryInstance_set_cast_shadows_setting:
|
|
||||||
|
|
||||||
- void **set_cast_shadows_setting** **(** :ref:`int<class_int>` shadow_casting_setting **)**
|
|
||||||
|
|
||||||
.. _class_GeometryInstance_set_extra_cull_margin:
|
|
||||||
|
|
||||||
- void **set_extra_cull_margin** **(** :ref:`float<class_float>` margin **)**
|
|
||||||
|
|
||||||
.. _class_GeometryInstance_set_flag:
|
|
||||||
|
|
||||||
- void **set_flag** **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` value **)**
|
|
||||||
|
|
||||||
.. _class_GeometryInstance_set_lod_max_distance:
|
|
||||||
|
|
||||||
- void **set_lod_max_distance** **(** :ref:`float<class_float>` mode **)**
|
|
||||||
|
|
||||||
.. _class_GeometryInstance_set_lod_max_hysteresis:
|
|
||||||
|
|
||||||
- void **set_lod_max_hysteresis** **(** :ref:`float<class_float>` mode **)**
|
|
||||||
|
|
||||||
.. _class_GeometryInstance_set_lod_min_distance:
|
|
||||||
|
|
||||||
- void **set_lod_min_distance** **(** :ref:`float<class_float>` mode **)**
|
|
||||||
|
|
||||||
.. _class_GeometryInstance_set_lod_min_hysteresis:
|
|
||||||
|
|
||||||
- void **set_lod_min_hysteresis** **(** :ref:`float<class_float>` mode **)**
|
|
||||||
|
|
||||||
.. _class_GeometryInstance_set_material_override:
|
|
||||||
|
|
||||||
- void **set_material_override** **(** :ref:`Material<class_material>` material **)**
|
|
||||||
|
|
||||||
Set the material override for the whole geometry.
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
+5
-125
@@ -19,51 +19,11 @@ Brief Description
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
+-------+---------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`bake<class_GIProbe_bake>` **(** :ref:`Node<class_node>` from_node=null, :ref:`bool<class_bool>` create_visual_debug=false **)** |
|
| void | :ref:`bake<class_GIProbe_bake>` **(** :ref:`Node<class_node>` from_node=null, :ref:`bool<class_bool>` create_visual_debug=false **)** |
|
||||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
+-------+---------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`debug_bake<class_GIProbe_debug_bake>` **(** **)** |
|
| void | :ref:`debug_bake<class_GIProbe_debug_bake>` **(** **)** |
|
||||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
+-------+---------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_bias<class_GIProbe_get_bias>` **(** **)** const |
|
|
||||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`int<class_int>` | :ref:`get_dynamic_range<class_GIProbe_get_dynamic_range>` **(** **)** const |
|
|
||||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_energy<class_GIProbe_get_energy>` **(** **)** const |
|
|
||||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`Vector3<class_vector3>` | :ref:`get_extents<class_GIProbe_get_extents>` **(** **)** const |
|
|
||||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_normal_bias<class_GIProbe_get_normal_bias>` **(** **)** const |
|
|
||||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`GIProbeData<class_giprobedata>` | :ref:`get_probe_data<class_GIProbe_get_probe_data>` **(** **)** const |
|
|
||||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_propagation<class_GIProbe_get_propagation>` **(** **)** const |
|
|
||||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`int<class_int>` | :ref:`get_subdiv<class_GIProbe_get_subdiv>` **(** **)** const |
|
|
||||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_compressed<class_GIProbe_is_compressed>` **(** **)** const |
|
|
||||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_interior<class_GIProbe_is_interior>` **(** **)** const |
|
|
||||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_bias<class_GIProbe_set_bias>` **(** :ref:`float<class_float>` max **)** |
|
|
||||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_compress<class_GIProbe_set_compress>` **(** :ref:`bool<class_bool>` enable **)** |
|
|
||||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_dynamic_range<class_GIProbe_set_dynamic_range>` **(** :ref:`int<class_int>` max **)** |
|
|
||||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_energy<class_GIProbe_set_energy>` **(** :ref:`float<class_float>` max **)** |
|
|
||||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_extents<class_GIProbe_set_extents>` **(** :ref:`Vector3<class_vector3>` extents **)** |
|
|
||||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_interior<class_GIProbe_set_interior>` **(** :ref:`bool<class_bool>` enable **)** |
|
|
||||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_normal_bias<class_GIProbe_set_normal_bias>` **(** :ref:`float<class_float>` max **)** |
|
|
||||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_probe_data<class_GIProbe_set_probe_data>` **(** :ref:`GIProbeData<class_giprobedata>` data **)** |
|
|
||||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_propagation<class_GIProbe_set_propagation>` **(** :ref:`float<class_float>` max **)** |
|
|
||||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_subdiv<class_GIProbe_set_subdiv>` **(** :ref:`int<class_int>` subdiv **)** |
|
|
||||||
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
@@ -129,84 +89,4 @@ Member Function Description
|
|||||||
|
|
||||||
- void **debug_bake** **(** **)**
|
- void **debug_bake** **(** **)**
|
||||||
|
|
||||||
.. _class_GIProbe_get_bias:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_bias** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_GIProbe_get_dynamic_range:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_dynamic_range** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_GIProbe_get_energy:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_energy** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_GIProbe_get_extents:
|
|
||||||
|
|
||||||
- :ref:`Vector3<class_vector3>` **get_extents** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_GIProbe_get_normal_bias:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_normal_bias** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_GIProbe_get_probe_data:
|
|
||||||
|
|
||||||
- :ref:`GIProbeData<class_giprobedata>` **get_probe_data** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_GIProbe_get_propagation:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_propagation** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_GIProbe_get_subdiv:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_subdiv** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_GIProbe_is_compressed:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_compressed** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_GIProbe_is_interior:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_interior** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_GIProbe_set_bias:
|
|
||||||
|
|
||||||
- void **set_bias** **(** :ref:`float<class_float>` max **)**
|
|
||||||
|
|
||||||
.. _class_GIProbe_set_compress:
|
|
||||||
|
|
||||||
- void **set_compress** **(** :ref:`bool<class_bool>` enable **)**
|
|
||||||
|
|
||||||
.. _class_GIProbe_set_dynamic_range:
|
|
||||||
|
|
||||||
- void **set_dynamic_range** **(** :ref:`int<class_int>` max **)**
|
|
||||||
|
|
||||||
.. _class_GIProbe_set_energy:
|
|
||||||
|
|
||||||
- void **set_energy** **(** :ref:`float<class_float>` max **)**
|
|
||||||
|
|
||||||
.. _class_GIProbe_set_extents:
|
|
||||||
|
|
||||||
- void **set_extents** **(** :ref:`Vector3<class_vector3>` extents **)**
|
|
||||||
|
|
||||||
.. _class_GIProbe_set_interior:
|
|
||||||
|
|
||||||
- void **set_interior** **(** :ref:`bool<class_bool>` enable **)**
|
|
||||||
|
|
||||||
.. _class_GIProbe_set_normal_bias:
|
|
||||||
|
|
||||||
- void **set_normal_bias** **(** :ref:`float<class_float>` max **)**
|
|
||||||
|
|
||||||
.. _class_GIProbe_set_probe_data:
|
|
||||||
|
|
||||||
- void **set_probe_data** **(** :ref:`GIProbeData<class_giprobedata>` data **)**
|
|
||||||
|
|
||||||
.. _class_GIProbe_set_propagation:
|
|
||||||
|
|
||||||
- void **set_propagation** **(** :ref:`float<class_float>` max **)**
|
|
||||||
|
|
||||||
.. _class_GIProbe_set_subdiv:
|
|
||||||
|
|
||||||
- void **set_subdiv** **(** :ref:`int<class_int>` subdiv **)**
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -16,55 +16,6 @@ Brief Description
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
Member Functions
|
|
||||||
----------------
|
|
||||||
|
|
||||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_bias<class_GIProbeData_get_bias>` **(** **)** const |
|
|
||||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`Rect3<class_rect3>` | :ref:`get_bounds<class_GIProbeData_get_bounds>` **(** **)** const |
|
|
||||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_cell_size<class_GIProbeData_get_cell_size>` **(** **)** const |
|
|
||||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`PoolIntArray<class_poolintarray>` | :ref:`get_dynamic_data<class_GIProbeData_get_dynamic_data>` **(** **)** const |
|
|
||||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`int<class_int>` | :ref:`get_dynamic_range<class_GIProbeData_get_dynamic_range>` **(** **)** const |
|
|
||||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_energy<class_GIProbeData_get_energy>` **(** **)** const |
|
|
||||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_normal_bias<class_GIProbeData_get_normal_bias>` **(** **)** const |
|
|
||||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`float<class_float>` | :ref:`get_propagation<class_GIProbeData_get_propagation>` **(** **)** const |
|
|
||||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`Transform<class_transform>` | :ref:`get_to_cell_xform<class_GIProbeData_get_to_cell_xform>` **(** **)** const |
|
|
||||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_compressed<class_GIProbeData_is_compressed>` **(** **)** const |
|
|
||||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| :ref:`bool<class_bool>` | :ref:`is_interior<class_GIProbeData_is_interior>` **(** **)** const |
|
|
||||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_bias<class_GIProbeData_set_bias>` **(** :ref:`float<class_float>` bias **)** |
|
|
||||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_bounds<class_GIProbeData_set_bounds>` **(** :ref:`Rect3<class_rect3>` bounds **)** |
|
|
||||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_cell_size<class_GIProbeData_set_cell_size>` **(** :ref:`float<class_float>` cell_size **)** |
|
|
||||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_compress<class_GIProbeData_set_compress>` **(** :ref:`bool<class_bool>` compress **)** |
|
|
||||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_dynamic_data<class_GIProbeData_set_dynamic_data>` **(** :ref:`PoolIntArray<class_poolintarray>` dynamic_data **)** |
|
|
||||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_dynamic_range<class_GIProbeData_set_dynamic_range>` **(** :ref:`int<class_int>` dynamic_range **)** |
|
|
||||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_energy<class_GIProbeData_set_energy>` **(** :ref:`float<class_float>` energy **)** |
|
|
||||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_interior<class_GIProbeData_set_interior>` **(** :ref:`bool<class_bool>` interior **)** |
|
|
||||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_normal_bias<class_GIProbeData_set_normal_bias>` **(** :ref:`float<class_float>` bias **)** |
|
|
||||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_propagation<class_GIProbeData_set_propagation>` **(** :ref:`float<class_float>` propagation **)** |
|
|
||||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_to_cell_xform<class_GIProbeData_set_to_cell_xform>` **(** :ref:`Transform<class_transform>` to_cell_xform **)** |
|
|
||||||
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
@@ -74,7 +25,7 @@ Member Variables
|
|||||||
|
|
||||||
.. _class_GIProbeData_bounds:
|
.. _class_GIProbeData_bounds:
|
||||||
|
|
||||||
- :ref:`Rect3<class_rect3>` **bounds**
|
- :ref:`AABB<class_aabb>` **bounds**
|
||||||
|
|
||||||
.. _class_GIProbeData_cell_size:
|
.. _class_GIProbeData_cell_size:
|
||||||
|
|
||||||
@@ -113,95 +64,3 @@ Member Variables
|
|||||||
- :ref:`Transform<class_transform>` **to_cell_xform**
|
- :ref:`Transform<class_transform>` **to_cell_xform**
|
||||||
|
|
||||||
|
|
||||||
Member Function Description
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. _class_GIProbeData_get_bias:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_bias** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_GIProbeData_get_bounds:
|
|
||||||
|
|
||||||
- :ref:`Rect3<class_rect3>` **get_bounds** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_GIProbeData_get_cell_size:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_cell_size** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_GIProbeData_get_dynamic_data:
|
|
||||||
|
|
||||||
- :ref:`PoolIntArray<class_poolintarray>` **get_dynamic_data** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_GIProbeData_get_dynamic_range:
|
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_dynamic_range** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_GIProbeData_get_energy:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_energy** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_GIProbeData_get_normal_bias:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_normal_bias** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_GIProbeData_get_propagation:
|
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_propagation** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_GIProbeData_get_to_cell_xform:
|
|
||||||
|
|
||||||
- :ref:`Transform<class_transform>` **get_to_cell_xform** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_GIProbeData_is_compressed:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_compressed** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_GIProbeData_is_interior:
|
|
||||||
|
|
||||||
- :ref:`bool<class_bool>` **is_interior** **(** **)** const
|
|
||||||
|
|
||||||
.. _class_GIProbeData_set_bias:
|
|
||||||
|
|
||||||
- void **set_bias** **(** :ref:`float<class_float>` bias **)**
|
|
||||||
|
|
||||||
.. _class_GIProbeData_set_bounds:
|
|
||||||
|
|
||||||
- void **set_bounds** **(** :ref:`Rect3<class_rect3>` bounds **)**
|
|
||||||
|
|
||||||
.. _class_GIProbeData_set_cell_size:
|
|
||||||
|
|
||||||
- void **set_cell_size** **(** :ref:`float<class_float>` cell_size **)**
|
|
||||||
|
|
||||||
.. _class_GIProbeData_set_compress:
|
|
||||||
|
|
||||||
- void **set_compress** **(** :ref:`bool<class_bool>` compress **)**
|
|
||||||
|
|
||||||
.. _class_GIProbeData_set_dynamic_data:
|
|
||||||
|
|
||||||
- void **set_dynamic_data** **(** :ref:`PoolIntArray<class_poolintarray>` dynamic_data **)**
|
|
||||||
|
|
||||||
.. _class_GIProbeData_set_dynamic_range:
|
|
||||||
|
|
||||||
- void **set_dynamic_range** **(** :ref:`int<class_int>` dynamic_range **)**
|
|
||||||
|
|
||||||
.. _class_GIProbeData_set_energy:
|
|
||||||
|
|
||||||
- void **set_energy** **(** :ref:`float<class_float>` energy **)**
|
|
||||||
|
|
||||||
.. _class_GIProbeData_set_interior:
|
|
||||||
|
|
||||||
- void **set_interior** **(** :ref:`bool<class_bool>` interior **)**
|
|
||||||
|
|
||||||
.. _class_GIProbeData_set_normal_bias:
|
|
||||||
|
|
||||||
- void **set_normal_bias** **(** :ref:`float<class_float>` bias **)**
|
|
||||||
|
|
||||||
.. _class_GIProbeData_set_propagation:
|
|
||||||
|
|
||||||
- void **set_propagation** **(** :ref:`float<class_float>` propagation **)**
|
|
||||||
|
|
||||||
.. _class_GIProbeData_set_to_cell_xform:
|
|
||||||
|
|
||||||
- void **set_to_cell_xform** **(** :ref:`Transform<class_transform>` to_cell_xform **)**
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
+17
-49
@@ -19,31 +19,23 @@ Color interpolator node.
|
|||||||
Member Functions
|
Member Functions
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`add_point<class_Gradient_add_point>` **(** :ref:`float<class_float>` offset, :ref:`Color<class_color>` color **)** |
|
| void | :ref:`add_point<class_Gradient_add_point>` **(** :ref:`float<class_float>` offset, :ref:`Color<class_color>` color **)** |
|
||||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Color<class_color>` | :ref:`get_color<class_Gradient_get_color>` **(** :ref:`int<class_int>` point **)** const |
|
| :ref:`Color<class_color>` | :ref:`get_color<class_Gradient_get_color>` **(** :ref:`int<class_int>` point **)** const |
|
||||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`PoolColorArray<class_poolcolorarray>` | :ref:`get_colors<class_Gradient_get_colors>` **(** **)** const |
|
| :ref:`float<class_float>` | :ref:`get_offset<class_Gradient_get_offset>` **(** :ref:`int<class_int>` point **)** const |
|
||||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`float<class_float>` | :ref:`get_offset<class_Gradient_get_offset>` **(** :ref:`int<class_int>` point **)** const |
|
| :ref:`int<class_int>` | :ref:`get_point_count<class_Gradient_get_point_count>` **(** **)** const |
|
||||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`PoolRealArray<class_poolrealarray>` | :ref:`get_offsets<class_Gradient_get_offsets>` **(** **)** const |
|
| :ref:`Color<class_color>` | :ref:`interpolate<class_Gradient_interpolate>` **(** :ref:`float<class_float>` offset **)** |
|
||||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`int<class_int>` | :ref:`get_point_count<class_Gradient_get_point_count>` **(** **)** const |
|
| void | :ref:`remove_point<class_Gradient_remove_point>` **(** :ref:`int<class_int>` offset **)** |
|
||||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||||
| :ref:`Color<class_color>` | :ref:`interpolate<class_Gradient_interpolate>` **(** :ref:`float<class_float>` offset **)** |
|
| void | :ref:`set_color<class_Gradient_set_color>` **(** :ref:`int<class_int>` point, :ref:`Color<class_color>` color **)** |
|
||||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`remove_point<class_Gradient_remove_point>` **(** :ref:`int<class_int>` offset **)** |
|
| void | :ref:`set_offset<class_Gradient_set_offset>` **(** :ref:`int<class_int>` point, :ref:`float<class_float>` offset **)** |
|
||||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||||
| void | :ref:`set_color<class_Gradient_set_color>` **(** :ref:`int<class_int>` point, :ref:`Color<class_color>` color **)** |
|
|
||||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_colors<class_Gradient_set_colors>` **(** :ref:`PoolColorArray<class_poolcolorarray>` colors **)** |
|
|
||||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_offset<class_Gradient_set_offset>` **(** :ref:`int<class_int>` point, :ref:`float<class_float>` offset **)** |
|
|
||||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| void | :ref:`set_offsets<class_Gradient_set_offsets>` **(** :ref:`PoolRealArray<class_poolrealarray>` offsets **)** |
|
|
||||||
+----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
|
||||||
|
|
||||||
Member Variables
|
Member Variables
|
||||||
----------------
|
----------------
|
||||||
@@ -77,24 +69,12 @@ Adds the specified color to the end of the ramp, with the specified offset
|
|||||||
|
|
||||||
Returns the color of the ramp color at index *point*
|
Returns the color of the ramp color at index *point*
|
||||||
|
|
||||||
.. _class_Gradient_get_colors:
|
|
||||||
|
|
||||||
- :ref:`PoolColorArray<class_poolcolorarray>` **get_colors** **(** **)** const
|
|
||||||
|
|
||||||
Returns the colors in the ramp
|
|
||||||
|
|
||||||
.. _class_Gradient_get_offset:
|
.. _class_Gradient_get_offset:
|
||||||
|
|
||||||
- :ref:`float<class_float>` **get_offset** **(** :ref:`int<class_int>` point **)** const
|
- :ref:`float<class_float>` **get_offset** **(** :ref:`int<class_int>` point **)** const
|
||||||
|
|
||||||
Returns the offset of the ramp color at index *point*
|
Returns the offset of the ramp color at index *point*
|
||||||
|
|
||||||
.. _class_Gradient_get_offsets:
|
|
||||||
|
|
||||||
- :ref:`PoolRealArray<class_poolrealarray>` **get_offsets** **(** **)** const
|
|
||||||
|
|
||||||
Returns the offsets for the colors in this ramp
|
|
||||||
|
|
||||||
.. _class_Gradient_get_point_count:
|
.. _class_Gradient_get_point_count:
|
||||||
|
|
||||||
- :ref:`int<class_int>` **get_point_count** **(** **)** const
|
- :ref:`int<class_int>` **get_point_count** **(** **)** const
|
||||||
@@ -119,22 +99,10 @@ Removes the color at the index *offset*
|
|||||||
|
|
||||||
Sets the color of the ramp color at index *point*
|
Sets the color of the ramp color at index *point*
|
||||||
|
|
||||||
.. _class_Gradient_set_colors:
|
|
||||||
|
|
||||||
- void **set_colors** **(** :ref:`PoolColorArray<class_poolcolorarray>` colors **)**
|
|
||||||
|
|
||||||
Sets the colors for the specified amount of elements. Calling this function with a different number of elements than previously defined causes the ramp to resize its colors and offsets array to accommodate the new elements.
|
|
||||||
|
|
||||||
.. _class_Gradient_set_offset:
|
.. _class_Gradient_set_offset:
|
||||||
|
|
||||||
- void **set_offset** **(** :ref:`int<class_int>` point, :ref:`float<class_float>` offset **)**
|
- void **set_offset** **(** :ref:`int<class_int>` point, :ref:`float<class_float>` offset **)**
|
||||||
|
|
||||||
Sets the offset for the ramp color at index *point*
|
Sets the offset for the ramp color at index *point*
|
||||||
|
|
||||||
.. _class_Gradient_set_offsets:
|
|
||||||
|
|
||||||
- void **set_offsets** **(** :ref:`PoolRealArray<class_poolrealarray>` offsets **)**
|
|
||||||
|
|
||||||
Sets the offset for the specified amount of elements. Calling this function with a different number of elements than previously defined causes the ramp to resize its colors and offsets array to accommodate the new elements, all new colors will be black by default.
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user