Events & Exports

Installing & dependencies.

Export functions

Export name	Description	Parameters	Returns
insertMine	Creates a new mine at your position	x:number, y:number, z:number, price:number, name:string	Promise
removeMine	Removes a mine	id:number	Promise
resetMine	Resets the mine (carts, owner, etc.)	id:number	Promise
setPickaxeState	Sets the pickaxe state for a player (if custom inventory)	source:number, state:boolean	void
setHelmetState	Sets the helmet state for a player (if custom inventory)	source:number, state:boolean	void

Events

Event name	Description	Parameters
onEnterMine	Triggered when player enter the mine	source:number, mineId:number
onLeaveMine	Triggered when player left the mine	source:number, mineId:number
onMineRentExpired	Triggered when mine rent is expired	mineId:number
onMineRented	Triggered when mine was just rented	source:number, mineId:number, days:number
onMineRentRenewal	Triggered when mine rent was renewed	source:number, mineId:number, days:number
onHitCell	Triggered when player hits a cell (tunnel block)	source:number