Struct IPlayerFixesData

Namespace

SampSharp.OpenMp.Core.Api

Assembly

SampSharp.OpenMp.Core.dll

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

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

Implements

IEquatable<IPlayerFixesData>

IPlayerFixesData.IManagedInterface

IExtension.IManagedInterface

IUnmanagedInterface

Inherited Members

ValueType.ToString()

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

IPlayerFixesData(nint)

Initializes a new instance of the IPlayerFixesData struct.

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

ApplyAnimation(IPlayer, IActor, AnimationData)

Applies an animation to the player or actor.

public void ApplyAnimation(IPlayer player, IActor actor, AnimationData animation)

Parameters

player IPlayer

The player to apply the animation to.

actor IActor

The actor to apply the animation to.

animation AnimationData

The animation data to apply.

Equals(IPlayerFixesData)

public bool Equals(IPlayerFixesData other)

Parameters

other IPlayerFixesData

Returns

bool

Equals(object?)

public override bool Equals(object? other)

Parameters

other object

Returns

bool

GetGameText(int, out string?, out TimeSpan, out TimeSpan)

Gets information about the game text at the specified style/slot.

public bool GetGameText(int style, out string? message, out TimeSpan time, out TimeSpan remaining)

Parameters

style int

The display style/slot to query.

message string

When the method returns, contains the message text.

time TimeSpan

When the method returns, contains the total display time.

remaining TimeSpan

When the method returns, contains the remaining display time.

Returns

bool

true if information was retrieved successfully; otherwise, false.

GetHashCode()

public override int GetHashCode()

Returns

int

HasGameText(int)

Checks if the player has active game text at the specified style/slot.

public bool HasGameText(int style)

Parameters

style int

The display style/slot to check.

Returns

bool

true if there is active game text at that slot; otherwise, false.

HideGameText(int)

Hides game text for the player.

public bool HideGameText(int style)

Parameters

style int

The display style/slot to hide.

Returns

bool

true if successful; otherwise, false.

SendGameText(string, TimeSpan, int)

Sends game text to the player.

public bool SendGameText(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.

Operators

operator ==(IPlayerFixesData, object?)

Determines whether the specified values are equal.

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

Parameters

lhs IPlayerFixesData

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 IPlayerFixesData(IExtension)

Casts the IExtension to a IPlayerFixesData.

public static explicit operator IPlayerFixesData(IExtension value)

Parameters

value IExtension

The IExtension to cast.

Returns

IPlayerFixesData

The converted IPlayerFixesData.

explicit operator IExtension(IPlayerFixesData)

Casts the IPlayerFixesData to a IExtension.

public static explicit operator IExtension(IPlayerFixesData value)

Parameters

value IPlayerFixesData

The IPlayerFixesData to cast.

Returns

IExtension

The converted IExtension.

operator !=(IPlayerFixesData, object?)

Determines whether the specified values are not equal.

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

Parameters

lhs IPlayerFixesData

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

ExtensionId

Gets the identifier of the extension type. IPool<T>

static UID ExtensionId { get; }

Returns

UID