MSCLoader API - piotrulos/MSCModLoader GitHub Wiki

MSCLoader Namespace

Important

My Winter Car version is stripped from all legacy code that was marked as "obsolete" as of MSCLoader version 1.3.6 for better performance. (This change doesn't affect My Summer Car version)

Important

In ModSetup() only SetupFunction() is allowed, this is designed to only setup Mod class. Do not execute other code inside ModSetup(), follow strictly Order of execution in mod class otherwise you will break other mods or even loader itself (DO NOT guess how stuff work, read documentation and ask questions if you don't know the answer)

Classes

Warning

DO NOT! use harmony to patch playmaker actions, since this breaks entire state machine. Please learn and use PlayMakerExtensions instead!

 

Class Description Examples
Public class ConsoleCommand Base class for console commands  
Public class ExceptionExtensions Exception extensions  
Public class Keybind Add easily rebindable keybinds.  
Public class KeybindHeader Keybind Header  
Public class LoadAssets Class for Loading custom assets from Assets folder LoadAssets methods
Public class Mod The base mod class, all mods should have this class. Mod class structure
Public class ModAudio Audio library (play local *.mp3, *.ogg, *.wav, *.aiff, *.flac)  
Public class ModAudioStream Audio library (Play online mp3 streams)  
Public class ModConsole MSCLoader console related functions.  
Public class ModKeybind Mod Setting base class  
Public class ModLoader This is main Mod Loader class.  
Public class ModSetting Mod Setting base class  
Public class ModUI UI elements like creating Message Boxes  
Public class ModUIDrag Make Unity.UI element draggable, attachable to UI gameobject  
Public class MSCExtensions My Summer Car specific extensions  
Public class MsgBoxBtn MsgBoxBtn class  
Public class OBJLoader OBJLoader (obsoloete)  
Public class Playlists Parse playlists files  
Public class PlayMakerExtensions PlayMaker extensions for Unity API  
Public class PlayMakerProxyExtensions Extension methods for PlayMakerArrayListProxy and PlayMakerHashTableProxy  
Public class PopupSetting Popup Setting Window  
Public class SaveLoad Save and Load Class for gameobject and custom class Unified SaveLoad methods
Public class Settings Add simple settings for mods. Create Mod Settings
Public class SettingsButton Settings Button  
Public class SettingsCheckBox Settings checkbox Settings Checkbox
Public class SettingsCheckBoxGroup CheckBox group (aka radio button)  
Public class SettingsColorPicker Settings Color Picker Settings ColorPicker
Public class SettingsDropDownList Settings DropDown List Settings DropDownList 
Public class SettingsGroupLayout Settings Horizontal/Vertical Group  
Public class SettingsHeader Settings Header  
Public class SettingsKeybind Keybind  
Public class SettingsResetButton Settings Reset Button  
Public class SettingsSlider Settings Slider Settings Slider
Public class SettingsSliderInt Integer version of Settings Slider Settings Slider
Public class SettingsText Settings Text  
Public class SettingsTextArea Settings TextArea  
Public class SettingsTextBox Settings TextBox Settings TextBox
Public class UnifiedRaycast Unified Raycast, use this to get interaction raycast results  
 

Enumerations

 

Enumeration Description
Public enumeration CurrentScene List of possible scenes
Public enumeration Game List of supported games
Public enumeration Mod.Setup Type of Function to setup
Public enumeration SettingsButton.ButtonIcon Predefined button icons
 
⚠️ **GitHub.com Fallback** ⚠️