‪TechbloxModdingAPI  ‪v2.2.0
‪The unofficial Techblox modding API
TechbloxModdingAPI.Persistence.SimpleEntitySerializer< Descriptor > Class Template Reference

‪Simple entity serializer sufficient for simple entity components. More...

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

Public Member Functions

 SimpleEntitySerializer (GetEntitiesToSerialize getEntitiesToSerialize)
 ‪Construct the entity serializer. More...
 
EntityInitializer BuildDeserializedEntity (EGID egid, ISerializationData serializationData, ISerializableEntityDescriptor entityDescriptor, int serializationType, IEntitySerialization entitySerialization, IEntityFactory factory, bool enginesRootIsDeserializationOnly)
 
bool Deserialize (ref ISerializationData serializationData, IEntitySerialization entitySerializer)
 ‪Deserialize the entities. More...
 
delegate EGID[] GetEntitiesToSerialize (EntitiesDB entitiesDB)
 ‪Delegate function called when the serializer needs to know what entities to serialize. More...
 
void Ready ()
 
bool Serialize (ref ISerializationData serializationData, EntitiesDB entitiesDB, IEntitySerialization entitySerializer)
 ‪Serialize the entities. More...
 

Protected Attributes

int serializationType
 

Properties

EntitiesDB entitiesDB [protected get, set]
 

Detailed Description

Simple entity serializer sufficient for simple entity components.

Type Constraints
Descriptor :ISerializableEntityDescriptor 
Descriptor :new() 

Constructor & Destructor Documentation

◆ SimpleEntitySerializer()

‪Construct the entity serializer.

Parameters
getEntitiesToSerialize‪Provider of entity IDs to serialize.

Member Function Documentation

◆ BuildDeserializedEntity()

EntityInitializer TechbloxModdingAPI.Persistence.SimpleEntitySerializer< Descriptor >.BuildDeserializedEntity ( EGID  egid,
ISerializationData  serializationData,
ISerializableEntityDescriptor  entityDescriptor,
int  serializationType,
IEntitySerialization  entitySerialization,
IEntityFactory  factory,
bool  enginesRootIsDeserializationOnly 
)
inline

◆ Deserialize()

bool TechbloxModdingAPI.Persistence.SimpleEntitySerializer< Descriptor >.Deserialize ( ref ISerializationData  serializationData,
IEntitySerialization  entitySerializer 
)
inline

‪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.

Implements TechbloxModdingAPI.Persistence.IEntitySerializer.

◆ GetEntitiesToSerialize()

delegate EGID [] TechbloxModdingAPI.Persistence.SimpleEntitySerializer< Descriptor >.GetEntitiesToSerialize ( EntitiesDB  entitiesDB)

‪Delegate function called when the serializer needs to know what entities to serialize.

◆ Ready()

void TechbloxModdingAPI.Persistence.SimpleEntitySerializer< Descriptor >.Ready ( )
inline

◆ Serialize()

bool TechbloxModdingAPI.Persistence.SimpleEntitySerializer< Descriptor >.Serialize ( ref ISerializationData  serializationData,
EntitiesDB  entitiesDB,
IEntitySerialization  entitySerializer 
)
inline

‪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.

Implements TechbloxModdingAPI.Persistence.IEntitySerializer.

Member Data Documentation

◆ serializationType

int TechbloxModdingAPI.Persistence.SimpleEntitySerializer< Descriptor >.serializationType
protected

Property Documentation

◆ entitiesDB

EntitiesDB TechbloxModdingAPI.Persistence.SimpleEntitySerializer< Descriptor >.entitiesDB
protected getset

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