From 403de9df43ddbe473b38344fc553c557a8a06dc0 Mon Sep 17 00:00:00 2001 From: Kayne Ruse Date: Sun, 22 Jun 2014 23:04:39 +1000 Subject: [PATCH] Updated API outline --- api outline.md | 55 ++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 42 insertions(+), 13 deletions(-) diff --git a/api outline.md b/api outline.md index 49a261b..825a087 100644 --- a/api outline.md +++ b/api outline.md @@ -1,3 +1,34 @@ +--RoomManager interface +roommgr.getroom(index) + return userdata +roommgr.createroom(room[, {params}]) + return userdata +roommgr.unloadroom(room) + return nil + + +--RoomData interface +room.getpager(room) + return userdata +room.getgenerator(room) + return userdata + +room.get{params}(room) + + +--RegionPager interface +pager.settile(p, x, y, z, v) +pager.gettile(p, x, y, z) +pager.getregion(p, x, y) +pager.setdirectory(p, directory) +pager.getdirectory(p) +pager.loadregion(p, x, y) +pager.saveregion(p, x, y) +pager.createregion(p, x, y[, {params}]) +pager.unloadregion(p, x, y) + + +--Region interface region.settile(r, x, y, z, v) region.gettile(r, x, y, z) region.getx(r) @@ -10,19 +41,17 @@ region.save(r, directory) region.create(r[, {params}]) region.unload(r[, directory]) -pager.settile(p, x, y, z, v) -pager.gettile(p, x, y, z) -pager.getregion(p, x, y) -pager.setdirectory(p, directory) -pager.getdirectory(p) -pager.loadregion(p, x, y) -pager.saveregion(p, x, y) -pager.createregion(p, x, y[, {params}]) -pager.unloadregion(p, x, y) -room.gettype(room) -room.get{params}(room) -room.getregionpager(room) +--*Generator interface +generator.gettype(generator) + return string +generator.getchunk(generator, x, y) + return userdata +generator.getmapwidth() + return number +generator.getmapheight() + return number -room.getroom(index) +--Chunk interface +?? \ No newline at end of file