Skip to content

Colony Integrator

Picture

Header

The colony integrator can interact with a colony from MineColonies.


Overview

Peripheral Name Interfaces with Events Introduced in
colonyIntegrator MineColonies No 0.7r

Functions

Example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
local integrator = peripheral.find("colonyIntegrator") -- Finds the peripheral if one is connected

if integrator == nil then error("colonyIntegrator not found") end

if not integrator.isInColony then error("Block is not in a colony") end

print("Colony name:".. integrator.getColonyName())
print("Currently under attack?".. integrator.isUnderAttack())
for k, v in ipairs(integrator.getCitizens()) do
  v.name -- Prints the name of every colonist in the colony
end
Function Returns Description
isInColony() boolean Returns true if the block is in a colony.
isWithin(table position) boolean Returns true if the given coordinates are in a colony.
getCitizens() table Returns a table with all citizens of the colony.
getColonyID() int Returns the id of the colony.
getColonyName() string Returns the name of the colony.
getColonyStyle() string Returns the style of the colony.
isActive() boolean Returns true if the colony is active(Trusted players are online).
getHappiness() int Returns the overall happiness of the colony.
getLocation() table Returns the position of the townhall.
isUnderAttack() boolean Returns true if the colony is currently under attack.
amountOfCitizens() int Returns the amount of citizens.
maxOfCitizens() int Returns the possible max amount of citizens.
amountOfGraves() int Returns the amount of graves in the colony.
amountOfConstructionSites int Returns the amount of currently existing construction sites
getVisitors() table Returns a table with all visitors in your tavern of the colony.
getBuildings() table Returns a table with all buildings in your colony.
getWorkOrders() table Returns a table with all work orders.
getResearch() table Returns all possible researches, currently researches that is being worked on and research that has already been researched.
getWorkOrderResources(int id) table Returns a table with the resources of a work order. You can find out every order and its ID with getWorkOrders().
getRequests() table Returns all requests in any kind of the colony.
getBuilderResources(table position) table Returns all resources of the given builder's hut.

Examples

We made a script to show every citizens and their gender on a monitor.

Script: Github Picture

And here we have a script made for a pocket computer to show statistics about a colony

Script: Github Picture

Changelog/Trivia

0.7r Added the colony integrator

Back to top