Struct IConsoleComponent

Namespace

SampSharp.OpenMp.Core.Api

Assembly

SampSharp.OpenMp.Core.dll

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

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

Implements

IEquatable<IConsoleComponent>

IConsoleComponent.IManagedInterface

IComponent.IManagedInterface

IUnmanagedInterface

Inherited Members

ValueType.ToString()

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

IConsoleComponent(nint)

Initializes a new instance of the IConsoleComponent struct.

public IConsoleComponent(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(IConsoleComponent)

public bool Equals(IConsoleComponent other)

Parameters

other IConsoleComponent

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 console-related events.

public IEventDispatcher<IConsoleEventHandler> GetEventDispatcher()

Returns

IEventDispatcher<IConsoleEventHandler>

The event dispatcher instance.

GetHashCode()

public override int GetHashCode()

Returns

int

Send(string, ref ConsoleCommandSenderData)

Sends a command from a console source.

public void Send(string command, ref ConsoleCommandSenderData sender)

Parameters

command string

The command to send.

sender ConsoleCommandSenderData

Information about the command sender.

SendMessage(ref ConsoleCommandSenderData, string)

Sends a message to a console recipient.

public void SendMessage(ref ConsoleCommandSenderData recipient, string message)

Parameters

recipient ConsoleCommandSenderData

Information about the message recipient.

message string

The message to send.

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

Determines whether the specified values are equal.

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

Parameters

lhs IConsoleComponent

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

Casts the IComponent to a IConsoleComponent.

public static explicit operator IConsoleComponent(IComponent value)

Parameters

value IComponent

The IComponent to cast.

Returns

IConsoleComponent

The converted IConsoleComponent.

explicit operator IComponent(IConsoleComponent)

Casts the IConsoleComponent to a IComponent.

public static explicit operator IComponent(IConsoleComponent value)

Parameters

value IConsoleComponent

The IConsoleComponent to cast.

Returns

IComponent

The converted IComponent.

operator !=(IConsoleComponent, object?)

Determines whether the specified values are not equal.

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

Parameters

lhs IConsoleComponent

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.