ModPE API

Index

NOTICE:

I am working on a new JSDoc Template that better suits my needs for documenting the ModPE API. This project will not be worked until I am able to complete the new template. Sorry for the delay!

Documentation for the ModPE API

v0.0.3

Build Status

Version Compatibility

  • Minecraft Pocket Edition: 0.13.0
  • BlockLauncher Pro: 1.11.1-b5

References Documentation

Helpful Stuff

TODO

General

  • improve code examples where necessary
  • tutorials and script examples
  • make sure to credit all sources of code and docs
  • separate references into tutorials/help section (block IDs, block render types, textures, etc...)
  • improve README

Global Namespace

  • getLevel: what does this do? iOS only?
  • preventDefault: need more info on what it does and a better example with explanatory details

Hooks

  • fine tune examples and function/parameter descriptions

Block API

  • Block.setRenderLayer: does translucency work (layer 2)?

Entity API

  • still lots to do

Item API

  • done, including new Item.setProperties()

Level API

  • Level.addParticle: better description of how velocity settings work
  • Level.getAddress: what does this do? iOS only?

ModPE API

  • almost everything

Player API

  • almost everything

Renderer API

  • everything
  • is this a valid API?

Server API

  • done except for fine tuning & better examples

Graphics Credits

Minecraft Block

 Minecraft Block  From: Vector.me (by Tavin)

Font License Info

Minecrafter Font

 Copyright © 2014 by MadPixel Designs
 Author: MadPixel Designs
 License: CC
 Homepage: dafont

Glyphicons Halflings

 From Bootstrap Components:

". . . Glyphicons Halflings are normally not available for free, but their
creator has made them available for Bootstrap free of cost. As a thank you,
we only ask that you include a link back to Glyphicons whenever possible."

Entypo

 Copyright © 2012 by Daniel Bruce
 Author: Daniel Bruce
 License: SIL
 Homepage: Entypo

Font Awesome

 Copyright © 2012 by Dave Gandy
 Author: Dave Gandy
 License: SIL
 Homepage: Font Awesome

Modern Pictograms

 Copyright © 2012 by John Caserta. All rights reserved.
 Author: John Caserta
 License: SIL
 Homepage: Modern Pictograms

Web Symbols

 Copyright © 2011 by Just Be Nice studio. All rights reserved.
 Author: Just Be Nice studio
 License: SIL
 Homepage: Web Symbols