KickPlayer: Difference between revisions

From Onset Developer Wiki
← Older editNewer edit →
28days (talk | contribs)
833 edits
No edit summary
No edit summary
Line 28: Line 28:


{{RelatedFunctions}}
{{RelatedFunctions}}
{{PlayerEvents}}
{{ServerPlayerFunctions}}

Revision as of 20:41, 27 May 2021

KickPlayer

Type: Function
Context: Server
Introduced: v1.0

Description

Kicks 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=4778"