docs.unity3d.com
    Show / Hide Table of Contents

    Struct PhysicsWorldIndex

    Shared component for entities that belong to a physics world. Default physics world is built in BuildPhysicsWorld, from entities that have Value of 0.

    Inherited Members
    ValueType.Equals(Object)
    ValueType.ToString()
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Namespace: Unity.Physics
    Syntax
    public struct PhysicsWorldIndex : ISharedComponentData, IQueryTypeParameter, IEquatable<PhysicsWorldIndex>

    Constructors

    PhysicsWorldIndex(UInt32)

    Constructor taking the physics world index, with default value of 0 (used for default physics world).

    Declaration
    public PhysicsWorldIndex(uint worldIndex = 0U)
    Parameters
    Type Name Description
    UInt32 worldIndex

    (Optional) Zero-based index of the world.

    Fields

    Value

    Index of the physics world that this entity belongs to.

    Declaration
    public uint Value
    Field Value
    Type Description
    UInt32

    Methods

    Equals(PhysicsWorldIndex)

    Tests if this PhysicsWorldIndex is considered equal to another.

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

    The physics world index to compare to this object.

    Returns
    Type Description
    Boolean

    True if the objects are considered equal, false if they are not.

    Implements
    IEquatable<T>.Equals(T)

    GetHashCode()

    Calculates a hash code for this object.

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    Int32

    A hash code for this object.

    Overrides
    ValueType.GetHashCode()
    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