heyplay Welcome Play Create Explore Log in Log in

Editor documentation

Top Heyplay IOkit Player

Represents specific player that participates in the game.

Properties
id
Unique identifier (internally it's an integer incremented from 1).
score
Player score (non-negative integer). Determines player in-game ranking and leaderboards.
nickname
Player nickname (entered during sign up/in profile, auto-generated for guests).
color
Player color (in hex format, selected in profile, random for guests).
camera
Player camera.
Methods
onJoin Static
Called every time a new player joins the game, once per player.
onSteer Static
Called when the player points in a new direction.
onAction Static
Called when the player starts or stops holding the action button.
onDeath Static
Called when player dies due to `Player.kill` call or a disconnect.
kill
Eliminate the specified player from the game.