Merge pull request #7 from ZXMushroom63/main

Plugin Docs for Alpha 4.0

src/.vuepress/config.js

@@ -90,6 +90,7 @@ module.exports = {
 	  title: 'Globals',
 	  collapsable: true,
 	  children: [
+      'globals/Data',
 		  'globals/AxisAlignedBB',
 		  'globals/BlockData',
 		  'globals/EnchantmentData',
@@ -100,6 +101,9 @@ module.exports = {
 		  'globals/MapColor',
 		  'globals/MaterialData',
 		  'globals/PlayerData',
+      'globals/ItemStackData',
+		  'globals/InventoryBasicData',
+      'globals/ContainerData',
 		  'globals/Vec3',
 		  'globals/require',
 		  'globals/updateComponent',

src/plugindocs/README.md

@@ -11,5 +11,4 @@ It has the following methods:
 
 
 
-
 It also has some global objects which expose some of the inner Minecraft workings. Go [here](globals/ListOfGlobals.md) to view the full list.

src/plugindocs/globals/ContainerData.md

@@ -0,0 +1,8 @@
+# ContainerData
+Represents a container.
+
+Has the following properties:
+- `inventoryItemStacks : [ItemStackData](ItemStackData.md)[]`
+
+And the following methods:
+- `getPlayerList() : [PlayerData](PlayerData.md)[]`

src/plugindocs/globals/Data.md

@@ -0,0 +1,3 @@
+# Data
+
+Data is the parent of all other types of data, so all types of data share the `reload()` method. Reload is used to force reload the data in-game.

src/plugindocs/globals/InventoryBasicData.md

@@ -0,0 +1,8 @@
+# InventoryBasicData
+Represents a basic inventory.
+
+Has the following properties:
+- `inventoryContents : [ItemStackData](ItemStackData.md)[]`
+- `inventoryTitle : String`
+- `slotsCount : Integer`
+- `hasCustomName : Boolean`

src/plugindocs/globals/ItemStackData.md

@@ -0,0 +1,44 @@
+# ItemStackData
+Represents an itemstack.
+
+Has the following properties:
+- `amount : Integer`
+- `animationsToGo : Integer`
+- `itemId : Integer`
+- `itemDamage : Integer`
+- `itemFrame : [EntityData](EntityData.md)` (If existing)
+- `canDestroyCacheBlock : BlockData`
+- `canDestroyCacheResult : Boolean`
+- `canPlaceOnCacheBlock : BlockData`
+- `canPlaceOnCacheResult : Boolean`
+
+Has the following methods:
+- `getItem() : [ItemData.md](ItemData.md)`
+- `getMaxStackSize() : Integer`
+- `isStackable() : Boolean`
+- `isItemStackDamageable() : Boolean`
+- `getHasSubtypes() : Boolean`
+- `isItemDamaged() : Boolean`
+- `getItemDamage() : Integer`
+- `getMetadata() : Integer`
+- `setItemDamage({meta: Integer}) : void`
+- `getMaxDamage() : Integer`
+- `copy() : [ItemStackData.md](ItemStackData.md)`
+- `getUnlocalizedName() : String`
+- `toString() : String`
+- `getMaxItemUseDuration() : Integer`
+- `getDisplayName() : String`
+- `setDisplayName(displayName: String) : [ItemStackData.md](ItemStackData.md)`
+- `clearCustomName() : void`
+- `hasDisplayName() : Boolean`
+- `hasEffect() : Boolean`
+- `isItemEnchantable() : Boolean`
+- `addEnchantment(enchId: Integer, level: Integer) : void`
+- `isItemEnchanted() : Boolean`
+- `canEditBlocks() : Boolean`
+- `isOnItemFrame() : Boolean`
+- `getRepairCost() : Integer`
+- `setRepairCost(cost: Integer) : void`
+- `setItem(itemId: Integer) : void`
+- `canDestroy(blockId: Integer) : Boolean`
+- `canPlaceOn(blockId: Integer) : Boolean`

src/plugindocs/globals/MapColor.md

@@ -3,5 +3,5 @@ Represents a map color.
 
 Has the following properties:
 - `colorIndex` : Integer
-- `colorValue` : colorValue
+- `colorValue` : Integer
 - `rgb` : Integer[]

src/plugindocs/globals/PlayerData.md

@@ -13,6 +13,7 @@ All of the properties of [EntityData](EntityData.md), and:
 - `flyToggleTimer`: Integer: Equal to the player's `flyToggleTimer`.
 - `hasReducedDebug`: Boolean: Equal to the player's `hasReducedDebug`.
 - `itemInUseCount`: Integer: The count of the item that the player is currenly using. (Read-only)
+- `itemInUse`: [ItemStackData](ItemStackData.md): The itemstack the player is using. (If existing)
 - `lastXPSound`: Integer: Equal to the player's `lastXPSound`.
 - `sleepTimer`: Integer: Equal to the player's `sleepTimer`.
 - `sleeping`: Boolean: Whether or not the player is sleeping.