GTA.Checkpoint Class Reference

Inheritance diagram for GTA.Checkpoint:

Public Member Functions
	Checkpoint (int handle)
override void	Delete ()
	Removes this Checkpoint. More...
override bool	Exists ()
	Determines if this Checkpoint exists. More...
override bool	Equals (object obj)
	Determines if an object refers to the same checkpoint as this Checkpoint. More...
override int	GetHashCode ()

Static Public Member Functions
static bool	operator== (Checkpoint left, Checkpoint right)
	Determines if two Checkpoints refer to the same checkpoint. More...
static bool	operator!= (Checkpoint left, Checkpoint right)
	Determines if two Checkpoints don't refer to the same checkpoint. More...
static implicit	operator InputArgument (Checkpoint value)
	Converts a Checkpoint to a native input argument. More...

Public Attributes
IntPtr	MemoryAddress => SHVDN.NativeMemory.GetCheckpointAddress(Handle)
	Gets the memory address of this Checkpoint. More...

Properties
Vector3	Position [get, set]
	Gets or sets the position of this Checkpoint. More...
Vector3	TargetPosition [get, set]
	Gets or sets the position where this Checkpoint points to. More...
CheckpointIcon	Icon [get, set]
	Gets or sets the icon drawn in this Checkpoint. More...
CheckpointCustomIcon	CustomIcon [get, set]
	Gets or sets a custom icon to be drawn in this Checkpoint. More...
float	Radius [get, set]
	Gets or sets the radius of this Checkpoint. More...
System.Drawing.Color	Color [get, set]
	Gets or sets the color of this Checkpoint. More...
System.Drawing.Color	IconColor [get, set]
	Gets or sets the color of the icon in this Checkpoint. More...
float	CylinderRadius [get, set]
	Gets or sets the radius of the cylinder in this Checkpoint. More...
float	CylinderNearHeight [get, set]
	Gets or sets the near height of the cylinder of this Checkpoint. More...
float	CylinderFarHeight [get, set]
	Gets or sets the far height of the cylinder of this Checkpoint. More...
Properties inherited from GTA.PoolObject
int	Handle [get, protected set]
	The handle of the object. More...
ulong	NativeValue [get, set]
	The handle of the object translated to a native value. More...
Properties inherited from GTA.Native.INativeValue
ulong	NativeValue [get, set]

Additional Inherited Members
Protected Member Functions inherited from GTA.PoolObject
	PoolObject (int handle)

Constructor & Destructor Documentation

Checkpoint()

GTA.Checkpoint.Checkpoint

(

int

handle

)

Member Function Documentation

Delete()

override void GTA.Checkpoint.Delete ( )

virtual

Removes this Checkpoint.

Implements GTA.PoolObject.

Equals()

override bool GTA.Checkpoint.Equals

(

object

obj

)

Determines if an object refers to the same checkpoint as this Checkpoint.

Parameters

obj	The object to check.

Returns

true if the obj is the same checkpoint as this Checkpoint; otherwise, false.

Exists()

override bool GTA.Checkpoint.Exists ( )

virtual

Determines if this Checkpoint exists.

Returns

true if this Checkpoint exists; otherwise, false.

Implements GTA.PoolObject.

GetHashCode()

override int GTA.Checkpoint.GetHashCode

(

)

operator InputArgument()

static implicit GTA.Checkpoint.operator InputArgument ( Checkpoint  value )

static

Converts a Checkpoint to a native input argument.

operator!=()

static bool GTA.Checkpoint.operator!= ( Checkpoint  left, Checkpoint  right  )

static

Determines if two Checkpoints don't refer to the same checkpoint.

Parameters

left	The left Checkpoint.
right	The right Checkpoint.

Returns

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

operator==()

static bool GTA.Checkpoint.operator== ( Checkpoint  left, Checkpoint  right  )

static

Determines if two Checkpoints refer to the same checkpoint.

Parameters

left	The left Checkpoint.
right	The right Checkpoint.

Returns

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

Member Data Documentation

MemoryAddress

IntPtr GTA.Checkpoint.MemoryAddress => SHVDN.NativeMemory.GetCheckpointAddress(Handle)

Gets the memory address of this Checkpoint.

Property Documentation

Color

System.Drawing.Color GTA.Checkpoint.Color

getset

Gets or sets the color of this Checkpoint.

CustomIcon

CheckpointCustomIcon GTA.Checkpoint.CustomIcon

getset

Gets or sets a custom icon to be drawn in this Checkpoint.

CylinderFarHeight

float GTA.Checkpoint.CylinderFarHeight

getset

Gets or sets the far height of the cylinder of this Checkpoint.

CylinderNearHeight

float GTA.Checkpoint.CylinderNearHeight

getset

Gets or sets the near height of the cylinder of this Checkpoint.

CylinderRadius

float GTA.Checkpoint.CylinderRadius

getset

Gets or sets the radius of the cylinder in this Checkpoint.

Icon

CheckpointIcon GTA.Checkpoint.Icon

getset

Gets or sets the icon drawn in this Checkpoint.

IconColor

System.Drawing.Color GTA.Checkpoint.IconColor

getset

Gets or sets the color of the icon in this Checkpoint.

Position

Vector3 GTA.Checkpoint.Position

getset

Gets or sets the position of this Checkpoint.

Radius

float GTA.Checkpoint.Radius

getset

Gets or sets the radius of this Checkpoint.

TargetPosition

Vector3 GTA.Checkpoint.TargetPosition

getset

Gets or sets the position where this Checkpoint points to.

---

The documentation for this class was generated from the following file:

• C:/Users/nitan/source/repos/scripthookvdotnet/source/scripting_v3/GTA/Checkpoint.cs