With Advanced Peripherals you can control your base in Minecraft only with messages in the chat, you can develop an AI that controls your farms - there really is no limit to what you can create with CC:Tweaked and Advanced Peripherals.
"},{"location":"#links","title":"Links","text":"If you need help, join the Discord See the mod page on Curseforge Find the mod source code on Github
"},{"location":"#version-support","title":"Version support","text":"Supported Version 1.16 1.17 1.18 1.19.2 1.19.3 1.19.4 1.20.1 1.20.2 Security patches Critical fixes Minor fixes Minor features Fully supported Will be supported"},{"location":"#netlify","title":"Netlify","text":"Netlify is a cloud computing company that offers a development platform for web applications and dynamic websites. It provides a unified workflow that integrates build tools, web frameworks, APIs, and various web technologies. The platform is designed to support the development, deployment, and scaling of websites whose source files are stored in Git and then generated into static web content files
"},{"location":"#contribute","title":"Contribute","text":"If you want to contribute to this documentation or fix any spelling mistakes, feel free to do so on the documentation Github, checkout the Contribute section in the README for more info.
Documentation rewrite and overhaul by SyntheticDev
"},{"location":"changelogs/0.7.24r/","title":"Changelog 1.18.2-0.7.24r / 1.19.3-0.7.23b","text":""},{"location":"changelogs/0.7.24r/#table-of-contents","title":"Table of Contents","text":"The 0.7.24r update brings some changes to our inventory system. All major and breaking changes are listed here to help with updating your scripts.
"},{"location":"changelogs/0.7.24r/#itemfluid-filter","title":"Item/Fluid Filter","text":"You may know that we use tables to filter for items for some of our inventory transferring functions. This system got a rework and is now used for more functions but also got some syntax changes.
Fluids also now use a filter system.
The following keys got removed: - json - tag
The nbt key now uses json typed nbt values like {nbt=\"{StoredEnchantments: [{lvl: 2s, id: \\\"minecraft:blast_protection\\\"}]}\"}
The name key can now search for tags.
{\n name=\"#minecraft:wool\" -- searches for the wool tag\n -- OR\n name=\"#forge:ores/gold\" -- searches for the forge gold tag\n -- OR\n name=\"minecraft:white_wool\" -- searches for white wool\n}\nYou CAN NOT search for multiple items/tags at once.
Item Filters can filter for slots with toSlot and fromSlot.
You can find the new filter documentation here
"},{"location":"changelogs/0.7.24r/#inventory-manager","title":"Inventory manager","text":"The following functions got deprecated:
removeItemFromPlayer(direction: string, count: int[, slot: int, item: string])
addItemToPlayer(direction: string, count: int[, slot: int, item: string])
removeItemFromPlayerNBT(direction: string, count: int[, slot: int, item: table])
addItemToPlayerNBT(direction: string, count: int[, slot: int, item: table])
These will be replaced in the next major update with the following two functions:
removeItemFromPlayer(direction: direction, string: table)
addItemToPlayer(direction: string, item: table)
The following functions now use the new filter system:
removeItemFromPlayerNBT(direction: string, count: int[, slot: int, item: filter])
addItemToPlayerNBT(direction: string, count: int[, slot: int, item: filter]))
Added the following functions to the me bridge:
getTotalItemStoragegetTotalFluidStoragegetUsedItemStoragegetUsedFluidStoragegetAvailableItemStoragegetAvailableFluidStoragelistCellsisConnectedMore functions now return a Method Result. This means they're capable to report errors if something wrong. For more information, refer to the documentation of the specific function. This is not a breaking change.
"},{"location":"changelogs/0.7r/","title":"Changelog 0.7r","text":""},{"location":"changelogs/0.7r/#table-of-contents","title":"Table of Contents","text":"First of all, big thanks to SirEdvin and FatalMerlin! These awesome hoomans helped a lot with this update!
"},{"location":"changelogs/0.7r/#video","title":"Video","text":"If you don't want to read, you can watch this wonderful short video!
"},{"location":"changelogs/0.7r/#features","title":"Features","text":""},{"location":"changelogs/0.7r/#new-integrations","title":"New Integrations","text":""},{"location":"changelogs/0.7r/#integrated-dynamics-integration","title":"Integrated Dynamics Integration","text":"We added a peripheral to the \"Variable Store\" Block from Integrated Dynamics to read variables from integrated dynamics."},{"location":"changelogs/0.7r/#view-here","title":"View here","text":""},{"location":"changelogs/0.7r/#storage-drawer-integration","title":"Storage Drawer Integration","text":"You can now access Storage Drawers. Store items, push and pull items or do whatever you want to do with items. This new feature is a mod integration.
"},{"location":"changelogs/0.7r/#view-here_1","title":"View here","text":""},{"location":"changelogs/0.7r/#new-peripherals","title":"New Peripherals","text":""},{"location":"changelogs/0.7r/#colony-integrator","title":"Colony Integrator","text":"We added the Colony Integrator that interacts with MineColonies. You can use this peripheral to get information about your colony. It can be used as a pocket upgrade or as a block."},{"location":"changelogs/0.7r/#view-here_2","title":"View here","text":""},{"location":"changelogs/0.7r/#geo-scanner","title":"Geo Scanner","text":"The Geo Scanner provides information about blocks around it and information about the current chunk. You could use it to search the current chunk and nearby blocks for ores.
"},{"location":"changelogs/0.7r/#view-here_3","title":"View here","text":""},{"location":"changelogs/0.7r/#block-reader","title":"Block Reader","text":"With the Block Reader you can read the data of neighboring blocks and tile entites.
"},{"location":"changelogs/0.7r/#view-here_4","title":"View here","text":""},{"location":"changelogs/0.7r/#nbt-storage","title":"NBT Storage","text":"With the NBT Storage peripheral you are able to store tables or other values into a block as NBT data. You can read and write values to the block with the peripheral functions.
"},{"location":"changelogs/0.7r/#view-here_5","title":"View here","text":""},{"location":"changelogs/0.7r/#new-turtles-upgrades","title":"New Turtles Upgrades","text":"New powerful turtle upgrades! With these small upgrades you finally can use any tools just from turtle inventories, perform right click on blocks, collect items in a small range, transport animals and much more! But be aware, the new abilities require fuel and most of them have a cooldown. Big thanks to SirEdvin who made these upgrades.
"},{"location":"changelogs/0.7r/#new-ingame-documentation","title":"New Ingame Documentation","text":"Advanced Peripherals now uses Patchouli to generate ingame documentation. You can now get quick information about the mod in-game, without the need for internet access!
"},{"location":"changelogs/0.7r/#small-features-and-improvements","title":"Small features and improvements","text":"This update also provides a lot of small features and improvements.
"},{"location":"changelogs/0.7r/#breaking-changes","title":"Breaking changes","text":"uuid and isHidden return values to the chat event.sendFormattedMessage function to the chat box.You can now connect supported blocks directly with a modem. We completely removed the Peripheral Proxy.
"},{"location":"changelogs/0.7r/#support-for-relative-and-cardinal-directions","title":"Support for relative and cardinal directions","text":"You can now use relative directions (right, left, front, back, top bottom) and cardinal directions (north, south, east, west, up, down) at the same time. Example:
-- Both of these will work\nredstoneIntegrator.setOutput(\"north\", true)\nredstoneIntegrator.setOutput(\"right\", true)\n* Not all fixed bugs are listed here
For information on the different types of cooldowns and operations that a turtle may have see the Automatas:
All world changing operations will consume turtle fuel (unless it is disabled in the CC:Tweaked configuration). Most of these operations have cooldowns, so you should consider this in your code. Hopefully, every active cooldown can be retrieved via peripheral methods.
"},{"location":"guides/cooldowns_and_fuel_consumption/#consumption-vs-cooldowns","title":"Consumption vs Cooldowns","text":"Higher fuel consumption rate will reduce operation cooldowns, but obviously will increase the consumption of fuel. For example, if a click operation required 1 fuel point to perform and has a 5 second cooldown; with a fuel consumption rate of 2 you can perform a click operation every 2.5 seconds, but at the cost of 2 fuel points.
"},{"location":"guides/cooldowns_and_fuel_consumption/#maximum-fuel-consumption","title":"Maximum fuel consumption","text":"However, fuel consumption rate is not so simple! Every mechanic soul has a max fuel consumption limitation, that can be retrieved via the getConfiguration() method.
Also, the number of required fuel points increases faster than fuel consumption for every reduction in cooldowns. Fuel consumption 3 requires 4 fuel points, fuel consumption 4 requires 6 fuel points, etc.
"},{"location":"guides/filters/","title":"Filters","text":"
Added in version 1.18.2-0.7.24r and 1.19.3-0.7.23b
The tables which are added to one of our item/fluid transferring functions are called Item/Fluid Filters. The functions use these to find the item you're looking for. These can set the item, count, slots, tags, nbt or fingerprint values.
"},{"location":"guides/filters/#syntax","title":"Syntax","text":""},{"location":"guides/filters/#itemfluid-name-and-tag","title":"Item/Fluid Name and Tag","text":"The item's/fluid's filter name or tag can be specified with the name field. If this field is not set, the filter will try to search for items with the right nbt values specified in the nbt field or fingerprints.
This can be a tag or a name. To filter for tags, place a # in front of the name.
{\n name = \"minecraft:enchanted_book\" -- Will just search for an enchanted book, nbt values are ginored\n}\n{\n name = \"#forge:ores/gold\" -- Will search for the gold ore tag, nbt values are ignored\n}\nThe item's/fluid's filter amout can be specified with the count field. Standard values are 64 or 1000 for fluids.
{\n name = \"minecraft:cobblestone\",\n count = 128000 -- Will try to export 128000 cobblestone to the target inventory. It will transfer less if there is not enough space in the target inventory or if there aren't enough items in the source inventory\n}\nNBT Values are specified with the nbt field. The field needs to be a string which contains a json which can be parsed to a nbt tag.
{\n name = \"minecraft:enchanted_book\" \n nbt=\"{StoredEnchantments: [{lvl: 2s, id: \\\"minecraft:blast_protection\\\"}]}\"} -- Will search for an enchanted book with the blast protection enchantment level 2\n}\nAny strings inside the nbt value needs to be prefixed with a \\
"},{"location":"guides/filters/#slots","title":"Slots","text":"Only available for item filters
Slots can be specified with the toSlot or fromSlot field. The inventory manager uses 103-100 for the armor slots helmet to boots and 36 for the offhand.
Storage systems like the rs or me bridge will ignore these fields if they are used to specify the slot of the system. Like toSlot if you use it for importItem
If the slot can't be found or if the slot can't accept this item, the item will not be transferred.
{\n toSlot = 6, -- Tries to move the item to this slot of the target inventory\n fromSlot = 36, -- Tries to remove the item from the offhand\n}\nThe fingerprint is a MD5 hash calculated of the nbt tag, the registry name and the display name.
This can be useful if you want to only filter for one very specific item. Also helpful if you don't want to copy the nbt tag for an item into the filter.
A fingerprint can be generated with the /advancedperipherals getHashItem command while holding the item in your main hand.
If the fingerpring field is specified, the nbt and name field will be ignored.
{\n fingerprint = \"227FCCBE693942047DD04AA96F735F2E\" -- The hash for a protection 4 enchanted book\n count = 5 -- Try to move 5 protection 4 books to the target inventory\n}\nWe appreciate your dedication to making the project better by helping us squash those pesky bugs and suggesting exciting new features. The process of reporting a bug or requesting a new feature is straightforward and user-friendly. Here's how to do it:
"},{"location":"guides/how_to_report/#reporting-a-bug","title":"Reporting a Bug","text":"Expected Behavior: Start by describing what you expected to happen when you encountered the bug. This helps us understand the issue better.
Steps to Reproduce: Provide a clear, step-by-step guide on how to reproduce the bug. Include every detail, like which items you used, where you were, and what actions you took.
Logs: If the bug is critical, or you're not sure what's causing it, including logs can be a game-changer. Share any error messages or log files related to the issue.
Pictures: A picture is worth a thousand words! If you can, add screenshots to visually demonstrate the problem.
Optional - Video: Want to be an awesome bug hunter? Record a short video showing the bug in action. It can make the bug-hunting process even smoother!
"},{"location":"guides/how_to_report/#requesting-a-feature","title":"Requesting a Feature","text":"Clear Description: Tell us exactly what you want to see in the mod. Be specific and clear about the new features purpose.
API Functions: If your feature request involves changes or additions to the Lua functions, let us know which functions or methods you'd like to see added or modified.
Use Cases: Explain how this new feature would enhance your gameplay. Share scenarios where it would come in handy.
Remember, our modding community is built on collaboration and a love for Minecraft. Be friendly and respectful in your reports and requests.
To report a bug or request a feature, head over to our github repository. Your feedback is important to us, and it makes the project what it is today!
If you need assistance or want to discuss a feature or something else, head out to our discord
"},{"location":"integrations/","title":"Mod Integrations","text":""},{"location":"integrations/#how-do-they-work","title":"How do they work?","text":"To use our third party integrations you can simply place your computer or a modem next to a supported block and wrap it. If the block is supported, you can use the functions it'll provide, see the block's specific page for more information.
Example with a botania mana flower:
local flower = peripheral.find(\"manaFlower\")\n\nprint(\"Stored mana: \".. flower.getMana())\nprint(\"Mana capacity: \".. flower.getMaxMana())\nprint(\"Is on enchanted soul?: \".. flower.isOnEnchantedSoil())\nIf you want to see more integrations, you can request a mod integration on Github.
"},{"location":"integrations/#changelogtrivia","title":"Changelog/Trivia","text":"0.7.16 Added Create and Botania integrations
0.7.7r Removed Draconic Evolution integration
0.7.4r Added Draconic Evolution integration
0.7r Removed the Peripheral Proxy, you can now connect your computer with any supported block directly. Added Integrated Dynamics integration Added Storage Drawers integration
0.6b Added mod integrations with the Peripheral Proxy
"},{"location":"integrations/botania/flowers/","title":"Mana Generating Flowers","text":"Available in all versions
Picture
Mana generating flowers from botania can generate mana for other recipes or rituals.
Requirement
Requires the Botania mod to be installed
Peripheral Name Interfaces with Has events Introduced in manaFlower Mana flowers No 0.6b
"},{"location":"integrations/botania/flowers/#functions","title":"Functions","text":""},{"location":"integrations/botania/flowers/#getmana","title":"getMana","text":"getMana() -> number\ngetMaxMana() -> number\nisFloating() -> boolean\nisOnEnchantedSoil() -> boolean\n0.7.16 Ported Botania integration to 1.18
0.6b Added integration for Botania
"},{"location":"integrations/botania/pool/","title":"Mana Pool","text":"Available in all versions
Picture
Mana Pools are used to store mana. They are also used to craft items.
Requirement
Requires the Botania mod to be installed
Peripheral Name Interfaces with Has events Introduced in manaPool Mana Pool block No 0.6b
"},{"location":"integrations/botania/pool/#functions","title":"Functions","text":""},{"location":"integrations/botania/pool/#getmana","title":"getMana","text":"getMana() -> number\ngetMaxMana() -> number\ngetManaNeeded() -> number\nAdded in version 0.7.4r
Returns the amount of mana needed to fill the pool. Equivalent to getMaxMana() - getMana().
isEmpty() -> boolean\nisFull() -> boolean\n0.7.16 Ported Botania integration to 1.18
0.7.4r Added getManaNeeded to the Mana Pool integration
0.6b Added integration for Botania
"},{"location":"integrations/botania/spreader/","title":"Mana Spreader","text":"Available in all versions
Picture
Mana Spreaders are used to transfer mana from one source to another.
Requirement
Requires the Botania mod to be installed
Peripheral Name Interfaces with Has events Introduced in manaSpreader Mana Spreader block No 0.6b
"},{"location":"integrations/botania/spreader/#functions","title":"Functions","text":""},{"location":"integrations/botania/spreader/#getmana","title":"getMana","text":"getMana() -> number\ngetMaxMana() -> number\nisEmpty() -> boolean\nisFull() -> boolean\ngetVariant() -> string\ngetBounding() -> table\nnumber The x coordinate y: number The y coordinate z: number The z coordinate"},{"location":"integrations/botania/spreader/#changelogtrivia","title":"Changelog/Trivia","text":"0.7.16 Ported Botania integration to 1.18
0.6b Added integration for Botania
"},{"location":"integrations/create/basin/","title":"Basin","text":"Available in versions 1.18+
Picture
A Basin can hold items and fluids for many different crafting recipes.
Requirement
Requires the Create mod to be installed
Peripheral Name Interfaces with Has events Introduced in basin Basin block No 0.7.16
"},{"location":"integrations/create/basin/#functions","title":"Functions","text":""},{"location":"integrations/create/basin/#getinputfluids","title":"getInputFluids","text":"getInputFluids() -> table\ngetOutputFluids() -> table\ngetFilter() -> table\ngetInventory() -> table\n0.7.16 Added Create integration
"},{"location":"integrations/create/blazeburner/","title":"Blaze Burner","text":"Available in all versions
Picture
A Blaze Burner uses different fuel types to heat up things above it like basins and fluid tanks.
Requirement
Requires the Create mod to be installed
Peripheral Name Interfaces with Has events Introduced in blazeBurner Blaze Burner block No 0.7.16
"},{"location":"integrations/create/blazeburner/#functions","title":"Functions","text":""},{"location":"integrations/create/blazeburner/#getinfo","title":"getInfo","text":"getInfo() -> table\nstring The type of fuel in the burner heatLevel: string The blaze burner heat level remainingBurnTime: number The amount of burn time left for the current fuel isCreative: boolean If the burner is using creative fuel"},{"location":"integrations/create/blazeburner/#changelogtrivia","title":"Changelog/Trivia","text":"0.7.16 Added Create integration
"},{"location":"integrations/create/fluidtank/","title":"Fluid Tank","text":"Available in versions 1.18+
Picture
A Fluid Tank is a multiblock structure which can hold fluids. With each block being able to hold 8 buckets worth.
Requirement
Requires the Create mod to be installed
Peripheral Name Interfaces with Has events Introduced in fluidTank Fluid Tank block No 0.7.16
"},{"location":"integrations/create/fluidtank/#functions","title":"Functions","text":""},{"location":"integrations/create/fluidtank/#getinfo","title":"getInfo","text":"getInfo() -> table\nnumber The maximum amount of fluid the tank can hold amount: number The amount of fluid in the tank fluid: string The registry name for the tank's current fluid isBoiler: boolean If the tank is part of a boiler"},{"location":"integrations/create/fluidtank/#changelogtrivia","title":"Changelog/Trivia","text":"0.7.16 Added Create integration
"},{"location":"integrations/create/mechanicalmixer/","title":"Mechanical Mixer","text":"Available in versions 1.18+
Picture
A Mechanical Mixer is used in combination with a Basin to process many shapeless recipes with items and fluid.
Requirement
Requires the Create mod to be installed
Peripheral Name Interfaces with Has events Introduced in mechanicalMixer Mechanical Mixer block No 0.7.16
"},{"location":"integrations/create/mechanicalmixer/#functions","title":"Functions","text":""},{"location":"integrations/create/mechanicalmixer/#isrunning","title":"isRunning","text":"isRunning() -> boolean\nhasBasin() -> boolean\n0.7.16 Added Create integration
"},{"location":"integrations/create/scrollbehaviour/","title":"Blocks with Scroll Value Behaviours","text":"Available in all versions
This integration works for all blocks with any type of scroll value behaviour. Like the Speed Controller and Creative Motor.
Info
This integration only works for Speed based scroll value behaviour blocks. So this will not work for blocks like the Smart Funnel.
Requirement
Requires the Create mod to be installed
Peripheral Name Interfaces with Has events Introduced in scrollBehaviourEntityspeedController (1.16) Scroll Value Behaviour blocks No 0.7.16
"},{"location":"integrations/create/scrollbehaviour/#functions","title":"Functions","text":""},{"location":"integrations/create/scrollbehaviour/#gettargetspeed","title":"getTargetSpeed","text":"getTargetSpeed() -> number\nsetTargetSpeed(value: number) -> boolean\nvalue. Returns whether or not the value was successfully set."},{"location":"integrations/create/scrollbehaviour/#changelogtrivia","title":"Changelog/Trivia","text":"0.7.16 Added Create integration
"},{"location":"integrations/draconic_evolution/","title":"Draconic Evolution","text":"Only available in versions =>1.16-0.7.4r, <1.16-0.7.7r
The Draconic Evolution integration was only briefly available in the mod. Hence the documentation for the mod's integrations have been excluded from the side navigation. However, if needed they can still be accessed using the links below:
"},{"location":"integrations/draconic_evolution/#docs","title":"Docs","text":"0.7.7r Removed Draconic Evolution integration
0.7.4r Added Draconic Evolution integration
"},{"location":"integrations/draconic_evolution/energy_core/","title":"Energy core","text":"Go Back"},{"location":"integrations/draconic_evolution/energy_core/#draconic-energy-core","title":"Draconic Energy Core","text":"Only available in versions =>1.16-0.7.4r, <1.16-0.7.7r
Picture
The Draconic Energy Core is a multiblock structure which can store massive amounts of energy.
Requirement
Requires the Draconic Evolution mod to be installed
"},{"location":"integrations/draconic_evolution/energy_core/#functions","title":"Functions","text":""},{"location":"integrations/draconic_evolution/energy_core/#getenergystored","title":"getEnergyStored","text":"getEnergyStored() -> number\ngetMaxEnergyStored() -> number\ngetTransferPerTick() -> number\ngetTier() -> number\n0.7.4r Added Draconic Evolution integration
"},{"location":"integrations/draconic_evolution/reactor/","title":"Reactor","text":"Go Back"},{"location":"integrations/draconic_evolution/reactor/#draconic-reactor","title":"Draconic Reactor","text":"Only available in versions =>1.16-0.7.4r, <1.16-0.7.7r
Picture
The Draconic Reactor is a powerful reactor used to create a massive amount of energy.
Requirement
Requires the Draconic Evolution mod to be installed
"},{"location":"integrations/draconic_evolution/reactor/#functions","title":"Functions","text":""},{"location":"integrations/draconic_evolution/reactor/#getreactorinfo","title":"getReactorInfo","text":"getReactorInfo() -> table\nchargeReactor() -> boolean\nactivateReactor() -> boolean\nstopReactor() -> boolean\nsetFailSafe(enabled: boolean) -> void\n0.7.4r Added Draconic Evolution integration
"},{"location":"integrations/immersive_engineering/connector/","title":"Redstone Wire Connector","text":"Only available in version 1.16
Picture
The Redstone Wire Connector is a block from Immersive Engineering to connect redstone wire over big distances.
Requirement
Requires the Immersive Engineering mod to be installed
Peripheral Name Interfaces with Has events Introduced in redstoneConnector Redstone Wire Connector block No 0.6b
"},{"location":"integrations/immersive_engineering/connector/#functions","title":"Functions","text":""},{"location":"integrations/immersive_engineering/connector/#getredstonechannel","title":"getRedstoneChannel","text":"getRedstoneChannel() -> string\nsetRedstoneChannel(color: string) -> void\ncolor channel for the connector."},{"location":"integrations/immersive_engineering/connector/#getredstoneforchannel","title":"getRedstoneForChannel","text":"getRedstoneForChannel(color: string) -> number\ncolor channel. A number from 0 to 15."},{"location":"integrations/immersive_engineering/connector/#getoutput","title":"getOutput","text":"getOutput() -> number\nisInputMode() -> boolean\n0.6b Added integration for Immersive Engineering
"},{"location":"integrations/immersive_engineering/probe/","title":"Redstone Probe","text":"Only available in version 1.16
Picture
The Redstone Probe is a block from Immersive Engineering used to read and write data to a specific redstone channel.
Requirement
Requires the Immersive Engineering mod to be installed
Peripheral Name Interfaces with Has events Introduced in redstoneProbe Redstone Probe block No 0.6b
"},{"location":"integrations/immersive_engineering/probe/#functions","title":"Functions","text":""},{"location":"integrations/immersive_engineering/probe/#getsendingchannel","title":"getSendingChannel","text":"getSendingChannel() -> string\nsetSendingChannel(color: string) -> void\ncolor channel."},{"location":"integrations/immersive_engineering/probe/#getreceivingchannel","title":"getReceivingChannel","text":"getReceivingChannel() -> string\nsetReceivingChannel(color: string) -> void\ncolor channel."},{"location":"integrations/immersive_engineering/probe/#getredstoneforchannel","title":"getRedstoneForChannel","text":"getRedstoneForChannel(color: string) -> number\ncolor channel. A number from 0 to 15."},{"location":"integrations/immersive_engineering/probe/#changelogtrivia","title":"Changelog/Trivia","text":"0.6b Added integration for Immersive Engineering
"},{"location":"integrations/integrated_dynamics/variable_store/","title":"Variable Store","text":"Only available in version 1.16
Picture
The Variable Store is a block from Integrated Dynamics that can store variables for future use.
Requirement
Requires the Integrated Dynamics mod to be installed
Peripheral Name Interfaces with Has events Introduced in variableStore Variable Store block No 0.7r
"},{"location":"integrations/integrated_dynamics/variable_store/#functions","title":"Functions","text":""},{"location":"integrations/integrated_dynamics/variable_store/#list","title":"list","text":"list() -> table\nstring The variable's id label: string The label name for the variable type: string The type of the variable dynamic: boolean If the variable is dynamic"},{"location":"integrations/integrated_dynamics/variable_store/#read","title":"read","text":"read(slot: number) -> table | nil, string\nslot. Or nil and an error message."},{"location":"integrations/integrated_dynamics/variable_store/#properties_1","title":"Properties","text":"variable Description id: string The variable's id label: string The label name for the variable type: string The type of the variable value: string The NBT representation of the stored value dynamic: boolean If the variable is dynamic"},{"location":"integrations/integrated_dynamics/variable_store/#changelogtrivia","title":"Changelog/Trivia","text":"0.7r Added integration for Integrated Dynamics
"},{"location":"integrations/mekanism/","title":"Mekanism","text":"Only available in versions =>1.16-0.6b, <1.16-0.7.7r
The Mekanism integration was removed from the mod due to mekanism adding CC:Tweaked support internally. Hence the documentation for the mod's integrations have been excluded from the side navigation. For updated documentation on mekanism integration see the Mekanism wiki. If needed the old docs can still be accessed using the links below:
"},{"location":"integrations/mekanism/#docs","title":"Docs","text":"0.7.7r Removed Mekanism integration
0.6b Added integration for Mekanism
"},{"location":"integrations/mekanism/boiler/","title":"Boiler","text":"Go Back"},{"location":"integrations/mekanism/boiler/#boiler","title":"Boiler","text":"Picture
Mod: Mekanism Block: Boiler Valve
The Themoelectric Boiler is a multiblock structure from mekanism to generate steam or other gases.
Info
Energy functions will always return in FE. If you want it in joules, multiply the value with 2.5
The functions which returns a value in percent, will return a number between 1-0. (50% would be 0.5)
"},{"location":"integrations/mekanism/boiler/#functions","title":"Functions","text":"Function Returns Description getCoolant() table Returns the type of coolant and the amount. getCoolantCapacity() int Returns capacity of the coolant tank. getCoolantNeeded() int Returns the coolant that is needed the tank is full. getCoolantFilledPercentage() int Returns the amount of the coolant in percent. getHeatedCoolant() table Returns the type of heated coolant and the amount. getHeatedCoolantCapacity() int Returns capacity of the heated coolant tank. getHeatedCoolantNeeded() int Returns the amount of heated coolant that is needed to fill the tank. getHeatedCoolantFilledPercentage() int Returns the amount of the heated coolant in percent. getWater() int Returns the amount of the water. getWaterCapacity() int Returns the capacity of the water. getWaterNeeded() int Returns the amount of water that is needed to fill the tank. getWaterFilledPercentage() int Returns the amount of the water in percent. getSteam() int Returns the stored amount of the water. getSteamCapacity() int Returns the capacity of the steam. getSteamNeeded() int Returns the amount of steam that is needed to fill the tank. getSteamFilledPercentage() int Returns the amount of the steam in percent. getEnvironmentalLoss() int Returns the environmental loss. getTemperature() int Returns the temperature of the reactor. getBoilRate() int Returns the boil rate. getMaxBoilRate() int Returns the max boil rate. getSuperheaters() int Returns the amount of superheating elements. getBoilCapacity() int Returns the capacity of the boiler."},{"location":"integrations/mekanism/boiler/#changelogtrivia","title":"Changelog/Trivia","text":"0.6b Added integration for Mekanism
"},{"location":"integrations/mekanism/chemical/","title":"Chemical","text":"Go Back"},{"location":"integrations/mekanism/chemical/#chemical-tank","title":"Chemical Tank","text":"Picture
Mod: Mekanism Block: Chemical Tank
Chemical Tanks are used to store Gases. They can be placed as a block and can interact with Pressurized Tubes. They come in the four tiers, each tier being double the capacity and output rate of its predecessor. It can store the following gases:
Info
The functions which returns a value in percent, will return a number between 1-0. (50% would be 0.5)
"},{"location":"integrations/mekanism/chemical/#functions","title":"Functions","text":"Function Returns Description getStored() table Returns the type and the amount of the chemical. getCapacity() int Returns the capacity. getFilledPercentage() int Returns the amount of the stored chemical in percent. getNeeded() int Returns the amount of chemicals that is needed to fill the tank."},{"location":"integrations/mekanism/chemical/#changelogtrivia","title":"Changelog/Trivia","text":"0.6.6b Added integration for the chemical tank
"},{"location":"integrations/mekanism/digital_miner/","title":"Digital miner","text":"Go Back"},{"location":"integrations/mekanism/digital_miner/#fission-reactor","title":"Fission Reactor","text":"Picture
Mod: Mekanism Block: Digital Miner
The Digital Miner is the scale mining machine of Mekanism. However, this machine is like no other as it \"magically-teleports\" mined blocks to its inventory.
Info
Energy functions will always return in FE. If you want it in joules, multiply the value with 2.5
The functions which returns a value in percent, will return a number between 1-0. (50% would be 0.5)
"},{"location":"integrations/mekanism/digital_miner/#functions","title":"Functions","text":"Function Returns Description getDelay() int Returns the delay between two mining operations. getRadius() int Returns the radius. setRadius(int radius) Set the radius. getMinY() int Returns the minium mining high. setMinY(int high) Set the minium mining high. getMaxY() int Returns the maximum mining high. setMaxY(int high) Set the maximum mining high. toggleSilkTouch() Toggles the silk touch mode. toggleInverse() Toggles the inverse mode. toggleAutoEject() Toggles the auto eject mode. toggleAutoPull() Toggles the auto pull mode. start() Starts the miner. stop() Stops the miner. reset() Resets the miner. getTotalEnergyFilledPercentage() int Returns the amount of the energy in percent."},{"location":"integrations/mekanism/digital_miner/#changelogtrivia","title":"Changelog/Trivia","text":"0.6.5b Added the digital miner integration
"},{"location":"integrations/mekanism/dynamic_tank/","title":"Dynamic tank","text":"Go Back"},{"location":"integrations/mekanism/dynamic_tank/#dynamic-tank","title":"Dynamic Tank","text":"Picture
Mod: Mekanism Block: Dynamic Tank Valve
The Dynamic tank is a multiblock structure from mekanism to store fluids, gases and more.
Info
Energy functions will always return in FE. If you want it in joules, multiply the value with 2.5
The functions which returns a value in percent, will return a number between 1-0. (50% would be 0.5)
"},{"location":"integrations/mekanism/dynamic_tank/#functions","title":"Functions","text":"Function Returns Description getStored() table Returns a table with the amount, the name of the stored type and the current type(fluid, gas, ...). getCapacity() int Returns the capacity of the tank. getFilledPercentage int Returns the amount in percent. getNeeded() int Returns the amount that is needed to fill the tank. isEmpty() boolean Returns true if the tank is empty."},{"location":"integrations/mekanism/dynamic_tank/#changelogtrivia","title":"Changelog/Trivia","text":"0.7.3r Added dynamic tank integration
0.6b Added integration for Mekanism
"},{"location":"integrations/mekanism/fission/","title":"Fission","text":"Go Back"},{"location":"integrations/mekanism/fission/#fission-reactor","title":"Fission Reactor","text":"Picture
Mod: Mekanism Block: Fission Reactor Logic Adapter
The Fission Reactor is a reactor from Mekanism.
Info
Energy functions will always return in FE. If you want it in joules, multiply the value with 2.5
The functions which returns a value in percent, will return a number between 1-0. (50% would be 0.5)
"},{"location":"integrations/mekanism/fission/#functions","title":"Functions","text":"Function Returns Description getCoolant() table Returns the type of coolant and the amount. getCoolantCapacity() int Returns capacity of the coolant tank. getCoolantNeeded() int Returns the coolant that is needed the tank is full. getCoolantFilledPercentage() int Returns the amount of the coolant in percent. getHeatedCoolant() table Returns the type of heated coolant and the amount. getHeatedCoolantCapacity() int Returns capacity of the heated coolant tank. getHeatedCoolantNeeded() int Returns the amount of heated coolant that is needed to fill the tank. getHeatedCoolantFilledPercentage() int Returns the amount of the heated coolant in percent. getFuel() int Returns the amount of fuel. getFuelCapacity() int Returns capacity of the fuel tank. getFuelNeeded() int Returns the amount of fuel that is needed to fill the tank. getFuelFilledPercentage() int Returns the amount of the fuel in percent. getWaste() int Returns the amount of waste. getWasteCapacity() int Returns capacity of the waste tank. getWasteNeeded() int Returns the waste that is needed to fill the tank. getWasteFilledPercentage() int Returns the amount of the waste in percent. getStatus() booleans Returns true if the reactor is active false if not. scram() Deactivates the reactor. activate() Activates the reactor. getBurnRate() int Returns the burn rate of the reactor that is set. setBurnRate(int rate) Set the burn rate. getActualBurnRate() int Actual burn rate as it may be lower if say there is not enough fuel . getMaxBurnRate() int Returns the max burn rate. getDamagePercent() int Returns the damage in percent. getHeatingRate() int Returns the heating rate. getEnvironmentalLoss() int Returns the environmental loss. getTemperature() int Returns the temperature of the reactor. getHeatCapacity() int Returns the max temperature. getFuelAssemblies() int Returns the amount of fuel assemblies. getFuelSurfaceArea() int Returns the surface area of the fuel. getBoilEfficiency() int getActualBurnRate() int Actual burn rate as it may be lower if say there is not enough fuel . getMaxBurnRate() int Returns the max burn rate. getDamagePercent() int Returns the damage in percent. getHeatingRate() int Returns the heating rate. getEnvironmentalLoss() int Returns the environmental loss."},{"location":"integrations/mekanism/fission/#changelogtrivia","title":"Changelog/Trivia","text":"0.6b Added integration for Mekanism
"},{"location":"integrations/mekanism/fluid_tank/","title":"Fluid tank","text":"Go Back"},{"location":"integrations/mekanism/fluid_tank/#fluid-tank","title":"Fluid Tank","text":"Picture
Mod: Mekanism Block: Fluid Tanks
Fluid Tanks are tanks from mekanism to store fluids, obviously.
Info
Energy functions will always return in FE. If you want it in joules, multiply the value with 2.5
The functions which returns a value in percent, will return a number between 1-0. (50% would be 0.5)
"},{"location":"integrations/mekanism/fluid_tank/#functions","title":"Functions","text":"Function Returns Description getStored() table Returns a table with the amount and the name of the stored type. getTier() string Returns the tier of the tank(Basic, Advanced, ...). getCapacity() int Returns the capacity of the tank. getFilledPercentage int Returns the amount in percent. getNeeded() int Returns the amount that is needed to fill the tank."},{"location":"integrations/mekanism/fluid_tank/#changelogtrivia","title":"Changelog/Trivia","text":"0.7.2r Added fluid tank integration
0.6b Added integration for Mekanism
"},{"location":"integrations/mekanism/fusion/","title":"Fusion","text":"Go Back"},{"location":"integrations/mekanism/fusion/#fusion-reactor","title":"Fusion Reactor","text":"Picture
Mod: Mekanism Block: Fusion Reactor Logic Adapter
The Fusion Reactor is a reactor from Mekanism.
Info
Energy functions will always return in FE. If you want it in joules, multiply the value with 2.5
The functions which returns a value in percent, will return a number between 1-0. (50% would be 0.5)
"},{"location":"integrations/mekanism/fusion/#functions","title":"Functions","text":"Function Returns Description getHohlraum() table Returns the item stack of the hohlraum. getPlasmaTemperature() int Returns the temperature of the plasma. getCaseTemperature() int Returns the temperature of the case. getWater() int Returns the amount of the water. getWaterCapacity() int Returns the capacity of the water. getWaterNeeded() int Returns the amount of water that is needed to fill the tank. getWaterFilledPercentage() int Returns the amount of the water in percent. getSteam() int Returns the stored amount of the water. getSteamCapacity() int Returns the capacity of the steam. getSteamNeeded() int Returns the amount of steam that is needed to fill the tank. getSteamFilledPercentage() int Returns the amount of the steam in percent. getTritium() int Returns the amount of the tritium. getTritiumCapacity() int Returns the capacity of the tritium. getTritiumNeeded() int Returns the amount of tritium that is needed to fill the tank. getTritiumFilledPercentage() int Returns the amount of the tritium in percent. getDeuterium() int Returns the stored amount of the deuterium. getDeuteriumCapacity() int Returns the capacity of the deuterium. getDeuteriumNeeded() int Returns the amount of deuterium that is needed to fill the tank. getDeuteriumFilledPercentage() int Returns the amount of the deuterium in percent. getDTFuel() int Returns the stored amount of the dt-fuel. getDTFuelCapacity() int Returns the capacity of the dt-fuel. getDTFuelNeeded() int Returns the amount of dt-fuel that is needed to fill the tank. getDTFuelFilledPercentage() int Returns the amount of the dt-fuel in percent. getProduction() int Returns the energy production. getInjectionRate() int Returns the injection rate. setInjectionRate(int rate) Set the injection rate. getPassiveGeneration(boolean isWaterCooled) int Returns the passive generation."},{"location":"integrations/mekanism/fusion/#changelogtrivia","title":"Changelog/Trivia","text":"0.6b Added integration for Mekanism
"},{"location":"integrations/mekanism/generic/","title":"Generic","text":"Go Back"},{"location":"integrations/mekanism/generic/#generic-mekanism-machine","title":"Generic Mekanism Machine","text":"Picture
Mod: Mekanism Block: Any energy supporting block
This proxy integration will add a integration for every energy supporting machine from Mekanism.
Info
Energy functions will always return in FE. If you want it in joules, multiply the value with 2.5
The functions which returns a value in percent, will return a number between 1-0. (50% would be 0.5)
"},{"location":"integrations/mekanism/generic/#functions","title":"Functions","text":"Function Returns Description getTotalEnergy() int Returns the amount of stored energy. getTotalEnergyNeeded() int Returns the amount of energy that is needed to fill the block. getTotalEnergyFilledPercentage() int Returns the amount of the energy in percent. getTotalMaxEnergy() int Returns the capacity of the machine."},{"location":"integrations/mekanism/generic/#changelogtrivia","title":"Changelog/Trivia","text":"0.6b Added integration for Mekanism
"},{"location":"integrations/mekanism/induction/","title":"Induction","text":"Go Back"},{"location":"integrations/mekanism/induction/#induction-matrix","title":"Induction Matrix","text":"Picture
Mod: Mekanism Block: Induction Valve
The Induction Matrix is a multiblock structure from mekanism made to store large amounts of energy.
Info
Energy functions will always return in FE. If you want it in joules, multiply the value with 2.5
The functions which returns a value in percent, will return a number between 1-0. (50% would be 0.5)
"},{"location":"integrations/mekanism/induction/#functions","title":"Functions","text":"Function Returns Description getEnergy() int Returns the amount of stored energy. getLastInput() int Returns the input rate per tick. getLastOutput() int Returns the output rate per tick. getEnergyNeeded() int Returns the amount of energy that is needed to fill the matrix. getEnergyFilledPercentage() int Returns the amount of the energy in percent. getTransferCap() table Returns the max transfer rate per tick. This is defined by the amount of induction providers getInstalledCells() int Returns the amount of the installed induction cells. getInstalledProviders() int Returns the amount of the installed induction providers. getMaxEnergy() int Returns the capacity of the induction matrix."},{"location":"integrations/mekanism/induction/#changelogtrivia","title":"Changelog/Trivia","text":"0.6b Added integration for Mekanism
"},{"location":"integrations/mekanism/solar_evaporation/","title":"Solar evaporation","text":"Go Back"},{"location":"integrations/mekanism/solar_evaporation/#solar-evaporation-plant","title":"Solar Evaporation Plant","text":"Picture
Mod: Mekanism Block: Thermal Evaporation Valve
A Solar Evaporation Plant is a multiblock structure from mekanism to create brine or lithium.
Info
Energy functions will always return in FE. If you want it in joules, multiply the value with 2.5
The functions which returns a value in percent, will return a number between 1-0. (50% would be 0.5)
"},{"location":"integrations/mekanism/solar_evaporation/#functions","title":"Functions","text":"Function Returns Description getInputTank() table Returns the name and the amount of the stored fluid of the input tank(left). getInputTank() table Returns the name and the amount of the stored fluid of the output tank(right). getHeat() int Returns the amount heat. getHeight() int Returns the height of the tower. getProduction() int Returns the production rate of the tower."},{"location":"integrations/mekanism/solar_evaporation/#changelogtrivia","title":"Changelog/Trivia","text":"0.7.1r Added evaporation tower integration
0.6b Added integration for Mekanism
"},{"location":"integrations/mekanism/transmitter/","title":"Transmitter","text":"Go Back"},{"location":"integrations/mekanism/transmitter/#transmitters","title":"Transmitters","text":"Picture
Mod: Mekanism Block: Any transmitter. See full list below
Transmitters from mekanism are blocks which can transport various types of things like gases, fluids, energy or more.
Info
Energy functions will always return in FE. If you want it in joules, multiply the value with 2.5
The functions which returns a value in percent, will return a number between 1-0. (50% would be 0.5)
"},{"location":"integrations/mekanism/transmitter/#supported-transmitters","title":"Supported transmitters","text":"Supporte transmitters are
Functions for every transmitter
Function Returns Description getTransmitters int Returns the amount of transmitters. (Amount of cables) getAcceptors int Returns the amount of acceptors. (Amount of cables which are connected) getThroughput int Returns how much the cable can transfer at ones.(UsegetPull() for the logistical transporter) getTier string Returns the tier of the transporter. (Basic to ultimate) getCapacity int Returns the capacity of the cable. (Not available for: logistical transporter) getStored int Returns the amount of stored things in the cable. (Not available for: logistical transporter) getNetworkCapacity int Returns the capacity of the network. (Not available for: logistical transporter, thermodynamic conductor) getNetworkStored int Returns the amount of stored things in the network. (Not available for: logistical transporter, thermodynamic conductor)"},{"location":"integrations/mekanism/transmitter/#logistical-transporter","title":"Logistical Transporter","text":"Function Returns Description getBaseSpeed int Returns the base speed(blocks per second) of the transmitter. getBasePull int Returns the base pull speed(items per second) of the transmitter. getSpeed int Returns the base speed (blocks per second) of the transmitter based on the configuration. getPull int Returns the base pull speed(items per second) of the transmitter based on the configuration."},{"location":"integrations/mekanism/transmitter/#changelogtrivia","title":"Changelog/Trivia","text":"0.7.6r Added transmitter integration
0.6b Added integration for Mekanism
"},{"location":"integrations/mekanism/turbine/","title":"Turbine","text":"Go Back"},{"location":"integrations/mekanism/turbine/#industrial-turbine","title":"Industrial Turbine","text":"Picture
Mod: Mekanism Block: Turbine Valve
The Industrial Turbine is a multiblock structure from mekanism to generate energy with steam.
Info
Energy functions will always return in FE. If you want it in joules, multiply the value with 2.5
The functions which returns a value in percent, will return a number between 1-0. (50% would be 0.5)
"},{"location":"integrations/mekanism/turbine/#functions","title":"Functions","text":"Function Returns Description getSteam() int Returns the stored amount of the water. getSteamCapacity() int Returns the capacity of the steam. getSteamNeeded() int Returns the amount of steam that is needed to fill the tank. getSteamFilledPercentage() int Returns the amount of the steam in percent. getLastSteamInputRate() int Returns the amount of steam that is imported to the turbine. getDumpingMode() string Returns the gas dumping mode. getProductionRate() int Returns the energy production per tick. getMaxProduction() int Returns the max possible energy production per tic. getFlowRate() int Returns the current flow rate per tick. getMaxFlowRate() int Returns the current max possible flow rate per tick. getMaxWaterOutput() int Returns the max possible water output. getDispersers() int Returns the amount of dispersers. getVents() int Returns the amount of vents. getBlades() int Returns the amount of blades. getCoils() int Returns the amount of coils. getCondensers() int Returns the amount of condensers."},{"location":"integrations/mekanism/turbine/#changelogtrivia","title":"Changelog/Trivia","text":"0.6b Added integration for Mekanism
"},{"location":"integrations/mekanism/waste_barrel/","title":"Waste barrel","text":"Go Back"},{"location":"integrations/mekanism/waste_barrel/#waste-barrel","title":"Waste Barrel","text":"Picture
Mod: Mekanism Block: Waste Barrel
Waste Barrels are blocks from mekanism to store nuclear waste.
Info
Energy functions will always return in FE. If you want it in joules, multiply the value with 2.5
The functions which returns a value in percent, will return a number between 1-0. (50% would be 0.5)
"},{"location":"integrations/mekanism/waste_barrel/#functions","title":"Functions","text":"Function Returns Description getStored() int Returns the amount of stored waste. getCapacity() string Returns the capacity of the barrel. getFilledPercentage int Returns the amount of waste in percent."},{"location":"integrations/mekanism/waste_barrel/#changelogtrivia","title":"Changelog/Trivia","text":"0.7.2r Added waste barrel integration
0.6b Added integration for Mekanism
"},{"location":"integrations/minecraft/beacon/","title":"Beacon","text":"Picture
A Beacon is a block that projects a light beam skyward and can provide status effects such as Speed, Jump Boost, Haste, Regeneration, Resistance, or Strength to nearby players.
Peripheral Name Interfaces with Has events Introduced in beacon Beacon block No 0.6b
"},{"location":"integrations/minecraft/beacon/#functions","title":"Functions","text":""},{"location":"integrations/minecraft/beacon/#getlevel","title":"getLevel","text":"getLevel() -> number\ngetPrimaryEffect() -> string\ngetSecondaryEffect() -> string\n0.6b Added integration for Minecraft
"},{"location":"integrations/minecraft/noteblock/","title":"Note Block","text":"Picture
A Note Block is a musical block that emits sounds when punched or powered with redstone.
Peripheral Name Interfaces with Has events Introduced in noteBlock Note Block No 0.7.4r
"},{"location":"integrations/minecraft/noteblock/#functions","title":"Functions","text":""},{"location":"integrations/minecraft/noteblock/#playnote","title":"playNote","text":"playNote() -> void\ngetNote() -> number\nchangeNoteBy(note: number) -> number\nnote. note must be a number from 0 to 24. Returns the note if successful or -1 if not successful."},{"location":"integrations/minecraft/noteblock/#changenote","title":"changeNote","text":"changeNote() -> number\n0.7.4r Added the Note Block integration
0.6b Added integration for Minecraft
"},{"location":"integrations/powah/ender_cell/","title":"Ender Cell","text":"Only available in version 1.19.2
The Ender Cell is a block from Powah to receive, store, and send energy on specific channels of the owner. You can access the energy from anywhere.
Requirement
Requires the Powah mod to be installed
Peripheral Name Interfaces with Has events Introduced in enderCell Every Ender Cell block (all tiers) No N/A
"},{"location":"integrations/powah/ender_cell/#functions","title":"Functions","text":""},{"location":"integrations/powah/ender_cell/#getname","title":"getName","text":"getName() -> string\ngetEnergy() -> number\ngetMaxEnergy() -> number\ngetChannel() -> number\ngetMaxChannels()."},{"location":"integrations/powah/ender_cell/#getmaxchannels","title":"getMaxChannels()","text":"getMaxChannels() -> number\nsetChannel(channel: number) -> void\nchannel. channel must be a number between 1 to getMaxChannels(). Does not change the channel if channel is invalid."},{"location":"integrations/powah/ender_cell/#changelogtrivia","title":"Changelog/Trivia","text":"1.19.2-0.X.XX.X Added integration for Powah's Ender Cell
"},{"location":"integrations/powah/energy_cell/","title":"Energy Cell","text":"Only available in version 1.19.2
The Energy Cell is a block from Powah to receive, store and send energy.
Requirement
Requires the Powah mod to be installed
Peripheral Name Interfaces with Has events Introduced in energyCell Every energy cell block (all tiers) No N/A
"},{"location":"integrations/powah/energy_cell/#functions","title":"Functions","text":""},{"location":"integrations/powah/energy_cell/#getname","title":"getName","text":"getName() -> string\ngetEnergy() -> number\ngetMaxEnergy() -> number\n1.19.2-0.7.26.r Added integration for Powah
"},{"location":"integrations/powah/furnator/","title":"Furnator","text":"Only available in version 1.19.2
The Furnator is a block from Powah to generate power given a fuel source.
Requirement
Requires the Powah mod to be installed
Peripheral Name Interfaces with Has events Introduced in furnator Every furnator block (all tiers) No N/A
"},{"location":"integrations/powah/furnator/#functions","title":"Functions","text":""},{"location":"integrations/powah/furnator/#getname","title":"getName","text":"getName() -> string\ngetEnergy() -> number\ngetMaxEnergy() -> number\nisBurning() -> boolean\ngetCarbon() -> number\ngetInventory() -> table\n1.19.2-0.7.26.r Added integration for Powah
"},{"location":"integrations/powah/magmator/","title":"Magmator","text":"Only available in version 1.19.2
The Magmator is a block from Powah to generate power from a fluid heat source (lava)
Requirement
Requires the Powah mod to be installed
Peripheral Name Interfaces with Has events Introduced in magmator Every magmator block (all tiers) No N/A
"},{"location":"integrations/powah/magmator/#functions","title":"Functions","text":""},{"location":"integrations/powah/magmator/#getname","title":"getName","text":"getName() -> string\ngetEnergy() -> number\ngetMaxEnergy() -> number\nisBurning() -> boolean\ngetTankCapacity() -> number\ngetFluidInTank() -> number\n1.19.2-0.7.26.r Added integration for Powah
"},{"location":"integrations/powah/reactor/","title":"Reactor","text":"Only available in version 1.19.2
The Reactor is a block from Powah to generate power from uraninite.
Requirement
Requires the Powah mod to be installed
Peripheral Name Interfaces with Has events Introduced in uraniniteReactor Every reactor multiblock structure (all tiers) No N/A
"},{"location":"integrations/powah/reactor/#functions","title":"Functions","text":""},{"location":"integrations/powah/reactor/#getname","title":"getName","text":"getName() -> string\ngetEnergy() -> number\ngetMaxEnergy() -> number\ngetMaxEnergy() -> number\nisRunning() -> boolean\ngetFuel() -> number\ngetCarbon() -> number\ngetRedstone() -> number\ngetTemperature() -> number\ngetInventoryUraninite() -> table\ngetInventoryRedstone() -> table\ngetInventoryCarbon() -> table\n1.19.2-0.7.26.r Added integration for Powah
"},{"location":"integrations/powah/solar_panel/","title":"Solar Panel","text":"Only available in version 1.19.2
The Solar Panel is a block from Powah to generate power given direct exposure to the sky.
Requirement
Requires the Powah mod to be installed
Peripheral Name Interfaces with Has events Introduced in solarPanel Every solar panel block (all tiers) No N/A
"},{"location":"integrations/powah/solar_panel/#functions","title":"Functions","text":""},{"location":"integrations/powah/solar_panel/#getname","title":"getName","text":"getName() -> string\ngetEnergy() -> number\ngetMaxEnergy() -> number\ncanSeeSky() -> boolean\n1.19.2-0.7.26.r Added integration for Powah
"},{"location":"integrations/powah/thermo_generator/","title":"Thermo Generator","text":"Only available in version 1.19.2
The Thermo Generator is block from Powah to generate power from an appropriate heat source block beneath it (magma block, lava)
Requirement
Requires the Powah mod to be installed
Peripheral Name Interfaces with Has events Introduced in thermo Every thermo generator block (all tiers) No N/A
"},{"location":"integrations/powah/thermo_generator/#functions","title":"Functions","text":""},{"location":"integrations/powah/thermo_generator/#getname","title":"getName","text":"getName() -> string\ngetEnergy() -> number\ngetMaxEnergy() -> number\ngetCoolantInTank() -> number\n1.19.2-0.7.26.r Added integration for Powah
"},{"location":"integrations/storage_drawers/drawer/","title":"Drawer","text":"Only available in version 1.16
Picture
Drawers are a storage block from the Storage Drawer mod. This integration fixes weird interactions between the generic CC:Tweaked inventory integration and Storage Drawer logic.
Requirement
Requires the Storage Drawers mod to be installed
"},{"location":"integrations/storage_drawers/drawer/#functions","title":"Functions","text":"See the generic inventory peripheral from CC:Tweaked for details.
"},{"location":"integrations/storage_drawers/drawer/#changelogtrivia","title":"Changelog/Trivia","text":"0.7r Added integration for Storage Drawers
"},{"location":"items/ar_goggles/","title":"AR Goggles","text":"Picture
The AR Goggles can be used in combination with the AR Controller to have a customizable overlay wherever you go. Fun! See the documenation for the AR Controller to learn more.
Hint
To link your goggles to an AR Controller, right click it with them in your hand. Multiple Goggles can be linked to one Controller.
Bug
The AR Goggles are slightly buggy in 1.18x and completely disabled in 1.19x. We work on a rework of the AR Goggles system with a bunch of new features for 0.8/1.0
"},{"location":"items/ar_goggles/#changelogtrivia","title":"Changelog/Trivia","text":"0.5b Added the AR Controller and AR Goggles, made by Olfi01#6413
"},{"location":"items/chunk_controller/","title":"Chunk Controller","text":"Picture
The Chunk Controller is a crafting ingredient for the Chunky Turtle.
"},{"location":"items/chunk_controller/#changelogtrivia","title":"Changelog/Trivia","text":"0.4b Added as the crafting ingredient for the chunky turtle.
"},{"location":"items/computer_tool/","title":"Computer Tool","text":"Picture
The Computer Tool is a tool to open GUI's from the mod blocks.
Note
Currently the Computer Tool is useless.
"},{"location":"items/computer_tool/#changelogtrivia","title":"Changelog/Trivia","text":"0.5b Added the Computer Tool
"},{"location":"items/memory_card/","title":"Memory Card","text":"Picture
The Memory Card can be used in combination with the Inventory Manager to manipulate with the player's inventory. See the Inventory Manager documenation for more info.
Hint
Right click with the Memory Card in your hand to assign it to yourself to the card.
"},{"location":"items/memory_card/#changelogtrivia","title":"Changelog/Trivia","text":"0.5b Added the Inventory Manager and Memory Card
"},{"location":"items/pocket_computer/","title":"Pocket Computers","text":"Picture
There are Pocket Computer versions of the following peripherals:
Events
The pocket computer versions of the peripherals do not receive the peripheral events.
"},{"location":"items/pocket_computer/#changelogtrivia","title":"Changelog/Trivia","text":"0.7r Added Geo Scanner pocket computer.
0.4.3b Added the Player Detector and Chat Box pocket computers.
0.4.1b Added the Environment Detector pocket computer.
"},{"location":"peripherals/ar_controller/","title":"AR Controller","text":"Picture
The AR Controller is used to control your AR Goggles wirelessly. You can draw anything you wish into an overlay that will be visible as long as you're wearing the goggles.
Hint
To link your goggles to an AR Controller, right click it with them in your hand. Multiple Goggles can be linked to one Controller.
Bug
The AR Goggles are currently slightly buggy. Sometimes, they just don't do what they should do. We will rework the AR System in 0.8r/1.0r
Peripheral Name Interfaces with Has events Introduced in arController AR Goggles No 0.5b
While the Controller is in relative mode, it interprets all coordinates as if they were on a virtual screen of the size you specified, and then scales them according to your screen size.
All color values are hexadecimal color codes (for example 0xff00ff)
Everything that is painted onto the canvas remains there until clear() or if the element is removed using clearElement(id), however, it might be repositioned if relative mode is toggled on or off.
clear() -> void\nClears the entire canvas.
"},{"location":"peripherals/ar_controller/#clearelement","title":"clearElement","text":"clearElement(id: string) -> void\nClears the element with the given id.
horizontalLine(minX: number, maxX: number, y: number, color: number) -> void\nDraws a horizontal line in the given color from minX to maxX at vertical y.
"},{"location":"peripherals/ar_controller/#horizontallinewithid","title":"horizontalLineWithId","text":"horizontalLineWithId(id: string, minX: number, maxX: number, y: number, color: number) -> void\nThe same as horizontalLine(), but has an id so it can be overridden later on or can be completely cleared.
verticalLine(x: number, minY: number, maxY: number, color: number) -> void\nDraws a vertical line in the given color from minY to maxY at horizontal x.
"},{"location":"peripherals/ar_controller/#verticallinewithid","title":"verticalLineWithId","text":"verticalLineWithId(id: string, x: number, minY: number, maxY: number, color: number) -> void\nThe same as verticalLine(), but has an id so it can be overridden later on or can be completely cleared.
drawString(text: string, x: number, y: number, color: number) -> void\nDraws the given string to the specified position with the specified text color.
"},{"location":"peripherals/ar_controller/#drawstringwithid","title":"drawStringWithId","text":"drawStringWithId(id: string, text: string, x: number, y: number, color: number) -> void\nThe same as drawString(), but has an id so it can be overridden later on or can be completely cleared.
drawCenteredString(text: string, x: number, y: number, color: number) -> void\nThe same as drawString(), but centers the string horizontally around the specified position.
drawCenteredStringWithId(id: string, text: string, x: number, y: number, color: number) -> void\nThe same as drawCenteredString(), but has an id so it can be overridden later on or can be completely cleared.
drawRightboundString(text: string, x: number, y: number, color: number) -> void\nThe same as drawString(), but the string is positioned with its right end at the specified position.
drawRightboundStringWithId(id: string, text: string, x: number, y: number, color: number) -> void\nThe same as drawRightboundString(), but has an id so it can be overridden later on or can be completely cleared.
drawItemIcon(itemId: string, x: number, y: number) -> void\nAdded in version 0.5.2b
Draws the given item to the specified position.
"},{"location":"peripherals/ar_controller/#drawitemiconwithid","title":"drawItemIconWithId","text":"drawItemIconWithId(id: string, itemId: string, x: number, y: number) -> void\nAdded in version 0.5.2b
The same as drawItemIcon(), but has an id so it can be overridden later on or can be completely cleared.
drawCircle(x: number, y: number, radius: number, color: number) -> void\nAdded in version 0.5.2b
Draws a circle without filling it.
"},{"location":"peripherals/ar_controller/#drawcirclewithid","title":"drawCircleWithId","text":"drawCircleWithId(id: string, x: number, y: number, radius: number, color: number) -> void\nAdded in version 0.5.2b
The same as drawCircle(), but has an id so it can be overridden later on or can be completely cleared.
fill(minX: number, minY: number, maxX: number, maxY: number, color: number)\nFills a rectangle with the given color from the corner minX, minY to maxX, maxY.
"},{"location":"peripherals/ar_controller/#fillwithid","title":"fillWithId","text":"fill(id: string, minX: number, minY: number, maxX: number, maxY: number, color: number)\nThe same as fill(), but has an id so it can be overridden later on or can be completely cleared.
fillCircle(x: number, y: number, radius: number, color: number) -> void\nAdded in version 0.5.2b
Draws a full circle.
"},{"location":"peripherals/ar_controller/#fillcirclewithid","title":"fillCircleWithId","text":"fillCircleWithId(id: string, x: number, y: number, radius: number, color: number) -> void\nAdded in version 0.5.2b
The same as fillCircle(), but has an id so it can be overridden later on or can be completely cleared.
fillGradient(minX: number, minY: number, maxX: number, maxY: number, colorFrom: number, colorTo: number) -> void\nDraws a rectangular gradient from colorFrom to colorTo with the given corners.
"},{"location":"peripherals/ar_controller/#fillgradientwithid","title":"fillGradientWithId","text":"fillGradientWithId(id: string, minX: number, minY: number, maxX: number, maxY: number, colorFrom: number, colorTo: number) -> void\nThe same as fillGradient(), but has an id so it can be overridden later on or can be completely cleared.
isRelativeMode(): true, number, number | false\nReturns true and the size of the virtual screen if relative mode is active, or just false if it isn't.
"},{"location":"peripherals/ar_controller/#setrelativemode","title":"setRelativeMode","text":"setRelativeMode(enabled: boolean, virtualScreenWidth?: number, virtualScreenHeight?: number) -> void\nActivates or deactivates relative mode. Requires virtual screen width and height if it is being enabled.
Hint
Use negative coordinates to specify an x value from the right end of the screen or a y value from the bottom!
"},{"location":"peripherals/ar_controller/#examples","title":"Examples","text":""},{"location":"peripherals/ar_controller/#example-1","title":"Example 1","text":"Olfi01 made a simple script that shows the current date and time in the top right corner of the screen and updates every second.
local controller = peripheral.find(\"arController\") -- Finds the peripheral if one is connected\n\nif controller == nil then error(\"arController not found\") end\n\ncontroller.setRelativeMode(true, 1600, 900) -- Convenient Aspect ratio for most screens\nwhile true do\n local timer = os.startTimer(1)\n local event, id\n repeat\n event, id = os.pullEvent(\"timer\")\n until id == timer\n controller.clear() -- If you don't do this, the texts will draw over each other\n controller.drawRightboundString(os.date(), -10, 10, 0xffffff)\nend\nOlfi01 made another script to draw .nfp files, which you can draw with the paint program, in cc in your HUD.
First, we have a script with more adaptability. You can define x, y, width and height.
Script 1: Github
And we have another script which depends on the script above, but is simpler to use.
Script 2: Github
"},{"location":"peripherals/ar_controller/#changelogtrivia","title":"Changelog/Trivia","text":"0.5.2b Added fillCircle, drawCircle and drawItemIcon.
0.5b Added the AR Controller and Goggles, made by Olfi01#6413
"},{"location":"peripherals/block_reader/","title":"Block Reader","text":"Picture
This block is able to read data about any blocks or tile entities in front of it.
Peripheral Name Interfaces with Has events Introduced in blockReader Blocks No 0.7r
"},{"location":"peripherals/block_reader/#functions","title":"Functions","text":""},{"location":"peripherals/block_reader/#getblockname","title":"getBlockName","text":"getBlockName() -> string\nReturns the registry name of the block (ex. minecraft:dirt)
local reader = peripheral.find(\"blockReader\")\n\nprint(\"There is a \" .. read.getBlockName() .. \" in front.\")\ngetBlockData() -> table | nil\nReturns the block data of the block if block is a tile entity.
local reader = peripheral.find(\"blockReader\")\n\n--Prints the contents of the data\nfor k, v in ipairs(reader.getBlockData()) do \n print(k, v)\nend\n0.7r Added the Block Reader peripheral.
"},{"location":"peripherals/chat_box/","title":"Chat Box","text":"Picture
The Chat Box is able to read and write messages to the in-game chat. You can send messages to just one player or to everyone.
Hint
If you prefix your message with a $ the message will not be sent to the global chat but it will still fire the chat event. Example: $this message is hidden!
Peripheral Name Interfaces with Has events Introduced in chatBox Game Chat Yes 0.1b
"},{"location":"peripherals/chat_box/#events","title":"Events","text":""},{"location":"peripherals/chat_box/#chat","title":"chat","text":"Fires when a player sends a message into the chat. Values: 1. username: string The username of the player who sent the message 2. message: string The message sent by the player 3. uuid: string The player's uuid 4. isHidden: boolean Whether the message is hidden or not
local event, username, message, uuid, isHidden = os.pullEvent(\"chat\")\nprint(\"The 'chat' event was fired with the username \" .. username .. \" and the message \" .. message)\nInfo
The chat event will fire when a chatbox has been connected to a computer. You don't have to .wrap() or .find() the peripheral (unless you intend to send messages).
sendMessage(message: string[, prefix: string, brackets: string, bracketColor: string, range: number]) -> true | nil, string\nrange is specified it is sent to all players in the range. The prefix will change the text that appears inside the brackets at the start of a message. Defaults to \"AP\". To change the brackets used around the prefix you must specify a string like so: \"[]\", \"()\", \"<>\", ... bracketColor specifies the color to use for the brackets, this must be in the MOTD code format. Returns true if the message is successfully sent, or nil and an error message if it fails.
local chatBox = peripheral.find(\"chatBox\")\n\nchatBox.sendMessage(\"Hello world!\") -- Sends \"[AP] Hello world!\" in chat\nos.sleep(1) -- We must account for the cooldown between messages, this is to prevent spam\nchatBox.sendMessage(\"I am dave\", \"Dave\") -- Sends \"[Dave] I am dave\"\nos.sleep(1)\n\n-- Sends message \"Welcome!\" with cyan <> brackets around \"<Box>\"\n-- to players within 30 blocks of the chat box\nchatBox.sendMessage(\"Welcome!\", \"Box\", \"<>\", \"&b\", 30)\nTip
Just like the bracketColor argument you can add colors to the message and prefix arguments using the same MOTD color code format. Since CC doesn't accept non-ascii charactor \u00a7, you should replace it with &. If you want to send colored message but not only colored brackets, please use sendFormattedMessage() instead.
sendMessageToPlayer(message: string, username: string[, prefix: string, brackets: string, bracketColor: string, range: number]) -> true | nil, string\nsendMessage() this sends a message to one specific player. Specify the player to send the message to with the username parameter. local chatBox = peripheral.find(\"chatBox\")\n\nchatBox.sendMessageToPlayer(\"Hello there.\", \"Player123\") -- Sends \"[AP] Hello there.\" to Player123 in chat\nsendFormattedMessage(json: string, username: string[, prefix: string, brackets: string, bracketColor: string, range: number]) -> true | nil, string\nsendMessage() except it takes a json text component as the first parameter. Find out more information on how the text component format works on the minecraft fandom wiki. You can generate the json at minecraft.tools. local chatBox = peripheral.find(\"chatBox\")\n\nlocal message = {\n {text = \"Click \"}, \n {\n text = \"here\",\n underlined = true,\n color = \"aqua\",\n clickEvent = {\n action = \"open_url\",\n value = \"https://advancedperipherals.madefor.cc/\"\n }\n },\n {text = \" for the AP \"},\n {text = \"documentation\", color = \"red\"},\n {text = \"!\"}\n}\n\nlocal json = textutils.serialiseJSON(message)\n\nchatBox.sendFormattedMessage(json)\nsendFormattedMessageToPlayer(json: string, username: string[, prefix: string, brackets: string, bracketColor: string, range: number]) -> true | nil, string\nsendFormattedMessage() this sends a formatted message to one specific player. Specify the player to send the message to with the username parameter."},{"location":"peripherals/chat_box/#changelogtrivia","title":"Changelog/Trivia","text":"0.7r Added the uuid and isHidden parameter to the chat event. Also added the sendFormattedMessage function.
4.0b Fixed the chat box so that is should now work in LAN worlds
0.1b Added the chat box. This was the first feature of the mod.
"},{"location":"peripherals/colony_integrator/","title":"Colony Integrator","text":"Picture
The colony integrator can interact with a colony from MineColonies.
Requirement
Requires the MineColonies mod to be installed
Peripheral Name Interfaces with Has events Introduced in colonyIntegrator Mine Colony No 0.7r
"},{"location":"peripherals/colony_integrator/#functions","title":"Functions","text":""},{"location":"peripherals/colony_integrator/#getcitizens","title":"getCitizens","text":"getCitizens() -> table\nReturns a list of information about every citizen in the colony.
"},{"location":"peripherals/colony_integrator/#citizen-properties","title":"Citizen Properties","text":"citizen Description id:string The citizen's id name: string The citizen's name age: string The age of the citizen, either \"child\" or \"adult\" gender: string The citizen's gender, either \"male\" or \"female\" location: table The current location of the citizen (has x, y, z) bedPos: table The position of the citizen's bed (has x, y, z) saturation: number The citizen's food saturation happiness: number An indicator of how happy the citizen is health: number? The citizen's current health maxHealth: number? The citizen's max health armor: number? The citizen's current number of armor points toughness: number? The citizen's armor toughness betterFood: boolean Whether the citizen needs better food isAsleep: boolean If the citizen is currently asleep isIdle: boolean If the citizen is currently idle state: string A string representing the citizen's current state children: table A list of the ids of this citizen's children skills: table A table of skill names to skills where each skill hasa level and xp number work: table? A table of info about the citizen's job home: table? A table of info about the citizen's house"},{"location":"peripherals/colony_integrator/#work-properties","title":"Work Properties","text":"work Description name: string The name of the work building job: string The name of the job location: table The work location (has x, y, z) type: string The building type level: number The building's level"},{"location":"peripherals/colony_integrator/#home-properties","title":"Home Properties","text":"home Description location: table The home location (has x, y, z) type: string The building type level: number The building's level"},{"location":"peripherals/colony_integrator/#getvisitors","title":"getVisitors","text":"getVisitors() -> table\ncitizen table but there is an additional recruitCost table."},{"location":"peripherals/colony_integrator/#recruitcost-properties","title":"recruitCost properties","text":"item Description name: string The registry name of the item count: number The amount of the item maxStackSize: number Maximum stack size for the item type displayName: string The item's display name tags: table A list of item tags nbt: table The item's nbt data"},{"location":"peripherals/colony_integrator/#getbuildings","title":"getBuildings","text":"getBuildings() -> table\nstring The name of the building location: table The buildings's location (has x, y, z) type: string The building type level: number The building's level maxLevel: number The building's max level style: string The building's style storageBlocks: number The number of storage blocks in the building storageSlots: number The number of storage slots guarded: boolean If the building is currently being guarded built: boolean If the building is built or is under construction isWorkingOn: boolean Whether the building is being worked on priority: number The building's construction priority structure: table A table defining the bounds of the structure citizens: table A list of citizen's names and ids"},{"location":"peripherals/colony_integrator/#structure-properties","title":"Structure Properties","text":"structure Description cornerA: table The first corner of the bounds (has x, y, z) cornerB: table The second corner of the bounds (has x, y, z) rotation: number The structure's rotation mirror: boolean If the structure has been mirrored"},{"location":"peripherals/colony_integrator/#getresearch","title":"getResearch","text":"getResearch() -> table\nReturns a table of all possible colony research as a tree where the root table contains the branch names and their respective research.
"},{"location":"peripherals/colony_integrator/#properties","title":"Properties","text":"research Description id:string The research id name: string The name of the research status: number The current research status researchEffects: table A list of effects provided by the research children: table? A list of any child research progress: number Research progress requirements: table List of requirements for the research cost: table The cost of the research (list of tables)"},{"location":"peripherals/colony_integrator/#requirement-properties","title":"Requirement Properties","text":"requirememt Description type: string Type of requirement. desc: string Description of the requirement fulfilled: boolean If the requirement is already met"},{"location":"peripherals/colony_integrator/#building-requirement-properties","title":"Building Requirement Properties","text":"If the requirement type is building, it will have these additional properties:
string Name of the required building level: number Level of the required building"},{"location":"peripherals/colony_integrator/#cost-item-properties","title":"Cost item Properties","text":"item Description name: string The registry name of the item count: number The amount of the item maxStackSize: number Maximum stack size for the item type displayName: string The item's display name tags: table A list of item tags nbt: table The item's nbt data"},{"location":"peripherals/colony_integrator/#getrequests","title":"getRequests","text":"getRequests() -> table\nstring The request's id name: string The name of the request desc: string A description about the request state: string The state of the request count: number The number of the request minCount: number The minimum of the request needed target: string The request's target items: table A list of items attached to the request"},{"location":"peripherals/colony_integrator/#item-properties","title":"Item Properties","text":"item Description name: string The registry name of the item count: number The amount of the item maxStackSize: number Maximum stack size for the item type displayName: string The item's display name tags: table A list of item tags nbt: table The item's nbt data"},{"location":"peripherals/colony_integrator/#getworkorders","title":"getWorkOrders","text":"getWorkOrders() -> table\nstring The work order's id priority: number The priority of the work order workOrderType: string The type of work order changed: boolean If the work order changed isClaimed: boolean Whether the work order has been claimed builder: table The position of the builder (has x, y, z) buildingName: string The name of the building type: string The type of the building targetLevel: number The building's target level"},{"location":"peripherals/colony_integrator/#getworkorderresources","title":"getWorkOrderResources","text":"getWorkOrderResources(workOrderId: number) -> table | nil\nstring The registry name for the item displayName: string The display name for the item status: string The status of this resource needed: number How much of the resource is needed for the job available: boolean If the resource is currently available delivering: boolean If the resource is currently being delivered"},{"location":"peripherals/colony_integrator/#getbuilderresources","title":"getBuilderResources","text":"getBuilderResources(position: table) -> table | nil\nThe position table must contain:
number number number getColonyID() -> number\ngetColonyName() -> string\ngetColonyStyle() -> string\ngetLocation() -> table\nnumber The x coordinate y: number The y coordinate z: number The z coordinate"},{"location":"peripherals/colony_integrator/#gethappiness","title":"getHappiness","text":"getHappiness() -> number\nisActive() -> boolean\nisUnderAttack() -> boolean\nisInColony() -> boolean\nlocal integrator = peripheral.find(\"colonyIntegrator\")\n\nif integrator.isInColony() then\n print(\"Block is inside a colony!\")\nelse\n print(\"Not in a colony!\")\nend\nisWithin(position: table) -> boolean\nThe position table must contain:
number number number amountOfCitizens() -> number\nmaxOfCitizens() -> number\namountOfGraves() -> number\namountOfConstructionSites() -> number\nWe made a script to show every citizens and their gender on a monitor.
You can view and download the script on Github
"},{"location":"peripherals/colony_integrator/#colony-stats","title":"Colony Stats","text":"And here we have a script made for a pocket computer to show statistics about a colony.
You can view and download the script on Github
"},{"location":"peripherals/colony_integrator/#changelogtrivia","title":"Changelog/Trivia","text":"0.7r Added the colony integrator
"},{"location":"peripherals/energy_detector/","title":"Energy Detector","text":"Picture
The Energy Detector can detect energy flow and acts as a resistor. You can define the max flow rate to use it as a resistor.
Bug
The Energy Detector does not work on versions below 0.4.5b. It is recommended that you always use the latest version.
Peripheral Name Interfaces with Has events Introduced in energyDetector Forge Energy No 0.4.1b
"},{"location":"peripherals/energy_detector/#functions","title":"Functions","text":""},{"location":"peripherals/energy_detector/#gettransferrate","title":"getTransferRate","text":"getTransferRate() -> int\nReturns the current energy that is going through the block.
local detector = peripheral.find(\"energyDetector\")\n\n-- prints \"Current transfer rate: xxx FE/t\"\n-- where 'xxx' is the current energy flowing through the block\nprint(\"Current transfer rate: \" .. detector.getTransferRate() .. \" FE/t\")\ngetTransferRateLimit() -> int\nReturns the max rate limit of energy through the block which has been set using setTransferRateLimit.
setTransferRateLimit(limit: int) -> void\nSet the max energy rate that will go through the block.
local detector = peripheral.find(\"energyDetector\")\n\ndetector.setTransferRateLimit(512) -- Only 512 FE/t can go through the block\nThe Energy Detector had some weird problems in versions before 0.4.6b The block was able to store infinite amounts of energy or it creates an limitless amount of energy.
0.4.6b The energy detector is now bug free. hopefully
0.4.5b Completely changed the system of the energy detector, but the energy detector was able to drain energy without any reason.
0.4.3b Created a crafting recipe for the detector.
0.4.2b The energy detector is now able to send energy automatically.
0.4.1b Added the lovely bugged energy detector.
"},{"location":"peripherals/environment_detector/","title":"Environment Detector","text":"Picture
The Environment Detector provides current information from the environment like the current time, the current moon phase, the light level of the block and many more.
Peripheral Name Interfaces with Has events Introduced in environmentDetector World No 0.1b
"},{"location":"peripherals/environment_detector/#functions","title":"Functions","text":""},{"location":"peripherals/environment_detector/#getbiome","title":"getBiome","text":"getBiome() -> string\nReturns the current biome the block is in.
local detector = peripheral.find(\"environmentDetector\")\n\n-- e.g. prints \"Biome: minecraft:plains\"\nprint(\"Biome: \" .. detector.getBiome())\ngetBlockLightLevel() -> number\nReturns the block light level (0 to 15) at the detector block, this can be influenced by light sources
"},{"location":"peripherals/environment_detector/#getdaylightlevel","title":"getDayLightLevel","text":"getDayLightLevel() -> number\nReturns the day light level of the current world from 0 to 15. This is uneffected by blocks covering the peripheral.
"},{"location":"peripherals/environment_detector/#getskylightlevel","title":"getSkyLightLevel","text":"getSkyLightLevel() -> number\nReturns the current sky light level from 0 to 15 (like a daylight sensor).
"},{"location":"peripherals/environment_detector/#getdimensionname","title":"getDimensionName","text":"getDimensionName() -> string\nReturns the name of the current dimension (ex. overworld, the_nether or the_end).
local detector = peripheral.find(\"environmentDetector\")\n\n-- e.g. prints \"Dimension: the_nether\"\nprint(\"Dimension: \" .. detector.getDimensionName())\ngetDimensionPaN() -> string\nSimilar to getDimensionName it returns the name of the dimension prefixed with the provider name (ex. minecraft:overworld).
getDimensionProvider() -> string\nReturns the provider of the dimension (ex. minecraft).
getMoonId() -> number\nReturns the current moon phase's id.
Info
There are 8 different moon phases, see below a list of their names and ids
0 = Full moon, 1 = Waning gibbous, 2 = Third quarter, 3 = Waning crescent, 4 = New moon, 5 = Waxing crescent, 6 = First quarter, 7 = Waxing gibbous
getMoonName() -> string\nReturns the current moon phase's name.
"},{"location":"peripherals/environment_detector/#gettime","title":"getTime","text":"getTime() -> number\nWIP
Returns the daytime of the current world.
"},{"location":"peripherals/environment_detector/#getradiation","title":"getRadiation","text":"getRadiation() -> table\nAdded in version 0.6.1b
Requirement
Requires the Mekanism mod to be installed
Returns the current radiation level from the Mekanism mod with the radiation unit.
"},{"location":"peripherals/environment_detector/#properties","title":"Properties","text":"table Description radiation:string The current radiation level as a string unit: string The radiation unit"},{"location":"peripherals/environment_detector/#getradiationraw","title":"getRadiationRaw","text":"getRadiationRaw() -> number\nAdded in version 0.6.5b
Requirement
Requires the Mekanism mod to be installed
Returns the current raw radiation level in Sv/h.
"},{"location":"peripherals/environment_detector/#isdimension","title":"isDimension","text":"isDimension(dimension: string) -> boolean\nReturns true if the current dimension matches the dimension parameter.
isMoon(moonPhaseId: number) -> boolean\nReturns true if the current moon phase matches the moonPhaseId parameter.
isRaining() -> boolean\nReturns true if it is raining.
"},{"location":"peripherals/environment_detector/#issunny","title":"isSunny","text":"isSunny() -> boolean\nReturns true if it is sunny.
"},{"location":"peripherals/environment_detector/#isthunder","title":"isThunder","text":"isThunder() -> boolean\nReturns true if it is thundering.
"},{"location":"peripherals/environment_detector/#isslimechunk","title":"isSlimeChunk","text":"isSlimeChunk() -> boolean\nReturns true if the current chunk is a slime chunk.
"},{"location":"peripherals/environment_detector/#listdimensions","title":"listDimensions","text":"listDimensions() -> table\nReturns a table with all of the registered dimensions for the current world, this includes modded dimensions.
Example
As an example listDimensions might return a table like so:
{\"minecraft:overworld\", \"minecraft:the_nether\", \"minecraft:the_end\", \"twilightforest:twilight_forest\"}\n0.6.5b Added getRadiationRaw
0.6.1b Added getRadiation
0.3.3b Added many more functions to the environment detector. The environment detector was a useless block before this update.
0.1b Added the block. It was the second feature of the mod.
"},{"location":"peripherals/geo_scanner/","title":"Geo Scanner","text":"Picture
The Geo Scanner provides information about blocks around it and the chunk of that it is in.
The Geo scanner has a delay between scans, so you must wait until you can scan again.
Peripheral Name Interfaces with Has events Introduced in geoScanner Blocks No 0.7r
"},{"location":"peripherals/geo_scanner/#functions","title":"Functions","text":""},{"location":"peripherals/geo_scanner/#getfuellevel","title":"getFuelLevel","text":"getFuelLevel() -> number\nReturns the amount of stored fuel.
"},{"location":"peripherals/geo_scanner/#getfuelmaxlevel","title":"getFuelMaxLevel","text":"getFuelMaxLevel() -> number\nReturns the maximum amount of possible stored fuel.
"},{"location":"peripherals/geo_scanner/#cost","title":"cost","text":"cost(radius: number) -> number\nReturns the cost in FE for a scan with the given radius.
scan(radius: number) -> table | nil, string\nReturns a list of data about all blocks in the radius. Or if the scan fails it returns nil and an error message.
"},{"location":"peripherals/geo_scanner/#block-properties","title":"Block Properties","text":"block Description name:string The registry name of the block tags: table A list of block tags x: number The block's x coordinate y: number The block's y coordinate z: number The block's z coordinate"},{"location":"peripherals/geo_scanner/#getscancooldown","title":"getScanCooldown","text":"getScanCooldown() -> number\nReturns the current time remaining until then next scan() can be ran.
chunkAnalyze() -> table | nil, reason\nReturns a table of data about how many of each ore type is in the block's chunk. Or if the analyze fails it returns nil and an error message.
"},{"location":"peripherals/geo_scanner/#changelogtrivia","title":"Changelog/Trivia","text":"0.7r Added Geo Scanner peripheral.
"},{"location":"peripherals/inventory_manager/","title":"Inventory Manager","text":"Picture
The Inventory Manager can communicate with the player's inventory. You need to assign yourself to a Memory Card and put the card into the manager to use it.
Note
Only one Memory Card can be used per Inventory Manager.
Peripheral Name Interfaces with Has events Introduced in inventoryManager Player Inventory No 0.5b
Failure
You need to place the inventory you want to use next to the inventory manager and NOT next to the computer!"},{"location":"peripherals/inventory_manager/#functions","title":"Functions","text":""},{"location":"peripherals/inventory_manager/#additemtoplayer","title":"addItemToPlayer
addItemToPlayer(direction: string, item: table) -> number\nAdds an item to the player's inventory and returns the amount of the item added. The direction is the direction of the container relative to the peripheral. The slot is the slot to take items from in the container. The Inventory Manager will add a random item to the player's inventory if the item or slot argument are not provided.
Since version 0.7r
You can now use both relative (right, left, front, back, top, bottom) and cardinal (north, south, east, west, up, down) directions for the direction argument.
local manager = peripheral.find(\"inventoryManager\")\n\n-- Add 32 cobblestone to the players offhand slot from the block above\nmanager.addItemToPlayer(\"up\", {name=\"minecraft:cobblestone\", toSlot=36, count=32})\nremoveItemFromPlayer(direction: string item: table) -> number\nRemoves an item from the player's inventory and returns the amount of the item removed. The direction is the direction of the container relative to the peripheral to put the item into. The slot is the slot to take items from in the player's inventory. The Inventory Manager will remove a random item from the player's inventory if the item or slot argument are not provided. The slot and count are overwritten if fromSlot or count is specified in the item filter if the item argument is empty, the manager will move any item.
local manager = peripheral.find(\"inventoryManager\")\n\n-- Remove up to 5 of the item in slot 1 of the player's inventory\n-- and place it in the block above\nmanager.removeItemFromPlayer(\"up\", {name=\"minecraft:cobblestone\", toSlot=3, fromSlot=1, count=5})\ngetArmor() -> table\nReturns a list of the player's current armor slots
","text":""},{"location":"peripherals/inventory_manager/#item-properties","title":"Item Properties","text":"item Description name:string The registry name of the item count: number The amount of the item maxStackSize: number Maximum stack size for the item type displayName: string The item's display name slot: number The slot that the item stack is in tags: table A list of item tags nbt: table The item's nbt data local manager = peripheral.find(\"inventoryManager\")\n\nlocal armor = manager.getArmor()\nprint(\"First armor piece is: \" .. armor[1].displayName)\ngetItems() -> table\nReturns the contents of the player's inventory as a list of items
","text":""},{"location":"peripherals/inventory_manager/#item-properties_1","title":"Item Properties","text":"item Description name:string The registry name of the item count: number The amount of the item maxStackSize: number Maximum stack size for the item type slot: number The slot that the item stack is in displayName: string The item's display name tags: table A list of item tags nbt: table The item's nbt data"},{"location":"peripherals/inventory_manager/#getowner","title":"getOwner getOwner() -> string | nil\nReturns the username of the owner of the memory card in the manager or nil if there is no memory card or owner.
","text":""},{"location":"peripherals/inventory_manager/#isplayerequipped","title":"isPlayerEquippedisPlayerEquipped() -> boolean\nReturns true if the player is wearing atleast one piece of armor.
","text":""},{"location":"peripherals/inventory_manager/#iswearing","title":"isWearingisWearing(slot: number) -> boolean\nReturns true if the player is wearing a armor piece on the given slot. Slots: 103(Helmet) - 100(Boots).
getItemInHand() -> table\nAdded in version 0.7.4r
Returns the item in the player's main hand.
","text":""},{"location":"peripherals/inventory_manager/#item-properties_2","title":"Item Properties","text":"item Description name:string The registry name of the item count: number The amount of the item maxStackSize: number Maximum stack size for the item type displayName: string The item's display name tags: table A list of item tags nbt: table The item's nbt data"},{"location":"peripherals/inventory_manager/#getiteminoffhand","title":"getItemInOffHand getItemInOffHand() -> table\nAdded in version 0.7.4r
Returns the item in the player's off hand.
","text":""},{"location":"peripherals/inventory_manager/#item-properties_3","title":"Item Properties","text":"item Description name:string The registry name of the item count: number The amount of the item maxStackSize: number Maximum stack size for the item type displayName: string The item's display name tags: table A list of item tags nbt: table The item's nbt data"},{"location":"peripherals/inventory_manager/#getfreeslot","title":"getFreeSlot getFreeSlot() -> number\nAdded in version 0.7.4r
Returns the next free slot in the player's inventory. Or -1 if their inventory is full.
","text":""},{"location":"peripherals/inventory_manager/#isspaceavailable","title":"isSpaceAvailableisSpaceAvailable() -> boolean\nAdded in version 0.7.4r
Returns true if space is available in the player's inventory.
","text":""},{"location":"peripherals/inventory_manager/#getemptyspace","title":"getEmptySpacegetEmptySpace() -> number\nAdded in version 0.7.4r
Returns the number of empty slots in the player's inventory.
","text":""},{"location":"peripherals/inventory_manager/#changelogtrivia","title":"Changelog/Trivia","text":"0.7.4r Added getItemInHand, getItemInOffHand, getFreeSlot, isSpaceAvailable and getEmptySpace to the inventory manager. Added support for armor items, you can use the slots 100 - 103 to access armor items.
0.7r Added the slot parameter. Also changed the direction parameter to computercraft directions.
0.5.2b Fixed the bug where the inventory manager does not drop its contents.
0.5b Added the Inventory Manager and Memory Card
"},{"location":"peripherals/me_bridge/","title":"ME Bridge","text":"Picture
The ME Bridge is able to interact with Applied Energistics 2. You can retrieve items, craft items, get all items as a list and more. The ME Bridge uses one channel.
Requirement
Requires the Applied Energistics 2 mod to be installed
Peripheral Name Interfaces with Has events Introduced in meBridge ME System Yes 0.3b
Failure
You need to place the inventory/tank you want to use to export/import stuff next to the ME Bridge and NOT next to the computer!"},{"location":"peripherals/me_bridge/#events","title":"Events","text":""},{"location":"peripherals/me_bridge/#crafting","title":"crafting
Fires when a crafting job starts or fails. Values: 1. success: boolean Indicates whether a crafting job has successfully started or not 2. message: string A message about the status of the crafting job These values are equivalent to the return values of craftItem().
local event, success, message = os.pullEvent(\"crafting\")\nif success then\n print(\"A crafting job has successfully started\")\nelse\n print(\"A crafting job has failed to start\")\nend\nWarning
The crafting event will fire when the ME Bridge is connected to an active ME System that is performing crafting operations. These operations need to be started by the bridge itself!
Tip
You can use the command /advancedperipherals getHashItem with an item in your hand to get the MD5 hash of the NBT tags of the item. An MD5 Hash can look like this ae70053c97f877de546b0248b9ddf525.
Info
The item arguments(item: table) accepts our item filters, you can check the syntax of these filters here.
craftItem(item: table[, craftingCpu: string]) -> boolean, err: string\nTries to craft the provided item. If a craftingCpu's name is provided then it will use that cpu to craft the item.
Check the item filters guide for more info!
item Description name:string The registry name of the item or a tag count: number? The amount of the item to craft nbt: string? NBT to match the item on OR
item Description fingerprint:string A unique fingerprint which identifies theitem to craft count: number? The amount of the item to craft"},{"location":"peripherals/me_bridge/#craftfluid","title":"craftFluid craftFluid(fluid: table[, craftingCpu: string]) -> boolean, err: string\nTries to craft the provided fluid. If a craftingCpu's name is provided then it will use that cpu to craft the fluid.
Check the fluid filters guide for more info!
fluid Description name:string The registry name of the fluid or a tag count: number? The amount of the fluid to craft nbt: string? NBT to match the fluid on OR
fluid Description fingerprint:string A unique fingerprint which identifies thefluid to craft count: number? The amount of the fluid to craft ---"},{"location":"peripherals/me_bridge/#getitem","title":"getItem getItem(item: table) -> table, err: string\nReturns a table with information about the item type in the system.
","text":""},{"location":"peripherals/me_bridge/#properties","title":"Properties","text":"result Description name:string The registry name of the item fingerprint: string? A unique fingerprint which identifies the item to craft amount: number The amount of the item in the system displayName: string The display name for the item isCraftable: boolean Whether the item has a crafting pattern or not nbt: string? NBT to match the item on tags: table A list of all of the item tags"},{"location":"peripherals/me_bridge/#importitem","title":"importItem importItem(item: table, direction: string) -> number, err: string\nImports an item from a container in the direction to the ME System. Returns the number of the item imported into the system.
Since version 0.7r
You can now use both relative (right, left, front, back, top, bottom) and cardinal (north, south, east, west, up, down) directions for the direction argument.
local bridge = peripheral.find(\"meBridge\")\n\n-- Imports 32 dirt from the container above into the system\nbridge.importItem({name=\"minecraft:dirt\", count=1}, \"up\")\nexportItem(item: table, direction: string) -> number, err: string\nExports an item to a container in the direction from the ME bridge block. Returns the number of the item exported into the container.
local bridge = peripheral.find(\"meBridge\")\n\n-- Exports 1 \"Protection I\" book into the container above\nbridge.exportItem({name=\"minecraft:enchanted_book\", count=1, nbt=\"ae70053c97f877de546b0248b9ddf525\"}, \"up\")\nimportItemFromPeripheral(item: table, container: string) -> number, err: string\nSimilar to importItem() it imports an item from a container which is connected to the peripheral network. container should be the exact name of the container peripheral on the network. Returns the number of the item imported from the container.
exportItemToPeripheral(item: table, container: string) -> number, err: string\nSimilar to exportItem() it exports an item to a container which is connected to the peripheral network. container should be the exact name of the container peripheral on the network. Returns the number of the item exported into the container.
getEnergyStorage() -> number, err: string\nReturns the stored energy of the whole ME System in AE.
","text":""},{"location":"peripherals/me_bridge/#getmaxenergystorage","title":"getMaxEnergyStoragegetMaxEnergyStorage() -> number, err: string\nReturns the maximum energy storage capacity of the whole ME system in AE.
","text":""},{"location":"peripherals/me_bridge/#getenergyusage","title":"getEnergyUsagegetEnergyUsage() -> number, err: string\nReturns the energy usage of the whole ME System in AE/t.
","text":""},{"location":"peripherals/me_bridge/#getcraftingcpus","title":"getCraftingCPUsgetCraftingCPUs() -> table, err: string\nReturns a list of all connected crafting cpus.
","text":""},{"location":"peripherals/me_bridge/#cpu-properties","title":"CPU Properties","text":"cpu Description storage:number The amount of storage the CPU has coProcessors: number The number of coprocessors the CPU has isBusy: boolean If the cpu is currently crafting"},{"location":"peripherals/me_bridge/#isitemcrafting","title":"isItemCrafting isItemCrafting(item: table[, craftingCpu: string]) -> boolean, err: string\nReturns true if a crafting job for the item exists. If a craftingCpu's name is provided then it will check only if that cpu is crafting the item.
isItemCraftable(item: table) -> boolean, err: string\nReturns true if the item is craftable.
listCraftableItems() -> table, err: string\nReturns a list of information about all craftable items
","text":""},{"location":"peripherals/me_bridge/#properties_1","title":"Properties","text":"item / fluid Description name:string The registry name of the item fingerprint: string? A unique fingerprint which identifies the item to craft amount: number The amount of the item in the system displayName: string The display name for the item isCraftable: boolean Whether the item has a crafting pattern or not nbt: string? NBT to match the item on tags: table A list of all of the item tags local bridge = peripheral.find(\"meBridge\")\n\n-- print out all craftable items\ncraftableItems = bridge.listCraftableItems()\nfor _, item in pairs(craftableItems) do\n print(item.name)\nend\nlistCraftableFluid() -> table, err: string\nReturns a list of information about all craftable fluids
","text":""},{"location":"peripherals/me_bridge/#listitems","title":"listItemslistItems() -> table, err: string\nReturns a list of information about all items in the ME System.
","text":""},{"location":"peripherals/me_bridge/#listfluid","title":"listFluidlistFluid() -> table, err: string\nReturns a list of information about all fluids in the ME System.
","text":""},{"location":"peripherals/me_bridge/#listgas","title":"listGaslistGas() -> table, err: string\nReturns a list of information about all gases (Applied Mekanistics) in the ME System.
Added in version 1.18.2-0.7.24r | 1.19.2-0.7.23b
","text":""},{"location":"peripherals/me_bridge/#listcells","title":"listCellslistCells() -> table, err: string\nReturns a list of information about all cells in the disk drives of the ME System.
cell Description item:string The name of the cell. e.g. `ae2:64k_storage_cell cellType: string The type of the cell. item or fluid bytesPerType: int The bytes per type totalBytes: int Total available bytes of the cell Added in version 1.18.2-0.7.24r | 1.19.2-0.7.23b
","text":""},{"location":"peripherals/me_bridge/#gettotalitemstorage","title":"getTotalItemStoragegetTotalItemStorage() -> int, err: string\nReturns how much total item storage the system offers
Added in version 1.18.2-0.7.24r | 1.19.2-0.7.23b
","text":""},{"location":"peripherals/me_bridge/#gettotalfluidstorage","title":"getTotalFluidStoragegetTotalFluidStorage() -> int, err: string\nReturns how much total fluid storage the system offers
Added in version 1.18.2-0.7.24r | 1.19.2-0.7.23b
","text":""},{"location":"peripherals/me_bridge/#getuseditemstorage","title":"getUsedItemStoragegetUsedItemStorage() -> int, err: string\nReturns how much item storage is used
Added in version 1.18.2-0.7.24r | 1.19.2-0.7.23b
","text":""},{"location":"peripherals/me_bridge/#getusedfluidstorage","title":"getUsedFluidStoragegetUsedFluidStorage() -> int, err: string\nReturns how much fluid storage is used
Added in version 1.18.2-0.7.24r | 1.19.2-0.7.23b
","text":""},{"location":"peripherals/me_bridge/#getavailableitemstorage","title":"getAvailableItemStoragegetAvailableItemStorage() -> int, err: string\nReturns how much item storage is available
Added in version 1.18.2-0.7.24r | 1.19.2-0.7.23b
","text":""},{"location":"peripherals/me_bridge/#getavailablefluidstorage","title":"getAvailableFluidStoragegetAvailableFluidStorage() -> int, err: string\nReturns how much fluid storage is available
","text":""},{"location":"peripherals/me_bridge/#examples","title":"Examples","text":""},{"location":"peripherals/me_bridge/#automatic-autocrafting","title":"Automatic AutocraftingThis script automatically crafts items in a list. Do you want 500 glass in your me system at all times? Add glass to the list and the script will craft it for you. No need for level emitters or crafting cards!
You can find instructions on how to install the script here
","text":""},{"location":"peripherals/me_bridge/#me-crafting-cpus","title":"ME Crafting CPUsThis script shows you some statistics about the ME crafting cpus.
You can find instructions on how to install the script here
","text":""},{"location":"peripherals/me_bridge/#changelogtrivia","title":"Changelog/Trivia","text":"0.7r The ME Bridge does uses computercraft relative and cardinal directions. We also changed some function names.
0.4b Reworked the system of the ME Bridge, it now has more features and a new system for the item parameter.
0.3.9b Added the importItem and exportItem from container functions.
0.3b Added the ME Bridge with a good amount of features.
"},{"location":"peripherals/nbt_storage/","title":"NBT Storage","text":"Picture
NBT Storage is a custom block that allows reading and writing of NBT data to the block for later use.
Peripheral Name Interfaces with Has events Introduced in nbtStorage NBT No 0.7r
Failure
You need to place the inventory/tank you want to use to export/import stuff next to the RS Bridge and NOT next to the computer!"},{"location":"peripherals/nbt_storage/#functions","title":"Functions","text":""},{"location":"peripherals/nbt_storage/#read","title":"read
read() -> table\nReturns the NBT data stored in the block.
","text":""},{"location":"peripherals/nbt_storage/#writejson","title":"writeJsonwriteJson(json: string) -> boolean | nil, string\nWrites the json as NBT data into the block and returns true if the json is valid and the data is successfully written. Otherwise it returns nil and an error message.
","text":""},{"location":"peripherals/nbt_storage/#writetable","title":"writeTablewriteTable(nbt: table) -> boolean | nil, string\nWrites NBT data into the block and returns true if the data is successfully written. Otherwise it returns nil and an error message.
local storage = peripheral.find(\"nbtStorage\")\n\nstorage.writeTable({\n specialString = \"A super special string\"\n})\n\nlocal nbt = storage.read()\n-- prints \"A super special string\"\nprint(nbt.specialString)\n0.7r Added NBT Storage block.
"},{"location":"peripherals/player_detector/","title":"Player Detector","text":"Picture
The Player Detector is a useful peripheral that allows you to detect players within a certain range, position and area. You can get a list of all online players and detect when a player clicks on the block.
Peripheral Name Interfaces with Has events Introduced in playerDetector Players Yes 0.1b
"},{"location":"peripherals/player_detector/#events","title":"Events","text":""},{"location":"peripherals/player_detector/#playerclick","title":"playerClick","text":"Fires when a player clicks on the block. Values: 1. username: string The username of the player who clicked the block 2. devicename: string Th name of the peripheral like playerDetector_4
local event, username, device = os.pullEvent(\"playerClick\")\nprint(\"The detector \".. device ..\" was clicked by \" .. username)\nFires when a player joins the world/a server Values: 1. username: string The username of the player who clicked the block 2. dimension: string The resource id of the dimension the player is in
local event, username, dimension = os.pullEvent(\"playerJoin\")\nprint(\"Player \" .. username .. \" joined the server in the dimension \" .. dimension)\nFires when a player leaves the world/a server Values: 1. username: string The username of the player who clicked the block 2. dimension: string The resource id of the dimension the player was in
local event, username, dimension = os.pullEvent(\"playerLeave\")\nprint(\"Player \" .. username .. \" left the server in the dimension \" .. dimension)\nFires when a player clicks on the block. Values: 1. username: string The username of the player who clicked the block 2. fromDim: string The resource id of the dimension the player was in 2. toDim: string The resource id of the dimension the player is in
local event, username, fromDim, toDim = os.pullEvent(\"playerChangedDimension\")\nprint(\"Player \" .. username .. \" left the dimension \" .. fromDim .. \" and is now in \" .. toDim)\nInfo
The events will fire when a player detector has been connected to a computer. You don't have to .wrap() or .find() the peripheral (unless you intend to send messages).
Info
The player detector supports multidimensional spying(Since 1.19.2-0.7.30r & 1.20.1-0.7.32a). This only works if the config option playerDetMultiDimensional is set to true and the option playerDetMaxRange is set to -1(infinite)
getPlayerPos(username: string) -> table | nil\nReturns the position of the player with the username passed.
Added more properties in version 0.7.4r
table Description dimension:string The dimension the player is in eyeHeight: number The height of the player's eyes pitch: number The pitch of the player's head yaw: number The yaw of the player's head x: number The x coordinate y: number The y coordinate z: number The z coordinate local detector = peripheral.find(\"playerDetector\")\n\n-- Get the position of Player123 and print their coordinates\nlocal pos = detector.getPlayerPos(\"Player123\")\nprint(\"Position: \" .. pos.x .. \",\" .. pos.y .. \",\" .. pos.z)\ngetOnlinePlayers() -> table\nAdded in version 0.7r
Returns a list of all online players.
"},{"location":"peripherals/player_detector/#getplayersinrange","title":"getPlayersInRange","text":"getPlayersInRange(range: number) -> table\nReturns a list of players within the given range of the peripheral.
Note
The center of the range is the Player Detector peripheral and not the Computer.
getPlayersInCoords(posOne: table, posTwo: table) -> table\nAdded in version 0.7r
Returns a list of players within the 2 positions posOne and posTwo.
The posOne and posTwo tables must contain:
number number number Note
The area the detector going to detect is [x1, x2), [y1, y2), [z1, z2). Which means call getPlayersInCoords({x=x, y=y, z=z}, {x=x, y=y, z=z}) will always return nothing
getPlayersInCubic(w: number, h: number, d: number) -> table\nAdded in version 0.7r
Returns a list of players within a cuboid centered at the peripheral. Where w, h, d correspond to the x, y, z axes and are the width, height and depth of the cuboid.
isPlayerInRange(range: number, username: string) -> boolean\nReturns true if the player whose username matches the provided username is without the given range of the peripheral.
isPlayerInCoords(posOne: table, posTwo: table, username: string) -> boolean\nAdded in version 0.7r
Returns true if the player is within the 2 positions.
The posOne and posTwo tables must contain:
number number number isPlayerInCubic(w: number, h: number, d: number)\nAdded in version 0.7r
Returns true if the player is within the cuboid centered at the peripheral. Where w, h, d correspond to the x, y, z axes and are the width, height and depth of the cuboid.
isPlayersInRange(range: number) -> boolean\nReturns true if there is any player in the given range.
isPlayersInCoords(posOne: table, posTwo: table) -> boolean\nAdded in version 0.7r
Returns true if any player is within the 2 positions.
The posOne and posTwo tables must contain:
number number number isPlayersInCubic(w: number, h: number, d: number)\nAdded in version 0.7r
Returns true if any player is within the cuboid centered at the peripheral. Where w, h, d correspond to the x, y, z axes and are the width, height and depth of the cuboid.
In early versions the player detector was also a buggy block, like the energy detector. We had bugs where the block used completely wrong coordinates or the range parameters did not work.
0.7.4r Added more information to the getPlayerPos function. (Configurable)
0.7r Added more functions to the player detector. One to define the range in every 3 axes, one to define 2 positions. Also added getOnlinePlayers.
0.4.2b Added a max range config value.
0.3b Added the functions isPlayersInRange and isPlayerinRange.
0.2.6b Added the function getPlayersInRange.
0.1b Added the player detector, it was the third feature of the mod.
"},{"location":"peripherals/redstone_integrator/","title":"Redstone Integrator","text":"Picture
The Redstone Integrator is able to interact with redstone. You can use the same code you would use for a computer on a Redstone Integrator.
You may need this peripheral for cases where you need to output redstone signals on more sides than a regular computer has to offer.
Peripheral Name Interfaces with Has events Introduced in redstoneIntegrator Redstone No 0.5.3b
"},{"location":"peripherals/redstone_integrator/#functions","title":"Functions","text":""},{"location":"peripherals/redstone_integrator/#getinput","title":"getInput","text":"getInput(side: string) -> boolean\nReturns true or false depending on if the redstone at the given side is on.
Since version 0.7r
You can now use both relative (right, left, front, back, top, bottom) and cardinal (north, south, east, west, up, down) directions for the side argument.
getOutput(side: string) -> boolean\nReturns true or false depending on if the Redstone Integrator is sending a signal to the given side.
getAnalogInput(side: string) -> number\nReturns the redstone level input on the given side.
Tip
You can also use Analogue instead of Analog (ex. getAnalogueInput) both work exactly the same.
getAnalogOutput(side: string) -> number\nReturns the redstone level being output by the Redstone Integrator on the given side.
setOutput(side: string, powered: boolean) -> void\nSets the redstone level output to 0 or 15 on the given side depending on powered.
local integrator = peripheral.find(\"redstoneIntegrator\")\n\nprint(\"Left redstone level: \".. integrator.getAnalogInput(\"left\")) -- prints the level of the redstone at the left side.\nprint(\"Right redstone: \".. integrator.getOutput(\"right\")) -- prints whether there is a redstone output on the right side.\nintegrator.setOutput(\"top\", true) -- Sets the redstone level to 15 for the top side.\nsetAnalogOutput(side: string, power: number) -> void\nSets the redstone level output on the given side to the given power level.
0.5.3b Added the lovely Redstone Integrator.
"},{"location":"peripherals/rs_bridge/","title":"RS Bridge","text":"Picture
The RS Bridge is able to interact with Refined Storage. You can retrieve items, craft items, get all items as a list and more.
Requirement
Requires the Refined Storage mod to be installed
Peripheral Name Interfaces with Has events Introduced in rsBridge Refined Storage No 0.3.6b
Tip
You can use the command /advancedperipherals getHashItem with an item in your hand to get the MD5 hash of the NBT tags of the item. An MD5 Hash can look like this ae70053c97f877de546b0248b9ddf525.
Info
The item arguments(item: table) accepts our item filters, you can check the syntax of these filters here.
craftItem(item: table) -> boolean\nTries to craft the provided item, returns true if it successfully starts crafting.
Check the item filters guide for more info!
item Description name:string The registry name of the item or a tag count: number? The amount of the item to craft nbt: string? NBT to match the item on OR
item Description fingerprint:string A unique fingerprint which identifies theitem to craft count: number? The amount of the item to craft"},{"location":"peripherals/rs_bridge/#craftfluid","title":"craftFluid","text":"craftFluid(fluid: table, amount: number) -> boolean\nTries to craft the provided fluid of the given amount, returns true if it successfully starts crafting.
Check the fluid filters guide for more info!
fluid Description name:string The registry name of the fluid or a tag count: number? The amount of the fluid to craft nbt: string? NBT to match the fluid on OR
fluid Description fingerprint:string A unique fingerprint which identifies thefluid to craft count: number? The amount of the fluid to craft"},{"location":"peripherals/rs_bridge/#getitem","title":"getItem","text":"getItem(item: table) -> table\nReturns a table with information about the item type in the system.
"},{"location":"peripherals/rs_bridge/#properties","title":"Properties","text":"result Description name:string The registry name of the item fingerprint: string? A unique fingerprint which identifies the item to craft amount: number The amount of the item in the system displayName: string The display name for the item isCraftable: boolean Whether the item has a crafting pattern or not nbt: string? NBT to match the item on tags: table A list of all of the item tags"},{"location":"peripherals/rs_bridge/#importitem","title":"importItem","text":"importItem(item: table, direction: string) -> number\nImports an item from a container in the direction to the RS System. Returns the number of the item imported into the system.
Since version 0.7r
You can now use both relative (right, left, front, back, top, bottom) and cardinal (north, south, east, west, up, down) directions for the direction argument.
local bridge = peripheral.find(\"rsBridge\")\n\n-- Imports 32 dirt from the container above into the system\nbridge.importItem({name=\"minecraft:dirt\", count=1}, \"up\")\nexportItem(item: table, direction: string) -> number\nExports an item to a container in the direction from the RS bridge block. Returns the number of the item exported into the container.
local bridge = peripheral.find(\"rsBridge\")\n\n-- Exports 1 \"Protection I\" book into the container above\nbridge.exportItem({name=\"minecraft:enchanted_book\", count=1, nbt=\"ae70053c97f877de546b0248b9ddf525\"}, \"up\")\nimportItemFromPeripheral(item: table, container: string) -> number\nSimilar to importItem() it imports an item from a container which is connected to the peripheral network. container should be the exact name of the container peripheral on the network. Returns the number of the item imported from the container.
exportItemToPeripheral(item: table, container: string) -> number\nSimilar to exportItem() it exports an item to a container which is connected to the peripheral network. container should be the exact name of the container peripheral on the network. Returns the number of the item exported into the container.
getMaxItemDiskStorage() -> number\nAdded in version 0.7.3r
Returns the total amount of available item disk storage.
"},{"location":"peripherals/rs_bridge/#getmaxfluiddiskstorage","title":"getMaxFluidDiskStorage","text":"getMaxItemDiskStorage() -> number\nAdded in version 0.7.3r
Returns the total amount of available fluid disk storage.
"},{"location":"peripherals/rs_bridge/#getmaxitemexternalstorage","title":"getMaxItemExternalStorage","text":"getMaxItemExternalStorage() -> number\nAdded in version 0.7.3r
Returns the total amount of available external item disk storage.
"},{"location":"peripherals/rs_bridge/#getmaxfluidexternalstorage","title":"getMaxFluidExternalStorage","text":"getMaxFluidExternalStorage() -> number\nAdded in version 0.7.3r
Returns the total amount of available external fluid disk storage.
"},{"location":"peripherals/rs_bridge/#getenergystorage","title":"getEnergyStorage","text":"getEnergyStorage() -> number\nReturns the stored energy of the whole RS System in FE.
"},{"location":"peripherals/rs_bridge/#getmaxenergystorage","title":"getMaxEnergyStorage","text":"getMaxEnergyStorage() -> number\nReturns the maximum energy storage capacity of the whole RS system in FE.
"},{"location":"peripherals/rs_bridge/#getenergyusage","title":"getEnergyUsage","text":"getEnergyUsage() -> number\nReturns the energy usage of the whole RS System in FE/t.
"},{"location":"peripherals/rs_bridge/#getpattern","title":"getPattern","text":"getPattern(item: table) -> table | nil, string\nAdded in version 0.7.3r
Returns the crafting pattern for the item if one exists.
table A list of all the input items outputs: table A list of all of the output items byproducts: table A list of any byproduct items processing: boolean If the pattern is currently being used in crafting"},{"location":"peripherals/rs_bridge/#isitemcrafting","title":"isItemCrafting","text":"isItemCrafting(item: table) -> boolean\nReturns true if a crafting job for the item exists.
isItemCraftable(item: table) -> boolean\nAdded in version 0.7.3r
Returns true if the item is craftable.
listCraftableItems() -> table\nDoes not exist in versions >=0.7.3r, <0.7.10b
Returns a list of information about all craftable items
"},{"location":"peripherals/rs_bridge/#properties_2","title":"Properties","text":"item / fluid Description name:string The registry name of the item fingerprint: string? A unique fingerprint which identifies the item to craft amount: number The amount of the item in the system displayName: string The display name for the item isCraftable: boolean Whether the item has a crafting pattern or not nbt: string? NBT to match the item on tags: table A list of all of the item tags local bridge = peripheral.find(\"rsBridge\")\n\n-- print out all craftable items\ncraftableItems = bridge.listCraftableItems()\nfor _, item in pairs(craftableItems) do\n print(item.name)\nend\nlistCraftableFluids() -> table\nDoes not exist in versions >=0.7.3r, <0.7.10b
Returns a list of information about all craftable fluids
"},{"location":"peripherals/rs_bridge/#listitems","title":"listItems","text":"listItems() -> table\nReturns a list of information about all items in the RS System.
"},{"location":"peripherals/rs_bridge/#listfluids","title":"listFluids","text":"listFluids() -> table\nReturns a list of information about all fluids in the RS System.
"},{"location":"peripherals/rs_bridge/#examples","title":"Examples","text":""},{"location":"peripherals/rs_bridge/#autocrafting-script","title":"Autocrafting script","text":"Here is a script to craft items, the computer will re-craft every item needed (a specified amount) in the RS system. Everything is adjustable.
Click here to view the script
Bug
This script does not work on versions above 0.4b
"},{"location":"peripherals/rs_bridge/#changelogtrivia","title":"Changelog/Trivia","text":"0.7.10b Ported RS Bridge to 1.18.1. Added listCraftableItems and listCraftableFluids back.
0.7.3r Added getMaxItemDiskStorage, getMaxFluidDiskStorage, getMaxItemExternalStorage, getMaxFluidExternalStorage, getPattern and isItemCraftable. Removed listCraftableItems and listCraftableFluids.
0.7r The RS Bridge does uses computercraft relative and cardinal directions. We also changed some function names.
0.4b Reworked the system of the RS Bridge, it has now more features and a new system for the item parameter.
0.3.9b Added the importItem and exportItem from container functions.
0.3.6b Added the RS Bridge with a good amount of features.
"},{"location":"turtles/chatty_turtle/","title":"Chatty Turtle","text":"Picture
The Chatty Turtle is the turtle version of the Chat Box peripheral. See its documenation for more information.
"},{"location":"turtles/chatty_turtle/#changelogtrivia","title":"Changelog/Trivia","text":"0.4b Added the Chatty Turtle
"},{"location":"turtles/chunky_turtle/","title":"Chunky Turtle","text":"Picture
The Chunky Turtle actively loads the current turtle's chunk. This turtle can be disabled in the mod's configuration file. This turtle has no functions or events.
"},{"location":"turtles/chunky_turtle/#changelogtrivia","title":"Changelog/Trivia","text":"0.4b Added the Chunky Turtle
"},{"location":"turtles/environment_turtle/","title":"Environment Turtle","text":"Picture
The Environment Turtle is the turtle version of the Environment Detector peripheral. See its documenation for more information.
"},{"location":"turtles/environment_turtle/#changelogtrivia","title":"Changelog/Trivia","text":"0.4b Added the Environment Turtle
"},{"location":"turtles/geo_scanner_turtle/","title":"Geoscanning Turtle","text":"Picture
The Geoscanning Turtle is the turtle version of the Geo Scanner peripheral. See its documenation for more information.
"},{"location":"turtles/geo_scanner_turtle/#changelogtrivia","title":"Changelog/Trivia","text":"0.7r Added the Geoscanning Turtle
"},{"location":"turtles/player_turtle/","title":"Player Turtle","text":"Picture
The Player Turtle is the turtle version of the Player Detector peripheral. See its documenation for more information.
"},{"location":"turtles/player_turtle/#changelogtrivia","title":"Changelog/Trivia","text":"0.4b Added the Player Turtle
"},{"location":"turtles/metaphysics/end_automata/","title":"End Automata","text":"Picture
End automata is a turtle with an End Mechanic Soul upgrade. This upgrade has all of the abilities of a Weak Automata plus its own additional abilites: \u2022 Teleport between saved locations \u2022 Save a location as a warp point
Peripheral Name Interfaces with Has events Introduced in endAutomata World No 0.7r
"},{"location":"turtles/metaphysics/end_automata/#how-to-craft","title":"How to craft","text":"To create an end soul, you need to feed 10 endermans via the feedSoul function to a weak automata core. The core needs to be placed inside the turtle into the current active slot(Usually the first one).
The turtle needs 10 endermans in total:
Mob Amount Enderman 10Step by Step:
weakAutomata#feedSoul() for every enderman while the enderman is in front of the turtleExample
core = peripheral.find(\"weak_automata\")\n\nsuccessful, message = core.feedSoul()\nprint(successful)\nprint(message)\npoints() -> table | nil, string\nsavePoint(name: string) -> true | nil, string\nname which can be teleported to at a future point in time. Returns true if the location is successfully saved, or nil and an error message."},{"location":"turtles/metaphysics/end_automata/#distancetopoint","title":"distanceToPoint","text":"distanceToPoint(name: string) -> number | nil, string\ngetWarpCooldown() -> number\nestimateWarpCost(name: string) -> number | nil, string\nname. Or nil and an error message."},{"location":"turtles/metaphysics/end_automata/#warptopoint","title":"warpToPoint","text":"warpToPoint(name: string) -> true | nil, string\nname. Returns true if the turtle is successfully teleported or nil and an error message."},{"location":"turtles/metaphysics/end_automata/#changelogtrivia","title":"Changelog/Trivia","text":"0.7r Added the End Automata
"},{"location":"turtles/metaphysics/husbandry_automata/","title":"Husbandry Automata","text":"Picture
Husbandry automata is a turtle with a Husbandry Mechanic Soul upgrade. This upgrade has all of the abilities of a Weak Automata plus some additional abilites: \u2022 Use items on animals \u2022 Get information about an animal \u2022 Scan for nearby animals \u2022 Capture and release animals
Peripheral Name Interfaces with Has events Introduced in husbandryAutomata World No 0.7r
"},{"location":"turtles/metaphysics/husbandry_automata/#how-to-craft","title":"How to craft","text":"To create a husbandry soul, you need to feed 3 different types of animals via the feedSoul function to a weak automata core. The core needs to be placed inside the turtle into the current active slot(Usually the first one).
The turtle needs 9 animals in total:
Animal Amount Cow 3 Sheep 3 Chicken 3Step by Step:
weakAutomata#feedSoul() for every animal while the animal is in front of the turtleExample
core = peripheral.find(\"weak_automata\")\n\nsuccessful, message = core.feedSoul()\nprint(successful)\nprint(message)\nuseOnAnimal() -> (true | nil), string\ninspectAnimal() -> table | nil, string\nsearchAnimals() -> table | nil, string\ncaptureAnimal() -> true | nil, string\nreleaseAnimal() -> true | nil, string\ngetCapturedAnimal() -> table | nil, string\n0.7r Added the Husbandry Automata
"},{"location":"turtles/metaphysics/overpowered_automata/","title":"Overpowered Automata","text":"Picture
Overpowered automata is a turtle with an Overpowered Mechanic Soul upgrade. This upgrade has all of the abilities of the original automata.
This automata will not use any item durability, however there is a very small chance that with every automata operation that the Mechanic Soul upgrade will just break- Forever. Once the upgrade has broken it can not be used again.
Peripheral Name Interfaces with Has events Introduced in overpoweredWeakAutomataoverpoweredHusbandryAutomataoverpoweredEndAutomata World No 0.7r"},{"location":"turtles/metaphysics/overpowered_automata/#changelogtrivia","title":"Changelog/Trivia","text":"0.7r Added the Overpowered Automata
"},{"location":"turtles/metaphysics/weak_automata/","title":"Weak Automata","text":"Picture
Weak automata is a turtle with a Weak Mechanic Soul upgrade. It has several different abilities: \u2022 Digging blocks with tools \u2022 Interact with blocks with an item or empty hand \u2022 Collect all or specific nearby items \u2022 Detect nearby items \u2022 Detect blocks and entities in front of the turtle \u2022 Charge the turtle with an energy cell in the turtle's inventory
Peripheral Name Interfaces with Has events Introduced in weakAutomata World No 0.7r
"},{"location":"turtles/metaphysics/weak_automata/#functions","title":"Functions","text":""},{"location":"turtles/metaphysics/weak_automata/#getfuellevel","title":"getFuelLevel","text":"getFuelLevel() -> number\ngetFuelMaxLevel() -> number\ngetFuelConsumptionRate() -> number\nsetFuelConsumptionRate(rate: number) -> true | nil, string\nrate of the turtle. See Cooldowns and Fuel consumption to learn about how fuel consumption affects fuel cost and operation cooldowns. Returns true if the consumption rate was successfully set, or nil and an error message.
"},{"location":"turtles/metaphysics/weak_automata/#getdigcooldown","title":"getDigCooldown","text":"getDigCooldown() -> number\ngetSuckCooldown() -> number\ngetUseOnBlockCooldown() -> number\ngetConfiguration() -> table\nlookAtBlock() -> table | nil, string\nlookAtEntity() -> table | nil, string\ndigBlock() -> true | nil, string\nuseOnBlock() -> true | nil, string\nscanItems() -> table | nil, string\ncollectItems([count: number]) -> true | nil, string\ncount is given around the turtle. Returns true if it successfully collects items or nil and an error message."},{"location":"turtles/metaphysics/weak_automata/#collectspecificitem","title":"collectSpecificItem","text":"collectSpecificItem(item: string[, count: number]) -> true | nil, string\ncount is given of the given item type that are around the turtle. Returns true if it successfully collects items or nil and an error message."},{"location":"turtles/metaphysics/weak_automata/#feedsoul","title":"feedSoul","text":"feedSoul() -> (true | nil), string\nchargeTurtle([fuel: number]) -> number | nil, string\nfuel argument limits the amount of fuel it will try to gain. Returns the amount of fuel points gained or nil and an error message."},{"location":"turtles/metaphysics/weak_automata/#changelogtrivia","title":"Changelog/Trivia","text":"0.7r Added the Weak Automata
"}]} \ No newline at end of file +{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Advanced Peripherals","text":"Advanced Peripherals is a mod that adds many useful extensions for CC:Tweaked. You can communicate with Refined Storage, Applied Energistics 2 or with the whole Minecraft world.
With Advanced Peripherals you can control your base in Minecraft only with messages in the chat, you can develop an AI that controls your farms - there really is no limit to what you can create with CC:Tweaked and Advanced Peripherals.
"},{"location":"#links","title":"Links","text":"If you need help, join the Discord See the mod page on Curseforge Find the mod source code on Github
"},{"location":"#version-support","title":"Version support","text":"Supported Version 1.16 1.17 1.18 1.19.2 1.19.3 1.19.4 1.20.1 1.20.4 Security patches Critical fixes Minor fixes Minor features Fully supported Will be supported"},{"location":"#netlify","title":"Netlify","text":"Netlify is a cloud computing company that offers a development platform for web applications and dynamic websites. It provides a unified workflow that integrates build tools, web frameworks, APIs, and various web technologies. The platform is designed to support the development, deployment, and scaling of websites whose source files are stored in Git and then generated into static web content files
"},{"location":"#contribute","title":"Contribute","text":"If you want to contribute to this documentation or fix any spelling mistakes, feel free to do so on the documentation Github, checkout the Contribute section in the README for more info.
Documentation rewrite and overhaul by SyntheticDev
"},{"location":"changelogs/0.7.24r/","title":"Changelog 1.18.2-0.7.24r / 1.19.3-0.7.23b","text":""},{"location":"changelogs/0.7.24r/#table-of-contents","title":"Table of Contents","text":"The 0.7.24r update brings some changes to our inventory system. All major and breaking changes are listed here to help with updating your scripts.
"},{"location":"changelogs/0.7.24r/#itemfluid-filter","title":"Item/Fluid Filter","text":"You may know that we use tables to filter for items for some of our inventory transferring functions. This system got a rework and is now used for more functions but also got some syntax changes.
Fluids also now use a filter system.
The following keys got removed: - json - tag
The nbt key now uses json typed nbt values like {nbt=\"{StoredEnchantments: [{lvl: 2s, id: \\\"minecraft:blast_protection\\\"}]}\"}
The name key can now search for tags.
{\n name=\"#minecraft:wool\" -- searches for the wool tag\n -- OR\n name=\"#forge:ores/gold\" -- searches for the forge gold tag\n -- OR\n name=\"minecraft:white_wool\" -- searches for white wool\n}\nYou CAN NOT search for multiple items/tags at once.
Item Filters can filter for slots with toSlot and fromSlot.
You can find the new filter documentation here
"},{"location":"changelogs/0.7.24r/#inventory-manager","title":"Inventory manager","text":"The following functions got deprecated:
removeItemFromPlayer(direction: string, count: int[, slot: int, item: string])
addItemToPlayer(direction: string, count: int[, slot: int, item: string])
removeItemFromPlayerNBT(direction: string, count: int[, slot: int, item: table])
addItemToPlayerNBT(direction: string, count: int[, slot: int, item: table])
These will be replaced in the next major update with the following two functions:
removeItemFromPlayer(direction: direction, string: table)
addItemToPlayer(direction: string, item: table)
The following functions now use the new filter system:
removeItemFromPlayerNBT(direction: string, count: int[, slot: int, item: filter])
addItemToPlayerNBT(direction: string, count: int[, slot: int, item: filter]))
Added the following functions to the me bridge:
getTotalItemStoragegetTotalFluidStoragegetUsedItemStoragegetUsedFluidStoragegetAvailableItemStoragegetAvailableFluidStoragelistCellsisConnectedMore functions now return a Method Result. This means they're capable to report errors if something wrong. For more information, refer to the documentation of the specific function. This is not a breaking change.
"},{"location":"changelogs/0.7r/","title":"Changelog 0.7r","text":""},{"location":"changelogs/0.7r/#table-of-contents","title":"Table of Contents","text":"First of all, big thanks to SirEdvin and FatalMerlin! These awesome hoomans helped a lot with this update!
"},{"location":"changelogs/0.7r/#video","title":"Video","text":"If you don't want to read, you can watch this wonderful short video!
"},{"location":"changelogs/0.7r/#features","title":"Features","text":""},{"location":"changelogs/0.7r/#new-integrations","title":"New Integrations","text":""},{"location":"changelogs/0.7r/#integrated-dynamics-integration","title":"Integrated Dynamics Integration","text":"We added a peripheral to the \"Variable Store\" Block from Integrated Dynamics to read variables from integrated dynamics."},{"location":"changelogs/0.7r/#view-here","title":"View here","text":""},{"location":"changelogs/0.7r/#storage-drawer-integration","title":"Storage Drawer Integration","text":"You can now access Storage Drawers. Store items, push and pull items or do whatever you want to do with items. This new feature is a mod integration.
"},{"location":"changelogs/0.7r/#view-here_1","title":"View here","text":""},{"location":"changelogs/0.7r/#new-peripherals","title":"New Peripherals","text":""},{"location":"changelogs/0.7r/#colony-integrator","title":"Colony Integrator","text":"We added the Colony Integrator that interacts with MineColonies. You can use this peripheral to get information about your colony. It can be used as a pocket upgrade or as a block."},{"location":"changelogs/0.7r/#view-here_2","title":"View here","text":""},{"location":"changelogs/0.7r/#geo-scanner","title":"Geo Scanner","text":"The Geo Scanner provides information about blocks around it and information about the current chunk. You could use it to search the current chunk and nearby blocks for ores.
"},{"location":"changelogs/0.7r/#view-here_3","title":"View here","text":""},{"location":"changelogs/0.7r/#block-reader","title":"Block Reader","text":"With the Block Reader you can read the data of neighboring blocks and tile entites.
"},{"location":"changelogs/0.7r/#view-here_4","title":"View here","text":""},{"location":"changelogs/0.7r/#nbt-storage","title":"NBT Storage","text":"With the NBT Storage peripheral you are able to store tables or other values into a block as NBT data. You can read and write values to the block with the peripheral functions.
"},{"location":"changelogs/0.7r/#view-here_5","title":"View here","text":""},{"location":"changelogs/0.7r/#new-turtles-upgrades","title":"New Turtles Upgrades","text":"New powerful turtle upgrades! With these small upgrades you finally can use any tools just from turtle inventories, perform right click on blocks, collect items in a small range, transport animals and much more! But be aware, the new abilities require fuel and most of them have a cooldown. Big thanks to SirEdvin who made these upgrades.
"},{"location":"changelogs/0.7r/#new-ingame-documentation","title":"New Ingame Documentation","text":"Advanced Peripherals now uses Patchouli to generate ingame documentation. You can now get quick information about the mod in-game, without the need for internet access!
"},{"location":"changelogs/0.7r/#small-features-and-improvements","title":"Small features and improvements","text":"This update also provides a lot of small features and improvements.
"},{"location":"changelogs/0.7r/#breaking-changes","title":"Breaking changes","text":"uuid and isHidden return values to the chat event.sendFormattedMessage function to the chat box.You can now connect supported blocks directly with a modem. We completely removed the Peripheral Proxy.
"},{"location":"changelogs/0.7r/#support-for-relative-and-cardinal-directions","title":"Support for relative and cardinal directions","text":"You can now use relative directions (right, left, front, back, top bottom) and cardinal directions (north, south, east, west, up, down) at the same time. Example:
-- Both of these will work\nredstoneIntegrator.setOutput(\"north\", true)\nredstoneIntegrator.setOutput(\"right\", true)\n* Not all fixed bugs are listed here
For information on the different types of cooldowns and operations that a turtle may have see the Automatas:
All world changing operations will consume turtle fuel (unless it is disabled in the CC:Tweaked configuration). Most of these operations have cooldowns, so you should consider this in your code. Hopefully, every active cooldown can be retrieved via peripheral methods.
"},{"location":"guides/cooldowns_and_fuel_consumption/#consumption-vs-cooldowns","title":"Consumption vs Cooldowns","text":"Higher fuel consumption rate will reduce operation cooldowns, but obviously will increase the consumption of fuel. For example, if a click operation required 1 fuel point to perform and has a 5 second cooldown; with a fuel consumption rate of 2 you can perform a click operation every 2.5 seconds, but at the cost of 2 fuel points.
"},{"location":"guides/cooldowns_and_fuel_consumption/#maximum-fuel-consumption","title":"Maximum fuel consumption","text":"However, fuel consumption rate is not so simple! Every mechanic soul has a max fuel consumption limitation, that can be retrieved via the getConfiguration() method.
Also, the number of required fuel points increases faster than fuel consumption for every reduction in cooldowns. Fuel consumption 3 requires 4 fuel points, fuel consumption 4 requires 6 fuel points, etc.
"},{"location":"guides/filters/","title":"Filters","text":"
Added in version 1.18.2-0.7.24r and 1.19.3-0.7.23b
The tables which are added to one of our item/fluid transferring functions are called Item/Fluid Filters. The functions use these to find the item you're looking for. These can set the item, count, slots, tags, nbt or fingerprint values.
"},{"location":"guides/filters/#syntax","title":"Syntax","text":""},{"location":"guides/filters/#itemfluid-name-and-tag","title":"Item/Fluid Name and Tag","text":"The item's/fluid's filter name or tag can be specified with the name field. If this field is not set, the filter will try to search for items with the right nbt values specified in the nbt field or fingerprints.
This can be a tag or a name. To filter for tags, place a # in front of the name.
{\n name = \"minecraft:enchanted_book\" -- Will just search for an enchanted book, nbt values are ginored\n}\n{\n name = \"#forge:ores/gold\" -- Will search for the gold ore tag, nbt values are ignored\n}\nThe item's/fluid's filter amout can be specified with the count field. Standard values are 64 or 1000 for fluids.
{\n name = \"minecraft:cobblestone\",\n count = 128000 -- Will try to export 128000 cobblestone to the target inventory. It will transfer less if there is not enough space in the target inventory or if there aren't enough items in the source inventory\n}\nNBT Values are specified with the nbt field. The field needs to be a string which contains a json which can be parsed to a nbt tag.
{\n name = \"minecraft:enchanted_book\" \n nbt=\"{StoredEnchantments: [{lvl: 2s, id: \\\"minecraft:blast_protection\\\"}]}\"} -- Will search for an enchanted book with the blast protection enchantment level 2\n}\nAny strings inside the nbt value needs to be prefixed with a \\
"},{"location":"guides/filters/#slots","title":"Slots","text":"Only available for item filters
Slots can be specified with the toSlot or fromSlot field. The inventory manager uses 103-100 for the armor slots helmet to boots and 36 for the offhand.
Storage systems like the rs or me bridge will ignore these fields if they are used to specify the slot of the system. Like toSlot if you use it for importItem
If the slot can't be found or if the slot can't accept this item, the item will not be transferred.
{\n toSlot = 6, -- Tries to move the item to this slot of the target inventory\n fromSlot = 36, -- Tries to remove the item from the offhand\n}\nThe fingerprint is a MD5 hash calculated of the nbt tag, the registry name and the display name.
This can be useful if you want to only filter for one very specific item. Also helpful if you don't want to copy the nbt tag for an item into the filter.
A fingerprint can be generated with the /advancedperipherals getHashItem command while holding the item in your main hand.
If the fingerpring field is specified, the nbt and name field will be ignored.
{\n fingerprint = \"227FCCBE693942047DD04AA96F735F2E\" -- The hash for a protection 4 enchanted book\n count = 5 -- Try to move 5 protection 4 books to the target inventory\n}\nWe appreciate your dedication to making the project better by helping us squash those pesky bugs and suggesting exciting new features. The process of reporting a bug or requesting a new feature is straightforward and user-friendly. Here's how to do it:
"},{"location":"guides/how_to_report/#reporting-a-bug","title":"Reporting a Bug","text":"Expected Behavior: Start by describing what you expected to happen when you encountered the bug. This helps us understand the issue better.
Steps to Reproduce: Provide a clear, step-by-step guide on how to reproduce the bug. Include every detail, like which items you used, where you were, and what actions you took.
Logs: If the bug is critical, or you're not sure what's causing it, including logs can be a game-changer. Share any error messages or log files related to the issue.
Pictures: A picture is worth a thousand words! If you can, add screenshots to visually demonstrate the problem.
Optional - Video: Want to be an awesome bug hunter? Record a short video showing the bug in action. It can make the bug-hunting process even smoother!
"},{"location":"guides/how_to_report/#requesting-a-feature","title":"Requesting a Feature","text":"Clear Description: Tell us exactly what you want to see in the mod. Be specific and clear about the new features purpose.
API Functions: If your feature request involves changes or additions to the Lua functions, let us know which functions or methods you'd like to see added or modified.
Use Cases: Explain how this new feature would enhance your gameplay. Share scenarios where it would come in handy.
Remember, our modding community is built on collaboration and a love for Minecraft. Be friendly and respectful in your reports and requests.
To report a bug or request a feature, head over to our github repository. Your feedback is important to us, and it makes the project what it is today!
If you need assistance or want to discuss a feature or something else, head out to our discord
"},{"location":"integrations/","title":"Mod Integrations","text":""},{"location":"integrations/#how-do-they-work","title":"How do they work?","text":"To use our third party integrations you can simply place your computer or a modem next to a supported block and wrap it. If the block is supported, you can use the functions it'll provide, see the block's specific page for more information.
Example with a botania mana flower:
local flower = peripheral.find(\"manaFlower\")\n\nprint(\"Stored mana: \".. flower.getMana())\nprint(\"Mana capacity: \".. flower.getMaxMana())\nprint(\"Is on enchanted soul?: \".. flower.isOnEnchantedSoil())\nIf you want to see more integrations, you can request a mod integration on Github.
"},{"location":"integrations/#changelogtrivia","title":"Changelog/Trivia","text":"0.7.16 Added Create and Botania integrations
0.7.7r Removed Draconic Evolution integration
0.7.4r Added Draconic Evolution integration
0.7r Removed the Peripheral Proxy, you can now connect your computer with any supported block directly. Added Integrated Dynamics integration Added Storage Drawers integration
0.6b Added mod integrations with the Peripheral Proxy
"},{"location":"integrations/botania/flowers/","title":"Mana Generating Flowers","text":"Available in all versions
Picture
Mana generating flowers from botania can generate mana for other recipes or rituals.
Requirement
Requires the Botania mod to be installed
Peripheral Name Interfaces with Has events Introduced in manaFlower Mana flowers No 0.6b
"},{"location":"integrations/botania/flowers/#functions","title":"Functions","text":""},{"location":"integrations/botania/flowers/#getmana","title":"getMana","text":"getMana() -> number\ngetMaxMana() -> number\nisFloating() -> boolean\nisOnEnchantedSoil() -> boolean\n0.7.16 Ported Botania integration to 1.18
0.6b Added integration for Botania
"},{"location":"integrations/botania/pool/","title":"Mana Pool","text":"Available in all versions
Picture
Mana Pools are used to store mana. They are also used to craft items.
Requirement
Requires the Botania mod to be installed
Peripheral Name Interfaces with Has events Introduced in manaPool Mana Pool block No 0.6b
"},{"location":"integrations/botania/pool/#functions","title":"Functions","text":""},{"location":"integrations/botania/pool/#getmana","title":"getMana","text":"getMana() -> number\ngetMaxMana() -> number\ngetManaNeeded() -> number\nAdded in version 0.7.4r
Returns the amount of mana needed to fill the pool. Equivalent to getMaxMana() - getMana().
isEmpty() -> boolean\nisFull() -> boolean\n0.7.16 Ported Botania integration to 1.18
0.7.4r Added getManaNeeded to the Mana Pool integration
0.6b Added integration for Botania
"},{"location":"integrations/botania/spreader/","title":"Mana Spreader","text":"Available in all versions
Picture
Mana Spreaders are used to transfer mana from one source to another.
Requirement
Requires the Botania mod to be installed
Peripheral Name Interfaces with Has events Introduced in manaSpreader Mana Spreader block No 0.6b
"},{"location":"integrations/botania/spreader/#functions","title":"Functions","text":""},{"location":"integrations/botania/spreader/#getmana","title":"getMana","text":"getMana() -> number\ngetMaxMana() -> number\nisEmpty() -> boolean\nisFull() -> boolean\ngetVariant() -> string\ngetBounding() -> table\nnumber The x coordinate y: number The y coordinate z: number The z coordinate"},{"location":"integrations/botania/spreader/#changelogtrivia","title":"Changelog/Trivia","text":"0.7.16 Ported Botania integration to 1.18
0.6b Added integration for Botania
"},{"location":"integrations/create/basin/","title":"Basin","text":"Available in versions 1.18+
Picture
A Basin can hold items and fluids for many different crafting recipes.
Requirement
Requires the Create mod to be installed
Peripheral Name Interfaces with Has events Introduced in basin Basin block No 0.7.16
"},{"location":"integrations/create/basin/#functions","title":"Functions","text":""},{"location":"integrations/create/basin/#getinputfluids","title":"getInputFluids","text":"getInputFluids() -> table\ngetOutputFluids() -> table\ngetFilter() -> table\ngetInventory() -> table\n0.7.16 Added Create integration
"},{"location":"integrations/create/blazeburner/","title":"Blaze Burner","text":"Available in all versions
Picture
A Blaze Burner uses different fuel types to heat up things above it like basins and fluid tanks.
Requirement
Requires the Create mod to be installed
Peripheral Name Interfaces with Has events Introduced in blazeBurner Blaze Burner block No 0.7.16
"},{"location":"integrations/create/blazeburner/#functions","title":"Functions","text":""},{"location":"integrations/create/blazeburner/#getinfo","title":"getInfo","text":"getInfo() -> table\nstring The type of fuel in the burner heatLevel: string The blaze burner heat level remainingBurnTime: number The amount of burn time left for the current fuel isCreative: boolean If the burner is using creative fuel"},{"location":"integrations/create/blazeburner/#changelogtrivia","title":"Changelog/Trivia","text":"0.7.16 Added Create integration
"},{"location":"integrations/create/fluidtank/","title":"Fluid Tank","text":"Available in versions 1.18+
Picture
A Fluid Tank is a multiblock structure which can hold fluids. With each block being able to hold 8 buckets worth.
Requirement
Requires the Create mod to be installed
Peripheral Name Interfaces with Has events Introduced in fluidTank Fluid Tank block No 0.7.16
"},{"location":"integrations/create/fluidtank/#functions","title":"Functions","text":""},{"location":"integrations/create/fluidtank/#getinfo","title":"getInfo","text":"getInfo() -> table\nnumber The maximum amount of fluid the tank can hold amount: number The amount of fluid in the tank fluid: string The registry name for the tank's current fluid isBoiler: boolean If the tank is part of a boiler"},{"location":"integrations/create/fluidtank/#changelogtrivia","title":"Changelog/Trivia","text":"0.7.16 Added Create integration
"},{"location":"integrations/create/mechanicalmixer/","title":"Mechanical Mixer","text":"Available in versions 1.18+
Picture
A Mechanical Mixer is used in combination with a Basin to process many shapeless recipes with items and fluid.
Requirement
Requires the Create mod to be installed
Peripheral Name Interfaces with Has events Introduced in mechanicalMixer Mechanical Mixer block No 0.7.16
"},{"location":"integrations/create/mechanicalmixer/#functions","title":"Functions","text":""},{"location":"integrations/create/mechanicalmixer/#isrunning","title":"isRunning","text":"isRunning() -> boolean\nhasBasin() -> boolean\n0.7.16 Added Create integration
"},{"location":"integrations/create/scrollbehaviour/","title":"Blocks with Scroll Value Behaviours","text":"Available in all versions
This integration works for all blocks with any type of scroll value behaviour. Like the Speed Controller and Creative Motor.
Info
This integration only works for Speed based scroll value behaviour blocks. So this will not work for blocks like the Smart Funnel.
Requirement
Requires the Create mod to be installed
Peripheral Name Interfaces with Has events Introduced in scrollBehaviourEntityspeedController (1.16) Scroll Value Behaviour blocks No 0.7.16
"},{"location":"integrations/create/scrollbehaviour/#functions","title":"Functions","text":""},{"location":"integrations/create/scrollbehaviour/#gettargetspeed","title":"getTargetSpeed","text":"getTargetSpeed() -> number\nsetTargetSpeed(value: number) -> boolean\nvalue. Returns whether or not the value was successfully set."},{"location":"integrations/create/scrollbehaviour/#changelogtrivia","title":"Changelog/Trivia","text":"0.7.16 Added Create integration
"},{"location":"integrations/draconic_evolution/","title":"Draconic Evolution","text":"Only available in versions =>1.16-0.7.4r, <1.16-0.7.7r
The Draconic Evolution integration was only briefly available in the mod. Hence the documentation for the mod's integrations have been excluded from the side navigation. However, if needed they can still be accessed using the links below:
"},{"location":"integrations/draconic_evolution/#docs","title":"Docs","text":"0.7.7r Removed Draconic Evolution integration
0.7.4r Added Draconic Evolution integration
"},{"location":"integrations/draconic_evolution/energy_core/","title":"Energy core","text":"Go Back"},{"location":"integrations/draconic_evolution/energy_core/#draconic-energy-core","title":"Draconic Energy Core","text":"Only available in versions =>1.16-0.7.4r, <1.16-0.7.7r
Picture
The Draconic Energy Core is a multiblock structure which can store massive amounts of energy.
Requirement
Requires the Draconic Evolution mod to be installed
"},{"location":"integrations/draconic_evolution/energy_core/#functions","title":"Functions","text":""},{"location":"integrations/draconic_evolution/energy_core/#getenergystored","title":"getEnergyStored","text":"getEnergyStored() -> number\ngetMaxEnergyStored() -> number\ngetTransferPerTick() -> number\ngetTier() -> number\n0.7.4r Added Draconic Evolution integration
"},{"location":"integrations/draconic_evolution/reactor/","title":"Reactor","text":"Go Back"},{"location":"integrations/draconic_evolution/reactor/#draconic-reactor","title":"Draconic Reactor","text":"Only available in versions =>1.16-0.7.4r, <1.16-0.7.7r
Picture
The Draconic Reactor is a powerful reactor used to create a massive amount of energy.
Requirement
Requires the Draconic Evolution mod to be installed
"},{"location":"integrations/draconic_evolution/reactor/#functions","title":"Functions","text":""},{"location":"integrations/draconic_evolution/reactor/#getreactorinfo","title":"getReactorInfo","text":"getReactorInfo() -> table\nchargeReactor() -> boolean\nactivateReactor() -> boolean\nstopReactor() -> boolean\nsetFailSafe(enabled: boolean) -> void\n0.7.4r Added Draconic Evolution integration
"},{"location":"integrations/immersive_engineering/connector/","title":"Redstone Wire Connector","text":"Only available in version 1.16
Picture
The Redstone Wire Connector is a block from Immersive Engineering to connect redstone wire over big distances.
Requirement
Requires the Immersive Engineering mod to be installed
Peripheral Name Interfaces with Has events Introduced in redstoneConnector Redstone Wire Connector block No 0.6b
"},{"location":"integrations/immersive_engineering/connector/#functions","title":"Functions","text":""},{"location":"integrations/immersive_engineering/connector/#getredstonechannel","title":"getRedstoneChannel","text":"getRedstoneChannel() -> string\nsetRedstoneChannel(color: string) -> void\ncolor channel for the connector."},{"location":"integrations/immersive_engineering/connector/#getredstoneforchannel","title":"getRedstoneForChannel","text":"getRedstoneForChannel(color: string) -> number\ncolor channel. A number from 0 to 15."},{"location":"integrations/immersive_engineering/connector/#getoutput","title":"getOutput","text":"getOutput() -> number\nisInputMode() -> boolean\n0.6b Added integration for Immersive Engineering
"},{"location":"integrations/immersive_engineering/probe/","title":"Redstone Probe","text":"Only available in version 1.16
Picture
The Redstone Probe is a block from Immersive Engineering used to read and write data to a specific redstone channel.
Requirement
Requires the Immersive Engineering mod to be installed
Peripheral Name Interfaces with Has events Introduced in redstoneProbe Redstone Probe block No 0.6b
"},{"location":"integrations/immersive_engineering/probe/#functions","title":"Functions","text":""},{"location":"integrations/immersive_engineering/probe/#getsendingchannel","title":"getSendingChannel","text":"getSendingChannel() -> string\nsetSendingChannel(color: string) -> void\ncolor channel."},{"location":"integrations/immersive_engineering/probe/#getreceivingchannel","title":"getReceivingChannel","text":"getReceivingChannel() -> string\nsetReceivingChannel(color: string) -> void\ncolor channel."},{"location":"integrations/immersive_engineering/probe/#getredstoneforchannel","title":"getRedstoneForChannel","text":"getRedstoneForChannel(color: string) -> number\ncolor channel. A number from 0 to 15."},{"location":"integrations/immersive_engineering/probe/#changelogtrivia","title":"Changelog/Trivia","text":"0.6b Added integration for Immersive Engineering
"},{"location":"integrations/integrated_dynamics/variable_store/","title":"Variable Store","text":"Only available in version 1.16
Picture
The Variable Store is a block from Integrated Dynamics that can store variables for future use.
Requirement
Requires the Integrated Dynamics mod to be installed
Peripheral Name Interfaces with Has events Introduced in variableStore Variable Store block No 0.7r
"},{"location":"integrations/integrated_dynamics/variable_store/#functions","title":"Functions","text":""},{"location":"integrations/integrated_dynamics/variable_store/#list","title":"list","text":"list() -> table\nstring The variable's id label: string The label name for the variable type: string The type of the variable dynamic: boolean If the variable is dynamic"},{"location":"integrations/integrated_dynamics/variable_store/#read","title":"read","text":"read(slot: number) -> table | nil, string\nslot. Or nil and an error message."},{"location":"integrations/integrated_dynamics/variable_store/#properties_1","title":"Properties","text":"variable Description id: string The variable's id label: string The label name for the variable type: string The type of the variable value: string The NBT representation of the stored value dynamic: boolean If the variable is dynamic"},{"location":"integrations/integrated_dynamics/variable_store/#changelogtrivia","title":"Changelog/Trivia","text":"0.7r Added integration for Integrated Dynamics
"},{"location":"integrations/mekanism/","title":"Mekanism","text":"Only available in versions =>1.16-0.6b, <1.16-0.7.7r
The Mekanism integration was removed from the mod due to mekanism adding CC:Tweaked support internally. Hence the documentation for the mod's integrations have been excluded from the side navigation. For updated documentation on mekanism integration see the Mekanism wiki. If needed the old docs can still be accessed using the links below:
"},{"location":"integrations/mekanism/#docs","title":"Docs","text":"0.7.7r Removed Mekanism integration
0.6b Added integration for Mekanism
"},{"location":"integrations/mekanism/boiler/","title":"Boiler","text":"Go Back"},{"location":"integrations/mekanism/boiler/#boiler","title":"Boiler","text":"Picture
Mod: Mekanism Block: Boiler Valve
The Themoelectric Boiler is a multiblock structure from mekanism to generate steam or other gases.
Info
Energy functions will always return in FE. If you want it in joules, multiply the value with 2.5
The functions which returns a value in percent, will return a number between 1-0. (50% would be 0.5)
"},{"location":"integrations/mekanism/boiler/#functions","title":"Functions","text":"Function Returns Description getCoolant() table Returns the type of coolant and the amount. getCoolantCapacity() int Returns capacity of the coolant tank. getCoolantNeeded() int Returns the coolant that is needed the tank is full. getCoolantFilledPercentage() int Returns the amount of the coolant in percent. getHeatedCoolant() table Returns the type of heated coolant and the amount. getHeatedCoolantCapacity() int Returns capacity of the heated coolant tank. getHeatedCoolantNeeded() int Returns the amount of heated coolant that is needed to fill the tank. getHeatedCoolantFilledPercentage() int Returns the amount of the heated coolant in percent. getWater() int Returns the amount of the water. getWaterCapacity() int Returns the capacity of the water. getWaterNeeded() int Returns the amount of water that is needed to fill the tank. getWaterFilledPercentage() int Returns the amount of the water in percent. getSteam() int Returns the stored amount of the water. getSteamCapacity() int Returns the capacity of the steam. getSteamNeeded() int Returns the amount of steam that is needed to fill the tank. getSteamFilledPercentage() int Returns the amount of the steam in percent. getEnvironmentalLoss() int Returns the environmental loss. getTemperature() int Returns the temperature of the reactor. getBoilRate() int Returns the boil rate. getMaxBoilRate() int Returns the max boil rate. getSuperheaters() int Returns the amount of superheating elements. getBoilCapacity() int Returns the capacity of the boiler."},{"location":"integrations/mekanism/boiler/#changelogtrivia","title":"Changelog/Trivia","text":"0.6b Added integration for Mekanism
"},{"location":"integrations/mekanism/chemical/","title":"Chemical","text":"Go Back"},{"location":"integrations/mekanism/chemical/#chemical-tank","title":"Chemical Tank","text":"Picture
Mod: Mekanism Block: Chemical Tank
Chemical Tanks are used to store Gases. They can be placed as a block and can interact with Pressurized Tubes. They come in the four tiers, each tier being double the capacity and output rate of its predecessor. It can store the following gases:
Info
The functions which returns a value in percent, will return a number between 1-0. (50% would be 0.5)
"},{"location":"integrations/mekanism/chemical/#functions","title":"Functions","text":"Function Returns Description getStored() table Returns the type and the amount of the chemical. getCapacity() int Returns the capacity. getFilledPercentage() int Returns the amount of the stored chemical in percent. getNeeded() int Returns the amount of chemicals that is needed to fill the tank."},{"location":"integrations/mekanism/chemical/#changelogtrivia","title":"Changelog/Trivia","text":"0.6.6b Added integration for the chemical tank
"},{"location":"integrations/mekanism/digital_miner/","title":"Digital miner","text":"Go Back"},{"location":"integrations/mekanism/digital_miner/#fission-reactor","title":"Fission Reactor","text":"Picture
Mod: Mekanism Block: Digital Miner
The Digital Miner is the scale mining machine of Mekanism. However, this machine is like no other as it \"magically-teleports\" mined blocks to its inventory.
Info
Energy functions will always return in FE. If you want it in joules, multiply the value with 2.5
The functions which returns a value in percent, will return a number between 1-0. (50% would be 0.5)
"},{"location":"integrations/mekanism/digital_miner/#functions","title":"Functions","text":"Function Returns Description getDelay() int Returns the delay between two mining operations. getRadius() int Returns the radius. setRadius(int radius) Set the radius. getMinY() int Returns the minium mining high. setMinY(int high) Set the minium mining high. getMaxY() int Returns the maximum mining high. setMaxY(int high) Set the maximum mining high. toggleSilkTouch() Toggles the silk touch mode. toggleInverse() Toggles the inverse mode. toggleAutoEject() Toggles the auto eject mode. toggleAutoPull() Toggles the auto pull mode. start() Starts the miner. stop() Stops the miner. reset() Resets the miner. getTotalEnergyFilledPercentage() int Returns the amount of the energy in percent."},{"location":"integrations/mekanism/digital_miner/#changelogtrivia","title":"Changelog/Trivia","text":"0.6.5b Added the digital miner integration
"},{"location":"integrations/mekanism/dynamic_tank/","title":"Dynamic tank","text":"Go Back"},{"location":"integrations/mekanism/dynamic_tank/#dynamic-tank","title":"Dynamic Tank","text":"Picture
Mod: Mekanism Block: Dynamic Tank Valve
The Dynamic tank is a multiblock structure from mekanism to store fluids, gases and more.
Info
Energy functions will always return in FE. If you want it in joules, multiply the value with 2.5
The functions which returns a value in percent, will return a number between 1-0. (50% would be 0.5)
"},{"location":"integrations/mekanism/dynamic_tank/#functions","title":"Functions","text":"Function Returns Description getStored() table Returns a table with the amount, the name of the stored type and the current type(fluid, gas, ...). getCapacity() int Returns the capacity of the tank. getFilledPercentage int Returns the amount in percent. getNeeded() int Returns the amount that is needed to fill the tank. isEmpty() boolean Returns true if the tank is empty."},{"location":"integrations/mekanism/dynamic_tank/#changelogtrivia","title":"Changelog/Trivia","text":"0.7.3r Added dynamic tank integration
0.6b Added integration for Mekanism
"},{"location":"integrations/mekanism/fission/","title":"Fission","text":"Go Back"},{"location":"integrations/mekanism/fission/#fission-reactor","title":"Fission Reactor","text":"Picture
Mod: Mekanism Block: Fission Reactor Logic Adapter
The Fission Reactor is a reactor from Mekanism.
Info
Energy functions will always return in FE. If you want it in joules, multiply the value with 2.5
The functions which returns a value in percent, will return a number between 1-0. (50% would be 0.5)
"},{"location":"integrations/mekanism/fission/#functions","title":"Functions","text":"Function Returns Description getCoolant() table Returns the type of coolant and the amount. getCoolantCapacity() int Returns capacity of the coolant tank. getCoolantNeeded() int Returns the coolant that is needed the tank is full. getCoolantFilledPercentage() int Returns the amount of the coolant in percent. getHeatedCoolant() table Returns the type of heated coolant and the amount. getHeatedCoolantCapacity() int Returns capacity of the heated coolant tank. getHeatedCoolantNeeded() int Returns the amount of heated coolant that is needed to fill the tank. getHeatedCoolantFilledPercentage() int Returns the amount of the heated coolant in percent. getFuel() int Returns the amount of fuel. getFuelCapacity() int Returns capacity of the fuel tank. getFuelNeeded() int Returns the amount of fuel that is needed to fill the tank. getFuelFilledPercentage() int Returns the amount of the fuel in percent. getWaste() int Returns the amount of waste. getWasteCapacity() int Returns capacity of the waste tank. getWasteNeeded() int Returns the waste that is needed to fill the tank. getWasteFilledPercentage() int Returns the amount of the waste in percent. getStatus() booleans Returns true if the reactor is active false if not. scram() Deactivates the reactor. activate() Activates the reactor. getBurnRate() int Returns the burn rate of the reactor that is set. setBurnRate(int rate) Set the burn rate. getActualBurnRate() int Actual burn rate as it may be lower if say there is not enough fuel . getMaxBurnRate() int Returns the max burn rate. getDamagePercent() int Returns the damage in percent. getHeatingRate() int Returns the heating rate. getEnvironmentalLoss() int Returns the environmental loss. getTemperature() int Returns the temperature of the reactor. getHeatCapacity() int Returns the max temperature. getFuelAssemblies() int Returns the amount of fuel assemblies. getFuelSurfaceArea() int Returns the surface area of the fuel. getBoilEfficiency() int getActualBurnRate() int Actual burn rate as it may be lower if say there is not enough fuel . getMaxBurnRate() int Returns the max burn rate. getDamagePercent() int Returns the damage in percent. getHeatingRate() int Returns the heating rate. getEnvironmentalLoss() int Returns the environmental loss."},{"location":"integrations/mekanism/fission/#changelogtrivia","title":"Changelog/Trivia","text":"0.6b Added integration for Mekanism
"},{"location":"integrations/mekanism/fluid_tank/","title":"Fluid tank","text":"Go Back"},{"location":"integrations/mekanism/fluid_tank/#fluid-tank","title":"Fluid Tank","text":"Picture
Mod: Mekanism Block: Fluid Tanks
Fluid Tanks are tanks from mekanism to store fluids, obviously.
Info
Energy functions will always return in FE. If you want it in joules, multiply the value with 2.5
The functions which returns a value in percent, will return a number between 1-0. (50% would be 0.5)
"},{"location":"integrations/mekanism/fluid_tank/#functions","title":"Functions","text":"Function Returns Description getStored() table Returns a table with the amount and the name of the stored type. getTier() string Returns the tier of the tank(Basic, Advanced, ...). getCapacity() int Returns the capacity of the tank. getFilledPercentage int Returns the amount in percent. getNeeded() int Returns the amount that is needed to fill the tank."},{"location":"integrations/mekanism/fluid_tank/#changelogtrivia","title":"Changelog/Trivia","text":"0.7.2r Added fluid tank integration
0.6b Added integration for Mekanism
"},{"location":"integrations/mekanism/fusion/","title":"Fusion","text":"Go Back"},{"location":"integrations/mekanism/fusion/#fusion-reactor","title":"Fusion Reactor","text":"Picture
Mod: Mekanism Block: Fusion Reactor Logic Adapter
The Fusion Reactor is a reactor from Mekanism.
Info
Energy functions will always return in FE. If you want it in joules, multiply the value with 2.5
The functions which returns a value in percent, will return a number between 1-0. (50% would be 0.5)
"},{"location":"integrations/mekanism/fusion/#functions","title":"Functions","text":"Function Returns Description getHohlraum() table Returns the item stack of the hohlraum. getPlasmaTemperature() int Returns the temperature of the plasma. getCaseTemperature() int Returns the temperature of the case. getWater() int Returns the amount of the water. getWaterCapacity() int Returns the capacity of the water. getWaterNeeded() int Returns the amount of water that is needed to fill the tank. getWaterFilledPercentage() int Returns the amount of the water in percent. getSteam() int Returns the stored amount of the water. getSteamCapacity() int Returns the capacity of the steam. getSteamNeeded() int Returns the amount of steam that is needed to fill the tank. getSteamFilledPercentage() int Returns the amount of the steam in percent. getTritium() int Returns the amount of the tritium. getTritiumCapacity() int Returns the capacity of the tritium. getTritiumNeeded() int Returns the amount of tritium that is needed to fill the tank. getTritiumFilledPercentage() int Returns the amount of the tritium in percent. getDeuterium() int Returns the stored amount of the deuterium. getDeuteriumCapacity() int Returns the capacity of the deuterium. getDeuteriumNeeded() int Returns the amount of deuterium that is needed to fill the tank. getDeuteriumFilledPercentage() int Returns the amount of the deuterium in percent. getDTFuel() int Returns the stored amount of the dt-fuel. getDTFuelCapacity() int Returns the capacity of the dt-fuel. getDTFuelNeeded() int Returns the amount of dt-fuel that is needed to fill the tank. getDTFuelFilledPercentage() int Returns the amount of the dt-fuel in percent. getProduction() int Returns the energy production. getInjectionRate() int Returns the injection rate. setInjectionRate(int rate) Set the injection rate. getPassiveGeneration(boolean isWaterCooled) int Returns the passive generation."},{"location":"integrations/mekanism/fusion/#changelogtrivia","title":"Changelog/Trivia","text":"0.6b Added integration for Mekanism
"},{"location":"integrations/mekanism/generic/","title":"Generic","text":"Go Back"},{"location":"integrations/mekanism/generic/#generic-mekanism-machine","title":"Generic Mekanism Machine","text":"Picture
Mod: Mekanism Block: Any energy supporting block
This proxy integration will add a integration for every energy supporting machine from Mekanism.
Info
Energy functions will always return in FE. If you want it in joules, multiply the value with 2.5
The functions which returns a value in percent, will return a number between 1-0. (50% would be 0.5)
"},{"location":"integrations/mekanism/generic/#functions","title":"Functions","text":"Function Returns Description getTotalEnergy() int Returns the amount of stored energy. getTotalEnergyNeeded() int Returns the amount of energy that is needed to fill the block. getTotalEnergyFilledPercentage() int Returns the amount of the energy in percent. getTotalMaxEnergy() int Returns the capacity of the machine."},{"location":"integrations/mekanism/generic/#changelogtrivia","title":"Changelog/Trivia","text":"0.6b Added integration for Mekanism
"},{"location":"integrations/mekanism/induction/","title":"Induction","text":"Go Back"},{"location":"integrations/mekanism/induction/#induction-matrix","title":"Induction Matrix","text":"Picture
Mod: Mekanism Block: Induction Valve
The Induction Matrix is a multiblock structure from mekanism made to store large amounts of energy.
Info
Energy functions will always return in FE. If you want it in joules, multiply the value with 2.5
The functions which returns a value in percent, will return a number between 1-0. (50% would be 0.5)
"},{"location":"integrations/mekanism/induction/#functions","title":"Functions","text":"Function Returns Description getEnergy() int Returns the amount of stored energy. getLastInput() int Returns the input rate per tick. getLastOutput() int Returns the output rate per tick. getEnergyNeeded() int Returns the amount of energy that is needed to fill the matrix. getEnergyFilledPercentage() int Returns the amount of the energy in percent. getTransferCap() table Returns the max transfer rate per tick. This is defined by the amount of induction providers getInstalledCells() int Returns the amount of the installed induction cells. getInstalledProviders() int Returns the amount of the installed induction providers. getMaxEnergy() int Returns the capacity of the induction matrix."},{"location":"integrations/mekanism/induction/#changelogtrivia","title":"Changelog/Trivia","text":"0.6b Added integration for Mekanism
"},{"location":"integrations/mekanism/solar_evaporation/","title":"Solar evaporation","text":"Go Back"},{"location":"integrations/mekanism/solar_evaporation/#solar-evaporation-plant","title":"Solar Evaporation Plant","text":"Picture
Mod: Mekanism Block: Thermal Evaporation Valve
A Solar Evaporation Plant is a multiblock structure from mekanism to create brine or lithium.
Info
Energy functions will always return in FE. If you want it in joules, multiply the value with 2.5
The functions which returns a value in percent, will return a number between 1-0. (50% would be 0.5)
"},{"location":"integrations/mekanism/solar_evaporation/#functions","title":"Functions","text":"Function Returns Description getInputTank() table Returns the name and the amount of the stored fluid of the input tank(left). getInputTank() table Returns the name and the amount of the stored fluid of the output tank(right). getHeat() int Returns the amount heat. getHeight() int Returns the height of the tower. getProduction() int Returns the production rate of the tower."},{"location":"integrations/mekanism/solar_evaporation/#changelogtrivia","title":"Changelog/Trivia","text":"0.7.1r Added evaporation tower integration
0.6b Added integration for Mekanism
"},{"location":"integrations/mekanism/transmitter/","title":"Transmitter","text":"Go Back"},{"location":"integrations/mekanism/transmitter/#transmitters","title":"Transmitters","text":"Picture
Mod: Mekanism Block: Any transmitter. See full list below
Transmitters from mekanism are blocks which can transport various types of things like gases, fluids, energy or more.
Info
Energy functions will always return in FE. If you want it in joules, multiply the value with 2.5
The functions which returns a value in percent, will return a number between 1-0. (50% would be 0.5)
"},{"location":"integrations/mekanism/transmitter/#supported-transmitters","title":"Supported transmitters","text":"Supporte transmitters are
Functions for every transmitter
Function Returns Description getTransmitters int Returns the amount of transmitters. (Amount of cables) getAcceptors int Returns the amount of acceptors. (Amount of cables which are connected) getThroughput int Returns how much the cable can transfer at ones.(UsegetPull() for the logistical transporter) getTier string Returns the tier of the transporter. (Basic to ultimate) getCapacity int Returns the capacity of the cable. (Not available for: logistical transporter) getStored int Returns the amount of stored things in the cable. (Not available for: logistical transporter) getNetworkCapacity int Returns the capacity of the network. (Not available for: logistical transporter, thermodynamic conductor) getNetworkStored int Returns the amount of stored things in the network. (Not available for: logistical transporter, thermodynamic conductor)"},{"location":"integrations/mekanism/transmitter/#logistical-transporter","title":"Logistical Transporter","text":"Function Returns Description getBaseSpeed int Returns the base speed(blocks per second) of the transmitter. getBasePull int Returns the base pull speed(items per second) of the transmitter. getSpeed int Returns the base speed (blocks per second) of the transmitter based on the configuration. getPull int Returns the base pull speed(items per second) of the transmitter based on the configuration."},{"location":"integrations/mekanism/transmitter/#changelogtrivia","title":"Changelog/Trivia","text":"0.7.6r Added transmitter integration
0.6b Added integration for Mekanism
"},{"location":"integrations/mekanism/turbine/","title":"Turbine","text":"Go Back"},{"location":"integrations/mekanism/turbine/#industrial-turbine","title":"Industrial Turbine","text":"Picture
Mod: Mekanism Block: Turbine Valve
The Industrial Turbine is a multiblock structure from mekanism to generate energy with steam.
Info
Energy functions will always return in FE. If you want it in joules, multiply the value with 2.5
The functions which returns a value in percent, will return a number between 1-0. (50% would be 0.5)
"},{"location":"integrations/mekanism/turbine/#functions","title":"Functions","text":"Function Returns Description getSteam() int Returns the stored amount of the water. getSteamCapacity() int Returns the capacity of the steam. getSteamNeeded() int Returns the amount of steam that is needed to fill the tank. getSteamFilledPercentage() int Returns the amount of the steam in percent. getLastSteamInputRate() int Returns the amount of steam that is imported to the turbine. getDumpingMode() string Returns the gas dumping mode. getProductionRate() int Returns the energy production per tick. getMaxProduction() int Returns the max possible energy production per tic. getFlowRate() int Returns the current flow rate per tick. getMaxFlowRate() int Returns the current max possible flow rate per tick. getMaxWaterOutput() int Returns the max possible water output. getDispersers() int Returns the amount of dispersers. getVents() int Returns the amount of vents. getBlades() int Returns the amount of blades. getCoils() int Returns the amount of coils. getCondensers() int Returns the amount of condensers."},{"location":"integrations/mekanism/turbine/#changelogtrivia","title":"Changelog/Trivia","text":"0.6b Added integration for Mekanism
"},{"location":"integrations/mekanism/waste_barrel/","title":"Waste barrel","text":"Go Back"},{"location":"integrations/mekanism/waste_barrel/#waste-barrel","title":"Waste Barrel","text":"Picture
Mod: Mekanism Block: Waste Barrel
Waste Barrels are blocks from mekanism to store nuclear waste.
Info
Energy functions will always return in FE. If you want it in joules, multiply the value with 2.5
The functions which returns a value in percent, will return a number between 1-0. (50% would be 0.5)
"},{"location":"integrations/mekanism/waste_barrel/#functions","title":"Functions","text":"Function Returns Description getStored() int Returns the amount of stored waste. getCapacity() string Returns the capacity of the barrel. getFilledPercentage int Returns the amount of waste in percent."},{"location":"integrations/mekanism/waste_barrel/#changelogtrivia","title":"Changelog/Trivia","text":"0.7.2r Added waste barrel integration
0.6b Added integration for Mekanism
"},{"location":"integrations/minecraft/beacon/","title":"Beacon","text":"Picture
A Beacon is a block that projects a light beam skyward and can provide status effects such as Speed, Jump Boost, Haste, Regeneration, Resistance, or Strength to nearby players.
Peripheral Name Interfaces with Has events Introduced in beacon Beacon block No 0.6b
"},{"location":"integrations/minecraft/beacon/#functions","title":"Functions","text":""},{"location":"integrations/minecraft/beacon/#getlevel","title":"getLevel","text":"getLevel() -> number\ngetPrimaryEffect() -> string\ngetSecondaryEffect() -> string\n0.6b Added integration for Minecraft
"},{"location":"integrations/minecraft/noteblock/","title":"Note Block","text":"Picture
A Note Block is a musical block that emits sounds when punched or powered with redstone.
Peripheral Name Interfaces with Has events Introduced in noteBlock Note Block No 0.7.4r
"},{"location":"integrations/minecraft/noteblock/#functions","title":"Functions","text":""},{"location":"integrations/minecraft/noteblock/#playnote","title":"playNote","text":"playNote() -> void\ngetNote() -> number\nchangeNoteBy(note: number) -> number\nnote. note must be a number from 0 to 24. Returns the note if successful or -1 if not successful."},{"location":"integrations/minecraft/noteblock/#changenote","title":"changeNote","text":"changeNote() -> number\n0.7.4r Added the Note Block integration
0.6b Added integration for Minecraft
"},{"location":"integrations/powah/ender_cell/","title":"Ender Cell","text":"Only available in version 1.19.2
The Ender Cell is a block from Powah to receive, store, and send energy on specific channels of the owner. You can access the energy from anywhere.
Requirement
Requires the Powah mod to be installed
Peripheral Name Interfaces with Has events Introduced in enderCell Every Ender Cell block (all tiers) No N/A
"},{"location":"integrations/powah/ender_cell/#functions","title":"Functions","text":""},{"location":"integrations/powah/ender_cell/#getname","title":"getName","text":"getName() -> string\ngetEnergy() -> number\ngetMaxEnergy() -> number\ngetChannel() -> number\ngetMaxChannels()."},{"location":"integrations/powah/ender_cell/#getmaxchannels","title":"getMaxChannels()","text":"getMaxChannels() -> number\nsetChannel(channel: number) -> void\nchannel. channel must be a number between 1 to getMaxChannels(). Does not change the channel if channel is invalid."},{"location":"integrations/powah/ender_cell/#changelogtrivia","title":"Changelog/Trivia","text":"1.19.2-0.X.XX.X Added integration for Powah's Ender Cell
"},{"location":"integrations/powah/energy_cell/","title":"Energy Cell","text":"Only available in version 1.19.2
The Energy Cell is a block from Powah to receive, store and send energy.
Requirement
Requires the Powah mod to be installed
Peripheral Name Interfaces with Has events Introduced in energyCell Every energy cell block (all tiers) No N/A
"},{"location":"integrations/powah/energy_cell/#functions","title":"Functions","text":""},{"location":"integrations/powah/energy_cell/#getname","title":"getName","text":"getName() -> string\ngetEnergy() -> number\ngetMaxEnergy() -> number\n1.19.2-0.7.26.r Added integration for Powah
"},{"location":"integrations/powah/furnator/","title":"Furnator","text":"Only available in version 1.19.2
The Furnator is a block from Powah to generate power given a fuel source.
Requirement
Requires the Powah mod to be installed
Peripheral Name Interfaces with Has events Introduced in furnator Every furnator block (all tiers) No N/A
"},{"location":"integrations/powah/furnator/#functions","title":"Functions","text":""},{"location":"integrations/powah/furnator/#getname","title":"getName","text":"getName() -> string\ngetEnergy() -> number\ngetMaxEnergy() -> number\nisBurning() -> boolean\ngetCarbon() -> number\ngetInventory() -> table\n1.19.2-0.7.26.r Added integration for Powah
"},{"location":"integrations/powah/magmator/","title":"Magmator","text":"Only available in version 1.19.2
The Magmator is a block from Powah to generate power from a fluid heat source (lava)
Requirement
Requires the Powah mod to be installed
Peripheral Name Interfaces with Has events Introduced in magmator Every magmator block (all tiers) No N/A
"},{"location":"integrations/powah/magmator/#functions","title":"Functions","text":""},{"location":"integrations/powah/magmator/#getname","title":"getName","text":"getName() -> string\ngetEnergy() -> number\ngetMaxEnergy() -> number\nisBurning() -> boolean\ngetTankCapacity() -> number\ngetFluidInTank() -> number\n1.19.2-0.7.26.r Added integration for Powah
"},{"location":"integrations/powah/reactor/","title":"Reactor","text":"Only available in version 1.19.2
The Reactor is a block from Powah to generate power from uraninite.
Requirement
Requires the Powah mod to be installed
Peripheral Name Interfaces with Has events Introduced in uraniniteReactor Every reactor multiblock structure (all tiers) No N/A
"},{"location":"integrations/powah/reactor/#functions","title":"Functions","text":""},{"location":"integrations/powah/reactor/#getname","title":"getName","text":"getName() -> string\ngetEnergy() -> number\ngetMaxEnergy() -> number\ngetMaxEnergy() -> number\nisRunning() -> boolean\ngetFuel() -> number\ngetCarbon() -> number\ngetRedstone() -> number\ngetTemperature() -> number\ngetInventoryUraninite() -> table\ngetInventoryRedstone() -> table\ngetInventoryCarbon() -> table\n1.19.2-0.7.26.r Added integration for Powah
"},{"location":"integrations/powah/solar_panel/","title":"Solar Panel","text":"Only available in version 1.19.2
The Solar Panel is a block from Powah to generate power given direct exposure to the sky.
Requirement
Requires the Powah mod to be installed
Peripheral Name Interfaces with Has events Introduced in solarPanel Every solar panel block (all tiers) No N/A
"},{"location":"integrations/powah/solar_panel/#functions","title":"Functions","text":""},{"location":"integrations/powah/solar_panel/#getname","title":"getName","text":"getName() -> string\ngetEnergy() -> number\ngetMaxEnergy() -> number\ncanSeeSky() -> boolean\n1.19.2-0.7.26.r Added integration for Powah
"},{"location":"integrations/powah/thermo_generator/","title":"Thermo Generator","text":"Only available in version 1.19.2
The Thermo Generator is block from Powah to generate power from an appropriate heat source block beneath it (magma block, lava)
Requirement
Requires the Powah mod to be installed
Peripheral Name Interfaces with Has events Introduced in thermo Every thermo generator block (all tiers) No N/A
"},{"location":"integrations/powah/thermo_generator/#functions","title":"Functions","text":""},{"location":"integrations/powah/thermo_generator/#getname","title":"getName","text":"getName() -> string\ngetEnergy() -> number\ngetMaxEnergy() -> number\ngetCoolantInTank() -> number\n1.19.2-0.7.26.r Added integration for Powah
"},{"location":"integrations/storage_drawers/drawer/","title":"Drawer","text":"Only available in version 1.16
Picture
Drawers are a storage block from the Storage Drawer mod. This integration fixes weird interactions between the generic CC:Tweaked inventory integration and Storage Drawer logic.
Requirement
Requires the Storage Drawers mod to be installed
"},{"location":"integrations/storage_drawers/drawer/#functions","title":"Functions","text":"See the generic inventory peripheral from CC:Tweaked for details.
"},{"location":"integrations/storage_drawers/drawer/#changelogtrivia","title":"Changelog/Trivia","text":"0.7r Added integration for Storage Drawers
"},{"location":"items/ar_goggles/","title":"AR Goggles","text":"Picture
The AR Goggles can be used in combination with the AR Controller to have a customizable overlay wherever you go. Fun! See the documenation for the AR Controller to learn more.
Hint
To link your goggles to an AR Controller, right click it with them in your hand. Multiple Goggles can be linked to one Controller.
Bug
The AR Goggles are slightly buggy in 1.18x and completely disabled in 1.19x. We work on a rework of the AR Goggles system with a bunch of new features for 0.8/1.0
"},{"location":"items/ar_goggles/#changelogtrivia","title":"Changelog/Trivia","text":"0.5b Added the AR Controller and AR Goggles, made by Olfi01#6413
"},{"location":"items/chunk_controller/","title":"Chunk Controller","text":"Picture
The Chunk Controller is a crafting ingredient for the Chunky Turtle.
"},{"location":"items/chunk_controller/#changelogtrivia","title":"Changelog/Trivia","text":"0.4b Added as the crafting ingredient for the chunky turtle.
"},{"location":"items/computer_tool/","title":"Computer Tool","text":"Picture
The Computer Tool is a tool to open GUI's from the mod blocks.
Note
Currently the Computer Tool is useless.
"},{"location":"items/computer_tool/#changelogtrivia","title":"Changelog/Trivia","text":"0.5b Added the Computer Tool
"},{"location":"items/memory_card/","title":"Memory Card","text":"Picture
The Memory Card can be used in combination with the Inventory Manager to manipulate with the player's inventory. See the Inventory Manager documenation for more info.
Hint
Right click with the Memory Card in your hand to assign it to yourself to the card.
"},{"location":"items/memory_card/#changelogtrivia","title":"Changelog/Trivia","text":"0.5b Added the Inventory Manager and Memory Card
"},{"location":"items/pocket_computer/","title":"Pocket Computers","text":"Picture
There are Pocket Computer versions of the following peripherals:
Events
The pocket computer versions of the peripherals do not receive the peripheral events.
"},{"location":"items/pocket_computer/#changelogtrivia","title":"Changelog/Trivia","text":"0.7r Added Geo Scanner pocket computer.
0.4.3b Added the Player Detector and Chat Box pocket computers.
0.4.1b Added the Environment Detector pocket computer.
"},{"location":"peripherals/ar_controller/","title":"AR Controller","text":"Picture
The AR Controller is used to control your AR Goggles wirelessly. You can draw anything you wish into an overlay that will be visible as long as you're wearing the goggles.
Hint
To link your goggles to an AR Controller, right click it with them in your hand. Multiple Goggles can be linked to one Controller.
Bug
The AR Goggles are currently slightly buggy. Sometimes, they just don't do what they should do. We will rework the AR System in 0.8r/1.0r
Peripheral Name Interfaces with Has events Introduced in arController AR Goggles No 0.5b
While the Controller is in relative mode, it interprets all coordinates as if they were on a virtual screen of the size you specified, and then scales them according to your screen size.
All color values are hexadecimal color codes (for example 0xff00ff)
Everything that is painted onto the canvas remains there until clear() or if the element is removed using clearElement(id), however, it might be repositioned if relative mode is toggled on or off.
clear() -> void\nClears the entire canvas.
"},{"location":"peripherals/ar_controller/#clearelement","title":"clearElement","text":"clearElement(id: string) -> void\nClears the element with the given id.
horizontalLine(minX: number, maxX: number, y: number, color: number) -> void\nDraws a horizontal line in the given color from minX to maxX at vertical y.
"},{"location":"peripherals/ar_controller/#horizontallinewithid","title":"horizontalLineWithId","text":"horizontalLineWithId(id: string, minX: number, maxX: number, y: number, color: number) -> void\nThe same as horizontalLine(), but has an id so it can be overridden later on or can be completely cleared.
verticalLine(x: number, minY: number, maxY: number, color: number) -> void\nDraws a vertical line in the given color from minY to maxY at horizontal x.
"},{"location":"peripherals/ar_controller/#verticallinewithid","title":"verticalLineWithId","text":"verticalLineWithId(id: string, x: number, minY: number, maxY: number, color: number) -> void\nThe same as verticalLine(), but has an id so it can be overridden later on or can be completely cleared.
drawString(text: string, x: number, y: number, color: number) -> void\nDraws the given string to the specified position with the specified text color.
"},{"location":"peripherals/ar_controller/#drawstringwithid","title":"drawStringWithId","text":"drawStringWithId(id: string, text: string, x: number, y: number, color: number) -> void\nThe same as drawString(), but has an id so it can be overridden later on or can be completely cleared.
drawCenteredString(text: string, x: number, y: number, color: number) -> void\nThe same as drawString(), but centers the string horizontally around the specified position.
drawCenteredStringWithId(id: string, text: string, x: number, y: number, color: number) -> void\nThe same as drawCenteredString(), but has an id so it can be overridden later on or can be completely cleared.
drawRightboundString(text: string, x: number, y: number, color: number) -> void\nThe same as drawString(), but the string is positioned with its right end at the specified position.
drawRightboundStringWithId(id: string, text: string, x: number, y: number, color: number) -> void\nThe same as drawRightboundString(), but has an id so it can be overridden later on or can be completely cleared.
drawItemIcon(itemId: string, x: number, y: number) -> void\nAdded in version 0.5.2b
Draws the given item to the specified position.
"},{"location":"peripherals/ar_controller/#drawitemiconwithid","title":"drawItemIconWithId","text":"drawItemIconWithId(id: string, itemId: string, x: number, y: number) -> void\nAdded in version 0.5.2b
The same as drawItemIcon(), but has an id so it can be overridden later on or can be completely cleared.
drawCircle(x: number, y: number, radius: number, color: number) -> void\nAdded in version 0.5.2b
Draws a circle without filling it.
"},{"location":"peripherals/ar_controller/#drawcirclewithid","title":"drawCircleWithId","text":"drawCircleWithId(id: string, x: number, y: number, radius: number, color: number) -> void\nAdded in version 0.5.2b
The same as drawCircle(), but has an id so it can be overridden later on or can be completely cleared.
fill(minX: number, minY: number, maxX: number, maxY: number, color: number)\nFills a rectangle with the given color from the corner minX, minY to maxX, maxY.
"},{"location":"peripherals/ar_controller/#fillwithid","title":"fillWithId","text":"fill(id: string, minX: number, minY: number, maxX: number, maxY: number, color: number)\nThe same as fill(), but has an id so it can be overridden later on or can be completely cleared.
fillCircle(x: number, y: number, radius: number, color: number) -> void\nAdded in version 0.5.2b
Draws a full circle.
"},{"location":"peripherals/ar_controller/#fillcirclewithid","title":"fillCircleWithId","text":"fillCircleWithId(id: string, x: number, y: number, radius: number, color: number) -> void\nAdded in version 0.5.2b
The same as fillCircle(), but has an id so it can be overridden later on or can be completely cleared.
fillGradient(minX: number, minY: number, maxX: number, maxY: number, colorFrom: number, colorTo: number) -> void\nDraws a rectangular gradient from colorFrom to colorTo with the given corners.
"},{"location":"peripherals/ar_controller/#fillgradientwithid","title":"fillGradientWithId","text":"fillGradientWithId(id: string, minX: number, minY: number, maxX: number, maxY: number, colorFrom: number, colorTo: number) -> void\nThe same as fillGradient(), but has an id so it can be overridden later on or can be completely cleared.
isRelativeMode(): true, number, number | false\nReturns true and the size of the virtual screen if relative mode is active, or just false if it isn't.
"},{"location":"peripherals/ar_controller/#setrelativemode","title":"setRelativeMode","text":"setRelativeMode(enabled: boolean, virtualScreenWidth?: number, virtualScreenHeight?: number) -> void\nActivates or deactivates relative mode. Requires virtual screen width and height if it is being enabled.
Hint
Use negative coordinates to specify an x value from the right end of the screen or a y value from the bottom!
"},{"location":"peripherals/ar_controller/#examples","title":"Examples","text":""},{"location":"peripherals/ar_controller/#example-1","title":"Example 1","text":"Olfi01 made a simple script that shows the current date and time in the top right corner of the screen and updates every second.
local controller = peripheral.find(\"arController\") -- Finds the peripheral if one is connected\n\nif controller == nil then error(\"arController not found\") end\n\ncontroller.setRelativeMode(true, 1600, 900) -- Convenient Aspect ratio for most screens\nwhile true do\n local timer = os.startTimer(1)\n local event, id\n repeat\n event, id = os.pullEvent(\"timer\")\n until id == timer\n controller.clear() -- If you don't do this, the texts will draw over each other\n controller.drawRightboundString(os.date(), -10, 10, 0xffffff)\nend\nOlfi01 made another script to draw .nfp files, which you can draw with the paint program, in cc in your HUD.
First, we have a script with more adaptability. You can define x, y, width and height.
Script 1: Github
And we have another script which depends on the script above, but is simpler to use.
Script 2: Github
"},{"location":"peripherals/ar_controller/#changelogtrivia","title":"Changelog/Trivia","text":"0.5.2b Added fillCircle, drawCircle and drawItemIcon.
0.5b Added the AR Controller and Goggles, made by Olfi01#6413
"},{"location":"peripherals/block_reader/","title":"Block Reader","text":"Picture
This block is able to read data about any blocks or tile entities in front of it.
Peripheral Name Interfaces with Has events Introduced in blockReader Blocks No 0.7r
"},{"location":"peripherals/block_reader/#functions","title":"Functions","text":""},{"location":"peripherals/block_reader/#getblockname","title":"getBlockName","text":"getBlockName() -> string\nReturns the registry name of the block (ex. minecraft:dirt)
local reader = peripheral.find(\"blockReader\")\n\nprint(\"There is a \" .. read.getBlockName() .. \" in front.\")\ngetBlockData() -> table | nil\nReturns the block data of the block if block is a tile entity.
local reader = peripheral.find(\"blockReader\")\n\n--Prints the contents of the data\nfor k, v in ipairs(reader.getBlockData()) do \n print(k, v)\nend\n0.7r Added the Block Reader peripheral.
"},{"location":"peripherals/chat_box/","title":"Chat Box","text":"Picture
The Chat Box is able to read and write messages to the in-game chat. You can send messages to just one player or to everyone.
Hint
If you prefix your message with a $ the message will not be sent to the global chat but it will still fire the chat event. Example: $this message is hidden!
Peripheral Name Interfaces with Has events Introduced in chatBox Game Chat Yes 0.1b
"},{"location":"peripherals/chat_box/#events","title":"Events","text":""},{"location":"peripherals/chat_box/#chat","title":"chat","text":"Fires when a player sends a message into the chat. Values: 1. username: string The username of the player who sent the message 2. message: string The message sent by the player 3. uuid: string The player's uuid 4. isHidden: boolean Whether the message is hidden or not
local event, username, message, uuid, isHidden = os.pullEvent(\"chat\")\nprint(\"The 'chat' event was fired with the username \" .. username .. \" and the message \" .. message)\nInfo
The chat event will fire when a chatbox has been connected to a computer. You don't have to .wrap() or .find() the peripheral (unless you intend to send messages).
sendMessage(message: string[, prefix: string, brackets: string, bracketColor: string, range: number]) -> true | nil, string\nrange is specified it is sent to all players in the range. The prefix will change the text that appears inside the brackets at the start of a message. Defaults to \"AP\". To change the brackets used around the prefix you must specify a string like so: \"[]\", \"()\", \"<>\", ... bracketColor specifies the color to use for the brackets, this must be in the MOTD code format. Returns true if the message is successfully sent, or nil and an error message if it fails.
local chatBox = peripheral.find(\"chatBox\")\n\nchatBox.sendMessage(\"Hello world!\") -- Sends \"[AP] Hello world!\" in chat\nos.sleep(1) -- We must account for the cooldown between messages, this is to prevent spam\nchatBox.sendMessage(\"I am dave\", \"Dave\") -- Sends \"[Dave] I am dave\"\nos.sleep(1)\n\n-- Sends message \"Welcome!\" with cyan <> brackets around \"<Box>\"\n-- to players within 30 blocks of the chat box\nchatBox.sendMessage(\"Welcome!\", \"Box\", \"<>\", \"&b\", 30)\nTip
Just like the bracketColor argument you can add colors to the message and prefix arguments using the same MOTD color code format. Since CC doesn't accept non-ascii charactor \u00a7, you should replace it with &. If you want to send colored message but not only colored brackets, please use sendFormattedMessage() instead.
sendMessageToPlayer(message: string, username: string[, prefix: string, brackets: string, bracketColor: string, range: number]) -> true | nil, string\nsendMessage() this sends a message to one specific player. Specify the player to send the message to with the username parameter. local chatBox = peripheral.find(\"chatBox\")\n\nchatBox.sendMessageToPlayer(\"Hello there.\", \"Player123\") -- Sends \"[AP] Hello there.\" to Player123 in chat\nsendFormattedMessage(json: string, username: string[, prefix: string, brackets: string, bracketColor: string, range: number]) -> true | nil, string\nsendMessage() except it takes a json text component as the first parameter. Find out more information on how the text component format works on the minecraft fandom wiki. You can generate the json at minecraft.tools. local chatBox = peripheral.find(\"chatBox\")\n\nlocal message = {\n {text = \"Click \"}, \n {\n text = \"here\",\n underlined = true,\n color = \"aqua\",\n clickEvent = {\n action = \"open_url\",\n value = \"https://advancedperipherals.madefor.cc/\"\n }\n },\n {text = \" for the AP \"},\n {text = \"documentation\", color = \"red\"},\n {text = \"!\"}\n}\n\nlocal json = textutils.serialiseJSON(message)\n\nchatBox.sendFormattedMessage(json)\nsendFormattedMessageToPlayer(json: string, username: string[, prefix: string, brackets: string, bracketColor: string, range: number]) -> true | nil, string\nsendFormattedMessage() this sends a formatted message to one specific player. Specify the player to send the message to with the username parameter."},{"location":"peripherals/chat_box/#changelogtrivia","title":"Changelog/Trivia","text":"0.7r Added the uuid and isHidden parameter to the chat event. Also added the sendFormattedMessage function.
4.0b Fixed the chat box so that is should now work in LAN worlds
0.1b Added the chat box. This was the first feature of the mod.
"},{"location":"peripherals/colony_integrator/","title":"Colony Integrator","text":"Picture
The colony integrator can interact with a colony from MineColonies.
Requirement
Requires the MineColonies mod to be installed
Peripheral Name Interfaces with Has events Introduced in colonyIntegrator Mine Colony No 0.7r
"},{"location":"peripherals/colony_integrator/#functions","title":"Functions","text":""},{"location":"peripherals/colony_integrator/#getcitizens","title":"getCitizens","text":"getCitizens() -> table\nReturns a list of information about every citizen in the colony.
"},{"location":"peripherals/colony_integrator/#citizen-properties","title":"Citizen Properties","text":"citizen Description id:string The citizen's id name: string The citizen's name age: string The age of the citizen, either \"child\" or \"adult\" gender: string The citizen's gender, either \"male\" or \"female\" location: table The current location of the citizen (has x, y, z) bedPos: table The position of the citizen's bed (has x, y, z) saturation: number The citizen's food saturation happiness: number An indicator of how happy the citizen is health: number? The citizen's current health maxHealth: number? The citizen's max health armor: number? The citizen's current number of armor points toughness: number? The citizen's armor toughness betterFood: boolean Whether the citizen needs better food isAsleep: boolean If the citizen is currently asleep isIdle: boolean If the citizen is currently idle state: string A string representing the citizen's current state children: table A list of the ids of this citizen's children skills: table A table of skill names to skills where each skill hasa level and xp number work: table? A table of info about the citizen's job home: table? A table of info about the citizen's house"},{"location":"peripherals/colony_integrator/#work-properties","title":"Work Properties","text":"work Description name: string The name of the work building job: string The name of the job location: table The work location (has x, y, z) type: string The building type level: number The building's level"},{"location":"peripherals/colony_integrator/#home-properties","title":"Home Properties","text":"home Description location: table The home location (has x, y, z) type: string The building type level: number The building's level"},{"location":"peripherals/colony_integrator/#getvisitors","title":"getVisitors","text":"getVisitors() -> table\ncitizen table but there is an additional recruitCost table."},{"location":"peripherals/colony_integrator/#recruitcost-properties","title":"recruitCost properties","text":"item Description name: string The registry name of the item count: number The amount of the item maxStackSize: number Maximum stack size for the item type displayName: string The item's display name tags: table A list of item tags nbt: table The item's nbt data"},{"location":"peripherals/colony_integrator/#getbuildings","title":"getBuildings","text":"getBuildings() -> table\nstring The name of the building location: table The buildings's location (has x, y, z) type: string The building type level: number The building's level maxLevel: number The building's max level style: string The building's style storageBlocks: number The number of storage blocks in the building storageSlots: number The number of storage slots guarded: boolean If the building is currently being guarded built: boolean If the building is built or is under construction isWorkingOn: boolean Whether the building is being worked on priority: number The building's construction priority structure: table A table defining the bounds of the structure citizens: table A list of citizen's names and ids"},{"location":"peripherals/colony_integrator/#structure-properties","title":"Structure Properties","text":"structure Description cornerA: table The first corner of the bounds (has x, y, z) cornerB: table The second corner of the bounds (has x, y, z) rotation: number The structure's rotation mirror: boolean If the structure has been mirrored"},{"location":"peripherals/colony_integrator/#getresearch","title":"getResearch","text":"getResearch() -> table\nReturns a table of all possible colony research as a tree where the root table contains the branch names and their respective research.
"},{"location":"peripherals/colony_integrator/#properties","title":"Properties","text":"research Description id:string The research id name: string The name of the research status: number The current research status researchEffects: table A list of effects provided by the research children: table? A list of any child research progress: number Research progress requirements: table List of requirements for the research cost: table The cost of the research (list of tables)"},{"location":"peripherals/colony_integrator/#requirement-properties","title":"Requirement Properties","text":"requirememt Description type: string Type of requirement. desc: string Description of the requirement fulfilled: boolean If the requirement is already met"},{"location":"peripherals/colony_integrator/#building-requirement-properties","title":"Building Requirement Properties","text":"If the requirement type is building, it will have these additional properties:
string Name of the required building level: number Level of the required building"},{"location":"peripherals/colony_integrator/#cost-item-properties","title":"Cost item Properties","text":"item Description name: string The registry name of the item count: number The amount of the item maxStackSize: number Maximum stack size for the item type displayName: string The item's display name tags: table A list of item tags nbt: table The item's nbt data"},{"location":"peripherals/colony_integrator/#getrequests","title":"getRequests","text":"getRequests() -> table\nstring The request's id name: string The name of the request desc: string A description about the request state: string The state of the request count: number The number of the request minCount: number The minimum of the request needed target: string The request's target items: table A list of items attached to the request"},{"location":"peripherals/colony_integrator/#item-properties","title":"Item Properties","text":"item Description name: string The registry name of the item count: number The amount of the item maxStackSize: number Maximum stack size for the item type displayName: string The item's display name tags: table A list of item tags nbt: table The item's nbt data"},{"location":"peripherals/colony_integrator/#getworkorders","title":"getWorkOrders","text":"getWorkOrders() -> table\nstring The work order's id priority: number The priority of the work order workOrderType: string The type of work order changed: boolean If the work order changed isClaimed: boolean Whether the work order has been claimed builder: table The position of the builder (has x, y, z) buildingName: string The name of the building type: string The type of the building targetLevel: number The building's target level"},{"location":"peripherals/colony_integrator/#getworkorderresources","title":"getWorkOrderResources","text":"getWorkOrderResources(workOrderId: number) -> table | nil\nstring The registry name for the item displayName: string The display name for the item status: string The status of this resource needed: number How much of the resource is needed for the job available: boolean If the resource is currently available delivering: boolean If the resource is currently being delivered"},{"location":"peripherals/colony_integrator/#getbuilderresources","title":"getBuilderResources","text":"getBuilderResources(position: table) -> table | nil\nThe position table must contain:
number number number getColonyID() -> number\ngetColonyName() -> string\ngetColonyStyle() -> string\ngetLocation() -> table\nnumber The x coordinate y: number The y coordinate z: number The z coordinate"},{"location":"peripherals/colony_integrator/#gethappiness","title":"getHappiness","text":"getHappiness() -> number\nisActive() -> boolean\nisUnderAttack() -> boolean\nisInColony() -> boolean\nlocal integrator = peripheral.find(\"colonyIntegrator\")\n\nif integrator.isInColony() then\n print(\"Block is inside a colony!\")\nelse\n print(\"Not in a colony!\")\nend\nisWithin(position: table) -> boolean\nThe position table must contain:
number number number amountOfCitizens() -> number\nmaxOfCitizens() -> number\namountOfGraves() -> number\namountOfConstructionSites() -> number\nWe made a script to show every citizens and their gender on a monitor.
You can view and download the script on Github
"},{"location":"peripherals/colony_integrator/#colony-stats","title":"Colony Stats","text":"And here we have a script made for a pocket computer to show statistics about a colony.
You can view and download the script on Github
"},{"location":"peripherals/colony_integrator/#changelogtrivia","title":"Changelog/Trivia","text":"0.7r Added the colony integrator
"},{"location":"peripherals/energy_detector/","title":"Energy Detector","text":"Picture
The Energy Detector can detect energy flow and acts as a resistor. You can define the max flow rate to use it as a resistor.
Bug
The Energy Detector does not work on versions below 0.4.5b. It is recommended that you always use the latest version.
Peripheral Name Interfaces with Has events Introduced in energyDetector Forge Energy No 0.4.1b
"},{"location":"peripherals/energy_detector/#functions","title":"Functions","text":""},{"location":"peripherals/energy_detector/#gettransferrate","title":"getTransferRate","text":"getTransferRate() -> int\nReturns the current energy that is going through the block.
local detector = peripheral.find(\"energyDetector\")\n\n-- prints \"Current transfer rate: xxx FE/t\"\n-- where 'xxx' is the current energy flowing through the block\nprint(\"Current transfer rate: \" .. detector.getTransferRate() .. \" FE/t\")\ngetTransferRateLimit() -> int\nReturns the max rate limit of energy through the block which has been set using setTransferRateLimit.
setTransferRateLimit(limit: int) -> void\nSet the max energy rate that will go through the block.
local detector = peripheral.find(\"energyDetector\")\n\ndetector.setTransferRateLimit(512) -- Only 512 FE/t can go through the block\nThe Energy Detector had some weird problems in versions before 0.4.6b The block was able to store infinite amounts of energy or it creates an limitless amount of energy.
0.4.6b The energy detector is now bug free. hopefully
0.4.5b Completely changed the system of the energy detector, but the energy detector was able to drain energy without any reason.
0.4.3b Created a crafting recipe for the detector.
0.4.2b The energy detector is now able to send energy automatically.
0.4.1b Added the lovely bugged energy detector.
"},{"location":"peripherals/environment_detector/","title":"Environment Detector","text":"Picture
The Environment Detector provides current information from the environment like the current time, the current moon phase, the light level of the block and many more.
Peripheral Name Interfaces with Has events Introduced in environmentDetector World No 0.1b
"},{"location":"peripherals/environment_detector/#functions","title":"Functions","text":""},{"location":"peripherals/environment_detector/#getbiome","title":"getBiome","text":"getBiome() -> string\nReturns the current biome the block is in.
local detector = peripheral.find(\"environmentDetector\")\n\n-- e.g. prints \"Biome: minecraft:plains\"\nprint(\"Biome: \" .. detector.getBiome())\ngetBlockLightLevel() -> number\nReturns the block light level (0 to 15) at the detector block, this can be influenced by light sources
"},{"location":"peripherals/environment_detector/#getdaylightlevel","title":"getDayLightLevel","text":"getDayLightLevel() -> number\nReturns the day light level of the current world from 0 to 15. This is uneffected by blocks covering the peripheral.
"},{"location":"peripherals/environment_detector/#getskylightlevel","title":"getSkyLightLevel","text":"getSkyLightLevel() -> number\nReturns the current sky light level from 0 to 15 (like a daylight sensor).
"},{"location":"peripherals/environment_detector/#getdimensionname","title":"getDimensionName","text":"getDimensionName() -> string\nReturns the name of the current dimension (ex. overworld, the_nether or the_end).
local detector = peripheral.find(\"environmentDetector\")\n\n-- e.g. prints \"Dimension: the_nether\"\nprint(\"Dimension: \" .. detector.getDimensionName())\ngetDimensionPaN() -> string\nSimilar to getDimensionName it returns the name of the dimension prefixed with the provider name (ex. minecraft:overworld).
getDimensionProvider() -> string\nReturns the provider of the dimension (ex. minecraft).
getMoonId() -> number\nReturns the current moon phase's id.
Info
There are 8 different moon phases, see below a list of their names and ids
0 = Full moon, 1 = Waning gibbous, 2 = Third quarter, 3 = Waning crescent, 4 = New moon, 5 = Waxing crescent, 6 = First quarter, 7 = Waxing gibbous
getMoonName() -> string\nReturns the current moon phase's name.
"},{"location":"peripherals/environment_detector/#gettime","title":"getTime","text":"getTime() -> number\nWIP
Returns the daytime of the current world.
"},{"location":"peripherals/environment_detector/#getradiation","title":"getRadiation","text":"getRadiation() -> table\nAdded in version 0.6.1b
Requirement
Requires the Mekanism mod to be installed
Returns the current radiation level from the Mekanism mod with the radiation unit.
"},{"location":"peripherals/environment_detector/#properties","title":"Properties","text":"table Description radiation:string The current radiation level as a string unit: string The radiation unit"},{"location":"peripherals/environment_detector/#getradiationraw","title":"getRadiationRaw","text":"getRadiationRaw() -> number\nAdded in version 0.6.5b
Requirement
Requires the Mekanism mod to be installed
Returns the current raw radiation level in Sv/h.
"},{"location":"peripherals/environment_detector/#isdimension","title":"isDimension","text":"isDimension(dimension: string) -> boolean\nReturns true if the current dimension matches the dimension parameter.
isMoon(moonPhaseId: number) -> boolean\nReturns true if the current moon phase matches the moonPhaseId parameter.
isRaining() -> boolean\nReturns true if it is raining.
"},{"location":"peripherals/environment_detector/#issunny","title":"isSunny","text":"isSunny() -> boolean\nReturns true if it is sunny.
"},{"location":"peripherals/environment_detector/#isthunder","title":"isThunder","text":"isThunder() -> boolean\nReturns true if it is thundering.
"},{"location":"peripherals/environment_detector/#isslimechunk","title":"isSlimeChunk","text":"isSlimeChunk() -> boolean\nReturns true if the current chunk is a slime chunk.
"},{"location":"peripherals/environment_detector/#listdimensions","title":"listDimensions","text":"listDimensions() -> table\nReturns a table with all of the registered dimensions for the current world, this includes modded dimensions.
Example
As an example listDimensions might return a table like so:
{\"minecraft:overworld\", \"minecraft:the_nether\", \"minecraft:the_end\", \"twilightforest:twilight_forest\"}\n0.6.5b Added getRadiationRaw
0.6.1b Added getRadiation
0.3.3b Added many more functions to the environment detector. The environment detector was a useless block before this update.
0.1b Added the block. It was the second feature of the mod.
"},{"location":"peripherals/geo_scanner/","title":"Geo Scanner","text":"Picture
The Geo Scanner provides information about blocks around it and the chunk of that it is in.
The Geo scanner has a delay between scans, so you must wait until you can scan again.
Peripheral Name Interfaces with Has events Introduced in geoScanner Blocks No 0.7r
"},{"location":"peripherals/geo_scanner/#functions","title":"Functions","text":""},{"location":"peripherals/geo_scanner/#getfuellevel","title":"getFuelLevel","text":"getFuelLevel() -> number\nReturns the amount of stored fuel.
"},{"location":"peripherals/geo_scanner/#getfuelmaxlevel","title":"getFuelMaxLevel","text":"getFuelMaxLevel() -> number\nReturns the maximum amount of possible stored fuel.
"},{"location":"peripherals/geo_scanner/#cost","title":"cost","text":"cost(radius: number) -> number\nReturns the cost in FE for a scan with the given radius.
scan(radius: number) -> table | nil, string\nReturns a list of data about all blocks in the radius. Or if the scan fails it returns nil and an error message.
"},{"location":"peripherals/geo_scanner/#block-properties","title":"Block Properties","text":"block Description name:string The registry name of the block tags: table A list of block tags x: number The block's x coordinate y: number The block's y coordinate z: number The block's z coordinate"},{"location":"peripherals/geo_scanner/#getscancooldown","title":"getScanCooldown","text":"getScanCooldown() -> number\nReturns the current time remaining until then next scan() can be ran.
chunkAnalyze() -> table | nil, reason\nReturns a table of data about how many of each ore type is in the block's chunk. Or if the analyze fails it returns nil and an error message.
"},{"location":"peripherals/geo_scanner/#changelogtrivia","title":"Changelog/Trivia","text":"0.7r Added Geo Scanner peripheral.
"},{"location":"peripherals/inventory_manager/","title":"Inventory Manager","text":"Picture
The Inventory Manager can communicate with the player's inventory. You need to assign yourself to a Memory Card and put the card into the manager to use it.
Note
Only one Memory Card can be used per Inventory Manager.
Peripheral Name Interfaces with Has events Introduced in inventoryManager Player Inventory No 0.5b
Failure
You need to place the inventory you want to use next to the inventory manager and NOT next to the computer!"},{"location":"peripherals/inventory_manager/#functions","title":"Functions","text":""},{"location":"peripherals/inventory_manager/#additemtoplayer","title":"addItemToPlayer
addItemToPlayer(direction: string, item: table) -> number\nAdds an item to the player's inventory and returns the amount of the item added. The direction is the direction of the container relative to the peripheral. The slot is the slot to take items from in the container. The Inventory Manager will add a random item to the player's inventory if the item or slot argument are not provided.
Since version 0.7r
You can now use both relative (right, left, front, back, top, bottom) and cardinal (north, south, east, west, up, down) directions for the direction argument.
local manager = peripheral.find(\"inventoryManager\")\n\n-- Add 32 cobblestone to the players offhand slot from the block above\nmanager.addItemToPlayer(\"up\", {name=\"minecraft:cobblestone\", toSlot=36, count=32})\nremoveItemFromPlayer(direction: string item: table) -> number\nRemoves an item from the player's inventory and returns the amount of the item removed. The direction is the direction of the container relative to the peripheral to put the item into. The slot is the slot to take items from in the player's inventory. The Inventory Manager will remove a random item from the player's inventory if the item or slot argument are not provided. The slot and count are overwritten if fromSlot or count is specified in the item filter if the item argument is empty, the manager will move any item.
local manager = peripheral.find(\"inventoryManager\")\n\n-- Remove up to 5 of the item in slot 1 of the player's inventory\n-- and place it in the block above\nmanager.removeItemFromPlayer(\"up\", {name=\"minecraft:cobblestone\", toSlot=3, fromSlot=1, count=5})\ngetArmor() -> table\nReturns a list of the player's current armor slots
","text":""},{"location":"peripherals/inventory_manager/#item-properties","title":"Item Properties","text":"item Description name:string The registry name of the item count: number The amount of the item maxStackSize: number Maximum stack size for the item type displayName: string The item's display name slot: number The slot that the item stack is in tags: table A list of item tags nbt: table The item's nbt data local manager = peripheral.find(\"inventoryManager\")\n\nlocal armor = manager.getArmor()\nprint(\"First armor piece is: \" .. armor[1].displayName)\ngetItems() -> table\nReturns the contents of the player's inventory as a list of items
","text":""},{"location":"peripherals/inventory_manager/#item-properties_1","title":"Item Properties","text":"item Description name:string The registry name of the item count: number The amount of the item maxStackSize: number Maximum stack size for the item type slot: number The slot that the item stack is in displayName: string The item's display name tags: table A list of item tags nbt: table The item's nbt data"},{"location":"peripherals/inventory_manager/#getowner","title":"getOwner getOwner() -> string | nil\nReturns the username of the owner of the memory card in the manager or nil if there is no memory card or owner.
","text":""},{"location":"peripherals/inventory_manager/#isplayerequipped","title":"isPlayerEquippedisPlayerEquipped() -> boolean\nReturns true if the player is wearing atleast one piece of armor.
","text":""},{"location":"peripherals/inventory_manager/#iswearing","title":"isWearingisWearing(slot: number) -> boolean\nReturns true if the player is wearing a armor piece on the given slot. Slots: 103(Helmet) - 100(Boots).
getItemInHand() -> table\nAdded in version 0.7.4r
Returns the item in the player's main hand.
","text":""},{"location":"peripherals/inventory_manager/#item-properties_2","title":"Item Properties","text":"item Description name:string The registry name of the item count: number The amount of the item maxStackSize: number Maximum stack size for the item type displayName: string The item's display name tags: table A list of item tags nbt: table The item's nbt data"},{"location":"peripherals/inventory_manager/#getiteminoffhand","title":"getItemInOffHand getItemInOffHand() -> table\nAdded in version 0.7.4r
Returns the item in the player's off hand.
","text":""},{"location":"peripherals/inventory_manager/#item-properties_3","title":"Item Properties","text":"item Description name:string The registry name of the item count: number The amount of the item maxStackSize: number Maximum stack size for the item type displayName: string The item's display name tags: table A list of item tags nbt: table The item's nbt data"},{"location":"peripherals/inventory_manager/#getfreeslot","title":"getFreeSlot getFreeSlot() -> number\nAdded in version 0.7.4r
Returns the next free slot in the player's inventory. Or -1 if their inventory is full.
","text":""},{"location":"peripherals/inventory_manager/#isspaceavailable","title":"isSpaceAvailableisSpaceAvailable() -> boolean\nAdded in version 0.7.4r
Returns true if space is available in the player's inventory.
","text":""},{"location":"peripherals/inventory_manager/#getemptyspace","title":"getEmptySpacegetEmptySpace() -> number\nAdded in version 0.7.4r
Returns the number of empty slots in the player's inventory.
","text":""},{"location":"peripherals/inventory_manager/#changelogtrivia","title":"Changelog/Trivia","text":"0.7.4r Added getItemInHand, getItemInOffHand, getFreeSlot, isSpaceAvailable and getEmptySpace to the inventory manager. Added support for armor items, you can use the slots 100 - 103 to access armor items.
0.7r Added the slot parameter. Also changed the direction parameter to computercraft directions.
0.5.2b Fixed the bug where the inventory manager does not drop its contents.
0.5b Added the Inventory Manager and Memory Card
"},{"location":"peripherals/me_bridge/","title":"ME Bridge","text":"Picture
The ME Bridge is able to interact with Applied Energistics 2. You can retrieve items, craft items, get all items as a list and more. The ME Bridge uses one channel.
Requirement
Requires the Applied Energistics 2 mod to be installed
Peripheral Name Interfaces with Has events Introduced in meBridge ME System Yes 0.3b
Failure
You need to place the inventory/tank you want to use to export/import stuff next to the ME Bridge and NOT next to the computer!"},{"location":"peripherals/me_bridge/#events","title":"Events","text":""},{"location":"peripherals/me_bridge/#crafting","title":"crafting
Fires when a crafting job starts or fails. Values: 1. success: boolean Indicates whether a crafting job has successfully started or not 2. message: string A message about the status of the crafting job These values are equivalent to the return values of craftItem().
local event, success, message = os.pullEvent(\"crafting\")\nif success then\n print(\"A crafting job has successfully started\")\nelse\n print(\"A crafting job has failed to start\")\nend\nWarning
The crafting event will fire when the ME Bridge is connected to an active ME System that is performing crafting operations. These operations need to be started by the bridge itself!
Tip
You can use the command /advancedperipherals getHashItem with an item in your hand to get the MD5 hash of the NBT tags of the item. An MD5 Hash can look like this ae70053c97f877de546b0248b9ddf525.
Info
The item arguments(item: table) accepts our item filters, you can check the syntax of these filters here.
craftItem(item: table[, craftingCpu: string]) -> boolean, err: string\nTries to craft the provided item. If a craftingCpu's name is provided then it will use that cpu to craft the item.
Check the item filters guide for more info!
item Description name:string The registry name of the item or a tag count: number? The amount of the item to craft nbt: string? NBT to match the item on OR
item Description fingerprint:string A unique fingerprint which identifies theitem to craft count: number? The amount of the item to craft"},{"location":"peripherals/me_bridge/#craftfluid","title":"craftFluid craftFluid(fluid: table[, craftingCpu: string]) -> boolean, err: string\nTries to craft the provided fluid. If a craftingCpu's name is provided then it will use that cpu to craft the fluid.
Check the fluid filters guide for more info!
fluid Description name:string The registry name of the fluid or a tag count: number? The amount of the fluid to craft nbt: string? NBT to match the fluid on OR
fluid Description fingerprint:string A unique fingerprint which identifies thefluid to craft count: number? The amount of the fluid to craft ---"},{"location":"peripherals/me_bridge/#getitem","title":"getItem getItem(item: table) -> table, err: string\nReturns a table with information about the item type in the system.
","text":""},{"location":"peripherals/me_bridge/#properties","title":"Properties","text":"result Description name:string The registry name of the item fingerprint: string? A unique fingerprint which identifies the item to craft amount: number The amount of the item in the system displayName: string The display name for the item isCraftable: boolean Whether the item has a crafting pattern or not nbt: string? NBT to match the item on tags: table A list of all of the item tags"},{"location":"peripherals/me_bridge/#importitem","title":"importItem importItem(item: table, direction: string) -> number, err: string\nImports an item from a container in the direction to the ME System. Returns the number of the item imported into the system.
Since version 0.7r
You can now use both relative (right, left, front, back, top, bottom) and cardinal (north, south, east, west, up, down) directions for the direction argument.
local bridge = peripheral.find(\"meBridge\")\n\n-- Imports 32 dirt from the container above into the system\nbridge.importItem({name=\"minecraft:dirt\", count=1}, \"up\")\nexportItem(item: table, direction: string) -> number, err: string\nExports an item to a container in the direction from the ME bridge block. Returns the number of the item exported into the container.
local bridge = peripheral.find(\"meBridge\")\n\n-- Exports 1 \"Protection I\" book into the container above\nbridge.exportItem({name=\"minecraft:enchanted_book\", count=1, nbt=\"ae70053c97f877de546b0248b9ddf525\"}, \"up\")\nimportItemFromPeripheral(item: table, container: string) -> number, err: string\nSimilar to importItem() it imports an item from a container which is connected to the peripheral network. container should be the exact name of the container peripheral on the network. Returns the number of the item imported from the container.
exportItemToPeripheral(item: table, container: string) -> number, err: string\nSimilar to exportItem() it exports an item to a container which is connected to the peripheral network. container should be the exact name of the container peripheral on the network. Returns the number of the item exported into the container.
getEnergyStorage() -> number, err: string\nReturns the stored energy of the whole ME System in AE.
","text":""},{"location":"peripherals/me_bridge/#getmaxenergystorage","title":"getMaxEnergyStoragegetMaxEnergyStorage() -> number, err: string\nReturns the maximum energy storage capacity of the whole ME system in AE.
","text":""},{"location":"peripherals/me_bridge/#getenergyusage","title":"getEnergyUsagegetEnergyUsage() -> number, err: string\nReturns the energy usage of the whole ME System in AE/t.
","text":""},{"location":"peripherals/me_bridge/#getcraftingcpus","title":"getCraftingCPUsgetCraftingCPUs() -> table, err: string\nReturns a list of all connected crafting cpus.
","text":""},{"location":"peripherals/me_bridge/#cpu-properties","title":"CPU Properties","text":"cpu Description storage:number The amount of storage the CPU has coProcessors: number The number of coprocessors the CPU has isBusy: boolean If the cpu is currently crafting"},{"location":"peripherals/me_bridge/#isitemcrafting","title":"isItemCrafting isItemCrafting(item: table[, craftingCpu: string]) -> boolean, err: string\nReturns true if a crafting job for the item exists. If a craftingCpu's name is provided then it will check only if that cpu is crafting the item.
isItemCraftable(item: table) -> boolean, err: string\nReturns true if the item is craftable.
listCraftableItems() -> table, err: string\nReturns a list of information about all craftable items
","text":""},{"location":"peripherals/me_bridge/#properties_1","title":"Properties","text":"item / fluid Description name:string The registry name of the item fingerprint: string? A unique fingerprint which identifies the item to craft amount: number The amount of the item in the system displayName: string The display name for the item isCraftable: boolean Whether the item has a crafting pattern or not nbt: string? NBT to match the item on tags: table A list of all of the item tags local bridge = peripheral.find(\"meBridge\")\n\n-- print out all craftable items\ncraftableItems = bridge.listCraftableItems()\nfor _, item in pairs(craftableItems) do\n print(item.name)\nend\nlistCraftableFluid() -> table, err: string\nReturns a list of information about all craftable fluids
","text":""},{"location":"peripherals/me_bridge/#listitems","title":"listItemslistItems() -> table, err: string\nReturns a list of information about all items in the ME System.
","text":""},{"location":"peripherals/me_bridge/#listfluid","title":"listFluidlistFluid() -> table, err: string\nReturns a list of information about all fluids in the ME System.
","text":""},{"location":"peripherals/me_bridge/#listgas","title":"listGaslistGas() -> table, err: string\nReturns a list of information about all gases (Applied Mekanistics) in the ME System.
Added in version 1.18.2-0.7.24r | 1.19.2-0.7.23b
","text":""},{"location":"peripherals/me_bridge/#listcells","title":"listCellslistCells() -> table, err: string\nReturns a list of information about all cells in the disk drives of the ME System.
cell Description item:string The name of the cell. e.g. `ae2:64k_storage_cell cellType: string The type of the cell. item or fluid bytesPerType: int The bytes per type totalBytes: int Total available bytes of the cell Added in version 1.18.2-0.7.24r | 1.19.2-0.7.23b
","text":""},{"location":"peripherals/me_bridge/#gettotalitemstorage","title":"getTotalItemStoragegetTotalItemStorage() -> int, err: string\nReturns how much total item storage the system offers
Added in version 1.18.2-0.7.24r | 1.19.2-0.7.23b
","text":""},{"location":"peripherals/me_bridge/#gettotalfluidstorage","title":"getTotalFluidStoragegetTotalFluidStorage() -> int, err: string\nReturns how much total fluid storage the system offers
Added in version 1.18.2-0.7.24r | 1.19.2-0.7.23b
","text":""},{"location":"peripherals/me_bridge/#getuseditemstorage","title":"getUsedItemStoragegetUsedItemStorage() -> int, err: string\nReturns how much item storage is used
Added in version 1.18.2-0.7.24r | 1.19.2-0.7.23b
","text":""},{"location":"peripherals/me_bridge/#getusedfluidstorage","title":"getUsedFluidStoragegetUsedFluidStorage() -> int, err: string\nReturns how much fluid storage is used
Added in version 1.18.2-0.7.24r | 1.19.2-0.7.23b
","text":""},{"location":"peripherals/me_bridge/#getavailableitemstorage","title":"getAvailableItemStoragegetAvailableItemStorage() -> int, err: string\nReturns how much item storage is available
Added in version 1.18.2-0.7.24r | 1.19.2-0.7.23b
","text":""},{"location":"peripherals/me_bridge/#getavailablefluidstorage","title":"getAvailableFluidStoragegetAvailableFluidStorage() -> int, err: string\nReturns how much fluid storage is available
","text":""},{"location":"peripherals/me_bridge/#examples","title":"Examples","text":""},{"location":"peripherals/me_bridge/#automatic-autocrafting","title":"Automatic AutocraftingThis script automatically crafts items in a list. Do you want 500 glass in your me system at all times? Add glass to the list and the script will craft it for you. No need for level emitters or crafting cards!
You can find instructions on how to install the script here
","text":""},{"location":"peripherals/me_bridge/#me-crafting-cpus","title":"ME Crafting CPUsThis script shows you some statistics about the ME crafting cpus.
You can find instructions on how to install the script here
","text":""},{"location":"peripherals/me_bridge/#changelogtrivia","title":"Changelog/Trivia","text":"0.7r The ME Bridge does uses computercraft relative and cardinal directions. We also changed some function names.
0.4b Reworked the system of the ME Bridge, it now has more features and a new system for the item parameter.
0.3.9b Added the importItem and exportItem from container functions.
0.3b Added the ME Bridge with a good amount of features.
"},{"location":"peripherals/nbt_storage/","title":"NBT Storage","text":"Picture
NBT Storage is a custom block that allows reading and writing of NBT data to the block for later use.
Peripheral Name Interfaces with Has events Introduced in nbtStorage NBT No 0.7r
Failure
You need to place the inventory/tank you want to use to export/import stuff next to the RS Bridge and NOT next to the computer!"},{"location":"peripherals/nbt_storage/#functions","title":"Functions","text":""},{"location":"peripherals/nbt_storage/#read","title":"read
read() -> table\nReturns the NBT data stored in the block.
","text":""},{"location":"peripherals/nbt_storage/#writejson","title":"writeJsonwriteJson(json: string) -> boolean | nil, string\nWrites the json as NBT data into the block and returns true if the json is valid and the data is successfully written. Otherwise it returns nil and an error message.
","text":""},{"location":"peripherals/nbt_storage/#writetable","title":"writeTablewriteTable(nbt: table) -> boolean | nil, string\nWrites NBT data into the block and returns true if the data is successfully written. Otherwise it returns nil and an error message.
local storage = peripheral.find(\"nbtStorage\")\n\nstorage.writeTable({\n specialString = \"A super special string\"\n})\n\nlocal nbt = storage.read()\n-- prints \"A super special string\"\nprint(nbt.specialString)\n0.7r Added NBT Storage block.
"},{"location":"peripherals/player_detector/","title":"Player Detector","text":"Picture
The Player Detector is a useful peripheral that allows you to detect players within a certain range, position and area. You can get a list of all online players and detect when a player clicks on the block.
Peripheral Name Interfaces with Has events Introduced in playerDetector Players Yes 0.1b
"},{"location":"peripherals/player_detector/#events","title":"Events","text":""},{"location":"peripherals/player_detector/#playerclick","title":"playerClick","text":"Fires when a player clicks on the block. Values: 1. username: string The username of the player who clicked the block 2. devicename: string Th name of the peripheral like playerDetector_4
local event, username, device = os.pullEvent(\"playerClick\")\nprint(\"The detector \".. device ..\" was clicked by \" .. username)\nFires when a player joins the world/a server Values: 1. username: string The username of the player who clicked the block 2. dimension: string The resource id of the dimension the player is in
local event, username, dimension = os.pullEvent(\"playerJoin\")\nprint(\"Player \" .. username .. \" joined the server in the dimension \" .. dimension)\nFires when a player leaves the world/a server Values: 1. username: string The username of the player who clicked the block 2. dimension: string The resource id of the dimension the player was in
local event, username, dimension = os.pullEvent(\"playerLeave\")\nprint(\"Player \" .. username .. \" left the server in the dimension \" .. dimension)\nFires when a player clicks on the block. Values: 1. username: string The username of the player who clicked the block 2. fromDim: string The resource id of the dimension the player was in 2. toDim: string The resource id of the dimension the player is in
local event, username, fromDim, toDim = os.pullEvent(\"playerChangedDimension\")\nprint(\"Player \" .. username .. \" left the dimension \" .. fromDim .. \" and is now in \" .. toDim)\nInfo
The events will fire when a player detector has been connected to a computer. You don't have to .wrap() or .find() the peripheral (unless you intend to send messages).
Info
The player detector supports multidimensional spying(Since 1.19.2-0.7.30r & 1.20.1-0.7.32a). This only works if the config option playerDetMultiDimensional is set to true and the option playerDetMaxRange is set to -1(infinite)
getPlayerPos(username: string) -> table | nil\nReturns the position of the player with the username passed.
Added more properties in version 0.7.4r
table Description dimension:string The dimension the player is in eyeHeight: number The height of the player's eyes pitch: number The pitch of the player's head yaw: number The yaw of the player's head x: number The x coordinate y: number The y coordinate z: number The z coordinate local detector = peripheral.find(\"playerDetector\")\n\n-- Get the position of Player123 and print their coordinates\nlocal pos = detector.getPlayerPos(\"Player123\")\nprint(\"Position: \" .. pos.x .. \",\" .. pos.y .. \",\" .. pos.z)\ngetOnlinePlayers() -> table\nAdded in version 0.7r
Returns a list of all online players.
"},{"location":"peripherals/player_detector/#getplayersinrange","title":"getPlayersInRange","text":"getPlayersInRange(range: number) -> table\nReturns a list of players within the given range of the peripheral.
Note
The center of the range is the Player Detector peripheral and not the Computer.
getPlayersInCoords(posOne: table, posTwo: table) -> table\nAdded in version 0.7r
Returns a list of players within the 2 positions posOne and posTwo.
The posOne and posTwo tables must contain:
number number number Note
The area the detector going to detect is [x1, x2), [y1, y2), [z1, z2). Which means call getPlayersInCoords({x=x, y=y, z=z}, {x=x, y=y, z=z}) will always return nothing
getPlayersInCubic(w: number, h: number, d: number) -> table\nAdded in version 0.7r
Returns a list of players within a cuboid centered at the peripheral. Where w, h, d correspond to the x, y, z axes and are the width, height and depth of the cuboid.
isPlayerInRange(range: number, username: string) -> boolean\nReturns true if the player whose username matches the provided username is without the given range of the peripheral.
isPlayerInCoords(posOne: table, posTwo: table, username: string) -> boolean\nAdded in version 0.7r
Returns true if the player is within the 2 positions.
The posOne and posTwo tables must contain:
number number number isPlayerInCubic(w: number, h: number, d: number)\nAdded in version 0.7r
Returns true if the player is within the cuboid centered at the peripheral. Where w, h, d correspond to the x, y, z axes and are the width, height and depth of the cuboid.
isPlayersInRange(range: number) -> boolean\nReturns true if there is any player in the given range.
isPlayersInCoords(posOne: table, posTwo: table) -> boolean\nAdded in version 0.7r
Returns true if any player is within the 2 positions.
The posOne and posTwo tables must contain:
number number number isPlayersInCubic(w: number, h: number, d: number)\nAdded in version 0.7r
Returns true if any player is within the cuboid centered at the peripheral. Where w, h, d correspond to the x, y, z axes and are the width, height and depth of the cuboid.
In early versions the player detector was also a buggy block, like the energy detector. We had bugs where the block used completely wrong coordinates or the range parameters did not work.
0.7.4r Added more information to the getPlayerPos function. (Configurable)
0.7r Added more functions to the player detector. One to define the range in every 3 axes, one to define 2 positions. Also added getOnlinePlayers.
0.4.2b Added a max range config value.
0.3b Added the functions isPlayersInRange and isPlayerinRange.
0.2.6b Added the function getPlayersInRange.
0.1b Added the player detector, it was the third feature of the mod.
"},{"location":"peripherals/redstone_integrator/","title":"Redstone Integrator","text":"Picture
The Redstone Integrator is able to interact with redstone. You can use the same code you would use for a computer on a Redstone Integrator.
You may need this peripheral for cases where you need to output redstone signals on more sides than a regular computer has to offer.
Peripheral Name Interfaces with Has events Introduced in redstoneIntegrator Redstone No 0.5.3b
"},{"location":"peripherals/redstone_integrator/#functions","title":"Functions","text":""},{"location":"peripherals/redstone_integrator/#getinput","title":"getInput","text":"getInput(side: string) -> boolean\nReturns true or false depending on if the redstone at the given side is on.
Since version 0.7r
You can now use both relative (right, left, front, back, top, bottom) and cardinal (north, south, east, west, up, down) directions for the side argument.
getOutput(side: string) -> boolean\nReturns true or false depending on if the Redstone Integrator is sending a signal to the given side.
getAnalogInput(side: string) -> number\nReturns the redstone level input on the given side.
Tip
You can also use Analogue instead of Analog (ex. getAnalogueInput) both work exactly the same.
getAnalogOutput(side: string) -> number\nReturns the redstone level being output by the Redstone Integrator on the given side.
setOutput(side: string, powered: boolean) -> void\nSets the redstone level output to 0 or 15 on the given side depending on powered.
local integrator = peripheral.find(\"redstoneIntegrator\")\n\nprint(\"Left redstone level: \".. integrator.getAnalogInput(\"left\")) -- prints the level of the redstone at the left side.\nprint(\"Right redstone: \".. integrator.getOutput(\"right\")) -- prints whether there is a redstone output on the right side.\nintegrator.setOutput(\"top\", true) -- Sets the redstone level to 15 for the top side.\nsetAnalogOutput(side: string, power: number) -> void\nSets the redstone level output on the given side to the given power level.
0.5.3b Added the lovely Redstone Integrator.
"},{"location":"peripherals/rs_bridge/","title":"RS Bridge","text":"Picture
The RS Bridge is able to interact with Refined Storage. You can retrieve items, craft items, get all items as a list and more.
Requirement
Requires the Refined Storage mod to be installed
Peripheral Name Interfaces with Has events Introduced in rsBridge Refined Storage No 0.3.6b
Tip
You can use the command /advancedperipherals getHashItem with an item in your hand to get the MD5 hash of the NBT tags of the item. An MD5 Hash can look like this ae70053c97f877de546b0248b9ddf525.
Info
The item arguments(item: table) accepts our item filters, you can check the syntax of these filters here.
craftItem(item: table) -> boolean\nTries to craft the provided item, returns true if it successfully starts crafting.
Check the item filters guide for more info!
item Description name:string The registry name of the item or a tag count: number? The amount of the item to craft nbt: string? NBT to match the item on OR
item Description fingerprint:string A unique fingerprint which identifies theitem to craft count: number? The amount of the item to craft"},{"location":"peripherals/rs_bridge/#craftfluid","title":"craftFluid","text":"craftFluid(fluid: table, amount: number) -> boolean\nTries to craft the provided fluid of the given amount, returns true if it successfully starts crafting.
Check the fluid filters guide for more info!
fluid Description name:string The registry name of the fluid or a tag count: number? The amount of the fluid to craft nbt: string? NBT to match the fluid on OR
fluid Description fingerprint:string A unique fingerprint which identifies thefluid to craft count: number? The amount of the fluid to craft"},{"location":"peripherals/rs_bridge/#getitem","title":"getItem","text":"getItem(item: table) -> table\nReturns a table with information about the item type in the system.
"},{"location":"peripherals/rs_bridge/#properties","title":"Properties","text":"result Description name:string The registry name of the item fingerprint: string? A unique fingerprint which identifies the item to craft amount: number The amount of the item in the system displayName: string The display name for the item isCraftable: boolean Whether the item has a crafting pattern or not nbt: string? NBT to match the item on tags: table A list of all of the item tags"},{"location":"peripherals/rs_bridge/#importitem","title":"importItem","text":"importItem(item: table, direction: string) -> number\nImports an item from a container in the direction to the RS System. Returns the number of the item imported into the system.
Since version 0.7r
You can now use both relative (right, left, front, back, top, bottom) and cardinal (north, south, east, west, up, down) directions for the direction argument.
local bridge = peripheral.find(\"rsBridge\")\n\n-- Imports 32 dirt from the container above into the system\nbridge.importItem({name=\"minecraft:dirt\", count=1}, \"up\")\nexportItem(item: table, direction: string) -> number\nExports an item to a container in the direction from the RS bridge block. Returns the number of the item exported into the container.
local bridge = peripheral.find(\"rsBridge\")\n\n-- Exports 1 \"Protection I\" book into the container above\nbridge.exportItem({name=\"minecraft:enchanted_book\", count=1, nbt=\"ae70053c97f877de546b0248b9ddf525\"}, \"up\")\nimportItemFromPeripheral(item: table, container: string) -> number\nSimilar to importItem() it imports an item from a container which is connected to the peripheral network. container should be the exact name of the container peripheral on the network. Returns the number of the item imported from the container.
exportItemToPeripheral(item: table, container: string) -> number\nSimilar to exportItem() it exports an item to a container which is connected to the peripheral network. container should be the exact name of the container peripheral on the network. Returns the number of the item exported into the container.
getMaxItemDiskStorage() -> number\nAdded in version 0.7.3r
Returns the total amount of available item disk storage.
"},{"location":"peripherals/rs_bridge/#getmaxfluiddiskstorage","title":"getMaxFluidDiskStorage","text":"getMaxItemDiskStorage() -> number\nAdded in version 0.7.3r
Returns the total amount of available fluid disk storage.
"},{"location":"peripherals/rs_bridge/#getmaxitemexternalstorage","title":"getMaxItemExternalStorage","text":"getMaxItemExternalStorage() -> number\nAdded in version 0.7.3r
Returns the total amount of available external item disk storage.
"},{"location":"peripherals/rs_bridge/#getmaxfluidexternalstorage","title":"getMaxFluidExternalStorage","text":"getMaxFluidExternalStorage() -> number\nAdded in version 0.7.3r
Returns the total amount of available external fluid disk storage.
"},{"location":"peripherals/rs_bridge/#getenergystorage","title":"getEnergyStorage","text":"getEnergyStorage() -> number\nReturns the stored energy of the whole RS System in FE.
"},{"location":"peripherals/rs_bridge/#getmaxenergystorage","title":"getMaxEnergyStorage","text":"getMaxEnergyStorage() -> number\nReturns the maximum energy storage capacity of the whole RS system in FE.
"},{"location":"peripherals/rs_bridge/#getenergyusage","title":"getEnergyUsage","text":"getEnergyUsage() -> number\nReturns the energy usage of the whole RS System in FE/t.
"},{"location":"peripherals/rs_bridge/#getpattern","title":"getPattern","text":"getPattern(item: table) -> table | nil, string\nAdded in version 0.7.3r
Returns the crafting pattern for the item if one exists.
table A list of all the input items outputs: table A list of all of the output items byproducts: table A list of any byproduct items processing: boolean If the pattern is currently being used in crafting"},{"location":"peripherals/rs_bridge/#isitemcrafting","title":"isItemCrafting","text":"isItemCrafting(item: table) -> boolean\nReturns true if a crafting job for the item exists.
isItemCraftable(item: table) -> boolean\nAdded in version 0.7.3r
Returns true if the item is craftable.
listCraftableItems() -> table\nDoes not exist in versions >=0.7.3r, <0.7.10b
Returns a list of information about all craftable items
"},{"location":"peripherals/rs_bridge/#properties_2","title":"Properties","text":"item / fluid Description name:string The registry name of the item fingerprint: string? A unique fingerprint which identifies the item to craft amount: number The amount of the item in the system displayName: string The display name for the item isCraftable: boolean Whether the item has a crafting pattern or not nbt: string? NBT to match the item on tags: table A list of all of the item tags local bridge = peripheral.find(\"rsBridge\")\n\n-- print out all craftable items\ncraftableItems = bridge.listCraftableItems()\nfor _, item in pairs(craftableItems) do\n print(item.name)\nend\nlistCraftableFluids() -> table\nDoes not exist in versions >=0.7.3r, <0.7.10b
Returns a list of information about all craftable fluids
"},{"location":"peripherals/rs_bridge/#listitems","title":"listItems","text":"listItems() -> table\nReturns a list of information about all items in the RS System.
"},{"location":"peripherals/rs_bridge/#listfluids","title":"listFluids","text":"listFluids() -> table\nReturns a list of information about all fluids in the RS System.
"},{"location":"peripherals/rs_bridge/#examples","title":"Examples","text":""},{"location":"peripherals/rs_bridge/#autocrafting-script","title":"Autocrafting script","text":"Here is a script to craft items, the computer will re-craft every item needed (a specified amount) in the RS system. Everything is adjustable.
Click here to view the script
Bug
This script does not work on versions above 0.4b
"},{"location":"peripherals/rs_bridge/#changelogtrivia","title":"Changelog/Trivia","text":"0.7.10b Ported RS Bridge to 1.18.1. Added listCraftableItems and listCraftableFluids back.
0.7.3r Added getMaxItemDiskStorage, getMaxFluidDiskStorage, getMaxItemExternalStorage, getMaxFluidExternalStorage, getPattern and isItemCraftable. Removed listCraftableItems and listCraftableFluids.
0.7r The RS Bridge does uses computercraft relative and cardinal directions. We also changed some function names.
0.4b Reworked the system of the RS Bridge, it has now more features and a new system for the item parameter.
0.3.9b Added the importItem and exportItem from container functions.
0.3.6b Added the RS Bridge with a good amount of features.
"},{"location":"turtles/chatty_turtle/","title":"Chatty Turtle","text":"Picture
The Chatty Turtle is the turtle version of the Chat Box peripheral. See its documenation for more information.
"},{"location":"turtles/chatty_turtle/#changelogtrivia","title":"Changelog/Trivia","text":"0.4b Added the Chatty Turtle
"},{"location":"turtles/chunky_turtle/","title":"Chunky Turtle","text":"Picture
The Chunky Turtle actively loads the current turtle's chunk. This turtle can be disabled in the mod's configuration file. This turtle has no functions or events.
"},{"location":"turtles/chunky_turtle/#changelogtrivia","title":"Changelog/Trivia","text":"0.4b Added the Chunky Turtle
"},{"location":"turtles/environment_turtle/","title":"Environment Turtle","text":"Picture
The Environment Turtle is the turtle version of the Environment Detector peripheral. See its documenation for more information.
"},{"location":"turtles/environment_turtle/#changelogtrivia","title":"Changelog/Trivia","text":"0.4b Added the Environment Turtle
"},{"location":"turtles/geo_scanner_turtle/","title":"Geoscanning Turtle","text":"Picture
The Geoscanning Turtle is the turtle version of the Geo Scanner peripheral. See its documenation for more information.
"},{"location":"turtles/geo_scanner_turtle/#changelogtrivia","title":"Changelog/Trivia","text":"0.7r Added the Geoscanning Turtle
"},{"location":"turtles/player_turtle/","title":"Player Turtle","text":"Picture
The Player Turtle is the turtle version of the Player Detector peripheral. See its documenation for more information.
"},{"location":"turtles/player_turtle/#changelogtrivia","title":"Changelog/Trivia","text":"0.4b Added the Player Turtle
"},{"location":"turtles/metaphysics/end_automata/","title":"End Automata","text":"Picture
End automata is a turtle with an End Mechanic Soul upgrade. This upgrade has all of the abilities of a Weak Automata plus its own additional abilites: \u2022 Teleport between saved locations \u2022 Save a location as a warp point
Peripheral Name Interfaces with Has events Introduced in endAutomata World No 0.7r
"},{"location":"turtles/metaphysics/end_automata/#how-to-craft","title":"How to craft","text":"To create an end soul, you need to feed 10 endermans via the feedSoul function to a weak automata core. The core needs to be placed inside the turtle into the current active slot(Usually the first one).
The turtle needs 10 endermans in total:
Mob Amount Enderman 10Step by Step:
weakAutomata#feedSoul() for every enderman while the enderman is in front of the turtleExample
core = peripheral.find(\"weak_automata\")\n\nsuccessful, message = core.feedSoul()\nprint(successful)\nprint(message)\npoints() -> table | nil, string\nsavePoint(name: string) -> true | nil, string\nname which can be teleported to at a future point in time. Returns true if the location is successfully saved, or nil and an error message."},{"location":"turtles/metaphysics/end_automata/#distancetopoint","title":"distanceToPoint","text":"distanceToPoint(name: string) -> number | nil, string\ngetWarpCooldown() -> number\nestimateWarpCost(name: string) -> number | nil, string\nname. Or nil and an error message."},{"location":"turtles/metaphysics/end_automata/#warptopoint","title":"warpToPoint","text":"warpToPoint(name: string) -> true | nil, string\nname. Returns true if the turtle is successfully teleported or nil and an error message."},{"location":"turtles/metaphysics/end_automata/#changelogtrivia","title":"Changelog/Trivia","text":"0.7r Added the End Automata
"},{"location":"turtles/metaphysics/husbandry_automata/","title":"Husbandry Automata","text":"Picture
Husbandry automata is a turtle with a Husbandry Mechanic Soul upgrade. This upgrade has all of the abilities of a Weak Automata plus some additional abilites: \u2022 Use items on animals \u2022 Get information about an animal \u2022 Scan for nearby animals \u2022 Capture and release animals
Peripheral Name Interfaces with Has events Introduced in husbandryAutomata World No 0.7r
"},{"location":"turtles/metaphysics/husbandry_automata/#how-to-craft","title":"How to craft","text":"To create a husbandry soul, you need to feed 3 different types of animals via the feedSoul function to a weak automata core. The core needs to be placed inside the turtle into the current active slot(Usually the first one).
The turtle needs 9 animals in total:
Animal Amount Cow 3 Sheep 3 Chicken 3Step by Step:
weakAutomata#feedSoul() for every animal while the animal is in front of the turtleExample
core = peripheral.find(\"weak_automata\")\n\nsuccessful, message = core.feedSoul()\nprint(successful)\nprint(message)\nuseOnAnimal() -> (true | nil), string\ninspectAnimal() -> table | nil, string\nsearchAnimals() -> table | nil, string\ncaptureAnimal() -> true | nil, string\nreleaseAnimal() -> true | nil, string\ngetCapturedAnimal() -> table | nil, string\n0.7r Added the Husbandry Automata
"},{"location":"turtles/metaphysics/overpowered_automata/","title":"Overpowered Automata","text":"Picture
Overpowered automata is a turtle with an Overpowered Mechanic Soul upgrade. This upgrade has all of the abilities of the original automata.
This automata will not use any item durability, however there is a very small chance that with every automata operation that the Mechanic Soul upgrade will just break- Forever. Once the upgrade has broken it can not be used again.
Peripheral Name Interfaces with Has events Introduced in overpoweredWeakAutomataoverpoweredHusbandryAutomataoverpoweredEndAutomata World No 0.7r"},{"location":"turtles/metaphysics/overpowered_automata/#changelogtrivia","title":"Changelog/Trivia","text":"0.7r Added the Overpowered Automata
"},{"location":"turtles/metaphysics/weak_automata/","title":"Weak Automata","text":"Picture
Weak automata is a turtle with a Weak Mechanic Soul upgrade. It has several different abilities: \u2022 Digging blocks with tools \u2022 Interact with blocks with an item or empty hand \u2022 Collect all or specific nearby items \u2022 Detect nearby items \u2022 Detect blocks and entities in front of the turtle \u2022 Charge the turtle with an energy cell in the turtle's inventory
Peripheral Name Interfaces with Has events Introduced in weakAutomata World No 0.7r
"},{"location":"turtles/metaphysics/weak_automata/#functions","title":"Functions","text":""},{"location":"turtles/metaphysics/weak_automata/#getfuellevel","title":"getFuelLevel","text":"getFuelLevel() -> number\ngetFuelMaxLevel() -> number\ngetFuelConsumptionRate() -> number\nsetFuelConsumptionRate(rate: number) -> true | nil, string\nrate of the turtle. See Cooldowns and Fuel consumption to learn about how fuel consumption affects fuel cost and operation cooldowns. Returns true if the consumption rate was successfully set, or nil and an error message.
"},{"location":"turtles/metaphysics/weak_automata/#getdigcooldown","title":"getDigCooldown","text":"getDigCooldown() -> number\ngetSuckCooldown() -> number\ngetUseOnBlockCooldown() -> number\ngetConfiguration() -> table\nlookAtBlock() -> table | nil, string\nlookAtEntity() -> table | nil, string\ndigBlock() -> true | nil, string\nuseOnBlock() -> true | nil, string\nscanItems() -> table | nil, string\ncollectItems([count: number]) -> true | nil, string\ncount is given around the turtle. Returns true if it successfully collects items or nil and an error message."},{"location":"turtles/metaphysics/weak_automata/#collectspecificitem","title":"collectSpecificItem","text":"collectSpecificItem(item: string[, count: number]) -> true | nil, string\ncount is given of the given item type that are around the turtle. Returns true if it successfully collects items or nil and an error message."},{"location":"turtles/metaphysics/weak_automata/#feedsoul","title":"feedSoul","text":"feedSoul() -> (true | nil), string\nchargeTurtle([fuel: number]) -> number | nil, string\nfuel argument limits the amount of fuel it will try to gain. Returns the amount of fuel points gained or nil and an error message."},{"location":"turtles/metaphysics/weak_automata/#changelogtrivia","title":"Changelog/Trivia","text":"0.7r Added the Weak Automata
"}]} \ No newline at end of file diff --git a/sitemap.xml.gz b/sitemap.xml.gz index bfbbb2e..5f764af 100644 Binary files a/sitemap.xml.gz and b/sitemap.xml.gz differ