Class BeamableSerializer

This serializer uses a combination of Beamable Cloud Storage and Inventory to save content state. Some content needs to be saved to the Cloud Storage because it is not IdleKit "Content" but rather classes that need to store state. IUserSavedData and SerializedDataCache are examples of these. EventSettingsSavedData can't use Inventory because its asset doesn't extend IKItemContent<TInterface, TConcrete>

Inheritance

Object

BeamableSerializer

Implements

ISerializer

IInjectable

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Object.ReferenceEquals(Object, Object)

Namespace: IdleKit.Gameplay

Assembly: cs.temp.dll.dll

Syntax

public class BeamableSerializer : ISerializer, IInjectable

Fields

_actionService

Declaration

protected IActionService _actionService

Field Value

Type	Description
IActionService

_beamable

Declaration

protected Beamable _beamable

Field Value

Type	Description
Beamable

_dirtyData

Declaration

protected readonly IDictionary<string, ISavedData> _dirtyData

Field Value

Type	Description
IDictionary<String, ISavedData>

_inventoryUpdateBuilder

Declaration

protected InventoryUpdateBuilder _inventoryUpdateBuilder

Field Value

Type	Description
InventoryUpdateBuilder

_path

Declaration

protected string _path

Field Value

Type	Description
String

_resolver

Declaration

protected IResolver _resolver

Field Value

Type	Description
IResolver

Properties

DirtyData

Declaration

public virtual ISavedData[] DirtyData { get; }

Property Value

Type	Description
ISavedData[]

HasDirtyData

Declaration

public virtual bool HasDirtyData { get; }

Property Value

Type	Description
Boolean

Methods

Delete<TSavedData>(String, TSavedData)

Declaration

public virtual void Delete<TSavedData>(string savedId, TSavedData savedData)
    where TSavedData : ISavedData

Parameters

Type	Name	Description
String	savedId
TSavedData	savedData

Type Parameters

Name	Description
TSavedData

DeleteAll()

Declaration

public virtual void DeleteAll()

Deserialize<TSavedData>(String, ref TSavedData)

Declaration

public virtual bool Deserialize<TSavedData>(string savedId, ref TSavedData savedData)
    where TSavedData : ISavedData

Parameters

Type	Name	Description
String	savedId
TSavedData	savedData

Returns

Type	Description
Boolean

Type Parameters

Name	Description
TSavedData

GetBeamableContentId(String)

Declaration

protected virtual string GetBeamableContentId(string savedId)

Parameters

Type	Name	Description
String	savedId

Returns

Type	Description
String

GetItemView(String)

Declaration

protected virtual ItemView GetItemView(string contentId)

Parameters

Type	Name	Description
String	contentId

Returns

Type	Description
ItemView

GetSaveFilePath(String)

Declaration

protected virtual string GetSaveFilePath(string savedId)

Parameters

Type	Name	Description
String	savedId

Returns

Type	Description
String

Initialize()

Declaration

public virtual void Initialize()

Inject(IResolver)

Declaration

public virtual void Inject(IResolver resolver)

Parameters

Type	Name	Description
IResolver	resolver

IsStoredInCloud<TSavedData>(TSavedData)

Declaration

protected virtual bool IsStoredInCloud<TSavedData>(TSavedData savedData)
    where TSavedData : ISavedData

Parameters

Type	Name	Description
TSavedData	savedData

Returns

Type	Description
Boolean

Type Parameters

Name	Description
TSavedData

IsStoredInInventory<TSavedData>(TSavedData)

Declaration

protected virtual bool IsStoredInInventory<TSavedData>(TSavedData savedData)
    where TSavedData : ISavedData

Parameters

Type	Name	Description
TSavedData	savedData

Returns

Type	Description
Boolean

Type Parameters

Name	Description
TSavedData

MarkDirty<TSavedData>(String, TSavedData)

Declaration

public virtual void MarkDirty<TSavedData>(string savedId, TSavedData objectToSerialize)
    where TSavedData : ISavedData

Parameters

Type	Name	Description
String	savedId
TSavedData	objectToSerialize

Type Parameters

Name	Description
TSavedData

Serialize<TSavedData>(String, TSavedData)

Declaration

public virtual void Serialize<TSavedData>(string savedId, TSavedData objectToSerialize)
    where TSavedData : ISavedData

Parameters

Type	Name	Description
String	savedId
TSavedData	objectToSerialize

Type Parameters

Name	Description
TSavedData

SerializeDirty(Action)

Declaration

public virtual void SerializeDirty(Action onCompleteCallback = null)

Parameters

Type	Name	Description
Action	onCompleteCallback

UpdateInventoryAsync(Action)

Declaration

protected virtual Task UpdateInventoryAsync(Action onCompleteCallback)

Parameters

Type	Name	Description
Action	onCompleteCallback

Returns

Type	Description
Task

Implements

ISerializer

IInjectable