| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the NativeScript.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_NativeScript:
- NativeScript
- ============
- **Inherits:** :ref:`Script<class_Script>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
- Properties
- ----------
- +-----------------------------------------------+-----------------------------------------------------------------------------------+--------+
- | :ref:`String<class_String>` | :ref:`class_name<class_NativeScript_property_class_name>` | ``""`` |
- +-----------------------------------------------+-----------------------------------------------------------------------------------+--------+
- | :ref:`GDNativeLibrary<class_GDNativeLibrary>` | :ref:`library<class_NativeScript_property_library>` | |
- +-----------------------------------------------+-----------------------------------------------------------------------------------+--------+
- | :ref:`String<class_String>` | :ref:`script_class_icon_path<class_NativeScript_property_script_class_icon_path>` | ``""`` |
- +-----------------------------------------------+-----------------------------------------------------------------------------------+--------+
- | :ref:`String<class_String>` | :ref:`script_class_name<class_NativeScript_property_script_class_name>` | ``""`` |
- +-----------------------------------------------+-----------------------------------------------------------------------------------+--------+
- Methods
- -------
- +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_String>` | :ref:`get_class_documentation<class_NativeScript_method_get_class_documentation>` **(** **)** |const| |
- +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_String>` | :ref:`get_method_documentation<class_NativeScript_method_get_method_documentation>` **(** :ref:`String<class_String>` method **)** |const| |
- +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_String>` | :ref:`get_property_documentation<class_NativeScript_method_get_property_documentation>` **(** :ref:`String<class_String>` path **)** |const| |
- +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_String>` | :ref:`get_signal_documentation<class_NativeScript_method_get_signal_documentation>` **(** :ref:`String<class_String>` signal_name **)** |const| |
- +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Variant<class_Variant>` | :ref:`new<class_NativeScript_method_new>` **(** ... **)** |vararg| |
- +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
- Property Descriptions
- ---------------------
- .. _class_NativeScript_property_class_name:
- - :ref:`String<class_String>` **class_name**
- +-----------+-----------------------+
- | *Default* | ``""`` |
- +-----------+-----------------------+
- | *Setter* | set_class_name(value) |
- +-----------+-----------------------+
- | *Getter* | get_class_name() |
- +-----------+-----------------------+
- ----
- .. _class_NativeScript_property_library:
- - :ref:`GDNativeLibrary<class_GDNativeLibrary>` **library**
- +----------+--------------------+
- | *Setter* | set_library(value) |
- +----------+--------------------+
- | *Getter* | get_library() |
- +----------+--------------------+
- ----
- .. _class_NativeScript_property_script_class_icon_path:
- - :ref:`String<class_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<class_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<class_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<class_String>` **get_method_documentation** **(** :ref:`String<class_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<class_String>` **get_property_documentation** **(** :ref:`String<class_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<class_String>` **get_signal_documentation** **(** :ref:`String<class_String>` signal_name **)** |const|
- Returns the documentation string that was previously set with ``godot_nativescript_set_signal_documentation``.
- ----
- .. _class_NativeScript_method_new:
- - :ref:`Variant<class_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.)`
|
