HostAPI

No description available
figura.docs.host

HostAPI.actionbar

No description available
figura.docs.host.set_actionbar

overload 1:
HostAPI.actionbar(text: String): HostAPI 
typings.-1808118735typings.-1531650254Method PropertyFluent DescriptionRepresentation
text accepts
Return Value
overload 2:
HostAPI.actionbar(text: String, animated: Boolean): HostAPI 
typings.-1808118735typings.1729365000typings.-1531650254Method PropertyFluent DescriptionRepresentation
text accepts
animated accepts
Return Value

Method Property	Fluent Description	Representation
text accepts
Return Value

Method Property	Fluent Description	Representation
text accepts
animated accepts
Return Value

HostAPI.appendChatHistory

No description available
figura.docs.host.append_chat_history

overload 1:
HostAPI.appendChatHistory(message: String): HostAPI 
typings.-1808118735typings.-1531650254Method PropertyFluent DescriptionRepresentation
message accepts
Return Value

Method Property	Fluent Description	Representation
message accepts
Return Value

HostAPI.chatColor

No description available
figura.docs.host.set_chat_color

overload 1:
HostAPI.chatColor(color: Vector3): HostAPI 
typings.2002444080typings.-1531650254Method PropertyFluent DescriptionRepresentation
color accepts
Return Value
overload 2:
HostAPI.chatColor(r: Number, g: Number, b: Number): HostAPI 
typings.-1950496919typings.-1950496919typings.-1950496919typings.-1531650254Method PropertyFluent DescriptionRepresentation
r accepts
g accepts
b accepts
Return Value

Method Property	Fluent Description	Representation
color accepts
Return Value

Method Property	Fluent Description	Representation
r accepts
g accepts
b accepts
Return Value

HostAPI.chatText

No description available
figura.docs.host.set_chat_text

overload 1:
HostAPI.chatText(text: String): HostAPI 
typings.-1808118735typings.-1531650254Method PropertyFluent DescriptionRepresentation
text accepts
Return Value

Method Property	Fluent Description	Representation
text accepts
Return Value

HostAPI.clearTitle

No description available
figura.docs.host.clear_title

overload 1:
HostAPI.clearTitle(): HostAPI 
typings.-1531650254Method PropertyFluent DescriptionRepresentation
Return Value

Method Property	Fluent Description	Representation
Return Value

HostAPI.clipboard

No description available
figura.docs.host.set_clipboard

overload 1:
HostAPI.clipboard(text: String): HostAPI 
typings.-1808118735typings.-1531650254Method PropertyFluent DescriptionRepresentation
text accepts
Return Value

Method Property	Fluent Description	Representation
text accepts
Return Value

HostAPI.getAir

No description available
figura.docs.host.get_air

overload 1:
HostAPI.getAir(): Integer 
typings.-672261858Method PropertyFluent DescriptionRepresentation
Return Value

Method Property	Fluent Description	Representation
Return Value

HostAPI.getAttackCharge

No description available
figura.docs.host.get_attack_charge

overload 1:
HostAPI.getAttackCharge(): Number 
typings.-1950496919Method PropertyFluent DescriptionRepresentation
Return Value

Method Property	Fluent Description	Representation
Return Value

HostAPI.getChatColor

No description available
figura.docs.host.get_chat_color

overload 1:
HostAPI.getChatColor(): Integer 
typings.-672261858Method PropertyFluent DescriptionRepresentation
Return Value

Method Property	Fluent Description	Representation
Return Value

HostAPI.getChatMessage

No description available
figura.docs.host.get_chat_message

overload 1:
HostAPI.getChatMessage(index: Integer): Table 
typings.-672261858typings.80563118Method PropertyFluent DescriptionRepresentation
index accepts
Return Value

Method Property	Fluent Description	Representation
index accepts
Return Value

HostAPI.getChatText

No description available
figura.docs.host.get_chat_text

overload 1:
HostAPI.getChatText(): String 
typings.-1808118735Method PropertyFluent DescriptionRepresentation
Return Value

Method Property	Fluent Description	Representation
Return Value

HostAPI.getClipboard

No description available
figura.docs.host.get_clipboard

overload 1:
HostAPI.getClipboard(): String 
typings.-1808118735Method PropertyFluent DescriptionRepresentation
Return Value

Method Property	Fluent Description	Representation
Return Value

HostAPI.getPickBlock

No description available
figura.docs.host.get_pick_block

overload 1:
HostAPI.getPickBlock(): Varargs 
typings.1901216868Method PropertyFluent DescriptionRepresentation
Return Value

Method Property	Fluent Description	Representation
Return Value

HostAPI.getPickEntity

No description available
figura.docs.host.get_pick_entity

overload 1:
HostAPI.getPickEntity(): EntityAPI 
typings.1263373079Method PropertyFluent DescriptionRepresentation
Return Value

Method Property	Fluent Description	Representation
Return Value

HostAPI.getReachDistance

No description available
figura.docs.host.get_reach_distance

overload 1:
HostAPI.getReachDistance(): Number 
typings.-1950496919Method PropertyFluent DescriptionRepresentation
Return Value

Method Property	Fluent Description	Representation
Return Value

HostAPI.getScreen

No description available
figura.docs.host.get_screen

overload 1:
HostAPI.getScreen(): String | nil 
typings.-1209970754Method PropertyFluent DescriptionRepresentation
Return Value

Method Property	Fluent Description	Representation
Return Value

HostAPI.getScreenSlot

No description available
figura.docs.host.get_screen_slot

overload 1:
HostAPI.getScreenSlot(slot: String): ItemStack 
typings.-1808118735typings.-148280555Method PropertyFluent DescriptionRepresentation
slot accepts
Return Value
overload 2:
HostAPI.getScreenSlot(slot: Integer): ItemStack 
typings.-672261858typings.-148280555Method PropertyFluent DescriptionRepresentation
slot accepts
Return Value

Method Property	Fluent Description	Representation
slot accepts
Return Value

Method Property	Fluent Description	Representation
slot accepts
Return Value

HostAPI.getScreenSlotCount

No description available
figura.docs.host.get_screen_slot_count

overload 1:
HostAPI.getScreenSlotCount(): Integer 
typings.-672261858Method PropertyFluent DescriptionRepresentation
Return Value

Method Property	Fluent Description	Representation
Return Value

HostAPI.getSlot

No description available
figura.docs.host.get_slot

overload 1:
HostAPI.getSlot(slot: String): ItemStack 
typings.-1808118735typings.-148280555Method PropertyFluent DescriptionRepresentation
slot accepts
Return Value
overload 2:
HostAPI.getSlot(slot: Integer): ItemStack 
typings.-672261858typings.-148280555Method PropertyFluent DescriptionRepresentation
slot accepts
Return Value

Method Property	Fluent Description	Representation
slot accepts
Return Value

Method Property	Fluent Description	Representation
slot accepts
Return Value

HostAPI.getStatusEffects

No description available
figura.docs.host.get_status_effects

overload 1:
HostAPI.getStatusEffects(): Table 
typings.80563118Method PropertyFluent DescriptionRepresentation
Return Value

Method Property	Fluent Description	Representation
Return Value

HostAPI.isAvatarUploaded

No description available
figura.docs.host.is_avatar_uploaded

overload 1:
HostAPI.isAvatarUploaded(): Boolean 
typings.1729365000Method PropertyFluent DescriptionRepresentation
Return Value

Method Property	Fluent Description	Representation
Return Value

HostAPI.isChatOpen

No description available
figura.docs.host.is_chat_open

overload 1:
HostAPI.isChatOpen(): Boolean 
typings.1729365000Method PropertyFluent DescriptionRepresentation
Return Value

Method Property	Fluent Description	Representation
Return Value

HostAPI.isChatVerified

No description available
figura.docs.host.is_chat_verified

overload 1:
HostAPI.isChatVerified(): Boolean 
typings.1729365000Method PropertyFluent DescriptionRepresentation
Return Value

Method Property	Fluent Description	Representation
Return Value

HostAPI.isContainerOpen

No description available
figura.docs.host.is_container_open

overload 1:
HostAPI.isContainerOpen(): Boolean 
typings.1729365000Method PropertyFluent DescriptionRepresentation
Return Value

Method Property	Fluent Description	Representation
Return Value

HostAPI.isCursorUnlocked

No description available
figura.docs.host.is_cursor_unlocked

overload 1:
HostAPI.isCursorUnlocked(): Boolean 
typings.1729365000Method PropertyFluent DescriptionRepresentation
Return Value

Method Property	Fluent Description	Representation
Return Value

HostAPI.isFlying

No description available
figura.docs.host.is_flying

overload 1:
HostAPI.isFlying(): Boolean 
typings.1729365000Method PropertyFluent DescriptionRepresentation
Return Value

Method Property	Fluent Description	Representation
Return Value

HostAPI.isHost

No description available
figura.docs.host.is_host

overload 1:
HostAPI.isHost(): Boolean 
typings.1729365000Method PropertyFluent DescriptionRepresentation
Return Value

Method Property	Fluent Description	Representation
Return Value

HostAPI.isJumping

No description available
figura.docs.host.is_jumping

overload 1:
HostAPI.isJumping(): Boolean 
typings.1729365000Method PropertyFluent DescriptionRepresentation
Return Value

Method Property	Fluent Description	Representation
Return Value

HostAPI.screenshot

No description available
figura.docs.host.screenshot

overload 1:
HostAPI.screenshot(name: String): Texture 
typings.-1808118735typings.246836475Method PropertyFluent DescriptionRepresentation
name accepts
Return Value

Method Property	Fluent Description	Representation
name accepts
Return Value

HostAPI.sendChatCommand

No description available
figura.docs.host.send_chat_command

overload 1:
HostAPI.sendChatCommand(command: String): HostAPI 
typings.-1808118735typings.-1531650254Method PropertyFluent DescriptionRepresentation
command accepts
Return Value

Method Property	Fluent Description	Representation
command accepts
Return Value

HostAPI.sendChatMessage

No description available
figura.docs.host.send_chat_message

overload 1:
HostAPI.sendChatMessage(message: String): HostAPI 
typings.-1808118735typings.-1531650254Method PropertyFluent DescriptionRepresentation
message accepts
Return Value

Method Property	Fluent Description	Representation
message accepts
Return Value

HostAPI.setActionbar

No description available
figura.docs.host.set_actionbar

overload 1:
HostAPI.setActionbar(text: String): HostAPI 
typings.-1808118735typings.-1531650254Method PropertyFluent DescriptionRepresentation
text accepts
Return Value
overload 2:
HostAPI.setActionbar(text: String, animated: Boolean): HostAPI 
typings.-1808118735typings.1729365000typings.-1531650254Method PropertyFluent DescriptionRepresentation
text accepts
animated accepts
Return Value

Method Property	Fluent Description	Representation
text accepts
Return Value

Method Property	Fluent Description	Representation
text accepts
animated accepts
Return Value

HostAPI.setChatColor

No description available
figura.docs.host.set_chat_color

overload 1:
HostAPI.setChatColor(color: Vector3): HostAPI 
typings.2002444080typings.-1531650254Method PropertyFluent DescriptionRepresentation
color accepts
Return Value
overload 2:
HostAPI.setChatColor(r: Number, g: Number, b: Number): HostAPI 
typings.-1950496919typings.-1950496919typings.-1950496919typings.-1531650254Method PropertyFluent DescriptionRepresentation
r accepts
g accepts
b accepts
Return Value

Method Property	Fluent Description	Representation
color accepts
Return Value

Method Property	Fluent Description	Representation
r accepts
g accepts
b accepts
Return Value

HostAPI.setChatMessage

No description available
figura.docs.host.set_chat_message

overload 1:
HostAPI.setChatMessage(index: Integer): HostAPI 
typings.-672261858typings.-1531650254Method PropertyFluent DescriptionRepresentation
index accepts
Return Value
overload 2:
HostAPI.setChatMessage(index: Integer, newMessage: String): HostAPI 
typings.-672261858typings.-1808118735typings.-1531650254Method PropertyFluent DescriptionRepresentation
index accepts
newMessage accepts
Return Value
overload 3:
HostAPI.setChatMessage(index: Integer, newMessage: String, backgroundColor: Vector3): HostAPI 
typings.-672261858typings.-1808118735typings.2002444080typings.-1531650254Method PropertyFluent DescriptionRepresentation
index accepts
newMessage accepts
backgroundColor accepts
Return Value

Method Property	Fluent Description	Representation
index accepts
Return Value

Method Property	Fluent Description	Representation
index accepts
newMessage accepts
Return Value

Method Property	Fluent Description	Representation
index accepts
newMessage accepts
backgroundColor accepts
Return Value

HostAPI.setChatText

No description available
figura.docs.host.set_chat_text

overload 1:
HostAPI.setChatText(text: String): HostAPI 
typings.-1808118735typings.-1531650254Method PropertyFluent DescriptionRepresentation
text accepts
Return Value

Method Property	Fluent Description	Representation
text accepts
Return Value

HostAPI.setClipboard

No description available
figura.docs.host.set_clipboard

overload 1:
HostAPI.setClipboard(text: String): HostAPI 
typings.-1808118735typings.-1531650254Method PropertyFluent DescriptionRepresentation
text accepts
Return Value

Method Property	Fluent Description	Representation
text accepts
Return Value

HostAPI.setSlot

No description available
figura.docs.host.set_slot

overload 1:
HostAPI.setSlot(slot: String): HostAPI 
typings.-1808118735typings.-1531650254Method PropertyFluent DescriptionRepresentation
slot accepts
Return Value
overload 2:
HostAPI.setSlot(slot: Integer): HostAPI 
typings.-672261858typings.-1531650254Method PropertyFluent DescriptionRepresentation
slot accepts
Return Value
overload 3:
HostAPI.setSlot(slot: String, item: String): HostAPI 
typings.-1808118735typings.-1808118735typings.-1531650254Method PropertyFluent DescriptionRepresentation
slot accepts
item accepts
Return Value
overload 4:
HostAPI.setSlot(slot: Integer, item: ItemStack): HostAPI 
typings.-672261858typings.-148280555typings.-1531650254Method PropertyFluent DescriptionRepresentation
slot accepts
item accepts
Return Value

Method Property	Fluent Description	Representation
slot accepts
Return Value

Method Property	Fluent Description	Representation
slot accepts
Return Value

Method Property	Fluent Description	Representation
slot accepts
item accepts
Return Value

Method Property	Fluent Description	Representation
slot accepts
item accepts
Return Value

HostAPI.setSubtitle

No description available
figura.docs.host.set_subtitle

overload 1:
HostAPI.setSubtitle(text: String): HostAPI 
typings.-1808118735typings.-1531650254Method PropertyFluent DescriptionRepresentation
text accepts
Return Value

Method Property	Fluent Description	Representation
text accepts
Return Value

HostAPI.setTitle

No description available
figura.docs.host.set_title

overload 1:
HostAPI.setTitle(text: String): HostAPI 
typings.-1808118735typings.-1531650254Method PropertyFluent DescriptionRepresentation
text accepts
Return Value

Method Property	Fluent Description	Representation
text accepts
Return Value

HostAPI.setTitleTimes

No description available
figura.docs.host.set_title_times

overload 1:
HostAPI.setTitleTimes(timesData: Vector3): HostAPI 
typings.2002444080typings.-1531650254Method PropertyFluent DescriptionRepresentation
timesData accepts
Return Value
overload 2:
HostAPI.setTitleTimes(fadeInTime: Integer, stayTime: Integer, fadeOutTime: Integer): HostAPI 
typings.-672261858typings.-672261858typings.-672261858typings.-1531650254Method PropertyFluent DescriptionRepresentation
fadeInTime accepts
stayTime accepts
fadeOutTime accepts
Return Value

HostAPI.setUnlockCursor

No description available
figura.docs.host.set_unlock_cursor

overload 1:
HostAPI.setUnlockCursor(boolean: Boolean): HostAPI 
typings.1729365000typings.-1531650254Method PropertyFluent DescriptionRepresentation
boolean accepts
Return Value

HostAPI.subtitle

No description available
figura.docs.host.set_subtitle

overload 1:
HostAPI.subtitle(text: String): HostAPI 
typings.-1808118735typings.-1531650254Method PropertyFluent DescriptionRepresentation
text accepts
Return Value

HostAPI.swingArm

No description available
figura.docs.host.swing_arm

overload 1:
HostAPI.swingArm(): HostAPI 
typings.-1531650254Method PropertyFluent DescriptionRepresentation
Return Value
overload 2:
HostAPI.swingArm(offhand: Boolean): HostAPI 
typings.1729365000typings.-1531650254Method PropertyFluent DescriptionRepresentation
offhand accepts
Return Value

HostAPI.title

No description available
figura.docs.host.set_title

overload 1:
HostAPI.title(text: String): HostAPI 
typings.-1808118735typings.-1531650254Method PropertyFluent DescriptionRepresentation
text accepts
Return Value

HostAPI.titleTimes

No description available
figura.docs.host.set_title_times

overload 1:
HostAPI.titleTimes(timesData: Vector3): HostAPI 
typings.2002444080typings.-1531650254Method PropertyFluent DescriptionRepresentation
timesData accepts
Return Value
overload 2:
HostAPI.titleTimes(fadeInTime: Integer, stayTime: Integer, fadeOutTime: Integer): HostAPI 
typings.-672261858typings.-672261858typings.-672261858typings.-1531650254Method PropertyFluent DescriptionRepresentation
fadeInTime accepts
stayTime accepts
fadeOutTime accepts
Return Value

HostAPI.warnToLog

No description available
figura.docs.host.warn_to_log

overload 1:
HostAPI.warnToLog(string: String): nil 
typings.-1808118735typings.109073Method PropertyFluent DescriptionRepresentation
string accepts
Return Value

HostAPI.writeToLog

No description available
figura.docs.host.write_to_log

overload 1:
HostAPI.writeToLog(string: String): nil 
typings.-1808118735typings.109073Method PropertyFluent DescriptionRepresentation
string accepts
Return Value

HostAPI.unlockCursor

No description available
figura.docs.host.unlock_cursor

field signature:
HostAPI.unlockCursor: Boolean 
typings.1729365000Method PropertyFluent DescriptionRepresentation
Field Type

Method Property	Fluent Description	Representation
fadeInTime accepts
stayTime accepts
fadeOutTime accepts
Return Value

Global Objects

Types

action_wheel

animations

avatar

world

models

data

client

config

player

nameplate

events

file

host

net

json

keybinds

matrices

particles

pings

raycast

renderer

resources

sounds

textures

vanilla_model

vectors

Uncategorized

Enums