Enfusion Script API
Loading...
Searching...
No Matches
ContainerSerializationSaveContext Interface Reference

Base serialization context for saving data to BaseSerializationSaveContainer based class. More...

Inheritance diagram for ContainerSerializationSaveContext:
BaseSerializationSaveContext BaseSerializationContext ScriptAndConfig Managed

Public Member Functions

void ContainerSerializationSaveContext (bool skipEmptyObjects=true)
 skipEmptyObjects : This feature is for writing only sub-objects to container which have some data and not creating hierarchy of empty sub-objects.
 
proto external BaseSerializationSaveContainer GetContainer ()
 Returns the assigned container.
 
proto external void SetContainer (BaseSerializationSaveContainer container)
 Set the new assigned container.
 
- Public Member Functions inherited from BaseSerializationSaveContext
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 to BaseSerializationSaveContainer based class.

This context passes given data to set container class.

Constructor & Destructor Documentation

◆ ContainerSerializationSaveContext()

void ContainerSerializationSaveContext.ContainerSerializationSaveContext ( bool skipEmptyObjects = true)

skipEmptyObjects : This feature is for writing only sub-objects to container which have some data and not creating hierarchy of empty sub-objects.

Member Function Documentation

◆ GetContainer()

proto external BaseSerializationSaveContainer ContainerSerializationSaveContext.GetContainer ( )

Returns the assigned container.

◆ SetContainer()

proto external void ContainerSerializationSaveContext.SetContainer ( BaseSerializationSaveContainer container)

Set the new assigned container.

Parameters
containerThe new container.

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