Class Migration<T>
A generic migration represents an action or set of actions that need to be done to an object of type T
to update it to the game's current version.
Migrations are available for a multitude of object types that inhabit a Map, ExportedHousehold or ExportedLot by default.
Note that migrations do not have to be registered using Register<T>(IEnumerable<Migration<T>>) when added to a preexisting collection like Migrations or Migrations, but only when a mod adds a custom set of migrations for a custom object type.
public class Migration<T> : Migration
Type Parameters
T
- Inheritance
-
Migration<T>
- Inherited Members
- Extension Methods
Constructors
Migration(string, MigrationPhase, Action<T>)
Creates a new migration with the given settings.
public Migration(string name, MigrationPhase phase, Action<T> apply)
Parameters
name
stringThe name of this migration, which is stored in the save file or exported content once this migration has been applied if Silent is false.
phase
MigrationPhaseThe MigrationPhase that this migration should be applied on. Note that some object types only support the Single phase.
apply
Action<T>A function that applies this migration on an object. When using this constructor, Success is always returned in this migration's Apply function.
Migration(string, MigrationPhase, Func<T, MigrationResult>)
Creates a new migration with the given settings.
public Migration(string name, MigrationPhase phase, Func<T, MigrationResult> apply)
Parameters
name
stringThe name of this migration, which is stored in the save file or exported content once this migration has been applied if Silent is false.
phase
MigrationPhaseThe MigrationPhase that this migration should be applied on. Note that some object types only support the Single phase.
apply
Func<T, MigrationResult>A function that applies this migration on an object.
Migration(string, MigrationPhase, ApplyDelegate)
Creates a new migration with the given settings.
public Migration(string name, MigrationPhase phase, Migration.ApplyDelegate apply)
Parameters
name
stringThe name of this migration, which is stored in the save file or exported content once this migration has been applied if Silent is false.
phase
MigrationPhaseThe MigrationPhase that this migration should be applied on. Note that some object types only support the Single phase.
apply
Migration.ApplyDelegateA function that applies this migration on an object.