Files
godot-docs/classes/class_pathremap.rst
Rémi Verschelde fa00c829f0 Add inheritance path
Also fix parsing of [method (Class.)name]
2016-02-08 18:31:35 +01:00

69 lines
3.4 KiB
ReStructuredText

.. _class_PathRemap:
PathRemap
=========
**Inherits:** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Singleton containing the list of remapped resources.
Member Functions
----------------
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_remap<class_PathRemap_add_remap>` **(** :ref:`String<class_string>` from, :ref:`String<class_string>` to, :ref:`String<class_string>` locale="" **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_remap<class_PathRemap_has_remap>` **(** :ref:`String<class_string>` path **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_remap<class_PathRemap_get_remap>` **(** :ref:`String<class_string>` path **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`erase_remap<class_PathRemap_erase_remap>` **(** :ref:`String<class_string>` path **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_remaps<class_PathRemap_clear_remaps>` **(** **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Description
-----------
When exporting, the types of some resources may change internally so they are converted to more optimized versions. While it's not usually necesary to access to this directly (path remapping happens automatically when opeining a file), it's exported just for information.
Member Function Description
---------------------------
.. _class_PathRemap_add_remap:
- void **add_remap** **(** :ref:`String<class_string>` from, :ref:`String<class_string>` to, :ref:`String<class_string>` locale="" **)**
Add a remap from a file to another.
.. _class_PathRemap_has_remap:
- :ref:`bool<class_bool>` **has_remap** **(** :ref:`String<class_string>` path **)** const
Return true if a file is being remapped.
.. _class_PathRemap_get_remap:
- :ref:`String<class_string>` **get_remap** **(** :ref:`String<class_string>` path **)** const
Return the remapped new path of a file.
.. _class_PathRemap_erase_remap:
- void **erase_remap** **(** :ref:`String<class_string>` path **)**
Erase a remap.
.. _class_PathRemap_clear_remaps:
- void **clear_remaps** **(** **)**
Clear all remaps.