T_MSCLoader_Mod
piotrulos edited this page Apr 7, 2023
·
4 revisions
The base mod class, all mods should have this class.
System.Object
MSCLoader.Mod
MSCLoader.ModConsole
Namespace: MSCLoader
Assembly: MSCLoader (in MSCLoader.dll) Version: 1.2.11.286
C#
public abstract class Mod
View Source
The Mod type exposes the following members.
Name | Description | |
---|---|---|
Mod | pro BS |
Name | Description | |
---|---|---|
Author | Author of the mod (Enter your nickname in this variable) | |
Description | Short Description of your mod | |
Icon | Mod Icon from Resources or Embedded Resources. | |
ID | The ID for your mod (This should be unique). | |
isDisabled | true if mod is disabled | |
LoadInMenu | Load this mod in Main Menu. | |
Name | The name of mod that will be displayed in settings. (if not set, will be same as ID) | |
SecondPass | Enable SecondPassOnLoad() that will execute after all mods have been loaded. | |
UseAssetsFolder | Set this to true if you want load custom files from Assets folder (This will create a subfolder for your mod) | |
Version | The current version of the mod. (prefered standard version format: 2, 3 or 4 digits) |
Name | Description | |
---|---|---|
FixedUpdate | Called once every fixed frame (standard unity FixedUpdate()). | |
ModSettings | All settings should be created here. | |
ModSettingsLoaded | Called after saved settings habe been loaded from file. | |
ModSetup | Setup your mod. | |
OnGUI | Standard unity OnGUI(). | |
OnLoad | Called once, after GAME scene is fully loaded. | |
OnMenuLoad | Called once in main menu (only when LoadInMenu is true). | |
OnModDisabled | Called once when mod has been disabled in settings | |
OnModEnabled | Called once when mod has been enabled in settings | |
OnNewGame | Called once after starting "New Game" You can reset/delete your saves here | |
OnSave | Called once, when save and quit. | |
PreLoad | Called once as soon as GAME scene is loaded. | |
SecondPassOnLoad | Called once, after ALL mods has finished OnLoad() and when SecondPass is set to true (Executed still before first pass of Update(), but NOT exectued if OnLoad() failed with error) | |
SetupFunction | Setup selected function for your mod | |
Update | Called once every frame (standard unity Update()). |
- How to install MSCLoader using MSCPatcher
- MSCPatcher explained
- How to install mods
- Official experimental linux support
- Unofficial tutorial for linux (wine/proton)
- Install Visual Studio for MSCLoader
- Install template for Visual Studio
- How to use templates
- Debugging your mods in Visual Studio
- Enable DevMode to help with debugging
- Uploading and creating Self update feature for your mod or reference
- All Playmaker Global Variables and Events
- How to create and use Asset Bundles