Search Results for

    Show / Hide Table of Contents

    Class InteriorInstance

    Inheritance
    Object
    InteriorInstance
    Implements
    IExistable
    Inherited Members
    Object.ToString()
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: GTA
    Assembly: ScriptHookVDotNet3.dll
    Syntax
    public class InteriorInstance : IExistable

    Properties

    | Improve this Doc View Source

    Handle

    The handle of this Building. This property is provided mainly for safer instance handling, but this is also used for equality comparison.

    Declaration
    public int Handle { get; }
    Property Value
    Type Description
    Int32
    | Improve this Doc View Source

    InteriorProxy

    Gets the InteriorProxy this InteriorInstance is loaded from.

    Declaration
    public InteriorProxy InteriorProxy { get; }
    Property Value
    Type Description
    InteriorProxy
    Remarks

    returns null if this InteriorInstance does not exist or SHVDN could not find the InteriorProxy pool for some reason.

    | Improve this Doc View Source

    Matrix

    Gets this InteriorInstances matrix which stores position and rotation information.

    Declaration
    public Matrix Matrix { get; }
    Property Value
    Type Description
    Matrix
    | Improve this Doc View Source

    MemoryAddress

    Gets the memory address where the InteriorInstance is stored in memory.

    Declaration
    public IntPtr MemoryAddress { get; }
    Property Value
    Type Description
    IntPtr
    | Improve this Doc View Source

    Model

    Gets the model of this InteriorInstance.

    Declaration
    public Model Model { get; }
    Property Value
    Type Description
    Model
    | Improve this Doc View Source

    Position

    Gets or sets the position of this InteriorInstance.

    Declaration
    public Vector3 Position { get; }
    Property Value
    Type Description
    Vector3

    The position in world space.

    | Improve this Doc View Source

    Quaternion

    Gets the quaternion of this InteriorInstance.

    Declaration
    public Quaternion Quaternion { get; }
    Property Value
    Type Description
    Quaternion
    | Improve this Doc View Source

    Rotation

    Gets the rotation of this InteriorInstance.

    Declaration
    public Vector3 Rotation { get; }
    Property Value
    Type Description
    Vector3

    The yaw, pitch, roll rotation values in degree.

    Methods

    | Improve this Doc View Source

    Equals(Object)

    Determines if an Object refers to the same entity as this InteriorInstance.

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

    The Object to check.

    Returns
    Type Description
    Boolean

    true if the obj is the same entity as this InteriorInstance; otherwise, false.

    Overrides
    Object.Equals(Object)
    | Improve this Doc View Source

    Exists()

    Determines if this InteriorInstance exists.

    Declaration
    public bool Exists()
    Returns
    Type Description
    Boolean

    true if this InteriorInstance exists; otherwise, false.

    | Improve this Doc View Source

    FromHandle(Int32)

    Creates a new instance of an InteriorInstance from the given handle.

    Declaration
    public static InteriorInstance FromHandle(int handle)
    Parameters
    Type Name Description
    Int32 handle

    The interior instance handle.

    Returns
    Type Description
    InteriorInstance

    Returns a InteriorInstance if this handle corresponds to a InteriorInstance. Returns null if no InteriorInstance exists this the specified handle

    | Improve this Doc View Source

    GetHashCode()

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    Int32
    Overrides
    Object.GetHashCode()

    Operators

    | Improve this Doc View Source

    Equality(InteriorInstance, InteriorInstance)

    Determines if two InteriorInstances refer to the same entity.

    Declaration
    public static bool operator ==(InteriorInstance left, InteriorInstance right)
    Parameters
    Type Name Description
    InteriorInstance left

    The left InteriorInstance.

    InteriorInstance right

    The right InteriorInstance.

    Returns
    Type Description
    Boolean

    true if left is the same entity as right; otherwise, false.

    | Improve this Doc View Source

    Inequality(InteriorInstance, InteriorInstance)

    Determines if two InteriorInstances don't refer to the same entity.

    Declaration
    public static bool operator !=(InteriorInstance left, InteriorInstance right)
    Parameters
    Type Name Description
    InteriorInstance left

    The left InteriorInstance.

    InteriorInstance right

    The right InteriorInstance.

    Returns
    Type Description
    Boolean

    true if left is not the same entity as right; otherwise, false.

    Implements

    IExistable
    • Improve this Doc
    • View Source
    In This Article
    Back to top Generated by DocFX