Class EventChannelDescriptionAttribute

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

Inheritance

object

Attribute

EventChannelDescriptionAttribute

Inherited Members

Attribute.Equals(object)

Attribute.GetCustomAttribute(Assembly, Type)

Attribute.GetCustomAttribute(Assembly, Type, bool)

Attribute.GetCustomAttribute(MemberInfo, Type)

Attribute.GetCustomAttribute(MemberInfo, Type, bool)

Attribute.GetCustomAttribute(Module, Type)

Attribute.GetCustomAttribute(Module, Type, bool)

Attribute.GetCustomAttribute(ParameterInfo, Type)

Attribute.GetCustomAttribute(ParameterInfo, Type, bool)

Attribute.GetCustomAttributes(Assembly)

Attribute.GetCustomAttributes(Assembly, bool)

Attribute.GetCustomAttributes(Assembly, Type)

Attribute.GetCustomAttributes(Assembly, Type, bool)

Attribute.GetCustomAttributes(MemberInfo)

Attribute.GetCustomAttributes(MemberInfo, bool)

Attribute.GetCustomAttributes(MemberInfo, Type)

Attribute.GetCustomAttributes(MemberInfo, Type, bool)

Attribute.GetCustomAttributes(Module)

Attribute.GetCustomAttributes(Module, bool)

Attribute.GetCustomAttributes(Module, Type)

Attribute.GetCustomAttributes(Module, Type, bool)

Attribute.GetCustomAttributes(ParameterInfo)

Attribute.GetCustomAttributes(ParameterInfo, bool)

Attribute.GetCustomAttributes(ParameterInfo, Type)

Attribute.GetCustomAttributes(ParameterInfo, Type, bool)

Attribute.GetHashCode()

Attribute.IsDefaultAttribute()

Attribute.IsDefined(Assembly, Type)

Attribute.IsDefined(Assembly, Type, bool)

Attribute.IsDefined(MemberInfo, Type)

Attribute.IsDefined(MemberInfo, Type, bool)

Attribute.IsDefined(Module, Type)

Attribute.IsDefined(Module, Type, bool)

Attribute.IsDefined(ParameterInfo, Type)

Attribute.IsDefined(ParameterInfo, Type, bool)

Attribute.Match(object)

Attribute.TypeId

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Behavior

Assembly: Unity.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