Class InteriorProxy

Inheritance

Object

InteriorProxy

Implements

INativeValue

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 InteriorProxy : INativeValue, IExistable

Properties

CurrentInteriorInstance

Gets the current InteriorInstance this InteriorProxy is using.

Declaration

public InteriorInstance CurrentInteriorInstance { get; }

Property Value

Type	Description
InteriorInstance

Remarks

returns null if this InteriorProxy is not using any InteriorInstance.

Handle

The handle of this InteriorProxy.

Declaration

public int Handle { get; }

Property Value

Type	Description
Int32

IsCapped

Gets a value indicating whether this InteriorProxy will only load a few elements of the interior. Doors can be loaded and the collision is not necessarily completely disabled (e.g. collisions for bullets and projectiles can work).

Declaration

public bool IsCapped { get; }

Property Value

Type	Description
Boolean	true if this InteriorProxy will only load a few elements of the interior; otherwise, false.

IsDisabled

Gets a value indicating whether this InteriorProxy will behave as if interior is not loaded completely.

Declaration

public bool IsDisabled { get; }

Property Value

Type	Description
Boolean	true if this InteriorProxy will behave as if interior is not loaded completely; otherwise, false.

MemoryAddress

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

Declaration

public IntPtr MemoryAddress { get; }

Property Value

Type	Description
IntPtr

Model

Gets the model this InteriorProxy will load.

Declaration

public Model Model { get; }

Property Value

Type	Description
Model

NativeValue

The handle of this InteriorProxy translated to a native value.

Declaration

public ulong NativeValue { get; set; }

Property Value

Type	Description
UInt64

Position

Gets or sets the position of this AnimatedBuilding.

Declaration

public Vector3 Position { get; }

Property Value

Type	Description
Vector3	The position in world space.

Methods

Cap(Boolean)

Caps the interior so this InteriorProxy will only load a few elements of the interior. Does nothing if the player Ped is in this InteriorProxy.

Declaration

public void Cap(bool toggle)

Parameters

Type	Name	Description
Boolean	toggle

Disable(Boolean)

Disables the interior, making InteriorProxy behave as if interior is not loaded completely. Does not prevent from having a InteriorInstance. Does nothing if the player Ped is in this InteriorProxy.

Declaration

public void Disable(bool toggle)

Parameters

Type	Name	Description
Boolean	toggle

Equals(Object)

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

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 InteriorProxy; otherwise, false.

Overrides

Object.Equals(Object)

Exists()

Determines if this InteriorProxy exists.

Declaration

public bool Exists()

Returns

Type	Description
Boolean	true if this InteriorProxy exists; otherwise, false.

FromHandle(Int32)

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

Declaration

public static InteriorProxy FromHandle(int handle)

Parameters

Type	Name	Description
Int32	handle	The interior proxy handle.

Returns

Type	Description
InteriorProxy	Returns a InteriorProxy if this handle corresponds to a InteriorProxy. Returns null if no Entity exists this the specified handle

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32

Overrides

Object.GetHashCode()

GetInteriorProxyAt(Vector3)

Declaration

public static InteriorProxy GetInteriorProxyAt(Vector3 position)

Parameters

Type	Name	Description
Vector3	position

Returns

Type	Description
InteriorProxy

GetInteriorProxyFromGameplayCam()

Gets the InteriorProxy if the gameplay camera is in a interior.

Declaration

public static InteriorProxy GetInteriorProxyFromGameplayCam()

Returns

Type	Description
InteriorProxy

Remarks

returns null if the gameplay camera is not in any interior space.

PinInMemory()

Makes this InteriorProxy keep the InteriorProxy this InteriorProxy is loaded.

Declaration

public void PinInMemory()

Refresh()

Refreshs the current InteriorInstance if loaded. Does not change the memory address or handle of the InteriorInstance.

Declaration

public void Refresh()

UnpinFromMemory()

Lets this InteriorProxy free the InteriorProxy this InteriorProxy is loaded.

Declaration

public void UnpinFromMemory()

Operators

Equality(InteriorProxy, InteriorProxy)

Determines if two InteriorProxys refer to the same entity.

Declaration

public static bool operator ==(InteriorProxy left, InteriorProxy right)

Parameters

Type	Name	Description
InteriorProxy	left	The left InteriorProxy.
InteriorProxy	right	The right InteriorProxy.

Returns

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

Implicit(InteriorProxy to InputArgument)

Converts an Entity to a native input argument.

Declaration

public static implicit operator InputArgument(InteriorProxy value)

Parameters

Type	Name	Description
InteriorProxy	value

Returns

Type	Description
InputArgument

Inequality(InteriorProxy, InteriorProxy)

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

Declaration

public static bool operator !=(InteriorProxy left, InteriorProxy right)

Parameters

Type	Name	Description
InteriorProxy	left	The left Entity.
InteriorProxy	right	The right Entity.

Returns

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

Implements

INativeValue

IExistable