Show everything

Miscellaneous Types

math
Action ClickAction Page ScrollAction ToggleAction
Animation
EntityNameplateCustomization NameplateCustomization NameplateCustomizationGroup
Biome BlockState ItemStack
VanillaModelGroup VanillaModelPart
BlockTask ItemTask RenderTask TextTask
LivingEntityAPI
Event
Keybind
Vector2 Vector3 Vector4 Vector5 Vector6
Matrix2 Matrix3 Matrix4
Sound
PingFunction
Made by applejuice

host
The global instance of HostAPI
field signature:
host
Method Property Fluent Description Representation
Field Type a HostAPI

HostAPI.getSlot
Gets an ItemStack for the item in the given slot
The slot is either their numerical id (0 indexed) or the slot string, as used in the /item command
overload 1:
host:getSlot(slot)
Method Property Fluent Description Representation
slot accepts a String
Return Value an ItemStack

HostAPI.setTitle
Sets the current title to the given text
The text is given as json
overload 1:
host:setTitle(text)
Method Property Fluent Description Representation
text accepts a String
Return Value nil

HostAPI.getTargetedEntity
figura.docs.host.get_targeted_entity
overload 1:
host:getTargetedEntity()
Method Property Fluent Description Representation
Return Value an EntityAPI

HostAPI.setTitleTimes
Sets the duration of the title on the screen, also its fade-in and fade-out durations
overload 1:
host:setTitleTimes(timesData)
Method Property Fluent Description Representation
timesData accepts a Vector3
Return Value nil
overload 2:
host: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.swingArm
Animates swinging the player's arm
If the boolean is true, then the offhand is the one that swings
overload 1:
host:swingArm()
Method Property Fluent Description Representation
Return Value nil
overload 2:
host:swingArm(offhand)
Method Property Fluent Description Representation
offhand accepts a Boolean
Return Value nil

HostAPI.setActionbar
Sets the action bar message to the given text
The boolean parameter defaults to false
overload 1:
host:setActionbar(text)
Method Property Fluent Description Representation
text accepts a String
Return Value nil
overload 2:
host:setActionbar(text, animated)
Method Property Fluent Description Representation
text accepts a String
animated accepts a Boolean
Return Value nil

HostAPI.appendChatHistory
Appends the message on the recent chat history
overload 1:
host:appendChatHistory(message)
Method Property Fluent Description Representation
message accepts a String
Return Value nil

HostAPI.isChatOpen
Checks if the host has the chat screen opened
overload 1:
host:isChatOpen()
Method Property Fluent Description Representation
Return Value a Boolean

HostAPI.sendChatCommand
Sends the given command in the chat
overload 1:
host:sendChatCommand(command)
Method Property Fluent Description Representation
command accepts a String
Return Value nil

HostAPI.getChatText
Gets the text that is currently being typed into the chat window
overload 1:
host:getChatText()
Method Property Fluent Description Representation
Return Value a String

HostAPI.setSubtitle
Sets the current subtitle to the given text
The text is given as a JSON string
overload 1:
host:setSubtitle(text)
Method Property Fluent Description Representation
text accepts a String
Return Value nil

HostAPI.clearTitle
Clears the current title from the GUI
overload 1:
host:clearTitle()
Method Property Fluent Description Representation
Return Value nil

HostAPI.getChatColor
Gets the chat window text color
overload 1:
host:getChatColor()
Method Property Fluent Description Representation
Return Value an Integer

HostAPI.setChatColor
Sets the color of the text that is currently being typed into the chat window
overload 1:
host:setChatColor(color)
Method Property Fluent Description Representation
color accepts a Vector3
Return Value nil
overload 2:
host: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.setChatText
Sets the text currently being typed in the chat window to the given string
overload 1:
host:setChatText(text)
Method Property Fluent Description Representation
text accepts a String
Return Value nil

HostAPI.getScreen
Gets the class name of the screen the player is currently on
If the player is not currently in a screen, returns nil
overload 1:
host:getScreen()
Method Property Fluent Description Representation
Return Value either a String or nil

HostAPI.isContainerOpen
Checks if the host has a container screen opened
overload 1:
host:isContainerOpen()
Method Property Fluent Description Representation
Return Value a Boolean

HostAPI.sendChatMessage
Sends the given message in the chat
overload 1:
host:sendChatMessage(message)
Method Property Fluent Description Representation
message accepts a String
Return Value nil

HostAPI.isHost
Returns true if this instance of the script is running on host
overload 1:
host:isHost()
Method Property Fluent Description Representation
Return Value a Boolean

HostAPI.unlockCursor
Setting this value to true will unlock your cursor, letting you move it freely on the screen instead of it controlling your player's rotation
field signature:
unlockCursor
Method Property Fluent Description Representation
Field Type a Boolean
a a