Game.Settings.SettingsUIHiddenAttribute

Assembly: Assembly-CSharp
Namespace: Game.Settings

Type: class

Base: System.Attribute

Summary:
Marker attribute used to indicate that a setting (or a type containing settings) should be hidden from the in-game settings UI. It is a simple declarative attribute with no behavior by itself; UI code or reflection-based serializers in the game/framework check for this attribute and omit decorated members from presentation. The attribute targets classes, structs, properties and fields and is inheritable by derived types.

---

Fields

• None
  This attribute declares no instance or static fields.

Properties

• None
  There are no declared properties on this attribute.

Constructors

• public SettingsUIHiddenAttribute()
  The parameterless constructor is the default implicit constructor provided for this attribute. No parameters or special initialization are required.

Methods

• None
  No methods are declared on this attribute type.

Usage Example

using Game.Settings;

// Hide a single setting field or property
public class MySettings
{
    [SettingsUIHidden]
    public int InternalOnlyValue { get; set; }

    public int VisibleValue { get; set; }
}

// Or hide an entire settings class/struct so the UI ignores it
[SettingsUIHidden]
public class AdvancedSettings
{
    public bool SomeAdvancedToggle { get; set; }
}