> For the complete documentation index, see [llms.txt](https://postica.gitbook.io/binding-system-3/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://postica.gitbook.io/binding-system-3/reference/attributes.md). # Attributes Every attribute that affects a bind field, a modifier or the menus. All in the `Postica.BindingSystem` namespace, except `[TypeDescription]` which lives in `Postica.Common`. ## On bind fields

Attribute	What it does
`[Bind]`	Marks the field as a bind type. Use it when several drawing attributes are combined and they need to be ordered into one draw pipeline.
`[Bind(BindMode)]`	Forces the field into a mode.
`[ReadOnlyBind]`	Read only. The bind path menu offers only readable members.
`[WriteOnlyBind]`	Write only. The menu offers only writable members.
`[BindType(Type)]`	Restricts the field to values of that type. Needed for generic containers where the type cannot be inferred.
`[BindMode(BindMode)]`	A mode on a field, property, class or struct.
`[AllowDefaultValues]`	Lets the field offer the default value of its type as an explicit choice.
`[MultiUpdate]`	Declares that the field can update several times per frame.
`[DynamicBindType]`	The bind type is decided at runtime rather than declared.
`[BindTypeSource(fieldPath)]`	Takes the bind type from another field. For expert use.
`[InlineToggle(field, onText, offText)]`	Draws a sibling `bool` field as a pill on this bind field's row, showing one word for each state. For an option that is one word about the field beside it. Mark the `bool` `[HideInInspector]` too, or it keeps its own row. Honoured on bind fields only.

```csharp public class Turret : MonoBehaviour { [ReadOnlyBind] public Bind targetAngle; [WriteOnlyBind] public Bind isFiring; [Bind(BindMode.Read)] public Bind ammo; [AllowDefaultValues] public Bind optionalTarget; } ``` `[InlineToggle]` is how a converter or modifier puts a small switch where it reads best, beside the value it qualifies: ```csharp [Serializable] public class StringToPrice : IConverter { [InlineToggle(nameof(fallbackOnEmpty), "Invalid or empty", "Invalid only")] public Bind fallback; [HideInInspector] [Tooltip("Whether an empty string also takes the fallback value.")] public bool fallbackOnEmpty; // ... } ``` ## Controlling the bind path menu

Attribute	What it does
`[HideMember]`	Hides the member from the bind path menu entirely.
`[HideMember(Hide.InternalsOnly)]`	Keeps the member visible but stops navigation into its own members.

```csharp [HideMember] public float internalCounter; // not offered at all [HideMember(HideMemberAttribute.Hide.InternalsOnly)] public ComplexThing thing; // bindable, but not walked into ``` For hiding members of types you do not own, the editor applies global filters through `ReflectionFactory`. That is how `GameObject.transform` is hidden while `Transform` stays fully bindable. Those filters are applied at editor load and are not hot-reloadable: changing one needs a domain reload. ## On modifiers

Attribute	What it does
`[TypeDescription(string)]`	The description shown in the Add Modifier menu and as the tooltip.
`[OneLineModifier]`	Draw the modifier on one line rather than as a foldout. Right for a single-field modifier.
`[ModifierOptions]`	How the modifier is offered: `ModifierMode` to force a mode, `AllowSimilarTypes` to also allow similar modifiers for base types, and a switch for applying to derived types.

See [Custom Modifiers](/binding-system-3/reference/extending/modifiers.md). ## Code generation

Attribute	What it does
`[EnableStandardModifiers]`	Generates the generic standard modifiers for your type. See Standard Modifiers for Your Types.
`[EnableStandardModifiers(StandardModifierKinds)]`	Only the kinds you name. Reference types always get every applicable kind.
`[RegistersGeneratedModifiers]`	Marks a static parameterless method as the registration entry point for generated modifiers. Called at editor startup.
`[RegistersCustomAccessors]`	Marks a type as registering custom accessors.
`[AutoGenerated(Type generator)]`	Marks a type as auto generated, and by what.
`[GeneratedBind]`	Marks a bind field as generated by the system.

`StandardModifierKinds` values: `SetValue`, `LinksTo`, `NullCheck`, `Delay`, `Log`, `Events`, `Conditions`, plus `None` and `All`. ## Editor lifecycle

Attribute	What it does
`[OnBindSystemUpgrade]`	Marks a static method called once when the package is upgraded, with the version you came from as its argument. Use it to migrate your own binding-related data.

```csharp [OnBindSystemUpgrade] private static void Upgrade(string fromVersion) { if (string.Compare(fromVersion, "3.0.0", StringComparison.Ordinal) < 0) { // migrate } } ``` ## Attributes from other packages that are respected

Attribute	What it does
`[Tooltip]`	Used as the tooltip on bind fields and on modifier and converter fields.
`[SerializeField]`, `[SerializeReference]`	Normal Unity serialization. Converters and modifiers are stored through `[SerializeReference]`, which is what makes them polymorphic.
`[FormerlySerializedAs]`	Respected. It keeps the value across a rename; refactoring keeps the bindings. Use both.
Odin's `[AssetsOnly]`, `[SceneObjectsOnly]`	Propagated to the source field, and reported as Assets NOT Allowed or Scene Objects NOT Allowed. See Odin Inspector.

## Interfaces worth knowing beside the attributes

Interface	What it is for
`IBindController`	An empty marker. An object implementing it can pause, resume and refresh its own bindings. See Controlling Bindings at Runtime.
`IDynamicComponent`	Declares that a converter's or modifier's output can change without its input changing. See Phased Bindings.
`IRequiresAutoUpdate`	A modifier that needs the binding to update automatically.
`IBindVariableContainer`	Supplies bind variables.
`IAccessorProvider`	Supplies bindable paths that are not members.
`IValueProvider<T>`	Supplies a value to a parameter or a modifier field.