doc/API

   1 TODO: This Documentation is unfull and partly deprecated!
   2 API Documentation
   3         Methods
   4                 dragonblocks.addFinalStep(function() : void) : void
   5                         Execute the function after all mods are loaded, the player is spawned and the map is generated.
   6                 dragonblocks.chatMessage(message : String) : void
   7                         Write something into the chatconsole. (alias for dragonblocks.chat.write)
   8                 dragonblocks.checkWorldExistance(worldname : String) : Boolean
   9                         Check if a world exists or not
  10                 dragonblocks.checkWorldOwnership(worldname : String) : Boolean
  11                         Check if a world is owned by the user
  12                 dragonblocks.checkWorldSpelling(worldname : String) : Boolean
  13                         Check if a worldname is OK (e.g. does not contain special chacters)
  14                 dragonblocks.clearTimer(name : String, meta : Object) : void
  15                         Clear a timer set using  dragonblocks.setTimer
  16                 dragonblocks.createItemstack(itemstring : String) : dragonblocks.Itemstack
  17                         Create an Itemstack object and immediately parse the provided itemstring.
  18                 dragonblocks.error(errorstring : String) : void
  19                         Throw an error. (errorstring is added to dragonblocks.backlog)
  20                 dragonblocks.finalize() : void
  21                         Execute the final steps added using dragonblocks.addFinalStep. Not to be used!
  22                 dragonblocks.finishTimer(name : String, meta : Object) : void
  23                         Immediately finish a timer set using dragonblocks.setTimer
  24                 dragonblocks.generateMap() : void
  25                         Run the Mapgen selected in the mainmenu. Not to be used.
  26                 dragonblocks.getEmptyWorld() : Object
  27                         Returns an Empty World save object. Not to be used.
  28                 dragonblocks.getModpath(modname : String) : String
  29                         Returns the path of an Mod or Gamemod. Use this instead of e.g. "mods/" + modname + "/" + ...
  30                 dragonblocks.getNode(x, y) : dragonblocks.MapNode
  31                         Returns the MapNode at x, y.
  32                 dragonblocks.getPixelManipulator(manip : Array) : dragonblocks.PixelManipulator
  33                         Returns an Pixel Manipulator. Same as new dragonblocks.PixelManipulator(manip)
  34                 dragonblocks.getSavestring() : String
  35                         Return the save string for the world
  36                 dragonblocks.getSound(filename : String) : String
  37                         Return the path for an sound file. These files can be placed in the folders mods/*/sounds, game/*/sounds and sounds. If not found, it will just return the filename.
  38                 dragonblocks.getTexture(filename : String) : String
  39                         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(...)
  40                 dragonblocks.getToken() : String
  41                         Returns a unique string starting with #
  42                 dragonblocks.getVersion() : String
  43                         Returns the version string (something like "Dragonblocks 3.0")
  44                 dragonblocks.isValidItemstring(itemstring : String)
  45                         Check if an Itemstring is OK
  46                 dragonblocks.gui.toggleLayer() : void
  47                         Toggle the Layer.
  48                 dragonblocks.gui.openLayer() : void
  49                 dragonblocks.gui.showLayer() : void
  50                         Open the Layer
  51                 dragonblocks.gui.closeLayer() : void
  52                 dragonblocks.gui.hideLayer() : void
  53                         Hide the Layer
  54                 dragonblocks.gui.createBox(properties : Object) : Element
  55                         Creates a dragonblocks.gui.Box(properties) and returns its the DOM Element.
  56
  57         Objects
  58                 dragonblocks.availableMods : Array
  59                         A list of all mods
  60                 dragonblocks.backlog : String
  61                         Contains everything logged using dragonblocks.log
  62                 dragonblocks.chat : dragonblocks.Chat
  63                         The dragonblocks chatconsole.
  64                 dragonblocks.chatcommands : Object
  65                         Contains all registered chatcommands
  66                 dragonblocks.entities : Object
  67                         Contains all registered entities
  68                 dragonblocks.finalSteps : Array
  69                         Contains the final Steps added using dragonblocks.addFinalStep
  70                 dragonblocks.gamemods : Array
  71                         Contains the gamemods
  72                 dragonblocks.groups : Object
  73                         Contains all registered groups
  74                 dragonblocks.items : Object
  75                         Contains all registered items
  76                 dragonblocks.itemstacks : Object
  77                         Contains all created Itemstacks
  78                 dragonblocks.keyHandler: dragonblocks.KeyHandler
  79                         The Keyhandler
  80         Classes
  81