Class DropdownSetting

Namespace

Exiled.API.Features.Core.UserSettings

Assembly

Exiled.API.dll

Represents a dropdown setting.

public class DropdownSetting : SettingBase, IWrapper<ServerSpecificSettingBase>, IWrapper<SSDropdownSetting>

Inheritance

object

TypeCastObject<SettingBase>

SettingBase

DropdownSetting

Implements

IWrapper<ServerSpecificSettingBase>

IWrapper<SSDropdownSetting>

Inherited Members

SettingBase.SyncedList

SettingBase.List

SettingBase.SyncOnJoin

SettingBase.Id

SettingBase.Label

SettingBase.HintDescription

SettingBase.IsServerOnly

SettingBase.CollectionId

SettingBase.ResponseMode

SettingBase.OriginalDefinition

SettingBase.Header

SettingBase.OnChanged

SettingBase.TryGetSetting<T>(Player, int, out T)

SettingBase.TryGetSetting(Player, int, out SettingBase)

SettingBase.Create(ServerSpecificSettingBase)

SettingBase.Create<T>(ServerSpecificSettingBase)

SettingBase.SendToAll()

SettingBase.SendToAll(Func<Player, bool>)

SettingBase.SendToPlayer(Player)

SettingBase.SendToPlayer(Player, IEnumerable<SettingBase>)

SettingBase.Register(IEnumerable<SettingBase>, Func<Player, bool>)

SettingBase.Register(Player, IEnumerable<SettingBase>)

SettingBase.Unregister(Func<Player, bool>, IEnumerable<SettingBase>)

SettingBase.Unregister(Player, IEnumerable<SettingBase>)

SettingBase.UpdateLabelAndHint(string, string, bool, Predicate<Player>)

TypeCastObject<SettingBase>.Cast<TObject>()

TypeCastObject<SettingBase>.Cast<TObject>(out TObject)

TypeCastObject<SettingBase>.As<TObject>()

TypeCastObject<SettingBase>.Is<TObject>(out TObject)

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

ReflectionExtensions.CopyProperties(object, object)

Constructors

DropdownSetting(int, string, IEnumerable<string>, int, DropdownEntryType, string, HeaderSetting, Action<Player, SettingBase>)

Initializes a new instance of the DropdownSetting class.

[Obsolete("Will be removed in Exiled 10 in favour of ctor with more params")]
public DropdownSetting(int id, string label, IEnumerable<string> options, int defaultOptionIndex, SSDropdownSetting.DropdownEntryType dropdownEntryType, string hintDescription, HeaderSetting header, Action<Player, SettingBase> onChanged)

Parameters

id int

label string

options IEnumerable<string>

defaultOptionIndex int

dropdownEntryType SSDropdownSetting.DropdownEntryType

hintDescription string

header HeaderSetting

onChanged Action<Player, SettingBase>

DropdownSetting(int, string, IEnumerable<string>, int, DropdownEntryType, string, byte, bool, HeaderSetting, Action<Player, SettingBase>)

Initializes a new instance of the DropdownSetting class.

public DropdownSetting(int id, string label, IEnumerable<string> options, int defaultOptionIndex = 0, SSDropdownSetting.DropdownEntryType dropdownEntryType = DropdownEntryType.Regular, string hintDescription = null, byte collectionId = 255, bool isServerOnly = false, HeaderSetting header = null, Action<Player, SettingBase> onChanged = null)

Parameters

id int

label string

options IEnumerable<string>

defaultOptionIndex int

dropdownEntryType SSDropdownSetting.DropdownEntryType

hintDescription string

collectionId byte

isServerOnly bool

header HeaderSetting

onChanged Action<Player, SettingBase>

Properties

Base

Gets the base UserSettings.ServerSpecific.SSDropdownSetting that this class is wrapping.

public SSDropdownSetting Base { get; }

Property Value

SSDropdownSetting

DefaultOption

Gets or sets a default option.

public string DefaultOption { get; set; }

Property Value

string

DefaultOptionIndex

Gets or sets an index of default option.

public int DefaultOptionIndex { get; set; }

Property Value

int

DropdownType

Gets or sets a type of dropdown.

public SSDropdownSetting.DropdownEntryType DropdownType { get; set; }

Property Value

SSDropdownSetting.DropdownEntryType

Options

Gets or sets a collection of all options in dropdown.

public IEnumerable<string> Options { get; set; }

Property Value

IEnumerable<string>

SelectedIndex

Gets or sets an index of selected option.

public int SelectedIndex { get; set; }

Property Value

int

SelectedOption

Gets or sets a selected option.

public string SelectedOption { get; set; }

Property Value

string

Methods

ToString()

Gets a string representation of this DropdownSetting.

public override string ToString()

Returns

string

A string in human-readable format.

UpdateSetting(string[], bool, Predicate<Player>)

Sends updated values to clients.

public void UpdateSetting(string[] options, bool overrideValue = true, Predicate<Player> filter = null)

Parameters

options string[]

overrideValue bool

If false, sends fake values.

filter Predicate<Player>

Who to send the update to.

UpdateValue(int, bool, Predicate<Player>)

If setting is server only, sends updated values to clients.

public void UpdateValue(int selectedIndex, bool overrideValue = true, Predicate<Player> filter = null)

Parameters

selectedIndex int

overrideValue bool

If false, sends fake values.

filter Predicate<Player>

Who to send the update to.