.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.

.. _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=""  **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                         | :ref:`clear_remaps<class_PathRemap_clear_remaps>`  **(** **)**                                                                                                    |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                         | :ref:`erase_remap<class_PathRemap_erase_remap>`  **(** :ref:`String<class_string>` path  **)**                                                                    |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>`  | :ref:`get_remap<class_PathRemap_get_remap>`  **(** :ref:`String<class_string>` path  **)** const                                                                  |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`      | :ref:`has_remap<class_PathRemap_has_remap>`  **(** :ref:`String<class_string>` path  **)** const                                                                  |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Description
-----------

When exporting, the types of some resources may change internally so they are converted to more optimized versions. While it's not usually necessary to access to this directly (path remapping happens automatically when opening 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_clear_remaps:

- void  **clear_remaps**  **(** **)**

Clear all remaps.

.. _class_PathRemap_erase_remap:

- void  **erase_remap**  **(** :ref:`String<class_string>` path  **)**

Erase a remap.

.. _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_has_remap:

- :ref:`bool<class_bool>`  **has_remap**  **(** :ref:`String<class_string>` path  **)** const

Return true if a file is being remapped.