Scripting/Squirrel/Functions/KickPlayer: Difference between revisions
Jump to navigation
Jump to search
This wiki is using an old backup from 2020
Some information may be old/missing
No edit summary |
|||
| (11 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
This function disconnects a client from the server, aka kick a player. | |||
== Syntax == | == Syntax == | ||
<pre>KickPlayer( player )</pre> | <pre>KickPlayer( player )</pre> | ||
== Arguments == | |||
* ''CPlayer'' '''player''' - the player you are going to kick. | |||
== Example == | == Example == | ||
This example shows how to create a command to kick players. | |||
<source lang=squirrel> | <source lang=squirrel> | ||
function onPlayerCommand( player, cmd, text ); | function onPlayerCommand( player, cmd, text ); | ||
if ( cmd == "kick" ) | { | ||
if ( cmd == "kick" ) | |||
if ( player.Name == " | { | ||
if ( player.Name == "Noob69" || player.Name == "Antonio_Morales" ) //This players can execute the command. | |||
{ | { | ||
if ( text ) | |||
{ | { | ||
local plr = FindPlayer( text ); | |||
if ( plr ) | |||
{ | |||
KickPlayer( plr ); | |||
} | |||
else MessagePlayer( "Cannot find player "+text+"." , player ); | |||
} | |||
else MessagePlayer( "Usage: /"+cmd+" <player>" , player ); | |||
} | |||
else MessagePlayer( "You are not allowed to use this command." , player ) | |||
} | } | ||
} | |||
</source> | </source> | ||
=== Notes === | === Notes === | ||
Call [[Scripting/Squirrel/Events/Player/ | Call [[Scripting/Squirrel/Events/Player/OnPlayerCommand|onPlayerCommand]] were used in this example. More info about them in the corresponding pages. | ||
== Related Functions == | |||
{{Scripting/Squirrel/Functions/Player_Functions}} | |||
[[Category:Scripting/Squirrel/Functions/Player_Functions]] | |||
Latest revision as of 18:45, 30 January 2017
This function disconnects a client from the server, aka kick a player.
Syntax
KickPlayer( player )
Arguments
- CPlayer player - the player you are going to kick.
Example
This example shows how to create a command to kick players.
function onPlayerCommand( player, cmd, text );
{
if ( cmd == "kick" )
{
if ( player.Name == "Noob69" || player.Name == "Antonio_Morales" ) //This players can execute the command.
{
if ( text )
{
local plr = FindPlayer( text );
if ( plr )
{
KickPlayer( plr );
}
else MessagePlayer( "Cannot find player "+text+"." , player );
}
else MessagePlayer( "Usage: /"+cmd+" <player>" , player );
}
else MessagePlayer( "You are not allowed to use this command." , player )
}
}Notes
Call onPlayerCommand were used in this example. More info about them in the corresponding pages.
Related Functions
- BanPlayer
- FindPlayer
- GetPlayerIDFromName
- IsWorldCompatibleWithPlayer
- KickPlayer
- PlaySoundForPlayer
- Player.Action
- Player.AddSpeed
- Player.Admin
- Player.AimDir
- Player.AimPos
- Player.Alpha
- Player.Ammo
- Player.Angle
- Player.Armour
- Player.Away
- Player.Ban
- Player.CameraLocked
- Player.CanAttack
- Player.CanDriveby
- Player.Cash
- Player.Class
- Player.Colour
- Player.Disarm
- Player.Eject
- Player.FPS
- Player.Frozen
- Player.GameKeys
- Player.GetAmmoAtSlot
- Player.GetWeaponAtSlot
- Player.GiveMoney
- Player.GiveWeapon
- Player.GreenScanlines
- Player.HasChatTags
- Player.HasMarker
- Player.Health
- Player.ID
- Player.Immunity
- Player.IP
- Player.IsCrouching
- Player.IsDrunk
- Player.IsOnFire
- Player.IsOnRadar
- Player.IsSpawned
- Player.Key
- Player.Kick
- Player.Name
- Player.Ping
- Player.PlaySound
- Player.Pos
- Player.Redirect
- Player.RestoreCamera
- Player.RemoveMarker
- Player.RemoveWeapon
- Player.Score
- Player.SecWorld
- Player.Select()
- Player.SetAlpha
- Player.SetAnim
- Player.SetDrunkLevel
- Player.SetCameraPos
- Player.SetInterior
- Player.SetMarker - bugged
- Player.SetWantedLevel
- Player.SetWeapon
- Player.ShowMarkers
- Player.Slot
- Player.Skin
- Player.Spawn
- Player.SpectateTarget
- Player.Speed
- Player.StandingOnObject
- Player.StandingOnVehicle
- Player.State
- Player.StreamedToPlayer
- Player.Typing
- Player.Team
- Player.UniqueID
- Player.UniqueID2
- Player.UniqueWorld
- Player.Vehicle
- Player.VehicleSlot
- Player.VehicleStatus
- Player.WantedLevel
- Player.Weapon
- Player.WhiteScanlines
- Player.Widescreen
- Player.World
- Player.PutInVehicleSlot
Player Game Functions
These functions exist for compatibility with the R2 Squirrel server.