Tutorials/Commands: Difference between revisions

Latest revision as of 17:18, 27 September 2024

Figura comes with a small set of commands to act as menu shortcuts or access advanced features. As Figura is a client-side mod, these only affect the client.

⚠ Warning

Figura commands are only visible client-side and therefore cannot be used server-side (e.g. in command blocks or functions, or even in /execute). If you try, it will appear as an invalid command.

/figura docs: This command allows you to quickly access a list of types (and their fields/methods) and enums (and their values), as well as a brief description for each one. Note that some internal docs may

/figura emojis: This command lists all the emojis added by Figura. /figura emojis all can show you all of them at once.

/figura export avatar: This exports your currently saved avatar data to a file in your Figura directory. The

/figura links: This command prints a list of links to various Figura websites.

/figura load directory: This command loads a Figura avatar by the name of its directory in your avatars folder. This can be useful if you don't want to open the Figura menu, or you have a lot of avatars and don't want to search through them.

/figura reload: This command reloads your currently-selected avatar, equivalent to pressing your reload keybind.

/figura run code: This command runs the code you supply in the context of your avatar, with the ability to access any global variables you've declared. If you don't have an avatar selected, or its script has errored. you will not be able to run code.

Debug Mode Commands

More commands can be unlocked by turning Debug Mode on in Figura’s settings and rejoining the world..

/figura debug: This generates a file in your Figura directory that contains information about your Figura mod settings and the avatar you currently have equipped. This includes the file sizes of all of the elements in the avatar. This command is currently broken on Forge.

/figura backend2: Usage unknown; presumably used to test the Figura backend.

/figura set_avatar to from: This command copies equipped avatars between entities, which allows you to e.g. test CEM avatars. Note that both arguments must be the entities' UUIDs — merely their name or a selector will not be accepted.

to: This is the UUID of the entity you wish to set the avatar of. You can get the UUID by autocompleting a command, such as /tp, while looking at them. (This command also works on players, somewhat.)

from: This is the UUID of the entity you want to copy the avatar from. You can acquire this by using the command /list uuids (check your game logs if you wish to copy the output) or a website such as [1].

@@ Line 1: / Line 1: @@
-Figura comes with a small set of commands that can help you use Figura. As Figura is a client-side mod these only affect the client.
+Figura comes with a small set of commands to act as menu shortcuts or access advanced features. As Figura is a client-side mod, these only affect the client.
+{{note|Figura commands are '''only visible client-side''' and therefore cannot be used server-side (e.g. in command blocks or functions, or even in <code>/execute</code>). If you try, it will appear as an invalid command.|tag=Warning|icon=⚠}}
 <span id="normal-commands"></span>
-== Normal Commands ==
+; <code name="docs">/figura docs</code>
+: This command allows you to quickly access a list of types (and their fields/methods) and enums (and their values), as well as a brief description for each one. Note that some internal docs may
-<span id="debug"></span>
-=== Debug ===
-Usage: <code>/figura debug</code>
-Debug generates a file in your Figura directory that contains information about your Figura mod settings and the avatar you currently have equipped. This includes the file sizes of all of the elements in the avatar.
-<span id="docs"></span>
-=== Docs ===
-Usage: <code>/figura docs</code>
-Docs contains all of the documentation you can find in the Globals and Enums section of this wiki, simply use autofill to discover all of the options.
-<span id="emojis"></span>
-=== Emojis ===
-Usage: <code>/figura emojis</code>
-Emojis contains a list of all the emojis added by Figura. <code>/figura emojis all</code> can show you all of them at once.
-<span id="export"></span>
+; <code name="emojis>/figura emojis</code>
+: This command lists all the emojis added by Figura. <code>/figura emojis all</code> can show you all of them at once.
-=== Export ===
+; <code name="export_avatar>/figura export avatar</code>
+: This exports your currently saved avatar data to a file in your Figura directory. The
+; <code>/figura links</code>
+: This command prints a list of links to various Figura websites.
+; <code>/figura load ''directory''</code>
+: This command loads a Figura avatar by the name of its ''directory'' in your avatars folder. This can be useful if you don't want to open the Figura menu, or you have a lot of avatars and don't want to search through them.
-Usage: <code>/figura export avatar</code>
+; <code>/figura reload</code>
+: This command reloads your currently-selected avatar, equivalent to pressing your reload keybind.
+; <code>/figura run ''code''</code>
+: This command runs the code you supply in the context of your avatar, with the ability to access any '''global''' variables you've declared. If you don't have an avatar selected, or its script has errored. you will not be able to run code.
-Export, as the name suggests, exports certain files to your Figura directory. The most useful is <code>/figura export avatar</code> which puts your currently worn avatar’s moon file into your directory. If you’ve lost your avatar and it’s still on Figura’s backend, you can retrieve its .moon file with this command.
-<span id="links"></span>
-=== Links ===
-<code>/figura links</code>
-Links contains all the links for various Figura pages.
-<span id="load"></span>
-=== Load ===
-[WIP]
-<span id="reload"></span>
-=== Reload ===
-<code>/figura reload</code>
-Reload reloads your currently equipped avatar.
-<span id="run"></span>
-=== Run ===
-Usage: <code>/figura run log(&quot;Hello World&quot;)</code>
-Run runs whatever lua code you type after it.
-<span id="debug-mode-commands"></span>
 == Debug Mode Commands ==
+More commands can be unlocked by turning Debug Mode on in Figura’s settings and rejoining the world..
+; <code name="debug">/figura debug</code>
+: This generates a file in your Figura directory that contains information about your Figura mod settings and the avatar you currently have equipped. This includes the file sizes of all of the elements in the avatar. ''This command is currently broken on Forge.''
-More commands can be unlocked by turning Debug Mode on in Figura’s settings.
+; <code name="backend2">/figura backend2</code>
+: Usage unknown; presumably used to test the Figura backend.
-<span id="backend2"></span>
-=== Backend2 ===
-[WIP]
-<span id="set_avatar"></span>
-=== Set_Avatar ===
-Usage: <code>/figura set_avatar targetuuid sourceuuid</code>
-Set_avatar can be used to set the avatar of an entity using its uuid. targetuuid is the entity whose avatar is being set, and sourceuuid is the entity from where the avatar is coming from. For example, if you were to set a cow to have the avatar you’re wearing, the cow’s uuid would be the targetuuid and your uuid would be the sourceuuid.
+; <code name="set_avatar">/figura set_avatar ''to'' ''from''</code>
+: This command copies equipped avatars between entities, which allows you to e.g. test [[CEM]] avatars. Note that both arguments must be the entities' '''UUIDs''' — merely their name or a selector will not be accepted.
+: {{tagged|<code>to</code>|This is the UUID of the entity you wish to set the avatar of. You can get the UUID by autocompleting a command, such as <code>/tp</code>, while looking at them. (This command also works on players, somewhat.)}}
+: {{tagged|<code>from</code>|This is the UUID of the entity you want to copy the avatar ''from''. You can acquire this by using the command <code>/list uuids</code> (check your game logs if you wish to copy the output) or a website such as [https://mcuuid.net].}}