Class ItemChangerMod

Inheritance
System.Object
ItemChangerMod
Implements
ILocalSettings<SaveSettings>
IGlobalSettings<GlobalSettings>
ICustomMenuMod
Namespace: ItemChanger
Assembly: ItemChanger.dll
Syntax
public class ItemChangerMod : Mod

Constructors

| Improve this Doc View Source

ItemChangerMod()

Declaration
public ItemChangerMod()

Properties

| Improve this Doc View Source

Modules

Declaration
public static ModuleCollection Modules { get; }
Property Value
Type Description
ModuleCollection

Methods

| Improve this Doc View Source

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
| Improve this Doc View Source

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.
| Improve this Doc View Source

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
| Improve this Doc View Source

ChangeStartGame(StartDef)

Declaration
public static void ChangeStartGame(StartDef start)
Parameters
Type Name Description
StartDef start
| Improve this Doc View Source

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.
| Improve this Doc View Source

CreateSettingsProfile(Boolean)

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
System.Boolean overwrite

If settings data already exists, should it be overwritten?
| Improve this Doc View Source

CreateSettingsProfile(Boolean, Boolean)

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
System.Boolean overwrite

If settings data already exists, should it be overwritten?
System.Boolean createDefaultModules

If a new profile is created, should it include all default modules?
| Improve this Doc View Source

GetPreloadNames()

Declaration
public override List<(string, string)> GetPreloadNames()
Returns
Type Description
List<System.ValueTuple<System.String, System.String>>
| Improve this Doc View Source

GetVersion()

Declaration
public override string GetVersion()
Returns
Type Description
System.String
| Improve this Doc View Source

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

Declaration
public override void Initialize(Dictionary<string, Dictionary<string, GameObject>> preloadedObjects)
Parameters
Type Name Description
Dictionary<System.String, Dictionary<System.String, GameObject>> preloadedObjects
| Improve this Doc View Source

LoadPriority()

Declaration
public override int LoadPriority()
Returns
Type Description
System.Int32

Implements

ILocalSettings<>
IGlobalSettings<>
ICustomMenuMod

Extension Methods