LaunchBoxCONTRIBUTORS
On this page

14.1 Beta 1 SDK

This reference documents the current beta SDK. Beta APIs can change before stable.

EmulatorControllerOption13.13

Obsolete since 14.1 Beta

This emulator option contract is no longer consumed and has no direct replacement.

C#
public class Unbroken.LaunchBox.Plugins.EmulatorControllerOption
An option this emulator can have set

Constructors

EmulatorControllerOption 13.13

C#
public EmulatorControllerOption(string identifier, Unbroken.LaunchBox.Plugins.EmulatorControllerOptionTypes type, string label, string? description = null, object? currentValue = null, object? defaultValue = null, System.Collections.Generic.IEnumerable<object>? possibleValues = null)
Initializes a legacy emulator option descriptor.
identifier 13.13
The non-null option identifier.
type 13.13
The kind of value accepted by the option.
label 13.13
The non-null display label.
description 13.13
The optional descriptive text.
currentValue 13.13
The current option value.
defaultValue 13.13
The default option value.
possibleValues 13.13
The allowed choices, copied into a list; null produces an empty list.

Properties

CurrentValue 13.13

C#
public object? CurrentValue { get; }
The current value of this option

DefaultValue 13.13

C#
public object? DefaultValue { get; }
The default value of this option

Description 13.13

C#
public string? Description { get; }
UI string describing this option

Identifier 13.13

C#
public string Identifier { get; }
Unique identifier for this option

Label 13.13

C#
public string Label { get; }
UI Label for this option

OptionType 13.13

C#
public Unbroken.LaunchBox.Plugins.EmulatorControllerOptionTypes OptionType { get; }
Type of data this option utilizes

PossibleValues 13.13

C#
public System.Collections.Generic.IReadOnlyList<object> PossibleValues { get; }
A collection of possible values for this option

Methods

ToString 13.13

C#
public override string ToString()
Returns the display label.

Returns

The display label.