Class Checkpoint
Inherited Members
Namespace: GTA
Assembly: ScriptHookVDotNet3.dll
Syntax
public sealed class Checkpoint : PoolObject, INativeValue, IDeletable, IExistable
Constructors
| Improve this Doc View SourceCheckpoint(Int32)
Declaration
public Checkpoint(int handle)
Parameters
Type | Name | Description |
---|---|---|
Int32 | handle |
Properties
| Improve this Doc View SourceColor
Gets or sets the color of this Checkpoint.
Declaration
public Color Color { get; set; }
Property Value
Type | Description |
---|---|
Color |
CustomIcon
Gets or sets a custom icon to be drawn in this Checkpoint.
Declaration
public CheckpointCustomIcon CustomIcon { get; set; }
Property Value
Type | Description |
---|---|
CheckpointCustomIcon |
CylinderFarHeight
Gets or sets the far height of the cylinder of this Checkpoint.
Declaration
public float CylinderFarHeight { get; set; }
Property Value
Type | Description |
---|---|
Single |
CylinderNearHeight
Gets or sets the near height of the cylinder of this Checkpoint.
Declaration
public float CylinderNearHeight { get; set; }
Property Value
Type | Description |
---|---|
Single |
CylinderRadius
Gets or sets the radius of the cylinder in this Checkpoint.
Declaration
public float CylinderRadius { get; set; }
Property Value
Type | Description |
---|---|
Single |
Icon
Gets or sets the icon drawn in this Checkpoint.
Declaration
public CheckpointIcon Icon { get; set; }
Property Value
Type | Description |
---|---|
CheckpointIcon |
IconColor
Gets or sets the color of the icon in this Checkpoint.
Declaration
public Color IconColor { get; set; }
Property Value
Type | Description |
---|---|
Color |
MemoryAddress
Gets the memory address of this Checkpoint.
Declaration
public IntPtr MemoryAddress { get; }
Property Value
Type | Description |
---|---|
IntPtr |
Position
Gets or sets the position of this Checkpoint.
Declaration
public Vector3 Position { get; set; }
Property Value
Type | Description |
---|---|
Vector3 |
Radius
Gets or sets the radius of this Checkpoint.
Declaration
public float Radius { get; set; }
Property Value
Type | Description |
---|---|
Single |
TargetPosition
Gets or sets the position where this Checkpoint points to.
Declaration
public Vector3 TargetPosition { get; set; }
Property Value
Type | Description |
---|---|
Vector3 |
Methods
| Improve this Doc View SourceDelete()
Removes this Checkpoint.
Declaration
public override void Delete()
Overrides
| Improve this Doc View SourceEquals(Object)
Determines if an Object refers to the same checkpoint as this Checkpoint.
Declaration
public override bool Equals(object obj)
Parameters
Type | Name | Description |
---|---|---|
Object | obj | The Object to check. |
Returns
Type | Description |
---|---|
Boolean | true if the |
Overrides
| Improve this Doc View SourceExists()
Determines if this Checkpoint exists.
Declaration
public override bool Exists()
Returns
Type | Description |
---|---|
Boolean | true if this Checkpoint exists; otherwise, false. |
Overrides
| Improve this Doc View SourceGetHashCode()
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
Int32 |
Overrides
Operators
| Improve this Doc View SourceEquality(Checkpoint, Checkpoint)
Determines if two Checkpoints refer to the same checkpoint.
Declaration
public static bool operator ==(Checkpoint left, Checkpoint right)
Parameters
Type | Name | Description |
---|---|---|
Checkpoint | left | The left Checkpoint. |
Checkpoint | right | The right Checkpoint. |
Returns
Type | Description |
---|---|
Boolean | true if |
Implicit(Checkpoint to InputArgument)
Converts a Checkpoint to a native input argument.
Declaration
public static implicit operator InputArgument(Checkpoint value)
Parameters
Type | Name | Description |
---|---|---|
Checkpoint | value |
Returns
Type | Description |
---|---|
InputArgument |
Inequality(Checkpoint, Checkpoint)
Determines if two Checkpoints don't refer to the same checkpoint.
Declaration
public static bool operator !=(Checkpoint left, Checkpoint right)
Parameters
Type | Name | Description |
---|---|---|
Checkpoint | left | The left Checkpoint. |
Checkpoint | right | The right Checkpoint. |
Returns
Type | Description |
---|---|
Boolean | true if |