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

addBotPlayer

addBotPlayer(authority, addBotPlayerOptions): PlayerEntity | null

Fills a seat with a bot player: a player entity with the role Role.Bot and no page, made with every plugin’s onPlayerJoin and onPlayerReady at once, so the characters plugin gives her a character and a scoreboard or a team balance counts her. A room system drives her through writeInput; a tick no system wrote her input for reads at rest. She holds no save. kick removes her, and the room’s close runs her leave with every player’s. Answers her player entity, or null where a join hook threw in a deployed room, which logs it and leaves nothing of hers; a development world throws it. As Unreal’s bots, which a game mode spawns with an AIController and a PlayerState.

Parameter Type
authority Authority
addBotPlayerOptions AddBotPlayerOptions

PlayerEntity | null