Improve this page

Functions

attack

attack( <Number: millis> )

Causes the player to rapidly click or hold the attack keybinding (lmb) when millis is…

back

back( Number: millis )

Causes the player hold the back keybinding (s) when millis is…

connect

connect( String: serverIP )

Attempts to connect you to a server.

customizeSkin

customizeSkin( String: Part, Boolean: value )

Turns skin layers on or off for the player.

disconnect

disconnect()

Leaves the server you are connected too.

drop

drop( <Boolean: Drop All> )

Throw your currently held item. (like q) If true is given as an arg then it will drop the whole stack. If no arg is passed

entityRayTrace

entityRayTrace{ … }

everything is optional

Defaults player eye pos, player look direction, player reach amount, and fluids true

Returns

forward

Causes the player hold the forward keybinding (w) when millis is…

getBiome

getBiome( <Number: BlockX, Number: BlockZ> )

Returns a table with details about the biome either at the players location or the given location.

Output:

getBlock

getBlock( Number: x, Number: y, Number: z )

Returns a table with information about a block at the given position. If the block requested is not loaded or is void air then it will return false.

getBlockLight

getBlockLight(<Number: x, Number: y, Number: z>)

Returns the current block light level at a given position. If no position is given it will use the players position.

getBlockList

getBlockList()

A bit of a misnomer, this function returns a table of all blocks and items in the game (including mods). Each entry will be what it would look like if you had an item stack of 1 in an inventory and loged it. The table uses the item id (such as minecraft:birch_stairs) as the key, and the example item as the value.

getBoundingBox

getBoundingBox( Number: blockX, Number: blockY, Number: blockZ )

getBoundingBox( {Number: blockX, Number: blockY, Number: blockZ} )

getBoundingBox( Number: EntityID )

Returns a table with functions relating to a bounding box of a block or entity.
For blocks, a second return value of true or false will be returned indicating if the block is solid.

getChunkUpdateCount

getChunkUpdateCount()

Returns the number of chunk updates as seen in the F3 debug menu.

getEntity

getEntity( Number:ID <,Boolean coerce> )

Returns a table with information about an entity much like getPlayer().
getEntityList() can be used to locate an entity’s ID number.

If coerce is true then a luajava version of the entity is returned instead.

getEntityList

getEntityList()

Returns a list of entities loaded in your chunks.

Each entity will have…

getEntityNBT

getEntityNBT( Number: ID )

Return a table with just the NBT data for an entity.
ID number is from the getEntityList() function.

getFps

getFps()

Returns the current FPS as seen in the F3 debug menu.

getHotbar

getHotbar()

Returns the currently selected hotbar index.
(1-9)

getInventory

getInventory( <String: name> )

Returns a table listing the players inventory contents.
If a name is given it will return the visible part of another players inventory (or false if no player is found).

getJarLibLoaders

….Looks like this returns a table where jars can be added so require can find them..?

getLight

getLight(<Number: x, Number: y, Number: z>)

Returns the current block and sky light level at a given position. If no position is given it will use the players position.

Return values:

light level, sky, block

getLoadedPlayers

getLoadedPlayers()

Returns a list of any players in your loaded chunks.

getPlayer

getPlayer( <String: name> )

Returns a hoard of information in a table about your player (no arg), or the target player (name arg).

getPlayerBlockPos

getPlayerBlockPos( <String: name> )

Returns the block position of either yourself or a player by name.
If a player can not be found the function will return false

The position will always be whole numbers.
If you want the decimal part, use getPlayerPos()

getPlayerList

getPlayerList()

Returns a list of players on the server. This is not limited to loaded chunks like getLoadedPlayers().

getPlayerNBT

getPlayerNBT( <String: PlayerName> )

Returns the NBT data for a player or yourself.

getPlayerPos

getPlayerPos( <String: Player Name >)

Returns the exact players position of your player or the given player. If the player can’t be found then it will return false

local x, y, z = getPlayerPos()

getProfile

getProfile()

Returns the name of the current profile from the bindings menu.

getRecipes

getRecipes( <String: item> )

Returns a list of crafting recipes. If an item is specified, any recipes whos output item id contains item in the string will be added to the list.
For example: stone will add minecraft:stone’s recipe as well as minecraft:cobblestone_stairs because it has the word stone in it.

For

local recipes = getRecipes()

The output is formated as follows: recipes[recipeType][recipeNumber]['in'/'out']
For input items:

• shaped recipes will list items as [x][y][options]
• shapless recipes will list items as [x][options] For output items:
• Will list the output item directly

getScreen

getScreen()

Returns a new image with controls with the pixel data being a screenshot of the game.

getSettings

getSettings()

Returns a table containing any mod settings and controls for Minecraft settings.

Some useful stuff: getSettings().editor.colors.textFill controls the background color in the editor. (Transparent colors are allowed) All of the mod’s colors are defined in the settings and can be changed to whatever you like.

getSettings().chat.maxLines Controls the number of lines the chat can store before it starts removing messages. By default Minecraft has this as 100. Changing this can be useful for looking at large tables in chat. A good number to use would be 1000.

getSettings().scriptBrowser.columns Controls how many columns are in the file browser. (Too many may cause them to overlap) getSettings().profiles This is the table where each binding profile is saved. You can edit them from here if you want to do so. getSettings().minecraft Returns a table with functions for changing Minecraft settings

getSettings().save() Saves all changes you made to settings. Be sure to call this after making changes.

getSkyLight

getSkyLight( <Number:x, Number:y, Number:z> )

Returns the light level provided from the sky at a given position or the players current block pos.

getSound

getSound( String:file ) Returns a table with controls for playing a sound. When a sound stops because it has finished playing or has been stopped with the stop function the resources are released and are not reuseable.

Controls:

getWorld

getWorld()

Returns a table containing information about the current world or false if you are not currently in a world.

border

moonPhase

value		name
0		Full moon
1		Waning gibbous
2		Last quarter
3		Waning crescent
4		New Moon
5		Waxing crescent
6		First quarter
7		Waxing Gibbous

highlightEntity

highlightEntity( Number: entityID, String: action <,Boolean: active> )

Causes an entity to be rendered as glowing or rendered on top of everything else.

httpRequest

**httpRequest{ args… }

Returns

Table

httpQuick

httpQuick( String:url )

Returns

Table

Since

isKeyDown

isKeyDown(String: keyName)

Returns a boolean if a key is held or mouse button is held. The key name will match the name used in the bindings menu.

jump

jump() Makes the player jump

key

key( String:keyName <, Number:duration> )

Holds the key with the matching name down for duration seconds.
Default duration is 0,

When duration <= 0 the key is released

left

left( <Number: duration>)

Holds the left strafe key (a) for the provided duration.
Default duration is 0,

When duration <= 0 the key is released

listTextures

listTextures() returns a list of textures.

Try in REPL

tex = listTextures()
b = hud3D.newBlock()
b.changeTexture("block:"..tex[11])
b.enableDraw()

loader

?

log

log( … ) Writes text to the chat.

Basic usage

log"Hello world!"
log("Hello"," ","world!")
log("You're using AM v",_MOD_VERSION)

Coloring & Formatting

You can add & codes to color/format your text.
Formatting is applied up until the next color change or arg

log("&aHello World") --green
log("&aHello &BWorld") --green then green &bold
log("&BHello &aworld") --bold & white, then green and not bold
log("&aHello"," world") --world is written with wite text

log"This && That"

Click Events

When a click & code is added, the next argument after the string is consumed

log("&a&NHover here&f &b&U&FClickMe","A &atooltip&f!",function(formatted,unformatted) log"You clicked it!" end, " &d&U&FAnother clickable", {hover="Do it!", click=function(formatted,unformatted) log("&a&BIt worked!") end})

look

look( Number:yaw, Number:pitch <, Number:millis> )

Make the player turn their head to some yaw and pitch.

If millis is not provided, head instantly snaps to the angle

If millis is provided, head smoothly turns over that many milliseconds.
(Non blocking)

lookAt

**lookAt( Number:x, Number:y, Number:z <, Number:millis>)

Make the player turn their head to some x,y,z.

If millis is not provided, head instantly snaps to the angle

If millis is provided, head smoothly turns over that many milliseconds.
(Non blocking)

narrate

narrate( String text <, Boolean:stopCurrentSpeach> )

Does text to speach for text
if the narrator is already saying somethign and stopCurrentSpeach is true, the narrator will be interrupted, else queued.
Default: false

newMutex

newMutex( String:name )

Creates a reference to a mutex used for thread saftey.
A mutex created with the same name as another both refer to the same lock.

Behavior

When a mutex is locked, no other threads will be able to lock until the thread that locked it unlocks it (or is cleaned up).

Example

Preventing spam

local function noSpam()
  local mutex = newMutex"theincgi_noSpam" --unique name
  if not mutex.tryLock() then 
    return
  end

  playSound("chimes.wav").play()
  sleep(2000) --cooldown for playing the sound

  mutex.unlock() --important!
end

for i=1,10 do
  noSpam()
  --try it without the mutex if you want to hear the difference
  --playSound("chimes.wav").play()
  waitTick()
end

Preventing race conditon

View here

openInventory

openInventory()

Returns a table containing controls for interacting with inventories

Returned table contains…

Click

.click( Number:slot <,Number:button> ) As if you clicked on a slot using your mouse

Close

.close() Closes the gui without dropping items held by the mouse

CloseAndDrop

.closeAndDrop() Normal behavior of closing the inventory screen, items dropped to ground if held by mouse.

DragClick

.dragClick( Table:slots <,Number:button> ) Distribute items across slots in order

Drop

.drop( Number:slot <,Boolean:stack>) Drop the item in the provided inventory slot.
If stack is true, the whole stack is dropped instead of 1 item.
Default: false

GetHeld()

**.getHeld()** returns `false` or the item held by the mouse.

If coerce is true, a the ItemStack is returned as userdata

GetMap()

.getMap() returns the slot mappings for the current container/inventory.

Typical Usage

local inv = openInventory()
local map = inv.getMap()
inv.click( map.hotbar[3] ) --clicks 3rd slot in hotbar

Possible Sections

GetSlot

**.getSlot( Number:slot <,Boolean:coerce> )

If coerce is true, a the ItemStack is returned as userdata

GetTotalSlots()

.getTotalSlots() returns the total number of slots for the current inventory

GetType()

.getType() returns the name of the current inventory

common ones with mappings are:

GrabAll

.grabAll( Number:slot )

Like when you quickly double click an item to pick up all of the same type

HotSwap

**.hotSwap( Number:slot, Number:hotbarSlot ) Like when you hover an item in your inventory and hit a number key to switch items

Mapping

table This is used by .getMap() and contains all container mappings listed by inventory type .getMap() basically does this:

local map = inv.mapping[ inv.getType() ]

Quick

**.quick( Table:slots, <,Number: limit> ) ** **.quick( Table:slots ) **

For quickly transfering inventory contents into a container #CHECK_ME

SetRecipe

.setRecipe( Number:recipeID <,Boolean:makeAll> )

Emulates clicking on a recipe from the recipe book.
recipeID is from getRecipes

If makeAll is true then it acts like shift clicking the recipe pulling in as many ingredients as it can.

pRun

pRun( String:file ) pcall, but for run

pickBlock

pickBlock() Middle click action

Survival: select hotbar slot with item or move item from inventory to current hotbar slot

Creative: select hotbar slot with item orcopy item to hand

pickItem

**pickItem( String:name <, Number:slot )

Attempts to pick an item from your inventory If it exists it is picked from hotbar or moved to the prefered slot Slot number is returned or false if none found

Source can be found here

playSound

playSound( String:soundName )

Counterintuitively this returns controls for playing a sound.

Sounds are located in ~/sounds (AM Root dir)

If you’re planning to share your code, it’s instead recommended to use getSound.

print

print(…)

Puts text in the console.

rayTrace

**rayTrace(<,vector3d:from> <,Number:reachDistance <,Boolean stopOnLiquid>>)**

vector2d can be either yaw,pitch or {yaw,pitch}

vector3d can be either x,y,z or {x,y,z}

Returns false or a table containing info about the trace result

If hit block:

right

right( <Number: duration>)

Holds the right strafe key (d) for the provided duration.
Default duration is 0,

When duration <= 0 the key is released

run

run( String:file, … )

Runs a script like a function returning any results.

Unlike require this does not save the returned results and instead runs it each time.

File access rules apply. File is local to the directory of the caller.

runThread

runThread( String file, … ) runThread( function:task, … )

Instantly starts the given file or function in a new thread with provided args.

Returns a table with thread controls for checking status and killing the thread if needed.

If you don’t wish to start the thread immediatly you can instead do

local myThread = thread.new( myFunction )
--or
local myThread = thread.new( function(...) run( "myScript.lua", ...)) end )
--then later
myThread.start()

say

say( String:msg ) Causes the player to speak into the chat. This can be used to run commands as well, just don’t forget the /!

setHotbar

setHotbar( Number:slot ) Selects the hotbar slot.

Slot numbers are 1 through 9

setProfile

setProfile( String:profileName ) Changes the active profile in the bindings menu

returns false if the profile could not be found.

sleep

sleep( Number:milliseconds )

Causes the script to pause for the given number of milliseconds.

sneak

**sneak()**

Holds the sneak key (shift) for the provided duration.
Default duration is 0,

When duration <= 0 the key is released

sprint

**sprint()**

Default: true, start sprinting

Causes the player to start or stop sprinting

stopAllScripts

stopAllScripts

Kills all running scripts. Like hitting CTRL+AM Menu Key and clicking each little [x]

swapHand

swapHand()

Switches your main hand’s item with your off hand’s item.

toast

**toast(<, String:detail> )** Creates a popup notification

Default text for both is nil

use

use( <Number: duration> ) use()

Holds the use key (a) for the provided duration.

When duration <= 0 the key is released

If no number is provided then it does an instantaneous click

waitTick

waitTick()

Causes the script to sleep until the next Minecraft tick starts.