Added more detailed info about some methods to the documentation

[dragonblocks.git] / doc / API.md

diff --git a/doc/API.md b/doc/API.md
index 7a5a5da110474beb0c10aff68de3b1efa267e65d..7f21f956b8714f294172ee541a84744bbf036d07 100644 (file)
--- a/doc/API.md
+++ b/doc/API.md
@@ -6,21 +6,27 @@ TODO: This Documentation is unfull and partly deprecated!
                dragonblocks.chatMessage(message : String) : void
                        Write something into the chatconsole. (alias for dragonblocks.chat.write)
                dragonblocks.checkWorldExistance(worldname : String) : Boolean
-                       Check if a world exists or not
+                       Check if a world exists or not (secure check)
                dragonblocks.checkWorldOwnership(worldname : String) : Boolean
-                       Check if a world is owned by the user
+                       Check if a world is owned by the current user (secure check)
                dragonblocks.checkWorldSpelling(worldname : String) : Boolean
                        Check if a worldname is OK (e.g. does not contain special chacters)
                dragonblocks.clearTimer(name : String, meta : Object) : void
                        Clear a timer set using  dragonblocks.setTimer
+                       meta is the variable the timer is stored in
+                       name is the timer's name (also stored in meta[name] while the timer is running)
                dragonblocks.createItemstack(itemstring : String) : dragonblocks.Itemstack
                        Create an Itemstack object and immediately parse the provided itemstring.
+               dragonblocks.createWorld(properties : Object) : void
+                       Create and load a world without saving it.
                dragonblocks.error(errorstring : String) : void
                        Throw an error. (errorstring is added to dragonblocks.backlog)
                dragonblocks.finalize() : void
                        Execute the final steps added using dragonblocks.addFinalStep. Not to be used!
                dragonblocks.finishTimer(name : String, meta : Object) : void
                        Immediately finish a timer set using dragonblocks.setTimer
+                       meta is the variable the timer is stored in
+                       name is the timer's name (also stored in meta[name] while the timer is running)
                dragonblocks.generateMap() : void
                        Run the Mapgen selected in the mainmenu. Not to be used.
                dragonblocks.getEmptyWorld() : Object
@@ -29,8 +35,11 @@ TODO: This Documentation is unfull and partly deprecated!
                        Returns the path of an Mod or Gamemod. Use this instead of e.g. "mods/" + modname + "/" + ...
                dragonblocks.getNode(x, y) : dragonblocks.MapNode
                        Returns the MapNode at x, y.
+                       You can use the object to read its properties.
                dragonblocks.getPixelManipulator(manip : Array) : dragonblocks.PixelManipulator
                        Returns an Pixel Manipulator. Same as new dragonblocks.PixelManipulator(manip)
+                       You have to provide a Pixel Manipulator which is then made usable by this function.
+                       For further information on how to use Pixel Manipulators, consult Pixel_Manipulator.md
                dragonblocks.getSavestring() : String
                        Return the save string for the world
                dragonblocks.getSound(filename : String) : String
@@ -39,22 +48,30 @@ TODO: This Documentation is unfull and partly deprecated!
                        Same as dragonblocks.getSound, exept for Textures and, if the file is found, it will surrond it with url() so you can do elem.style.background = dragonblocks.getTexture(...)
                dragonblocks.getToken() : String
                        Returns a unique string starting with #
+                       Useful when working with entities as they all need an ID
+               dragonblocks.getTool(name : String) : dragonblocks.Tool
+                       Returns the tool with the id "name".
                dragonblocks.getVersion() : String
                        Returns the version string (something like "Dragonblocks 3.0")
                dragonblocks.isValidItemstring(itemstring : String)
                        Check if an Itemstring is OK
+               dragonblocks.log(message : String) : void
+                       Add a message to the backlog.
                dragonblocks.gui.toggleLayer() : void
-                       Toggle the Layer. 
+                       Toggle (show or hide) the Layer. 
                dragonblocks.gui.openLayer() : void
+                       Not implemented yet
                dragonblocks.gui.showLayer() : void
-                       Open the Layer
+                       Show the Layer
                dragonblocks.gui.closeLayer() : void
+                       Not implemented yet
                dragonblocks.gui.hideLayer() : void
                        Hide the Layer
                dragonblocks.gui.createBox(properties : Object) : Element
-                       Creates a dragonblocks.gui.Box(properties) and returns its the DOM Element.
+                       Creates a dragonblocks.gui.Box(properties) and returns an object to access it.
+                       Valid properties are closeable : boolean, id : String, scroll : boolean, moveable : boolean, size : String ("big" or "small"), layer : boolean, keylock : boolean
                
-       Objects
+##     Objects
                dragonblocks.availableMods : Array
                        A list of all mods
                dragonblocks.backlog : String
@@ -65,8 +82,6 @@ TODO: This Documentation is unfull and partly deprecated!
                        Contains all registered chatcommands
                dragonblocks.entities : Object
                        Contains all registered entities
-               dragonblocks.finalSteps : Array
-                       Contains the final Steps added using dragonblocks.addFinalStep
                dragonblocks.gamemods : Array
                        Contains the gamemods
                dragonblocks.groups : Object
@@ -77,5 +92,21 @@ TODO: This Documentation is unfull and partly deprecated!
                        Contains all created Itemstacks
                dragonblocks.keyHandler: dragonblocks.KeyHandler
                        The Keyhandler
-       Classes
-        
+               dragonblocks.mods : Array
+                       Contains all loaded mods
+               dragonblocks.nodes : Object
+                       Contains all registered nodes
+               dragonblocks.recipes : Array
+                       Contains all registered recipes
+               dragonblocks.settings : Object
+                       Contains all dragonblocks settings
+               dragonblocks.skins : Object
+                       Contains all registered skins
+               dragonblocks.spawnedEntities : Array
+                       Contains all spawned entities
+               dragonblocks.tools : Object
+                       Contains all registered tools
+               dragonblocks.worlds : Array
+                       List of saved worlds of logged-in user
+##     Classes
+