Show not everything
Made by applejuice

log
Example by applejuice:
log(60, "abc")
docs.globals.log
overload 1:
log(...)
Method Property Fluent Description Representation
... accepts anything
Return Value nil

logJson
docs.globals.logjson
overload 1:
logJson(json)
Method Property Fluent Description Representation
json accepts a String
Return Value nil

logTable
Example by ChloeSpacedOut:
local table = {'string',{'tableception'}}

logTable(table,2)
docs.globals.logtable
overload 1:
logTable(table)
Method Property Fluent Description Representation
table accepts a table
Return Value nil
overload 2:
logTable(javaObject)
Method Property Fluent Description Representation
javaObject accepts an Userdata
Return Value nil
overload 3:
logTable(table, maxDepth)
Method Property Fluent Description Representation
table accepts a table
maxDepth accepts an Integer
Return Value nil
overload 4:
logTable(javaObject, maxDepth)
Method Property Fluent Description Representation
javaObject accepts an Userdata
maxDepth accepts an Integer
Return Value nil

print
Example by ChloeSpacedOut:
print(60, "abc")
docs.globals.print
overload 1:
print(...)
Method Property Fluent Description Representation
... accepts anything
Return Value nil

printJson
docs.globals.printjson
overload 1:
printJson(json)
Method Property Fluent Description Representation
json accepts a String
Return Value nil

printTable
Example by ChloeSpacedOut:
local table = {'string',{'tableception'}}

printTable(table,2)
docs.globals.printtable
overload 1:
printTable(table)
Method Property Fluent Description Representation
table accepts a table
Return Value nil
overload 2:
printTable(javaObject)
Method Property Fluent Description Representation
javaObject accepts an Userdata
Return Value nil
overload 3:
printTable(table, maxDepth)
Method Property Fluent Description Representation
table accepts a table
maxDepth accepts an Integer
Return Value nil
overload 4:
printTable(javaObject, maxDepth)
Method Property Fluent Description Representation
javaObject accepts an Userdata
maxDepth accepts an Integer
Return Value nil

require
Example by ChloeSpacedOut:
local library = require("lib.parser")
-- this will import a file
docs.globals.require
overload 1:
require(scriptName)
Method Property Fluent Description Representation
scriptName accepts a String
Return Value anything

action_wheel
docs.globals.action_wheel
field signature:
action_wheel
Method Property Fluent Description Representation
Field Type an ActionWheelAPI

ActionWheelAPI.execute
Example by ChloeSpacedOut:
examplePage = action_wheel:createPage()
action_wheel:setPage(examplePage)
examplePage:newAction(1):onRightClick(function() log('chat spam :3') end)

events.TICK:register(function()
action_wheel:execute(1,true)
end)
-- this will only run if the action wheel is open
docs.actionwheelapi.execute
overload 1:
action_wheel:execute()
Method Property Fluent Description Representation
Return Value nil
overload 2:
action_wheel:execute(index)
Method Property Fluent Description Representation
index accepts an Integer
Return Value nil
overload 3:
action_wheel:execute(index, rightClick)
Method Property Fluent Description Representation
index accepts an Integer
rightClick accepts a Boolean
Return Value nil

ActionWheelAPI.isEnabled
Example by ChloeSpacedOut:
examplePage = action_wheel:createPage()
action_wheel:setPage(examplePage)

events.TICK:register(function()
if action_wheel:isEnabled() then
log("action wheel's is open!")
end
end)
docs.actionwheelapi.isenabled
overload 1:
action_wheel:isEnabled()
Method Property Fluent Description Representation
Return Value a Boolean

ActionWheelAPI.setPage
Example by ChloeSpacedOut:
examplePage = action_wheel:createPage()
action_wheel:setPage(examplePage)
docs.actionwheelapi.setpage
overload 1:
action_wheel:setPage(pageTitle)
Method Property Fluent Description Representation
pageTitle accepts a String
Return Value nil
overload 2:
action_wheel:setPage(page)
Method Property Fluent Description Representation
page accepts a Page
Return Value nil

ActionWheelAPI.getPage
docs.actionwheelapi.getpage
overload 1:
action_wheel:getPage(pageTitle)
Method Property Fluent Description Representation
pageTitle accepts a String
Return Value either a Page or nil

ActionWheelAPI.createPage
docs.actionwheelapi.createpage
overload 1:
action_wheel:createPage()
Method Property Fluent Description Representation
Return Value a Page
overload 2:
action_wheel:createPage(title)
Method Property Fluent Description Representation
title accepts a String
Return Value a Page

ActionWheelAPI.getSelected
Example by ChloeSpacedOut:
examplePage = action_wheel:createPage()
action_wheel:setPage(examplePage)
for slot = 1,8 do
examplePage:newAction(slot)
end

events.TICK:register(function()
log(action_wheel:getSelected())
end)
-- returns even if the action wheel is closed
docs.actionwheelapi.getselected
overload 1:
action_wheel:getSelected()
Method Property Fluent Description Representation
Return Value an Integer

ActionWheelAPI.leftClick
Example by ChloeSpacedOut:
examplePage = action_wheel:createPage('pageName')
action_wheel:setPage(examplePage)

function action_wheel.leftClick()
log('you just left clicked while in the action wheel!')
end
docs.actionwheelapi.leftclick
field signature:
leftClick
Method Property Fluent Description Representation
Field Type a function that takes nothing and will return anything
() -> AnyType

ActionWheelAPI.rightClick
Example by ChloeSpacedOut:
examplePage = action_wheel:createPage('pageName')
action_wheel:setPage(examplePage)

function action_wheel.rightClick()
log('you just left clicked while in the action wheel!')
end
docs.actionwheelapi.rightclick
field signature:
rightClick
Method Property Fluent Description Representation
Field Type a function that takes nothing and will return anything
() -> AnyType

ActionWheelAPI.scroll
Example by ChloeSpacedOut:
examplePage = action_wheel:createPage('pageName')
action_wheel:setPage(examplePage)

function action_wheel.scroll(direction)
log(direction)
end
docs.actionwheelapi.scroll
field signature:
scroll
Method Property Fluent Description Representation
Field Type a function that takes a Number and will return anything

animation
docs.globals.animation
field signature:
animation
Method Property Fluent Description Representation
Field Type a table

client
docs.globals.client
field signature:
client
Method Property Fluent Description Representation
Field Type a ClientAPI

ClientAPI.getVersion
Example by ChloeSpacedOut:
log(client.getVersion())
docs.clientapi.getversion
overload 1:
client.getVersion()
Method Property Fluent Description Representation
Return Value a String

ClientAPI.getParticleCount
Example by ChloeSpacedOut:
events.TICK:register(function()
log(client.getParticleCount())
end)
docs.clientapi.getparticlecount
overload 1:
client.getParticleCount()
Method Property Fluent Description Representation
Return Value a String

ClientAPI.getJavaVersion
Example by ChloeSpacedOut:
log(client.getJavaVersion())
docs.clientapi.getjavaversion
overload 1:
client.getJavaVersion()
Method Property Fluent Description Representation
Return Value a String

ClientAPI.getAllocatedMemory
docs.clientapi.getallocatedmemory
overload 1:
client.getAllocatedMemory()
Method Property Fluent Description Representation
Return Value an Integer

ClientAPI.getVersionType
Example by ChloeSpacedOut:
log(client.getVersionType())
docs.clientapi.getversiontype
overload 1:
client.getVersionType()
Method Property Fluent Description Representation
Return Value a String

ClientAPI.getCurrentEffect
Example by ChloeSpacedOut:
events.TICK:register(function()
log(client.getCurrentEffect())
end)
docs.clientapi.getcurrenteffect
overload 1:
client.getCurrentEffect()
Method Property Fluent Description Representation
Return Value either a String or nil

ClientAPI.getUsedMemory
Example by ChloeSpacedOut:
events.TICK:register(function()
log(client.getUsedMemory())
end)
-- returns memory in bytes
docs.clientapi.getusedmemory
overload 1:
client.getUsedMemory()
Method Property Fluent Description Representation
Return Value an Integer

ClientAPI.isPaused
Example by ChloeSpacedOut:
events.TICK:register(function()
log(client.isPaused())
end)
docs.clientapi.ispaused
overload 1:
client.isPaused()
Method Property Fluent Description Representation
Return Value a Boolean

ClientAPI.getMaxMemory
Example by ChloeSpacedOut:
log(client.getMaxMemory())
-- returns memory in bytes
docs.clientapi.getmaxmemory
overload 1:
client.getMaxMemory()
Method Property Fluent Description Representation
Return Value an Integer

ClientAPI.getServerBrand
Example by ChloeSpacedOut:
log(client.getServerBrand())
docs.clientapi.getserverbrand
overload 1:
client.getServerBrand()
Method Property Fluent Description Representation
Return Value a String

ClientAPI.getEntityCount
Example by ChloeSpacedOut:
events.TICK:register(function()
log(client.getEntityCount())
end)
docs.clientapi.getentitycount
overload 1:
client.getEntityCount()
Method Property Fluent Description Representation
Return Value an Integer

ClientAPI.getSoundStatistics
docs.clientapi.getsoundstatistics
overload 1:
client.getSoundStatistics()
Method Property Fluent Description Representation
Return Value a String

ClientAPI.getChunkStatistics
docs.clientapi.getchunkstatistics
overload 1:
client.getChunkStatistics()
Method Property Fluent Description Representation
Return Value a String

ClientAPI.getFPS
Example by ChloeSpacedOut:
events.TICK:register(function()
log(client.getFPS())
end)
docs.clientapi.getfps
overload 1:
client.getFPS()
Method Property Fluent Description Representation
Return Value an Integer

ClientAPI.getFPSString
Example by ChloeSpacedOut:
events.TICK:register(function()
log(client.getFPSString())
end)
docs.clientapi.getfpsstring
overload 1:
client.getFPSString()
Method Property Fluent Description Representation
Return Value a String

ClientAPI.getTextHeight
Example by ChloeSpacedOut:
log(client.getTextHeight('TEXT!'))
docs.clientapi.gettextheight
overload 1:
client.getTextHeight(text)
Method Property Fluent Description Representation
text accepts a String
Return Value an Integer

ClientAPI.getSystemTime
Example by ChloeSpacedOut:
events.TICK:register(function()
log(client.getSystemTime())
end)
docs.clientapi.getsystemtime
overload 1:
client.getSystemTime()
Method Property Fluent Description Representation
Return Value an Integer

ClientAPI.getActiveLang
Example by ChloeSpacedOut:
log(client.getActiveLang())
docs.clientapi.getactivelang
overload 1:
client.getActiveLang()
Method Property Fluent Description Representation
Return Value a String

ClientAPI.isWindowFocused
Example by ChloeSpacedOut:
events.TICK:register(function()
log(client.isWindowFocused())
end)
docs.clientapi.iswindowfocused
overload 1:
client.isWindowFocused()
Method Property Fluent Description Representation
Return Value a Boolean

ClientAPI.isHudEnabled
Example by ChloeSpacedOut:
events.TICK:register(function()
log(client.isHudEnabled())
end)
docs.clientapi.ishudenabled
overload 1:
client.isHudEnabled()
Method Property Fluent Description Representation
Return Value a Boolean

ClientAPI.getMousePos
Example by ChloeSpacedOut:
events.TICK:register(function()
log(client.getMousePos())
end)
docs.clientapi.getmousepos
overload 1:
client.getMousePos()
Method Property Fluent Description Representation
Return Value a Vector2

ClientAPI.getTextWidth
Example by ChloeSpacedOut:
log(client.getTextWidth('TEXT!'))
docs.clientapi.gettextwidth
overload 1:
client.getTextWidth(text)
Method Property Fluent Description Representation
text accepts a String
Return Value an Integer

ClientAPI.getCameraPos
Example by ChloeSpacedOut:
events.TICK:register(function()
log(client.getCameraPos())
end)
docs.clientapi.getcamerapos
overload 1:
client.getCameraPos()
Method Property Fluent Description Representation
Return Value a Vector3

ClientAPI.getFOV
Example by ChloeSpacedOut:
log(client.getFOV())
docs.clientapi.getfov
overload 1:
client.getFOV()
Method Property Fluent Description Representation
Return Value a Number

ClientAPI.getWindowSize
Example by ChloeSpacedOut:
events.TICK:register(function()
log(client.getWindowSize())
end)
docs.clientapi.getwindowsize
overload 1:
client.getWindowSize()
Method Property Fluent Description Representation
Return Value a Vector2

ClientAPI.getScreen
docs.clientapi.getscreen
overload 1:
client.getScreen()
Method Property Fluent Description Representation
Return Value a String

ClientAPI.getCameraRot
Example by ChloeSpacedOut:
events.TICK:register(function()
log(client.getCameraRot())
end)
docs.clientapi.getcamerarot
overload 1:
client.getCameraRot()
Method Property Fluent Description Representation
Return Value a Vector3

ClientAPI.getGuiScale
Example by ChloeSpacedOut:
log(client.getGuiScale())
docs.clientapi.getguiscale
overload 1:
client.getGuiScale()
Method Property Fluent Description Representation
Return Value a Number

ClientAPI.getEntityStatistics
docs.clientapi.getentitystatistics
overload 1:
client.getEntityStatistics()
Method Property Fluent Description Representation
Return Value a String

ClientAPI.isDebugOverlayEnabled
Example by ChloeSpacedOut:
events.TICK:register(function()
log(client.isDebugOverlayEnabled())
end)
docs.clientapi.isdebugoverlayenabled
overload 1:
client.isDebugOverlayEnabled()
Method Property Fluent Description Representation
Return Value a Boolean

ClientAPI.getScaledWindowSize
Example by ChloeSpacedOut:
events.TICK:register(function()
log(client.getScaledWindowSize())
end)
docs.clientapi.getscaledwindowsize
overload 1:
client.getScaledWindowSize()
Method Property Fluent Description Representation
Return Value a Vector2

events
docs.globals.events
field signature:
events
Method Property Fluent Description Representation
Field Type an EventsAPI

EventsAPI.runOnce
docs.eventsapi.runonce
overload 1:
events:runOnce(predicate, toRun)
Method Property Fluent Description Representation
predicate accepts a function
toRun accepts a function
Return Value nil
overload 2:
events:runOnce(predicate, toRun, event)
Method Property Fluent Description Representation
predicate accepts a function
toRun accepts a function
event accepts an Event
Return Value nil

EventsAPI.TICK
docs.eventsapi.tick
field signature:
TICK
Method Property Fluent Description Representation
Field Type an Event

EventsAPI.WORLD_TICK
docs.eventsapi.world_tick
field signature:
WORLD_TICK
Method Property Fluent Description Representation
Field Type an Event

EventsAPI.RENDER
docs.eventsapi.render
field signature:
RENDER
Method Property Fluent Description Representation
Field Type an Event

EventsAPI.POST_RENDER
docs.eventsapi.post_render
field signature:
POST_RENDER
Method Property Fluent Description Representation
Field Type an Event

EventsAPI.WORLD_RENDER
docs.eventsapi.world_render
field signature:
WORLD_RENDER
Method Property Fluent Description Representation
Field Type an Event

EventsAPI.POST_WORLD_RENDER
docs.eventsapi.post_world_render
field signature:
POST_WORLD_RENDER
Method Property Fluent Description Representation
Field Type an Event

EventsAPI.CHAT_SEND_MESSAGE
docs.eventsapi.chat_send_message
field signature:
CHAT_SEND_MESSAGE
Method Property Fluent Description Representation
Field Type an Event

EventsAPI.CHAT_RECEIVE_MESSAGE
docs.eventsapi.chat_receive_message
field signature:
CHAT_RECEIVE_MESSAGE
Method Property Fluent Description Representation
Field Type an Event

matrices
docs.globals.matrices
field signature:
matrices
Method Property Fluent Description Representation
Field Type a MatricesAPI

MatricesAPI.scale2
docs.matricesapi.scale2
overload 1:
matrices.scale2(vec)
Method Property Fluent Description Representation
vec accepts a Vector2
Return Value a Matrix2
overload 2:
matrices.scale2(x, y)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
Return Value a Matrix2

MatricesAPI.rotation2
docs.matricesapi.rotation2
overload 1:
matrices.rotation2(angle)
Method Property Fluent Description Representation
angle accepts a Number
Return Value a Matrix2

MatricesAPI.mat2
docs.matricesapi.mat2
overload 1:
matrices.mat2()
Method Property Fluent Description Representation
Return Value a Matrix2
overload 2:
matrices.mat2(col1, col2)
Method Property Fluent Description Representation
col1 accepts a Vector2
col2 accepts a Vector2
Return Value a Matrix2

MatricesAPI.mat4
docs.matricesapi.mat4
overload 1:
matrices.mat4()
Method Property Fluent Description Representation
Return Value a Matrix4
overload 2:
matrices.mat4(col1, col2, col3, col4)
Method Property Fluent Description Representation
col1 accepts a Vector4
col2 accepts a Vector4
col3 accepts a Vector4
col4 accepts a Vector4
Return Value a Matrix4

MatricesAPI.mat3
docs.matricesapi.mat3
overload 1:
matrices.mat3()
Method Property Fluent Description Representation
Return Value a Matrix3
overload 2:
matrices.mat3(col1, col2, col3)
Method Property Fluent Description Representation
col1 accepts a Vector3
col2 accepts a Vector3
col3 accepts a Vector3
Return Value a Matrix3

MatricesAPI.yRotation4
docs.matricesapi.yrotation4
overload 1:
matrices.yRotation4(angle)
Method Property Fluent Description Representation
angle accepts a Number
Return Value a Matrix4

MatricesAPI.xRotation3
docs.matricesapi.xrotation3
overload 1:
matrices.xRotation3(angle)
Method Property Fluent Description Representation
angle accepts a Number
Return Value a Matrix3

MatricesAPI.rotation4
docs.matricesapi.rotation4
overload 1:
matrices.rotation4(vec)
Method Property Fluent Description Representation
vec accepts a Vector3
Return Value a Matrix4
overload 2:
matrices.rotation4(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a Matrix4

MatricesAPI.zRotation4
docs.matricesapi.zrotation4
overload 1:
matrices.zRotation4(angle)
Method Property Fluent Description Representation
angle accepts a Number
Return Value a Matrix4

MatricesAPI.rotation3
docs.matricesapi.rotation3
overload 1:
matrices.rotation3(vec)
Method Property Fluent Description Representation
vec accepts a Vector3
Return Value a Matrix3
overload 2:
matrices.rotation3(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a Matrix3

MatricesAPI.zRotation3
docs.matricesapi.zrotation3
overload 1:
matrices.zRotation3(angle)
Method Property Fluent Description Representation
angle accepts a Number
Return Value a Matrix3

MatricesAPI.xRotation4
docs.matricesapi.xrotation4
overload 1:
matrices.xRotation4(angle)
Method Property Fluent Description Representation
angle accepts a Number
Return Value a Matrix4

MatricesAPI.scale4
docs.matricesapi.scale4
overload 1:
matrices.scale4(vec)
Method Property Fluent Description Representation
vec accepts a Vector3
Return Value a Matrix4
overload 2:
matrices.scale4(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a Matrix4

MatricesAPI.translate3
docs.matricesapi.translate3
overload 1:
matrices.translate3(vec)
Method Property Fluent Description Representation
vec accepts a Vector2
Return Value a Matrix3
overload 2:
matrices.translate3(x, y)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
Return Value a Matrix3

MatricesAPI.scale3
docs.matricesapi.scale3
overload 1:
matrices.scale3(vec)
Method Property Fluent Description Representation
vec accepts a Vector3
Return Value a Matrix3
overload 2:
matrices.scale3(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a Matrix3

MatricesAPI.yRotation3
docs.matricesapi.yrotation3
overload 1:
matrices.yRotation3(angle)
Method Property Fluent Description Representation
angle accepts a Number
Return Value a Matrix3

MatricesAPI.translate4
docs.matricesapi.translate4
overload 1:
matrices.translate4(vec)
Method Property Fluent Description Representation
vec accepts a Vector3
Return Value a Matrix4
overload 2:
matrices.translate4(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a Matrix4

models
docs.globals.models
field signature:
models
Method Property Fluent Description Representation
Field Type a ModelPart

ModelPart.getParent
docs.modelpart.getparent
overload 1:
models:getParent()
Method Property Fluent Description Representation
Return Value either a ModelPart or nil

ModelPart.getType
docs.modelpart.gettype
overload 1:
models:getType()
Method Property Fluent Description Representation
Return Value a String

ModelPart.getChildren
docs.modelpart.getchildren
overload 1:
models:getChildren()
Method Property Fluent Description Representation
Return Value an array of ModelParts

ModelPart.setColor
docs.modelpart.setcolor
overload 1:
models:setColor(color)
Method Property Fluent Description Representation
color accepts a Vector3
Return Value nil
overload 2:
models:setColor(r, g, b)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
Return Value nil

ModelPart.setScale
docs.modelpart.setscale
overload 1:
models:setScale(scale)
Method Property Fluent Description Representation
scale accepts a Vector3
Return Value nil
overload 2:
models:setScale(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value nil

ModelPart.getTask
docs.modelpart.gettask
overload 1:
models:getTask(taskName)
Method Property Fluent Description Representation
taskName accepts a String
Return Value a table mapping a String to a RenderTask

ModelPart.addItem
docs.modelpart.additem
overload 1:
models:addItem(taskName)
Method Property Fluent Description Representation
taskName accepts a String
Return Value a RenderTask

ModelPart.getVisible
docs.modelpart.getvisible
overload 1:
models:getVisible()
Method Property Fluent Description Representation
Return Value either a Boolean or nil

ModelPart.setVisible
docs.modelpart.setvisible
overload 1:
models:setVisible(visible)
Method Property Fluent Description Representation
visible accepts a Boolean
Return Value nil

ModelPart.setPos
docs.modelpart.setpos
overload 1:
models:setPos(pos)
Method Property Fluent Description Representation
pos accepts a Vector3
Return Value nil
overload 2:
models:setPos(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value nil

ModelPart.getScale
docs.modelpart.getscale
overload 1:
models:getScale()
Method Property Fluent Description Representation
Return Value a Vector3

ModelPart.getPos
docs.modelpart.getpos
overload 1:
models:getPos()
Method Property Fluent Description Representation
Return Value a Vector3

ModelPart.getOpacity
docs.modelpart.getopacity
overload 1:
models:getOpacity()
Method Property Fluent Description Representation
Return Value a Number

ModelPart.offsetPivot
docs.modelpart.offsetpivot
overload 1:
models:offsetPivot(offsetPivot)
Method Property Fluent Description Representation
offsetPivot accepts a Vector3
Return Value nil
overload 2:
models:offsetPivot(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value nil

ModelPart.getAnimRot
docs.modelpart.getanimrot
overload 1:
models:getAnimRot()
Method Property Fluent Description Representation
Return Value a Vector3

ModelPart.getAnimScale
docs.modelpart.getanimscale
overload 1:
models:getAnimScale()
Method Property Fluent Description Representation
Return Value a Vector3

ModelPart.offsetRot
docs.modelpart.offsetrot
overload 1:
models:offsetRot(offsetRot)
Method Property Fluent Description Representation
offsetRot accepts a Vector3
Return Value nil
overload 2:
models:offsetRot(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value nil

ModelPart.getAnimPos
docs.modelpart.getanimpos
overload 1:
models:getAnimPos()
Method Property Fluent Description Representation
Return Value a Vector3

ModelPart.getNormalMatrix
docs.modelpart.getnormalmatrix
overload 1:
models:getNormalMatrix()
Method Property Fluent Description Representation
Return Value a Matrix3

ModelPart.setPivot
docs.modelpart.setpivot
overload 1:
models:setPivot(pivot)
Method Property Fluent Description Representation
pivot accepts a Vector3
Return Value nil
overload 2:
models:setPivot(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value nil

ModelPart.getOffsetRot
docs.modelpart.getoffsetrot
overload 1:
models:getOffsetRot()
Method Property Fluent Description Representation
Return Value a Vector3

ModelPart.getPivot
docs.modelpart.getpivot
overload 1:
models:getPivot()
Method Property Fluent Description Representation
Return Value a Vector3

ModelPart.getOffsetPivot
docs.modelpart.getoffsetpivot
overload 1:
models:getOffsetPivot()
Method Property Fluent Description Representation
Return Value a Vector3

ModelPart.setRot
docs.modelpart.setrot
overload 1:
models:setRot(rot)
Method Property Fluent Description Representation
rot accepts a Vector3
Return Value nil
overload 2:
models:setRot(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value nil

ModelPart.getNormalMatrixRaw
docs.modelpart.getnormalmatrixraw
overload 1:
models:getNormalMatrixRaw()
Method Property Fluent Description Representation
Return Value a Matrix3

ModelPart.getPositionMatrix
docs.modelpart.getpositionmatrix
overload 1:
models:getPositionMatrix()
Method Property Fluent Description Representation
Return Value a Matrix4

ModelPart.getRot
docs.modelpart.getrot
overload 1:
models:getRot()
Method Property Fluent Description Representation
Return Value a Vector3

ModelPart.setMatrix
docs.modelpart.setmatrix
overload 1:
models:setMatrix(matrix)
Method Property Fluent Description Representation
matrix accepts a Matrix4
Return Value nil

ModelPart.resetVisible
docs.modelpart.resetvisible
overload 1:
models:resetVisible()
Method Property Fluent Description Representation
Return Value nil

ModelPart.getTextureSize
docs.modelpart.gettexturesize
overload 1:
models:getTextureSize()
Method Property Fluent Description Representation
Return Value a Vector2

ModelPart.setUVMatrix
docs.modelpart.setuvmatrix
overload 1:
models:setUVMatrix(matrix)
Method Property Fluent Description Representation
matrix accepts a Matrix3
Return Value nil

ModelPart.setPrimaryTexture
docs.modelpart.setprimarytexture
overload 1:
models:setPrimaryTexture(textureType)
Method Property Fluent Description Representation
textureType accepts a String
Return Value nil
overload 2:
models:setPrimaryTexture(resource, path)
Method Property Fluent Description Representation
resource accepts a String
path accepts a String
Return Value nil

ModelPart.partToWorldMatrix
docs.modelpart.parttoworldmatrix
overload 1:
models:partToWorldMatrix()
Method Property Fluent Description Representation
Return Value a Matrix4

ModelPart.setUVPixels
docs.modelpart.setuvpixels
overload 1:
models:setUVPixels(uv)
Method Property Fluent Description Representation
uv accepts a Vector2
Return Value nil
overload 2:
models:setUVPixels(u, v)
Method Property Fluent Description Representation
u accepts a Number
v accepts a Number
Return Value nil

ModelPart.setOpacity
docs.modelpart.setopacity
overload 1:
models:setOpacity(opacity)
Method Property Fluent Description Representation
opacity accepts a Number
Return Value nil

ModelPart.setUV
docs.modelpart.setuv
overload 1:
models:setUV(uv)
Method Property Fluent Description Representation
uv accepts a Vector2
Return Value nil
overload 2:
models:setUV(u, v)
Method Property Fluent Description Representation
u accepts a Number
v accepts a Number
Return Value nil

ModelPart.addText
docs.modelpart.addtext
overload 1:
models:addText(taskName)
Method Property Fluent Description Representation
taskName accepts a String
Return Value a RenderTask

ModelPart.addBlock
docs.modelpart.addblock
overload 1:
models:addBlock(taskName)
Method Property Fluent Description Representation
taskName accepts a String
Return Value a RenderTask

ModelPart.setLight
docs.modelpart.setlight
overload 1:
models:setLight(light)
Method Property Fluent Description Representation
light accepts a Vector2
Return Value nil
overload 2:
models:setLight(blockLight, skyLight)
Method Property Fluent Description Representation
blockLight accepts an Integer
skyLight accepts an Integer
Return Value nil

ModelPart.getLight
docs.modelpart.getlight
overload 1:
models:getLight()
Method Property Fluent Description Representation
Return Value a Vector2

ModelPart.setParentType
docs.modelpart.setparenttype
overload 1:
models:setParentType(parentType)
Method Property Fluent Description Representation
parentType accepts a String
Return Value nil

ModelPart.getParentType
docs.modelpart.getparenttype
overload 1:
models:getParentType()
Method Property Fluent Description Representation
Return Value a String

ModelPart.removeTask
docs.modelpart.removetask
overload 1:
models:removeTask(taskName)
Method Property Fluent Description Representation
taskName accepts a String
Return Value nil

ModelPart.getColor
docs.modelpart.getcolor
overload 1:
models:getColor()
Method Property Fluent Description Representation
Return Value a Vector3

ModelPart.getPositionMatrixRaw
docs.modelpart.getpositionmatrixraw
overload 1:
models:getPositionMatrixRaw()
Method Property Fluent Description Representation
Return Value a Matrix4

ModelPart.getSecondaryRenderType
docs.modelpart.getsecondaryrendertype
overload 1:
models:getSecondaryRenderType()
Method Property Fluent Description Representation
Return Value either a RenderTypes or nil

ModelPart.getPrimaryRenderType
docs.modelpart.getprimaryrendertype
overload 1:
models:getPrimaryRenderType()
Method Property Fluent Description Representation
Return Value either a RenderTypes or nil

ModelPart.setSecondaryRenderType
docs.modelpart.setsecondaryrendertype
overload 1:
models:setSecondaryRenderType(renderType)
Method Property Fluent Description Representation
renderType accepts a String
Return Value nil

ModelPart.setPrimaryRenderType
docs.modelpart.setprimaryrendertype
overload 1:
models:setPrimaryRenderType(renderType)
Method Property Fluent Description Representation
renderType accepts a String
Return Value nil

ModelPart.setSecondaryTexture
docs.modelpart.setsecondarytexture
overload 1:
models:setSecondaryTexture(textureType)
Method Property Fluent Description Representation
textureType accepts a String
Return Value nil
overload 2:
models:setSecondaryTexture(resource, path)
Method Property Fluent Description Representation
resource accepts a String
path accepts a String
Return Value nil

ModelPart.name
docs.modelpart.name
field signature:
name
Method Property Fluent Description Representation
Field Type a String

nameplate
docs.globals.nameplate
field signature:
nameplate
Method Property Fluent Description Representation
Field Type a NameplateAPI

NameplateAPI.CHAT
docs.nameplateapi.chat
field signature:
CHAT
Method Property Fluent Description Representation
Field Type a NameplateCustomization

NameplateAPI.ENTITY
docs.nameplateapi.entity
field signature:
ENTITY
Method Property Fluent Description Representation
Field Type a NameplateCustomization

NameplateAPI.LIST
docs.nameplateapi.list
field signature:
LIST
Method Property Fluent Description Representation
Field Type a NameplateCustomization

particle
docs.globals.particle
field signature:
particle
Method Property Fluent Description Representation
Field Type a ParticleAPI

ParticleAPI.addParticle
docs.particleapi.addparticle
overload 1:
particle:addParticle(name, posVel)
typings.2002444083
Method Property Fluent Description Representation
name accepts a String
posVel accepts
Return Value nil
overload 2:
particle:addParticle(name, pos)
Method Property Fluent Description Representation
name accepts a String
pos accepts a Vector3
Return Value nil
overload 3:
particle:addParticle(name, pos, vel)
Method Property Fluent Description Representation
name accepts a String
pos accepts a Vector3
vel accepts a Vector3
Return Value nil
overload 4:
particle:addParticle(name, posX, posY, posZ)
Method Property Fluent Description Representation
name accepts a String
posX accepts a Number
posY accepts a Number
posZ accepts a Number
Return Value nil
overload 5:
particle:addParticle(name, pos, velX, velY, velZ)
Method Property Fluent Description Representation
name accepts a String
pos accepts a Vector3
velX accepts a Number
velY accepts a Number
velZ accepts a Number
Return Value nil
overload 6:
particle:addParticle(name, posX, posY, posZ, vel)
Method Property Fluent Description Representation
name accepts a String
posX accepts a Number
posY accepts a Number
posZ accepts a Number
vel accepts a Vector3
Return Value nil
overload 7:
particle:addParticle(name, posX, posY, posZ, velX, velY, velZ)
Method Property Fluent Description Representation
name accepts a String
posX accepts a Number
posY accepts a Number
posZ accepts a Number
velX accepts a Number
velY accepts a Number
velZ accepts a Number
Return Value nil

player
docs.globals.player
field signature:
player
typings.-1901885695
Method Property Fluent Description Representation
Field Type

Player.getGamemode
docs.player.getgamemode
overload 1:
player:getGamemode()
Method Property Fluent Description Representation
Return Value a String

Player.getFood
docs.player.getfood
overload 1:
player:getFood()
Method Property Fluent Description Representation
Return Value an Integer

Player.getSaturation
docs.player.getsaturation
overload 1:
player:getSaturation()
Method Property Fluent Description Representation
Return Value a Number

Player.isFlying
docs.player.isflying
overload 1:
player:isFlying()
Method Property Fluent Description Representation
Return Value a Boolean

Player.getModelType
docs.player.getmodeltype
overload 1:
player:getModelType()
Method Property Fluent Description Representation
Return Value a String

Player.getExperienceLevel
docs.player.getexperiencelevel
overload 1:
player:getExperienceLevel()
Method Property Fluent Description Representation
Return Value an Integer

Player.getExperienceProgress
docs.player.getexperienceprogress
overload 1:
player:getExperienceProgress()
Method Property Fluent Description Representation
Return Value a Number

Player.getDeathTime

Inherited from LivingEntity

docs.player.getdeathtime
overload 1:
player:getDeathTime()
Method Property Fluent Description Representation
Return Value an Integer

Player.getMaxHealth

Inherited from LivingEntity

docs.player.getmaxhealth
overload 1:
player:getMaxHealth()
Method Property Fluent Description Representation
Return Value a Number

Player.getArmor

Inherited from LivingEntity

docs.player.getarmor
overload 1:
player:getArmor()
Method Property Fluent Description Representation
Return Value an Integer

Player.getStatusEffects

Inherited from LivingEntity

docs.player.getstatuseffects
overload 1:
player:getStatusEffects()
Method Property Fluent Description Representation
Return Value a table

Player.getHeldItem

Inherited from LivingEntity

docs.player.gethelditem
overload 1:
player:getHeldItem()
Method Property Fluent Description Representation
Return Value an ItemStack
overload 2:
player:getHeldItem(offhand)
Method Property Fluent Description Representation
offhand accepts a Boolean
Return Value an ItemStack

Player.getBodyYaw

Inherited from LivingEntity

docs.player.getbodyyaw
overload 1:
player:getBodyYaw()
Method Property Fluent Description Representation
Return Value a Number
overload 2:
player:getBodyYaw(delta)
Method Property Fluent Description Representation
delta accepts a Number
Return Value a Number

Player.getHealth

Inherited from LivingEntity

docs.player.gethealth
overload 1:
player:getHealth()
Method Property Fluent Description Representation
Return Value a Number

Player.getStingerCount

Inherited from LivingEntity

docs.player.getstingercount
overload 1:
player:getStingerCount()
Method Property Fluent Description Representation
Return Value an Integer

Player.isClimbing

Inherited from LivingEntity

docs.player.isclimbing
overload 1:
player:isClimbing()
Method Property Fluent Description Representation
Return Value a Boolean

Player.getActiveHand

Inherited from LivingEntity

docs.player.getactivehand
overload 1:
player:getActiveHand()
Method Property Fluent Description Representation
Return Value a String

Player.getActiveItem

Inherited from LivingEntity

docs.player.getactiveitem
overload 1:
player:getActiveItem()
Method Property Fluent Description Representation
Return Value an ItemStack

Player.isLeftHanded

Inherited from LivingEntity

docs.player.islefthanded
overload 1:
player:isLeftHanded()
Method Property Fluent Description Representation
Return Value a Boolean

Player.getArrowCount

Inherited from LivingEntity

docs.player.getarrowcount
overload 1:
player:getArrowCount()
Method Property Fluent Description Representation
Return Value an Integer

Player.isUsingItem

Inherited from LivingEntity

docs.player.isusingitem
overload 1:
player:isUsingItem()
Method Property Fluent Description Representation
Return Value a Boolean

Player.getName

Inherited from LivingEntity

docs.player.getname
overload 1:
player:getName()
Method Property Fluent Description Representation
Return Value a String

Player.getType

Inherited from LivingEntity

docs.player.gettype
overload 1:
player:getType()
Method Property Fluent Description Representation
Return Value a String

Player.exists

Inherited from LivingEntity

docs.player.exists
overload 1:
player:exists()
Method Property Fluent Description Representation
Return Value a Boolean

Player.getItem

Inherited from LivingEntity

docs.player.getitem
overload 1:
player:getItem(index)
Method Property Fluent Description Representation
index accepts an Integer
Return Value an ItemStack

Player.getTargetedBlock

Inherited from LivingEntity

docs.player.gettargetedblock
overload 1:
player:getTargetedBlock()
Method Property Fluent Description Representation
Return Value a BlockState
overload 2:
player:getTargetedBlock(ignoreLiquids)
Method Property Fluent Description Representation
ignoreLiquids accepts a Boolean
Return Value a BlockState
overload 3:
player:getTargetedBlock(ignoreLiquids, distance)
Method Property Fluent Description Representation
ignoreLiquids accepts a Boolean
distance accepts a Number
Return Value a BlockState

Player.isOnFire

Inherited from LivingEntity

docs.player.isonfire
overload 1:
player:isOnFire()
Method Property Fluent Description Representation
Return Value a Boolean

Player.getPos

Inherited from LivingEntity

docs.player.getpos
overload 1:
player:getPos()
Method Property Fluent Description Representation
Return Value a Vector3
overload 2:
player:getPos(delta)
Method Property Fluent Description Representation
delta accepts a Number
Return Value a Vector3

Player.getRot

Inherited from LivingEntity

docs.player.getrot
overload 1:
player:getRot()
Method Property Fluent Description Representation
Return Value a Vector2
overload 2:
player:getRot(delta)
Method Property Fluent Description Representation
delta accepts a Number
Return Value a Vector2

Player.getUUID

Inherited from LivingEntity

docs.player.getuuid
overload 1:
player:getUUID()
Method Property Fluent Description Representation
Return Value a String

Player.getDimensionName

Inherited from LivingEntity

docs.player.getdimensionname
overload 1:
player:getDimensionName()
Method Property Fluent Description Representation
Return Value a String

Player.getEyeHeight

Inherited from LivingEntity

docs.player.geteyeheight
overload 1:
player:getEyeHeight()
Method Property Fluent Description Representation
Return Value a Number

Player.getBoundingBox

Inherited from LivingEntity

docs.player.getboundingbox
overload 1:
player:getBoundingBox()
Method Property Fluent Description Representation
Return Value a Vector3

Player.getFireTicks

Inherited from LivingEntity

docs.player.getfireticks
overload 1:
player:getFireTicks()
Method Property Fluent Description Representation
Return Value an Integer

Player.isHamburger

Inherited from LivingEntity

docs.player.ishamburger
overload 1:
player:isHamburger()
Method Property Fluent Description Representation
Return Value a Boolean

Player.getLookDir

Inherited from LivingEntity

docs.player.getlookdir
overload 1:
player:getLookDir()
Method Property Fluent Description Representation
Return Value a Vector3

Player.getMaxAir

Inherited from LivingEntity

docs.player.getmaxair
overload 1:
player:getMaxAir()
Method Property Fluent Description Representation
Return Value an Integer

Player.getFrozenTicks

Inherited from LivingEntity

docs.player.getfrozenticks
overload 1:
player:getFrozenTicks()
Method Property Fluent Description Representation
Return Value an Integer

Player.getPose

Inherited from LivingEntity

docs.player.getpose
overload 1:
player:getPose()
Method Property Fluent Description Representation
Return Value a String

Player.getVehicle

Inherited from LivingEntity

docs.player.getvehicle
overload 1:
player:getVehicle()
typings.2080559107
Method Property Fluent Description Representation
Return Value

Player.isOnGround

Inherited from LivingEntity

docs.player.isonground
overload 1:
player:isOnGround()
Method Property Fluent Description Representation
Return Value a Boolean

Player.getAir

Inherited from LivingEntity

docs.player.getair
overload 1:
player:getAir()
Method Property Fluent Description Representation
Return Value an Integer

Player.isWet

Inherited from LivingEntity

docs.player.iswet
overload 1:
player:isWet()
Method Property Fluent Description Representation
Return Value a Boolean

Player.getVelocity

Inherited from LivingEntity

docs.player.getvelocity
overload 1:
player:getVelocity()
Method Property Fluent Description Representation
Return Value a Vector3

Player.isUnderwater

Inherited from LivingEntity

docs.player.isunderwater
overload 1:
player:isUnderwater()
Method Property Fluent Description Representation
Return Value a Boolean

Player.isSprinting

Inherited from LivingEntity

docs.player.issprinting
overload 1:
player:isSprinting()
Method Property Fluent Description Representation
Return Value a Boolean

Player.getEyeY

Inherited from LivingEntity

docs.player.geteyey
overload 1:
player:getEyeY()
Method Property Fluent Description Representation
Return Value a Number

Player.isSneaking

Inherited from LivingEntity

docs.player.issneaking
overload 1:
player:isSneaking()
Method Property Fluent Description Representation
Return Value a Boolean

Player.isGlowing

Inherited from LivingEntity

docs.player.isglowing
overload 1:
player:isGlowing()
Method Property Fluent Description Representation
Return Value a Boolean

Player.isSilent

Inherited from LivingEntity

docs.player.issilent
overload 1:
player:isSilent()
Method Property Fluent Description Representation
Return Value a Boolean

Player.isInvisible

Inherited from LivingEntity

docs.player.isinvisible
overload 1:
player:isInvisible()
Method Property Fluent Description Representation
Return Value a Boolean

Player.getVariable

Inherited from LivingEntity

docs.player.getvariable
overload 1:
player:getVariable(key)
Method Property Fluent Description Representation
key accepts a String
Return Value anything

Player.isInRain

Inherited from LivingEntity

docs.player.isinrain
overload 1:
player:isInRain()
Method Property Fluent Description Representation
Return Value a Boolean

Player.isInWater

Inherited from LivingEntity

docs.player.isinwater
overload 1:
player:isInWater()
Method Property Fluent Description Representation
Return Value a Boolean

Player.hasAvatar

Inherited from LivingEntity

docs.player.hasavatar
overload 1:
player:hasAvatar()
Method Property Fluent Description Representation
Return Value a Boolean

Player.isInLava

Inherited from LivingEntity

docs.player.isinlava
overload 1:
player:isInLava()
Method Property Fluent Description Representation
Return Value a Boolean

Player.getNbt

Inherited from LivingEntity

docs.player.getnbt
overload 1:
player:getNbt()
Method Property Fluent Description Representation
Return Value a table

sound
docs.globals.sound
field signature:
sound
Method Property Fluent Description Representation
Field Type a SoundAPI

SoundAPI.playSound
Example by JimmyHelp:
sounds:playSound("entity.bat.ambient", player:getPos(),1,1,false)
docs.soundapi.playsound
overload 1:
sound:playSound(sound, pos)
Method Property Fluent Description Representation
sound accepts a String
pos accepts a Vector3
Return Value nil
overload 2:
sound:playSound(sound, posX, posY, posZ)
Method Property Fluent Description Representation
sound accepts a String
posX accepts a Number
posY accepts a Number
posZ accepts a Number
Return Value nil
overload 3:
sound:playSound(sound, pos, volume, pitch, loop)
Method Property Fluent Description Representation
sound accepts a String
pos accepts a Vector3
volume accepts a Number
pitch accepts a Number
loop accepts a Boolean
Return Value nil
overload 4:
sound:playSound(sound, posX, posY, posZ, volume, pitch, loop)
Method Property Fluent Description Representation
sound accepts a String
posX accepts a Number
posY accepts a Number
posZ accepts a Number
volume accepts a Number
pitch accepts a Number
loop accepts a Boolean
Return Value nil

SoundAPI.stopSound
docs.soundapi.stopsound
overload 1:
sound:stopSound()
Method Property Fluent Description Representation
Return Value nil
overload 2:
sound:stopSound(id)
Method Property Fluent Description Representation
id accepts a String
Return Value nil

vanilla_model
docs.globals.vanilla_model
field signature:
vanilla_model
Method Property Fluent Description Representation
Field Type a VanillaModelAPI

VanillaModelAPI.HEAD
docs.vanillamodelapi.head
field signature:
HEAD
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.BODY
docs.vanillamodelapi.body
field signature:
BODY
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.LEFT_ARM
docs.vanillamodelapi.left_arm
field signature:
LEFT_ARM
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.RIGHT_ARM
docs.vanillamodelapi.right_arm
field signature:
RIGHT_ARM
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.LEFT_LEG
docs.vanillamodelapi.left_leg
field signature:
LEFT_LEG
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.RIGHT_LEG
docs.vanillamodelapi.right_leg
field signature:
RIGHT_LEG
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.HAT
docs.vanillamodelapi.hat
field signature:
HAT
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.JACKET
docs.vanillamodelapi.jacket
field signature:
JACKET
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.LEFT_SLEEVE
docs.vanillamodelapi.left_sleeve
field signature:
LEFT_SLEEVE
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.RIGHT_SLEEVE
docs.vanillamodelapi.right_sleeve
field signature:
RIGHT_SLEEVE
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.LEFT_PANTS
docs.vanillamodelapi.left_pants
field signature:
LEFT_PANTS
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.RIGHT_PANTS
docs.vanillamodelapi.right_pants
field signature:
RIGHT_PANTS
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.CAPE_MODEL
docs.vanillamodelapi.cape_model
field signature:
CAPE_MODEL
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.FAKE_CAPE
docs.vanillamodelapi.fake_cape
field signature:
FAKE_CAPE
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.HELMET_HEAD
docs.vanillamodelapi.helmet_head
field signature:
HELMET_HEAD
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.HELMET_HAT
docs.vanillamodelapi.helmet_hat
field signature:
HELMET_HAT
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.CHESTPLATE_BODY
docs.vanillamodelapi.chestplate_body
field signature:
CHESTPLATE_BODY
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.CHESTPLATE_LEFT_ARM
docs.vanillamodelapi.chestplate_left_arm
field signature:
CHESTPLATE_LEFT_ARM
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.CHESTPLATE_RIGHT_ARM
docs.vanillamodelapi.chestplate_right_arm
field signature:
CHESTPLATE_RIGHT_ARM
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.LEGGINGS_BODY
docs.vanillamodelapi.leggings_body
field signature:
LEGGINGS_BODY
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.LEGGINGS_LEFT_LEG
docs.vanillamodelapi.leggings_left_leg
field signature:
LEGGINGS_LEFT_LEG
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.LEGGINGS_RIGHT_LEG
docs.vanillamodelapi.leggings_right_leg
field signature:
LEGGINGS_RIGHT_LEG
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.BOOTS_LEFT_LEG
docs.vanillamodelapi.boots_left_leg
field signature:
BOOTS_LEFT_LEG
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.BOOTS_RIGHT_LEG
docs.vanillamodelapi.boots_right_leg
field signature:
BOOTS_RIGHT_LEG
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.LEFT_ELYTRA
docs.vanillamodelapi.left_elytra
field signature:
LEFT_ELYTRA
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.RIGHT_ELYTRA
docs.vanillamodelapi.right_elytra
field signature:
RIGHT_ELYTRA
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.LEFT_ITEM
docs.vanillamodelapi.left_item
field signature:
LEFT_ITEM
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.RIGHT_ITEM
docs.vanillamodelapi.right_item
field signature:
RIGHT_ITEM
Method Property Fluent Description Representation
Field Type a VanillaModelPart

VanillaModelAPI.ALL
docs.vanillamodelapi.all
field signature:
ALL
Method Property Fluent Description Representation
Field Type a VanillaModelGroup

VanillaModelAPI.PLAYER
docs.vanillamodelapi.player
field signature:
PLAYER
Method Property Fluent Description Representation
Field Type a VanillaModelGroup

VanillaModelAPI.OUTER_LAYER
docs.vanillamodelapi.outer_layer
field signature:
OUTER_LAYER
Method Property Fluent Description Representation
Field Type a VanillaModelGroup

VanillaModelAPI.INNER_LAYER
docs.vanillamodelapi.inner_layer
field signature:
INNER_LAYER
Method Property Fluent Description Representation
Field Type a VanillaModelGroup

VanillaModelAPI.CAPE
docs.vanillamodelapi.cape
field signature:
CAPE
Method Property Fluent Description Representation
Field Type a VanillaModelGroup

VanillaModelAPI.ARMOR
docs.vanillamodelapi.armor
field signature:
ARMOR
Method Property Fluent Description Representation
Field Type a VanillaModelGroup

VanillaModelAPI.HELMET
docs.vanillamodelapi.helmet
field signature:
HELMET
Method Property Fluent Description Representation
Field Type a VanillaModelGroup

VanillaModelAPI.CHESTPLATE
docs.vanillamodelapi.chestplate
field signature:
CHESTPLATE
Method Property Fluent Description Representation
Field Type a VanillaModelGroup

VanillaModelAPI.LEGGINGS
docs.vanillamodelapi.leggings
field signature:
LEGGINGS
Method Property Fluent Description Representation
Field Type a VanillaModelGroup

VanillaModelAPI.BOOTS
docs.vanillamodelapi.boots
field signature:
BOOTS
Method Property Fluent Description Representation
Field Type a VanillaModelGroup

VanillaModelAPI.ELYTRA
docs.vanillamodelapi.elytra
field signature:
ELYTRA
Method Property Fluent Description Representation
Field Type a VanillaModelGroup

VanillaModelAPI.HELD_ITEMS
docs.vanillamodelapi.held_items
field signature:
HELD_ITEMS
Method Property Fluent Description Representation
Field Type a VanillaModelGroup

vec
docs.globals.vec
field signature:
vec
Method Property Fluent Description Representation
Field Type a function that takes a Number, a Number, either a Number or nil, either a Number or nil, either a Number or nil and either a Number or nil and will return anything, such that supplying a Number and a Number would return a Vector2, supplying a Number, a Number and a Number would return a Vector3, supplying a Number, a Number, a Number and a Number would return a Vector4, supplying a Number, a Number, a Number, a Number and a Number would return a Vector5, supplying a Number, a Number, a Number, a Number, a Number and a Number would return a Vector6

vectors
docs.globals.vectors
field signature:
vectors
Method Property Fluent Description Representation
Field Type a VectorsAPI

VectorsAPI.vec
docs.vectorsapi.vec
overload 1:
vectors.vec(x, y)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
Return Value a Vector2
overload 2:
vectors.vec(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a Vector3
overload 3:
vectors.vec(x, y, z, w)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
w accepts a Number
Return Value a Vector4
overload 4:
vectors.vec(x, y, z, w, t)
typings.2002444082
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
w accepts a Number
t accepts a Number
Return Value
overload 5:
vectors.vec(x, y, z, w, t, h)
typings.2002444083
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
w accepts a Number
t accepts a Number
h accepts a Number
Return Value

VectorsAPI.vec6
docs.vectorsapi.vec6
overload 1:
vectors.vec6(x, y, z, w, t, h)
typings.2002444083
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
w accepts a Number
t accepts a Number
h accepts a Number
Return Value

VectorsAPI.vec5
docs.vectorsapi.vec5
overload 1:
vectors.vec5(x, y, z, w, t)
typings.2002444082
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
w accepts a Number
t accepts a Number
Return Value

VectorsAPI.rotateAroundAxis
docs.vectorsapi.rotatearoundaxis
overload 1:
vectors.rotateAroundAxis(angle, vec, axis)
Method Property Fluent Description Representation
angle accepts a Number
vec accepts a Vector3
axis accepts a Vector3
Return Value a Vector3
overload 2:
vectors.rotateAroundAxis(angle, x, y, z, axis)
Method Property Fluent Description Representation
angle accepts a Number
x accepts a Number
y accepts a Number
z accepts a Number
axis accepts a Vector3
Return Value a Vector3
overload 3:
vectors.rotateAroundAxis(angle, vec, axisX, axisY, axisZ)
Method Property Fluent Description Representation
angle accepts a Number
vec accepts a Vector3
axisX accepts a Number
axisY accepts a Number
axisZ accepts a Number
Return Value a Vector3
overload 4:
vectors.rotateAroundAxis(angle, x, y, z, axisX, axisY, axisZ)
Method Property Fluent Description Representation
angle accepts a Number
x accepts a Number
y accepts a Number
z accepts a Number
axisX accepts a Number
axisY accepts a Number
axisZ accepts a Number
Return Value a Vector3

VectorsAPI.hexToRGB
docs.vectorsapi.hextorgb
overload 1:
vectors.hexToRGB(hex)
Method Property Fluent Description Representation
hex accepts a String
Return Value a Vector3

VectorsAPI.worldToScreenSpace
docs.vectorsapi.worldtoscreenspace
overload 1:
vectors.worldToScreenSpace(vec)
Method Property Fluent Description Representation
vec accepts a Vector3
Return Value a Vector4
overload 2:
vectors.worldToScreenSpace(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a Vector4

VectorsAPI.toCameraSpace
docs.vectorsapi.tocameraspace
overload 1:
vectors.toCameraSpace(vec)
Method Property Fluent Description Representation
vec accepts a Vector3
Return Value a Vector3
overload 2:
vectors.toCameraSpace(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a Vector3

VectorsAPI.vec4
docs.vectorsapi.vec4
overload 1:
vectors.vec4(x, y, z, w)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
w accepts a Number
Return Value a Vector4

VectorsAPI.rgbToINT
docs.vectorsapi.rgbtoint
overload 1:
vectors.rgbToINT(rgb)
Method Property Fluent Description Representation
rgb accepts a Vector3
Return Value an Integer
overload 2:
vectors.rgbToINT(r, g, b)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
Return Value an Integer

VectorsAPI.intToRGB
docs.vectorsapi.inttorgb
overload 1:
vectors.intToRGB(color)
Method Property Fluent Description Representation
color accepts an Integer
Return Value a Vector3

VectorsAPI.hsvToRGB
docs.vectorsapi.hsvtorgb
overload 1:
vectors.hsvToRGB(hsv)
Method Property Fluent Description Representation
hsv accepts a Vector3
Return Value a Vector3
overload 2:
vectors.hsvToRGB(h, s, v)
Method Property Fluent Description Representation
h accepts a Number
s accepts a Number
v accepts a Number
Return Value a Vector3

VectorsAPI.rgbToHSV
docs.vectorsapi.rgbtohsv
overload 1:
vectors.rgbToHSV(rgb)
Method Property Fluent Description Representation
rgb accepts a Vector3
Return Value a Vector3
overload 2:
vectors.rgbToHSV(r, g, b)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
Return Value a Vector3

VectorsAPI.rainbow
docs.vectorsapi.rainbow
overload 1:
vectors.rainbow(speed)
Method Property Fluent Description Representation
speed accepts a Number
Return Value a Vector3
overload 2:
vectors.rainbow(speed, offset)
Method Property Fluent Description Representation
speed accepts a Number
offset accepts a Number
Return Value a Vector3
overload 3:
vectors.rainbow(speed, offset, saturation, light)
Method Property Fluent Description Representation
speed accepts a Number
offset accepts a Number
saturation accepts a Number
light accepts a Number
Return Value a Vector3

VectorsAPI.vec2
docs.vectorsapi.vec2
overload 1:
vectors.vec2(x, y)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
Return Value a Vector2

VectorsAPI.vec3
docs.vectorsapi.vec3
overload 1:
vectors.vec3(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a Vector3

world
docs.globals.world
field signature:
world
Method Property Fluent Description Representation
Field Type a WorldAPI

WorldAPI.exists
docs.worldapi.exists
overload 1:
world.exists()
Method Property Fluent Description Representation
Return Value a Boolean

WorldAPI.getTime
docs.worldapi.gettime
overload 1:
world.getTime()
Method Property Fluent Description Representation
Return Value a Number
overload 2:
world.getTime(delta)
Method Property Fluent Description Representation
delta accepts a Number
Return Value a Number

WorldAPI.getTimeOfDay
docs.worldapi.gettimeofday
overload 1:
world.getTimeOfDay()
Method Property Fluent Description Representation
Return Value a Number
overload 2:
world.getTimeOfDay(delta)
Method Property Fluent Description Representation
delta accepts a Number
Return Value a Number

WorldAPI.getBlockState
docs.worldapi.getblockstate
overload 1:
world.getBlockState(pos)
Method Property Fluent Description Representation
pos accepts a Vector3
Return Value a BlockState
overload 2:
world.getBlockState(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a BlockState

WorldAPI.getRedstonePower
docs.worldapi.getredstonepower
overload 1:
world.getRedstonePower(pos)
Method Property Fluent Description Representation
pos accepts a Vector3
Return Value an Integer
overload 2:
world.getRedstonePower(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value an Integer

WorldAPI.getBiome
docs.worldapi.getbiome
overload 1:
world.getBiome(pos)
Method Property Fluent Description Representation
pos accepts a Vector3
Return Value a Biome
overload 2:
world.getBiome(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a Biome

WorldAPI.getSkyLightLevel
docs.worldapi.getskylightlevel
overload 1:
world.getSkyLightLevel(pos)
Method Property Fluent Description Representation
pos accepts a Vector3
Return Value an Integer
overload 2:
world.getSkyLightLevel(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value an Integer

WorldAPI.getMoonPhase
docs.worldapi.getmoonphase
overload 1:
world.getMoonPhase()
Method Property Fluent Description Representation
Return Value an Integer

WorldAPI.isThundering
docs.worldapi.isthundering
overload 1:
world.isThundering()
Method Property Fluent Description Representation
Return Value a Boolean

WorldAPI.isOpenSky
docs.worldapi.isopensky
overload 1:
world.isOpenSky(pos)
Method Property Fluent Description Representation
pos accepts a Vector3
Return Value a Boolean
overload 2:
world.isOpenSky(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a Boolean

WorldAPI.getBlockLightLevel
docs.worldapi.getblocklightlevel
overload 1:
world.getBlockLightLevel(pos)
Method Property Fluent Description Representation
pos accepts a Vector3
Return Value an Integer
overload 2:
world.getBlockLightLevel(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value an Integer

WorldAPI.getRainGradient
docs.worldapi.getraingradient
overload 1:
world.getRainGradient()
Method Property Fluent Description Representation
Return Value a Number
overload 2:
world.getRainGradient(delta)
Method Property Fluent Description Representation
delta accepts a Number
Return Value a Number

WorldAPI.getLightLevel
docs.worldapi.getlightlevel
overload 1:
world.getLightLevel(pos)
Method Property Fluent Description Representation
pos accepts a Vector3
Return Value an Integer
overload 2:
world.getLightLevel(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value an Integer

WorldAPI.getPlayers
docs.worldapi.getplayers
overload 1:
world.getPlayers()
Method Property Fluent Description Representation
Return Value a table mapping a String to a PlayerAPI

WorldAPI.getStrongRedstonePower
docs.worldapi.getstrongredstonepower
overload 1:
world.getStrongRedstonePower(pos)
Method Property Fluent Description Representation
pos accepts a Vector3
Return Value an Integer
overload 2:
world.getStrongRedstonePower(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value an Integer

Action
docs.action

Action.color
docs.action.color
overload 1:
Action:color(color)
Method Property Fluent Description Representation
color accepts a Vector3
Return Value an Action
overload 2:
Action:color(r, g, b)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
Return Value an Action

Action.item
docs.action.item
overload 1:
Action:item(item)
Method Property Fluent Description Representation
item accepts an ItemStack
Return Value an Action
overload 2:
Action:item(item)
Method Property Fluent Description Representation
item accepts a String
Return Value an Action

Action.title
docs.action.title
overload 1:
Action:title(title)
Method Property Fluent Description Representation
title accepts a String
Return Value an Action

Action.hoverColor
docs.action.hovercolor
overload 1:
Action:hoverColor(color)
Method Property Fluent Description Representation
color accepts a Vector3
Return Value an Action
overload 2:
Action:hoverColor(r, g, b)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
Return Value an Action

Action.hoverItem
docs.action.hoveritem
overload 1:
Action:hoverItem(item)
Method Property Fluent Description Representation
item accepts an ItemStack
Return Value an Action
overload 2:
Action:hoverItem(item)
Method Property Fluent Description Representation
item accepts a String
Return Value an Action

Animation
docs.animation

Animation.priority
docs.animation.priority
overload 1:
Animation:priority(priority)
Method Property Fluent Description Representation
priority accepts an Integer
Return Value an Animation

Animation.length
docs.animation.length
overload 1:
Animation:length(length)
Method Property Fluent Description Representation
length accepts a Number
Return Value an Animation

Animation.blend
docs.animation.blend
overload 1:
Animation:blend(blend)
Method Property Fluent Description Representation
blend accepts a Number
Return Value an Animation

Animation.offset
docs.animation.offset
overload 1:
Animation:offset(offset)
Method Property Fluent Description Representation
offset accepts a Number
Return Value an Animation

Animation.stop
docs.animation.stop
overload 1:
Animation:stop()
Method Property Fluent Description Representation
Return Value nil

Animation.override
docs.animation.override
overload 1:
Animation:override(override)
Method Property Fluent Description Representation
override accepts a Boolean
Return Value an Animation

Animation.loop
docs.animation.loop
overload 1:
Animation:loop(loop)
Method Property Fluent Description Representation
loop accepts a String
Return Value an Animation

Animation.getTime
docs.animation.gettime
overload 1:
Animation:getTime()
Method Property Fluent Description Representation
Return Value a Number

Animation.setTime
docs.animation.settime
overload 1:
Animation:setTime(time)
Method Property Fluent Description Representation
time accepts a Number
Return Value nil

Animation.play
Example by JimmyHelp:
animations.bbmodelName.animationName:play()
docs.animation.play
overload 1:
Animation:play()
Method Property Fluent Description Representation
Return Value nil

Animation.loopDelay
docs.animation.loopdelay
overload 1:
Animation:loopDelay(delay)
Method Property Fluent Description Representation
delay accepts a Number
Return Value an Animation

Animation.getPlayState
docs.animation.getplaystate
overload 1:
Animation:getPlayState()
Method Property Fluent Description Representation
Return Value a String

Animation.startDelay
docs.animation.startdelay
overload 1:
Animation:startDelay(delay)
Method Property Fluent Description Representation
delay accepts a Number
Return Value an Animation

Animation.pause
docs.animation.pause
overload 1:
Animation:pause()
Method Property Fluent Description Representation
Return Value nil

Animation.restart
docs.animation.restart
overload 1:
Animation:restart()
Method Property Fluent Description Representation
Return Value nil

Animation.addCode
docs.animation.addcode
overload 1:
Animation:addCode(time, code)
Method Property Fluent Description Representation
time accepts a Number
code accepts a String
Return Value an Animation

Animation.speed
docs.animation.speed
overload 1:
Animation:speed(speed)
Method Property Fluent Description Representation
speed accepts a Number
Return Value an Animation

Animation.name
docs.animation.name
field signature:
name
Method Property Fluent Description Representation
Field Type a String

Biome
docs.biome

Biome.exists
docs.biome.exists
overload 1:
Biome:exists()
Method Property Fluent Description Representation
Return Value a Boolean

Biome.setPos
docs.biome.setpos
overload 1:
Biome:setPos(pos)
Method Property Fluent Description Representation
pos accepts a Vector3
Return Value nil
overload 2:
Biome:setPos(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value nil

Biome.getPos
docs.biome.getpos
overload 1:
Biome:getPos()
Method Property Fluent Description Representation
Return Value a Vector3

Biome.getTemperature
docs.biome.gettemperature
overload 1:
Biome:getTemperature()
Method Property Fluent Description Representation
Return Value a Number

Biome.getFoliageColor
docs.biome.getfoliagecolor
overload 1:
Biome:getFoliageColor()
Method Property Fluent Description Representation
Return Value a Vector3

Biome.getPrecipitation
docs.biome.getprecipitation
overload 1:
Biome:getPrecipitation()
Method Property Fluent Description Representation
Return Value a String

Biome.getGrassColor
docs.biome.getgrasscolor
overload 1:
Biome:getGrassColor()
Method Property Fluent Description Representation
Return Value a Vector3

Biome.getDownfall
docs.biome.getdownfall
overload 1:
Biome:getDownfall()
Method Property Fluent Description Representation
Return Value a Number

Biome.getSkyColor
docs.biome.getskycolor
overload 1:
Biome:getSkyColor()
Method Property Fluent Description Representation
Return Value a Vector3

Biome.getWaterColor
docs.biome.getwatercolor
overload 1:
Biome:getWaterColor()
Method Property Fluent Description Representation
Return Value a Vector3

Biome.isHot
docs.biome.ishot
overload 1:
Biome:isHot()
Method Property Fluent Description Representation
Return Value a Boolean

Biome.getFogColor
docs.biome.getfogcolor
overload 1:
Biome:getFogColor()
Method Property Fluent Description Representation
Return Value a Vector3

Biome.isCold
docs.biome.iscold
overload 1:
Biome:isCold()
Method Property Fluent Description Representation
Return Value a Boolean

Biome.getWaterFogColor
docs.biome.getwaterfogcolor
overload 1:
Biome:getWaterFogColor()
Method Property Fluent Description Representation
Return Value a Vector3

Biome.name
docs.biome.name
field signature:
name
Method Property Fluent Description Representation
Field Type a String

BlockState
docs.blockstate

BlockState.isOpaque
docs.blockstate.isopaque
overload 1:
BlockState:isOpaque()
Method Property Fluent Description Representation
Return Value a Boolean

BlockState.exists
docs.blockstate.exists
overload 1:
BlockState:exists()
Method Property Fluent Description Representation
Return Value a Boolean

BlockState.setPos
docs.blockstate.setpos
overload 1:
BlockState:setPos(pos)
Method Property Fluent Description Representation
pos accepts a Vector3
Return Value nil
overload 2:
BlockState:setPos(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value nil

BlockState.getPos
docs.blockstate.getpos
overload 1:
BlockState:getPos()
Method Property Fluent Description Representation
Return Value a Vector3

BlockState.getFriction
docs.blockstate.getfriction
overload 1:
BlockState:getFriction()
Method Property Fluent Description Representation
Return Value a Number

BlockState.getMapColor
docs.blockstate.getmapcolor
overload 1:
BlockState:getMapColor()
Method Property Fluent Description Representation
Return Value a Vector3

BlockState.getTags
docs.blockstate.gettags
overload 1:
BlockState:getTags()
Method Property Fluent Description Representation
Return Value a table

BlockState.getBlastResistance
docs.blockstate.getblastresistance
overload 1:
BlockState:getBlastResistance()
Method Property Fluent Description Representation
Return Value a Number

BlockState.emitsRedstonePower
docs.blockstate.emitsredstonepower
overload 1:
BlockState:emitsRedstonePower()
Method Property Fluent Description Representation
Return Value a Boolean

BlockState.hasBlockEntity
docs.blockstate.hasblockentity
overload 1:
BlockState:hasBlockEntity()
Method Property Fluent Description Representation
Return Value a Boolean

BlockState.isFullCube
docs.blockstate.isfullcube
overload 1:
BlockState:isFullCube()
Method Property Fluent Description Representation
Return Value a Boolean

BlockState.asItem
docs.blockstate.asitem
overload 1:
BlockState:asItem()
Method Property Fluent Description Representation
Return Value either an ItemStack or nil

BlockState.getCollisionShape
docs.blockstate.getcollisionshape
overload 1:
BlockState:getCollisionShape()
Method Property Fluent Description Representation
Return Value a table

BlockState.getOutlineShape
docs.blockstate.getoutlineshape
overload 1:
BlockState:getOutlineShape()
Method Property Fluent Description Representation
Return Value a table

BlockState.isTranslucent
docs.blockstate.istranslucent
overload 1:
BlockState:isTranslucent()
Method Property Fluent Description Representation
Return Value a Boolean

BlockState.isSolidBlock
docs.blockstate.issolidblock
overload 1:
BlockState:isSolidBlock()
Method Property Fluent Description Representation
Return Value a Boolean

BlockState.getOpacity
docs.blockstate.getopacity
overload 1:
BlockState:getOpacity()
Method Property Fluent Description Representation
Return Value an Integer

BlockState.getEntityData
docs.blockstate.getentitydata
overload 1:
BlockState:getEntityData()
Method Property Fluent Description Representation
Return Value a table

BlockState.getSounds
docs.blockstate.getsounds
overload 1:
BlockState:getSounds()
Method Property Fluent Description Representation
Return Value a table

BlockState.getFluidTags
docs.blockstate.getfluidtags
overload 1:
BlockState:getFluidTags()
Method Property Fluent Description Representation
Return Value a table

BlockState.toStateString
docs.blockstate.tostatestring
overload 1:
BlockState:toStateString()
Method Property Fluent Description Representation
Return Value a String

BlockState.hasEmissiveLighting
docs.blockstate.hasemissivelighting
overload 1:
BlockState:hasEmissiveLighting()
Method Property Fluent Description Representation
Return Value a Boolean

BlockState.getComparatorOutput
docs.blockstate.getcomparatoroutput
overload 1:
BlockState:getComparatorOutput()
Method Property Fluent Description Representation
Return Value an Integer

BlockState.getVelocityMultiplier
docs.blockstate.getvelocitymultiplier
overload 1:
BlockState:getVelocityMultiplier()
Method Property Fluent Description Representation
Return Value a Number

BlockState.getJumpVelocityMultiplier
docs.blockstate.getjumpvelocitymultiplier
overload 1:
BlockState:getJumpVelocityMultiplier()
Method Property Fluent Description Representation
Return Value a Number

BlockState.getHardness
docs.blockstate.gethardness
overload 1:
BlockState:getHardness()
Method Property Fluent Description Representation
Return Value a Number

BlockState.getMaterial
docs.blockstate.getmaterial
overload 1:
BlockState:getMaterial()
Method Property Fluent Description Representation
Return Value a String

BlockState.getLuminance
docs.blockstate.getluminance
overload 1:
BlockState:getLuminance()
Method Property Fluent Description Representation
Return Value an Integer

BlockState.hasCollision
docs.blockstate.hascollision
overload 1:
BlockState:hasCollision()
Method Property Fluent Description Representation
Return Value a Boolean

BlockState.id
docs.blockstate.id
field signature:
id
Method Property Fluent Description Representation
Field Type a String

BlockState.properties
docs.blockstate.properties
field signature:
properties
Method Property Fluent Description Representation
Field Type a table

BlockTask

subclasses RenderTask

docs.blocktask

BlockTask.block
docs.blocktask.block
overload 1:
BlockTask:block(block)
Method Property Fluent Description Representation
block accepts a String
Return Value a RenderTask
overload 2:
BlockTask:block(block)
Method Property Fluent Description Representation
block accepts a BlockState
Return Value a RenderTask

BlockTask.scale

Inherited from RenderTask

docs.blocktask.scale
overload 1:
BlockTask:scale(scale)
Method Property Fluent Description Representation
scale accepts a Vector3
Return Value a RenderTask
overload 2:
BlockTask:scale(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a RenderTask

BlockTask.enabled

Inherited from RenderTask

docs.blocktask.enabled
overload 1:
BlockTask:enabled(bool)
Method Property Fluent Description Representation
bool accepts a Boolean
Return Value a RenderTask

BlockTask.pos

Inherited from RenderTask

docs.blocktask.pos
overload 1:
BlockTask:pos(pos)
Method Property Fluent Description Representation
pos accepts a Vector3
Return Value a RenderTask
overload 2:
BlockTask:pos(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a RenderTask

BlockTask.emissive

Inherited from RenderTask

docs.blocktask.emissive
overload 1:
BlockTask:emissive(bool)
Method Property Fluent Description Representation
bool accepts a Boolean
Return Value a RenderTask

BlockTask.rot

Inherited from RenderTask

docs.blocktask.rot
overload 1:
BlockTask:rot(rot)
Method Property Fluent Description Representation
rot accepts a Vector3
Return Value a RenderTask
overload 2:
BlockTask:rot(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a RenderTask

ClickAction

subclasses Action

docs.clickaction

ClickAction.onRightClick
docs.clickaction.onrightclick
overload 1:
ClickAction:onRightClick(rightFunction)
Method Property Fluent Description Representation
rightFunction accepts a function
Return Value an Action

ClickAction.onLeftClick
docs.clickaction.onleftclick
overload 1:
ClickAction:onLeftClick(leftFunction)
Method Property Fluent Description Representation
leftFunction accepts a function
Return Value an Action

ClickAction.color

Inherited from Action

docs.clickaction.color
overload 1:
ClickAction:color(color)
Method Property Fluent Description Representation
color accepts a Vector3
Return Value an Action
overload 2:
ClickAction:color(r, g, b)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
Return Value an Action

ClickAction.item

Inherited from Action

docs.clickaction.item
overload 1:
ClickAction:item(item)
Method Property Fluent Description Representation
item accepts an ItemStack
Return Value an Action
overload 2:
ClickAction:item(item)
Method Property Fluent Description Representation
item accepts a String
Return Value an Action

ClickAction.title

Inherited from Action

docs.clickaction.title
overload 1:
ClickAction:title(title)
Method Property Fluent Description Representation
title accepts a String
Return Value an Action

ClickAction.hoverColor

Inherited from Action

docs.clickaction.hovercolor
overload 1:
ClickAction:hoverColor(color)
Method Property Fluent Description Representation
color accepts a Vector3
Return Value an Action
overload 2:
ClickAction:hoverColor(r, g, b)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
Return Value an Action

ClickAction.hoverItem

Inherited from Action

docs.clickaction.hoveritem
overload 1:
ClickAction:hoverItem(item)
Method Property Fluent Description Representation
item accepts an ItemStack
Return Value an Action
overload 2:
ClickAction:hoverItem(item)
Method Property Fluent Description Representation
item accepts a String
Return Value an Action

ClickAction.leftClick
docs.clickaction.leftclick
field signature:
leftClick
Method Property Fluent Description Representation
Field Type a function

ClickAction.rightClick
docs.clickaction.rightclick
field signature:
rightClick
Method Property Fluent Description Representation
Field Type a function

Entity
docs.entity

Entity.getName
docs.entity.getname
overload 1:
Entity:getName()
Method Property Fluent Description Representation
Return Value a String

Entity.getType
docs.entity.gettype
overload 1:
Entity:getType()
Method Property Fluent Description Representation
Return Value a String

Entity.exists
docs.entity.exists
overload 1:
Entity:exists()
Method Property Fluent Description Representation
Return Value a Boolean

Entity.getItem
docs.entity.getitem
overload 1:
Entity:getItem(index)
Method Property Fluent Description Representation
index accepts an Integer
Return Value an ItemStack

Entity.getTargetedBlock
docs.entity.gettargetedblock
overload 1:
Entity:getTargetedBlock()
Method Property Fluent Description Representation
Return Value a BlockState
overload 2:
Entity:getTargetedBlock(ignoreLiquids)
Method Property Fluent Description Representation
ignoreLiquids accepts a Boolean
Return Value a BlockState
overload 3:
Entity:getTargetedBlock(ignoreLiquids, distance)
Method Property Fluent Description Representation
ignoreLiquids accepts a Boolean
distance accepts a Number
Return Value a BlockState

Entity.isOnFire
docs.entity.isonfire
overload 1:
Entity:isOnFire()
Method Property Fluent Description Representation
Return Value a Boolean

Entity.getPos
docs.entity.getpos
overload 1:
Entity:getPos()
Method Property Fluent Description Representation
Return Value a Vector3
overload 2:
Entity:getPos(delta)
Method Property Fluent Description Representation
delta accepts a Number
Return Value a Vector3

Entity.getRot
docs.entity.getrot
overload 1:
Entity:getRot()
Method Property Fluent Description Representation
Return Value a Vector2
overload 2:
Entity:getRot(delta)
Method Property Fluent Description Representation
delta accepts a Number
Return Value a Vector2

Entity.getUUID
docs.entity.getuuid
overload 1:
Entity:getUUID()
Method Property Fluent Description Representation
Return Value a String

Entity.getDimensionName
docs.entity.getdimensionname
overload 1:
Entity:getDimensionName()
Method Property Fluent Description Representation
Return Value a String

Entity.getEyeHeight
docs.entity.geteyeheight
overload 1:
Entity:getEyeHeight()
Method Property Fluent Description Representation
Return Value a Number

Entity.getBoundingBox
docs.entity.getboundingbox
overload 1:
Entity:getBoundingBox()
Method Property Fluent Description Representation
Return Value a Vector3

Entity.getFireTicks
docs.entity.getfireticks
overload 1:
Entity:getFireTicks()
Method Property Fluent Description Representation
Return Value an Integer

Entity.isHamburger
docs.entity.ishamburger
overload 1:
Entity:isHamburger()
Method Property Fluent Description Representation
Return Value a Boolean

Entity.getLookDir
docs.entity.getlookdir
overload 1:
Entity:getLookDir()
Method Property Fluent Description Representation
Return Value a Vector3

Entity.getMaxAir
docs.entity.getmaxair
overload 1:
Entity:getMaxAir()
Method Property Fluent Description Representation
Return Value an Integer

Entity.getFrozenTicks
docs.entity.getfrozenticks
overload 1:
Entity:getFrozenTicks()
Method Property Fluent Description Representation
Return Value an Integer

Entity.getPose
docs.entity.getpose
overload 1:
Entity:getPose()
Method Property Fluent Description Representation
Return Value a String

Entity.getVehicle
docs.entity.getvehicle
overload 1:
Entity:getVehicle()
typings.2080559107
Method Property Fluent Description Representation
Return Value

Entity.isOnGround
docs.entity.isonground
overload 1:
Entity:isOnGround()
Method Property Fluent Description Representation
Return Value a Boolean

Entity.getAir
docs.entity.getair
overload 1:
Entity:getAir()
Method Property Fluent Description Representation
Return Value an Integer

Entity.isWet
docs.entity.iswet
overload 1:
Entity:isWet()
Method Property Fluent Description Representation
Return Value a Boolean

Entity.getVelocity
docs.entity.getvelocity
overload 1:
Entity:getVelocity()
Method Property Fluent Description Representation
Return Value a Vector3

Entity.isUnderwater
docs.entity.isunderwater
overload 1:
Entity:isUnderwater()
Method Property Fluent Description Representation
Return Value a Boolean

Entity.isSprinting
docs.entity.issprinting
overload 1:
Entity:isSprinting()
Method Property Fluent Description Representation
Return Value a Boolean

Entity.getEyeY
docs.entity.geteyey
overload 1:
Entity:getEyeY()
Method Property Fluent Description Representation
Return Value a Number

Entity.isSneaking
docs.entity.issneaking
overload 1:
Entity:isSneaking()
Method Property Fluent Description Representation
Return Value a Boolean

Entity.isGlowing
docs.entity.isglowing
overload 1:
Entity:isGlowing()
Method Property Fluent Description Representation
Return Value a Boolean

Entity.isSilent
docs.entity.issilent
overload 1:
Entity:isSilent()
Method Property Fluent Description Representation
Return Value a Boolean

Entity.isInvisible
docs.entity.isinvisible
overload 1:
Entity:isInvisible()
Method Property Fluent Description Representation
Return Value a Boolean

Entity.getVariable
docs.entity.getvariable
overload 1:
Entity:getVariable(key)
Method Property Fluent Description Representation
key accepts a String
Return Value anything

Entity.isInRain
docs.entity.isinrain
overload 1:
Entity:isInRain()
Method Property Fluent Description Representation
Return Value a Boolean

Entity.isInWater
docs.entity.isinwater
overload 1:
Entity:isInWater()
Method Property Fluent Description Representation
Return Value a Boolean

Entity.hasAvatar
docs.entity.hasavatar
overload 1:
Entity:hasAvatar()
Method Property Fluent Description Representation
Return Value a Boolean

Entity.isInLava
docs.entity.isinlava
overload 1:
Entity:isInLava()
Method Property Fluent Description Representation
Return Value a Boolean

Entity.getNbt
docs.entity.getnbt
overload 1:
Entity:getNbt()
Method Property Fluent Description Representation
Return Value a table

Event
docs.event

Event.remove
docs.event.remove
overload 1:
Event:remove()
Method Property Fluent Description Representation
Return Value a Boolean
overload 2:
Event:remove(index)
Method Property Fluent Description Representation
index accepts an Integer
Return Value a Boolean
overload 3:
Event:remove(name)
Method Property Fluent Description Representation
name accepts a String
Return Value a Boolean

Event.clear
docs.event.clear
overload 1:
Event:clear()
Method Property Fluent Description Representation
Return Value nil

Event.register
docs.event.register
overload 1:
Event:register(function)
Method Property Fluent Description Representation
function accepts a function
Return Value nil
overload 2:
Event:register(function, name)
Method Property Fluent Description Representation
function accepts a function
name accepts a String
Return Value nil

Event.getCount
docs.event.getcount
overload 1:
Event:getCount()
Method Property Fluent Description Representation
Return Value an Integer

HostAPI
docs.hostapi

HostAPI.getSlot
docs.hostapi.getslot
overload 1:
HostAPI:getSlot(slot)
Method Property Fluent Description Representation
slot accepts a String
Return Value an ItemStack

HostAPI.setTitle
docs.hostapi.settitle
overload 1:
HostAPI:setTitle(text)
Method Property Fluent Description Representation
text accepts a String
Return Value nil

HostAPI.isHost
docs.hostapi.ishost
overload 1:
HostAPI:isHost()
Method Property Fluent Description Representation
Return Value a Boolean

HostAPI.setActionbar
docs.hostapi.setactionbar
overload 1:
HostAPI:setActionbar(text)
Method Property Fluent Description Representation
text accepts a String
Return Value nil
overload 2:
HostAPI:setActionbar(text, animated)
Method Property Fluent Description Representation
text accepts a String
animated accepts a Boolean
Return Value nil

HostAPI.clearTitle
docs.hostapi.cleartitle
overload 1:
HostAPI:clearTitle()
Method Property Fluent Description Representation
Return Value nil

HostAPI.setSubtitle
docs.hostapi.setsubtitle
overload 1:
HostAPI:setSubtitle(text)
Method Property Fluent Description Representation
text accepts a String
Return Value nil

HostAPI.swingArm
docs.hostapi.swingarm
overload 1:
HostAPI:swingArm(offhand)
Method Property Fluent Description Representation
offhand accepts a Boolean
Return Value nil

HostAPI.getTargetedEntity
docs.hostapi.gettargetedentity
overload 1:
HostAPI:getTargetedEntity()
typings.2080559107
Method Property Fluent Description Representation
Return Value

HostAPI.setChatColor
docs.hostapi.setchatcolor
overload 1:
HostAPI:setChatColor(color)
Method Property Fluent Description Representation
color accepts a Vector3
Return Value nil
overload 2:
HostAPI:setChatColor(r, g, b)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
Return Value nil

HostAPI.setTitleTimes
docs.hostapi.settitletimes
overload 1:
HostAPI:setTitleTimes(timesData)
Method Property Fluent Description Representation
timesData accepts a Vector3
Return Value nil
overload 2:
HostAPI:setTitleTimes(fadeInTime, stayTime, fadeOutTime)
Method Property Fluent Description Representation
fadeInTime accepts an Integer
stayTime accepts an Integer
fadeOutTime accepts an Integer
Return Value nil

HostAPI.getChatText
docs.hostapi.getchattext
overload 1:
HostAPI:getChatText()
Method Property Fluent Description Representation
Return Value a String

HostAPI.setChatText
docs.hostapi.setchattext
overload 1:
HostAPI:setChatText(text)
Method Property Fluent Description Representation
text accepts a String
Return Value nil

HostAPI.sendChatMessage
docs.hostapi.sendchatmessage
overload 1:
HostAPI:sendChatMessage(text)
Method Property Fluent Description Representation
text accepts a String
Return Value nil

HostAPI.unlockCursor
docs.hostapi.unlockcursor
field signature:
unlockCursor
Method Property Fluent Description Representation
Field Type a Boolean

ItemStack
docs.itemstack

ItemStack.getName
docs.itemstack.getname
overload 1:
ItemStack:getName()
Method Property Fluent Description Representation
Return Value a String

ItemStack.exists
docs.itemstack.exists
overload 1:
ItemStack:exists()
Method Property Fluent Description Representation
Return Value a Boolean

ItemStack.getCount
docs.itemstack.getcount
overload 1:
ItemStack:getCount()
Method Property Fluent Description Representation
Return Value an Integer

ItemStack.getTags
docs.itemstack.gettags
overload 1:
ItemStack:getTags()
Method Property Fluent Description Representation
Return Value a table

ItemStack.getDamage
docs.itemstack.getdamage
overload 1:
ItemStack:getDamage()
Method Property Fluent Description Representation
Return Value an Integer

ItemStack.hasGlint
docs.itemstack.hasglint
overload 1:
ItemStack:hasGlint()
Method Property Fluent Description Representation
Return Value a Boolean

ItemStack.getCooldown
docs.itemstack.getcooldown
overload 1:
ItemStack:getCooldown()
Method Property Fluent Description Representation
Return Value an Integer

ItemStack.isBlockItem
docs.itemstack.isblockitem
overload 1:
ItemStack:isBlockItem()
Method Property Fluent Description Representation
Return Value a Boolean

ItemStack.isFood
docs.itemstack.isfood
overload 1:
ItemStack:isFood()
Method Property Fluent Description Representation
Return Value a Boolean

ItemStack.getMaxCount
docs.itemstack.getmaxcount
overload 1:
ItemStack:getMaxCount()
Method Property Fluent Description Representation
Return Value an Integer

ItemStack.isStackable
docs.itemstack.isstackable
overload 1:
ItemStack:isStackable()
Method Property Fluent Description Representation
Return Value a Boolean

ItemStack.isDamageable
docs.itemstack.isdamageable
overload 1:
ItemStack:isDamageable()
Method Property Fluent Description Representation
Return Value a Boolean

ItemStack.getRepairCost
docs.itemstack.getrepaircost
overload 1:
ItemStack:getRepairCost()
Method Property Fluent Description Representation
Return Value an Integer

ItemStack.getUseAction
docs.itemstack.getuseaction
overload 1:
ItemStack:getUseAction()
Method Property Fluent Description Representation
Return Value a String

ItemStack.toStackString
docs.itemstack.tostackstring
overload 1:
ItemStack:toStackString()
Method Property Fluent Description Representation
Return Value a String

ItemStack.isEnchantable
docs.itemstack.isenchantable
overload 1:
ItemStack:isEnchantable()
Method Property Fluent Description Representation
Return Value a Boolean

ItemStack.getUseDuration
docs.itemstack.getuseduration
overload 1:
ItemStack:getUseDuration()
Method Property Fluent Description Representation
Return Value an Integer

ItemStack.getRarity
docs.itemstack.getrarity
overload 1:
ItemStack:getRarity()
Method Property Fluent Description Representation
Return Value a String

ItemStack.getMaxDamage
docs.itemstack.getmaxdamage
overload 1:
ItemStack:getMaxDamage()
Method Property Fluent Description Representation
Return Value an Integer

ItemStack.id
docs.itemstack.id
field signature:
id
Method Property Fluent Description Representation
Field Type a String

ItemStack.tag
docs.itemstack.tag
field signature:
tag
Method Property Fluent Description Representation
Field Type a table

ItemTask

subclasses RenderTask

docs.itemtask

ItemTask.item
docs.itemtask.item
overload 1:
ItemTask:item(item)
Method Property Fluent Description Representation
item accepts a String
Return Value a RenderTask
overload 2:
ItemTask:item(item)
Method Property Fluent Description Representation
item accepts an ItemStack
Return Value a RenderTask

ItemTask.renderType
docs.itemtask.rendertype
overload 1:
ItemTask:renderType(renderType)
Method Property Fluent Description Representation
renderType accepts a String
Return Value a RenderTask

ItemTask.scale

Inherited from RenderTask

docs.itemtask.scale
overload 1:
ItemTask:scale(scale)
Method Property Fluent Description Representation
scale accepts a Vector3
Return Value a RenderTask
overload 2:
ItemTask:scale(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a RenderTask

ItemTask.enabled

Inherited from RenderTask

docs.itemtask.enabled
overload 1:
ItemTask:enabled(bool)
Method Property Fluent Description Representation
bool accepts a Boolean
Return Value a RenderTask

ItemTask.pos

Inherited from RenderTask

docs.itemtask.pos
overload 1:
ItemTask:pos(pos)
Method Property Fluent Description Representation
pos accepts a Vector3
Return Value a RenderTask
overload 2:
ItemTask:pos(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a RenderTask

ItemTask.emissive

Inherited from RenderTask

docs.itemtask.emissive
overload 1:
ItemTask:emissive(bool)
Method Property Fluent Description Representation
bool accepts a Boolean
Return Value a RenderTask

ItemTask.rot

Inherited from RenderTask

docs.itemtask.rot
overload 1:
ItemTask:rot(rot)
Method Property Fluent Description Representation
rot accepts a Vector3
Return Value a RenderTask
overload 2:
ItemTask:rot(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a RenderTask

Keybind
docs.keybind

Keybind.getName
docs.keybind.getname
overload 1:
Keybind:getName()
Method Property Fluent Description Representation
Return Value a String

Keybind.getKey
docs.keybind.getkey
overload 1:
Keybind:getKey()
Method Property Fluent Description Representation
Return Value a String

Keybind.isDefault
docs.keybind.isdefault
overload 1:
Keybind:isDefault()
Method Property Fluent Description Representation
Return Value a Boolean

Keybind.isPressed
docs.keybind.ispressed
overload 1:
Keybind:isPressed()
Method Property Fluent Description Representation
Return Value a Boolean

Keybind.getKeyName
docs.keybind.getkeyname
overload 1:
Keybind:getKeyName()
Method Property Fluent Description Representation
Return Value a String

Keybind.setKey
docs.keybind.setkey
overload 1:
Keybind:setKey(key)
Method Property Fluent Description Representation
key accepts a String
Return Value nil

Keybind.onPress
docs.keybind.onpress
field signature:
onPress
Method Property Fluent Description Representation
Field Type a function

Keybind.onRelease
docs.keybind.onrelease
field signature:
onRelease
Method Property Fluent Description Representation
Field Type a function

Keybind.enabled
docs.keybind.enabled
field signature:
enabled
Method Property Fluent Description Representation
Field Type a Boolean

Keybind.gui
docs.keybind.gui
field signature:
gui
Method Property Fluent Description Representation
Field Type a Boolean

Keybind.override
docs.keybind.override
field signature:
override
Method Property Fluent Description Representation
Field Type a Boolean

KeybindAPI
docs.keybindapi

KeybindAPI.create
docs.keybindapi.create
overload 1:
KeybindAPI:create(name, key)
Method Property Fluent Description Representation
name accepts a String
key accepts a String
Return Value a Keybind
overload 2:
KeybindAPI:create(name, key, gui)
Method Property Fluent Description Representation
name accepts a String
key accepts a String
gui accepts a Boolean
Return Value a Keybind
overload 3:
KeybindAPI:create(name, key, gui, override)
Method Property Fluent Description Representation
name accepts a String
key accepts a String
gui accepts a Boolean
override accepts a Boolean
Return Value a Keybind

KeybindAPI.getVanillaKey
docs.keybindapi.getvanillakey
overload 1:
KeybindAPI:getVanillaKey(id)
Method Property Fluent Description Representation
id accepts a KeyIDs
Return Value a String

LivingEntity

subclasses Entity

docs.livingentity

LivingEntity.getDeathTime
docs.livingentity.getdeathtime
overload 1:
LivingEntity:getDeathTime()
Method Property Fluent Description Representation
Return Value an Integer

LivingEntity.getMaxHealth
docs.livingentity.getmaxhealth
overload 1:
LivingEntity:getMaxHealth()
Method Property Fluent Description Representation
Return Value a Number

LivingEntity.getArmor
docs.livingentity.getarmor
overload 1:
LivingEntity:getArmor()
Method Property Fluent Description Representation
Return Value an Integer

LivingEntity.getStatusEffects
docs.livingentity.getstatuseffects
overload 1:
LivingEntity:getStatusEffects()
Method Property Fluent Description Representation
Return Value a table

LivingEntity.getHeldItem
docs.livingentity.gethelditem
overload 1:
LivingEntity:getHeldItem()
Method Property Fluent Description Representation
Return Value an ItemStack
overload 2:
LivingEntity:getHeldItem(offhand)
Method Property Fluent Description Representation
offhand accepts a Boolean
Return Value an ItemStack

LivingEntity.getBodyYaw
docs.livingentity.getbodyyaw
overload 1:
LivingEntity:getBodyYaw()
Method Property Fluent Description Representation
Return Value a Number
overload 2:
LivingEntity:getBodyYaw(delta)
Method Property Fluent Description Representation
delta accepts a Number
Return Value a Number

LivingEntity.getHealth
docs.livingentity.gethealth
overload 1:
LivingEntity:getHealth()
Method Property Fluent Description Representation
Return Value a Number

LivingEntity.getStingerCount
docs.livingentity.getstingercount
overload 1:
LivingEntity:getStingerCount()
Method Property Fluent Description Representation
Return Value an Integer

LivingEntity.isClimbing
docs.livingentity.isclimbing
overload 1:
LivingEntity:isClimbing()
Method Property Fluent Description Representation
Return Value a Boolean

LivingEntity.getActiveHand
docs.livingentity.getactivehand
overload 1:
LivingEntity:getActiveHand()
Method Property Fluent Description Representation
Return Value a String

LivingEntity.getActiveItem
docs.livingentity.getactiveitem
overload 1:
LivingEntity:getActiveItem()
Method Property Fluent Description Representation
Return Value an ItemStack

LivingEntity.isLeftHanded
docs.livingentity.islefthanded
overload 1:
LivingEntity:isLeftHanded()
Method Property Fluent Description Representation
Return Value a Boolean

LivingEntity.getArrowCount
docs.livingentity.getarrowcount
overload 1:
LivingEntity:getArrowCount()
Method Property Fluent Description Representation
Return Value an Integer

LivingEntity.isUsingItem
docs.livingentity.isusingitem
overload 1:
LivingEntity:isUsingItem()
Method Property Fluent Description Representation
Return Value a Boolean

LivingEntity.getName

Inherited from Entity

docs.livingentity.getname
overload 1:
LivingEntity:getName()
Method Property Fluent Description Representation
Return Value a String

LivingEntity.getType

Inherited from Entity

docs.livingentity.gettype
overload 1:
LivingEntity:getType()
Method Property Fluent Description Representation
Return Value a String

LivingEntity.exists

Inherited from Entity

docs.livingentity.exists
overload 1:
LivingEntity:exists()
Method Property Fluent Description Representation
Return Value a Boolean

LivingEntity.getItem

Inherited from Entity

docs.livingentity.getitem
overload 1:
LivingEntity:getItem(index)
Method Property Fluent Description Representation
index accepts an Integer
Return Value an ItemStack

LivingEntity.getTargetedBlock

Inherited from Entity

docs.livingentity.gettargetedblock
overload 1:
LivingEntity:getTargetedBlock()
Method Property Fluent Description Representation
Return Value a BlockState
overload 2:
LivingEntity:getTargetedBlock(ignoreLiquids)
Method Property Fluent Description Representation
ignoreLiquids accepts a Boolean
Return Value a BlockState
overload 3:
LivingEntity:getTargetedBlock(ignoreLiquids, distance)
Method Property Fluent Description Representation
ignoreLiquids accepts a Boolean
distance accepts a Number
Return Value a BlockState

LivingEntity.isOnFire

Inherited from Entity

docs.livingentity.isonfire
overload 1:
LivingEntity:isOnFire()
Method Property Fluent Description Representation
Return Value a Boolean

LivingEntity.getPos

Inherited from Entity

docs.livingentity.getpos
overload 1:
LivingEntity:getPos()
Method Property Fluent Description Representation
Return Value a Vector3
overload 2:
LivingEntity:getPos(delta)
Method Property Fluent Description Representation
delta accepts a Number
Return Value a Vector3

LivingEntity.getRot

Inherited from Entity

docs.livingentity.getrot
overload 1:
LivingEntity:getRot()
Method Property Fluent Description Representation
Return Value a Vector2
overload 2:
LivingEntity:getRot(delta)
Method Property Fluent Description Representation
delta accepts a Number
Return Value a Vector2

LivingEntity.getUUID

Inherited from Entity

docs.livingentity.getuuid
overload 1:
LivingEntity:getUUID()
Method Property Fluent Description Representation
Return Value a String

LivingEntity.getDimensionName

Inherited from Entity

docs.livingentity.getdimensionname
overload 1:
LivingEntity:getDimensionName()
Method Property Fluent Description Representation
Return Value a String

LivingEntity.getEyeHeight

Inherited from Entity

docs.livingentity.geteyeheight
overload 1:
LivingEntity:getEyeHeight()
Method Property Fluent Description Representation
Return Value a Number

LivingEntity.getBoundingBox

Inherited from Entity

docs.livingentity.getboundingbox
overload 1:
LivingEntity:getBoundingBox()
Method Property Fluent Description Representation
Return Value a Vector3

LivingEntity.getFireTicks

Inherited from Entity

docs.livingentity.getfireticks
overload 1:
LivingEntity:getFireTicks()
Method Property Fluent Description Representation
Return Value an Integer

LivingEntity.isHamburger

Inherited from Entity

docs.livingentity.ishamburger
overload 1:
LivingEntity:isHamburger()
Method Property Fluent Description Representation
Return Value a Boolean

LivingEntity.getLookDir

Inherited from Entity

docs.livingentity.getlookdir
overload 1:
LivingEntity:getLookDir()
Method Property Fluent Description Representation
Return Value a Vector3

LivingEntity.getMaxAir

Inherited from Entity

docs.livingentity.getmaxair
overload 1:
LivingEntity:getMaxAir()
Method Property Fluent Description Representation
Return Value an Integer

LivingEntity.getFrozenTicks

Inherited from Entity

docs.livingentity.getfrozenticks
overload 1:
LivingEntity:getFrozenTicks()
Method Property Fluent Description Representation
Return Value an Integer

LivingEntity.getPose

Inherited from Entity

docs.livingentity.getpose
overload 1:
LivingEntity:getPose()
Method Property Fluent Description Representation
Return Value a String

LivingEntity.getVehicle

Inherited from Entity

docs.livingentity.getvehicle
overload 1:
LivingEntity:getVehicle()
typings.2080559107
Method Property Fluent Description Representation
Return Value

LivingEntity.isOnGround

Inherited from Entity

docs.livingentity.isonground
overload 1:
LivingEntity:isOnGround()
Method Property Fluent Description Representation
Return Value a Boolean

LivingEntity.getAir

Inherited from Entity

docs.livingentity.getair
overload 1:
LivingEntity:getAir()
Method Property Fluent Description Representation
Return Value an Integer

LivingEntity.isWet

Inherited from Entity

docs.livingentity.iswet
overload 1:
LivingEntity:isWet()
Method Property Fluent Description Representation
Return Value a Boolean

LivingEntity.getVelocity

Inherited from Entity

docs.livingentity.getvelocity
overload 1:
LivingEntity:getVelocity()
Method Property Fluent Description Representation
Return Value a Vector3

LivingEntity.isUnderwater

Inherited from Entity

docs.livingentity.isunderwater
overload 1:
LivingEntity:isUnderwater()
Method Property Fluent Description Representation
Return Value a Boolean

LivingEntity.isSprinting

Inherited from Entity

docs.livingentity.issprinting
overload 1:
LivingEntity:isSprinting()
Method Property Fluent Description Representation
Return Value a Boolean

LivingEntity.getEyeY

Inherited from Entity

docs.livingentity.geteyey
overload 1:
LivingEntity:getEyeY()
Method Property Fluent Description Representation
Return Value a Number

LivingEntity.isSneaking

Inherited from Entity

docs.livingentity.issneaking
overload 1:
LivingEntity:isSneaking()
Method Property Fluent Description Representation
Return Value a Boolean

LivingEntity.isGlowing

Inherited from Entity

docs.livingentity.isglowing
overload 1:
LivingEntity:isGlowing()
Method Property Fluent Description Representation
Return Value a Boolean

LivingEntity.isSilent

Inherited from Entity

docs.livingentity.issilent
overload 1:
LivingEntity:isSilent()
Method Property Fluent Description Representation
Return Value a Boolean

LivingEntity.isInvisible

Inherited from Entity

docs.livingentity.isinvisible
overload 1:
LivingEntity:isInvisible()
Method Property Fluent Description Representation
Return Value a Boolean

LivingEntity.getVariable

Inherited from Entity

docs.livingentity.getvariable
overload 1:
LivingEntity:getVariable(key)
Method Property Fluent Description Representation
key accepts a String
Return Value anything

LivingEntity.isInRain

Inherited from Entity

docs.livingentity.isinrain
overload 1:
LivingEntity:isInRain()
Method Property Fluent Description Representation
Return Value a Boolean

LivingEntity.isInWater

Inherited from Entity

docs.livingentity.isinwater
overload 1:
LivingEntity:isInWater()
Method Property Fluent Description Representation
Return Value a Boolean

LivingEntity.hasAvatar

Inherited from Entity

docs.livingentity.hasavatar
overload 1:
LivingEntity:hasAvatar()
Method Property Fluent Description Representation
Return Value a Boolean

LivingEntity.isInLava

Inherited from Entity

docs.livingentity.isinlava
overload 1:
LivingEntity:isInLava()
Method Property Fluent Description Representation
Return Value a Boolean

LivingEntity.getNbt

Inherited from Entity

docs.livingentity.getnbt
overload 1:
LivingEntity:getNbt()
Method Property Fluent Description Representation
Return Value a table

Matrix2
docs.matrix2
Meta name Allowed other parameters Meta execution method
__le
  • Matrix2
x <= y
__eq
  • Matrix2
x == y
__mul
  • Number
  • Matrix2
  • Vector2
x * y
__add
  • Matrix2
x + y
__sub
  • Matrix2
x - y
__len
#x

Matrix2.scale
docs.matrix2.scale
overload 1:
Matrix2:scale(vec)
Method Property Fluent Description Representation
vec accepts a Vector2
Return Value nil
overload 2:
Matrix2:scale(x, y)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
Return Value nil

Matrix2.reset
docs.matrix2.reset
overload 1:
Matrix2:reset()
Method Property Fluent Description Representation
Return Value nil

Matrix2.rotate
docs.matrix2.rotate
overload 1:
Matrix2:rotate(angle)
Method Property Fluent Description Representation
angle accepts a Number
Return Value nil

Matrix2.getColumn
docs.matrix2.getcolumn
overload 1:
Matrix2:getColumn(col)
Method Property Fluent Description Representation
col accepts an Integer
Return Value a Vector2

Matrix2.getInverse
docs.matrix2.getinverse
overload 1:
Matrix2:getInverse()
Method Property Fluent Description Representation
Return Value a Matrix2

Matrix2.det
docs.matrix2.det
overload 1:
Matrix2:det()
Method Property Fluent Description Representation
Return Value a Number

Matrix2.getTranspose
docs.matrix2.gettranspose
overload 1:
Matrix2:getTranspose()
Method Property Fluent Description Representation
Return Value a Matrix2

Matrix2.getRow
docs.matrix2.getrow
overload 1:
Matrix2:getRow(row)
Method Property Fluent Description Representation
row accepts an Integer
Return Value a Vector2

Matrix2.invert
docs.matrix2.invert
overload 1:
Matrix2:invert()
Method Property Fluent Description Representation
Return Value nil

Matrix2.transpose
docs.matrix2.transpose
overload 1:
Matrix2:transpose()
Method Property Fluent Description Representation
Return Value nil

Matrix2.vRC
docs.matrix2.vrc
field signature:
vRC
Method Property Fluent Description Representation
Field Type a Number

Matrix3
docs.matrix3
Meta name Allowed other parameters Meta execution method
__le
  • Matrix3
x <= y
__eq
  • Matrix3
x == y
__mul
  • Number
  • Matrix3
  • Vector3
x * y
__add
  • Matrix3
x + y
__sub
  • Matrix3
x - y
__len
#x

Matrix3.scale
docs.matrix3.scale
overload 1:
Matrix3:scale(vec)
Method Property Fluent Description Representation
vec accepts a Vector3
Return Value nil
overload 2:
Matrix3:scale(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value nil

Matrix3.reset
docs.matrix3.reset
overload 1:
Matrix3:reset()
Method Property Fluent Description Representation
Return Value nil

Matrix3.rotate
docs.matrix3.rotate
overload 1:
Matrix3:rotate(vec)
Method Property Fluent Description Representation
vec accepts a Vector3
Return Value nil
overload 2:
Matrix3:rotate(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value nil

Matrix3.getColumn
docs.matrix3.getcolumn
overload 1:
Matrix3:getColumn(col)
Method Property Fluent Description Representation
col accepts an Integer
Return Value a Vector3

Matrix3.getInverse
docs.matrix3.getinverse
overload 1:
Matrix3:getInverse()
Method Property Fluent Description Representation
Return Value a Matrix3

Matrix3.det
docs.matrix3.det
overload 1:
Matrix3:det()
Method Property Fluent Description Representation
Return Value a Number

Matrix3.getTranspose
docs.matrix3.gettranspose
overload 1:
Matrix3:getTranspose()
Method Property Fluent Description Representation
Return Value a Matrix3

Matrix3.getRow
docs.matrix3.getrow
overload 1:
Matrix3:getRow(row)
Method Property Fluent Description Representation
row accepts an Integer
Return Value a Vector3

Matrix3.translate
docs.matrix3.translate
overload 1:
Matrix3:translate(vec)
Method Property Fluent Description Representation
vec accepts a Vector2
Return Value nil
overload 2:
Matrix3:translate(x, y)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
Return Value nil

Matrix3.invert
docs.matrix3.invert
overload 1:
Matrix3:invert()
Method Property Fluent Description Representation
Return Value nil

Matrix3.transpose
docs.matrix3.transpose
overload 1:
Matrix3:transpose()
Method Property Fluent Description Representation
Return Value nil

Matrix3.vRC
docs.matrix3.vrc
field signature:
vRC
Method Property Fluent Description Representation
Field Type a Number

Matrix4
docs.matrix4
Meta name Allowed other parameters Meta execution method
__le
  • Matrix4
x <= y
__eq
  • Matrix4
x == y
__mul
  • Number
  • Matrix4
  • Vector4
x * y
__add
  • Matrix4
x + y
__sub
  • Matrix4
x - y
__len
#x

Matrix4.scale
docs.matrix4.scale
overload 1:
Matrix4:scale(vec)
Method Property Fluent Description Representation
vec accepts a Vector3
Return Value nil
overload 2:
Matrix4:scale(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value nil

Matrix4.reset
docs.matrix4.reset
overload 1:
Matrix4:reset()
Method Property Fluent Description Representation
Return Value nil

Matrix4.rotate
docs.matrix4.rotate
overload 1:
Matrix4:rotate(vec)
Method Property Fluent Description Representation
vec accepts a Vector3
Return Value nil
overload 2:
Matrix4:rotate(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value nil

Matrix4.getColumn
docs.matrix4.getcolumn
overload 1:
Matrix4:getColumn(col)
Method Property Fluent Description Representation
col accepts an Integer
Return Value a Vector4

Matrix4.getInverse
docs.matrix4.getinverse
overload 1:
Matrix4:getInverse()
Method Property Fluent Description Representation
Return Value a Matrix4

Matrix4.det
docs.matrix4.det
overload 1:
Matrix4:det()
Method Property Fluent Description Representation
Return Value a Number

Matrix4.getTranspose
docs.matrix4.gettranspose
overload 1:
Matrix4:getTranspose()
Method Property Fluent Description Representation
Return Value a Matrix4

Matrix4.getRow
docs.matrix4.getrow
overload 1:
Matrix4:getRow(row)
Method Property Fluent Description Representation
row accepts an Integer
Return Value a Vector4

Matrix4.translate
docs.matrix4.translate
overload 1:
Matrix4:translate(vec)
Method Property Fluent Description Representation
vec accepts a Vector3
Return Value nil
overload 2:
Matrix4:translate(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value nil

Matrix4.invert
docs.matrix4.invert
overload 1:
Matrix4:invert()
Method Property Fluent Description Representation
Return Value nil

Matrix4.transpose
docs.matrix4.transpose
overload 1:
Matrix4:transpose()
Method Property Fluent Description Representation
Return Value nil

Matrix4.vRC
docs.matrix4.vrc
field signature:
vRC
Method Property Fluent Description Representation
Field Type a Number

MetaAPI
docs.metaapi

MetaAPI.getName
docs.metaapi.getname
overload 1:
MetaAPI:getName()
Method Property Fluent Description Representation
Return Value a String

MetaAPI.store
docs.metaapi.store
overload 1:
MetaAPI:store(key, value)
Method Property Fluent Description Representation
key accepts a String
value accepts anything
Return Value nil

MetaAPI.getSize
docs.metaapi.getsize
overload 1:
MetaAPI:getSize()
Method Property Fluent Description Representation
Return Value a Number

MetaAPI.getVersion
docs.metaapi.getversion
overload 1:
MetaAPI:getVersion()
Method Property Fluent Description Representation
Return Value a String

MetaAPI.setColor
docs.metaapi.setcolor
overload 1:
MetaAPI:setColor(color)
Method Property Fluent Description Representation
color accepts a Vector3
Return Value nil
overload 2:
MetaAPI:setColor(r, g, b)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
Return Value nil

MetaAPI.getAuthors
docs.metaapi.getauthors
overload 1:
MetaAPI:getAuthors()
Method Property Fluent Description Representation
Return Value a String

MetaAPI.hasTexture
docs.metaapi.hastexture
overload 1:
MetaAPI:hasTexture()
Method Property Fluent Description Representation
Return Value a Boolean

MetaAPI.hasScriptError
docs.metaapi.hasscripterror
overload 1:
MetaAPI:hasScriptError()
Method Property Fluent Description Representation
Return Value a Boolean

MetaAPI.getInitCount
docs.metaapi.getinitcount
overload 1:
MetaAPI:getInitCount()
Method Property Fluent Description Representation
Return Value an Integer

MetaAPI.getTickCount
docs.metaapi.gettickcount
overload 1:
MetaAPI:getTickCount()
Method Property Fluent Description Representation
Return Value an Integer

MetaAPI.getMaxInitCount
docs.metaapi.getmaxinitcount
overload 1:
MetaAPI:getMaxInitCount()
Method Property Fluent Description Representation
Return Value an Integer

MetaAPI.getMaxTickCount
docs.metaapi.getmaxtickcount
overload 1:
MetaAPI:getMaxTickCount()
Method Property Fluent Description Representation
Return Value an Integer

MetaAPI.getRenderCount
docs.metaapi.getrendercount
overload 1:
MetaAPI:getRenderCount()
Method Property Fluent Description Representation
Return Value an Integer

MetaAPI.getWorldTickCount
docs.metaapi.getworldtickcount
overload 1:
MetaAPI:getWorldTickCount()
Method Property Fluent Description Representation
Return Value an Integer

MetaAPI.getMaxScriptMemory
docs.metaapi.getmaxscriptmemory
overload 1:
MetaAPI:getMaxScriptMemory()
Method Property Fluent Description Representation
Return Value an Integer

MetaAPI.getMaxSounds
docs.metaapi.getmaxsounds
overload 1:
MetaAPI:getMaxSounds()
Method Property Fluent Description Representation
Return Value an Integer

MetaAPI.getMaxRenderCount
docs.metaapi.getmaxrendercount
overload 1:
MetaAPI:getMaxRenderCount()
Method Property Fluent Description Representation
Return Value an Integer

MetaAPI.getRemainingSounds
docs.metaapi.getremainingsounds
overload 1:
MetaAPI:getRemainingSounds()
Method Property Fluent Description Representation
Return Value an Integer

MetaAPI.getComplexity
docs.metaapi.getcomplexity
overload 1:
MetaAPI:getComplexity()
Method Property Fluent Description Representation
Return Value an Integer

MetaAPI.getScriptMemory
docs.metaapi.getscriptmemory
overload 1:
MetaAPI:getScriptMemory()
Method Property Fluent Description Representation
Return Value an Integer

MetaAPI.getMaxComplexity
docs.metaapi.getmaxcomplexity
overload 1:
MetaAPI:getMaxComplexity()
Method Property Fluent Description Representation
Return Value an Integer

MetaAPI.getMaxParticles
docs.metaapi.getmaxparticles
overload 1:
MetaAPI:getMaxParticles()
Method Property Fluent Description Representation
Return Value an Integer

MetaAPI.canEditNameplate
docs.metaapi.caneditnameplate
overload 1:
MetaAPI:canEditNameplate()
Method Property Fluent Description Representation
Return Value a Boolean

MetaAPI.canRenderOffscreen
docs.metaapi.canrenderoffscreen
overload 1:
MetaAPI:canRenderOffscreen()
Method Property Fluent Description Representation
Return Value a Boolean

MetaAPI.canUseCustomSounds
docs.metaapi.canusecustomsounds
overload 1:
MetaAPI:canUseCustomSounds()
Method Property Fluent Description Representation
Return Value a Boolean

MetaAPI.getColor
docs.metaapi.getcolor
overload 1:
MetaAPI:getColor()
Method Property Fluent Description Representation
Return Value a String

MetaAPI.getRemainingParticles
docs.metaapi.getremainingparticles
overload 1:
MetaAPI:getRemainingParticles()
Method Property Fluent Description Representation
Return Value an Integer

MetaAPI.getWorldRenderCount
docs.metaapi.getworldrendercount
overload 1:
MetaAPI:getWorldRenderCount()
Method Property Fluent Description Representation
Return Value an Integer

MetaAPI.getAnimationComplexity
docs.metaapi.getanimationcomplexity
overload 1:
MetaAPI:getAnimationComplexity()
Method Property Fluent Description Representation
Return Value an Integer

MetaAPI.canEditVanillaModel
docs.metaapi.caneditvanillamodel
overload 1:
MetaAPI:canEditVanillaModel()
Method Property Fluent Description Representation
Return Value a Boolean

MetaAPI.getMaxAnimationComplexity
docs.metaapi.getmaxanimationcomplexity
overload 1:
MetaAPI:getMaxAnimationComplexity()
Method Property Fluent Description Representation
Return Value an Integer

MetaAPI.getMaxWorldRenderCount
docs.metaapi.getmaxworldrendercount
overload 1:
MetaAPI:getMaxWorldRenderCount()
Method Property Fluent Description Representation
Return Value an Integer

MetaAPI.getMaxWorldTickCount
docs.metaapi.getmaxworldtickcount
overload 1:
MetaAPI:getMaxWorldTickCount()
Method Property Fluent Description Representation
Return Value an Integer

NameplateCustomization
docs.nameplatecustomization

NameplateCustomization.setScale
docs.nameplatecustomization.setscale
overload 1:
NameplateCustomization:setScale(scale)
Method Property Fluent Description Representation
scale accepts a Vector3
Return Value nil
overload 2:
NameplateCustomization:setScale(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value nil

NameplateCustomization.getText
docs.nameplatecustomization.gettext
overload 1:
NameplateCustomization:getText()
Method Property Fluent Description Representation
Return Value a String

NameplateCustomization.setText
docs.nameplatecustomization.settext
overload 1:
NameplateCustomization:setText(text)
Method Property Fluent Description Representation
text accepts a String
Return Value nil

NameplateCustomization.setVisible
docs.nameplatecustomization.setvisible
overload 1:
NameplateCustomization:setVisible(visible)
Method Property Fluent Description Representation
visible accepts a Boolean
Return Value nil

NameplateCustomization.setPos
docs.nameplatecustomization.setpos
overload 1:
NameplateCustomization:setPos(pos)
Method Property Fluent Description Representation
pos accepts a Vector3
Return Value nil
overload 2:
NameplateCustomization:setPos(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value nil

NameplateCustomization.getScale
docs.nameplatecustomization.getscale
overload 1:
NameplateCustomization:getScale()
Method Property Fluent Description Representation
Return Value a Vector3

NameplateCustomization.getPos
docs.nameplatecustomization.getpos
overload 1:
NameplateCustomization:getPos()
Method Property Fluent Description Representation
Return Value a Vector3

NameplateCustomization.isVisible
docs.nameplatecustomization.isvisible
overload 1:
NameplateCustomization:isVisible()
Method Property Fluent Description Representation
Return Value a Boolean

Page
docs.page

Page.newAction
docs.page.newaction
overload 1:
Page:newAction()
Method Property Fluent Description Representation
Return Value an Action
overload 2:
Page:newAction(index)
Method Property Fluent Description Representation
index accepts an Integer
Return Value an Action

Page.getAction
Example by applejuice:
local action = myPage:getAction(1)
docs.page.getaction
overload 1:
Page:getAction(index)
Method Property Fluent Description Representation
index accepts an Integer
Return Value an Action

Page.newScroll
docs.page.newscroll
overload 1:
Page:newScroll()
Method Property Fluent Description Representation
Return Value an Action
overload 2:
Page:newScroll(index)
Method Property Fluent Description Representation
index accepts an Integer
Return Value an Action

Page.newToggle
docs.page.newtoggle
overload 1:
Page:newToggle()
Method Property Fluent Description Representation
Return Value an Action
overload 2:
Page:newToggle(index)
Method Property Fluent Description Representation
index accepts an Integer
Return Value an Action

RenderTask
docs.rendertask

RenderTask.scale
docs.rendertask.scale
overload 1:
RenderTask:scale(scale)
Method Property Fluent Description Representation
scale accepts a Vector3
Return Value a RenderTask
overload 2:
RenderTask:scale(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a RenderTask

RenderTask.enabled
docs.rendertask.enabled
overload 1:
RenderTask:enabled(bool)
Method Property Fluent Description Representation
bool accepts a Boolean
Return Value a RenderTask

RenderTask.pos
docs.rendertask.pos
overload 1:
RenderTask:pos(pos)
Method Property Fluent Description Representation
pos accepts a Vector3
Return Value a RenderTask
overload 2:
RenderTask:pos(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a RenderTask

RenderTask.emissive
docs.rendertask.emissive
overload 1:
RenderTask:emissive(bool)
Method Property Fluent Description Representation
bool accepts a Boolean
Return Value a RenderTask

RenderTask.rot
docs.rendertask.rot
overload 1:
RenderTask:rot(rot)
Method Property Fluent Description Representation
rot accepts a Vector3
Return Value a RenderTask
overload 2:
RenderTask:rot(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a RenderTask

RendererAPI
docs.rendererapi

RendererAPI.isCameraBackwards
docs.rendererapi.iscamerabackwards
overload 1:
RendererAPI:isCameraBackwards()
Method Property Fluent Description Representation
Return Value a Boolean

RendererAPI.setShadowRadius
docs.rendererapi.setshadowradius
overload 1:
RendererAPI:setShadowRadius(radius)
Method Property Fluent Description Representation
radius accepts a Number
Return Value nil

RendererAPI.getShadowRadius
docs.rendererapi.getshadowradius
overload 1:
RendererAPI:getShadowRadius()
Method Property Fluent Description Representation
Return Value a Number

RendererAPI.setCameraBonusRot
docs.rendererapi.setcamerabonusrot
overload 1:
RendererAPI:setCameraBonusRot(rot)
Method Property Fluent Description Representation
rot accepts a Vector3
Return Value nil
overload 2:
RendererAPI:setCameraBonusRot(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value nil

RendererAPI.setCameraRot
docs.rendererapi.setcamerarot
overload 1:
RendererAPI:setCameraRot(rot)
Method Property Fluent Description Representation
rot accepts a Vector3
Return Value nil
overload 2:
RendererAPI:setCameraRot(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value nil

RendererAPI.setPostEffect
docs.rendererapi.setposteffect
overload 1:
RendererAPI:setPostEffect(effect)
Method Property Fluent Description Representation
effect accepts a String
Return Value nil

RendererAPI.isFirstPerson
docs.rendererapi.isfirstperson
overload 1:
RendererAPI:isFirstPerson()
Method Property Fluent Description Representation
Return Value a Boolean

RendererAPI.renderFire
docs.rendererapi.renderfire
field signature:
renderFire
Method Property Fluent Description Representation
Field Type a Boolean

RendererAPI.renderVehicle
docs.rendererapi.rendervehicle
field signature:
renderVehicle
Method Property Fluent Description Representation
Field Type a Boolean

ScrollAction

subclasses Action

docs.scrollaction

ScrollAction.onScroll
docs.scrollaction.onscroll
overload 1:
ScrollAction:onScroll(scrollFunction)
Method Property Fluent Description Representation
scrollFunction accepts a function
Return Value an Action

ScrollAction.color

Inherited from Action

docs.scrollaction.color
overload 1:
ScrollAction:color(color)
Method Property Fluent Description Representation
color accepts a Vector3
Return Value an Action
overload 2:
ScrollAction:color(r, g, b)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
Return Value an Action

ScrollAction.item

Inherited from Action

docs.scrollaction.item
overload 1:
ScrollAction:item(item)
Method Property Fluent Description Representation
item accepts an ItemStack
Return Value an Action
overload 2:
ScrollAction:item(item)
Method Property Fluent Description Representation
item accepts a String
Return Value an Action

ScrollAction.title

Inherited from Action

docs.scrollaction.title
overload 1:
ScrollAction:title(title)
Method Property Fluent Description Representation
title accepts a String
Return Value an Action

ScrollAction.hoverColor

Inherited from Action

docs.scrollaction.hovercolor
overload 1:
ScrollAction:hoverColor(color)
Method Property Fluent Description Representation
color accepts a Vector3
Return Value an Action
overload 2:
ScrollAction:hoverColor(r, g, b)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
Return Value an Action

ScrollAction.hoverItem

Inherited from Action

docs.scrollaction.hoveritem
overload 1:
ScrollAction:hoverItem(item)
Method Property Fluent Description Representation
item accepts an ItemStack
Return Value an Action
overload 2:
ScrollAction:hoverItem(item)
Method Property Fluent Description Representation
item accepts a String
Return Value an Action

ScrollAction.scroll
docs.scrollaction.scroll
field signature:
scroll
Method Property Fluent Description Representation
Field Type a function

TextTask

subclasses RenderTask

docs.texttask

TextTask.text
docs.texttask.text
overload 1:
TextTask:text(text)
Method Property Fluent Description Representation
text accepts a String
Return Value a RenderTask

TextTask.centred
docs.texttask.centred
overload 1:
TextTask:centred(centred)
Method Property Fluent Description Representation
centred accepts a Boolean
Return Value a RenderTask

TextTask.outlineColor
docs.texttask.outlinecolor
overload 1:
TextTask:outlineColor(color)
Method Property Fluent Description Representation
color accepts a Vector3
Return Value a TextTask
overload 2:
TextTask:outlineColor(r, g, b)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
Return Value a TextTask

TextTask.outline
docs.texttask.outline
overload 1:
TextTask:outline(outline)
Method Property Fluent Description Representation
outline accepts a Boolean
Return Value a RenderTask

TextTask.shadow
docs.texttask.shadow
overload 1:
TextTask:shadow(shadow)
Method Property Fluent Description Representation
shadow accepts a Boolean
Return Value a RenderTask

TextTask.scale

Inherited from RenderTask

docs.texttask.scale
overload 1:
TextTask:scale(scale)
Method Property Fluent Description Representation
scale accepts a Vector3
Return Value a RenderTask
overload 2:
TextTask:scale(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a RenderTask

TextTask.enabled

Inherited from RenderTask

docs.texttask.enabled
overload 1:
TextTask:enabled(bool)
Method Property Fluent Description Representation
bool accepts a Boolean
Return Value a RenderTask

TextTask.pos

Inherited from RenderTask

docs.texttask.pos
overload 1:
TextTask:pos(pos)
Method Property Fluent Description Representation
pos accepts a Vector3
Return Value a RenderTask
overload 2:
TextTask:pos(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a RenderTask

TextTask.emissive

Inherited from RenderTask

docs.texttask.emissive
overload 1:
TextTask:emissive(bool)
Method Property Fluent Description Representation
bool accepts a Boolean
Return Value a RenderTask

TextTask.rot

Inherited from RenderTask

docs.texttask.rot
overload 1:
TextTask:rot(rot)
Method Property Fluent Description Representation
rot accepts a Vector3
Return Value a RenderTask
overload 2:
TextTask:rot(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value a RenderTask

ToggleAction

subclasses Action

docs.toggleaction

ToggleAction.onUntoggle
docs.toggleaction.onuntoggle
overload 1:
ToggleAction:onUntoggle(rightFunction)
Method Property Fluent Description Representation
rightFunction accepts a function
Return Value an Action

ToggleAction.toggled
docs.toggleaction.toggled
overload 1:
ToggleAction:toggled(bool)
Method Property Fluent Description Representation
bool accepts a Boolean
Return Value an Action

ToggleAction.isToggled
docs.toggleaction.istoggled
overload 1:
ToggleAction:isToggled()
Method Property Fluent Description Representation
Return Value a Boolean

ToggleAction.toggleItem
docs.toggleaction.toggleitem
overload 1:
ToggleAction:toggleItem(item)
Method Property Fluent Description Representation
item accepts an ItemStack
Return Value an Action
overload 2:
ToggleAction:toggleItem(item)
Method Property Fluent Description Representation
item accepts a String
Return Value an Action

ToggleAction.toggleColor
docs.toggleaction.togglecolor
overload 1:
ToggleAction:toggleColor(color)
Method Property Fluent Description Representation
color accepts a Vector3
Return Value an Action
overload 2:
ToggleAction:toggleColor(r, g, b)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
Return Value an Action

ToggleAction.onToggle
docs.toggleaction.ontoggle
overload 1:
ToggleAction:onToggle(leftFunction)
Method Property Fluent Description Representation
leftFunction accepts a function
Return Value an Action

ToggleAction.toggleTitle
docs.toggleaction.toggletitle
overload 1:
ToggleAction:toggleTitle(title)
Method Property Fluent Description Representation
title accepts a String
Return Value an Action

ToggleAction.color

Inherited from Action

docs.toggleaction.color
overload 1:
ToggleAction:color(color)
Method Property Fluent Description Representation
color accepts a Vector3
Return Value an Action
overload 2:
ToggleAction:color(r, g, b)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
Return Value an Action

ToggleAction.item

Inherited from Action

docs.toggleaction.item
overload 1:
ToggleAction:item(item)
Method Property Fluent Description Representation
item accepts an ItemStack
Return Value an Action
overload 2:
ToggleAction:item(item)
Method Property Fluent Description Representation
item accepts a String
Return Value an Action

ToggleAction.title

Inherited from Action

docs.toggleaction.title
overload 1:
ToggleAction:title(title)
Method Property Fluent Description Representation
title accepts a String
Return Value an Action

ToggleAction.hoverColor

Inherited from Action

docs.toggleaction.hovercolor
overload 1:
ToggleAction:hoverColor(color)
Method Property Fluent Description Representation
color accepts a Vector3
Return Value an Action
overload 2:
ToggleAction:hoverColor(r, g, b)
Method Property Fluent Description Representation
r accepts a Number
g accepts a Number
b accepts a Number
Return Value an Action

ToggleAction.hoverItem

Inherited from Action

docs.toggleaction.hoveritem
overload 1:
ToggleAction:hoverItem(item)
Method Property Fluent Description Representation
item accepts an ItemStack
Return Value an Action
overload 2:
ToggleAction:hoverItem(item)
Method Property Fluent Description Representation
item accepts a String
Return Value an Action

VanillaModelGroup
docs.vanillamodelgroup

VanillaModelGroup.getVisible
docs.vanillamodelgroup.getvisible
overload 1:
VanillaModelGroup:getVisible()
Method Property Fluent Description Representation
Return Value a Boolean

VanillaModelGroup.setVisible
docs.vanillamodelgroup.setvisible
overload 1:
VanillaModelGroup:setVisible(visible)
Method Property Fluent Description Representation
visible accepts a Boolean
Return Value nil

VanillaModelPart
docs.vanillamodelpart

VanillaModelPart.getVisible
docs.vanillamodelpart.getvisible
overload 1:
VanillaModelPart:getVisible()
Method Property Fluent Description Representation
Return Value a Boolean

VanillaModelPart.setVisible
docs.vanillamodelpart.setvisible
overload 1:
VanillaModelPart:setVisible(visible)
Method Property Fluent Description Representation
visible accepts a Boolean
Return Value nil

VanillaModelPart.getOriginPos
docs.vanillamodelpart.getoriginpos
overload 1:
VanillaModelPart:getOriginPos()
Method Property Fluent Description Representation
Return Value a Vector3

VanillaModelPart.getOriginRot
docs.vanillamodelpart.getoriginrot
overload 1:
VanillaModelPart:getOriginRot()
Method Property Fluent Description Representation
Return Value a Vector3

Vector2
docs.vector2
Meta name Allowed other parameters Meta execution method
__le
  • Vector2
x <= y
__lt
  • Vector2
x < y
__len
#x
__unm
-x
__eq
  • Vector2
x == y
__mod
  • Number
  • Vector2
x % y
__div
  • Number
  • Vector2
x / y
__mul
  • Number
  • Vector2
  • Matrix2
x * y
__add
  • Vector2
x + y
__sub
  • Vector2
x - y

Vector2.length
docs.vector2.length
overload 1:
Vector2:length()
Method Property Fluent Description Representation
Return Value a Number

Vector2.dot
docs.vector2.dot
overload 1:
Vector2:dot(vec2)
Method Property Fluent Description Representation
vec2 accepts a Vector2
Return Value a Number

Vector2.set
docs.vector2.set
overload 1:
Vector2:set(x, y)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
Return Value nil

Vector2.copy
docs.vector2.copy
overload 1:
Vector2:copy()
Method Property Fluent Description Representation
Return Value a Vector2

Vector2.normalize
docs.vector2.normalize
overload 1:
Vector2:normalize()
Method Property Fluent Description Representation
Return Value nil

Vector2.reset
docs.vector2.reset
overload 1:
Vector2:reset()
Method Property Fluent Description Representation
Return Value nil

Vector2.normalized
docs.vector2.normalized
overload 1:
Vector2:normalized()
Method Property Fluent Description Representation
Return Value a Vector2

Vector2.clamped
docs.vector2.clamped
overload 1:
Vector2:clamped(minLength, maxLength)
Method Property Fluent Description Representation
minLength accepts a Number
maxLength accepts a Number
Return Value a Vector2

Vector2.lengthSquared
docs.vector2.lengthsquared
overload 1:
Vector2:lengthSquared()
Method Property Fluent Description Representation
Return Value a Number

Vector2.toRad
docs.vector2.torad
overload 1:
Vector2:toRad()
Method Property Fluent Description Representation
Return Value a Vector2

Vector2.clampLength
docs.vector2.clamplength
overload 1:
Vector2:clampLength(minLength, maxLength)
Method Property Fluent Description Representation
minLength accepts a Number
maxLength accepts a Number
Return Value nil

Vector2.toDeg
docs.vector2.todeg
overload 1:
Vector2:toDeg()
Method Property Fluent Description Representation
Return Value a Vector2

Vector2.x
docs.vector2.x
field signature:
x
Method Property Fluent Description Representation
Field Type a Number

Vector2.y
docs.vector2.y
field signature:
y
Method Property Fluent Description Representation
Field Type a Number

Vector3
docs.vector3
Meta name Allowed other parameters Meta execution method
__le
  • Vector3
x <= y
__lt
  • Vector3
x < y
__len
#x
__unm
-x
__eq
  • Vector3
x == y
__mod
  • Number
  • Vector3
x % y
__div
  • Number
  • Vector3
x / y
__mul
  • Number
  • Vector3
  • Matrix3
x * y
__add
  • Vector3
x + y
__sub
  • Vector3
x - y

Vector3.length
docs.vector3.length
overload 1:
Vector3:length()
Method Property Fluent Description Representation
Return Value a Number

Vector3.dot
docs.vector3.dot
overload 1:
Vector3:dot(vec2)
Method Property Fluent Description Representation
vec2 accepts a Vector3
Return Value a Number

Vector3.set
docs.vector3.set
overload 1:
Vector3:set(x, y, z)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
Return Value nil

Vector3.copy
docs.vector3.copy
overload 1:
Vector3:copy()
Method Property Fluent Description Representation
Return Value a Vector3

Vector3.normalize
docs.vector3.normalize
overload 1:
Vector3:normalize()
Method Property Fluent Description Representation
Return Value nil

Vector3.reset
docs.vector3.reset
overload 1:
Vector3:reset()
Method Property Fluent Description Representation
Return Value nil

Vector3.normalized
docs.vector3.normalized
overload 1:
Vector3:normalized()
Method Property Fluent Description Representation
Return Value a Vector3

Vector3.clamped
docs.vector3.clamped
overload 1:
Vector3:clamped(minLength, maxLength)
Method Property Fluent Description Representation
minLength accepts a Number
maxLength accepts a Number
Return Value a Vector3

Vector3.augmented
docs.vector3.augmented
overload 1:
Vector3:augmented()
Method Property Fluent Description Representation
Return Value a Vector4

Vector3.lengthSquared
docs.vector3.lengthsquared
overload 1:
Vector3:lengthSquared()
Method Property Fluent Description Representation
Return Value a Number

Vector3.toRad
docs.vector3.torad
overload 1:
Vector3:toRad()
Method Property Fluent Description Representation
Return Value a Vector3

Vector3.clampLength
docs.vector3.clamplength
overload 1:
Vector3:clampLength(minLength, maxLength)
Method Property Fluent Description Representation
minLength accepts a Number
maxLength accepts a Number
Return Value nil

Vector3.toDeg
docs.vector3.todeg
overload 1:
Vector3:toDeg()
Method Property Fluent Description Representation
Return Value a Vector3

Vector3.cross
docs.vector3.cross
overload 1:
Vector3:cross(vec2)
Method Property Fluent Description Representation
vec2 accepts a Vector3
Return Value a Vector3

Vector3.x
docs.vector3.x
field signature:
x
Method Property Fluent Description Representation
Field Type a Number

Vector3.y
docs.vector3.y
field signature:
y
Method Property Fluent Description Representation
Field Type a Number

Vector3.z
docs.vector3.z
field signature:
z
Method Property Fluent Description Representation
Field Type a Number

Vector4
docs.vector4
Meta name Allowed other parameters Meta execution method
__le
  • Vector4
x <= y
__lt
  • Vector4
x < y
__len
#x
__unm
-x
__eq
  • Vector4
x == y
__mod
  • Number
  • Vector4
x % y
__div
  • Number
  • Vector4
x / y
__mul
  • Number
  • Vector4
  • Matrix4
x * y
__add
  • Vector4
x + y
__sub
  • Vector4
x - y

Vector4.length
docs.vector4.length
overload 1:
Vector4:length()
Method Property Fluent Description Representation
Return Value a Number

Vector4.dot
docs.vector4.dot
overload 1:
Vector4:dot(vec2)
Method Property Fluent Description Representation
vec2 accepts a Vector4
Return Value a Number

Vector4.set
docs.vector4.set
overload 1:
Vector4:set(x, y, z, w)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
w accepts a Number
Return Value nil

Vector4.copy
docs.vector4.copy
overload 1:
Vector4:copy()
Method Property Fluent Description Representation
Return Value a Vector4

Vector4.normalize
docs.vector4.normalize
overload 1:
Vector4:normalize()
Method Property Fluent Description Representation
Return Value nil

Vector4.reset
docs.vector4.reset
overload 1:
Vector4:reset()
Method Property Fluent Description Representation
Return Value nil

Vector4.normalized
docs.vector4.normalized
overload 1:
Vector4:normalized()
Method Property Fluent Description Representation
Return Value a Vector4

Vector4.clamped
docs.vector4.clamped
overload 1:
Vector4:clamped(minLength, maxLength)
Method Property Fluent Description Representation
minLength accepts a Number
maxLength accepts a Number
Return Value a Vector4

Vector4.lengthSquared
docs.vector4.lengthsquared
overload 1:
Vector4:lengthSquared()
Method Property Fluent Description Representation
Return Value a Number

Vector4.toRad
docs.vector4.torad
overload 1:
Vector4:toRad()
Method Property Fluent Description Representation
Return Value a Vector4

Vector4.clampLength
docs.vector4.clamplength
overload 1:
Vector4:clampLength(minLength, maxLength)
Method Property Fluent Description Representation
minLength accepts a Number
maxLength accepts a Number
Return Value nil

Vector4.toDeg
docs.vector4.todeg
overload 1:
Vector4:toDeg()
Method Property Fluent Description Representation
Return Value a Vector4

Vector4.x
docs.vector4.x
field signature:
x
Method Property Fluent Description Representation
Field Type a Number

Vector4.y
docs.vector4.y
field signature:
y
Method Property Fluent Description Representation
Field Type a Number

Vector4.z
docs.vector4.z
field signature:
z
Method Property Fluent Description Representation
Field Type a Number

Vector4.w
docs.vector4.w
field signature:
w
Method Property Fluent Description Representation
Field Type a Number

Vector5
docs.vector5
Meta name Allowed other parameters Meta execution method
__le
  • Vector5
x <= y
__lt
  • Vector5
x < y
__len
#x
__unm
-x
__eq
  • Vector5
x == y
__mod
  • Number
  • Vector5
x % y
__div
  • Number
  • Vector5
x / y
__mul
  • Number
  • Vector5
x * y
__add
  • Vector5
x + y
__sub
  • Vector5
x - y

Vector5.length
docs.vector5.length
overload 1:
Vector5:length()
Method Property Fluent Description Representation
Return Value a Number

Vector5.dot
docs.vector5.dot
overload 1:
Vector5:dot(vec2)
typings.2002444082
Method Property Fluent Description Representation
vec2 accepts
Return Value a Number

Vector5.set
docs.vector5.set
overload 1:
Vector5:set(x, y, z, w, t)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
w accepts a Number
t accepts a Number
Return Value nil

Vector5.copy
docs.vector5.copy
overload 1:
Vector5:copy()
typings.2002444082
Method Property Fluent Description Representation
Return Value

Vector5.normalize
docs.vector5.normalize
overload 1:
Vector5:normalize()
Method Property Fluent Description Representation
Return Value nil

Vector5.reset
docs.vector5.reset
overload 1:
Vector5:reset()
Method Property Fluent Description Representation
Return Value nil

Vector5.normalized
docs.vector5.normalized
overload 1:
Vector5:normalized()
typings.2002444082
Method Property Fluent Description Representation
Return Value

Vector5.clamped
docs.vector5.clamped
overload 1:
Vector5:clamped(minLength, maxLength)
typings.2002444082
Method Property Fluent Description Representation
minLength accepts a Number
maxLength accepts a Number
Return Value

Vector5.lengthSquared
docs.vector5.lengthsquared
overload 1:
Vector5:lengthSquared()
Method Property Fluent Description Representation
Return Value a Number

Vector5.toRad
docs.vector5.torad
overload 1:
Vector5:toRad()
typings.2002444082
Method Property Fluent Description Representation
Return Value

Vector5.clampLength
docs.vector5.clamplength
overload 1:
Vector5:clampLength(minLength, maxLength)
Method Property Fluent Description Representation
minLength accepts a Number
maxLength accepts a Number
Return Value nil

Vector5.toDeg
docs.vector5.todeg
overload 1:
Vector5:toDeg()
typings.2002444082
Method Property Fluent Description Representation
Return Value

Vector5.x
docs.vector5.x
field signature:
x
Method Property Fluent Description Representation
Field Type a Number

Vector5.y
docs.vector5.y
field signature:
y
Method Property Fluent Description Representation
Field Type a Number

Vector5.z
docs.vector5.z
field signature:
z
Method Property Fluent Description Representation
Field Type a Number

Vector5.w
docs.vector5.w
field signature:
w
Method Property Fluent Description Representation
Field Type a Number

Vector5.t
docs.vector5.t
field signature:
t
Method Property Fluent Description Representation
Field Type a Number

Vector6
docs.vector6
Meta name Allowed other parameters Meta execution method
__le
  • Vector6
x <= y
__lt
  • Vector6
x < y
__len
#x
__unm
-x
__eq
  • Vector6
x == y
__mod
  • Number
  • Vector6
x % y
__div
  • Number
  • Vector6
x / y
__mul
  • Number
  • Vector6
x * y
__add
  • Vector6
x + y
__sub
  • Vector6
x - y

Vector6.length
docs.vector6.length
overload 1:
Vector6:length()
Method Property Fluent Description Representation
Return Value a Number

Vector6.dot
docs.vector6.dot
overload 1:
Vector6:dot(vec2)
typings.2002444083
Method Property Fluent Description Representation
vec2 accepts
Return Value a Number

Vector6.set
docs.vector6.set
overload 1:
Vector6:set(x, y, z, w, t, h)
Method Property Fluent Description Representation
x accepts a Number
y accepts a Number
z accepts a Number
w accepts a Number
t accepts a Number
h accepts a Number
Return Value nil

Vector6.copy
docs.vector6.copy
overload 1:
Vector6:copy()
typings.2002444083
Method Property Fluent Description Representation
Return Value

Vector6.normalize
docs.vector6.normalize
overload 1:
Vector6:normalize()
Method Property Fluent Description Representation
Return Value nil

Vector6.reset
docs.vector6.reset
overload 1:
Vector6:reset()
Method Property Fluent Description Representation
Return Value nil

Vector6.normalized
docs.vector6.normalized
overload 1:
Vector6:normalized()
typings.2002444083
Method Property Fluent Description Representation
Return Value

Vector6.clamped
docs.vector6.clamped
overload 1:
Vector6:clamped(minLength, maxLength)
typings.2002444083
Method Property Fluent Description Representation
minLength accepts a Number
maxLength accepts a Number
Return Value

Vector6.lengthSquared
docs.vector6.lengthsquared
overload 1:
Vector6:lengthSquared()
Method Property Fluent Description Representation
Return Value a Number

Vector6.toRad
docs.vector6.torad
overload 1:
Vector6:toRad()
typings.2002444083
Method Property Fluent Description Representation
Return Value

Vector6.clampLength
docs.vector6.clamplength
overload 1:
Vector6:clampLength(minLength, maxLength)
Method Property Fluent Description Representation
minLength accepts a Number
maxLength accepts a Number
Return Value nil

Vector6.toDeg
docs.vector6.todeg
overload 1:
Vector6:toDeg()
typings.2002444083
Method Property Fluent Description Representation
Return Value

Vector6.x
docs.vector6.x
field signature:
x
Method Property Fluent Description Representation
Field Type a Number

Vector6.y
docs.vector6.y
field signature:
y
Method Property Fluent Description Representation
Field Type a Number

Vector6.z
docs.vector6.z
field signature:
z
Method Property Fluent Description Representation
Field Type a Number

Vector6.w
docs.vector6.w
field signature:
w
Method Property Fluent Description Representation
Field Type a Number

Vector6.t
docs.vector6.t
field signature:
t
Method Property Fluent Description Representation
Field Type a Number

Vector6.h
docs.vector6.h
field signature:
h
Method Property Fluent Description Representation
Field Type a Number

math
docs.math

math.map
docs.math.map
overload 1:
math.map(value, oldMin, oldMax, newMin, newMax)
Method Property Fluent Description Representation
value accepts a Number
oldMin accepts a Number
oldMax accepts a Number
newMin accepts a Number
newMax accepts a Number
Return Value a Number

math.round
docs.math.round
overload 1:
math.round(value)
Method Property Fluent Description Representation
value accepts a Number
Return Value a Number

math.sign
docs.math.sign
overload 1:
math.sign(value)
Method Property Fluent Description Representation
value accepts a Number
Return Value a Number

math.lerp
docs.math.lerp
overload 1:
math.lerp(a, b, t)
Method Property Fluent Description Representation
a accepts a Number
b accepts a Number
t accepts a Number
Return Value a Number
overload 2:
math.lerp(a, b, t)
Method Property Fluent Description Representation
a accepts a Vector
b accepts a Vector
t accepts a Number
Return Value a Vector

math.shortAngle
docs.math.shortangle
overload 1:
math.shortAngle(from, to)
Method Property Fluent Description Representation
from accepts a Number
to accepts a Number
Return Value a Number

math.lerpAngle
docs.math.lerpangle
overload 1:
math.lerpAngle(a, b, t)
Method Property Fluent Description Representation
a accepts a Number
b accepts a Number
t accepts a Number
Return Value a Number

math.clamp
docs.math.clamp
overload 1:
math.clamp(value, min, max)
Method Property Fluent Description Representation
value accepts a Number
min accepts a Number
max accepts a Number
Return Value a Number

EntityPoses
docs.entityposes
STANDING
FALL_FLYING
SLEEPING
SWIMMING
SPIN_ATTACK
CROUCHING
LONG_JUMPING
DYING
CROAKING
USING_TONGUE
ROARING
SNIFFING
EMERGING
DIGGING

Item RenderTypes
docs.item rendertypes
NONE
THIRD_PERSON_LEFT_HAND
THIRD_PERSON_RIGHT_HAND
FIRST_PERSON_LEFT_HAND
FIRST_PERSON_RIGHT_HAND
HEAD
GUI
GROUND
FIXED

KeyIDs
docs.keyids
key.playerlist
figura.config.action_wheel_button
key.sneak
key.hotbar.8
key.hotbar.7
key.sprint
key.hotbar.6
key.hotbar.5
key.hotbar.4
key.hotbar.3
key.hotbar.2
key.togglePerspective
key.hotbar.1
key.spectatorOutlines
key.left
key.chat
key.pickItem
key.socialInteractions
key.fullscreen
key.attack
key.smoothCamera
key.advancements
key.use
figura.config.panic_button
key.loadToolbarActivator
figura.config.reload_button
key.hotbar.9
key.forward
key.right
key.screenshot
key.back
key.swapOffhand
key.command
key.saveToolbarActivator
key.inventory
key.jump
key.drop

Keybinds
docs.keybinds
key.keyboard.unknown
key.mouse.left
key.mouse.right
key.mouse.middle
key.mouse.4
key.mouse.5
key.mouse.6
key.mouse.7
key.mouse.8
key.keyboard.0
key.keyboard.1
key.keyboard.2
key.keyboard.3
key.keyboard.4
key.keyboard.5
key.keyboard.6
key.keyboard.7
key.keyboard.8
key.keyboard.9
key.keyboard.a
key.keyboard.b
key.keyboard.c
key.keyboard.d
key.keyboard.e
key.keyboard.f
key.keyboard.g
key.keyboard.h
key.keyboard.i
key.keyboard.j
key.keyboard.k
key.keyboard.l
key.keyboard.m
key.keyboard.n
key.keyboard.o
key.keyboard.p
key.keyboard.q
key.keyboard.r
key.keyboard.s
key.keyboard.t
key.keyboard.u
key.keyboard.v
key.keyboard.w
key.keyboard.x
key.keyboard.y
key.keyboard.z
key.keyboard.f1
key.keyboard.f2
key.keyboard.f3
key.keyboard.f4
key.keyboard.f5
key.keyboard.f6
key.keyboard.f7
key.keyboard.f8
key.keyboard.f9
key.keyboard.f10
key.keyboard.f11
key.keyboard.f12
key.keyboard.f13
key.keyboard.f14
key.keyboard.f15
key.keyboard.f16
key.keyboard.f17
key.keyboard.f18
key.keyboard.f19
key.keyboard.f20
key.keyboard.f21
key.keyboard.f22
key.keyboard.f23
key.keyboard.f24
key.keyboard.f25
key.keyboard.num.lock
key.keyboard.keypad.0
key.keyboard.keypad.1
key.keyboard.keypad.2
key.keyboard.keypad.3
key.keyboard.keypad.4
key.keyboard.keypad.5
key.keyboard.keypad.6
key.keyboard.keypad.7
key.keyboard.keypad.8
key.keyboard.keypad.9
key.keyboard.keypad.add
key.keyboard.keypad.decimal
key.keyboard.keypad.enter
key.keyboard.keypad.equal
key.keyboard.keypad.multiply
key.keyboard.keypad.divide
key.keyboard.keypad.subtract
key.keyboard.down
key.keyboard.left
key.keyboard.right
key.keyboard.up
key.keyboard.apostrophe
key.keyboard.backslash
key.keyboard.comma
key.keyboard.equal
key.keyboard.grave.accent
key.keyboard.left.bracket
key.keyboard.minus
key.keyboard.period
key.keyboard.right.bracket
key.keyboard.semicolon
key.keyboard.slash
key.keyboard.space
key.keyboard.tab
key.keyboard.left.alt
key.keyboard.left.control
key.keyboard.left.shift
key.keyboard.left.win
key.keyboard.right.alt
key.keyboard.right.control
key.keyboard.right.shift
key.keyboard.right.win
key.keyboard.enter
key.keyboard.escape
key.keyboard.backspace
key.keyboard.delete
key.keyboard.end
key.keyboard.home
key.keyboard.insert
key.keyboard.page.down
key.keyboard.page.up
key.keyboard.caps.lock
key.keyboard.pause
key.keyboard.scroll.lock
key.keyboard.menu
key.keyboard.print.screen
key.keyboard.world.1
key.keyboard.world.2

LoopModes
docs.loopmodes
LOOP
ONCE
HOLD

ParentTypes
docs.parenttypes
None
NONE
Head
HEAD
Body
BODY
LeftArm
LEFT_ARM
RightArm
RIGHT_ARM
LeftLeg
LEFT_LEG
RightLeg
RIGHT_LEG
LeftElytra
LEFT_ELYTRA
LeftElytron
LEFT_ELYTRON
RightElytra
RIGHT_ELYTRA
RightElytron
RIGHT_ELYTRON
Cape
CAPE
World
WORLD
Hud
HUD
Gui
GUI
Camera
CAMERA
LeftItemPivot
LEFT_ITEM_PIVOT
RightItemPivot
RIGHT_ITEM_PIVOT

PlayStates
docs.playstates
STOPPED
PAUSED
PLAYING

PostEffects
docs.posteffects
notch
fxaa
art
bumpy
blobs2
pencil
color_convolve
deconverge
flip
invert
ntsc
outline
phosphor
scan_pincushion
sobel
bits
desaturate
green
blur
wobble
blobs
antialias
creeper
spider

RenderTypes
docs.rendertypes
CUTOUT
CUTOUT_CULL
TRANSLUCENT
TRANSLUCENT_CULL
EMISSIVE
EMISSIVE_SOLID
END_PORTAL
END_GATEWAY
GLINT
GLINT2
LINES
LINES_STRIP

TextureTypes
docs.texturetypes
skin
cape
elytra
resource
texture
a a