PackedDataContainer
Efficiently packs and serializes GArray
or GDictionary
.
class PackedDataContainer
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 GArray
and GDictionary
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 GDictionary
, the data can be retrieved by key names (String
/StringName
only).
Nested containers will be packed recursively. While iterating, they will be returned as PackedDataContainerRef
.
Superclasses
class Resource
Base class for serializable objects.
Citizens in SwiftGodot
Conformances
protocol CustomStringConvertible
A type with a customized textual representation.
protocol Equatable
A type that can be compared for value equality.
protocol Hashable
A type that can be hashed into a
Hasher
to produce an integer hash value.protocol Identifiable<ID>
A class of types whose instances hold the value of an entity with stable identity.
protocol VariantRepresentable
Types that conform to VariantRepresentable can be stored directly in
Variant
with no conversion. These include all of the Variant types from Godot (for exampleGString
,Rect
,Plane
), Godot objects (those that subclass SwiftGodot.Object) as well as the built-in Swift types UInt8, Int64 and Double.protocol VariantStorable
Types that conform to VariantStorable can be stored in a Variant and can be extracted back out of a Variant.
Type members
Instance members
func pack(value: Variant
) -> GodotError Packs the given container into a binary representation. The
value
must be eitherGArray
orGDictionary
, any other type will result in invalid data error.func size(
) -> Int32 Returns the size of the packed container (see
Array/size()
andDictionary/size()
).