Risikoptionen

Eine API, die eine Benutzeroberfläche im Spiel zur Interaktion mit BepInEx ConfigEntry bietet.

Aktuell unterstützte Optionen

• Kontrollkästchen Booler
• Schieberegler
• Treppenschieber Schwimmer
• IntSliders int
• Schlüsselbindung Tastaturkombinationen
• Zeichenfolgeneingabefeld Zeichenkette
• Dropdown-Liste auswählen Enumeration
• Farbauswahl UnityEngine.Farbe

Zusatzkomponenten

• Universalknopf

Für Funktionsanfragen oder Fragen besuchen Sie bitte meine Repository.

Ressourcen für Entwickler

• Wiki für Risikoptionen
• Anwendungsbeispiele

Einstieg

Zunächst müssen Sie von Kategorie: Thunderstore. Extrahieren Sie den mod in den Plugin-Ordner und fügen Sie dann einen Verweis auf die DLLs in Ihrem Projekt in Visual Studio hinzu. [Projekte-> Referenz hinzufügen...-> Durchsuchen]

Dann fügen Sie es überall hinzu, wo Sie es verwenden werden.

Verwenden Sie Risiko-Optionen;

Als nächstes müssen Sie die Option Risiko als Abhängigkeit Ihres Mods hinzufügen.

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

Stellen Sie schließlich sicher, dass Sie wissen, wie man BepInEx-Konfiguration

Jetzt können Sie mit dem Hinzufügen von Optionen beginnen.

Optionen hinzufügen

Gegeben von einer Konfigurationseinträge<bool>

Konfigurationseinträge<bool>enableThing=Config.Bind (...); ModSettingsManager.AddOption (neue Kontrollkästchenoption (aktiviert);

Brauchen Sie einen Lautstärkeregler?

Konfigurationseinträge<float>Volumen = Config.Bind (...); ModSettingsManager.Optionen hinzufügen (neue Schieberegleroptionen (Volume));

Jeder Optionskonstruktor kann eine Konfiguration für das obige Beispiel erhalten Schieberkonfiguration. Angenommen, Sie brauchen einen Schieberegler, der nur zwischen 60 und 130 sein kann. Sie werden tun:

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

Was ist mit Schiebereglern, die in Schritten von 0,15 und auf 1-5 beschränkt sind?

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

Genug über Schwimmen, reden wir über Spaghetti und Fleischbällchen, Schlüsselanhänger.

Konfigurationseinträge<KeyboardShortcut>keyBind = Config.Bind (...); ModSettingsManager.AddOption(neues KeyBindOption(keyBind)); //Dieser hat ebenfalls einen KeyBindConfig, kann aber weggelassen werden, wenn ein Standardwert erforderlich ist.

Das ist es, die genannte Tastaturkombination erscheint im ModOptionsmenü.

Die Checkbox- und Schiebereglerkonfiguration kann mit einem Delegierten eingestellt werden, der verwendet wird, um zu prüfen, ob die genannten Optionen im Menü deaktiviert werden sollen.

Konfigurationseinträge<bool>disableThing=Config.Bind (...); Konfigurationseinträge<bool>overridenThing=Config.Bind (...); ModSettingsManager.AddOption (neue Kontrollkästchenoption (deaktiviert)); ModSettingsManager.AddOption(new CheckBoxOption(overridenThing, new CheckBoxConfig () {checkIfDisabled=Check}));... private bool Check () {return disabledThing.value;}

Wann Deaktiviert Ermöglicht überwältigend Wird im Menü als nicht interaktiv angezeigt.

"Okay, das ist gut, aber was mache ich, wenn sich ein Wert ändert?" Gott sei Dank KonfigurationseinträgeWir sind mit diesem geboren:

Konfigurationseinträge<bool>toggleThing=Config.Bind (...); Toggle Thing.Setting geändert + = (object, args) = > {Debug.Log(Toggle Thing.value)};

Natürlich, wenn eine Option den übergebenen Wert ändert Konfigurationseinträge, die Werte werden in Echtzeit aktualisiert, sodass Sie in einigen Fällen nichts tun müssen, in denen der Eintragswert direkt überprüft wird.

In einigen Fällen möchten Sie vielleicht nur eine praktische Schaltfläche, um Ihr eigenes Menü zu öffnen, also können Sie dies tun:

ModSettingsManager.AddOption (Neue GenericButtonOption ("Menü anpassen", "Verschiedenes", "Inhalt hier konfigurieren", "Menü anpassen", OpenMenu)); Privat ungültig OpenMenu () {///Do stuff}

GenericButtonOption kann verwendet werden, um einen Einstiegspunkt zum Öffnen einer benutzerdefinierten GUI bereitzustellen.

Beschreibung des Einstellmods

ModSettingsManager.SetModDescription ("Beschreiben Sie Ihren mod in unglaublichen Details in den nächsten 2 Stunden");

Setzen Sie das Icon für den mod

Sprite-Icon =...; ModSettingsManager.SetModIcon (Symbol);

Schnelle Präsentation

Showcase

Ansprechpartner

Dissonanz: @rune

Github: Rune580