Documentation
¶
Overview ¶
[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). [codeblock] var data = { "key": "value", "another_key": 123, "lock": Vector2() } var packed = PackedDataContainer.new() packed.pack(data) ResourceSaver.save(packed, "packed_data.res") [/codeblock] [codeblock] var container = load("packed_data.res") for key in container:
prints(key, container[key])
[/codeblock] Prints: [codeblock lang=text] key value lock (0, 0) another_key 123 [/codeblock] Nested containers will be packed recursively. While iterating, they will be returned as [PackedDataContainerRef].
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsPackedDataContainer() Instance
- func (self Instance) AsRefCounted() [1]gd.RefCounted
- func (self Instance) AsResource() Resource.Instance
- func (self Instance) ID() ID
- func (self Instance) Pack(value any) error
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) Size() int
- func (self Instance) Virtual(name string) reflect.Value
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Advanced ¶
type Advanced = class
Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.
type Extension ¶
Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension
func (*Extension[T]) AsPackedDataContainer ¶
func (*Extension[T]) AsRefCounted ¶
func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
func (*Extension[T]) AsResource ¶
type ID ¶
ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.
type Instance ¶
type Instance [1]gdclass.PackedDataContainer
Instance of the class with convieniently typed arguments and results.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AsPackedDataContainer ¶
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
func (Instance) AsResource ¶
func (Instance) Pack ¶
Packs the given container into a binary representation. The 'value' must be either [Array] or [Dictionary], any other type will result in invalid data error. Note: Subsequent calls to this method will overwrite the existing data.
Source Files