Class KeybindSetting

Namespace

Exiled.API.Features.Core.UserSettings

Assembly

Exiled.API.dll

Represents a keybind setting.

public class KeybindSetting : SettingBase, IWrapper<ServerSpecificSettingBase>, IWrapper<SSKeybindSetting>

Inheritance

object

TypeCastObject<SettingBase>

SettingBase

KeybindSetting

Implements

IWrapper<ServerSpecificSettingBase>

IWrapper<SSKeybindSetting>

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

KeybindSetting(int, string, KeyCode, bool, bool, string, HeaderSetting, Action<Player, SettingBase>)

Initializes a new instance of the KeybindSetting class.

[Obsolete("Will be removed in Exiled 10 in favour of ctor with more params.")]
public KeybindSetting(int id, string label, KeyCode suggested, bool preventInteractionOnGUI, bool allowSpectatorTrigger, string hintDescription, HeaderSetting header, Action<Player, SettingBase> onChanged)

Parameters

id int

label string

suggested KeyCode

preventInteractionOnGUI bool

allowSpectatorTrigger bool

hintDescription string

header HeaderSetting

onChanged Action<Player, SettingBase>

KeybindSetting(int, string, KeyCode, bool, bool, string, byte, HeaderSetting, Action<Player, SettingBase>)

Initializes a new instance of the KeybindSetting class.

public KeybindSetting(int id, string label, KeyCode suggested, bool preventInteractionOnGUI = false, bool allowSpectatorTrigger = false, string hintDescription = "", byte collectionId = 255, HeaderSetting header = null, Action<Player, SettingBase> onChanged = null)

Parameters

id int

label string

suggested KeyCode

preventInteractionOnGUI bool

allowSpectatorTrigger bool

hintDescription string

collectionId byte

header HeaderSetting

onChanged Action<Player, SettingBase>

KeybindSetting(int, string, KeyCode, bool, string, HeaderSetting, Action<Player, SettingBase>)

Initializes a new instance of the KeybindSetting class.

[Obsolete("This method will be removed next major version because of a new feature. Use the constructor with \"CollectionId\" instead.")]
public KeybindSetting(int id, string label, KeyCode suggested, bool preventInteractionOnGUI, string hintDescription, HeaderSetting header, Action<Player, SettingBase> onChanged)

Parameters

id int

label string

suggested KeyCode

preventInteractionOnGUI bool

hintDescription string

header HeaderSetting

onChanged Action<Player, SettingBase>

Properties

AllowSpectatorTrigger

Gets or sets a value indicating whether the interaction is prevented in spectator roles.

public bool AllowSpectatorTrigger { get; set; }

Property Value

bool

Base

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

public SSKeybindSetting Base { get; }

Property Value

SSKeybindSetting

IsPressed

Gets a value indicating whether the key is pressed.

public bool IsPressed { get; }

Property Value

bool

KeyCode

Gets or sets the assigned key.

public KeyCode KeyCode { get; set; }

Property Value

KeyCode

PreventInteractionOnGUI

Gets or sets a value indicating whether the interaction is prevented while player is in RA, Settings etc.

public bool PreventInteractionOnGUI { get; set; }

Property Value

bool

Methods

ToString()

Returns a representation of this KeybindSetting.

public override string ToString()

Returns

string

A string in human-readable format.