Multiplayer Miner

Events & Exports

Manage mine properties, integrate custom equipment and respond to mining activity from other server resources.

API reference

Export functions

Create or remove mines and integrate custom pickaxe and helmet handling.

5 exports

NameDescriptionParametersReturns

insertMine

Creates a new mine at the specified position.

xnumberynumberznumberpricenumbernamestring

Promise

removeMine

Removes an existing mine.

idnumber

Promise

resetMine

Resets a mine, including its carts, owner and related state.

idnumber

Promise

setPickaxeState

Updates a player’s pickaxe state when using a custom inventory.

sourcenumberstateboolean

void

setHelmetState

Updates a player’s helmet state when using a custom inventory.

sourcenumberstateboolean

void

Event reference

Server events

React to mine access, rental changes and tunnel activity from another resource.

6 events

NameDescriptionParameters

onEnterMine

Triggered when a player enters a mine.

sourcenumbermineIdnumber

onLeaveMine

Triggered when a player leaves a mine.

sourcenumbermineIdnumber

onMineRentExpired

Triggered when the rental period for a mine expires.

mineIdnumber

onMineRented

Triggered immediately after a player rents a mine.

sourcenumbermineIdnumberdaysnumber

onMineRentRenewal

Triggered when a player renews a mine rental.

sourcenumbermineIdnumberdaysnumber

onHitCell

Triggered when a player hits a tunnel cell.

sourcenumber

Administration commands

The included commands provide quick in-game access to mine creation.

/createmine

Create a mine at your current position.

/createmineat

Create a mine at a specified position.