Skip to content
Work in progress. These docs describe Spawnite at launch, and some parts are still being built.

PlayerEntity

PlayerEntity = Entity & object

A player’s entity, as every place that finds a player hands it: readPlayers, a join hook’s player, a command’s cause.player, readLocalPlayer, and isPlayer narrows any other, such as a controller, which may be a room’s. It is an entity wherever one is taken; what takes only a player, such as emitEvent’s to, takes this, so a prop or a character passed there fails to typecheck. As Roblox’s Player, apart from the character it drives.

Name Type
[playerEntity] true