plugins/include/clients.inc
changeset 992 77133031b0d2
parent 901 db978c2819e6
child 996 378358b53fd5
     1.1 --- a/plugins/include/clients.inc	Wed Jun 20 11:03:06 2007 +0000
     1.2 +++ b/plugins/include/clients.inc	Wed Jun 20 11:06:58 2007 +0000
     1.3 @@ -494,3 +494,15 @@
     1.4   * @error				Returns 0 if invalid userid.
     1.5   */
     1.6  native GetClientOfUserId(userid);
     1.7 +
     1.8 +/**
     1.9 + * Disconnects a client from the server.
    1.10 + *
    1.11 + * @param client		Client index.
    1.12 + * @param format		Optional formatting rules for disconnect reason.
    1.13 + *                      Note that a period is automatically appended to the string by the engine.
    1.14 + * @param ...			Variable number of format parameters.
    1.15 + * @noreturn
    1.16 + * @error				Invalid client index, or client not connected.
    1.17 + */
    1.18 +native DisconnectClient(client, const String:format[]="", any:...);