Table of Contents

Class UserTextInputSetting

Namespace
Exiled.API.Features.Core.UserSettings
Assembly
Exiled.API.dll

Represents a user text input setting.

public class UserTextInputSetting : SettingBase, IWrapper<ServerSpecificSettingBase>, IWrapper<SSPlaintextSetting>
Inheritance
UserTextInputSetting
Implements
IWrapper<ServerSpecificSettingBase>
IWrapper<SSPlaintextSetting>
Inherited Members
Extension Methods

Constructors

UserTextInputSetting(int, string, string, int, ContentType, string)

Initializes a new instance of the UserTextInputSetting class.

public UserTextInputSetting(int id, string label, string placeHolder = "", int characterLimit = 64, TMP_InputField.ContentType contentType = ContentType.Standard, string hintDescription = null)

Parameters

id int
label string
placeHolder string
characterLimit int
contentType TMP_InputField.ContentType
hintDescription string

Properties

Base

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

public SSPlaintextSetting Base { get; }

Property Value

SSPlaintextSetting

CharacterLimit

Gets or sets a value indicating the max number of characters in the PlainTextSetting.

public int CharacterLimit { get; set; }

Property Value

int

ContentType

Gets or sets a value indicating the type of content within the PlainTextSetting.

public TMP_InputField.ContentType ContentType { get; set; }

Property Value

TMP_InputField.ContentType

PlaceHolder

Gets or sets a value indicating the placeholder shown within the PlainTextSetting.

public string PlaceHolder { get; set; }

Property Value

string

Text

Gets the value of the text entered by a client.

public string Text { get; }

Property Value

string

Methods

ToString()

Returns a representation of this UserTextInputSetting.

public override string ToString()

Returns

string

A string in human-readable format.

Edit this page