MapEditor
constMapEditor:object
Defined in: client/api.d.ts:2790
The world builder: a free camera, the game’s mesh catalog as an asset library, a placement brush, a gizmo that moves anything, and maps saved to and loaded from files.
F7 or a client resource opens it. Multiplayer requires the server to grant this player access with player.setWorldBuilderEnabled(true); single-player and offline editing are always allowed. While it is open it holds the one free camera, so a NoClip flight in progress ends and NoClip.enable refuses. The player can still close it from its own window.
Type Declaration
Section titled “Type Declaration”close()
Section titled “close()”close():
void
Closes the editor and hands the camera back. Doing nothing when it is closed is not an error.
Returns
Section titled “Returns”void
Nothing.
isEnabled()
Section titled “isEnabled()”isEnabled():
boolean
Whether this client may open World Builder.
Returns
Section titled “Returns”boolean
True offline or when the server has granted this player access.
isOpen()
Section titled “isOpen()”isOpen():
boolean
Whether the editor is open at this client.
Returns
Section titled “Returns”boolean
True while it is open.
open()
Section titled “open()”open():
"opened"|"alreadyOpen"|"disabled"
Opens the editor.
Returns
Section titled “Returns”"opened" | "alreadyOpen" | "disabled"
opened when it opened. alreadyOpen when it was open already. disabled when this multiplayer connection has not been granted access.