Table of Contents

Class ComponentFamilyAttribute

Namespace
Typhon.Schema.Definition
Assembly
Typhon.Schema.Definition.dll

Marks a component struct as belonging to a named family. The Workbench Data Flow module groups components by family at the L2 granularity ("Component-family"). When the attribute is absent, a server-side naming heuristic (Spatial / Combat / AI / Inventory / Rendering / Networking / Input / Misc) classifies the component by its name. The attribute always wins over the heuristic.

[AttributeUsage(AttributeTargets.Struct, Inherited = false)]
public sealed class ComponentFamilyAttribute : Attribute
Inheritance
ComponentFamilyAttribute
Inherited Members

Constructors

ComponentFamilyAttribute(string)

Assigns this component to the family named name.

public ComponentFamilyAttribute(string name)

Parameters

name string

Non-empty family name (see Name).

Exceptions

ArgumentException

name is null or empty.

Properties

Name

Family name that groups this component in the Workbench Data Flow view at the L2 ("Component-family") granularity.

public string Name { get; }

Property Value

string