.. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/docs/gdscript/modules/gdscript/doc_classes/@GDScript.xml. .. _class_@GDScript: @GDScript ========= .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`Color8` **(** :ref:`int` r8, :ref:`int` g8, :ref:`int` b8, :ref:`int` a8=255 **)** | +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`assert` **(** :ref:`bool` condition, :ref:`String` message="" **)** | +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`char` **(** :ref:`int` char **)** | +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`convert` **(** :ref:`Variant` what, :ref:`int` type **)** | +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Object` | :ref:`dict_to_inst` **(** :ref:`Dictionary` dictionary **)** | +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_stack` **(** **)** | +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`inst_to_dict` **(** :ref:`Object` instance **)** | +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_instance_of` **(** :ref:`Variant` value, :ref:`Variant` type **)** | +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`len` **(** :ref:`Variant` var **)** | +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Resource` | :ref:`load` **(** :ref:`String` path **)** | +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Resource` | :ref:`preload` **(** :ref:`String` path **)** | +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`print_debug` **(** ... **)** |vararg| | +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`print_stack` **(** **)** | +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`range` **(** ... **)** |vararg| | +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`type_exists` **(** :ref:`StringName` type **)** | +-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Constants --------- .. _class_@GDScript_constant_PI: .. rst-class:: classref-constant **PI** = ``3.14159265358979`` .. container:: contribute There is currently no description for this constant. Please help us by :ref:`contributing one `! .. _class_@GDScript_constant_TAU: .. rst-class:: classref-constant **TAU** = ``6.28318530717959`` .. container:: contribute There is currently no description for this constant. Please help us by :ref:`contributing one `! .. _class_@GDScript_constant_INF: .. rst-class:: classref-constant **INF** = ``inf`` .. container:: contribute There is currently no description for this constant. Please help us by :ref:`contributing one `! .. _class_@GDScript_constant_NAN: .. rst-class:: classref-constant **NAN** = ``nan`` .. container:: contribute There is currently no description for this constant. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- Annotations ----------- .. _class_@GDScript_annotation_@export: .. rst-class:: classref-annotation **@export** **(** **)** .. container:: contribute There is currently no description for this annotation. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_annotation_@export_category: .. rst-class:: classref-annotation **@export_category** **(** :ref:`String` name **)** .. container:: contribute There is currently no description for this annotation. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_annotation_@export_color_no_alpha: .. rst-class:: classref-annotation **@export_color_no_alpha** **(** **)** .. container:: contribute There is currently no description for this annotation. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_annotation_@export_custom: .. rst-class:: classref-annotation **@export_custom** **(** :ref:`PropertyHint` hint, :ref:`String` hint_string, |bitfield|\<:ref:`PropertyUsageFlags`\> usage=6 **)** .. container:: contribute There is currently no description for this annotation. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_annotation_@export_dir: .. rst-class:: classref-annotation **@export_dir** **(** **)** .. container:: contribute There is currently no description for this annotation. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_annotation_@export_enum: .. rst-class:: classref-annotation **@export_enum** **(** :ref:`String` names, ... **)** |vararg| .. container:: contribute There is currently no description for this annotation. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_annotation_@export_exp_easing: .. rst-class:: classref-annotation **@export_exp_easing** **(** :ref:`String` hints="", ... **)** |vararg| .. container:: contribute There is currently no description for this annotation. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_annotation_@export_file: .. rst-class:: classref-annotation **@export_file** **(** :ref:`String` filter="", ... **)** |vararg| .. container:: contribute There is currently no description for this annotation. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_annotation_@export_flags: .. rst-class:: classref-annotation **@export_flags** **(** :ref:`String` names, ... **)** |vararg| .. container:: contribute There is currently no description for this annotation. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_annotation_@export_flags_2d_navigation: .. rst-class:: classref-annotation **@export_flags_2d_navigation** **(** **)** .. container:: contribute There is currently no description for this annotation. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_annotation_@export_flags_2d_physics: .. rst-class:: classref-annotation **@export_flags_2d_physics** **(** **)** .. container:: contribute There is currently no description for this annotation. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_annotation_@export_flags_2d_render: .. rst-class:: classref-annotation **@export_flags_2d_render** **(** **)** .. container:: contribute There is currently no description for this annotation. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_annotation_@export_flags_3d_navigation: .. rst-class:: classref-annotation **@export_flags_3d_navigation** **(** **)** .. container:: contribute There is currently no description for this annotation. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_annotation_@export_flags_3d_physics: .. rst-class:: classref-annotation **@export_flags_3d_physics** **(** **)** .. container:: contribute There is currently no description for this annotation. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_annotation_@export_flags_3d_render: .. rst-class:: classref-annotation **@export_flags_3d_render** **(** **)** .. container:: contribute There is currently no description for this annotation. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_annotation_@export_flags_avoidance: .. rst-class:: classref-annotation **@export_flags_avoidance** **(** **)** .. container:: contribute There is currently no description for this annotation. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_annotation_@export_global_dir: .. rst-class:: classref-annotation **@export_global_dir** **(** **)** .. container:: contribute There is currently no description for this annotation. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_annotation_@export_global_file: .. rst-class:: classref-annotation **@export_global_file** **(** :ref:`String` filter="", ... **)** |vararg| .. container:: contribute There is currently no description for this annotation. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_annotation_@export_group: .. rst-class:: classref-annotation **@export_group** **(** :ref:`String` name, :ref:`String` prefix="" **)** .. container:: contribute There is currently no description for this annotation. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_annotation_@export_multiline: .. rst-class:: classref-annotation **@export_multiline** **(** **)** .. container:: contribute There is currently no description for this annotation. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_annotation_@export_node_path: .. rst-class:: classref-annotation **@export_node_path** **(** :ref:`String` type="", ... **)** |vararg| .. container:: contribute There is currently no description for this annotation. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_annotation_@export_placeholder: .. rst-class:: classref-annotation **@export_placeholder** **(** :ref:`String` placeholder **)** .. container:: contribute There is currently no description for this annotation. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_annotation_@export_range: .. rst-class:: classref-annotation **@export_range** **(** :ref:`float` min, :ref:`float` max, :ref:`float` step=1.0, :ref:`String` extra_hints="", ... **)** |vararg| .. container:: contribute There is currently no description for this annotation. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_annotation_@export_storage: .. rst-class:: classref-annotation **@export_storage** **(** **)** .. container:: contribute There is currently no description for this annotation. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_annotation_@export_subgroup: .. rst-class:: classref-annotation **@export_subgroup** **(** :ref:`String` name, :ref:`String` prefix="" **)** .. container:: contribute There is currently no description for this annotation. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_annotation_@icon: .. rst-class:: classref-annotation **@icon** **(** :ref:`String` icon_path **)** .. container:: contribute There is currently no description for this annotation. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_annotation_@onready: .. rst-class:: classref-annotation **@onready** **(** **)** .. container:: contribute There is currently no description for this annotation. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_annotation_@rpc: .. rst-class:: classref-annotation **@rpc** **(** :ref:`String` mode="authority", :ref:`String` sync="call_remote", :ref:`String` transfer_mode="unreliable", :ref:`int` transfer_channel=0 **)** .. container:: contribute There is currently no description for this annotation. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_annotation_@static_unload: .. rst-class:: classref-annotation **@static_unload** **(** **)** .. container:: contribute There is currently no description for this annotation. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_annotation_@tool: .. rst-class:: classref-annotation **@tool** **(** **)** .. container:: contribute There is currently no description for this annotation. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_annotation_@warning_ignore: .. rst-class:: classref-annotation **@warning_ignore** **(** :ref:`String` warning, ... **)** |vararg| .. container:: contribute There is currently no description for this annotation. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_@GDScript_method_Color8: .. rst-class:: classref-method :ref:`Color` **Color8** **(** :ref:`int` r8, :ref:`int` g8, :ref:`int` b8, :ref:`int` a8=255 **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_method_assert: .. rst-class:: classref-method void **assert** **(** :ref:`bool` condition, :ref:`String` message="" **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_method_char: .. rst-class:: classref-method :ref:`String` **char** **(** :ref:`int` char **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_method_convert: .. rst-class:: classref-method :ref:`Variant` **convert** **(** :ref:`Variant` what, :ref:`int` type **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_method_dict_to_inst: .. rst-class:: classref-method :ref:`Object` **dict_to_inst** **(** :ref:`Dictionary` dictionary **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_method_get_stack: .. rst-class:: classref-method :ref:`Array` **get_stack** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_method_inst_to_dict: .. rst-class:: classref-method :ref:`Dictionary` **inst_to_dict** **(** :ref:`Object` instance **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_method_is_instance_of: .. rst-class:: classref-method :ref:`bool` **is_instance_of** **(** :ref:`Variant` value, :ref:`Variant` type **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_method_len: .. rst-class:: classref-method :ref:`int` **len** **(** :ref:`Variant` var **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_method_load: .. rst-class:: classref-method :ref:`Resource` **load** **(** :ref:`String` path **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_method_preload: .. rst-class:: classref-method :ref:`Resource` **preload** **(** :ref:`String` path **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_method_print_debug: .. rst-class:: classref-method void **print_debug** **(** ... **)** |vararg| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_method_print_stack: .. rst-class:: classref-method void **print_stack** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_method_range: .. rst-class:: classref-method :ref:`Array` **range** **(** ... **)** |vararg| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_@GDScript_method_type_exists: .. rst-class:: classref-method :ref:`bool` **type_exists** **(** :ref:`StringName` type **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`