Enfusion Script API
Loading...
Searching...
No Matches
Public Member Functions | List of all members
ContainerSerializationLoadContext Interface Reference

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

Inheritance diagram for ContainerSerializationLoadContext:
[legend]

Public Member Functions

void ContainerSerializationLoadContext (bool skipEmptyObjects=true)
 skipEmptyObjects : This feature is for loading data where only objects with some data are present and empty objects are skipped.
 
proto external BaseSerializationLoadContainer GetContainer ()
 Returns the assigned container.
 
proto external void SetContainer (BaseSerializationLoadContainer container)
 Set the new assigned container.
 
- Public Member Functions inherited from BaseSerializationLoadContext
proto bool ReadValue (string name, out void value)
 
- Public Member Functions inherited from BaseSerializationContext
proto external bool IsValid ()
 
proto external void EnableTypeDiscriminator (string fieldName="$type")
 Type discriminator is used to add polymorph object instance support to the serializer.
 
proto external bool IsTypeDiscriminatorEnabled ()
 
proto external bool StartObject (string name)
 
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

◆ ContainerSerializationLoadContext()

void ContainerSerializationLoadContext.ContainerSerializationLoadContext ( bool  skipEmptyObjects = true)

skipEmptyObjects : This feature is for loading data where only objects with some data are present and empty objects are skipped.

If this feature is enabled, the context won't fail on StartObject method if it's not present in the data. Only when caller attempts to read key from this missing object it ends with error.

Member Function Documentation

◆ GetContainer()

proto external BaseSerializationLoadContainer ContainerSerializationLoadContext.GetContainer ( )

Returns the assigned container.

◆ SetContainer()

proto external void ContainerSerializationLoadContext.SetContainer ( BaseSerializationLoadContainer  container)

Set the new assigned container.

Parameters
containerThe new container.

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