Updated the API outline

api outline.md

@@ -1,56 +1,53 @@
+--TODO: each function needs to check it's parameter count
+--TODO: Set metatables
+--TODO: test
+
 --RoomManager interface
-roommgr.getroom(index)
+RoomMgr.GetRoom(index)
-	return userdata
+RoomMgr.CreateRoom([{params}])
-roommgr.createroom(room[, {params}])
+RoomMgr.UnloadRoom(index)
-	return userdata
-roommgr.unloadroom(room)
-	return nil
 
 
 --RoomData interface
-room.getpager(room)
+Room.GetPager()
-	return userdata
+Room.GetGenerator()
-room.getgenerator(room)
+Room.OnCreate([{params}])
-	return userdata
+Room.OnUnload()
 
-room.get{params}(room)
+Room.Get{params}()
 
 
 --RegionPager interface
-pager.settile(p, x, y, z, v)
+RegionPager.SetTile(x, y, z, v)
-pager.gettile(p, x, y, z)
+RegionPager.GetTile(x, y, z)
-pager.getregion(p, x, y)
+RegionPager.GetRegion(x, y)
-pager.setdirectory(p, directory)
+RegionPager.SetDirectory(directory)
-pager.getdirectory(p)
+RegionPager.GetDirectory()
-pager.loadregion(p, x, y)
+RegionPager.LoadRegion(x, y)
-pager.saveregion(p, x, y)
+RegionPager.SaveRegion(x, y)
-pager.createregion(p, x, y[, {params}])
+RegionPager.CreateRegion(x, y[, {params}])
-pager.unloadregion(p, x, y)
+RegionPager.UnloadRegion(x, y)
 
 
 --Region interface
-region.settile(r, x, y, z, v)
+Region.SetTile(x, y, z, v)
-region.gettile(r, x, y, z)
+Region.GetTile(x, y, z)
-region.getx(r)
+Region.GetX()
-region.gety(r)
+Region.GetY()
-region.getwidth()
+Region.GetWidth()
-region.getheight()
+Region.GetHeight()
-region.getdepth()
+Region.GetDepth()
-region.load(r, directory)
+Region.OnLoad(directory)
-region.save(r, directory)
+Region.OnSave(directory)
-region.create(r[, {params}])
+Region.OnCreate([{params}])
-region.unload(r[, directory])
+Region.OnUnload([directory])
 
 
 --*Generator interface
-generator.gettype(generator)
+Generator.GetMapType()
-	return string
+Generator.GetChunk(x, y)
-generator.getchunk(generator, x, y)
+Generator.GetMapWidth()
-	return userdata
+Generator.GetMapHeight()
-generator.getmapwidth()
-	return number
-generator.getmapheight()
-	return number
 
 
 --Chunk interface