ScriptedSaveContainer Class Reference

Scripted save container for custom handling of storage. More...

Inheritance diagram for ScriptedSaveContainer:

Protected Member Functions
void	Reset ()
	Reset the container to re-use for new data.
string	GetDataExtension ()
	Data extension of the serialized format (e.g. txt, csv, yml) if stored in a filesystem.
string	SaveToString ()
	Export the data as string to be written to disk etc.
bool	StartObject ()
bool	EndObject ()
bool	StartArray (int count)
bool	EndArray ()
bool	StartMap (int count)
bool	EndMap ()
bool	WriteKey (string key)
	Key writer for named properties in objects or map keys.
bool	WriteNull ()
	Typed value writers.
bool	WriteBool (bool value)
bool	WriteString (string value)
bool	WriteInt (int value)
bool	WriteFloat (float value)
bool	WriteVector (vector value)
void	Reset ()
	Reset the container to re-use for new data.
string	GetDataExtension ()
	Data extension of the serialized format (e.g. txt, csv, yml) if stored in a filesystem.
string	SaveToString ()
	Export the data as string to be written to disk etc.
bool	StartObject ()
bool	EndObject ()
bool	StartArray (int count)
bool	EndArray ()
bool	StartMap (int count)
bool	EndMap ()
bool	WriteKey (string key)
	Key writer for named properties in objects or map keys.
bool	WriteNull ()
	Typed value writers.
bool	WriteBool (bool value)
bool	WriteString (string value)
bool	WriteInt (int value)
bool	WriteFloat (float value)
bool	WriteVector (vector value)

Detailed Description

Scripted save container for custom handling of storage.

Definition at line 13 of file ScriptedSaveContainer.c.

Member Function Documentation

EndArray() [1/2]

bool ScriptedSaveContainer::EndArray ( )

inlineprotected

Definition at line 42 of file ScriptedSaveContainer.c.

EndArray() [2/2]

bool ScriptedSaveContainer::EndArray ( )

inlineprotected

Definition at line 42 of file ScriptedSaveContainer.c.

EndMap() [1/2]

bool ScriptedSaveContainer::EndMap ( )

inlineprotected

Definition at line 49 of file ScriptedSaveContainer.c.

EndMap() [2/2]

bool ScriptedSaveContainer::EndMap ( )

inlineprotected

Definition at line 49 of file ScriptedSaveContainer.c.

EndObject() [1/2]

bool ScriptedSaveContainer::EndObject ( )

inlineprotected

Definition at line 35 of file ScriptedSaveContainer.c.

EndObject() [2/2]

bool ScriptedSaveContainer::EndObject ( )

inlineprotected

Definition at line 35 of file ScriptedSaveContainer.c.

GetDataExtension() [1/2]

string ScriptedSaveContainer::GetDataExtension ( )

inlineprotected

Data extension of the serialized format (e.g. txt, csv, yml) if stored in a filesystem.

Definition at line 18 of file ScriptedSaveContainer.c.

GetDataExtension() [2/2]

string ScriptedSaveContainer::GetDataExtension ( )

inlineprotected

Data extension of the serialized format (e.g. txt, csv, yml) if stored in a filesystem.

Definition at line 18 of file ScriptedSaveContainer.c.

Reset() [1/2]

void ScriptedSaveContainer::Reset ( )

protected

Reset the container to re-use for new data.

Reset() [2/2]

void ScriptedSaveContainer::Reset ( )

protected

Reset the container to re-use for new data.

SaveToString() [1/2]

string ScriptedSaveContainer::SaveToString ( )

inlineprotected

Export the data as string to be written to disk etc.

Definition at line 20 of file ScriptedSaveContainer.c.

SaveToString() [2/2]

string ScriptedSaveContainer::SaveToString ( )

inlineprotected

Export the data as string to be written to disk etc.

Definition at line 20 of file ScriptedSaveContainer.c.

StartArray() [1/2]

bool ScriptedSaveContainer::StartArray ( int count )

inlineprotected

Arrays don't have named values and as such are only a sequence of value writes. Arrays may be nested, in which case StartArray is called while already inside an array. Sets are considered arrays for serialization.

Definition at line 41 of file ScriptedSaveContainer.c.

StartArray() [2/2]

bool ScriptedSaveContainer::StartArray ( int count )

inlineprotected

Arrays don't have named values and as such are only a sequence of value writes. Arrays may be nested, in which case StartArray is called while already inside an array. Sets are considered arrays for serialization.

Definition at line 41 of file ScriptedSaveContainer.c.

StartMap() [1/2]

bool ScriptedSaveContainer::StartMap ( int count )

inlineprotected

Maps are key value pairs which are written similar to objects, as sequence of WriteKey(key) + WriteXXX(value); Keys are converted automatically to strings for serialization for cases such as map<int, float>. The value type of the map is known one the first value write is called.

Definition at line 48 of file ScriptedSaveContainer.c.

StartMap() [2/2]

bool ScriptedSaveContainer::StartMap ( int count )

inlineprotected

Maps are key value pairs which are written similar to objects, as sequence of WriteKey(key) + WriteXXX(value); Keys are converted automatically to strings for serialization for cases such as map<int, float>. The value type of the map is known one the first value write is called.

Definition at line 48 of file ScriptedSaveContainer.c.

StartObject() [1/2]

bool ScriptedSaveContainer::StartObject ( )

inlineprotected

Objects are serialized as sequence of: StartObject() WriteKey("myValue"); WriteInt(42); WriteKey("anotherValue") WriteFloat(13.37); ... EndObject();

There may be sub-objects/arrays/maps. These will be written using a sequence of WriteKey(...) + StartObject/Array/Map(). Each nested object/array/map will be terminated by EndObject/Array/Map();

Definition at line 34 of file ScriptedSaveContainer.c.

StartObject() [2/2]

bool ScriptedSaveContainer::StartObject ( )

inlineprotected

Objects are serialized as sequence of: StartObject() WriteKey("myValue"); WriteInt(42); WriteKey("anotherValue") WriteFloat(13.37); ... EndObject();

There may be sub-objects/arrays/maps. These will be written using a sequence of WriteKey(...) + StartObject/Array/Map(). Each nested object/array/map will be terminated by EndObject/Array/Map();

Definition at line 34 of file ScriptedSaveContainer.c.

WriteBool() [1/2]

bool ScriptedSaveContainer::WriteBool ( bool value )

inlineprotected

Definition at line 54 of file ScriptedSaveContainer.c.

WriteBool() [2/2]

bool ScriptedSaveContainer::WriteBool ( bool value )

inlineprotected

Definition at line 54 of file ScriptedSaveContainer.c.

WriteFloat() [1/2]

bool ScriptedSaveContainer::WriteFloat ( float value )

inlineprotected

Definition at line 57 of file ScriptedSaveContainer.c.

WriteFloat() [2/2]

bool ScriptedSaveContainer::WriteFloat ( float value )

inlineprotected

Definition at line 57 of file ScriptedSaveContainer.c.

WriteInt() [1/2]

bool ScriptedSaveContainer::WriteInt ( int value )

inlineprotected

Definition at line 56 of file ScriptedSaveContainer.c.

WriteInt() [2/2]

bool ScriptedSaveContainer::WriteInt ( int value )

inlineprotected

Definition at line 56 of file ScriptedSaveContainer.c.

WriteKey() [1/2]

bool ScriptedSaveContainer::WriteKey ( string key )

inlineprotected

Key writer for named properties in objects or map keys.

Definition at line 51 of file ScriptedSaveContainer.c.

WriteKey() [2/2]

bool ScriptedSaveContainer::WriteKey ( string key )

inlineprotected

Key writer for named properties in objects or map keys.

Definition at line 51 of file ScriptedSaveContainer.c.

WriteNull() [1/2]

bool ScriptedSaveContainer::WriteNull ( )

inlineprotected

Typed value writers.

Definition at line 53 of file ScriptedSaveContainer.c.

WriteNull() [2/2]

bool ScriptedSaveContainer::WriteNull ( )

inlineprotected

Typed value writers.

Definition at line 53 of file ScriptedSaveContainer.c.

WriteString() [1/2]

bool ScriptedSaveContainer::WriteString ( string value )

inlineprotected

Definition at line 55 of file ScriptedSaveContainer.c.

WriteString() [2/2]

bool ScriptedSaveContainer::WriteString ( string value )

inlineprotected

Definition at line 55 of file ScriptedSaveContainer.c.

WriteVector() [1/2]

bool ScriptedSaveContainer::WriteVector ( vector value )

inlineprotected

Definition at line 58 of file ScriptedSaveContainer.c.

WriteVector() [2/2]

bool ScriptedSaveContainer::WriteVector ( vector value )

inlineprotected

Definition at line 58 of file ScriptedSaveContainer.c.

---

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

• scripts/Game/generated/Plugins/Serialization/ScriptedSaveContainer.c