Class SliderSetting

Namespace

Exiled.API.Features.Core.UserSettings

Assembly

Exiled.API.dll

Represents a slider setting.

public class SliderSetting : SettingBase, IWrapper<ServerSpecificSettingBase>, IWrapper<SSSliderSetting>

Inheritance

object

TypeCastObject<SettingBase>

SettingBase

SliderSetting

Implements

IWrapper<ServerSpecificSettingBase>

IWrapper<SSSliderSetting>

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

SliderSetting(int, string, float, float, float, bool, string, string, string)

Initializes a new instance of the SliderSetting class.

[Obsolete("Will be removed in Exiled 10 in favour of ctor with more params.")]
public SliderSetting(int id, string label, float minValue, float maxValue, float defaultValue, bool isInteger, string stringFormat, string displayFormat, string hintDescription)

Parameters

id int

label string

minValue float

maxValue float

defaultValue float

isInteger bool

stringFormat string

displayFormat string

hintDescription string

SliderSetting(int, string, float, float, float, bool, string, string, string, byte, bool, HeaderSetting, Action<Player, SettingBase>)

Initializes a new instance of the SliderSetting class.

public SliderSetting(int id, string label, float minValue, float maxValue, float defaultValue, bool isInteger = false, string stringFormat = "0.##", string displayFormat = "{0}", string hintDescription = null, byte collectionId = 255, bool isServerOnly = false, HeaderSetting header = null, Action<Player, SettingBase> onChanged = null)

Parameters

id int

label string

minValue float

maxValue float

defaultValue float

isInteger bool

stringFormat string

displayFormat string

hintDescription string

collectionId byte

isServerOnly bool

header HeaderSetting

onChanged Action<Player, SettingBase>

Properties

Base

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

public SSSliderSetting Base { get; }

Property Value

SSSliderSetting

DefaultValue

Gets or sets the default value of the slider.

public float DefaultValue { get; set; }

Property Value

float

DisplayFormat

Gets or sets the formatting used for the final display of the value of the slider.

public string DisplayFormat { get; set; }

Property Value

string

IsBeingDragged

Gets a value indicating whether the slider is currently being dragged.

public bool IsBeingDragged { get; }

Property Value

bool

IsInteger

Gets or sets a value indicating whether the slider displays integers.

public bool IsInteger { get; set; }

Property Value

bool

MaximumValue

Gets or sets the maximum value of the slider.

public float MaximumValue { get; set; }

Property Value

float

MinimumValue

Gets or sets the minimum value of the slider.

public float MinimumValue { get; set; }

Property Value

float

SliderValue

Gets a float that represents the current value of the slider.

public float SliderValue { get; }

Property Value

float

StringFormat

Gets or sets the formatting used for the number in the slider.

public string StringFormat { get; set; }

Property Value

string

Methods

ToString()

Returns a representation of this SliderSetting.

public override string ToString()

Returns

string

A string in human-readable format.

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

Sends updated values to clients.

public void UpdateSetting(float min, float max, bool isInteger, string stringFormat, string displayFormat, bool overrideValue = true, Predicate<Player> filter = null)

Parameters

min float

max float

isInteger bool

stringFormat string

displayFormat string

overrideValue bool

If false, sends fake values.

filter Predicate<Player>

Who to send the update to.

UpdateValue(float, bool, Predicate<Player>)

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

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

Parameters

value float

overrideValue bool

If false, sends fake values.

filter Predicate<Player>

Who to send the update to.