FiguraMC/Figura — English (United States) @ Figura Localization: Removes either a function from this event or when given …

Source string Source string

Key

English (United States)

Removes either a function from this event or when given a string, remove all functions registered under that name
Returns the number of functions that were removed

Needs editing

The string is read only.

Skip

	Key	English (United States)	Actions
	figura.docs.events.skull_render	Called on every one of your skull blocks placed in the world It have 5 arguments, as listed below: (number) - the tick delta (blockstate) - the block, when rendered from a block (itemstack) - the item, when rendered from an item (entity) - the entity, when rendered from an entity (string) - the type of the rendering (LEFT_HAND, HEAD, BLOCK, …) If the return value is true, the skull will not render
	figura.docs.events.mouse_scroll	The MOUSE_SCROLL event runs every time the mouse is scrolled Takes a parameter delta, which is the direction of the scroll If returned true, the event cancels its vanilla function
	figura.docs.events.mouse_move	The MOUSE_MOVE event runs every time the mouse is moved around Takes two parameters, x and y, which is the difference from the mouse position based on the latest saved position If returned true, the event cancels its vanilla function Note that canceling the vanilla function also cancels saving the last mouse position
	figura.docs.events.mouse_press	The MOUSE_PRESS event runs every time a mouse button is pressed Takes three number parameters, a "button", which is the number id of the button that was been pressed, the "action", which is the status of the press event (0 for release, 1 for press, 2 for hold), and the "modifier", which is a bitmask number detecting if you have any modifier keys being pressed (like shift or alt, for example) If returned true, the event cancels its vanilla function
	figura.docs.events.key_press	The KEY_PRESS event runs every time a keyboard key is pressed Takes three number parameters, a "key", which is the number id of the key that was been pressed, the "action", which is the status of the press event (0 for release, 1 for press, 2 for hold), and the "modifier", which is a bitmask number detecting if you have any modifier keys being pressed (like shift or alt, for example) If returned true, the event cancels its vanilla function
	figura.docs.events.char_typed	The CHAR_TYPED event runs every time a character is inputted Takes three parameters, the resulting "string" after converting the code point, the "modifier", which is a bitmask number detecting if you have any modifier keys being pressed (like shift or alt, for example), and the "codepoint" of the inputted char
	figura.docs.events.use_item	The USE_ITEM event is run every time the entity uses an item The item, action and amount of particles this item would produce is given as argument If returned true, the event cancels its vanilla function
	figura.docs.events.arrow_render	The ARROW_RENDER event is run for every arrow entity shot by the Avatar owner It takes two arguments, the tick delta, and the arrow entity Returning "true" stops this arrow from rendering, including the Arrow parent parts Requires the "Vanilla Model Change" permission
	figura.docs.events.item_render	Called on every one of your items that is being rendered It takes six arguments: the item being rendered, the rendering mode, the position, rotation, and scale that would be applied to the item, and if it's being rendered in the left hand Returning a ModelPart parented to Item stops the rendering of this item and will render the returned part instead
	figura.docs.events.on_play_sound	Called every time a new sound is played Takes the following as arguments: the sound's ID, its world position, volume, pitch, if the sound should loop, the sound's category, and the sound's file path Return true to prevent this sound from playing
	figura.docs.events.resource_reload	Called every time that the client resources are reloaded, allowing you to re-create or update resource texture references
	figura.docs.events.get_events	Returns a table with all events types
	figura.docs.event	A hook for a certain event in Minecraft You may register functions to one, and those functions will be called when the event occurs
	figura.docs.event.register	Register a function on this event Functions are run in registration order An optional string argument can be given, grouping functions under that name, for an easier management later on
	figura.docs.event.clear	Clears the given event of all its functions
	figura.docs.event.remove	Removes either a function from this event or when given a string, remove all functions registered under that name Returns the number of functions that were removed
	figura.docs.event.get_registered_count	Returns the number of functions that are registered with the given name
	figura.docs.host	A global API dedicated to specifically the host of the avatar For other viewers, these do nothing
	figura.docs.host.unlock_cursor	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
	figura.docs.host.is_host	Returns true if this instance of the script is running on host
	figura.docs.host.is_cursor_unlocked	Checks if the cursor is currently unlocked Only responds to your own changes in your script, not anything done by Minecraft itself
	figura.docs.host.set_unlock_cursor	Toggles locking of your cursor, letting you move it freely on the screen instead of it controlling your player's rotation
	figura.docs.host.set_title_times	Sets the duration of the title on the screen, also its fade-in and fade-out durations
	figura.docs.host.clear_title	Clears the current title from the GUI
	figura.docs.host.set_title	Sets the current title to the given text The text is given as json
	figura.docs.host.set_subtitle	Sets the current subtitle to the given text The text is given as a JSON string
	figura.docs.host.set_actionbar	Sets the action bar message to the given text The boolean parameter defaults to false
	figura.docs.host.send_chat_message	Sends the given message in the chat
	figura.docs.host.send_chat_command	Sends the given command in the chat
	figura.docs.host.append_chat_history	Appends the message on the recent chat history
	figura.docs.host.get_chat_message	Returns a table with information about a chat message Takes an index, where 1 means the last message on chat

	Key	English (United States)	Actions
	figura.docs.enum.loop_modes	List of valid LoopModes Used within Blockbench animations
	figura.docs.enum.parent_types	List of valid ParentTypes Used within ModelParts
	figura.docs.enum.play_states	List of valid PlayStates Used within Blockbench animations
	figura.docs.enum.player_model_parts	List of valid PlayerModelParts Used within the PlayerAPI
	figura.docs.enum.post_effects	List of valid PostEffects Used within the RendererAPI
	figura.docs.enum.registries	A list of valid registries. Used in client.getRegistry to select the type of registry
	figura.docs.enum.render_modes	List of valid RenderModes Used within the RENDER event
	figura.docs.enum.render_types	List of valid RenderTypes Used within ModelParts
	figura.docs.enum.string_encodings	List of valid string encodings Used within Buffers
	figura.docs.enum.texture_types	List of valid TextureTypes Used within ModelParts
	figura.docs.enum.use_actions	List of valid UseActions Used within the ItemStackAPI
	figura.docs.event	A hook for a certain event in Minecraft You may register functions to one, and those functions will be called when the event occurs
	figura.docs.event.clear	Clears the given event of all its functions
	figura.docs.event.get_registered_count	Returns the number of functions that are registered with the given name
	figura.docs.event.register	Register a function on this event Functions are run in registration order An optional string argument can be given, grouping functions under that name, for an easier management later on
	figura.docs.event.remove	Removes either a function from this event or when given a string, remove all functions registered under that name Returns the number of functions that were removed
	figura.docs.events	A global API that contains all of the figura Events Accessed using the name "events"
	figura.docs.events.arrow_render	The ARROW_RENDER event is run for every arrow entity shot by the Avatar owner It takes two arguments, the tick delta, and the arrow entity Returning "true" stops this arrow from rendering, including the Arrow parent parts Requires the "Vanilla Model Change" permission
	figura.docs.events.char_typed	The CHAR_TYPED event runs every time a character is inputted Takes three parameters, the resulting "string" after converting the code point, the "modifier", which is a bitmask number detecting if you have any modifier keys being pressed (like shift or alt, for example), and the "codepoint" of the inputted char
	figura.docs.events.chat_receive_message	The CHAT_RECEIVE_MESSAGE event is run every time a message is received in chat The first argument is the raw string of the received text The second argument is a JSON string representation of the received text If the first return value is not nil, the message will be replaced with that value If the first return value is false, it will suppress adding this message The second return value is, optionally, an RGB vector which will be used as the background color for this message
	figura.docs.events.chat_send_message	The CHAT_SEND_MESSAGE event is run every time you send a message in chat A string parameter is passed in, which contains the message that was sent The return value is chained to the next events of the same type, whereas NIL cancels the message from being sent and any other value will modify the sent message (if allowed in the settings)
	figura.docs.events.entity_init	The ENTITY_INIT event is run once this avatar's entity exists
	figura.docs.events.get_events	Returns a table with all events types
	figura.docs.events.item_render	Called on every one of your items that is being rendered It takes six arguments: the item being rendered, the rendering mode, the position, rotation, and scale that would be applied to the item, and if it's being rendered in the left hand Returning a ModelPart parented to Item stops the rendering of this item and will render the returned part instead
	figura.docs.events.key_press	The KEY_PRESS event runs every time a keyboard key is pressed Takes three number parameters, a "key", which is the number id of the key that was been pressed, the "action", which is the status of the press event (0 for release, 1 for press, 2 for hold), and the "modifier", which is a bitmask number detecting if you have any modifier keys being pressed (like shift or alt, for example) If returned true, the event cancels its vanilla function
	figura.docs.events.mouse_move	The MOUSE_MOVE event runs every time the mouse is moved around Takes two parameters, x and y, which is the difference from the mouse position based on the latest saved position If returned true, the event cancels its vanilla function Note that canceling the vanilla function also cancels saving the last mouse position
	figura.docs.events.mouse_press	The MOUSE_PRESS event runs every time a mouse button is pressed Takes three number parameters, a "button", which is the number id of the button that was been pressed, the "action", which is the status of the press event (0 for release, 1 for press, 2 for hold), and the "modifier", which is a bitmask number detecting if you have any modifier keys being pressed (like shift or alt, for example) If returned true, the event cancels its vanilla function
	figura.docs.events.mouse_scroll	The MOUSE_SCROLL event runs every time the mouse is scrolled Takes a parameter delta, which is the direction of the scroll If returned true, the event cancels its vanilla function
	figura.docs.events.on_play_sound	Called every time a new sound is played Takes the following as arguments: the sound's ID, its world position, volume, pitch, if the sound should loop, the sound's category, and the sound's file path Return true to prevent this sound from playing
	figura.docs.events.post_render	The POST_RENDER event runs every frame after the avatar is rendered Takes a parameter delta, which is a number from 0 to 1 indicating the proportion of the way the game is between ticks A second parameter, giving out context of the current RenderMode, with is a string with the name of the source of this render event And a third parameter, being the source matrix used to render the Avatar

Loading…

None

String updated in the repository

English (United States)

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

10 months ago

Browse all string changes

Things to check

Multiple failing checks

Following checks are failing:
Mismatched full stop: Italian, Italian, French (Canada), French (Canada)

Reset

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.event.remove

Flags

read-only

String age

a year ago

Last updated

10 months ago

Source string age

a year ago

Translation file

v2/lang/en_us.json, string 1061