Rune48a891aab771429d-Risk_Of_Options icon

Risk Of Options

A nice looking Mod Options API

Last updated 2 months ago
Total downloads 2267
Total rating 1 
Dependency string Rune48a891aab771429d-Risk_Of_Options-1.0.2
Dependants 1 other mod depends on this mod

This mod requires the following mods to function

bbepis-BepInExPack-5.3.1 icon
bbepis-BepInExPack

Unified BepInEx all-in-one modding pack - plugin framework, detour library

Preferred version: 5.3.1
README

RiskOfOptions

An API to add Mod Options in game to ROR2.

Getting Started

First you need to grab the latest release from the Thunderstore.
Extract the mod to your plugins folder, and then add a reference to the dll in your project in Visual Studio. [Project->Add Reference...->Browse]

Then add to where ever you will use this.

using RiskOfOptions;

Next you need to add Risk Of Options as a dependecy for your mod.

[BepInDependency("com.rune580.riskofoptions")]

Now you're ready to start adding options.

Adding an option

This needs to be run on Awake()

ModSettingsManager.addOption(new ModOption(ModOption.OptionType.Slider, "Test Slider", "This is a Slider test."));

ModSettingsManager.addOption(new ModOption(ModOption.OptionType.Bool, "Test Bool", "This is a Bool test."));

and with default values

ModSettingsManager.addOption(new ModOption(ModOption.OptionType.Slider, "Test Slider", "This is a Slider test.", "20"));

ModSettingsManager.addOption(new ModOption(ModOption.OptionType.Bool, "Test Bool", "This is a Bool test.", "1"));

Changing the description of the mod panel

ModSettingsManager.setPanelDescription("Testing stuff");

Changing the title of the mod panel

ModSettingsManager.setPanelTitle("Risk of Options Testing Stuff");

Fire event when value has changed

for a slider

ModSettingsManager.addListener(ModSettingsManager.getOption("Test Slider"), new UnityEngine.Events.UnityAction<float>(floatEvent));

public void floatEvent(float f)
        {
            Debug.Log(f);
        }

or for a bool

ModSettingsManager.addListener(ModSettingsManager.getOption("Test Bool"), new UnityEngine.Events.UnityAction<bool>(boolEvent));

public void boolEvent(bool b)
        {
            Debug.Log(b);
        }

Get the current value of an option

string b = ModSettingsManager.getOptionValue("Test Bool");

// BaseConVar returns a string as a value.
// for example it could be "1" or "0"

Get the ModOption of an option

ModSettingsManager.getOption("Test Bool")

Previews

Preview 1
Preview 2

Available versions

Please note that the install buttons only work if you have compatible client software installed. Otherwise use the zip download links instead.

Upload date Version number Downloads Download link  
2020-9-24 1.0.2 2208 Rune48a891aab771429d-Risk_Of_Options-1.0.2.zip Install
2020-9-23 1.0.1 41 Rune48a891aab771429d-Risk_Of_Options-1.0.1.zip Install
2020-9-23 1.0.0 18 Rune48a891aab771429d-Risk_Of_Options-1.0.0.zip Install