Base serialization context for saving data from game. More...

Inheritance diagram for BaseSerializationSaveContext:

Public Member Functions
proto bool	Write (void value)
	Write the value under the name of the variable passed.

proto bool	WriteValue (string name, void value)
	Write the value under the specified name.

proto bool	WriteDefault (void value, void defaultValue)
	Write the value only it does not match the provided default value, or the context does not allow seeking (e.g. json=no default, binary=defaults written)

proto bool	WriteValueDefault (string name, void value, void defaultValue)
	s. WriteValue and WriteDefault

proto external bool	WriteMapKey (string key)
	Set the next map key for manual map writing (StartMap).

Public Member Functions inherited from BaseSerializationContext
proto external bool	CanSeekMembers ()

proto external bool	IsValid ()

proto external string	GetDataExtension ()

proto external void	ConfigureTypeDiscriminator (string fieldName="$type")
	Type discriminator is used to add polymorph object instance support to the serializer.

proto external bool	EnableTypeDiscriminator (bool enabled)
	Enable or disable, can be used to pause it for a specific variable and resume after it was written.

proto external bool	IsTypeDiscriminatorEnabled ()
	Is the type discrimiation currently enabled.

proto external void	Reset ()
	Reset buffers to re-use for new data.

proto bool	StartMap (string name, out int count)
	Start new map. Empty name will result in an anonymous map. Count must be known ahead of time.

proto external bool	EndMap ()

proto bool	StartArray (string name, out int count)
	Start new array. Empty name will result in an anonymous array. Count must be known ahead of time.

proto external bool	EndArray ()

proto external bool	StartObject (string name=string.Empty)
	Start new subobject. Empty name will result in an anonymous object.

proto external bool	EndObject ()

Public Member Functions inherited from Managed
proto external ref Managed	Clone ()
	Return shallow copy of object, or null if it is not allowed (not public constructor)

Detailed Description

Base serialization context for saving data from game.

It works as an adapter between the game logic and serialized data.

Member Function Documentation

◆ Write()

proto bool BaseSerializationSaveContext.Write ( void value )

Write the value under the name of the variable passed.

◆ WriteDefault()

proto bool BaseSerializationSaveContext.WriteDefault	(	void	value,
		void	defaultValue )

Write the value only it does not match the provided default value, or the context does not allow seeking (e.g. json=no default, binary=defaults written)

◆ WriteMapKey()

proto external bool BaseSerializationSaveContext.WriteMapKey ( string key )

Set the next map key for manual map writing (StartMap).

NOTE: Only to be used if the value is complex (object, array, nested map). For primitive types use WriteValue("key", "value") for each entry instead.

◆ WriteValue()

proto bool BaseSerializationSaveContext.WriteValue	(	string	name,
		void	value )

Write the value under the specified name.

◆ WriteValueDefault()

proto bool BaseSerializationSaveContext.WriteValueDefault	(	string	name,
		void	value,
		void	defaultValue )

s. WriteValue and WriteDefault

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

GameLib/generated/Serialization/BaseSerializationSaveContext.c