OOB commands

From ioquake3 wiki
Jump to navigation Jump to search

Commands sent by client

connect
sent to server from {{#ifexist:CL_CheckForResend|CL_CheckForResend()|CL_CheckForResend()}} in order to acknowledge server's connection challenge. When the server receives this command and accepts the connection, it will send a connectResponse message back to the client and will will send netchan messages to client from then on.
getchallenge
sent to server from {{#ifexist:CL_CheckForResend|CL_CheckForResend()|CL_CheckForResend()}} in order to ask server to send back a connection challenge.
getinfo
sent to server from {{#ifexist:CL_Ping_f|CL_Ping_f()|CL_Ping_f()}} and {{#ifexist:CL_UpdateVisiblePings_f|CL_UpdateVisiblePings_f()|CL_UpdateVisiblePings_f()}} in order to query the server's info.
getKeyAuthorize
sent to AUTHORIZE_SERVER_NAME ("authorize.quake3arena.com") from {{#ifexist:CL_RequestAuthorization|CL_RequestAuthorization()|CL_RequestAuthorization()}} in order to authorize its CD key. When a client requests a connection to a server, the server will send an getIpAuthorize command to AUTHORIZE_SERVER_NAME. The server will accept the client if a valid CD key was sent to the authorize server by that client in the last 15 minutes. (If no response is received from the authorize server after two tries, the client will be let in anyway.)
getmotd
sent to UPDATE_SERVER_NAME ("update.quake3arena.com") from {{#ifexist:CL_RequestMotd|CL_RequestMotd()|CL_RequestMotd()}} in order to ask for software update messages from id.
getservers
sent to MASTER_SERVER_NAME ("master.quake3arena.com") from {{#ifexist:CL_GlobalServers_f|CL_GlobalServers_f()|CL_GlobalServers_f()}} in order to request a list of open servers.
getstatus
sent to server from {{#ifexist:CL_ServerStatus|CL_ServerStatus()|CL_ServerStatus()}} and {{#ifexist:CL_ServerStatus_f|CL_ServerStatus_f()|CL_ServerStatus_f()}} in order to query the server's status.

Commands sent by server

banUser
sent to AUTHORIZE_SERVER_NAME ("authorize.quake3arena.com") from {{#ifexist:SV_Ban_f|SV_Ban_f()|SV_Ban_f()}} and {{#ifexist:SV_BanNum_f|SV_BanNum_f()|SV_BanNum_f()}} in order to ban a user from being able to play on the server through the auth server.
challengeResponse
sent to client from {{#ifexist:SV_GetChallenge|SV_GetChallenge()|SV_GetChallenge()}} and {{#ifexist:SV_AuthorizeIpPacket|SV_AuthorizeIpPacket()|SV_AuthorizeIpPacket()}} in response to client's getchallenge message. If the client successfully authenticates with the auth server, this message is sent to the client with a randomly generated challenge key. The client must then respond with this key in its {{#ifexist:connect|connect()|connect()}} message in order to successfully connect.
connectResponse
sent to client from {{#ifexist:SV_DirectConnect|SV_DirectConnect()|SV_DirectConnect()}} to notify it that its connect command was accepted.
disconnect
sent to an unknown client from {{#ifexist:SV_PacketEvent|SV_PacketEvent()|SV_PacketEvent()}} when the server receives a Netchan message from a client that is not connected.
getIpAuthorize
sent to AUTHORIZE_SERVER_NAME ("authorize.quake3arena.com") from {{#ifexist:SV_GetChallenge|SV_GetChallenge()|SV_GetChallenge()}} in order to authorize a client's CD key. The server will accept the client only if the client sent a getKeyAuthorize message with a valid CD key to the authorize server in the last 15 minutes. (If no response is received from the authorize server after two tries, the client will be let in anyway.)
heartbeat
sent to master servers from {{#ifexist:SV_MasterHeartbeat|SV_MasterHeartbeat()|SV_MasterHeartbeat()}} to update the master servers about the server's current status. The master servers include MASTER_SERVER_NAME ("master.quake3arena.com") and/or whatever is listed in sv_master1, sv_master2, sv_master3, sv_master4, and sv_master5.
infoResponse
sent to client from {{#ifexist:SVC_Info|SVC_Info()|SVC_Info()}} in response to client's getinfo command.
print
sent to client from {{#ifexist:SV_DirectConnect|SV_DirectConnect()|SV_DirectConnect()}} and {{#ifexist:SV_AuthorizeIpPacket|SV_AuthorizeIpPacket()|SV_AuthorizeIpPacket()}} in order to print a console message notifying the user why his connection isn't accepted. Also sent by {{#ifexist:SV_FlushRedirect|SV_FlushRedirect()|SV_FlushRedirect()}} on the behest of {{#ifexist:SVC_RemoteCommand|SVC_RemoteCommand()|SVC_RemoteCommand()}} in order to redirect console output to a remote console.
statusResponse
sent to client from {{#ifexist:SVC_Status|SVC_Status()|SVC_Status()}} in response to client's getstatus command.

See also