CharacterCreator
constCharacterCreator:object
Defined in: client/api.d.ts:3551
The game’s own character stage, for the local player to choose how they look.
Opens the pause screen on its character page, hides the page’s own panels and stands a panel of tabs – body, face, hair, beard – beside a figure the player dresses and turns. The keys are listed on the panel, named as the game names them.
Client-only and local: it changes nothing anywhere. characterCreatorClosed reports what the player accepted, and the resource decides what that means.
Type Declaration
Section titled “Type Declaration”close()
Section titled “close()”close():
boolean
Ends the open creator as closed.
Returns
Section titled “Returns”boolean
False when none was open.
isOpen()
Section titled “isOpen()”isOpen():
boolean
Whether a creator is open or going up.
Returns
Section titled “Returns”boolean
True from open until its characterCreatorClosed.
open()
Section titled “open()”open(
options?):boolean
Opens a creator, ending one already open as replaced. The stage goes up on the next ticks; one that cannot ends as unavailable.
Parameters
Section titled “Parameters”options?
Section titled “options?”What to show.
Returns
Section titled “Returns”boolean
True. Malformed options throw.