listFiles
action_wheel
Action
BlockRaycastTypes A global API dedicated to specifically the host of the avatar
For other viewers, these do nothing 
Sets the action bar message to the given text
The boolean parameter defaults to false
overload 1:
HostAPI.actionbar(text: String): HostAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| text accepts | typings.-1808118735||
| Return Value | typings.-1531650254
overload 2:
HostAPI.actionbar(text: String, animated: Boolean): HostAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| text accepts | typings.-1808118735||
| animated accepts | typings.1729365000||
| Return Value | typings.-1531650254
Appends the message on the recent chat history
overload 1:
HostAPI.appendChatHistory(message: String): HostAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| message accepts | typings.-1808118735||
| Return Value | typings.-1531650254
Sets the color of the text that is currently being typed into the chat window
overload 1:
HostAPI.chatColor(color: Vector3): HostAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| color accepts | typings.2002444080||
| Return Value | typings.-1531650254
overload 2:
HostAPI.chatColor(r: Number, g: Number, b: Number): HostAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| r accepts | typings.-1950496919||
| g accepts | typings.-1950496919||
| b accepts | typings.-1950496919||
| Return Value | typings.-1531650254
Sets the text currently being typed in the chat window to the given string
overload 1:
HostAPI.chatText(text: String): HostAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| text accepts | typings.-1808118735||
| Return Value | typings.-1531650254
Clears the current title from the GUI
overload 1:
HostAPI.clearTitle(): HostAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1531650254
Sets the clipboard text
overload 1:
HostAPI.clipboard(text: String): HostAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| text accepts | typings.-1808118735||
| Return Value | typings.-1531650254
Gets the remaining amount of air of the player
overload 1:
HostAPI.getAir(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Returns a fraction (0 to 1) of the charge of the player attack
If less than 1, every attack will result in a weak attack
overload 1:
HostAPI.getAttackCharge(): Number | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1950496919
Gets the chat window text color
overload 1:
HostAPI.getChatColor(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
Returns a table with information about a chat message
Takes an index, where 1 means the last message on chat
overload 1:
HostAPI.getChatMessage(index: Integer): Table | Method Property | Fluent Description | Representation |
|---|---|---|
| index accepts | typings.-672261858||
| Return Value | typings.80563118
Gets the text that is currently being typed into the chat window
overload 1:
HostAPI.getChatText(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
Gets the text from the clipboard
overload 1:
HostAPI.getClipboard(): String | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1808118735
Returns the current targeted block set by the client
Returns the block, the hit position, and the targeted block face as three separate values
overload 1:
HostAPI.getPickBlock(): Varargs | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1901216868
Returns the currently targeted entity set by the client
overload 1:
HostAPI.getPickEntity(): EntityAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1263373079
Returns the current reach distance of the player
overload 1:
HostAPI.getReachDistance(): Number | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1950496919
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:
HostAPI.getScreen(): String | nil | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1209970754
Gets the item in a screen slot
The slot is either their numerical id (0 indexed) or the slot string, as used in the /item command
If the player is not currently in a screen, the screen has no slots, or the slot index is greater than the maximum, returns nil
overload 1:
HostAPI.getScreenSlot(slot: String): ItemStack | Method Property | Fluent Description | Representation |
|---|---|---|
| slot accepts | typings.-1808118735||
| Return Value | typings.-148280555
overload 2:
HostAPI.getScreenSlot(slot: Integer): ItemStack | Method Property | Fluent Description | Representation |
|---|---|---|
| slot accepts | typings.-672261858||
| Return Value | typings.-148280555
Gets the number of slots in the screen the player is currently in
If the player is not currently in a screen or the screen has no slots, returns nil
overload 1:
HostAPI.getScreenSlotCount(): Integer | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-672261858
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:
HostAPI.getSlot(slot: String): ItemStack | Method Property | Fluent Description | Representation |
|---|---|---|
| slot accepts | typings.-1808118735||
| Return Value | typings.-148280555
overload 2:
HostAPI.getSlot(slot: Integer): ItemStack | Method Property | Fluent Description | Representation |
|---|---|---|
| slot accepts | typings.-672261858||
| Return Value | typings.-148280555
Returns a table of all of the player's status effects
The table contains sub-tables, each of which contains the name, amplifier, duration, and particle visibility of each status effect
overload 1:
HostAPI.getStatusEffects(): Table | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.80563118
Checks if this avatar is currently uploaded
overload 1:
HostAPI.isAvatarUploaded(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Checks if the host has the chat screen opened
overload 1:
HostAPI.isChatOpen(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
No description available
figura.docs.host.is_chat_verified
overload 1:
HostAPI.isChatVerified(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Checks if the host has a container screen opened
overload 1:
HostAPI.isContainerOpen(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Checks if the cursor is currently unlocked
Only responds to your own changes in your script, not anything done by Minecraft itself
overload 1:
HostAPI.isCursorUnlocked(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Checks if the player is currently flying
overload 1:
HostAPI.isFlying(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Returns true if this instance of the script is running on host
overload 1:
HostAPI.isHost(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Checks if the player is jumping
Note this is only true during the first tick the player started jumping
overload 1:
HostAPI.isJumping(): Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.1729365000
Takes a screenshot from the current screen and returns a Texture of it
overload 1:
HostAPI.screenshot(name: String): Texture | Method Property | Fluent Description | Representation |
|---|---|---|
| name accepts | typings.-1808118735||
| Return Value | typings.246836475
Sends the given command in the chat
overload 1:
HostAPI.sendChatCommand(command: String): HostAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| command accepts | typings.-1808118735||
| Return Value | typings.-1531650254
Sends the given message in the chat
overload 1:
HostAPI.sendChatMessage(message: String): HostAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| message accepts | typings.-1808118735||
| Return Value | typings.-1531650254
Sets the action bar message to the given text
The boolean parameter defaults to false
overload 1:
HostAPI.setActionbar(text: String): HostAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| text accepts | typings.-1808118735||
| Return Value | typings.-1531650254
overload 2:
HostAPI.setActionbar(text: String, animated: Boolean): HostAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| text accepts | typings.-1808118735||
| animated accepts | typings.1729365000||
| Return Value | typings.-1531650254
Sets the color of the text that is currently being typed into the chat window
overload 1:
HostAPI.setChatColor(color: Vector3): HostAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| color accepts | typings.2002444080||
| Return Value | typings.-1531650254
overload 2:
HostAPI.setChatColor(r: Number, g: Number, b: Number): HostAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| r accepts | typings.-1950496919||
| g accepts | typings.-1950496919||
| b accepts | typings.-1950496919||
| Return Value | typings.-1531650254
Modifies a chat message with the given text
Takes an index, were 1 means the last message on chat
Setting the message to nil will effectively remove it from the chat
overload 1:
HostAPI.setChatMessage(index: Integer): HostAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| index accepts | typings.-672261858||
| Return Value | typings.-1531650254
overload 2:
HostAPI.setChatMessage(index: Integer, newMessage: String): HostAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| index accepts | typings.-672261858||
| newMessage accepts | typings.-1808118735||
| Return Value | typings.-1531650254
overload 3:
HostAPI.setChatMessage(index: Integer, newMessage: String, backgroundColor: Vector3): HostAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| index accepts | typings.-672261858||
| newMessage accepts | typings.-1808118735||
| backgroundColor accepts | typings.2002444080||
| Return Value | typings.-1531650254
Sets the text currently being typed in the chat window to the given string
overload 1:
HostAPI.setChatText(text: String): HostAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| text accepts | typings.-1808118735||
| Return Value | typings.-1531650254
Sets the clipboard text
overload 1:
HostAPI.setClipboard(text: String): HostAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| text accepts | typings.-1808118735||
| Return Value | typings.-1531650254
Sets a slot with an ItemStack
The slot is either their numerical id (0 indexed) or the slot string, as used in the /item command
Slot -1 uses the first available slot
Only runs for creative mode
overload 1:
HostAPI.setSlot(slot: String): HostAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| slot accepts | typings.-1808118735||
| Return Value | typings.-1531650254
overload 2:
HostAPI.setSlot(slot: Integer): HostAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| slot accepts | typings.-672261858||
| Return Value | typings.-1531650254
overload 3:
HostAPI.setSlot(slot: String, item: String): HostAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| slot accepts | typings.-1808118735||
| item accepts | typings.-1808118735||
| Return Value | typings.-1531650254
overload 4:
HostAPI.setSlot(slot: Integer, item: ItemStack): HostAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| slot accepts | typings.-672261858||
| item accepts | typings.-148280555||
| Return Value | typings.-1531650254
Sets the current subtitle to the given text
The text is given as a JSON string
overload 1:
HostAPI.setSubtitle(text: String): HostAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| text accepts | typings.-1808118735||
| Return Value | typings.-1531650254
Sets the current title to the given text
The text is given as json
overload 1:
HostAPI.setTitle(text: String): HostAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| text accepts | typings.-1808118735||
| Return Value | typings.-1531650254
Sets the duration of the title on the screen, also its fade-in and fade-out durations
overload 1:
HostAPI.setTitleTimes(timesData: Vector3): HostAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| timesData accepts | typings.2002444080||
| Return Value | typings.-1531650254
overload 2:
HostAPI.setTitleTimes(fadeInTime: Integer, stayTime: Integer, fadeOutTime: Integer): HostAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| fadeInTime accepts | typings.-672261858||
| stayTime accepts | typings.-672261858||
| fadeOutTime accepts | typings.-672261858||
| Return Value | typings.-1531650254
Toggles locking of your cursor, letting you move it freely on the screen instead of it controlling your player's rotation
overload 1:
HostAPI.setUnlockCursor(boolean: Boolean): HostAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| boolean accepts | typings.1729365000||
| Return Value | typings.-1531650254
Sets the current subtitle to the given text
The text is given as a JSON string
overload 1:
HostAPI.subtitle(text: String): HostAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| text accepts | typings.-1808118735||
| Return Value | typings.-1531650254
Animates swinging the player's arm
If the boolean is true, then the offhand is the one that swings
overload 1:
HostAPI.swingArm(): HostAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| Return Value | typings.-1531650254
overload 2:
HostAPI.swingArm(offhand: Boolean): HostAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| offhand accepts | typings.1729365000||
| Return Value | typings.-1531650254
Sets the current title to the given text
The text is given as json
overload 1:
HostAPI.title(text: String): HostAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| text accepts | typings.-1808118735||
| Return Value | typings.-1531650254
Sets the duration of the title on the screen, also its fade-in and fade-out durations
overload 1:
HostAPI.titleTimes(timesData: Vector3): HostAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| timesData accepts | typings.2002444080||
| Return Value | typings.-1531650254
overload 2:
HostAPI.titleTimes(fadeInTime: Integer, stayTime: Integer, fadeOutTime: Integer): HostAPI | Method Property | Fluent Description | Representation |
|---|---|---|
| fadeInTime accepts | typings.-672261858||
| stayTime accepts | typings.-672261858||
| fadeOutTime accepts | typings.-672261858||
| Return Value | typings.-1531650254
Write a warning directly to the minecraft log,
allowing for logging debug data without filling chat
overload 1:
HostAPI.warnToLog(string: String): nil | Method Property | Fluent Description | Representation |
|---|---|---|
| string accepts | typings.-1808118735||
| Return Value | typings.109073
Write directly to the minecraft log, allowing for
logging debug data without filling chat
overload 1:
HostAPI.writeToLog(string: String): nil | Method Property | Fluent Description | Representation |
|---|---|---|
| string accepts | typings.-1808118735||
| Return Value | typings.109073
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:
HostAPI.unlockCursor: Boolean | Method Property | Fluent Description | Representation |
|---|---|---|
| Field Type | typings.1729365000