Struct MessageContext | Data Flow Graph | 0.11.10-preview
docs.unity3d.com
    Show / Hide Table of Contents

    Struct MessageContext

    A context provided to a node's OnMessage<T>(MessageContext, T) implementation which is invoked when a node receives a message on one of their MessageInputs.

    Inherited Members
    ValueType.Equals(Object)
    ValueType.GetHashCode()
    ValueType.ToString()
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Namespace: Unity.DataFlowGraph
    Syntax
    public struct MessageContext

    Fields

    Handle

    A handle to the node receiving a message.

    Declaration
    public readonly NodeHandle Handle
    Field Value
    Type Description
    NodeHandle

    Properties

    ArrayIndex

    If the above port ID corresponds to a PortArray<TInputPort>, this is the array index on which the message is being received.

    Declaration
    public ushort ArrayIndex { get; }
    Property Value
    Type Description
    UInt16

    Port

    The port ID of the MessageInput<TDefinition, TMsg> on which the message is being received.

    Declaration
    public InputPortID Port { get; }
    Property Value
    Type Description
    InputPortID
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023