ScriptedStateSerializer Interface Reference

Inheritance diagram for ScriptedStateSerializer:

Static Public Member Functions
static EScriptedStateDeserializeEvent	GetDeserializeEvent ()
	Select when the deserialization should happen: BEFORE_CONSTRUCTOR: Instance was created but the constructor not yet called.
Static Public Member Functions inherited from PersistenceSerializerBase
static TypeName	GetTargetType ()
	Delcare the type this serializer can handle so it can automatically find matching data instances. MUST be implemented!
static EDeserializeFailHandling	GetDeserializeFailHandling ()
	Optinally override this if a failure in deserialization logic requires the entity/scripted state to be deleted as it would not be useable at all.

Protected Member Functions
proto external ESerializeResult	SerializeNative (notnull Managed instance, notnull BaseSerializationSaveContext context, ENativeSerializerMode mode=ENativeSerializerMode.NATIVE)
	Native serialization logic used by the game. Can be called by scripts before or after custom data or not all.
proto external bool	DeserializeNative (notnull Managed instance, notnull BaseSerializationLoadContext context, ENativeSerializerMode mode=ENativeSerializerMode.NATIVE)
	Native deserialization logic used by the game. Can be called by scripts before or after custom data or not all.
ESerializeResult	Serialize (notnull Managed instance, notnull BaseSerializationSaveContext context)
	Custom implementation for writing the script data into into the save context.
bool	Deserialize (notnull Managed instance, notnull BaseSerializationLoadContext context)
	Custom implementation for deserialzing the script data from the load context.
Protected Member Functions inherited from PersistenceSerializerBase
void	Setup ()
	Do any inital configuration of the serializer once it is linked to the system.

Additional Inherited Members
Public Member Functions inherited from PersistenceSerializerBase
proto external PersistenceSystem	GetSystem ()
	Get persistence system the serializer is linked to.

Member Function Documentation

Deserialize()

bool ScriptedStateSerializer.Deserialize ( notnull Managed instance, notnull BaseSerializationLoadContext context )

protected

Custom implementation for deserialzing the script data from the load context.

Returns

True for success. False for data/state errors which will abort the process and use configured fault handling

Implemented in SCR_EditableEntityCoreSerializer, SCR_GameMasterMetaDataSerializer, SCR_ScenarioFrameworkSystemSerializer, SCR_TaskSystemSerializer, and SCR_VoiceoverSystemSerializer.

DeserializeNative()

proto external bool ScriptedStateSerializer.DeserializeNative ( notnull Managed instance, notnull BaseSerializationLoadContext context, ENativeSerializerMode mode = ENativeSerializerMode.NATIVE )

protected

Native deserialization logic used by the game. Can be called by scripts before or after custom data or not all.

GetDeserializeEvent()

static EScriptedStateDeserializeEvent ScriptedStateSerializer.GetDeserializeEvent ( )

static

Select when the deserialization should happen: BEFORE_CONSTRUCTOR: Instance was created but the constructor not yet called.

So apply logic can not rely on something the constructor manually initalized.s REPLACE_CONSTRUCTOR: The deserialization logic replaces any constructor defined. Allows setting all relevant values without wasting time setting up defaults that will be overridden anyway. AFTER_CONSTRUCTOR: Default "normal" behavior as if custom scripts were manipulating the instance after the "new" call.

Serialize()

ESerializeResult ScriptedStateSerializer.Serialize ( notnull Managed instance, notnull BaseSerializationSaveContext context )

protected

Custom implementation for writing the script data into into the save context.

Returns

True for success. False for data/state errors which will abort the process and use configured fault handling

Implemented in SCR_EditableEntityCoreSerializer, SCR_GameMasterMetaDataSerializer, SCR_ScenarioFrameworkSystemSerializer, SCR_TaskSystemSerializer, and SCR_VoiceoverSystemSerializer.

SerializeNative()

proto external ESerializeResult ScriptedStateSerializer.SerializeNative ( notnull Managed instance, notnull BaseSerializationSaveContext context, ENativeSerializerMode mode = ENativeSerializerMode.NATIVE )

protected

Native serialization logic used by the game. Can be called by scripts before or after custom data or not all.

---

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

• Game/generated/Systems/Persistence/Serializers/ScriptedStateSerializer.c