Skip to content
This repository has been archived by the owner on May 29, 2024. It is now read-only.

Latest commit

 

History

History
76 lines (43 loc) · 2.73 KB

MODDING.MD

File metadata and controls

76 lines (43 loc) · 2.73 KB
Raw

Modding Overview

All mods must be stored as individual directories in the mods/ folder. Each mod must have a mod.txt and script.lua file.

Mod.txt

mod.txt must contain entries followed by a zero or non-zero value. These entries indicate the existence of functions in the script.lua (zero = does not have, non-zero = does have).

hasStart: Whether or not the script contains the onStart() function

hasUpdate: Whether or not the contains the onUpdate() function

hasTick: Whether or not the contains the onTick() function

hasBreak: Whether or not the contains the onBreak(x, y, z, blk) function

hasPlace: Whether or not the contains the onPlace(x, y, z, blk) function

Script.lua

script.lua may contain various functions, variables, and these variables (for now) are guaranteed not to be overriden by other mods. script.lua can have any of the various functions which are called upon events occuring.

onStart(): Called upon mod initialization

onUpdate(): Called upon every refresh cycle of the application -- this is essentially called every frame currently

onTick(): Called upon every world tick (4 per second)

onBreak(x, y, z, blk): Called when the player breaks a block and provides the x, y, z coordinate of block broken and what the block was.

onPlace(x, y, z, blk): Called when the player places a block and provides the x, y, z coordinate of block placed and what the block placed is.

Libraries

All standard lua libraries should be available. In addition, CrossCraft-SurvivalTest provides three helper libraries, World, Player, Entity

World contains World.setBlock(x, y, z, blk) and World.getBlock(x, y, z).

World.setBlk(x, y, z, blk): Will immediately set a block in the world and rebuild the chunk. BLK is the block ID to be set. These follow the classic ID scheme.

World.getBlock(x, y, z): Will return a value of what block is at a given position in the world.

Player contains Player.get[X/Y/Z]() and Player.set[X/Y/Z](v)

Player.getX(), Player.getY(), Player.getZ() return the X/Y/Z positions of the player

Player.setX(v), Player.setY(v), Player.setZ(v) updates and teleport the player to the X/Y/Z coordinates set by argument value v.

Entity contains Entity.spawnTNT(x, y, z, fuse), Entity.spawnDrop(x, y, z, id, quantity), Entity.spawnMob(x, y, z, type)

Entity.spawnTNT(x, y, z, fuse) spawns a TNT at a location with a fuse with duration in seconds

Entity.spawnDrop(x, y, z, id , quantity) spawns an Item at a location with a block ID id and number quantity

Entity.spawnMob(x, y, z, type) spawns a Mob at a location of a specific type.

Mob Types:

    Steve = 0x00,
    Zombie = 0x01,
    Skeleton = 0x02,
    Creeper = 0x03,
    Spider = 0x04,
    Pig = 0x05,
    Sheep = 0x06