add doctoc : add toc in api.md

This commit is contained in:
Romain Beaumont 2015-08-26 20:15:27 +02:00
parent 2e371e741f
commit 2d62ac8abb
2 changed files with 57 additions and 5 deletions

View file

@ -1,3 +1,52 @@
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*
- [API](#api)
- [Classes](#classes)
- [CraftyJS.Entity](#craftyjsentity)
- [entity.id](#entityid)
- [entity.type](#entitytype)
- [entity.username](#entityusername)
- [entity.mobType](#entitymobtype)
- [entity.displayName](#entitydisplayname)
- [entity.entityType](#entityentitytype)
- [entity.kind](#entitykind)
- [entity.name](#entityname)
- [entity.objectType](#entityobjecttype)
- [entity.count](#entitycount)
- [entity.position](#entityposition)
- [entity.velocity](#entityvelocity)
- [entity.yaw](#entityyaw)
- [entity.pitch](#entitypitch)
- [entity.height](#entityheight)
- [entity.onGround](#entityonground)
- [entity.equipment[5]](#entityequipment5)
- [entity.heldItem](#entityhelditem)
- [entity.metadata](#entitymetadata)
- [MCServer](#mcserver)
- [CraftyJS.createMCServer(options)](#craftyjscreatemcserveroptions)
- [Properties](#properties)
- [serv.entityMaxId](#serventitymaxid)
- [serv.players](#servplayers)
- [serv.uuidToPlayer](#servuuidtoplayer)
- [serv.world](#servworld)
- [Methods](#methods)
- [serv.createLog()](#servcreatelog)
- [serv.log(message)](#servlogmessage)
- [Player](#player)
- [Properties](#properties-1)
- [player.entity](#playerentity)
- [Methods](#methods-1)
- [player.login()](#playerlogin)
- [player.others(client)](#playerothersclient)
- [Low level properties](#low-level-properties)
- [player._client](#player_client)
- [Low level methods](#low-level-methods)
- [player._writeOthers(packetName, packetFields)](#player_writeotherspacketname-packetfields)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
# API
## Classes

View file

@ -4,10 +4,12 @@
"version": "0.1.0",
"main": "app.js",
"author": "mhsjlw <mhsjlw@aol.com>",
"contributors": [{
"name": "rom1504",
"email": "romain.rom1@gmail.com"
}],
"contributors": [
{
"name": "rom1504",
"email": "romain.rom1@gmail.com"
}
],
"scripts": {
"test": "mocha --reporter spec"
},
@ -21,7 +23,7 @@
"mocha": "~2.2.5",
"chai": "~3.2.0",
"prismarine-chunk": "~0.1.0",
"vec3":"0.1.3",
"vec3": "0.1.3",
"requireindex": "~1.0.0"
},
"repository": {
@ -32,6 +34,7 @@
"url": "http://github.com/mhsjlw/craftyjs/issues"
},
"devDependencies": {
"doctoc": "^0.15.0",
"longjohn": "~0.2.8"
}
}