PackedDataContainer

Overview ¶

graphics.gd/classdb/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 slice and data structure 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 data structure, the data can be retrieved by key names (string/string only).

package main

import (
	"graphics.gd/classdb/PackedDataContainer"
	"graphics.gd/classdb/ResourceSaver"
	"graphics.gd/variant/Vector2"
)

func ExamplePackedDataContainerSave() {
	var data = map[string]any{"key": "value", "another_key": 123, "lock": Vector2.XY{}}
	var packed = PackedDataContainer.New()
	packed.Pack(data)
	ResourceSaver.Save(packed.AsResource(), "packed_data.res", 0)
}

package main

import (
	"fmt"

	"graphics.gd/classdb/PackedDataContainer"
	"graphics.gd/classdb/Resource"
	"graphics.gd/variant/Object"
)

func ExamplePackedDataContainerLoad() {
	var container = Resource.Load[PackedDataContainer.Instance]("packed_data.res")
	for _, prop := range Object.GetPropertyList(container) {
		fmt.Println(prop.Name, Object.Get(container, prop.Name))
	}
}

Prints:

Nested containers will be packed recursively. While iterating, they will be returned as graphics.gd/classdb/PackedDataContainerRef.