Struct ICheckpointsComponent

Namespace

SampSharp.OpenMp.Core.Api

Assembly

SampSharp.OpenMp.Core.dll

This type represents a pointer to an unmanaged open.mp ICheckpointsComponent interface (the source of IPlayerCheckpointEventHandler events).

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

Implements

IEquatable<ICheckpointsComponent>

ICheckpointsComponent.IManagedInterface

IComponent.IManagedInterface

IUnmanagedInterface

Inherited Members

ValueType.ToString()

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

ICheckpointsComponent(nint)

Initializes a new instance of the ICheckpointsComponent struct.

public ICheckpointsComponent(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

ComponentName()

Gets the name of the component.

public string ComponentName()

Returns

string

The component name.

ComponentVersion()

Gets the version of the component.

public SemanticVersion ComponentVersion()

Returns

SemanticVersion

The component version.

Equals(ICheckpointsComponent)

public bool Equals(ICheckpointsComponent other)

Parameters

other ICheckpointsComponent

Returns

bool

Equals(object?)

public override bool Equals(object? other)

Parameters

other object

Returns

bool

GetComponentType()

Gets the type of the component.

public ComponentType GetComponentType()

Returns

ComponentType

The component type.

GetEventDispatcher()

Gets the event dispatcher for checkpoint enter/leave events.

public IEventDispatcher<IPlayerCheckpointEventHandler> GetEventDispatcher()

Returns

IEventDispatcher<IPlayerCheckpointEventHandler>

GetHashCode()

public override int GetHashCode()

Returns

int

SupportedVersion()

Gets the supported version of the component.

public int SupportedVersion()

Returns

int

The supported version of the component.

Remarks

The idea is for the SDK to be totally forward compatible, so code built at any time will always work, thanks to ABI compatibility. This method is an emergency trap door, just in case that's ever not the problem. Check which major version this component was built for, if it isn't the current major version, fail to load it. Always just returns a constant, recompiling will often be enough to upgrade. virtual and final to be the vtable, but it can't be overridden because it is a constant.

Operators

operator ==(ICheckpointsComponent, object?)

Determines whether the specified values are equal.

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

Parameters

lhs ICheckpointsComponent

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 IComponent(ICheckpointsComponent)

Casts the ICheckpointsComponent to a IComponent.

public static explicit operator IComponent(ICheckpointsComponent value)

Parameters

value ICheckpointsComponent

The ICheckpointsComponent to cast.

Returns

IComponent

The converted IComponent.

explicit operator ICheckpointsComponent(IComponent)

Casts the IComponent to a ICheckpointsComponent.

public static explicit operator ICheckpointsComponent(IComponent value)

Parameters

value IComponent

The IComponent to cast.

Returns

ICheckpointsComponent

The converted ICheckpointsComponent.

operator !=(ICheckpointsComponent, object?)

Determines whether the specified values are not equal.

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

Parameters

lhs ICheckpointsComponent

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.

Explicit Interface Implementations

ComponentId

Gets the identifier of the component type.

static UID ComponentId { get; }

Returns

UID

FromComponentHandle(nint)

Casts a handle from a IComponent handle to a handle of this type.

static nint FromComponentHandle(nint handle)

Parameters

handle nint

The IComponent handle.

Returns

nint

The handle of this type.