Class HeaderSetting

Namespace

Exiled.API.Features.Core.UserSettings

Assembly

Exiled.API.dll

Represents a header setting.

public class HeaderSetting : SettingBase, IWrapper<ServerSpecificSettingBase>, IWrapper<SSGroupHeader>

Inheritance

object

TypeCastObject<SettingBase>

SettingBase

HeaderSetting

Implements

IWrapper<ServerSpecificSettingBase>

IWrapper<SSGroupHeader>

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

HeaderSetting(int, string, string, bool)

Initializes a new instance of the HeaderSetting class.

public HeaderSetting(int id, string name, string hintDescription = "", bool padding = false)

Parameters

id int

name string

hintDescription string

padding bool

HeaderSetting(string, string, bool)

Initializes a new instance of the HeaderSetting class.

[Obsolete("Use constructor with Id, old headers will use random number based on headers name")]
public HeaderSetting(string name, string hintDescription, bool paddling)

Parameters

name string

hintDescription string

paddling bool

Properties

Base

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

public SSGroupHeader Base { get; }

Property Value

SSGroupHeader

ReducedPaddling

Gets or sets a value indicating whether to reduce padding.

public bool ReducedPaddling { get; set; }

Property Value

bool

Methods

ToString()

Returns a representation of this HeaderSetting.

public override string ToString()

Returns

string

A string in human-readable format.