Skip to content

K.Players ​

Functions ​

K.Players.IsReady ​

lua
K.Players.IsReady(player: Player): boolean

Server: true once the player's data has loaded. Client: true while they're in the game.

K.Players.GetAll ​

lua
K.Players.GetAll(): { Player }

Every ready player.

K.Players.OnJoin ​

lua
K.Players.OnJoin(callback: (Player) -> ())

Runs for every player already in the game and everyone who joins later. On the server it runs after the player's data has loaded.

K.Players.OnLeave ​

lua
K.Players.OnLeave(callback: (Player) -> ())

K.Players.OnCharacter ​

lua
K.Players.OnCharacter(callback: (Player, Model) -> ())

Runs for every character, including after each respawn.

K.Players.OnDeath ​

lua
K.Players.OnDeath(callback: (Player, Model) -> ())

K.Players.FromPart ​

lua
K.Players.FromPart(part: Instance?): Player?

The player whose character part belongs to (works for accessories and tools too).

K.Players.GetHumanoid ​

lua
K.Players.GetHumanoid(player: Player): Humanoid?

K.Players.IsAlive ​

lua
K.Players.IsAlive(player: Player): boolean

K.Players.Kill ​

lua
K.Players.Kill(player: Player)

K.Players.Respawn ​

lua
K.Players.Respawn(player: Player)

K.Players.AllowMovement ​

lua
K.Players.AllowMovement(player: Player, seconds: number)

Lets a player move unusually (fast, far, through the air) for seconds, so K.AntiCheat doesn't flag launches, dashes or your own teleports.

K.Players.IsMovementAllowed ​

lua
K.Players.IsMovementAllowed(player: Player): boolean

K.Players.Teleport ​

lua
K.Players.Teleport(player: Player, target: any)

Moves the player's character to a Part, Model, Vector3 or CFrame.

K.Players.DistanceTo ​

lua
K.Players.DistanceTo(player: Player, target: any): number

Distance from the player's character to the surface of a Part or Model, or to a Vector3 / Attachment. math.huge when they have no character.

K.Players.IsNear ​

lua
K.Players.IsNear(player: Player, target: any, maxDistance: number): boolean

Generated from src/Corode/Players.luau.

Corode 0.13.0 · MIT License