:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/3.5/modules/gdnative/doc_classes/NativeScript.xml. .. _class_NativeScript: NativeScript ============ **Inherits:** :ref:`Script` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` Properties ---------- +-----------------------------------------------+-----------------------------------------------------------------------------------+--------+ | :ref:`String` | :ref:`class_name` | ``""`` | +-----------------------------------------------+-----------------------------------------------------------------------------------+--------+ | :ref:`GDNativeLibrary` | :ref:`library` | | +-----------------------------------------------+-----------------------------------------------------------------------------------+--------+ | :ref:`String` | :ref:`script_class_icon_path` | ``""`` | +-----------------------------------------------+-----------------------------------------------------------------------------------+--------+ | :ref:`String` | :ref:`script_class_name` | ``""`` | +-----------------------------------------------+-----------------------------------------------------------------------------------+--------+ Methods ------- +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_class_documentation` **(** **)** |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_method_documentation` **(** :ref:`String` method **)** |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_property_documentation` **(** :ref:`String` path **)** |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_signal_documentation` **(** :ref:`String` signal_name **)** |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`new` **(** ... **)** |vararg| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- .. _class_NativeScript_property_class_name: - :ref:`String` **class_name** +-----------+-----------------------+ | *Default* | ``""`` | +-----------+-----------------------+ | *Setter* | set_class_name(value) | +-----------+-----------------------+ | *Getter* | get_class_name() | +-----------+-----------------------+ ---- .. _class_NativeScript_property_library: - :ref:`GDNativeLibrary` **library** +----------+--------------------+ | *Setter* | set_library(value) | +----------+--------------------+ | *Getter* | get_library() | +----------+--------------------+ ---- .. _class_NativeScript_property_script_class_icon_path: - :ref:`String` **script_class_icon_path** +-----------+-----------------------------------+ | *Default* | ``""`` | +-----------+-----------------------------------+ | *Setter* | set_script_class_icon_path(value) | +-----------+-----------------------------------+ | *Getter* | get_script_class_icon_path() | +-----------+-----------------------------------+ ---- .. _class_NativeScript_property_script_class_name: - :ref:`String` **script_class_name** +-----------+------------------------------+ | *Default* | ``""`` | +-----------+------------------------------+ | *Setter* | set_script_class_name(value) | +-----------+------------------------------+ | *Getter* | get_script_class_name() | +-----------+------------------------------+ Method Descriptions ------------------- .. _class_NativeScript_method_get_class_documentation: - :ref:`String` **get_class_documentation** **(** **)** |const| Returns the documentation string that was previously set with ``godot_nativescript_set_class_documentation``. ---- .. _class_NativeScript_method_get_method_documentation: - :ref:`String` **get_method_documentation** **(** :ref:`String` method **)** |const| Returns the documentation string that was previously set with ``godot_nativescript_set_method_documentation``. ---- .. _class_NativeScript_method_get_property_documentation: - :ref:`String` **get_property_documentation** **(** :ref:`String` path **)** |const| Returns the documentation string that was previously set with ``godot_nativescript_set_property_documentation``. ---- .. _class_NativeScript_method_get_signal_documentation: - :ref:`String` **get_signal_documentation** **(** :ref:`String` signal_name **)** |const| Returns the documentation string that was previously set with ``godot_nativescript_set_signal_documentation``. ---- .. _class_NativeScript_method_new: - :ref:`Variant` **new** **(** ... **)** |vararg| Constructs a new object of the base type with a script of this type already attached. \ **Note:** Any arguments passed to this function will be ignored and not passed to the native constructor function. This will change with in a future API extension. .. |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.)`