Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

PackedDataContainer

Inherits: Resource < RefCounted < Object

Efficiently packs and serializes Array or Dictionary.

Description

PackedDataContainer can be used to efficiently store data from untyped containers. The data is packed into raw bytes and can be saved to file. Only Array and Dictionary can be stored this way.

You can retrieve the data by iterating on the container, which will work as if iterating on the packed data itself. If the packed container is a Dictionary, the data can be retrieved by key names (String/StringName only).

var data = { "key": "value", "another_key": 123, "lock": Vector2() }
var packed = PackedDataContainer.new()
packed.pack(data)
ResourceSaver.save(packed, "packed_data.res")
var container = load("packed_data.res")
for key in container:
    prints(key, container[key])

# Prints:
# key value
# lock (0, 0)
# another_key 123

Nested containers will be packed recursively. While iterating, they will be returned as PackedDataContainerRef.

Methods

Error

pack ( Variant value )

int

size ( ) const


Method Descriptions

Error pack ( Variant value )

Packs the given container into a binary representation. The value must be either