Chrisknyfe
PicklerGD Serializer
PickleGD is a Godot asset for safely serializing arbitrary godot data structures, including custom classes, over multiplayer and to disk.Tested with: Godot Engine v4.4.stable.official.4c311cbee This is a system for "pickling" GDScript objects to byte arrays, using native var_to_bytes plus some code inspection magic. It's meant to make it easy for youto send complex data structures (such as large custom classes) over the networkto multiplayer peers, or to create your own save system. PickleGD is designedto prevent arbitrary code execution in the serialization and deserializationprocess.Note: this asset is not compatible with Python's pickle format.# Quick Start exampleTo get started pickling your data, first create a pickler.```var pickler = Pickler.new()```If you have custom classes you want to register, register them at scene load time:```pickler.register_custom_class(CustomClassOne)pickler.register_custom_class(CustomClassTwo)```If you want to register godot engine native classes, you must use the class nameas a string:```pickler.register_native_class("Node2D")```Now you are ready to pickle your data! On the sender's side, just pass your datato `picker.pickle()`, send the resulting PackedByteArray, then at the receiver'sside pass the PackedByteArray to `pickler.unpickle()`.```var data = {"one": CustomClassOne.new(),"things": ["str", 42, {"foo":"bar"}, [1,2,3], true, false, null],"node": Node2D.new(),}var pba: PackedByteArray = pickler.pickle(data)# "unpickled" should be the same as "data"var unpickled = pickler.unpickle(pba)```# Compressing a pickleYou can create smaller pickles by setting `Pickler.serialize_defaults` to `false`,which removes default values from pickled Objects.You can create compressed binary pickles using `Pickler.pickle_compressed()`.# Customizing a pickleYou can also have direct control over which properties are serialized/deserialized by adding`__getnewargs__()`, `__getstate__()` and `__setstate__()` methods to your custom class.Check out README.md in the git repository for more info on how to customize and optimize your pickles.