LaunchBoxContributors
On this page

EmulatorControllerOption13.13

Class in Unbroken.LaunchBox.Plugins

Obsolete since 14.1

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

C#
public class EmulatorControllerOption
An option this emulator can have set

Constructors

EmulatorControllerOption Changed 13.27

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

Properties

CurrentValue Changed 13.27

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

DefaultValue Changed 13.27

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

Description Changed 13.27

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

Identifier

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

Label

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

OptionType

C#
public EmulatorControllerOptionTypes OptionType { get; }
Type of data this option utilizes

PossibleValues

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

Methods

ToString

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

Returns

The display label.