Interface ISaveSlotInformationProvider

Namespace

Squiggles.Core.Meta

Assembly

SquigglesCommon4X.dll

An interface for providing meaningful information for a given save slot. All paths are considered absolute. Implement this to allow loading custom information for your game's save slots.

public interface ISaveSlotInformationProvider

Methods

GetSaveSlotName(string)

Gets the main (first) name for the save slot at the given path. Every save slot is a directory with a parse-able date that is was created. This name will be first on the button to load said slot. Ideally loaded from some kind of metadata file SaveData.ParseSaveSlotName

string GetSaveSlotName(string absolutePath)

Parameters

absolutePath string

The absolute path (starting with "C://" or "/home/" leading to the directory of the given save slot

Returns

string

A string that is the primary name for this save slot.

GetSaveSlotSubtitle(string)

Gets the secondary title (or subtitle) of the save slot for the given path. This may return "" if no subtitles are desired. Ideally this should provide some extra metadata such as what level the player has reached, or possibly some key items they have acquired at this point.

string GetSaveSlotSubtitle(string absolutePath)

Parameters

absolutePath string

The absolute path (starting with "C://" or "/home/" leading to the directory of the given save slot

Returns

string

A string that is the secondary name for this save slot.