Class ItemChangerMod

Inheritance

object

ItemChangerMod

Implements

ILocalSettings<SaveSettings>

IGlobalSettings<GlobalSettings>

ICustomMenuMod

IMod

ILogger

Namespace: ItemChanger

Assembly: ItemChanger.dll

Syntax

public class ItemChangerMod : Mod, ILocalSettings<SaveSettings>, IGlobalSettings<GlobalSettings>, ICustomMenuMod, IMod, ILogger

Constructors

ItemChangerMod()

Declaration

public ItemChangerMod()

Properties

Modules

Declaration

public static ModuleCollection Modules { get; }

Property Value

Type	Description
ModuleCollection

Methods

AddDeployer(IDeployer)

Add an event to instantiate an object at a given place to Settings. Primarily used for adding platforms, and similar preloaded objects.

Declaration

public static void AddDeployer(IDeployer deployer)

Parameters

Type	Name	Description
IDeployer	deployer

AddPlacements(IEnumerable<AbstractPlacement>, PlacementConflictResolution)

Adds placements to local settings, with handling for placements with the same name.

Declaration

public static void AddPlacements(IEnumerable<AbstractPlacement> placements, PlacementConflictResolution conflictResolution = PlacementConflictResolution.MergeKeepingNew)

Parameters

Type	Name	Description
IEnumerable<AbstractPlacement>	placements	The placements to add to the local settings.
PlacementConflictResolution	conflictResolution	The action if a placement already exists in settings with the same name.

AddTransitionOverride(Transition, ITransition)

Adds the override to SaveSettings. Overwrites any existing override for source.

Declaration

public static void AddTransitionOverride(Transition source, ITransition target)

Parameters

Type	Name	Description
Transition	source
ITransition	target

ChangeStartGame(StartDef)

Declaration

public static void ChangeStartGame(StartDef start)

Parameters

Type	Name	Description
StartDef	start

CreateSettingsProfile(Settings)

Create a settings profile from an existing Settings object (e.g. settings loaded from an external serialized source).

Declaration

public static void CreateSettingsProfile(Settings settings)

Parameters

Type	Name	Description
Settings	settings	The Settings object to save to local settings.

Exceptions

Type	Condition
InvalidOperationException	Settings have already been loaded.

CreateSettingsProfile(bool)

Create default ItemChanger settings for the save. Required before all operations which modify settings data.

Declaration

public static void CreateSettingsProfile(bool overwrite = true)

Parameters

Type	Name	Description
bool	overwrite	If settings data already exists, should it be overwritten?

Exceptions

Type	Condition
InvalidOperationException	Settings have already been loaded.

CreateSettingsProfile(bool, bool)

Create default ItemChanger settings for the save, with an option for whether default modules should be automatically added. Required before all operations which modify settings data.

Declaration

public static void CreateSettingsProfile(bool overwrite, bool createDefaultModules)

Parameters

Type	Name	Description
bool	overwrite	If settings data already exists, should it be overwritten?
bool	createDefaultModules	If a new profile is created, should it include all default modules?

Exceptions

Type	Condition
InvalidOperationException	Settings have already been loaded.

GetPreloadNames()

Declaration

public override List<(string, string)> GetPreloadNames()

Returns

Type	Description
List<(string, string)>

GetVersion()

Declaration

public override string GetVersion()

Returns

Type	Description
string

Initialize(Dictionary<string, Dictionary<string, GameObject>>)

Declaration

public override void Initialize(Dictionary<string, Dictionary<string, GameObject>> preloadedObjects)

Parameters

Type	Name	Description
Dictionary<string, Dictionary<string, GameObject>>	preloadedObjects

LoadPriority()

Declaration

public override int LoadPriority()

Returns

Type	Description
int

Implements

Modding.ILocalSettings<>

Modding.IGlobalSettings<>

Modding.ICustomMenuMod

Modding.IMod

Modding.ILogger

Extension Methods

Extensions.Yield<T>(T)