docs.unity3d.com
    Show / Hide Table of Contents

    Class Message

    An object passed in a message queue.

    Inheritance
    Object
    Message
    Inherited Members
    Object.ToString()
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: Unity.AppUI.Core
    Syntax
    public class Message

    Properties

    arg1

    An arbitrary integer value to attach with the message.

    Declaration
    public int arg1 { get; }
    Property Value
    Type Description
    Int32

    obj

    An arbitrary object to attach with the message.

    Declaration
    public object obj { get; }
    Property Value
    Type Description
    Object

    target

    The Handler instance which has obtained this message.

    Declaration
    public Handler target { get; }
    Property Value
    Type Description
    Handler

    what

    The message ID.

    Declaration
    public int what { get; }
    Property Value
    Type Description
    Int32

    Methods

    Obtain(Handler, Int32, Int32, Object)

    Obtain a message from the pool with pre specified properties.

    Declaration
    public static Message Obtain(Handler handler, int id, int arg1, object obj)
    Parameters
    Type Name Description
    Handler handler

    The target.

    Int32 id

    The message ID.

    Int32 arg1

    An arbitrary integer value.

    Object obj

    An arbitrary object.

    Returns
    Type Description
    Message

    The message.

    Obtain(Handler, Int32, Object)

    Obtain a message from the pool with pre specified properties.

    Declaration
    public static Message Obtain(Handler handler, int id, object obj)
    Parameters
    Type Name Description
    Handler handler

    The target.

    Int32 id

    The message ID.

    Object obj

    An arbitrary object.

    Returns
    Type Description
    Message

    The message.

    Recycle()

    Recycle this message and put if back into the pool.

    Declaration
    public void Recycle()
    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