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...
FileAccess
Hérite de : RefCounted < Object
Provides methods for file reading and writing operations.
Description
Cette classe peut être implémentée pour stocker de manière permanente des données dans le système de fichier de l'appareil de l'utilisateur, et pour en lire. C'est utile pour stocker des données de sauvegardes ou des fichiers de configuration de jeux.
Example: Comment écrire et lire dans un fichier. Le fichier nommé "save_game.dat" sera stocké dans le dossier "data" de l'utilisateur, comme indiqué dans la Data paths documentation :
func save_to_file(content):
var file = FileAccess.open("user://save_game.dat", FileAccess.WRITE)
file.store_string(content)
func load_from_file():
var file = FileAccess.open("user://save_game.dat", FileAccess.READ)
var content = file.get_as_text()
return content
public void SaveToFile(string content)
{
using var file = FileAccess.Open("user://save_game.dat", FileAccess.ModeFlags.Write);
file.StoreString(content);
}
public string LoadFromFile()
{
using var file = FileAccess.Open("user://save_game.dat", FileAccess.ModeFlags.Read);
string content = file.GetAsText();
return content;
}
Une instance de FileAccess a son propre curseur de fichier, qui est la position en bytes dans le fichier ou la prochaine opération de lecture/écriture aura lieu. Les fonctions telles que get_8(), get_16(), store_8(), etstore_16() déplaceront le curseur de fichier en avant du nombre de bytes lus/écrits. Le curseur de fichier peut être déplacé à une position spécifiée en utilisant la seek() ouseek_end(), et sa position peut être récupérée en utilisant get_position().
Une instance de FileAccess est fermée lorsque sont instance est libérée. Étant donné qu'elle hérite de RefCounted, cette opération est réalisée automatiquement lorsqu'elle n'est plus utilisée. close() peut être appelée pour la fermer plus tôt. En C#, la référence peut être supprimée manuellement, ce qui peut être réalisé avec l'instruction using ou en appelant la méthode Dispose directement.
Note : Pour accéder aux ressources du projet une fois exporté, il est recommandé d'utiliser ResourceLoader au lieu de FileAccess, car certains fichiers sont convertis en formats spécifiques au moteur et leurs fichiers sources originaux pourraient ne pas être présents dans le paquet PCK exporté. Si vous utilisez FileAccess, assurez-vous que le fichier est inclus dans l'exportation en changeant son mode d'importation à Keep File (exported as is) dans le dock d'importation, ou, pour les fichiers où cette option n'est pas disponible, modifiez le filtre d'exportation non-ressource dans le dialogue Exporter pour inclure l'extension du fichier (e.g. *.txt).
**Note : ** Les fichiers sont automatiquement fermés seulement si le processus termine « normalement » (comme en cliquant sur le bouton de fermeture du gestionnaire de fenêtre ou en appuyant sur Alt + F4). Si vous arrêtez l'exécution du projet en appuyant sur F8 pendant que le projet est en cours d'exécution, le fichier ne sera pas fermé car le processus de jeu sera arrêté. Vous pouvez contourner cela en appelant flush() à intervalles réguliers.
Tutoriels
Propriétés
Méthodes
Énumérations
enum ModeFlags: 🔗
ModeFlags READ = 1
Opens the file for read operations. The file cursor is positioned at the beginning of the file.
ModeFlags WRITE = 2
Opens the file for write operations. If the file exists, it is truncated to zero length and its contents are cleared. Otherwise, it is created.
Note: When creating a file it must be in an already existing directory. To recursively create directories for a file path, see DirAccess.make_dir_recursive().
ModeFlags READ_WRITE = 3
Opens the file for read and write operations. Does not truncate the file. The file cursor is positioned at the beginning of the file.
ModeFlags WRITE_READ = 7
Opens the file for read and write operations. If the file exists, it is truncated to zero length and its contents are cleared. Otherwise, it is created. The file cursor is positioned at the beginning of the file.
Note: When creating a file it must be in an already existing directory. To recursively create directories for a file path, see DirAccess.make_dir_recursive().
enum CompressionMode: 🔗
CompressionMode COMPRESSION_FASTLZ = 0
Utilise la méthode de compression FastLZ.
CompressionMode COMPRESSION_DEFLATE = 1
Utilise la méthode de compression DEFLATE.
CompressionMode COMPRESSION_ZSTD = 2
Utilise la méthode de compression Zstandard.
CompressionMode COMPRESSION_GZIP = 3
Utilise la méthode de compression gzip.
CompressionMode COMPRESSION_BROTLI = 4
Uses the brotli compression method (only decompression is supported).
flags UnixPermissionFlags: 🔗
UnixPermissionFlags UNIX_READ_OWNER = 256
Read for owner bit.
UnixPermissionFlags UNIX_WRITE_OWNER = 128
Write for owner bit.
UnixPermissionFlags UNIX_EXECUTE_OWNER = 64
Execute for owner bit.
UnixPermissionFlags UNIX_READ_GROUP = 32
Read for group bit.
UnixPermissionFlags UNIX_WRITE_GROUP = 16
Write for group bit.
UnixPermissionFlags UNIX_EXECUTE_GROUP = 8
Execute for group bit.
UnixPermissionFlags UNIX_READ_OTHER = 4
Read for other bit.
UnixPermissionFlags UNIX_WRITE_OTHER = 2
Write for other bit.
UnixPermissionFlags UNIX_EXECUTE_OTHER = 1
Execute for other bit.
UnixPermissionFlags UNIX_SET_USER_ID = 2048
Set user id on execution bit.
UnixPermissionFlags UNIX_SET_GROUP_ID = 1024
Set group id on execution bit.
UnixPermissionFlags UNIX_RESTRICTED_DELETE = 512
Restricted deletion (sticky) bit.
Descriptions des propriétés
If true, the file is read with big-endian endianness. If false, the file is read with little-endian endianness. If in doubt, leave this to false as most files are written with little-endian endianness.
Note: This is always reset to system endianness, which is little-endian on all supported platforms, whenever you open the file. Therefore, you must set big_endian after opening the file, not before.
Descriptions des méthodes
void close() 🔗
Closes the currently opened file and prevents subsequent read/write operations. Use flush() to persist the data to disk without closing the file.
Note: FileAccess will automatically close when it's freed, which happens when it goes out of scope or when it gets assigned with null. In C# the reference must be disposed after we are done using it, this can be done with the using statement or calling the Dispose method directly.
FileAccess create_temp(mode_flags: ModeFlags, prefix: String = "", extension: String = "", keep: bool = false) static 🔗
Creates a temporary file. This file will be freed when the returned FileAccess is freed.
If prefix is not empty, it will be prefixed to the file name, separated by a -.
If extension is not empty, it will be appended to the temporary file name.
If keep is true, the file is not deleted when the returned FileAccess is freed.
Returns null if opening the file failed. You can use get_open_error() to check the error that occurred.
Returns true if the file cursor has already read past the end of the file.
Note: eof_reached() == false cannot be used to check whether there is more data available. To loop while there is more data available, use:
while file.get_position() < file.get_length():
# Read data
while (file.GetPosition() < file.GetLength())
{
// Read data
}
bool file_exists(path: String) static 🔗
Returns true if the file exists in the given path.
Note: Many resources types are imported (e.g. textures or sound files), and their source asset will not be included in the exported game, as only the imported version is used. See ResourceLoader.exists() for an alternative approach that takes resource remapping into account.
For a non-static, relative equivalent, use DirAccess.file_exists().
void flush() 🔗
Writes the file's buffer to disk. Flushing is automatically performed when the file is closed. This means you don't need to call flush() manually before closing a file. Still, calling flush() can be used to ensure the data is safe even if the project crashes instead of being closed gracefully.
Note: Only call flush() when you actually need it. Otherwise, it will decrease performance due to constant disk writes.
Returns the next 8 bits from the file as an integer. This advances the file cursor by 1 byte. See store_8() for details on what values can be stored and retrieved this way.
Returns the next 16 bits from the file as an integer. This advances the file cursor by 2 bytes. See store_16() for details on what values can be stored and retrieved this way.
Returns the next 32 bits from the file as an integer. This advances the file cursor by 4 bytes. See store_32() for details on what values can be stored and retrieved this way.
Returns the next 64 bits from the file as an integer. This advances the file cursor by 8 bytes. See store_64() for details on what values can be stored and retrieved this way.
int get_access_time(file: String) static 🔗
Returns the last time the file was accessed in Unix timestamp format, or 0 on error. This Unix timestamp can be converted to another format using the Time singleton.
Returns the whole file as a String. Text is interpreted as being UTF-8 encoded. This ignores the file cursor and does not affect it.
PackedByteArray get_buffer(length: int) const 🔗
Returns next length bytes of the file as a PackedByteArray. This advances the file cursor by length bytes.
PackedStringArray get_csv_line(delim: String = ",") const 🔗
Returns the next value of the file in CSV (Comma-Separated Values) format. You can pass a different delimiter delim to use other than the default "," (comma). This delimiter must be one-character long, and cannot be a double quotation mark.
Text is interpreted as being UTF-8 encoded. Text values must be enclosed in double quotes if they include the delimiter character. Double quotes within a text value can be escaped by doubling their occurrence. This advances the file cursor to after the newline character at the end of the line.
For example, the following CSV lines are valid and will be properly parsed as two strings each:
Alice,"Hello, Bob!"
Bob,Alice! What a surprise!
Alice,"I thought you'd reply with ""Hello, world""."
Note how the second line can omit the enclosing quotes as it does not include the delimiter. However it could very well use quotes, it was only written without for demonstration purposes. The third line must use "" for each quotation mark that needs to be interpreted as such instead of the end of a text value.
Returns the next 64 bits from the file as a floating-point number. This advances the file cursor by 8 bytes.
Renvoie la dernière erreur qui est arrivée lors de l'exécution d'une opération. Comparez-la avec les constantes ERR_FILE_* de Error.
PackedByteArray get_extended_attribute(file: String, attribute_name: String) static 🔗
Reads the file extended attribute with name attribute_name as a byte array.
Note: This method is implemented on Linux, macOS, and Windows.
Note: Extended attributes support depends on the file system. Attributes will be lost when the file is moved between incompatible file systems.
Note: On Linux, only "user" namespace attributes are accessible, namespace prefix should not be included.
Note: On Windows, alternate data streams are used to store extended attributes.
String get_extended_attribute_string(file: String, attribute_name: String) static 🔗
Reads the file extended attribute with name attribute_name as a UTF-8 encoded string.
Note: This method is implemented on Linux, macOS, and Windows.
Note: Extended attributes support depends on the file system. Attributes will be lost when the file is moved between incompatible file systems.
Note: On Linux, only "user" namespace attributes are accessible, namespace prefix should not be included.
Note: On Windows, alternate data streams are used to store extended attributes.
PackedStringArray get_extended_attributes_list(file: String) static 🔗
Returns a list of file extended attributes.
Note: This method is implemented on Linux, macOS, and Windows.
Note: Extended attributes support depends on the file system. Attributes will be lost when the file is moved between incompatible file systems.
Note: On Linux, only "user" namespace attributes are accessible, namespace prefix should not be included.
Note: On Windows, alternate data streams are used to store extended attributes.
PackedByteArray get_file_as_bytes(path: String) static 🔗
Returns the whole path file contents as a PackedByteArray without any decoding.
Returns an empty PackedByteArray if an error occurred while opening the file. You can use get_open_error() to check the error that occurred.
String get_file_as_string(path: String) static 🔗
Returns the whole path file contents as a String. Text is interpreted as being UTF-8 encoded.
Returns an empty String if an error occurred while opening the file. You can use get_open_error() to check the error that occurred.
Returns the next 32 bits from the file as a floating-point number. This advances the file cursor by 4 bytes.
Returns the next 16 bits from the file as a half-precision floating-point number. This advances the file cursor by 2 bytes.
Retourne true si l'attribut hidden est défini sur le fichier du chemin donné.
Note : Cette méthode est disponible sur iOS, BSD, macOS et Windows.
Returns the size of the file in bytes. For a pipe, returns the number of bytes available for reading from the pipe.
Returns the next line of the file as a String. The returned string doesn't include newline (\n) or carriage return (\r) characters, but does include any other leading or trailing whitespace. This advances the file cursor to after the newline character at the end of the line.
Text is interpreted as being UTF-8 encoded.
String get_md5(path: String) static 🔗
Renvoie une chaîne MD5 représentant le fichier au chemin spécifié ou une String vide en cas d'échec.
int get_modified_time(file: String) static 🔗
Returns the last time the file was modified in Unix timestamp format, or 0 on error. This Unix timestamp can be converted to another format using the Time singleton.
Error get_open_error() static 🔗
Renvoie le résultat du dernier appel à open() sur le thread courant.
Returns a String saved in Pascal format from the file, meaning that the length of the string is explicitly stored at the start. See store_pascal_string(). This may include newline characters. The file cursor is advanced after the bytes read.
Text is interpreted as being UTF-8 encoded.
Renvoie le chemin en tant que String du fichier actuellement ouvert.
String get_path_absolute() const 🔗
Renvoie le chemin absolu en tant que String du fichier actuellement ouvert.
Returns the file cursor's position in bytes from the beginning of the file. This is the file reading/writing cursor set by seek() or seek_end() and advanced by read/write operations.
bool get_read_only_attribute(file: String) static 🔗
Renvoie true si l'attribut read only est défini sur le fichier au chemin donné.
Note : Cette méthode est implémentée sur iOS, BSD, macOS et Windows.
Returns the next bits from the file as a floating-point number. This advances the file cursor by either 4 or 8 bytes, depending on the precision used by the Godot build that saved the file.
If the file was saved by a Godot build compiled with the precision=single option (the default), the number of read bits for that file is 32. Otherwise, if compiled with the precision=double option, the number of read bits is 64.
String get_sha256(path: String) static 🔗
Returns an SHA-256 String representing the file at the given path or an empty String on failure.
int get_size(file: String) static 🔗
Renvoie la taille du fichier sur le chemin donné, en bytes, ou -1 en cas d'erreur.
BitField[UnixPermissionFlags] get_unix_permissions(file: String) static 🔗
Returns the UNIX permissions of the file at the given path.
Note: This method is implemented on iOS, Linux/BSD, and macOS.
Variant get_var(allow_objects: bool = false) const 🔗
Returns the next Variant value from the file. If allow_objects is true, decoding objects is allowed. This advances the file cursor by the number of bytes read.
Internally, this uses the same decoding mechanism as the @GlobalScope.bytes_to_var() method, as described in the Binary serialization API documentation.
Warning: Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution.
Renvoie true si le fichier est actuellement ouvert.
FileAccess open(path: String, flags: ModeFlags) static 🔗
Creates a new FileAccess object and opens the file for writing or reading, depending on the flags.
Returns null if opening the file failed. You can use get_open_error() to check the error that occurred.
FileAccess open_compressed(path: String, mode_flags: ModeFlags, compression_mode: CompressionMode = 0) static 🔗
Creates a new FileAccess object and opens a compressed file for reading or writing.
Note: open_compressed() can only read files that were saved by Godot, not third-party compression formats. See GitHub issue #28999 for a workaround.
Returns null if opening the file failed. You can use get_open_error() to check the error that occurred.
FileAccess open_encrypted(path: String, mode_flags: ModeFlags, key: PackedByteArray, iv: PackedByteArray = PackedByteArray()) static 🔗
Creates a new FileAccess object and opens an encrypted file in write or read mode. You need to pass a binary key to encrypt/decrypt it.
Note: The provided key must be 32 bytes long.
Returns null if opening the file failed. You can use get_open_error() to check the error that occurred.
FileAccess open_encrypted_with_pass(path: String, mode_flags: ModeFlags, pass: String) static 🔗
Creates a new FileAccess object and opens an encrypted file in write or read mode. You need to pass a password to encrypt/decrypt it.
Returns null if opening the file failed. You can use get_open_error() to check the error that occurred.
Error remove_extended_attribute(file: String, attribute_name: String) static 🔗
Removes file extended attribute with name attribute_name.
Note: This method is implemented on Linux, macOS, and Windows.
Note: Extended attributes support depends on the file system. Attributes will be lost when the file is moved between incompatible file systems.
Note: On Linux, only "user" namespace attributes are accessible, namespace prefix should not be included.
Note: On Windows, alternate data streams are used to store extended attributes.
Resizes the file to a specified length. The file must be open in a mode that permits writing. If the file is extended, NUL characters are appended. If the file is truncated, all data from the end file to the original length of the file is lost.
Sets the file cursor to the specified position in bytes, from the beginning of the file. This changes the value returned by get_position().
void seek_end(position: int = 0) 🔗
Sets the file cursor to the specified position in bytes, from the end of the file. This changes the value returned by get_position().
Note: This is an offset, so you should use negative numbers otherwise the file cursor will move past the end of the file.
Error set_extended_attribute(file: String, attribute_name: String, data: PackedByteArray) static 🔗
Writes file extended attribute with name attribute_name as a byte array.
Note: This method is implemented on Linux, macOS, and Windows.
Note: Extended attributes support depends on the file system. Attributes will be lost when the file is moved between incompatible file systems.
Note: On Linux, only "user" namespace attributes are accessible, namespace prefix should not be included.
Note: On Windows, alternate data streams are used to store extended attributes.
Error set_extended_attribute_string(file: String, attribute_name: String, data: String) static 🔗
Writes file extended attribute with name attribute_name as a UTF-8 encoded string.
Note: This method is implemented on Linux, macOS, and Windows.
Note: Extended attributes support depends on the file system. Attributes will be lost when the file is moved between incompatible file systems.
Note: On Linux, only "user" namespace attributes are accessible, namespace prefix should not be included.
Note: On Windows, alternate data streams are used to store extended attributes.
Ajoute l'attribut hidden au fichier.
Note : Cette méthode est implémentée sur OS, BSD, macOS, et Windows.
Error set_read_only_attribute(file: String, ro: bool) static 🔗
Ajoute l'attribut read only au fichier
Note : Cette méthode est implémentée sur iOS, BSD, macOS, et Windows.
Error set_unix_permissions(file: String, permissions: BitField[UnixPermissionFlags]) static 🔗
Sets file UNIX permissions.
Note: This method is implemented on iOS, Linux/BSD, and macOS.
Enregistre un entier sur 8 bits dans le fichier. Cela avance le curseur de fichier de 8 bytes. Retourne true si l'opération est réussie.
Note : La value doit se situer dans l'intervalle [0, 255]. Toute autre valeur va déborder et boucler.
Note : Si une erreur survient, la valeur résultante de l'indicateur de position du fichier est indéterminée.
Pour stocker un entier signé, utilisez store_64() ou convertissez-le manuellement (voir store_16() pour un exemple).
Enregistre un entier au format 16 bits dans le fichier. Cette opération avance le curseur de fichier de 2 bytes. Retourne true si l'opération est réussie.
Note : La value doit entre dans l'intervalle [0, 2^16 - 1]. Toute autre valeur dépassera et sera alors réduite à cet intervalle.
Note: Si une erreur se produit, la valeur résultante de l'indicateur de position du fichier est indéterminée.
Pour stocker un entier signé, utilisez store_64() ou stockez un entier signé à partir de l'intervalle [-2^15, 2^15 - 1] (c.-à-d. garder un bit pour la signature) et calculer son signe manuellement lors de la lecture. Par exemple :
const MAX_15B = 1 << 15
const MAX_16B = 1 << 16
func unsigned16_to_signed(unsigned):
return (unsigned + MAX_15B) % MAX_16B - MAX_15B
func _ready():
var f = FileAccess.open("user://file.dat", FileAccess.WRITE_READ)
f.store_16(-42) # This wraps around and stores 65494 (2^16 - 42).
f.store_16(121) # In bounds, will store 121.
f.seek(0) # Go back to start to read the stored value.
var read1 = f.get_16() # 65494
var read2 = f.get_16() # 121
var converted1 = unsigned16_to_signed(read1) # -42
var converted2 = unsigned16_to_signed(read2) # 121
public override void _Ready()
{
using var f = FileAccess.Open("user://file.dat", FileAccess.ModeFlags.WriteRead);
f.Store16(unchecked((ushort)-42)); // This wraps around and stores 65494 (2^16 - 42).
f.Store16(121); // In bounds, will store 121.
f.Seek(0); // Go back to start to read the stored value.
ushort read1 = f.Get16(); // 65494
ushort read2 = f.Get16(); // 121
short converted1 = (short)read1; // -42
short converted2 = (short)read2; // 121
}
Stores an integer as 32 bits in the file. This advances the file cursor by 4 bytes. Returns true if the operation is successful.
Note: The value should lie in the interval [0, 2^32 - 1]. Any other value will overflow and wrap around.
Note: If an error occurs, the resulting value of the file position indicator is indeterminate.
To store a signed integer, use store_64(), or convert it manually (see store_16() for an example).
Stores an integer as 64 bits in the file. This advances the file cursor by 8 bytes. Returns true if the operation is successful.
Note: The value must lie in the interval [-2^63, 2^63 - 1] (i.e. be a valid int value).
Note: If an error occurs, the resulting value of the file position indicator is indeterminate.
bool store_buffer(buffer: PackedByteArray) 🔗
Stores the given array of bytes in the file. This advances the file cursor by the number of bytes written. Returns true if the operation is successful.
Note: If an error occurs, the resulting value of the file position indicator is indeterminate.
bool store_csv_line(values: PackedStringArray, delim: String = ",") 🔗
Stores the given PackedStringArray in the file as a line formatted in the CSV (Comma-Separated Values) format. You can pass a different delimiter delim to use other than the default "," (comma). This delimiter must be one-character long.
Text will be encoded as UTF-8. Returns true if the operation is successful.
Note: If an error occurs, the resulting value of the file position indicator is indeterminate.
bool store_double(value: float) 🔗
Stores a floating-point number as 64 bits in the file. This advances the file cursor by 8 bytes. Returns true if the operation is successful.
Note: If an error occurs, the resulting value of the file position indicator is indeterminate.
bool store_float(value: float) 🔗
Stores a floating-point number as 32 bits in the file. This advances the file cursor by 4 bytes. Returns true if the operation is successful.
Note: If an error occurs, the resulting value of the file position indicator is indeterminate.
bool store_half(value: float) 🔗
Stores a half-precision floating-point number as 16 bits in the file. This advances the file cursor by 2 bytes. Returns true if the operation is successful.
Note: If an error occurs, the resulting value of the file position indicator is indeterminate.
bool store_line(line: String) 🔗
Stores line in the file followed by a newline character (\n), encoding the text as UTF-8. This advances the file cursor by the length of the line, after the newline character. The amount of bytes written depends on the UTF-8 encoded bytes, which may be different from String.length() which counts the number of UTF-32 codepoints. Returns true if the operation is successful.
Note: If an error occurs, the resulting value of the file position indicator is indeterminate.
bool store_pascal_string(string: String) 🔗
Stores the given String as a line in the file in Pascal format (i.e. also store the length of the string). Text will be encoded as UTF-8. This advances the file cursor by the number of bytes written depending on the UTF-8 encoded bytes, which may be different from String.length() which counts the number of UTF-32 codepoints. Returns true if the operation is successful.
Note: If an error occurs, the resulting value of the file position indicator is indeterminate.
bool store_real(value: float) 🔗
Stores a floating-point number in the file. This advances the file cursor by either 4 or 8 bytes, depending on the precision used by the current Godot build.
If using a Godot build compiled with the precision=single option (the default), this method will save a 32-bit float. Otherwise, if compiled with the precision=double option, this will save a 64-bit float. Returns true if the operation is successful.
Note: If an error occurs, the resulting value of the file position indicator is indeterminate.
bool store_string(string: String) 🔗
Stores string in the file without a newline character (\n), encoding the text as UTF-8. This advances the file cursor by the length of the string in UTF-8 encoded bytes, which may be different from String.length() which counts the number of UTF-32 codepoints. Returns true if the operation is successful.
Note: This method is intended to be used to write text files. The string is stored as a UTF-8 encoded buffer without string length or terminating zero, which means that it can't be loaded back easily. If you want to store a retrievable string in a binary file, consider using store_pascal_string() instead. For retrieving strings from a text file, you can use get_buffer(length).get_string_from_utf8() (if you know the length) or get_as_text().
Note: If an error occurs, the resulting value of the file position indicator is indeterminate.
bool store_var(value: Variant, full_objects: bool = false) 🔗
Stores any Variant value in the file. If full_objects is true, encoding objects is allowed (and can potentially include code). This advances the file cursor by the number of bytes written. Returns true if the operation is successful.
Internally, this uses the same encoding mechanism as the @GlobalScope.var_to_bytes() method, as described in the Binary serialization API documentation.
Note: Not all properties are included. Only properties that are configured with the @GlobalScope.PROPERTY_USAGE_STORAGE flag set will be serialized. You can add a new usage flag to a property by overriding the Object._get_property_list() method in your class. You can also check how property usage is configured by calling Object._get_property_list(). See PropertyUsageFlags for the possible usage flags.
Note: If an error occurs, the resulting value of the file position indicator is indeterminate.