Gears
API ReferenceAttributes

SettingPathAttribute

Base for any attribute that names a setting by its path. The path is "tabName.CategoryName.SettingName" for global settings and "CategoryName.SettingName" for world settings.

Abstract classNamespace GearsAPI.AttributesAssembly GearsAPI.dllSource
public abstract class SettingPathAttribute : Attribute

Base class of every attribute that names a setting by its path for BindSettingsClass. Cannot be applied directly. This class deliberately declares no AttributeUsage of its own, because AttributeUsage is inherited — each concrete attribute below it declares its own targets.

Inheritance: Object → Attribute → SettingPathAttribute
Derived: SettingListenerAttribute · SettingAttribute · SettingPlayerActionAttribute

Constructors

SettingPathAttribute(String)

protected SettingPathAttribute(string settingPath)

Protected. Stores settingPath. Throws ArgumentException if it is null or whitespace.

Properties

SettingPath

public string SettingPath { get; }

Gets the dot-separated path to the setting: "Tab.Category.Setting" for global settings, "Category.Setting" for world settings.

On this page