Class Game

This class contains functions for general game management.

Index

Methods

exit getAllBlocks getFps getSelectedBlock isKeyDown isWorldNew registerBlock setSelectedBlock

Methods

`Static`exit

exit(): void
Saves the level and exits the game cleanly.

Returns void
- Defined in jsm_api.d.ts:364

`Static`getAllBlocks

getAllBlocks(): Block[]
Get every registered Block.

Returns Block[]
A list of every registered Block

Remarks
You should run this in the first tick instead of ModDefinition.start because the mod loading order cannot be guaranteed.
- Defined in jsm_api.d.ts:390

`Static`getFps

getFps(): number
Retrieve the current game frames per second (FPS)

Returns number
The frame rate
- Defined in jsm_api.d.ts:370

`Static`getSelectedBlock

getSelectedBlock(): Block
Get the currently selected block.

Returns Block
The currently selected block.
- Defined in jsm_api.d.ts:402

`Static`isKeyDown

isKeyDown(key: Key): boolean
Check if a key is being held down
Parameters
- key: Key
  The key to check
Returns boolean
- Defined in jsm_api.d.ts:376

`Static`isWorldNew

isWorldNew(): boolean
Check if the world was just generated. This can be used to make sure custom world generation won't override a saved level.

Returns boolean
True if the world was generated on the same launch, otherwise false
- Defined in jsm_api.d.ts:408

`Static`registerBlock

registerBlock(block: PreBlock): Block
Register a block so it can be used in-game.
Parameters
- block: PreBlock
  A PreBlock. Discard the PreBlock and use the Block returned for any level mutation.
Returns Block
A Block object that was generated by the game. Use this instead of the PreBlock from now on.
- Defined in jsm_api.d.ts:383

`Static`setSelectedBlock

setSelectedBlock(block: Block): void
Change the currently selected block. The selected block is what is used when the player places a block.
Parameters
- block: Block
  The new selected block
Returns void
- Defined in jsm_api.d.ts:396