dreamworkAPI
Ctrl K
GitHub
typeDocs / server / QueryData

server.QueryData

typemenusource

Queries the servers for it's information.

Fields

NameTypeDescription
directorystringThe game directory to get the servers for = "garrysmod"
typestringType of servers to retrieve. Valid values are internet, favorite, history and lan
appidnumberSteam application ID to get the servers for = 4000
query_failedfunctionCalled if the query has failed, called with the servers IP Address
finishedfunctionCalled when the query is finished. No arguments

Static functions

#server.QueryData.server_queried

function server.QueryData.server_queried(info: server.Info): boolean?

Called when a new server is found and queried.

Function argument(s):

  • server.Info info - The information of the queried server.

Function return value(s):

  • boolean stop - Return false to stop the query.
Parameters
NameTypeDescription
infoserver.Info
Returns
TypeNameDescription
boolean?
Generated from the dreamwork meta branch.