Class ButtonSetting

Namespace

Exiled.API.Features.Core.UserSettings

Assembly

Exiled.API.dll

Represents a button setting.

public class ButtonSetting : SettingBase, IWrapper<ServerSpecificSettingBase>, IWrapper<SSButton>

Inheritance

object

TypeCastObject<SettingBase>

SettingBase

ButtonSetting

Implements

IWrapper<ServerSpecificSettingBase>

IWrapper<SSButton>

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

ButtonSetting(int, string, string, float, string, HeaderSetting, Action<Player, SettingBase>)

Initializes a new instance of the ButtonSetting class.

public ButtonSetting(int id, string label, string buttonText, float holdTime = 0, string hintDescription = null, HeaderSetting header = null, Action<Player, SettingBase> onChanged = null)

Parameters

id int

label string

buttonText string

holdTime float

hintDescription string

header HeaderSetting

onChanged Action<Player, SettingBase>

Properties

Base

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

public SSButton Base { get; }

Property Value

SSButton

HoldTime

Gets or sets the hold time in seconds.

public float HoldTime { get; set; }

Property Value

float

LastPress

Gets the last press time.

public Stopwatch LastPress { get; }

Property Value

Stopwatch

Text

Gets or sets the button text.

public string Text { get; set; }

Property Value

string

Methods

ToString()

Returns a representation of this ButtonSetting.

public override string ToString()

Returns

string

A string in human-readable format.

UpdateSetting(string, float, bool, Predicate<Player>)

Sends updated values to clients.

public void UpdateSetting(string text, float holdTime, bool overrideValue = true, Predicate<Player> filter = null)

Parameters

text string

holdTime float

overrideValue bool

If false, sends fake values.

filter Predicate<Player>

Who to send the update to.