Opzioni di rischio

Un API per fornire un'interfaccia utente nel gioco per interagire con il configentry di bepinex.

Opzioni attualmente supportate

• Caselle di controllo Il bool
• Il cursore
• Cursore a gradini Il galleggiante
• IntSlider E int.
• Binding di tasti Tastiera scorciatoia
• Campi di input stringa La stringa
• Scelta a discesa L'enumerazione
• Selezionatore di colori Unitymotor. Colore

Componenti aggiuntivi

• Pulsanti generici

Per richieste o problemi di funzionalità, visitare il mio Il repository.

Risorse degli sviluppatori

• Wiki delle opzioni di rischio
• Esempio di utilizzo

Inizio...

Prima devi prendere l'ultimo rilascio dal Pioggia temporale. estrarre il mod nella cartella dei plugin e quindi aggiungere un riferimento alla dll nel tuo progetto in visual studio. [progetto-> aggiungere riferimento...-> navigare]

Poi aggiungere a qualsiasi cosa si userà questo.

Utilizzare l'opzione di rischio;

Prossimo è necessario aggiungere il rischio di opzioni come una dipendenza per il tuo mod.

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

Infine assicurati di sapere come usare Configurazione di bepinex

Ora siete pronti per iniziare ad aggiungere opzioni.

Aggiungere un'opzione

Dai una Configurazione voce<bool>

Configurazione voce<bool>enableThing=Config.Bind (...); ModSettingsManager.AddOption(new CheckBoxOption(enableThing);

Hai bisogno di un cursore del volume?

Configurazione voce<float>volume = Config.Bind (...); ModSettingsManager.AddOption(new SliderOption(volume));

Ogni costruttore di opzione può prendere una configurazione per l'esempio sopra sarebbe Configurazione di scorrimento. dici che ti serve un cursore che va solo tra 60 e 130. Tu faresti:

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

Che mi dici di un cursore che va in incrementi di 0,15 ed è limitato tra 1-5?

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

Abbastanza sui galleggianti, parliamo degli spaghetti e delle polpette, dei chiavi.

Configurazione voce<KeyboardShortcut>keyBind = Config.Bind (...); ModSettingsManager.AddOption(new KeyBindOption(keyBind)); //questo ha anche un keybindconfig ma può essere omesso se si desiderano i valori predefiniti.

E questo è tutto, detto tastiera scorciatoia apparirà nel menu modoptions.

Le configurazioni della casella di controllo e del cursore possono essere impostate con un delegato che verrà utilizzato per controllare se detta opzione deve essere disabilitata nel menu.

Configurazione voce<bool>disableThing = Config.Bind (...); Configurazione voce<bool>overridenThing=Config.Bind (...); ModSettingsManager.AddOption(nuova checkboxoption(disabilitazione)); ModSettingsManager.AddOption(new CheckBoxOption(overridenThing, new CheckBoxConfig () {checkIfDisabled=Check}));... private bool Check () {return disabledThing.value;}

Quando? La disabilitazione È abilitato La sovrapposizione Apparirà come non interattabile nel menu.

"Ok, va tutto bene, ma come faccio a fare le cose quando un valore è cambiato?" Beh, grazie. Configurazione voceHa questo intrinsecamente:

Configurazione voce<bool>toggleThing=Config.Bind (...); toggleThing.SettingChanged + = (oggetto, args) = > {Debug.Log(toggleThing.Value)};

Naturalmente quando un'opzione cambia il valore di un Configurazione voceIl valore aggiorna in tempo reale, quindi in alcuni casi in cui si sta verificando il valore della voce direttamente non è necessario fare nulla.

Ci potrebbero esserci casi in cui si desidera solo un pulsante conveniente per aprire il proprio menu, in quanto tale si può fare questo:

ModSettingsManager.AddOption(new GenericButtonOption("menu personalizzato","Misc","Configure stuff in here "," Open Custom Menu ", OpenMenu)); private void OpenMenu () {/// Do stuff}

L'opzione genericbuttonoption può essere utilizzata per fornire un punto di entrata per l'apertura del tuo gui personalizzato.

Impostare la descrizione del mod

ModSettingsManager.SetModDescription("descrivere il tuo mod in dettaglio incredibile nel corso delle prossime 2 ore ");

Impostazione dell'icona del mod

Icona sprite =...; ModSettingsManager.SetModIcon (icona);

Vetrina rapida

La vetrina

I contatti e i contatti

Discordia: @rune

Github: Rune580