T_MSCLoader_Settings

Settings Class

Add simple settings for mods.

Inheritance Hierarchy

System.Object
  MSCLoader.Settings
Namespace: MSCLoader
Assembly: MSCLoader (in MSCLoader.dll) Version: 1.2.11.286

Syntax

C#

public class Settings

View Source
The Settings type exposes the following members.

Constructors

 

	Name	Description
	Settings(String, String, Action)	Constructor for Settings
	Settings(String, String, Object)	Constructor for Settings
	Settings(String, String, Object, Action)	Constructor for Settings

  Back to Top

Properties

 

	Name	Description
	Name	Visible name for your setting.
	Value	Default Value for setting.

  Back to Top

Methods

 

	Name	Description
	AddButton(Mod, String, Action)	Add button that can execute function.
	AddButton(Mod, String, Action, Color, Color)	Add button that can execute function.
	AddCheckBox	Add checkbox to settings menu Can execute action when its value is changed.
	AddCheckBoxGroup	Add checkbox group (radio buttons) to settings menu Can execute action when its value is changed.
	AddColorPickerRGB(Mod, String, String, Action)	Add Color Picker with RGB sliders
	AddColorPickerRGB(Mod, String, String, Color32, Action)	Add Color Picker with RGB sliders
	AddColorPickerRGBA(Mod, String, String, Action)	Add Color Picker with RGBA sliders
	AddColorPickerRGBA(Mod, String, String, Color32, Action)	Add Color Picker with RGBA sliders
	AddDropDownList	Add DropDown List
	AddDynamicHeader	Add dynamic Header, same as AddHeader but returns value, you can collapse/expand/change color of it from other settings.
	AddDynamicText	Add dynamic text (it is not saved)
	AddHeader(Mod, String)	Add Header, header groups settings together
	AddHeader(Mod, String, Boolean)	Add Header, header groups settings together
	AddHeader(Mod, String, Color)	Add Header, header groups settings together
	AddHeader(Mod, String, Color, Boolean)	Add Header, header groups settings together
	AddHeader(Mod, String, Color, Color)	Add Header, header groups settings together
	AddHeader(Mod, String, Color, Color, Boolean)	Add Header, header groups settings together
	AddResetButton	Add custom reset to default button
	AddSaveResetButton	Add Reset button to reset your mod's save file (only works when using unified save system)
	AddSlider(Mod, String, String, Int32, Int32, Int32, Action, String[])	Add Integer Slider to settings menu
	AddSlider(Mod, String, String, Single, Single, Single, Action, Int32)	Add Slider to settings menu
	AddText	Add just a text
	AddTextBox(Mod, String, String, String, String)	Add TextBox where user can type any text
	AddTextBox(Mod, String, String, String, String, ContentType)	Add TextBox where user can type any text
	Get	Return all settings for mod.
	GetDefault	Return all default settings for mod.
	GetValue	Get value of setting.
	HideResetAllButton	Hides "reset all settings to default" button.

  Back to Top

Fields

 

	Name	Description
	DoAction	Action to execute for specifed setting.
	ID	The ID of the settings (Should only be used once in your mod).
	Mod	The Mod this Setting belongs to (This is set when using Add whatever).
	SettingType	Type of setting.
	Vals	Helpful additional variables.

  Back to Top

See Also

Reference

MSCLoader Namespace