Class FiveM

Namespace

OpenGSQ.Protocols

Assembly

OpenGSQ.dll

FiveM Protocol (https://docs.fivem.net/docs/server-manual/proxy-setup/)

public class FiveM : ProtocolBase

Inheritance

object

ProtocolBase

FiveM

Inherited Members

ProtocolBase.Host

ProtocolBase.Port

ProtocolBase.Timeout

ProtocolBase.GetIPAddress()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

FiveM(string, int, int)

Initializes a new instance of the FiveM class.

public FiveM(string host, int port, int timeout = 5000)

Parameters

host string

The host to connect to.

port int

The port to connect to.

timeout int

The connection timeout in milliseconds. Default is 5 seconds.

Properties

FullName

Gets the full name of the protocol.

public override string FullName { get; }

Property Value

string

Methods

GetDynamic()

Asynchronously gets dynamic information from the server.

public Task<Dictionary<string, JsonElement>> GetDynamic()

Returns

Task<Dictionary<string, JsonElement>>

A task that represents the asynchronous operation. The task result contains the dynamic information.

GetInfo()

Asynchronously gets information about the server.

public Task<Dictionary<string, JsonElement>> GetInfo()

Returns

Task<Dictionary<string, JsonElement>>

A task that represents the asynchronous operation. The task result contains the server information.

GetPlayers()

Asynchronously gets the list of players from the server.

public Task<List<JsonElement>> GetPlayers()

Returns

Task<List<JsonElement>>

A task that represents the asynchronous operation. The task result contains the list of players.