‪TechbloxModdingAPI  ‪v2.2.0
‪The unofficial Techblox modding API
TechbloxModdingAPI.Persistence.IEntitySerializer Interface Reference

‪Entity serializer and deserializer interface for storing and retrieving data in a Techblox save file (GameSave.GC). More...

Inheritance diagram for TechbloxModdingAPI.Persistence.IEntitySerializer:
TechbloxModdingAPI.Persistence.SimpleEntitySerializer< Descriptor >

Public Member Functions

bool Deserialize (ref ISerializationData serializationData, IEntitySerialization entitySerializer)
 ‪Deserialize the entities. More...
 
bool Serialize (ref ISerializationData serializationData, EntitiesDB entitiesDB, IEntitySerialization entitySerializer)
 ‪Serialize the entities. More...
 

Detailed Description

Entity serializer and deserializer interface for storing and retrieving data in a Techblox save file (GameSave.GC).

Member Function Documentation

◆ Deserialize()

bool TechbloxModdingAPI.Persistence.IEntitySerializer.Deserialize ( ref ISerializationData  serializationData,
IEntitySerialization  entitySerializer 
)

‪Deserialize the entities.

Returns
‪Whether deserialization was successful.
Parameters
serializationData‪Serialized data to read from (read from GameSave.GC).
entitySerializer‪Entity serializer with support for single-entity deserialization.

Implemented in TechbloxModdingAPI.Persistence.SimpleEntitySerializer< Descriptor >.

◆ Serialize()

bool TechbloxModdingAPI.Persistence.IEntitySerializer.Serialize ( ref ISerializationData  serializationData,
EntitiesDB  entitiesDB,
IEntitySerialization  entitySerializer 
)

‪Serialize the entities.

Returns
‪Whether serialization was successful.
Parameters
serializationData‪Serialized data to write to (writes to GameSave.GC).
entitiesDB‪Entities db for the game.
entitySerializer‪Entity serializer with support for single-entity serialization.

Implemented in TechbloxModdingAPI.Persistence.SimpleEntitySerializer< Descriptor >.


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