godot-docs/classes/class_gdnativelibrary.rst

:github_url: hide

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the GDNativeLibrary.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_GDNativeLibrary:

GDNativeLibrary
===============

**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`

**Category:** Core

Brief Description
-----------------



Properties
----------

+-------------------------------------+--------------------------------------------------------------------+----------+
| :ref:`ConfigFile<class_ConfigFile>` | :ref:`config_file<class_GDNativeLibrary_property_config_file>`     |          |
+-------------------------------------+--------------------------------------------------------------------+----------+
| :ref:`bool<class_bool>`             | :ref:`load_once<class_GDNativeLibrary_property_load_once>`         | true     |
+-------------------------------------+--------------------------------------------------------------------+----------+
| :ref:`bool<class_bool>`             | :ref:`reloadable<class_GDNativeLibrary_property_reloadable>`       | true     |
+-------------------------------------+--------------------------------------------------------------------+----------+
| :ref:`bool<class_bool>`             | :ref:`singleton<class_GDNativeLibrary_property_singleton>`         | false    |
+-------------------------------------+--------------------------------------------------------------------+----------+
| :ref:`String<class_String>`         | :ref:`symbol_prefix<class_GDNativeLibrary_property_symbol_prefix>` | "godot_" |
+-------------------------------------+--------------------------------------------------------------------+----------+

Methods
-------

+-----------------------------------------------+----------------------------------------------------------------------------------------------------------+
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_current_dependencies<class_GDNativeLibrary_method_get_current_dependencies>` **(** **)** const |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`get_current_library_path<class_GDNativeLibrary_method_get_current_library_path>` **(** **)** const |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------+

Property Descriptions
---------------------

.. _class_GDNativeLibrary_property_config_file:

- :ref:`ConfigFile<class_ConfigFile>` **config_file**

+----------+------------------------+
| *Setter* | set_config_file(value) |
+----------+------------------------+
| *Getter* | get_config_file()      |
+----------+------------------------+

.. _class_GDNativeLibrary_property_load_once:

- :ref:`bool<class_bool>` **load_once**

+-----------+----------------------+
| *Default* | true                 |
+-----------+----------------------+
| *Setter*  | set_load_once(value) |
+-----------+----------------------+
| *Getter*  | should_load_once()   |
+-----------+----------------------+

.. _class_GDNativeLibrary_property_reloadable:

- :ref:`bool<class_bool>` **reloadable**

+-----------+-----------------------+
| *Default* | true                  |
+-----------+-----------------------+
| *Setter*  | set_reloadable(value) |
+-----------+-----------------------+
| *Getter*  | is_reloadable()       |
+-----------+-----------------------+

.. _class_GDNativeLibrary_property_singleton:

- :ref:`bool<class_bool>` **singleton**

+-----------+----------------------+
| *Default* | false                |
+-----------+----------------------+
| *Setter*  | set_singleton(value) |
+-----------+----------------------+
| *Getter*  | is_singleton()       |
+-----------+----------------------+

.. _class_GDNativeLibrary_property_symbol_prefix:

- :ref:`String<class_String>` **symbol_prefix**

+-----------+--------------------------+
| *Default* | "godot_"                 |
+-----------+--------------------------+
| *Setter*  | set_symbol_prefix(value) |
+-----------+--------------------------+
| *Getter*  | get_symbol_prefix()      |
+-----------+--------------------------+

Method Descriptions
-------------------

.. _class_GDNativeLibrary_method_get_current_dependencies:

- :ref:`PoolStringArray<class_PoolStringArray>` **get_current_dependencies** **(** **)** const

.. _class_GDNativeLibrary_method_get_current_library_path:

- :ref:`String<class_String>` **get_current_library_path** **(** **)** const