Search Results for

    Show / Hide Table of Contents

    Class Checkpoint

    Inheritance
    Object
    PoolObject
    Checkpoint
    Implements
    INativeValue
    IDeletable
    IExistable
    Inherited Members
    PoolObject.Handle
    PoolObject.NativeValue
    Object.ToString()
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: GTA
    Assembly: ScriptHookVDotNet3.dll
    Syntax
    public sealed class Checkpoint : PoolObject, INativeValue, IDeletable, IExistable

    Constructors

    | Improve this Doc View Source

    Checkpoint(Int32)

    Declaration
    public Checkpoint(int handle)
    Parameters
    Type Name Description
    Int32 handle

    Properties

    | Improve this Doc View Source

    Color

    Gets or sets the color of this Checkpoint.

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

    CustomIcon

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

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

    CylinderFarHeight

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

    Declaration
    public float CylinderFarHeight { get; set; }
    Property Value
    Type Description
    Single
    | Improve this Doc View Source

    CylinderNearHeight

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

    Declaration
    public float CylinderNearHeight { get; set; }
    Property Value
    Type Description
    Single
    | Improve this Doc View Source

    CylinderRadius

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

    Declaration
    public float CylinderRadius { get; set; }
    Property Value
    Type Description
    Single
    | Improve this Doc View Source

    Icon

    Gets or sets the icon drawn in this Checkpoint.

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

    IconColor

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

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

    MemoryAddress

    Gets the memory address of this Checkpoint.

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

    Position

    Gets or sets the position of this Checkpoint.

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

    Radius

    Gets or sets the radius of this Checkpoint.

    Declaration
    public float Radius { get; set; }
    Property Value
    Type Description
    Single
    | Improve this Doc View Source

    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 Source

    Delete()

    Removes this Checkpoint.

    Declaration
    public override void Delete()
    Overrides
    PoolObject.Delete()
    | Improve this Doc View Source

    Equals(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 obj is the same checkpoint as this Checkpoint; otherwise, false.

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

    Exists()

    Determines if this Checkpoint exists.

    Declaration
    public override bool Exists()
    Returns
    Type Description
    Boolean

    true if this Checkpoint exists; otherwise, false.

    Overrides
    PoolObject.Exists()
    | 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(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 left is the same checkpoint as right; otherwise, false.

    | Improve this Doc View Source

    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
    | Improve this Doc View Source

    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 left is not the same checkpoint as right; otherwise, false.

    Implements

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