Interface ISaveProfile

A save profile represents one, or a collection of individual save games that canonically represent the lineage of a single save instance for one type of save. It may or may not manage a history of save instances, but must be able to produce one canonical "head" save for a profile regardless of how history is implemented or managed.

Namespace: Snowflake.Orchestration.Saving

Assembly: Snowflake.Framework.Primitives.dll

Syntax

public interface ISaveProfile

Properties

Guid

A unique ID used to identify this save profile

Declaration

Guid Guid { get; }

Property Value

Type	Description
System.Guid

ManagementStrategy

The strategy this profile uses to persist saves.

Declaration

SaveManagementStrategy ManagementStrategy { get; }

Property Value

Type	Description
SaveManagementStrategy

ProfileName

The name of this profile.

Declaration

string ProfileName { get; }

Property Value

Type	Description
System.String

SaveType

A unique name for the format of the save this save profile produces. Two profiles with the same save type have the identical file and folder structure for a save.

Declaration

string SaveType { get; }

Property Value

Type	Description
System.String

Methods

ClearHistory()

Clears the history, leaving only the head.

Declaration

void ClearHistory()

CreateSave(IIndelibleDirectory)

Creates a new immutable save game. This function should be atomic, and if creating the save fails should not add a save. The new savegame becomes the "head" save.

Declaration

Task<ISaveGame> CreateSave(IIndelibleDirectory saveContents)

Parameters

Type	Name	Description
IIndelibleDirectory	saveContents	The directory of save contents to process in accordance with the SaveManagementStrategy. For single-file saves in particular, it is important that the save file produced by the emulator is renamed to "savecontent" to ensure compatibility between emulators that use the same save type. If for some reason this is not desireable, do not use a generic save type such as "sram". If implementing save-sharing, it is very important to ensure conventions remain identical across all orchestration plugins that implement the same save type.

Returns

Type	Description
System.Threading.Tasks.Task<ISaveGame>	A new ISaveGame instance.

CreateSave(ISaveGame)

Declaration

Task<ISaveGame> CreateSave(ISaveGame saveGame)

Parameters

Type	Name	Description
ISaveGame	saveGame

Returns

Type	Description
System.Threading.Tasks.Task<ISaveGame>

GetHeadSave()

Gets the "head" save of this profile.

Declaration

ISaveGame GetHeadSave()

Returns

Type	Description
ISaveGame	The most recently created savegame, or null if none were created.

GetHistory()

If supported, returns the saves that make up the history of this profile.

This is only supported for Copy and Diff, for all other strategies, this will only return an enumerable of the head save.

Declaration

IEnumerable<ISaveGame> GetHistory()

Returns

Type	Description
System.Collections.Generic.IEnumerable<ISaveGame>	All saves registered under this ISaveProfile