用於將BepInEx ConfigEntry添加到選項菜單的便捷API

風險期權

一個API，在遊戲中提供用戶界面，與BepInEx ConfigEntry進行交互。

當前支持的選項

• 複選框 布爾
• 滑塊
• 階梯滑塊 浮子
• IntSliders int
• 鍵綁定 鍵盤快捷鍵
• 字符串輸入字段 字符串
• 選擇下拉列表 枚舉
• 顏色選擇器 UnityEngine.Color

附加組件

• 通用按鈕

有關功能請求或問題，請訪問我的 存儲庫.

開發者資源

• 風險期權維基
• 用法示例

入門

首先，您需要從 Thunderstore.將mod解壓到插件文件夾，然後在Visual Studio中添加對項目中dll的引用。 [項目->添加引用...->瀏覽]

然後添加到您將使用它的任何地方。

使用風險選項；

接下來，你需要添加選項的風險作為你的mod的依賴。

[BepInDependency(“com.rune 580.riskofoptions”)]

最後確保您知道如何使用 BepInEx配置

現在，您可以開始添加選項了。

添加選項

給定一個 配置條目<bool>

配置條目<bool>enableThing=Config.Bind（...）； ModSettingsManager.AddOption（新複選框選項（啟用）；

需要音量滑塊嗎？

配置條目<float>volume=Config.Bind(...)； ModSettingsManager.添加選項（新滑塊選項（卷））；

每個選項構造函數都可以為上面的示例獲取一個配置 滑塊配置.假設你需要一個只能在60-130之間的滑塊。 你會做：

ModSettingsManager.AddOption(new SliderOption(limitedRangeFloat，new SliderConfig(){min=60，max=130}))；

以0.15為增量並限制在1-5之間的滑塊呢？

ModSettingsManager.AddOption(new StepSliderOption(incrementedFloat，new StepSliderConfig(){min=1，max=5，increment=0.15 f}))；

關於彩車說得夠多了，讓我們來談談意大利面和肉丸，鑰匙扣。

配置條目<KeyboardShortcut>keyBind=Config.Bind（...）； ModSettingsManager.AddOption（新KeyBindOption（keyBind））； //這也有一個KeyBindConfig，但如果需要默認值，可以省略。

就是這樣，所說的鍵盤快捷鍵將出現在ModOptions菜單上。

複選框和滑塊配置可以用一個委託來設置，該委託將用於檢查是否應該在菜單中禁用所述選項。

配置條目<bool>disableThing=Config.Bind(...)； 配置條目<bool>overridenThing=Config.Bind(...)； ModSettingsManager.AddOption（新複選框選項（禁用））； ModSettingsManager.AddOption（new CheckBoxOption（overridenThing，new CheckBoxConfig（）{checkIfDisabled=Check}））；... private bool Check(){return disabledThing.value;}

什麼時候 禁用 已啟用 壓倒性 將在菜單中顯示為不可交互。

“好吧，這很好，但是當一個值改變時，我該怎麼做呢？” 謝天謝地 配置條目我們天生就有這個：

配置條目<bool>toggleThing=Config.Bind(...)； Toggle Thing.Setting Changed+=(object，args)=>{Debug.Log(Toggle Thing.value)}；

當然，當一個選項改變了傳遞的值時 配置條目，值會實時更新，因此在某些直接檢查條目值的情況下，您不需要執行任何操作。

在某些情況下，您可能只想要一個方便的按鈕來打開自己的菜單，因此您可以這樣做：

ModSettingsManager.AddOption（新的GenericButtonOption（“自定義菜單”、“雜項”、“在此配置內容”、“打開自定義菜單”、OpenMenu））； private void OpenMenu(){///Do stuff}

GenericButtonOption可用於提供打開自定義GUI的入口點。

設置mod的描述

ModSettingsManager.SetModDescription（“在接下來的2個小時內以令人難以置信的細節描述你的mod”）；

設置mod的圖標

精靈圖標=...； ModSettingsManager.SetModIcon(圖標);

快速展示

陳列櫃

聯繫人

不和諧：@rune

Github：Rune580