Files
godot-docs/classes/class_resourceloader.rst
2018-09-13 01:56:47 +02:00

86 lines
6.1 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the ResourceLoader.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_ResourceLoader:
ResourceLoader
==============
**Inherits:** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------
Resource Loader.
Methods
-------
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`exists<class_ResourceLoader_exists>` **(** :ref:`String<class_String>` path, :ref:`String<class_String>` type_hint="" **)** |
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_dependencies<class_ResourceLoader_get_dependencies>` **(** :ref:`String<class_String>` path **)** |
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_recognized_extensions_for_type<class_ResourceLoader_get_recognized_extensions_for_type>` **(** :ref:`String<class_String>` type **)** |
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has<class_ResourceLoader_has>` **(** :ref:`String<class_String>` path **)** |
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_cached<class_ResourceLoader_has_cached>` **(** :ref:`String<class_String>` path **)** |
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Resource<class_Resource>` | :ref:`load<class_ResourceLoader_load>` **(** :ref:`String<class_String>` path, :ref:`String<class_String>` type_hint="", :ref:`bool<class_bool>` p_no_cache=false **)** |
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`ResourceInteractiveLoader<class_ResourceInteractiveLoader>` | :ref:`load_interactive<class_ResourceLoader_load_interactive>` **(** :ref:`String<class_String>` path, :ref:`String<class_String>` type_hint="" **)** |
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_abort_on_missing_resources<class_ResourceLoader_set_abort_on_missing_resources>` **(** :ref:`bool<class_bool>` abort **)** |
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Description
-----------
Resource Loader. This is a static object accessible as ``ResourceLoader``. GDScript has a simplified load() function, though.
Method Descriptions
-------------------
.. _class_ResourceLoader_exists:
- :ref:`bool<class_bool>` **exists** **(** :ref:`String<class_String>` path, :ref:`String<class_String>` type_hint="" **)**
.. _class_ResourceLoader_get_dependencies:
- :ref:`PoolStringArray<class_PoolStringArray>` **get_dependencies** **(** :ref:`String<class_String>` path **)**
.. _class_ResourceLoader_get_recognized_extensions_for_type:
- :ref:`PoolStringArray<class_PoolStringArray>` **get_recognized_extensions_for_type** **(** :ref:`String<class_String>` type **)**
Return the list of recognized extensions for a resource type.
.. _class_ResourceLoader_has:
- :ref:`bool<class_bool>` **has** **(** :ref:`String<class_String>` path **)**
.. _class_ResourceLoader_has_cached:
- :ref:`bool<class_bool>` **has_cached** **(** :ref:`String<class_String>` path **)**
.. _class_ResourceLoader_load:
- :ref:`Resource<class_Resource>` **load** **(** :ref:`String<class_String>` path, :ref:`String<class_String>` type_hint="", :ref:`bool<class_bool>` p_no_cache=false **)**
.. _class_ResourceLoader_load_interactive:
- :ref:`ResourceInteractiveLoader<class_ResourceInteractiveLoader>` **load_interactive** **(** :ref:`String<class_String>` path, :ref:`String<class_String>` type_hint="" **)**
Load a resource interactively, the returned object allows to load with high granularity.
.. _class_ResourceLoader_set_abort_on_missing_resources:
- void **set_abort_on_missing_resources** **(** :ref:`bool<class_bool>` abort **)**
Change the behavior on missing sub-resources. Default is to abort load.