Class EventChannelDescriptionAttribute

The EventChannelDescriptionAttribute contains metadata for event channels used in Muse Behavior graphs.

Inheritance
object
Attribute
EventChannelDescriptionAttribute
Inherited Members
Namespace: Unity.Muse.Behavior
Assembly: Unity.Muse.Behavior.dll
Syntax
[AttributeUsage(AttributeTargets.Class)]
public class EventChannelDescriptionAttribute : Attribute

Constructors

EventChannelDescriptionAttribute(string, string, string, string, string, string, string)

Initializes an instance of the EventChannelDescriptionAttribute class with the provided metadata.

Declaration
public EventChannelDescriptionAttribute(string name = "", string description = "", string message = "", string icon = "", string category = "", string id = "", string filePath = "")
Parameters
Type Name Description
string name

The name of the event channel.
string description

The description of the event channel's function.
string message

The message that describes the event that is being triggered.
string icon

The path of the icon to be used when representing the event channel in the graph editor.
string category

The category path this event channel belongs to and will be shown on the search window.
string id

A unique ID used to identify this event channel.
string filePath

The path to the script file containing this attribute.

Properties

Category

The category path this event channel belongs to and will be shown on the search window.

Declaration
public string Category { get; }
Property Value
Type Description
string

Description

The description of the event channel's function.

Declaration
public string Description { get; }
Property Value
Type Description
string

FilePath

The path to the script file containing this attribute.

Declaration
public string FilePath { get; }
Property Value
Type Description
string

GUID

A unique ID used to identify this event channel.

Declaration
public SerializableGUID GUID { get; }
Property Value
Type Description
SerializableGUID

Icon

The path of the icon to be used when representing the event channel in the graph editor.

Declaration
public string Icon { get; }
Property Value
Type Description
string

Message

The message that describes the event that has occured.

Declaration
public string Message { get; }
Property Value
Type Description
string

Name

The name of the event channel.

Declaration
public string Name { get; }
Property Value
Type Description
string