Plethora

getCelestialAngle():number

The angle the sun or moon lies at in degrees.

0 is directly overhead.

getDay():integer

The current day of this world

getMoonPhase():int

The current phase of the moon

getTime():int

The game time in ticks

getBlockLight():int

The light level from surrounding blocks.

getSkyLight():int

The light level from the sun.

getWeather():string

The weather in the current world.

hasSky():boolean

Whether this world has a sky.

playNote(instrument:string|number, pitch:number[, volume:number])

Plays a note block note

playSound(sound:string[, pitch:number][, volume:number])

Play a sound

capture(pattern:string)

Capture all chat messages matching a Lua pattern, preventing them from being said.

clearCaptures()

Remove all listeners added by capture().

say(message:string)

Send a message to everyone

tell(message:string)

Send a message to yourself

uncapture(pattern:string):boolean

Remove a capture added by capture(pattern).

capture(pattern:string)

Capture all chat messages matching a Lua pattern, preventing them from being said.

clearCaptures()

Remove all listeners added by capture().

say(message:string)

Send a message to everyone

uncapture(pattern:string):boolean

Remove a capture added by capture(pattern).

canvas():table

Get the 2D canvas for these glasses.

canvas3d():table

Get the 3D canvas for these glasses.

getEnder():table

Get this player's ender chest

getEquipment():table

Get this entity's held item and armor

getID():string

Get this entity's UUID.

getInventory():table

Get this turtle's inventory

getInventory():table

Get this player's inventory

getName():string

Get this entity's name.

getMetaOwner():table

Get this entity's UUID.

disableAI()

Disable the AI of this entity.

Be warned: this permanently scars them - they'll never be the same again!

explode()

Explode this creeper.

isWalking():boolean

Whether the entity is currently walking somewhere.

launch(yaw:number, pitch:number, power:number)

Launch the entity in a set direction

look(yaw:number, pitch:number)

Look in a set direction

propel(velocity:number)

Propel this minecart in along the track.

shoot(potency:number)

Fire an arrow in the direction the skeleton is looking

shoot(yaw:number, pitch:number)

Fire a fireball in the specified direction.

shoot(potency:number)

Throw a potion in the direction the witch is looking

swing():boolean, string|nil

Left click with this item.

Returns the action taken.

swing():boolean, string|nil

Left click with this item.

Returns the action taken.

teleport(x:number, y:number, z:number)

Teleport to a position relative to the current one

use([duration:integer]):boolean, string|nil

Right click with this item.

The duration is in ticks, or 1/20th of a second.

use([duration:integer], [hand:string]):boolean, string|nil

Right click with this item using a particular hand ("left" or "right").

The duration is in ticks, or 1/20th of a second.

walk(x:number, y:number, z:number):boolean, string|nil

Walk to a coordinate

fire(yaw:number, pitch:number, potency:number)

Fire a laser in a set direction

getBlockMeta(x:int, y:int, z:int):table

Get metadata about a nearby block

scan():table

Scan all blocks in the vicinity

getMetaByID(id:string):table|nil

Find a nearby entity by UUID

getMetaByName(name:string):table|nil

Find a nearby entity by name

sense():table

Scan for entities in the vicinity

getMetadata():table

Get metadata about this object

getBrewTime():int

Number of ticks the current potion has brewed for

getBurnTime():int

Number of ticks of burning the current fuel provides

getCookTime():int

Number of ticks the current item has cooked for

getRemainingBurnTime():int

Number of ticks of fuel left

getSignText():table

Each line of text on this sign

setSignText(lines...:string)

Set the lines of text on this sign

getTanks([side:string]):table

Get a list of all tanks on this side

pullFluid(fromName:string[, limit:int[, fluid:string]]):int

Pull fluid to this tank from another tank.

Returns the amount transferred.

pushFluid(toName:string[, limit:int], fluid:string):int

Push fluid from this tank to another tank.

Returns the amount transferred.

drop(slot:int[, limit:int[, direction:string]]):int

Drop an item on the ground.

Returns the number of items dropped

getItem(slot:int):table|nil

The item in the specified slot.

The slot number starts from 1.

getItemMeta(slot:int):table|nil

The metadata of the item in the specified slot.

The slot number starts from 1.

list():table

List all items in this inventory

pullItems(fromName:string, fromSlot:int[, limit:int[, toSlot:int]]):int

Pull items to this inventory from another inventory.

Returns the amount transferred.

pushItems(toName:string, fromSlot:int[, limit:int[, toSlot:int]]):int

Push items from this inventory to another inventory.

Returns the amount transferred.

size():int

The size of the inventory

suck([slot:int[, limit:int]]):int

Suck an item from the ground

getDocs([name: string]):string|table

Get the documentation for all functions or the function specified.

Errors if the function cannot be found.

getTransferLocations([location:string]):table

Get a list of all available objects which can be transferred to or from

filterModules(names:string...):table|nil

Gets the methods which require these modules

hasModule(module:string):boolean

Checks whether a module is available

listModules():table

Lists all modules available

consume()

Consume one item from this stack

drop([limit:int[, direction:string]]):int

Drop an item on the ground.

Returns the number of items dropped

setActive([active:boolean])

Set whether these elytra are active or not.

remove()

Remove this object from the canvas.

getAlpha():int

Get the alpha for this object.

getColor():int

Get the colour for this object.

getColour():int

Get the colour for this object.

setAlpha(alpha:int)

Set the alpha for this object.

setColor(colour|r:int, [g:int, b:int], [alpha:int]):number

Set the colour for this object.

setColour(colour|r:int, [g:int, b:int], [alpha:int]):number

Set the colour for this object.

getItem(): string, number

Get the item and damage value for this object.

setItem(item:string[, damage:int])

Set the item and damage value for this object.

clear()

Remove all objects.

getSize():number, number

Get the size of this canvas.

addDot(position:table, [, color:number][, size:number]):table

Create a new dot.

addGroup(position:table):table

Create a new object group.

addItem(position:table, item:string[, damage:int[, scale:number]]):table

Create a item icon.

addLine(start:table, end:table[, colour:int[, thickness:number]]):table

Create a new line.

addLines(points...:table, [, color:number[, thickness:number]]):table

Create a new line loop, composed of many points.

addPolygon(points...:table, [, color:number]):table

Create a new polygon, composed of many points.

addRectangle(x:number, y:number, width:number, height:number[, colour:int]):table

Create a new rectangle.

addText(position:table, contents:string[, colour:int[, size:number]]):table

Create a new text object.

addTriangle(p1:table, p2:table, p3:table[, colour:int]):table

Create a new triangle, composed of three points.

addBox(x:number, y:number, z:number[, width:number, height:number, depth:number][, color:number]):table

Create a new box.

addFrame(position:table):table

Create a new frame to put 2d objects in.

addItem(position:table, item:string[, damage:int[, scale:number]]):table

Create a item model.

addLine(start:table, end:table[, thickness:number[, colour:int]]):table

Create a new line.

create([offset:table]):table

Create a new 3D canvas centred relative to the current position.

getScale():number

Get the scale for this object.

setScale(scale:number)

Set the scale for this object.

getLineHeight():int

Get the line height for this object.

getText():string

Get the text for this object.

hasShadow():boolean

Get the shadow for this object.

setLineHeight(lineHeight:int)

Set the line height for this object.

setShadow(shadow:boolean)

Set the shadow for this object.

setText(contents:string)

Set the text for this object.

getPoint(idx:int):number, number

Get the specified vertex of this object.

setPoint(idx:int, x:number, y:number)

Set the specified vertex of this object.

getPointCount():int

Get the number of verticies on this object.

insertPoint([idx:int, ]x:number, y:number)

Add a specified vertex to this object.

removePoint(idx:int)

Remove the specified vertex of this object.

getPosition():number, number

Get the position for this object.

setPosition(x:number, y:number)

Set the position for this object.

getSize():number, number

Get the size of this rectangle.

setSize(width:number, height:number)

Set the size of this rectangle.

getSize():number, number, number

Get the size of this box.

setSize(width:number, height:number, depth:number)

Set the size of this box.

isDepthTested():boolean

Determine whether depth testing is enabled for this object.

setDepthTested(depthTest:boolean)

Set whether depth testing is enabled for this object.

getPoint(idx:int):number, number, number

Get the specified vertex of this object.

setPoint(idx:int, x:number, y:number, z:number)

Set the specified vertex of this object.

recenter([offset:table])

Recenter this canvas relative to the current position.

getPosition():number, number, number

Get the position for this object.

setPosition(x:number, y:number, z:number)

Set the position for this object.

getRotation():nil|number, number, number

Get the rotation for this object, or nil if it faces the player.

setRotation([x:number, y:number, z:number])

Set the rotation for this object, passing nothing if it should face the player.

org.squiddev.plethora.integration.computercraft.MetaTileComputer

org.squiddev.plethora.integration.computercraft.MetaTileTurtle

{
  turtle = {
    color = 23,
    colour = 23,
    fuel = 100,
    left = nil,
    right = nil
  }
}

org.squiddev.plethora.integration.vanilla.meta.MetaBlock

Provide the registry name, display name and translation key of a block.

{
  displayName = "Dirt",
  name = "minecraft:dirt",
  translationKey = "tile.dirt"
}

org.squiddev.plethora.integration.vanilla.meta.MetaMaterial

{
  blocksLight = true,
  blocksMovement = true,
  burns = false,
  liquid = false,
  opaque = true,
  replaceable = false,
  requiresTool = true,
  solid = true
}

org.squiddev.plethora.integration.vanilla.meta.MetaBlockState

Provides some very basic information about a block and its associated state.

{
  harvestLevel = 0,
  harvestTool = "pickaxe",
  material = { «nested metadata» 
    blocksLight = true,
    blocksMovement = true,
    burns = false,
    liquid = false,
    opaque = true,
    replaceable = false,
    requiresTool = true,
    solid = true
  },
  metadata = 0,
  state = {
    variant = "stone"
  }
}

org.squiddev.plethora.integration.vanilla.meta.MetaEntity

Provides some basic information about an entity, such as their their UUID and name.

{
  displayName = "Experience Orb",
  id = "8a28378f-9b8f-4d5c-80e1-7544a01d7847",
  motionX = 0.5,
  motionY = 0,
  motionZ = 0,
  name = "XPOrb",
  pitch = 73,
  withinBlock = {
    x = 0,
    y = 0.2125,
    z = 0
  },
  x = 11.5,
  y = -0.2875,
  yaw = 30,
  z = -0.5
}

org.squiddev.plethora.integration.vanilla.meta.MetaEntityLiving

{
  armor = {
    boots = nil,
    chestplate = «reference to net.minecraft.item.ItemStack»,
    helmet = nil,
    leggings = nil
  },
  health = 20,
  heldItem = «reference to net.minecraft.item.ItemStack»,
  isAirborne = false,
  isAlive = true,
  isBurning = false,
  isChild = false,
  isDead = false,
  isElytraFlying = false,
  isInWater = false,
  isOnLadder = false,
  isRiding = false,
  isSleeping = false,
  isSneaking = false,
  isSprinting = false,
  isWet = false,
  maxHealth = 20,
  offhandItem = nil,
  potionEffects = {}
}

org.squiddev.plethora.integration.vanilla.meta.MetaEntities.ENTITY_ITEM

Provides the stack of a dropped item

{
  item = { «nested metadata» 
    count = 1,
    damage = 0,
    displayName = "Dirt",
    maxCount = 64,
    maxDamage = 0,
    name = "minecraft:dirt",
    nbtHash = nil,
    ores = {
      dirt = true
    },
    rawName = "tile.dirt.default"
  }
}

org.squiddev.plethora.integration.vanilla.meta.MetaEntities.ENTITY_SHEEP

Provides the wool colour of the sheep.

{
  woolColor = "green",
  woolColour = "green"
}

org.squiddev.plethora.integration.vanilla.meta.MetaEntityPlayer

{
  allowFlying = false,
  flySpeed = 0.05,
  food = {
    hunger = 20,
    hungry = false,
    saturation = 5
  },
  isFlying = false,
  walkSpeed = 0.1
}

org.squiddev.plethora.integration.computercraft.MetaItemPrintout

{
  printout = {
    lines = {},
    pages = 0,
    title = "My page",
    type = "Single"
  }
}

org.squiddev.plethora.integration.vanilla.meta.MetaItemBasic

{
  count = 5,
  damage = 0,
  displayName = "Stick",
  maxCount = 64,
  maxDamage = 0,
  name = "minecraft:stick",
  nbtHash = nil,
  rawName = "item.stick"
}

org.squiddev.plethora.integration.vanilla.meta.MetaItems.ITEM_FOOD

Provides the hunger and saturation this foodstuff restores.

{
  heal = 5,
  saturation = 0.6
}

org.squiddev.plethora.integration.vanilla.meta.MetaItems.ITEM_POTION

Provides the potion type and effects of this item.

{
  effects = {
    {
      amplifier = 0,
      color = 8171462,
      duration = 180,
      instant = false,
      name = "effect.moveSpeed"
    }
  },
  potion = "minecraft:swiftness",
  potionType = "normal"
}

org.squiddev.plethora.integration.vanilla.meta.MetaItems.ITEM_SPAWN_EGG

Provides information about items captured within spawn eggs.

{
  storedEntity = { «nested metadata» 
    armor = {
      boots = nil,
      chestplate = nil,
      helmet = nil,
      leggings = nil
    },
    displayName = "Bat",
    health = 6,
    heldItem = nil,
    id = "d684b351-21b0-4605-ab4e-ead67af8ab10",
    isAirborne = false,
    isAlive = true,
    isBurning = false,
    isChild = false,
    isDead = false,
    isElytraFlying = false,
    isInWater = false,
    isOnLadder = false,
    isRiding = false,
    isSleeping = false,
    isSneaking = false,
    isSprinting = false,
    isWet = false,
    maxHealth = 6,
    motionX = 0,
    motionY = 0,
    motionZ = 0,
    name = "Bat",
    offhandItem = nil,
    pitch = 0,
    potionEffects = {},
    withinBlock = {
      x = 0.5,
      y = 0.95,
      z = 0.5
    },
    x = 0,
    y = 0.45,
    yaw = 0,
    z = 0
  }
}

org.squiddev.plethora.integration.vanilla.meta.MetaItems.ITEM_TOOL_CLASS

Provides the tool classes an item may have.

{
  toolClass = {
    pickaxe = 3
  }
}

org.squiddev.plethora.integration.vanilla.meta.VanillaMeta.ENCHANTED_ITEM

Provides the enchantments on an item

{
  enchantments = {
    {
      fullName = "Unbreaking V",
      level = 5,
      name = "enchantment.durability"
    }
  }
}

org.squiddev.plethora.integration.computercraft.MetaItemComputer

{
  computer = {
    family = "Normal",
    id = 3,
    label = "My computer"
  }
}

org.squiddev.plethora.integration.vanilla.meta.MetaItemOreDict

{
  ores = {
    blockGlass = true,
    blockGlassColorless = true
  }
}

org.squiddev.plethora.integration.computercraft.MetaItemMedia

{
  media = {
    label = "My disk",
    recordTitle = nil
  }
}

org.squiddev.plethora.integration.plethora.MetaItemModule

org.squiddev.plethora.integration.computercraft.MetaItemTurtle

{
  turtle = {
    color = 65280,
    colour = 65280,
    fuel = 3000,
    left = {
      adjective = "upgrade.computercraft:advanced_modem.adjective",
      id = "computercraft:advanced_modem",
      type = "Peripheral"
    },
    right = nil
  }
}

org.squiddev.plethora.integration.vanilla.meta.MetaItemMaterial

{
  material = "DIAMOND"
}

org.squiddev.plethora.integration.vanilla.meta.MetaItemArmor

Provides type and colour of amour.

{
  armorType = "chest",
  color = 16711680,
  colour = 16711680
}

org.squiddev.plethora.integration.computercraft.MetaItemPocketComputer

{
  pocket = {
    back = {
      adjective = "upgrade.computercraft:speaker.adjective",
      id = "computercraft:speaker"
    },
    color = 16711680,
    colour = 16711680
  }
}

org.squiddev.plethora.integration.vanilla.meta.MetaItemBanner

{
  banner = {
    {
      color = "purple",
      colour = "purple",
      id = "cre",
      name = "creeper"
    }
  }
}

org.squiddev.plethora.integration.vanilla.meta.VanillaMeta.SPAWNER_LOGIC

Provides the entities that this spawner will spawn.

{
  spawnedEntities = {
    { «nested metadata» 
      armor = {
        boots = nil,
        chestplate = nil,
        helmet = nil,
        leggings = nil
      },
      displayName = "Squid",
      health = 10,
      heldItem = nil,
      id = "779c2d0f-8c3f-4709-9ecb-f562d51c5c9e",
      isAirborne = false,
      isAlive = true,
      isBurning = false,
      isChild = false,
      isDead = false,
      isElytraFlying = false,
      isInWater = false,
      isOnLadder = false,
      isRiding = false,
      isSleeping = false,
      isSneaking = false,
      isSprinting = false,
      isWet = false,
      maxHealth = 10,
      motionX = 0,
      motionY = 0,
      motionZ = 0,
      name = "Squid",
      offhandItem = nil,
      pitch = 0,
      potionEffects = {},
      withinBlock = {
        x = 0.5,
        y = 0.9,
        z = 0.5
      },
      x = 0,
      y = 0.4,
      yaw = 0,
      z = 0
    }
  }
}

org.squiddev.plethora.integration.vanilla.meta.VanillaMeta.TILE_SIGN

Provides the text upon the sign.

{
  lines = {
    "This is",
    "my rather fancy",
    "sign.",
    ""
  }
}

org.squiddev.plethora.integration.vanilla.meta.VanillaMeta.ENERGY

Provides the currently stored energy and capacity of a Forge Energy cell

{
  energy = {
    capacity = 50000,
    stored = 1000
  }
}

org.squiddev.plethora.integration.vanilla.meta.MetaFluidStack

Provides information about a fluid, as well as how much is currently stored.

{
  amount = 525,
  displayName = "Water",
  id = "minecraft:water",
  name = "water",
  rawName = "fluid.tile.water"
}

org.squiddev.plethora.integration.vanilla.meta.MetaFluidTank

{
  capacity = 1000
}

org.squiddev.plethora.integration.vanilla.meta.MetaFluidHandler

{
  tanks = {
    { «nested metadata» 
      amount = 525,
      capacity = 1000,
      displayName = "Water",
      id = "minecraft:water",
      name = "water",
      rawName = "fluid.tile.water"
    }
  }
}

org.squiddev.plethora.integration.vanilla.meta.MetaFluidTankProperties

{
  capacity = 1000
}

org.squiddev.plethora.integration.vanilla.meta.MetaDaylightSensor

Provides metadata about block light levels, when the daylight sensor module is attached.

org.squiddev.plethora.integration.vanilla.meta.MetaBlockReference

Provides information about blocks which exist in the world.

{
  color = 9923917,
  colour = 9923917,
  hardness = 0.5
}

org.squiddev.plethora.integration.MetaWrapper$MetaProvider

Simply wraps an object and exposes metadata for that.

You can happily ignore this.

org.squiddev.plethora.integration.vanilla.NullableItemStack$MetaNullableItemStack

Simply wraps an item stack with additional information.

Refer to the documentation on those instead for more information.