Skip to content

Game.Settings.SettingsUITextInputAttribute

Assembly:
Namespace: Game.Settings

Type: class

Base: System.Attribute

Summary:
SettingsUITextInputAttribute is a marker attribute used to indicate that a settings property should be presented as a single-line text input field in the game's settings UI. It has no parameters and carries no behavior by itself beyond its presence; the settings UI system inspects for this attribute to decide how to render a property.

Fields

  • This type declares no fields.
    This attribute class does not define any backing fields or state. It is a stateless marker.

Properties

  • This type declares no properties.
    No properties are exposed by this attribute — it acts solely as a tag.

Constructors

  • public SettingsUITextInputAttribute()
    Default parameterless constructor. The attribute contains no data and is applied only for identification by the settings UI renderer.

Methods

  • This type declares no methods.
    There are no methods declared on this attribute type; it inherits Object members and Attribute behavior.

Usage Example

using Game.Settings;

public class MyModSettings
{
    // This property will be rendered as a single-line text input in the settings UI
    [SettingsUITextInput]
    public string PlayerDisplayName { get; set; }
}

Notes: - AttributeUsage on the type (as defined in source) restricts this attribute to properties and allows it to be inherited by derived types: AttributeTargets.Property, Inherited = true. - Because the attribute carries no data, it is safe to reuse on multiple properties and requires no additional parameters.