Updated API Sides (markdown)

Vexatos 2014-07-13 05:28:56 -07:00
parent 763629cdf9
commit 3a3c629dff

@ -1,3 +1,10 @@
[![](http://i.imgur.com/GKcszRV.png)](http://ocdoc.cil.li/)
For those that don't like images: the wiki has moved to a new place, http://ocdoc.cil.li/.
*This wiki will no longer be updated.*
****
This "API" provides a global table to allow you to refer to sides / directions by name, as opposed to their numbers. The underlying number values are identical to Minecraft's internal numbering (as well as the `ForgeDirection` Enum). This table serves as a two-directional look-up, so you can resolve names to numbers, but also numbers back to a human readable name. For example, `sides.top` has the value `1`, whereas `sides[1]` has the string value `top`. A couple of aliases for the side names are available, so it's less likely to accidentally pick the wrong one. These are the basic values:
- Bottom (`bottom`), Number: 0
- Top (`top`), Number: 1