KickPlayer

From Onset Developer Wiki
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
KickPlayer

Type: Function
Context: Server
Introduced: v1.0

Description

Kicks (disconnect) a player with a reason, colors are not supported.

Syntax

KickPlayer(player, reason)

Parameters

  • player
    The player identifier.
  • reason
    The reason

Return Value

  • This function doesn't have a return value.

Example

AddCommand("kick", function(playerid, lookupid)

    if lookupid == nil then
        return AddPlayerChat(playerid, "Usage: /kick <lookupid>")
    end

    if not IsValidPlayer(lookupid) then
        return AddPlayerChat(playerid, "The playerid you have inserted is invalid.")
    end

    KickPlayer(lookupid, "Kicked by "..GetPlayerName(playerid)..".")
end)

See also

Retrieved from "https://dev.playonset.com/index.php?title=KickPlayer&oldid=4990"