FiguraMC/Figura — English (United States) @ Figura Localization: Sets the function that is executed when this key is …

Source string Source string

Key

English (United States)

Sets the function that is executed when this key is pressed
The function has two arguments
The first argument is a number containing a bitmask of the currently held modifier keys
Shift = 1, Ctrl = 2, Alt = 4
The second argument is this keybind itself

Needs editing

The string is read only.

Skip

	Key	English (United States)	Actions
	figura.docs.itemstack.get_use_duration	Gets the number of ticks needed to "use" this item Currently only has a use for food items Always 32 for food items except kelp, which is 16
	figura.docs.itemstack.to_stack_string	Converts this ItemStack to a string, as you'd see in a command
	figura.docs.itemstack.is_armor	Checks if this item is Armor
	figura.docs.itemstack.is_tool	Check if this item is a Tool (Axe, Shovel, Pickaxe, …)
	figura.docs.itemstack.get_equipment_slot	Returns the slot name of where this item is used
	figura.docs.itemstack.copy	Returns a copy of this item stack
	figura.docs.itemstack.get_blockstate	Returns the blockstate representation of this item stack If this item has no block representation, returns nil
	figura.docs.keybinds	A global API containing a function to create new Keybind instances
	figura.docs.keybinds.new_keybind	Creates and returns a new Keybind The name is used in the keybind menu The key parameter is an identifier for a key, such as "key.keyboard.r" The boolean gui indicates whether the keybind should always work, or if it should only work when you don't have a screen open Check the docs enum command for all key names
	figura.docs.keybinds.from_vanilla	Creates a new Keybind based from a vanilla key
	figura.docs.keybinds.get_vanilla_key	Gets the id of the key bound to the given action, as a string Check the docs enum command for all key names and vanilla actions
	figura.docs.keybinds.get_keybinds	Returns a table with all registered keybinds
	figura.docs.keybind	Represents a key binding for your script Instances are obtained using the KeybindAPI's create() function
	figura.docs.keybind.press	A function that runs when the key is pressed down The function has two arguments The first argument is a number containing a bitmask of the currently held modifier keys Shift = 1, Ctrl = 2, Alt = 4 The second argument is this keybind itself If the return value is true then all vanilla keybinds using same key will be ignored
	figura.docs.keybind.release	A function that runs when the key is released The function has two arguments The first argument is a number containing a bitmask of the currently held modifier keys Shift = 1, Ctrl = 2, Alt = 4 The second argument is this keybind itself If the return value is true then all vanilla keybinds using same key will be ignored
	figura.docs.keybind.set_on_press	Sets the function that is executed when this key is pressed The function has two arguments The first argument is a number containing a bitmask of the currently held modifier keys Shift = 1, Ctrl = 2, Alt = 4 The second argument is this keybind itself
	figura.docs.keybind.set_on_release	Sets the function that is executed when this key is released The function has two arguments The first argument is a number containing a bitmask of the currently held modifier keys Shift = 1, Ctrl = 2, Alt = 4 The second argument is this keybind itself
	figura.docs.keybind.set_key	Sets the key for this keybind
	figura.docs.keybind.is_default	Checks whether this key is currently set to its default state (not been changed using the keybind menu)
	figura.docs.keybind.get_key	Gets the current key for this keybind
	figura.docs.keybind.get_key_name	Gets the name of the current key for this keybind
	figura.docs.keybind.get_name	Gets the name of the keybind, which you set when you created the keybind
	figura.docs.keybind.get_id	Returns the numeric ID of this keybind
	figura.docs.keybind.is_pressed	Gets whether this keybind is currently pressed down
	figura.docs.keybind.is_enabled	Returns if this keybind is enabled or not
	figura.docs.keybind.set_enabled	Toggles if this keybind should be processed or not
	figura.docs.keybind.is_gui_enabled	Returns if this keybind should work when a GUI screen (Chat, Inventory, etc) is open or not
	figura.docs.keybind.set_gui	Set whenever or not this keybind should run when a GUI screen is open
	figura.docs.matrices	A global API which provides functions dedicated to creating and otherwise manipulating matrices Accessed using the name "matrices"
	figura.docs.matrices.mat2	Creates a Matrix2 using the given parameters as columns If you call the function with no parameters, returns the 2x2 identity matrix
	figura.docs.matrices.mat3	Creates a Matrix3 using the given parameters as columns If you call the function with no parameters, returns the 3x3 identity matrix

	Key	English (United States)	Actions
	figura.docs.json_serializer.serialize	Serializes provided value to a JSON string
	figura.docs.keybind	Represents a key binding for your script Instances are obtained using the KeybindAPI's create() function
	figura.docs.keybind.get_id	Returns the numeric ID of this keybind
	figura.docs.keybind.get_key	Gets the current key for this keybind
	figura.docs.keybind.get_key_name	Gets the name of the current key for this keybind
	figura.docs.keybind.get_name	Gets the name of the keybind, which you set when you created the keybind
	figura.docs.keybind.is_default	Checks whether this key is currently set to its default state (not been changed using the keybind menu)
	figura.docs.keybind.is_enabled	Returns if this keybind is enabled or not
	figura.docs.keybind.is_gui_enabled	Returns if this keybind should work when a GUI screen (Chat, Inventory, etc) is open or not
	figura.docs.keybind.is_pressed	Gets whether this keybind is currently pressed down
	figura.docs.keybind.press	A function that runs when the key is pressed down The function has two arguments The first argument is a number containing a bitmask of the currently held modifier keys Shift = 1, Ctrl = 2, Alt = 4 The second argument is this keybind itself If the return value is true then all vanilla keybinds using same key will be ignored
	figura.docs.keybind.release	A function that runs when the key is released The function has two arguments The first argument is a number containing a bitmask of the currently held modifier keys Shift = 1, Ctrl = 2, Alt = 4 The second argument is this keybind itself If the return value is true then all vanilla keybinds using same key will be ignored
	figura.docs.keybind.set_enabled	Toggles if this keybind should be processed or not
	figura.docs.keybind.set_gui	Set whenever or not this keybind should run when a GUI screen is open
	figura.docs.keybind.set_key	Sets the key for this keybind
	figura.docs.keybind.set_on_press	Sets the function that is executed when this key is pressed The function has two arguments The first argument is a number containing a bitmask of the currently held modifier keys Shift = 1, Ctrl = 2, Alt = 4 The second argument is this keybind itself
	figura.docs.keybind.set_on_release	Sets the function that is executed when this key is released The function has two arguments The first argument is a number containing a bitmask of the currently held modifier keys Shift = 1, Ctrl = 2, Alt = 4 The second argument is this keybind itself
	figura.docs.keybinds	A global API containing a function to create new Keybind instances
	figura.docs.keybinds.from_vanilla	Creates a new Keybind based from a vanilla key
	figura.docs.keybinds.get_keybinds	Returns a table with all registered keybinds
	figura.docs.keybinds.get_vanilla_key	Gets the id of the key bound to the given action, as a string Check the docs enum command for all key names and vanilla actions
	figura.docs.keybinds.new_keybind	Creates and returns a new Keybind The name is used in the keybind menu The key parameter is an identifier for a key, such as "key.keyboard.r" The boolean gui indicates whether the keybind should always work, or if it should only work when you don't have a screen open Check the docs enum command for all key names
	figura.docs.living_entity	Acts as a proxy for a living entity in the Minecraft world
	figura.docs.living_entity.get_absorption_amount	Returns the amount of this entity's absorption (yellow hearts)
	figura.docs.living_entity.get_active_hand	Returns "OFF_HAND" or "MAIN_HAND", depending on which hand this entity uses an item with
	figura.docs.living_entity.get_active_item	Returns an ItemStack representing the item the entity is currently using If they're not using any item, returns air
	figura.docs.living_entity.get_active_item_time	Returns the ticks this entity's active item has been used for
	figura.docs.living_entity.get_armor	Returns the amount of armor points this entity has
	figura.docs.living_entity.get_arrow_count	Returns the number of arrows sticking out of this entity
	figura.docs.living_entity.get_body_yaw	Gets the yaw of this entity's body in degrees If delta is passed in, then it will be used to linearly interpolate the rotation of the body between the previous tick and the current tick The default value of delta is 1

Loading…

None

String updated in the repository

English (United States)

English (United States) 43 characters edited Current translation Read only

a year ago

Browse all string changes

Things to check

Long untranslated

The string has not been translated for a long time

Reset

Glossary

English (United States)	English (United States)
No related strings found in the glossary.

String information

Key

figura.docs.keybind.set_on_press

Flags

read-only

String age

a year ago

Last updated

a year ago

Source string age

a year ago

Translation file

v2/lang/en_us.json, string 1140