Files

222 lines
3.3 KiB
Markdown

# API
## Blocks
### minecraft-data.blocks
blocks indexed by id
### minecraft-data.blocksByName
blocks indexed by name
### minecraft-data.blocksArray
unindexed blocks
## Items
### minecraft-data.items
items indexed by id
### minecraft-data.itemsByName
items indexed by name
### minecraft-data.itemsArray
unindexed items
## Biomes
### minecraft-data.biomes
biomes indexed by id
### minecraft-data.biomesArray
unindexed biomes
## Recipes
### minecraft-data.recipes
recipes indexed by id
## Instruments
### minecraft-data.instruments
instruments indexed by id
### minecraft-data.instrumentsArray
unindexed instruments
## Materials
### minecraft-data.materials
materials indexed by name
## Entities
### minecraft-data.mobs
mobs indexed by id
### minecraft-data.objects
objects indexed by id
### minecraft-data.entitiesByName
entities indexed by name
### minecraft-data.entitiesArray
unindexed entities
## Enchantments
### minecraft-data.enchantments
enchantments indexed by id
### minecraft-data.enchantmentsByName
enchantments indexed by name
### minecraft-data.enchantmentsArray
unindexed enchantments
## Protocol
### minecraft-data.protocol
the minecraft protocol
### minecraft-data.protocolComments
the minecraft protocol comments
## Functions
### minecraft-data.findItemOrBlockById
find a block or an item by its id
### minecraft-data.findItemOrBlockByName
find a block or an item by its name
## Windows
### minecraft-data.windows
windows indexed by id
### minecraft-data.windowsByName
windows indexed by name
### minecraft-data.windowsArray
unindexed windows
## Version
### minecraft-data.version.version
the version number (example : 47)
### minecraft-data.version.minecraftVersion
the minecraft number (example : 1.8.3)
### minecraft-data.version.majorVersion
the major version (example : 1.8), also the name of the minecraft-data version
## Effects
### minecraft-data.effects
effects indexed by id
### minecraft-data.effectsByName
effects indexed by name
### minecraft-data.effectsArray
unindexed effects
## type
pe or pc
## minecraft-data.language
object from language key to string
## Protocol versions
Those are common data and directly available in the `require('minecraft-data')` object.
No need to specify a version before accessing them. They are indexed by pc and pe.
### minecraft-data.versions
unindexed minecraft versions
### minecraft-data.versionsByMinecraftVersion
minecraft versions indexed by minecraft version (example : 1.8.8)
### minecraft-data.preNettyVersionsByProtocolVersion
pre netty minecraft versions indexed by protocol version (example : 47)
### minecraft-data.postNettyVersionsByProtocolVersion
post netty minecraft versions indexed by protocol version (example : 47)
### minecraft-data.supportedVersions.pc
Array of pc supported versions
### minecraft-data.supportedVersions.pe
Array of pe supported versions
## Schemas
### minecraft-data.schema.biomes
### minecraft-data.schema.blocks
### minecraft-data.schema.effects
### minecraft-data.schema.entities
### minecraft-data.schema.instruments
### minecraft-data.schema.items
### minecraft-data.schema.materials
### minecraft-data.schema.protocol
### minecraft-data.schema.protocolVersions
### minecraft-data.schema.recipes
### minecraft-data.schema.version
### minecraft-data.schema.windows