Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
ResourceFormatSaver
Hérite de : RefCounted < Object
Enregistre un type de ressource spécifique dans un fichier.
Description
Le moteur peut sauvegarder des ressources lorsque vous le faites depuis l'éditeur, ou lorsque vous utilisez le singleton ResourceSaver. Ceci est accompli grâce à plusieurs ResourceFormatSavers, chacun manipulant son propre format et étant appelé automatiquement par le moteur.
Par défaut, Godot sauvegarde les ressources comme .tres (basé sur du texte), .res (en binaire) ou dans un autre format intégré, mais vous pouvez choisir de créer votre propre format en étendant cette classe. Assurez-vous de respecter les types et les valeurs de renvoi documentés. Vous devriez lui donner un nom de classe global avec class_name pour qu'elle soit enregistrée. Comme les ResourcesFormatSavers intégrés, elle sera appelée automatiquement lors de la sauvegarde des ressources de ses types reconnus. Vous pouvez également implémenter un ResourceFormatLoader.
Méthodes
_get_recognized_extensions(resource: Resource) virtual const |
|
_recognize(resource: Resource) virtual const |
|
_recognize_path(resource: Resource, path: String) virtual const |
|
Descriptions des méthodes
PackedStringArray _get_recognized_extensions(resource: Resource) virtual const 🔗
Renvoie la liste des extensions disponibles pour sauvegarder l'objet ressource, à condition qu'il soit reconnu (voir _recognize()).
bool _recognize(resource: Resource) virtual const 🔗
Renvoie si une ressource donnée peut être enregistrée par cet enregistreur.
bool _recognize_path(resource: Resource, path: String) virtual const 🔗
Renvoie true si cet enregistreur gère un chemin de sauvegarde donné et false sinon.
Si cette méthode n'est pas implémentée, le comportement par défaut renvoie si l'extension du chemin se trouve dans celles fournies par _get_recognized_extensions().
Error _save(resource: Resource, path: String, flags: int) virtual 🔗
Enregistre l'objet de ressource donné vers un fichier au chemin cible path. flags est un bitmask composé de constantes SaverFlags.
Renvoie @GlobalScope.OK lors du succès, ou une constante Error en cas d'échec.
Error _set_uid(path: String, uid: int) virtual 🔗
Définit un nouvel UID pour la ressource au chemin path donné. Renvoie @GlobalScope.OK lors du succès, ou une constante Error en cas d'échec.