Container for saving data in binary format. More...

Inheritance diagram for BinarySaveContainer:

Public Member Functions
proto external void	ConfigureCompression (bool enabled)
	Enable bitstuffing and value compression for data size reduction.

proto external void	ConfigureNameValidation (bool enabled)

proto external void	ConfigureObjectSeeking (bool enabled)
	When enabled it adds meta data to allow StartObject("name") calls to seek to their starting position, making it possible to ignore prior properties or to exit the sub object and re-seek to its start for a retry.

proto external void	ConfigureSkippableObjects (bool enabled)
	Adds neccessary meta data while writing objects so on load invalid/incomplete object reads can be skipped, while still making reads of the remaining binary stream possible.

proto external ref BinaryDataContainer	SaveToContainer ()

proto external bool	SaveToFile (string fileName)

Detailed Description

Container for saving data in binary format.

Member Function Documentation

◆ ConfigureCompression()

proto external void BinarySaveContainer.ConfigureCompression ( bool enabled )

Enable bitstuffing and value compression for data size reduction.

Leave disable when attempting to debug the data. Enabled by default. Disabled by default in developer builds

◆ ConfigureNameValidation()

proto external void BinarySaveContainer.ConfigureNameValidation ( bool enabled )

DEVELOPER BUILDS ONLY < Write each named variables name into the data stream to allow validation of correct read order. Enabled by default in developer builds. Parameter will do nothing in other builds.

◆ ConfigureObjectSeeking()

proto external void BinarySaveContainer.ConfigureObjectSeeking ( bool enabled )

When enabled it adds meta data to allow StartObject("name") calls to seek to their starting position, making it possible to ignore prior properties or to exit the sub object and re-seek to its start for a retry.

◆ ConfigureSkippableObjects()

proto external void BinarySaveContainer.ConfigureSkippableObjects ( bool enabled )

Adds neccessary meta data while writing objects so on load invalid/incomplete object reads can be skipped, while still making reads of the remaining binary stream possible.

Can be disabled to decrease data size if successful read is guranteed, or loss of the data stream is an acceptable use-case.

◆ SaveToContainer()

proto external ref BinaryDataContainer BinarySaveContainer.SaveToContainer ( )

◆ SaveToFile()

proto external bool BinarySaveContainer.SaveToFile ( string fileName )

The documentation for this interface was generated from the following file:

Game/generated/Plugins/Serialization/BinarySaveContainer.c

Public Member Functions