EventAttribute¶

Namespace: SideXP.Broadcaster | Inherits from: Attribute

public sealed class EventAttribute : Attribute

Optional metadata for an IEvent type, consumed by tooling (the editor windows and the monitor).

Constructors¶

EventAttribute()¶

public EventAttribute()

Optional metadata for an IEvent type, consumed by tooling (the editor windows and the monitor).

EventAttribute(string)¶

public EventAttribute(string description)

Optional metadata for an IEvent type, consumed by tooling (the editor windows and the monitor).

Parameters

• description

Properties¶

Name¶

public string Name

The name the Events window shows for this event instead of the C# type name. Supports /-separated paths.

Description¶

public string Description

Human-readable description of the event, surfaced in the Events window and the monitor.

OmitSnapshot¶

public bool OmitSnapshot

When true, the monitor captures only this event's type name, not its field/property values. Set it on events whose payload is sensitive, huge, or expensive to stringify. Off by default (the full payload is captured).

Hidden¶

public bool Hidden

When true, the Events window leaves this event out of its catalog by default.