SavedData

namespace Griff.Scenes;

public sealed class SavedData

A component’s saved values as an UpgradeFromAttribute step sees them, before they’re read into the component. Properties are named as they are in code (“MoveSpeed”); values are the same types the component’s properties have (numbers, text, vectors, colors, enums, lists of lines).

Properties

Fields

public SavedData? Fields { get; }

In a saved game (as an ISaveUpgrader sees it), a script’s own fields: its private fields and the rest a saved game keeps besides its properties, or what it saves itself (ISavesState), to read and change by name as properties are (“_wave” for a field called _wave, “Day” for an auto property’s). Null if none were saved. A field holding an object or a list points to it in the save’s objects (see Objects).

Json

public JsonObject Json { get; }

The raw JSON, for changes the other methods don’t cover. Keys are camelCase (“moveSpeed”).

Methods

Get

public T? Get<T>(string property, T? fallback = null)

The saved value of property, or fallback if there’s none or it isn’t a T.

Has

public bool Has(string property)

True if a value was saved for property.

Remove

public void Remove(string property)

Forgets the value of property.

Rename

public void Rename(string from, string to)

Moves the value of from to to (nothing happens if there’s none).

Set

public void Set<T>(string property, T? value)

Saves value as property, replacing what was there.