Struct IFixesComponent

Namespace

SampSharp.OpenMp.Core.Api

Assembly

SampSharp.OpenMp.Core.dll

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

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

Implements

IEquatable<IFixesComponent>

IFixesComponent.IManagedInterface

IComponent.IManagedInterface

IUnmanagedInterface

Inherited Members

ValueType.ToString()

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

IFixesComponent(nint)

Initializes a new instance of the IFixesComponent struct.

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

ClearAnimation(IPlayer, IActor)

Clears the current animation of a player or actor.

public void ClearAnimation(IPlayer player, IActor actor)

Parameters

player IPlayer

The player to clear animation for.

actor IActor

The actor to clear animation for.

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(IFixesComponent)

public bool Equals(IFixesComponent other)

Parameters

other IFixesComponent

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.

GetHashCode()

public override int GetHashCode()

Returns

int

HideGameTextForAll(int)

Hides game text for all players.

public bool HideGameTextForAll(int style)

Parameters

style int

The display style/slot to hide.

Returns

bool

true if successful; otherwise, false.

SendGameTextToAll(string, TimeSpan, int)

Sends game text to all players.

public bool SendGameTextToAll(string message, TimeSpan time, int style)

Parameters

message string

The message to display.

time TimeSpan

How long to display the message.

style int

The display style/slot for the game text.

Returns

bool

true if successful; otherwise, false.

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 ==(IFixesComponent, object?)

Determines whether the specified values are equal.

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

Parameters

lhs IFixesComponent

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

Casts the IComponent to a IFixesComponent.

public static explicit operator IFixesComponent(IComponent value)

Parameters

value IComponent

The IComponent to cast.

Returns

IFixesComponent

The converted IFixesComponent.

explicit operator IComponent(IFixesComponent)

Casts the IFixesComponent to a IComponent.

public static explicit operator IComponent(IFixesComponent value)

Parameters

value IFixesComponent

The IFixesComponent to cast.

Returns

IComponent

The converted IComponent.

operator !=(IFixesComponent, object?)

Determines whether the specified values are not equal.

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

Parameters

lhs IFixesComponent

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.