Struct ObjectId | AI Planner | 0.2.4-preview.3
docs.unity3d.com
    Show / Hide Table of Contents

    Struct ObjectId

    A unique identifier assigned to each trait-based object within a state

    Namespace: Unity.AI.Planner.Traits
    Syntax
    public struct ObjectId : IEquatable<ObjectId>

    Fields

    None

    The reserved ObjectId value specifying a reference to no trait-based object

    Declaration
    public static readonly ObjectId None
    Field Value
    Type Description
    ObjectId

    Value

    Id Value

    Declaration
    public int Value
    Field Value
    Type Description
    Int32

    Methods

    Equals(Object)

    Test for equality

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    Object obj

    Other ObjectId

    Returns
    Type Description
    Boolean

    Result of equality test

    Overrides
    ValueType.Equals(Object)

    Equals(ObjectId)

    Compares an ObjectId to another ObjectId

    Declaration
    public bool Equals(ObjectId other)
    Parameters
    Type Name Description
    ObjectId other

    ObjectId for comparison

    Returns
    Type Description
    Boolean

    Returns true if the ObjectIds are equal

    GetHashCode()

    Get the hash code

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    Int32

    Hash code

    Overrides
    ValueType.GetHashCode()

    GetNext()

    Provides a new trait-based object with an unassigned Id

    Declaration
    public static ObjectId GetNext()
    Returns
    Type Description
    ObjectId

    Returns a new, unassigned Id

    ToString()

    Returns a string that represents the ObjectId

    Declaration
    public override string ToString()
    Returns
    Type Description
    String

    A string that represents the ObjectId

    Overrides
    ValueType.ToString()

    Operators

    Equality(ObjectId, ObjectId)

    Compares two given ObjectIds

    Declaration
    public static bool operator ==(ObjectId x, ObjectId y)
    Parameters
    Type Name Description
    ObjectId x

    An ObjectId

    ObjectId y

    An ObjectId

    Returns
    Type Description
    Boolean

    Returns if two TraitBasedObjectIds are equal

    Inequality(ObjectId, ObjectId)

    Compares two given ObjectIds

    Declaration
    public static bool operator !=(ObjectId x, ObjectId y)
    Parameters
    Type Name Description
    ObjectId x

    An ObjectId

    ObjectId y

    An ObjectId

    Returns
    Type Description
    Boolean

    Returns if two TraitBasedObjectIds are not equal

    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