Available functions

Connect(aHostname As String, aHostPort As Long, aHostType As String, aTimeOut As Integer)

Connect to a certain game server. Besides the server's ip address and port you also have to pass the server's gametype and a timeout.
The server's type can be 'QUAKEWORLD', 'QUAKE2', 'QUAKE3' or 'HALFLIFE' (no quotes).
The timeout specifies the amount of milliseconds to wait before returning a time-out. If you're trying to connect to a server which isn't running, BrowserX will return a time-out after X milliseconds.

IsTimeOut(aTimeOut As Boolean)

This function is typically used right after connecting to a server. If aTimeOut is true than it means the server didn't respond in time.
A time-out doesn't always mean the server is down but it can just be that the server's reply got lost in the electronic traffic. It's always a good idea to retry to connect to the server a few times to make sure the server's actually down.

GetClientCount(aCount As Integer)

GetClientCount returns the amount of clients connected to the server. Usually this function is used to start an iteration that retrieves info about all the clients.

GetClientInfo(aIdx As Integer, aScore As String, aPing As String, aPlayername As String, aColorCodeName As String)

Every client has it's own properties: a name, a score and a ping.
Since QuakeWorld and Quake3 both allow FunNames to be used, BrowserX filters out the color-codes so the FunNames appear correctly. If for some reason you don't want the color-codes to be filtered out, you can retrieve the original name in 'aColorCodeName'. The not-color-coded name is stored in 'aPlayername'.
To get info about a certain player, all you need to do is pass it's index. This index has a value between zero and the amount of connected clients.

GetRulesCount(aCount As Integer)

GetRulesCount returns the amount of rules ( = server variables). Usually this function is used to start an iteration that retrieves info about all the rules.

GetRulesInfo(aCount As Integer, aVarName As String, aVarValue As String)

A rules consist of a variable name and a variable value
To get info about a certain rule, all you need to do is pass it's index. This index has a value between zero and the total amount of rules.

Quit()

If you're not querying any servers any more use the Quit function to close the ActiveX control.

Contact us

IncubusOne@hotmail.com

Upcoming features

-HalfLife support
-others...