Work in progress

The content of this page was not yet updated for Godot 4.2 and may be outdated. If you know how to improve this page or you can confirm that it's up to date, feel free to open a pull request.

Binarna serizlizacja API

Wprowadzenie

Godot has a serialization API based on Variant. It's used for converting data types to an array of bytes efficiently. This API is exposed via the global bytes_to_var() and var_to_bytes() functions, but it is also used in the get_var and store_var methods of FileAccess as well as the packet APIs for PacketPeer. This format is not used for binary scenes and resources.

Full Objects vs Object instance IDs

If a variable is serialized with full_objects = true, then any Objects contained in the variable will be serialized and included in the result. This is recursive.

If full_objects = false, then only the instance IDs will be serialized for any Objects contained in the variable.

Packet specification

The packet is designed to be always padded to 4 bytes. All values are little-endian-encoded. All packets have a 4-byte header representing an integer, specifying the type of data.

The lowest value two bytes are used to determine the type, while the highest value two bytes contain flags:

base_type = val & 0xFFFF;
flags = val >> 16;

Typ

Wartość

0

null

1

bool

2

integer

3

float

4

string

5

vector2

6

rect2

7

vector3

8

transform2d

9

płaszczyzna

10

quaternion

11

aabb

12

basis

13

transform3d

14

kolor

15

node path

16

rid

17

obiekt

18

słownik

19

array

20

raw array

21

int32 array

22

int64 array

23

float32 array

24

float64 array

25

string array

26

vector2 array

27

vector3 array

28

color array

29

max

Following this is the actual packet contents, which varies for each type of packet. Note that this assumes Godot is compiled with single-precision floats, which is the default. If Godot was compiled with double-precision floats, the length of "Float" fields within data structures should be 8, and the offset should be (offset - 4) * 2 + 4. The "float" type itself always uses double precision.

0: null

1: bool

Przesunięcie

Długość

Typ

Opis

4

4

Liczba całkowita

0 - Fałsz, 1 - Prawda

2: int

If no flags are set (flags == 0), the integer is sent as a 32 bit integer:

Przesunięcie

Długość

Typ

Opis

4

4

Liczba całkowita

32 bity dodatnich liczb całkowitych

If flag ENCODE_FLAG_64 is set (flags & 1 == 1), the integer is sent as a 64-bit integer:

Przesunięcie

Długość

Typ

Opis

4

8

Liczba całkowita

64-bit signed integer

3: float

If no flags are set (flags == 0), the float is sent as a 32 bit single precision:

Przesunięcie

Długość

Typ

Opis

4

4

Float

IEEE 754 single-precision float

If flag ENCODE_FLAG_64 is set (flags & 1 == 1), the float is sent as a 64-bit double precision number:

Przesunięcie

Długość

Typ

Opis

4

8

Float

IEEE 754 double-precision float

4: String

Przesunięcie

Długość

Typ

Opis

4

4

Liczba całkowita

String length (in bytes)

8

X

Bajty

UTF-8 encoded string

This field is padded to 4 bytes.

5: Vector2

Przesunięcie

Długość

Typ

Opis

4

4

Float

X coordinate

8

4

Float

Y coordinate

6: Rect2

Przesunięcie

Długość

Typ

Opis

4

4

Float

X coordinate

8

4

Float

Y coordinate

12

4

Float

rozmiar X

16

4

Float

rozmiar Y

7: Vector3

Przesunięcie

Długość

Typ

Opis

4

4

Float

X coordinate

8

4

Float

Y coordinate

12

4

Float

Z coordinate

8: Transform2D

Przesunięcie

Długość

Typ

Opis

4

4

Float

Poszczególne komponenty wektora są dostępne bezpośrednio po nazwie

8

4

Float

Poszczególne komponenty wektora są dostępne bezpośrednio po nazwie

12

4

Float

Poszczególne komponenty wektora są dostępne bezpośrednio po nazwie

16

4

Float

Poszczególne komponenty wektora są dostępne bezpośrednio po nazwie

20

4

Float

Poszczególne komponenty wektora są dostępne bezpośrednio po nazwie

24

4

Float

Poszczególne komponenty wektora są dostępne bezpośrednio po nazwie

9: Plane

Przesunięcie

Długość

Typ

Opis

4

4

Float

Normal X

8

4

Float

Normal Y

12

4

Float

Normalna Z

16

4

Float

Dystans

10: Quaternion

Przesunięcie

Długość

Typ

Opis

4

4

Float

Zespolone X

8

4

Float

Zespolone Y

12

4

Float

Zespolone Z

16

4

Float

Rzeczywiste W

11: AABB

Przesunięcie

Długość

Typ

Opis

4

4

Float

X coordinate

8

4

Float

Y coordinate

12

4

Float

Z coordinate

16

4

Float

rozmiar X

20

4

Float

rozmiar Y

24

4

Float

Z size

12: Basis

Przesunięcie

Długość

Typ

Opis

4

4

Float

Poszczególne komponenty wektora są dostępne bezpośrednio po nazwie

8

4

Float

Poszczególne komponenty wektora są dostępne bezpośrednio po nazwie

12

4

Float

Poszczególne komponenty wektora są dostępne bezpośrednio po nazwie

16

4

Float

Poszczególne komponenty wektora są dostępne bezpośrednio po nazwie

20

4

Float

Poszczególne komponenty wektora są dostępne bezpośrednio po nazwie

24

4

Float

Komponent Z wektora kolumnowego Y, dostępny przez [1][2]

28

4

Float

Komponent X wektora kolumnowego Z, dostępny przez [2][0]

32

4

Float

Poszczególne komponenty wektora są dostępne bezpośrednio po nazwie

36

4

Float

Poszczególne komponenty wektora są dostępne bezpośrednio po nazwie

13: Transform3D

Przesunięcie

Długość

Typ

Opis

4

4

Float

Poszczególne komponenty wektora są dostępne bezpośrednio po nazwie

8

4

Float

Poszczególne komponenty wektora są dostępne bezpośrednio po nazwie

12

4

Float

Poszczególne komponenty wektora są dostępne bezpośrednio po nazwie

16

4

Float

Poszczególne komponenty wektora są dostępne bezpośrednio po nazwie

20

4

Float

Poszczególne komponenty wektora są dostępne bezpośrednio po nazwie

24

4

Float

Komponent Z wektora kolumnowego Y, dostępny przez [1][2]

28

4

Float

Komponent X wektora kolumnowego Z, dostępny przez [2][0]

32

4

Float

Poszczególne komponenty wektora są dostępne bezpośrednio po nazwie

36

4

Float

Poszczególne komponenty wektora są dostępne bezpośrednio po nazwie

40

4

Float

Poszczególne komponenty wektora są dostępne bezpośrednio po nazwie

44

4

Float

Poszczególne komponenty wektora są dostępne bezpośrednio po nazwie

48

4

Float

Poszczególne komponenty wektora są dostępne bezpośrednio po nazwie

14: Color

Przesunięcie

Długość

Typ

Opis

4

4

Float

Red (typically 0..1, can be above 1 for overbright colors)

8

4

Float

Green (typically 0..1, can be above 1 for overbright colors)

12

4

Float

Blue (typically 0..1, can be above 1 for overbright colors)

16

4

Float

Przezroczystość (0..1)

15: NodePath

Przesunięcie

Długość

Typ

Opis

4

4

Liczba całkowita

String length, or new format (val&0x80000000!=0 and NameCount=val&0x7FFFFFFF)

Dla starego formatu:

Przesunięcie

Długość

Typ

Opis

8

X

Bajty

UTF-8 encoded string

Padded to 4 bytes.

Dla nowego formatu:

Przesunięcie

Długość

Typ

Opis

4

4

Liczba całkowita

Sub-name count

8

4

Liczba całkowita

Flags (absolute: val&1 != 0 )

For each Name and Sub-Name

Przesunięcie

Długość

Typ

Opis

X+0

4

Liczba całkowita

String length

X+4

X

Bajty

UTF-8 encoded string

Every name string is padded to 4 bytes.

16: RID (niewspierany)

17: Object

An Object could be serialized in three different ways: as a null value, with full_objects = false, or with full_objects = true.

A null value

Przesunięcie

Długość

Typ

Opis

4

4

Liczba całkowita

Zero (32-bit signed integer)

full_objects disabled

Przesunięcie

Długość

Typ

Opis

4

8

Liczba całkowita

The Object instance ID (64-bit signed integer)

full_objects enabled

Przesunięcie

Długość

Typ

Opis

4

4

Liczba całkowita

Class name (String length)

8

X

Bajty

Class name (UTF-8 encoded string)

X+8

4

Liczba całkowita

The number of properties that are serialized

For each property:

Przesunięcie

Długość

Typ

Opis

Y

4

Liczba całkowita

Property name (String length)

Y+4

Z

Bajty

Property name (UTF-8 encoded string)

Y+4+Z

W

<variable>

Property value, using this same format

Informacja

Not all properties are included. Only properties that are configured with the PROPERTY_USAGE_STORAGE flag set will be serialized. You can add a new usage flag to a property by overriding the _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.

18: Dictionary

Przesunięcie

Długość

Typ

Opis

4

4

Liczba całkowita

val&0x7FFFFFFF = elements, val&0x80000000 = shared (bool)

Then what follows is, for amount of "elements", pairs of key and value, one after the other, using this same format.

19: Array

Przesunięcie

Długość

Typ

Opis

4

4

Liczba całkowita

val&0x7FFFFFFF = elements, val&0x80000000 = shared (bool)

Then what follows is, for amount of "elements", values one after the other, using this same format.

20: PackedByteArray

Przesunięcie

Długość

Typ

Opis

4

4

Liczba całkowita

Array length (Bytes)

8..8+długość

1

Bajt

Bajt (0..255)

The array data is padded to 4 bytes.

21: PackedInt32Array

Przesunięcie

Długość

Typ

Opis

4

4

Liczba całkowita

Array length (Integers)

8..8+długość*4

4

Liczba całkowita

32 bity dodatnich liczb całkowitych

22: PackedInt64Array

Przesunięcie

Długość

Typ

Opis

4

8

Liczba całkowita

Array length (Integers)

8..8+długość*8

8

Liczba całkowita

64-bit signed integer

23: PackedFloat32Array

Przesunięcie

Długość

Typ

Opis

4

4

Liczba całkowita

Array length (Floats)

8..8+długość*4

4

Liczba całkowita

32-bit IEEE 754 single-precision float

24: PackedFloat64Array

Przesunięcie

Długość

Typ

Opis

4

4

Liczba całkowita

Array length (Floats)

8..8+długość*8

8

Liczba całkowita

64-bit IEEE 754 double-precision float

25: PackedStringArray

Przesunięcie

Długość

Typ

Opis

4

4

Liczba całkowita

Array length (Strings)

Dla każdego łańcucha znaków:

Przesunięcie

Długość

Typ

Opis

X+0

4

Liczba całkowita

String length

X+4

X

Bajty

UTF-8 encoded string

Każdy ciąg jest dopełniany do 4 bajtów.

26: PackedVector2Array

Przesunięcie

Długość

Typ

Opis

4

4

Liczba całkowita

Array length

8..8+długość*8

4

Float

X coordinate

8..12+długość*8

4

Float

Y coordinate

27: PackedVector3Array

Przesunięcie

Długość

Typ

Opis

4

4

Liczba całkowita

Array length

8..8+długość*12

4

Float

X coordinate

8..12+długość*12

4

Float

Y coordinate

8..16+długość*12

4

Float

Z coordinate

28: PackedColorArray

Przesunięcie

Długość

Typ

Opis

4

4

Liczba całkowita

Array length

8..8+długość*16

4

Float

Red (typically 0..1, can be above 1 for overbright colors)

8..12+długość*16

4

Float

Green (typically 0..1, can be above 1 for overbright colors)

8..16+długość*16

4

Float

Blue (typically 0..1, can be above 1 for overbright colors)

8..20+długość*16

4

Float

Przezroczystość (0..1)