Fixed return value descriptions.
This commit is contained in:
parent
990a467eb4
commit
57e83f7d49
@ -17,7 +17,9 @@ return
|
|||||||
{ Name = "Favicon", Type = "string", Notes = "The base64 encoded favicon to be displayed in the server list for compatible clients" },
|
{ Name = "Favicon", Type = "string", Notes = "The base64 encoded favicon to be displayed in the server list for compatible clients" },
|
||||||
},
|
},
|
||||||
Returns = [[
|
Returns = [[
|
||||||
The plugin may return a boolean.
|
The plugin returns <code>res, ServerDescription, OnlinePlayersCount, MaxPlayersCount, Favicon</code>.
|
||||||
|
res is a boolean which stops other plugins being notified of the ping if it's set to true, and the others
|
||||||
|
are the same as the arguments, and if emitted change the values transmitted to the client.
|
||||||
]],
|
]],
|
||||||
}, -- HOOK_SERVER_PING
|
}, -- HOOK_SERVER_PING
|
||||||
}
|
}
|
||||||
|
Loading…
Reference in New Issue
Block a user