godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-07 02:12:07 +03:00
Code Issues Packages Projects Releases Wiki Activity

JSON vs binary serialization improvements

Browse Source
This commit is contained in:
Max Hilbrunner
2021-08-09 16:18:26 +02:00
parent 7fa80b37ba
commit ccf9c7c67e
1 changed files with 11 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
tutorials/io/saving_games.rst
View File

@@ -314,11 +314,10 @@ children to parents as the :ref:`NodePath
JSON vs binary serialization JSON vs binary serialization
---------------------------- ----------------------------
For simple game state, JSON may be the best choice, because it is easy to For simple game state, JSON may work and it generates human-readable files that are easy to debug.
understand, and generates human-readable files that are easy to debug.
But JSON has many limitations. If you need to store more complex game state or But JSON has many limitations. If you need to store more complex game state or
a lot of game state, :ref:`binary serialization<doc_binary_serialization_api>` a lot of it, :ref:`binary serialization<doc_binary_serialization_api>`
may be a better approach. may be a better approach.
JSON limitations JSON limitations
@@ -326,16 +325,14 @@ JSON limitations
Here are some important gotchas to know about when using JSON. Here are some important gotchas to know about when using JSON.
Filesize: * **Filesize:**
JSON stores data in text format, which is much larger than binary format. JSON stores data in text format, which is much larger than binary formats.
* **Data types:**
Data types: JSON only offers a limited set of data types. If you have data types
JSON only knows about a limited set of data types. If you have data types that JSON doesn't have, you will need to translate your data to and
that JSON doesn't know about, you will need to translate your data to and
from types that JSON can handle. For example, some important types that JSON from types that JSON can handle. For example, some important types that JSON
can't parse are: Vector2, Vector3, Color, Rect2, Quat. can't parse are: ``Vector2``, ``Vector3``, ``Color``, ``Rect2``, and ``Quat``.
* **Custom logic needed for encoding/decoding:**
Custom logic needed for encoding/decoding:
If you have any custom classes that you want to store with JSON, you will If you have any custom classes that you want to store with JSON, you will
need to write your own logic for encoding and decoding those classes. need to write your own logic for encoding and decoding those classes.
@@ -356,6 +353,6 @@ with the :ref:`PROPERTY_USAGE_STORAGE<class_@GlobalScope_constant_PROPERTY_USAGE
flag set will be serialized. You can add a new usage flag to a property by overriding the flag set will be serialized. You can add a new usage flag to a property by overriding the
:ref:`_get_property_list<class_Object_method__get_property_list>` :ref:`_get_property_list<class_Object_method__get_property_list>`
method in your class. You can also check how property usage is configured by method in your class. You can also check how property usage is configured by
calling ``Object._get_property_list`` See calling ``Object._get_property_list``.
:ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>` for the See :ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>` for the
possible usage flags. possible usage flags.