Struct ICheckpointData

Namespace

SampSharp.OpenMp.Core.Api

Assembly

SampSharp.OpenMp.Core.dll

This type represents a pointer to an unmanaged open.mp ICheckpointData interface.

[OpenMpApi(new Type[] { typeof(ICheckpointDataBase) })]
public readonly struct ICheckpointData : IEquatable<ICheckpointData>, ICheckpointData.IManagedInterface, ICheckpointDataBase.IManagedInterface, IUnmanagedInterface

Implements

IEquatable<ICheckpointData>

ICheckpointData.IManagedInterface

ICheckpointDataBase.IManagedInterface

IUnmanagedInterface

Inherited Members

ValueType.ToString()

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

ICheckpointData(nint)

Initializes a new instance of the ICheckpointData struct.

public ICheckpointData(nint handle)

Parameters

handle nint

A pointer to the unmanaged interface.

Properties

Handle

Gets the handle to the unmanaged interface instance.

public nint Handle { get; }

Property Value

nint

HasValue

Gets a value indicating whether the pointer has a value.

public bool HasValue { get; }

Property Value

bool

Methods

Disable()

Disables this checkpoint.

public void Disable()

Enable()

Enables this checkpoint.

public void Enable()

Equals(ICheckpointData)

public bool Equals(ICheckpointData other)

Parameters

other ICheckpointData

Returns

bool

Equals(object?)

public override bool Equals(object? other)

Parameters

other object

Returns

bool

EtRadius()

Gets the radius of this checkpoint.

public float EtRadius()

Returns

float

The checkpoint radius.

GetHashCode()

public override int GetHashCode()

Returns

int

GetPosition()

Gets the position of this checkpoint.

public Vector3 GetPosition()

Returns

Vector3

The checkpoint position.

IsEnabled()

Checks whether this checkpoint is enabled.

public bool IsEnabled()

Returns

bool

true if the checkpoint is enabled; otherwise, false.

IsPlayerInside()

Checks whether the player is inside this checkpoint.

public bool IsPlayerInside()

Returns

bool

true if the player is inside the checkpoint; otherwise, false.

SetPlayerInside(bool)

Sets whether the player is inside this checkpoint.

public void SetPlayerInside(bool inside)

Parameters

inside bool

true to set the player as inside; false to set them as outside.

SetPosition(ref Vector3)

Sets the position of this checkpoint.

public void SetPosition(ref Vector3 position)

Parameters

position Vector3

The checkpoint position to set.

SetRadius(float)

Sets the radius of this checkpoint.

public void SetRadius(float radius)

Parameters

radius float

The checkpoint radius to set.

Operators

operator ==(ICheckpointData, object?)

Determines whether the specified values are equal.

public static bool operator ==(ICheckpointData lhs, object? rhs)

Parameters

lhs ICheckpointData

The value on the left side of the operator.

rhs object

The value on the right side of the operator.

Returns

bool

true if the values are equal; otherwise, false.

explicit operator ICheckpointDataBase(ICheckpointData)

Casts the ICheckpointData to a ICheckpointDataBase.

public static explicit operator ICheckpointDataBase(ICheckpointData value)

Parameters

value ICheckpointData

The ICheckpointData to cast.

Returns

ICheckpointDataBase

The converted ICheckpointDataBase.

explicit operator ICheckpointData(ICheckpointDataBase)

Casts the ICheckpointDataBase to a ICheckpointData.

public static explicit operator ICheckpointData(ICheckpointDataBase value)

Parameters

value ICheckpointDataBase

The ICheckpointDataBase to cast.

Returns

ICheckpointData

The converted ICheckpointData.

operator !=(ICheckpointData, object?)

Determines whether the specified values are not equal.

public static bool operator !=(ICheckpointData lhs, object? rhs)

Parameters

lhs ICheckpointData

The value on the left side of the operator.

rhs object

The value on the right side of the operator.

Returns

bool

true if the values are not equal; otherwise, false.