AI

The facility AI (short for "Artificial Intelligence") is a feature of the Headquarters that unlocks upon reaching Military Tier 4 and finishing the associated software. It is an extremely versatile tool that allows the user to automate almost any task in the game.

Compared to workers, AI scripts are far more versatile, as they can interact with almost every system in the game, and even for systems for which there is no current APIs that the AI could use to interact, it can always perform mouse clicks to simulate such behavior. This is currently limited, as the AI can only click on in-game UI buttons, so things like region artifacts must still be performed manually, additionally the AI cannot perform right or middle mouse clicks. However, AI cannot run while the game is closed (or more accurately during the simulated time when opening a save file) or interact with buildings which are not open. Workers can do both of these things, appear before AI (MT1 rather than MT4) and are far simpler to use without community assistance, so while AI may have more power to automate the game, neither is a replacement for the other.

To use the AI, you must first obtain a script to execute. There are several ways to do this:

• Create an AI script in the headquarters. For more information on learning how to create scripts, see Using the AI.
• Obtain import codes for scripts that other players have written. For a list of available scripts, see the discord forum.
• Use machine learning (a macro system). This is done by pressing F7 while the AI overlay is active.

AI Script Format

An AI script contains three sections that control its behavior:

• Impulses
• Conditions
• Actions

All scripts have a limit of impulses, conditions and actions. Impulses and conditions have a cap of 10, actions a cap of 50.

Impulses

An Impulse can refer to any button press or event that directly activates an AI script. It is not to be confused with the Basic:Execute command which is not considered an impulse, as it is not a way for a player to directly trigger an AI script, but rather a way of calling the script inside of another AI script much like helper methods in high level programming languages. Each impulse can trigger the AI script, regardless if it has already been triggered. It is possible that a script can trigger multiple times before it has finished execution. In this case multiple instances of this script can run in parallel.

Conditions

A Condition is a requirement that has to be fulfilled in order for the script to start executing. If any condition in the script is false then the script will not be executed when an impulse is triggered by a player action. During the execution the specified conditions have no effect. All conditions are of data Type:Bool, and any expression that returns a bool can be used as a condition.

Actions

An Action is something that the AI does when the script becomes active. The Actions are executed one by one, in order from top to bottom. Actions will continue to be executed until either the AI menu is closed, or the script terminates normally. Within one instance of a script, as many actions as the script budget will allow can be executed in one frame. Atomic actions (those with a red symbol) cost 0 budget, all others cost 100. The script is executed in sequence until the budget becomes less than or equal to 0, at which point execution is given to the next script.

AI-Script-Editor (In game)

There is a maximum budget per script. This is determined by the total amount of RAM installed in all servers.

To get a budget of 10,000 requires fully upgrading the RAM of all 16 servers.

AI Script Language

Data Types

There are various data types that are usable within AI scripts, all of which are incredibly versatile and useful in creating a script as complex or simple as one desires.

Type	Description	Example Values	Default Value	Notes
double	A integer that allows decimal precision. Can be positive or negative.	3.2, 0.29, -10.2, 7.9999993	0.0	Doubles have a max value of 2^1024, or approximately 1.79769 × 10308.
int	A number that does not allow decimal precision. Can be positive or negative.	20, 69, 420, -1029, 0	0	Ints range from -2147483648 to 2147483647
string	An array of characters. Basically a way to format and use text.	"meow", "hello", " ", "I am a text", "!BanBudE"	""	The quotes in the examples are not included in the actual string value.
bool	A binary value that can either be true or false.	true, false	false
Vector2	A container type that contains two double values called x and y.	(-30.0, 0.0), (28.38, 13.0)	(0.0, 0.0)

Some data types can be converted to others by using a function. Check the table below to see which data types are currently interchangeable.

Source / Target	double	int	string	bool	Vector2
double	-	Yes	Yes	No	Partially
int	Yes	-	Yes	No	No
string	Yes	Yes	-	No	No
bool	No	No	No	-	No
Vector2	Partially	No	No	No	-

(The table will be updated as soon as more AI features are available.)

Functions

Any line in an AI script (apart from impulses) represents a function.

There are two major types of functions:

• Without a return value (= Actions)
• With a return value

Functions without a return value appear as actions in the sidebar of the AI-script editor. In general these functions do something specific but require some sort of input.

The various inputs to a function are called arguments. Each argument of a function has a specific datatype and accepts either a constant value or a function with a return value of the same type.

APIs (Application Programming Interfaces) (as of v0.49)

Function signatures have been slightly modified to conform with a C-like syntax for similarity with other function signatures. The special return type impulse denotes a function is an input (rather than an action), actions which previously did not have a return type now have the void return type and the colon between type and argument name is removed.

Impulses

Name	Function Signature	Description
Wake Up	impulse wakeup()	Triggers whenever the AI switches from inactive to active.
New Round	impulse game.newround()	Triggers whenever a new Tower Testing round starts.
Open: <Building>	impulse open.<building>()	Triggers whenever the window of the building is being opened (ex: Open: Arcade)
Close: <Building>	impulse close.<building>()	Triggers whenever the window of the building is being closed (ex: Close: Arcade)
Mouse: <Left|Middle|Right> Up	impulse mouse.<id>.up()	Triggers whenever the <left|middle|right> mouse button is being pressed down. (ex: Mouse: Left Up)
Mouse: <Left|Middle|Right> Down	impulse mouse.<id>.down()	Triggers whenever the <left|middle|right> mouse button is being pressed down. (ex: Mouse: Left Down)
Key: <0-9, A-Z>	impulse key.#()	Triggers whenever the 0-9 or A-Z key is being pressed (case-insensitive, not numpad). (ex: Key: 0)

Script Execution Context

Name	Function Signature	Description
Mouse: <Key>	bool mouse.<key>.state()	Returns true if the <key> mouse button is currently being held down.
Screen: Height	int height()	Returns the height of the screen in pixels.
Screen: Width	int width()	Returns the width of the screen in pixels.
UI: Size	double ui.size()	Returns the value of the UI size option from from the options menu as a double ranging from 0.5 (50%) to 1.0 (100%)
Script: Triggering Impulse	string impulse()	Returns the ID of the impulse which triggered this script instance. If the script was triggered by another script then this function will return the name of that script
Basic: Remaining Budget	int budget()	Returns the remaining execution budget of this script during execution.
Time: Frame	int time.frame()	Returns the total number of frames since the start of the game.
Time: Delta	double time.delta()	Returns the total time in seconds between the current frame and the last frame. Pausing or accelerating the game affects this value.
Time: Scale	double time.scale()	Returns the factor at which the game is currently accelerated. (0 if the game is paused, 1 if the game runs at normal speed 2 if the game runs at 2x speed and so on)
Time: Unscaled Delta	double time.unscaled()	Returns the total time in seconds between the current frame and the last frame. This value is neither affected by pausing nor accelerating the game.
Timestamp: Now	double now()	Returns the current local time in ticks representing the time from midnight , January 1st, 0001 until now. (UNIX time)
Timestamp: UTC Now	double utcnow()	Returns the UTC time in ticks representing the time from midnight , January 1st, 0001 until now. (UNIX time)

Execution Primitives

Name	Function Signature	Description
Basic: Goto	void goto(int line)	Jumps to line line. The first line in the script equals 1. Entering an invalid line number will result in the value being clamped between the min. and max. boundaries during execution.
Basic: Goto-If	void goto(int line, bool condition)	Jumps to line line in the current script if condition is True. First line equals 1.
Basic: Click	void click(vector2 pos)	Performs a mouse click at following location: pos.
Basic: Slider	void slider(vector2 pos, double value)	Sets the slider position pos on the screen to value with 0 being the leftmost and 1 being the rightmost end.
Basic: Scrollrect	void scrollbar(vector2 pos, double horizontal, double vertical)	Scrolls within a scrollable container at pos to horizontal (horizontally) and vertical (vertically) with 0 being the left/lower end and 1 being the right/upper end. Use a negative value to ignore an axis.
Basic: Wait	void wait(double value)	A simple wait function that stops the current script for a total of value seconds.
Basic: Wait Until	void waituntil(bool condition)	Stops the current script until condition becomes True.
Basic: Wait While	void waitwhile(bool condition)	Stops the current script as long as condition is True.
Basic: Wait Frame	void waitframe()	Stops execution of this script for this frame and continues in the next one.
Basic: Execute	void execute(string script)	Executes the first script in the list which is named script without requiring an impulse. Conditions of the script called still have to be fulfilled. Executed scripts are put at the end of the script list, and because of this they (usually) will run their first action in the same frame, since the script list pointer is still on the calling script, earlier in the script list.
Basic: Execute (Sync)	void executesync(string script)	Executes the first script in the list which is named script and waits until the execution is completed. Conditions of the script still have to be fulfilled.
Basic: Stop	void stop(string script)	Stops the execution of all scripts and script instances which are named script. Important bug/feature: If a script stops itself, the script list pointer is reset to the beginning, effectively giving everything before this script an "extra" cycle. Because scripts that have reached the end aren't cleaned up until the end-of-frame processing, this means that scripts on their last line (or that have jumped to 99) will re-execute their last line, which can cause bugs. This behavior is known as "Turbo Exec," since it can be used to build programs that execute much faster than the typical one-action-per-frame.
Local: Get <T>	T local.T.get(string var)	Returns the value of the the local variable var.
Local: Set <T>	void local.T.set(string var, T value)	Creates or changes the the local variable var to contain the value value.
Local: Unset	void local.unset(string var)	Deletes the local variable with the name var.
Global: Get <T>	T global.T.get(string var)	Returns the value of the the global variable var.
Global: Set <T>	void global.T.set(string var, T value)	Creates or changes the the global variable var to contain the value value.
Global: Unset	void global.unset(string var)	Deletes the global variable with the name var.
Ternary: <T>	T if(bool condition, T value1, T value2)	If condition is true then value1 will be returned. Otherwise returns value2. Note: boolean values do not have this option.
Comparison: <T>	bool comparison.T(T value1, operator, T value2)	Compares two <T> values based on the selected operator.

Boolean Primitives

Name	Function Signature	Description
Bool: Not	bool not(bool)	Returns the inverse of the given boolean value. If bool is true it will return false and if it's false it will return true.

Numerical Primitives

Name	Function Signature	Description
Arithmetic		Performs an arithmetic operation on two [int/double] values. Accepted operators are: "+", "-", "*", "/", "pow", "mod", ["log" for doubles].
Max: [Int/Double]	number max(number1, number2)	Evaluates number1 and number2 and returns the bigger of the two as a result of this function. Note: you cannot compare an int with a double, you have to convert one of them into the other.
Min: [Int/Double]	number min(number1, number2)	Evaluates number1 and number2 and returns the smaller of the two as a result of this function.
Random: [Int/Double]	number rnd(lower, upper)	Returns a random number between lower (inclusive) and upper (inclusive). If the second smaller is lower than the first then the first value will always be returned.

Integer Primitives

Name	Function Signature	Description

Double Primitives

Name	Function Signature	Description
Constant: E	double const.e()	Returns the constant E: 2.7182818284590452.
Constant: PI	double const.pi()	Returns the constant PI: 3.1415926535897931.
Math: acos	double acos(double value)	Returns the inverse cosine (in radians) of the number value.
Math: asin	double asin(double value)	Returns the inverse sine (in radians) of the number value.
Math: atan	double atan(double value)	Returns the inverse tangent (in radians) of the number value.
Math: atan2	double atan2(vector coords)	Returns the angle in the plane (in radians) between the positive X-axis and the ray from (0, 0) to the point coords.
Math: ceiling	double ceil(double value)	Rounds the given number up to the closest integer.
Math: cos	double cos(double value)	Returns the cosine of the number value.
Math: floor	double floor(double value)	Rounds the given number down to the closest integers.
Math: round	double round(double value)	Rounds the given number to the closest integer.
Math: sin	double sin(double value)	Returns the sine of the number value.
Math: tan	double tan(double value)	Returns the tangent of the number value.

String Primitives

Name	Function Signature	Description
Concat	string concat(string lhs, string rhs) lhs . rhs	Chains the two given strings (lhs and rhs) together.
String: Contains	bool contains(string str, string substr)	Returns true if the string str contains the string substr. (ex: "Catch" Contains "Cat")
String: Index Of	int index(string str, string substr, int start)	Returns the index of the first occurrence of string substr within the string str. Search starts at index start whereas 0 represents the beginning of the string.
String: Length	int len(string str)	Returns the amount of characters in the string str.
String: To Lower	string lower(string str)	Turns the entire string str to lowercase.
String: To Upper	string upper(string str)	Turns the entire string str to uppercase.
Substring	string sub(string str, int start, int chars)	Returns a part of the string str, starting at position start (0 = first character) and then going a total of chars steps to the right. So Substring("Cubical", 1, 3) would return "ubi".

Vector Primitives

Name	Function Signature	Description
Vector2: X	double x(vector vec)	Returns the value of X of vec.
Vector2: Y	double y(vector vec)	Returns the value of Y of vec.
Vector2: From Coordinates	vector vec(double x, double y)	Generates a new vector out of two doubles where X is x and Y is y.
Mouse: Position	vector position()	Returns the current position of the cursor.

Conversions

Name	Function Signature	Description
Convert: Int	double i2d(int value) string i2s(int value)	Converts the integer value to a [double/string].
Convert: Double	int d2i(double value) string d2s(double value)	Converts the double value to [an integer/a string]. Note: converting a double into an integer rounds it to the nearest integer instead of rounding towards 0.
Convert: String	int s2i(string value, int fallback) double s2d(string value, double fallback)	Tries to convert value into [an integer/a double] value. If unsuccessful it will return fallback instead.

Town APIs

Name	Function Signature	Description
Town: Any Window Open	bool anyopen()	Returns true if any window in town is open. Includes all building, customization, skills and utility windows.
Town: Window Open	bool isopen(string: window)	Returns true if the Buildings window is active and visible on the screen. (ex: Tower Testing is open)
Town: Open Window	void show(string building, bool open)	Opens the building window if openis True, otherwise it will be closed. Opening or closing windows this way does not play the transition animation!
Game: Is Boss Fight	bool isBossFight()	Returns true of a boss fight is currently active. Returns false otherwise.
Game: Is Tower Testing	bool isTowerTesting()	Returns true if the game is currently in the tower testing screen. Pausing the game or the destruction of the tower does not affect the return value of this function.
Game: Resource	double resource(string currency)	Returns the amount of currency. If no resource with the specified id exists it will return 0.

Tower Testing APIs

Name	Function Signature	Description
Game: Is Paused	bool pause.get()	Returns true if the game is currently paused during tower testing via the pause button. Outside tower testing this will always return false.
Game: Set Pause	void pause.set(bool state)	Sets the pause state to state.
Game: Pause	void pause()	Pauses tower testing via the pause button if possible.
Game: Unpause	void unpause()	Unpauses tower testing via the pause button if possible.
Software: Is Enabled	bool software.enabled(string software)	Returns true if the software with id software has been enabled. Returns false is the software has not been toggled on or has not been researched yet.
Software: Find ID	string software.find(string software)	Returns the correct software ID of the software with the closest match to software (case-insensitive). This function is very slow. Avoid using it in performance critical sections.
Software: Toggle	void software.toggle(string software, bool enabled)	Enables software software if the condition bool condition is true or disables it if the condition is false.
Game: Number of Enemies	int enemies()	Returns the numbers of enemy units which are currently present on the map. Returns 0 if tower testing is not active.
Game: XP	double xp()	Returns the current amount of tower testing experience. Returns 0 if called outside of tower testing.
Game: Wave Acceleration	double waveAcceleration()	Returns the current wave acceleration factor. (You can check the current value inside the stats menu during tower testing).
Game: Fixed Waves Per Interval	double fixedWavesPerInterval()	Returns the current amount of fixed waves per interval as seen in the stats menu during tower testing. Returns 0 if currently not tower testing.
Game: Wave	double wave()	Returns the current wave during tower testing or 0 if tower testing is not active.
Highscore: Wave	double highscore.wave(string region, string difficulty	Returns the wave record of region region on difficulty difficulty.
Game: Era	double era()	Returns the current era during tower testing or 0 if tower testing is not active. Equivalent to wave() / 1e11.
Highscore: Era	double highscore.era(string region, string difficulty	Returns the era record of region region on difficulty difficulty. Equivalent to wave() / 1e11.
Era: Disable Cost	double disable.cost(string element)	Returns the XP cost of the upgrade that disables the era powers of element enemies. Returns -1 outside of tower testing or if the upgrade is not available in the current region.
Era: Disable Power	void disable.era(string element)	Tries to disable the era powers of element enemies by purchasing the according upgrade using xp.
Era: Upgrade Divider	void upgrade.era(string divider, int times)	Attempts to upgrade the era str (damage, health) divider a total of int x times by using xp.
Game: Infinity	double infinity()	Returns the current infinity during tower testing or 0 if tower testing is not active. Equivalent to wave() / 1e22 and era() / 1e11.
Highscore: Infinity	double highscore.infity(string region, string difficulty	Returns the infinity record of region region on difficulty difficulty. Equivalent to wave() / 1e22 and era() / 1e11.
Infinity: Secure Module Cost	double disable.inf.cost()	Returns the amount of XP required in order to secure/disable a module during infinity phase.
Infinity: Secure Module	void disable.inf(string moduleId)	Attempts to secure the module with id str id to prevent enemies from mimicking it during the infinity phase.
Game: Active Module Count	int active.count()	Returns the total number of active modules in the currently active blueprint of the tower. Returns 0 outside of tower testing.
Game: Active Module Index	int active.index(string moduleId)	Returns the index of the active module with ID moduleId inside the active skills list. If the module is not inside the list or tower testing is not active then this function will return 0.
Game: Active Module ID	string active.id(int index)	Returns the ID of the active module in slot index in the active modules list whereas 1 refers to the first module in the list. Returns an empty string if the slot index is invalid or tower testing is not active.
Tower: Is Stunned	bool stunned()	Returns true if the tower is stunned and false if the tower is either not stunned or does not exist.
Tower: Negative Buffs	int negative()	Returns the total number of nagative buffs currently present on the tower or 0 if the tower has no negative buffs or does not exist.
Tower: Health	double health(bool percent)	Returns the current health of the tower or 0 if the tower is dead does not exist. Returns the value as a percentage of max health value if percent is true otherwise the absolute value.
Tower: Max. Health	double health.max()	Returns the maximum hitpoints of the tower or 0 if the tower is either dead or does not exist.
Tower: Health Regeneration	double health.regen()	Returns the current health regeneration of the tower or 0 if the tower does not exist.
Tower: Energy	double energy(bool percent)	Returns the current energy of the tower or 0 if the tower does not exist. Returns the value as a percentage of max energy value if percent is true otherwise the absolute value.
Tower: Max. Energy	double energy.max()	Returns the maximum energy of the tower or 0 if the tower is either dead or does not exist.
Tower: Energy Regeneration	double energy.regen()	Returns the current energy regeneration of the tower or 0 if the tower does not exist.
Tower: Shield	double shield(bool percent)	Returns the current shieldpoints of the tower or 0 if the tower is dead or does not exist. Returns the value as a percentage of max shieldpoints value if percent is true otherwise the absolute value.
Tower: Max. Shield	double shield.max()	Returns the maximum shieldpoints of the tower or 0 if the tower is either dead or does not exist.
Tower: Module Cooldown	double cooldown(int skill)	Returns the remaining cooldown of the active module at slot skill in seconds Slot 1 refers to the first module in the active modules list.
Tower: Attack Range	double tower.range()	Returns the tower's current attack range. (Default attack range without any modules or buffs is 18).
Tower: Use (Instantly)	void useinstant(int skill)	Orders the Tower to use the Modules at slot skill where slot 1 refers to the module at the very top of the skill menu. Entering an invalid slot will do nothing.
Tower: Use (Position)	void useposition(int skill, vector2 pos	Orders the tower to use the module at slot skill where slot 1 refers to the module at the very top of the skill menu at an offset of pos
Tower: Restart	void restart()	Restarts the current Tower Testing run. Can only be can only be executing during or at the end of a run that took equal or longer than a second.
Tower: Exit	void exit()	Exits the current Tower Testing run.

Power Plant APIs

Name	Function Signature	Description
Powerplant: Sell	void sell(int x, int y)	Sells the Power Plant component at X: x and Y: y and automatically refunds a part of the selling price. If the selected slot is empty then nothing will happen. (0, 0) is the bottom left corner of the grid.

Mine APIs

Name	Function Signature	Description
Mine: Dig	void dig(int x, int y)	Digs up the tile at X: x and Y: y of the currently selected resource in the Mine with (0, 0) being the top left corner. Only works if the Mine window is active!
Mine: New Layer	void newlayer()	Generates a new layer of the currently selected resource in the Mine. Only works if the Mine window is active!
Mine: Open Tab	void tab(int pos)	Opens the mining tab at position pos. Position 1 is the first tab (Orange) and position 12 is the last tab (Black).
Mine: Delete Cluster	void remove(int pos)	Removes the asteroid cluster at list position pos where 1 represents the first cluster in the list.
Mine: Has Layers	bool hasLayers()	Returns true if the current active mining tab can generate at least 1 layer.
Mine: Clusters	int clusters()	Returns the total amount of asteroid clusters currently in the list or 0 if the second floor of Mine has not been unlocked yet.

Factory APIs

Name	Function Signature	Description
Factory: Try Craft	void craft(string item, int tier, double amount)	Tries to craft item (Tier tier) a total of amount times by using items inside the inventory or crafting grid. If that is not possible then no items are being crafted. Only works if the Factory screen is visible.
Factory: Try Produce	void produce(string item, int tier, double amount, string machine)	Tries to put amount x item (Ttier) into machine machine. If too few items are available or the selected machine is currently busy with a different item type then nothing will happen. Ignores the tier if the selected item ID is rubber.
Factory: Trash	void trash(string item, int tier, double amount)	Tries to put amount x item (Ttier) into the trash can of the Factory. If too few items are present in the inventory and the crafting grid of the Factory then it will still try to remove as many as possible. Ignores the tier for items that don't have a tier.
Factory: Cancel Machine	void cancel(string machine)	Stops production of the Factory machine with the ID machine and ejects all items back to the inventory if possible.
Factory: Is Processing	bool active(string machine)	Returns true if the machine with the ID machine is currently processing items.
Factory: Item Count	double count(string item, int tier)	Returns the total amount of item (Ttier) inside the inventory of the Factory.
Factory: Machine Input Count	double machine.item.count(string machine)	Returns the number of items currently inside the machine with the ID machine.
Factory: Machine Input	string machine.item(string machine)	Returns the ID of the item currently inside the Factory machine with the ID machine.
Factory: Find ID	string factory.find(string name)	Returns the correct item ID of the item with the closest match to name (ignores case-sensitivity). This function is very slow. Avoid using it in performance-critical sections.

Arcade APIs

Name	Function Signature	Description
Arcade: Spin Lucky Wheel	void wheel.spin(double wager)	Spins the Lucky Wheel with a wager of wager.
Arcade: Lucky Wheel Is Spinning	bool wheel.isSpinning()	Returns true if the Lucky Wheel in the Arcade is currently spinning.
Arcade: Jumble New Game	void jumble.new(double wager)	Starts a new game of Jumble with a wager of wager.
Arcade: Jumble Stop	void jumble.stop()	Stops the current column.
Arcade: Jumble Is Active	bool jumble.isActive()	Returns true if there is an active game of Jumble in the Arcade.
Adventure: Move	void adventure.move(vector direction)	Moves the player in the direction of direction in Adventure.
Adventure: Wait	void adventure.wait()	Skips a turn in Adventure.
Adventure: Place Bomb	void adventure.placeBomb()	Places a Bomb at the Player location in Adventure.
Adventure: Buy Market Item	void adventure.buyMarketItem(string item)	Tries to buy item from the Market.
Adventure: Cast Spell	void adventure.useSpell(string spell)	Cast the spell spell.
Adventure: Teleport	void adventure.teleport(vector room)	Teleport to room room. Note: (0, 0) is bottom left, (127, 127) is the center and (255, 255) is top right.
Adventure: Room Coordinates	vector adventure.roomCoords()	Returns the coordinates of the current room in Adventure.
Adventure: Player Position	vector adventure.playerPos()	Returns the player's current position in Adventure. Relative to the current room. (0, 0) is the bottom left corner, (18, 18) is the top right corner.
Adventure: Hearts	int adventure.playerHealth()	Returns the player's current Health in Adventure.
Adventure: Armor	int adventure.playerArmor()	Returns the player's current Armor in Adventure.
Adventure: Swords	int adventure.playerAttack()	Returns the player's current Swords in Adventure.
Adventure: Bombs	int adventure.bombs()	Returns the current amount of Bombs in Adventure.
Adventure: Count Entities	int adventure.countEntities(string type)	Returns the amount of type on the current map.
Adventure: Emeralds	int adventure.emeralds()	Returns the current amount of Emeralds in Adventure.
Adventure: Golden Hearts	int adventure.goldenHearts()	Returns the current amount of Golden Hearts in Adventure.
Adventure: Keys	int adventure.keys()	Returns the current Key amount in Adventure.
Adventure: Mana	int adventure.mana()	Returns the current amount of Mana in Adventure.
Adventure: Mana Armor	int adventure.manaArmor()	Returns the current amount of Mana Armor in Adventure.
Adventure: Has Phoenix Feather	bool hasPhoenixFeather()	Returns true if Phoenix Feather is available.
Adventure: Has Item	bool adventure.hasItem(string item)	Returns true if item item is unlocked.
Adventure: Is Wall	bool adventure.isWall(vector position)	Returns true if tile in position is Wall.
Adventure: Is Bomb	bool adventure.isBomb(vector position)	Returns true if tile is Bomb.
Adventure: Is Enemy	bool adventure.isEnemy(vector position)	Returns true if tile has an Enemy.
Adventure: Is Room Completed	bool adventure.isCompleted(vector position)	Returns true if the room at position is completed. (Only works if the Map and the Compass are unlocked.)
Adventure: Get Entity Type	string adventure.entityType(vector position)	Returns rock, door, chest or an empty string for position position. Can also return elite and mimic.

Trading Post APIs

Name	Function Signature	Description
Tradingpost: Refresh	void refresh()	Generates a new set of offers in the Trading Post. Requires a specific upgrade for the Trading Post later in the game in order to be used!
Tradingpost: Trade	void trade(int position, double percent)	Trades the offer at position position in the list of offers (first offer is at position 0) using percent (0.15 = 15%) of the available input resources.
Tradingpost: Offer Count	int offerCount()	Returns the total amount of available offers in Trading Post.

Museum APIs

Name	Function Signature	Description
Museum: Buy	void museum.buyTier(string element, int tier, int amount)	Buys a element Power Stone of tier tier from the shop or market amount times.
Museum: Buy Range	void museum.buyRange(string element, int tierMin, int tierMax, int amount)	Buys a element Power Stone between tier tierMin and tierMax from the shop or market amount times.
Museum: Combine	void combine(int tierMax)	Combine Power Stones with the usual combine rules up to Tier tierMax (<1 means no limit).
Museum: Transmute	void transmute()	Transmute Power Stones currently inside the Cubos Cube.
Museum: Move	void move(string from, int slot, string to)	Move a Power Stone from from in slot slot to to.
Museum: Move Slot	void museum.moveTo(string from, int fromSlot, string to, int toSlot)	Move a Power Stone from from slot fromSlot to to slot toSlot.
Museum: Swap	void museum.swap(string invA, int slotA, string invB, int slotB)	Swap the Power Stones in invA slot slotA and invB slot slotB.
Museum: Sell	void delete(string inventory, int slot)	Sell the Power Stone from inventory in slot slot.
Museum: Sell All	void clear(string inventory)	Sell all Power Stones from inventory.
Museum: Set Preferred Tier	void museum.setPreferredTier(int tier)	Sets the preferred market tier to tier.
Museum: Set Preference	void museum.setPreference(string element, bool state)	Set the market preference for element element to state.
Museum: Market Refresh	void museum.refresh()	Refreshes Market Offers Requires an upgrade later in the game.
Museum: Buy Market	void museum.buyOffer(int slot, int amount)	Buy the Power Stone from market in slot slot amount times.
Museum: Lock Market Slot	void museum.setSlotLocked(int slot, bool state)	Set the lock state of Market slot slot to state.
Museum: Rebuy	void museum.rebuy(int slot)	Rebuy the Power Stone from Trash slot slot.
Museum: Preference	bool museum.preference(string element)	Returns the current market preference for element element.
Museum: Market Lock	bool museum.isSlotLocked(int slot)	Returns the lock state of market slot slot.
Museum: Free Slots	int freeSlots(string inventory)	Returns the free slots of inventory.
Museum: Power Stone Tier	int tier(string inventory, int slot)	Returns the tier of Power Stone in inventory slot slot.
Museum: Preferred Tier	int museum.preferredTier()	Returns the currently set preferred market tier.
Museum: Max Tier	int museum.maxTier(string element)	Returns the max tier of element element.
Museum: Market Tier	int museum.slotTier(int slot)	Get tier of market slot slot.
Museum: Trash Tier	int museum.trashTier(int slot)	Get tier of trash slot slot.
Museum: Market Timer	double museum.timer()	Returns the current market time until the next refresh.
Museum: Power Stone Element	string element(string inventory, int slot)	Return the Power Stone element of inventory slot slot.
Museum: Market Element	string museum.slotElement(int slot)	Get element of market slot slot.
Museum: Trash Element	string museum.trashElement(int slot)	Get element of trash slot slot.

Worker APIs

Name	Function Signature	Description
Worker: Is Paused	bool worker.paused(string name)	Returns true if the first Worker with the name name is paused. Also returns true if not Worker with the given name exists.
Worker: Group	int worker.group(int index)	Returns the group of the Worker at index index (0 is the first Worker in the list). White = 0, red = 1, blue = 2, green = 3, yellow = 4, magenta = 5.
Worker: Name	string worker.name(int index)	Returns the name of the Worker at index index (0 is the first Worker in the list).
Worker: Task ID	string worker.task(string name)	Returns the ID of the current task of the first Worker with the name name. Returns an empty string if no Worker with the given name exists or if there has been no task assigned.
Workers: Toggle Group	void worker.toggleGroup(int group)	Toggles the paused state of all workers in group int group. (Click on the parameter to see which color belongs to which group id.) Colors: White (0), Red (1), Blue (2), Green(3), Yellow (4), Magenta (5)
Workers: Pause Group	void worker.pauseGroup(int group, bool paused)	Sets the paused state of all workers in group int group to bool value. (Click on the parameter to see which color belongs to which group id.)
Workers: Toggle	void worker.toggleName(string name)	Toggles the paused state of all workers with name str name.
Workers: Pause	void worker.pauseName(string name, bool paused)	Sets the paused state of all workers with the name str name to bool value.
Workers: Assign Group	void worker.assignGroup(string task, int subtask, int group)	Assigns the task with id str id and optional parameter int param (0 is the leftmost) to all workers in group int group. (Click on the groups parameter to see which color belongs to which group.)
Workers: Assign	void worker.assignName(string task, int subtask, string name)	Assigns Task with ID str id and optional parameter int param (0 is the leftmost) to all workers with the name str name. TaskIDs
Workers: Set Name	void worker.setName(int index, string name)	Sets the name of the worker at index int index to str name.
Worker: Set Group	void worker.setGroup(int index, int group)	Sets the group of the worker at index int index (0 is the first worker) to the group with id int id.

User Interface APIs (requires boots.d0s)

Name	Function Signature	Description
Canvas: Draw Rect	void canvas.rect(vector2 pos, vector2 size, string colour	Draws a rectangle on the drawable canvas at location pos with a size of size and colored in colour. (Accepts #RRGGBB and #RRGGBBAA as inputs for color.)
Canvas: Clear	void canvas.clear()	Clears the drawable canvas instantly.
Window: Create	void create(string windowId, string windowType)	Creates a window with the unique identifier windowId (used to address the new instance) of type windowType (window name inside windows list).
Window: Set Text	void text.set(string windowId, string textElementId, string value)	Sets the content inside the window with the id windowId of the text label with the id textElementId to value.
Window: Set Sprite	void sprite.set(string windowId, string elementId, string spriteId)	Sets the sprite inside the window with the id windowId of the button/image with the id elementId to spriteId.
Window: Is Visible	bool visibility.get(string windowID)	Returns true if the window with ID windowID is visible.
Window: Set Visibility	void visibility.set(string windowID, bool visible)	Set the window with id windowID to visible if visible is true. Otherwise it will be hidden.
Window: Is Child Visible	bool child.visibility.get(string windowID, string childElementID)	Returns true if the child of window windowID with ID childElementID is visible.
Window: Set Child Visibility	void child.visibility.set(string windowID, string childElementID, bool visible)	Set child of window with id windowID with id childElementID to visible if visible is true. Otherwise window will be hidden.
Window: Set Position	void position.set(string windowId, vector2 position)	Changes the position of the window with id windowId to position based on the anchor of its root element. Per default the anchor is set to the center of the window and 0,0 represents the center of the screen.
Window: Destroy	void destroy(string windowId)	Destroys the window with the unique identifier windowId.
Window: Destroy All	void destroy.all()	Destroys all active windows.