FiguraMC - User contributions [en]

User:Slyme/Drafts/Lua Basics

2024-11-04T03:31:04Z

Slyme:

{{Notice/Warning
|content='''This page is ''heavily'' unfinished.'''<br>For the time being, please visit the real [[Lua Basics]] page.
}}

{{Notice
|content='''This document only goes over the syntax of Lua.'''<br>
* For more specific documents (such as ones going over variables, functions, etc.), please scroll to the bottom of the page or [[#See more|click here]].
}}

User:Slyme/Drafts/Lua Basics/Values

2024-11-04T03:30:59Z

Slyme: Created page with "{{Notice |content='''This article is part of a larger series on the Lua Basics.'''<br> * Please check out the Lua Basics if you haven't already. * For more documents within this series, please scroll to the bottom of the page or click here. }} '''Values''' are essentially data within Lua. Values can be passed into functions as arguments and can be stored in variables for future use. There are several different ty..."

User:Slyme/Drafts/Lua Basics

2024-10-07T03:29:31Z

Slyme: Removed redirect to User:Slyme/Discards/Lua Basics

{{Notice/Warning
|content='''This page is ''heavily'' unfinished.'''<br>For the time being, please visit the real [[Lua Basics]] page.
}}

User:Slyme/Discards/Lua Basics

2024-10-07T03:29:22Z

Slyme:

{{Notice/Warning
|content='''This page has been discarded.'''<br>
No more work will be done on this page.
}}

==The Interpreter==
The interpreter is just the thing that runs your Lua code. In Figura's case, it's a [https://github.com/FiguraMC/luaj/ custom version of LuaJ], an interpreter written in Java.

A Lua interpreter reads each line sequentially, executing each line before moving on to the next one. This makes it hard to break away from the sequence without breaking the program entirely for something like a sleep call.
==Comments==
Comments are used to tell the interpreter to ignore a part of the code, either because it's for human programmers to see or it's a piece of code that should not be executed.

Short comments, comments that only affect one line, start with <code>--</code>. From the two dashes to the end of the line, code will be ignored.
{{Script
|script=--This is a comment.
local x = 2 -- Everything after the two dashes will be ignored.
-- local y = 3 -- The preceding code will not run because it's part of a comment.
-- This is useful in case you need to document your code for future programmers or you need to stop code from running without removing it from the script.
}}
===Long Comments===
Long comments, comments that can go over multiple lines, come in the form of <code>--[[ ]]</code>. Everything between the two brackets is commented and, thus, ignored by the interpreter.
{{Script
|script=--[[
This is a block comment. None of the
lines within the comment will be executed
until the final bracket.
--]] -- Sometimes programmers will put two dashes before the end of block comments. This is not required but looks nice.
local z = 5 -- You can use both types of comments within the same script.
--[[
Block comments are useful for long
explanations of code or for ignoring
large swaths of code.
]]
}}
==Variables==
Think of variables as a bunch of boxes. Each variable is one box, a label printed on it with an object (or, in some cases, a few) stored inside.

To put something inside a variable, you'll want to set it equal to that something. For example...
{{Script
|script=local a = 247 -- Make a new local variable "a" and set the value within to be the number 247.
local b = "Hello, World!" -- Make a new local variable "b" and set the value within to be the string "Hello, World!"
c = 10 -- Make a new *global* variable "c" and set the value within to be the number 10.
}}
The last variable, <code>c</code>, is a global variable. This means that it can be used ''anywhere'' within the Lua environment. While this may seem like a good thing at first, there are many cases where this may not be a thing you want. For example, let's see how a system like below, assuming each script is run in sequence in the same environment, would fare with global variables
{{Script
|script=script = 1
return function() return script end
|name=test-script-1.lua
}}
{{Script
|script=script = 2
return function() return script end
|name=test-script-2.lua
}}
{{Script
|script=script = 3
return function() return script end
|name=test-script-3.lua
}}
{{Script
|script=print(require("test-script-1")()) --> 3
print(require("test-script-2")()) --> 3
print(require("test-script-3")()) --> 3
|name=script-checker.lua
}}
We'll get more into variable scopes later. Watch out for all other instances of <code>c</code> throughout the rest of the document, it may interfere with other scripts. ;)
=== Valid Names ===
Variable names...
* Can only use alphanumeric characters and <code>_</code>
* Must not start with a number.
* Cannot be the same as a Lua keyword (<code>and</code>, <code>or</code>, <code>if</code>, <code>while</code>, etc.)
For instance...
{{Script
|script=local a -- ✅ Valid
local _b -- ✅ Valid
local aBc123 -- ✅ Valid
local 123abc -- ❌ Invalid; Variable names cannot start with a number.
local foo-bar -- ❌ Invalid; Variable names can only use alphanumeric characters.
local and -- ❌ Invalid; Variable names cannot be the same as a Lua keyword.
local local -- ❌ Invalid; Variable names cannot be the same as a Lua keyword.
}}
=== Declaring Without Setting ===
In some cases, you may want to declare a local variable without setting its value. This can be done by just writing <code>local variableName</code> without adding a <code>=</code>
{{Script
|script=local a -- a is now initialized as a local variable with no value.
print(a) --> nil
a = 3 -- Variables already declared as locals do not need to be marked as local again.
print(a) --> 3
}}
==Types==
A type is any sort of object, whether it be a few words, a number, a true/false value, etc.
==={{Type|boolean}}===
Booleans hold one of two values: <code>true</code> or <code>false</code>.

These are typically returned when a relational operator (<code>==</code>, <code>></code>, <code><=</code>, etc.) or a boolean operator (<code>not</code>, <code>and</code>, etc.) is used.
{{Script
|script=print(true) --> true
print(5 > 3) --> true
print(10 <= 6) --> false
print(true and false) --> false
}}
==={{Type|number}}===
Numbers are numbers, either integer or decimal.

Numbers are typically returned when an arithmetic operator (<code>+</code>, <code>-</code>, <code>*</code>, <code>/</code>, etc.) is used.
{{Script
|script=print(5) --> 5
print(5 + 2) --> 7
print(5 * 2) --> 10
print(5 / 2) --> 2.5
}}
==={{Type|string}}===
Strings are sequences of characters, most notably text. When defined in code, strings must be wrapped in either quotes (<code>"</code>) or single quotes (<code>'</code>).

Strings can be modified using the [https://www.lua.org/manual/5.2/manual.html#6.4 String standard library], accessible using either the <code>string</code> global or by using the methods on strings themselves.

When defining a string in code, make sure to use <code>\n</code> in place of linebreaks within the string. Using real line breaks instead of <code>\n</code> will result in a syntax error.

You may also need to escape single/double quotes in case the character you want to use is already used to wrap the string. In that case, just put a backslash (<code>\</code>) in front of the character to escape it (for example, <code>"\""</code> is the same as <code>'"'</code>).
====Literal Strings====
Strings, when surrounded by double brackets (<code>[[]]</code>), take characters at face value. These are called literal strings and can be used to make a string span multiple lines.
{{Script
|script=print("Hello, World!") --> Hello, World!
print("\"Line 1\"
'Line 2'") -- ERROR! unfinished string near '""Line 1"'
print("\"Line 1\"\n'Line 2'") --> "Line 1"
-- 'Line 2'
print([["Line 1"
'Line 2']]) --> "Line 1"
-- 'Line 2'
}}
==={{Type|nil}}===
Unlike other types, {{Type|nil}} is the ''absence'' of a value. This is what's returned when you try to use a variable not defined yet.
{{Script
|script=print(a) --> nil
print(b) --> nil
print(c) --> 10
-- Oh, there's our lovely little global "c" again! Didn't expect that, did you?
}}
Scripts can at best return/display unwanted values and at worst error if a {{Type|nil}} pops up where it shouldn't.
{{Script
|script=string = nil
local a = "Hello, World!"
print(string.sub(a, 2, 5)) -- ERROR! attempt to index a nil value (global 'string')}}
==={{Type|table}}===
Tables are where things start to get more complex. Instead of containing ''one'' object, tables can store ''many'' objects in multiple different ways.

For instance, a table can store a sequence of objects. This is commonly called an array. Arrays start at an index of one and continue counting up for each item added to the table.

However, you don't ''just'' have to use numbers as indices. You can use any basic object (boolean, number, string, nil) you want! Doing so makes what's commonly called a dictionary, the indices called keys and the values called values.
{{Script
|script=local a = {"Hello,", "World!"}
print(a[1]) --> Hello,
a["diamond"] = true
print(a.diamond) --> true -- Doing something like a.diamond is the same as doing a["diamond"]
local b = {
[c] = true, -- I hope you remember what c is!
[true] = 56,
[5<3] = b or c -- Expressions can be used as keys and/or values. In this case, (5<3) comes out to true and (c and d) comes out to 10 since d is nil and global c is still 10.
["foo"] = "bar"
xyz = "abc" -- String keys can be removed from their brackets and quotes as long as they follow the variable name rules above.
}
print(b[b.foo == "bar"]) --> 56 -- Expressions can also be used to index a table.
}}
Sometimes, you may want to go over all items within a table. This can be done with a [[#Loops|for loop]].

User:Slyme/Drafts/Lua Basics/Variables

2024-10-07T03:28:06Z

Slyme: First- nope, Second Draft

{{Notice
|content='''This article is part of a larger series on the [[../|Lua Basics]].'''<br>
* Please check out the [[Lua Basics]] if you haven't already.
* For more documents within this series, please scroll to the bottom of the page or [[#See more|click here]].
}}

'''Variables''' are the way Lua stores values for later use. Think of them like several labeled boxes. For our purposes, each box contains one [[../Values|value]]. Whenever you ask for the contents of a specific variable, Lua looks for it, finds it, and reports back with the contents.
==Declaring a Variable==
Variables can be made by typing a variable name, an equal sign (<code>=</code>), and a value or expression. They can then be used in place of values and can be modified later within a script.
{{Script
|script=a = "Hello, World!" -- Here, we store the string value "Hello, World!" within the variable "a"
print(a) --> Hello, World!
a = a .. " You are amazing!" -- We add " You are amazing!" to the end of "Hello, World!" to form...
print(a) --> Hello, World! You are amazing!
}}
Lua is a dynamically typed language, which means that any variable can hold any value regardless of what it originally held.
{{Script
|script=a = "Hello, World!"
a = 5
a = true
print(a) --> true
}}
===Valid Names===
Variable names...
* Can only use alphanumeric characters and underscores (<code>_</code>).
* Must not start with a number.
* Cannot be the same as a Lua keyword (<code>and</code>, <code>or</code>, <code>if</code>, <code>while</code>, etc.)
For instance...
* ✅ <code>a</code> is a valid variable name.
* ✅ <code>_b</code> is a valid variable name.
* ✅ <code>aBc123</code> is a valid variable name.
* ❌ <code>123abc</code> is an '''invalid''' variable name; variable names cannot start with a number.
* ❌ <code>foo-bar</code> is an '''invalid''' variable name; variable name can only use alphanumeric characters and underscores (<code>_</code>)
* ❌ <code>and</code> is an '''invalid''' variable name; variable names cannot be the same as a Lua keyword.
* ❌ <code>local</code> is an '''invalid''' variable name; variable names cannot be the same as a Lua keyword.
==Issues with Global Variables==
By default, new variables declared within Lua are global. This means that they can be used ''anywhere'' within the Lua environment once declared. This can lead to some adverse effects.

For starters, scripts can cause interference with other scripts if they all use the same name for a global variable.

These issues can be fixed with [[#Local Variables|local variables]].
==Local Variables==
'''Local variables''' are limited to their own [[#Variable Scope|scope]], meaning that only instructions within it can access their contents. A new local variable can be created by putting <code>local</code> behind the first declaration of the variable.

To use the same local variable within the same scope, make sure to '''not''' use the <code>local</code> tag for the variable again. If not...
{{Script
|script=local var = 5
do
print(var) --> 5
local var = var*2
print(var) --> 10
end
print(var) --> 5
}}
<includeonly>
----
==Global Variables==
Global variables are very simple: from the point of its declaration onward, any script in the environment who doesn't have a local variable with the same name can use the global variable. This can lead to adverse effects.

For one, globals may or may not be defined. If not, trying to use it will result in a {{Type|nil}} being returned instead of a useful value. This may not be what you want in most cases, especially when you intend to use it in an expression, in which case your script will most likely error.
{{Script
|name=script-1.lua
|script=-- ...
print(c*2) -- ERROR! attempt to perform arithmetic on a nil value (global 'c')
-- ...
}}{{Script
|name=script-2.lua
|script=-- ...
c = 10
-- ...
}}
==Local Variables==
Whenever a local variable is declared, its scope will extend to the end of the block it is currently in. For example...
{{Script
|script=local var = 5
do
print(var) --> 5
local var = var*2
print(var) --> 10
end
print(var) --> 5
|highlight=3-5,7
}}
* The first print instruction on line three will print the local variable just outside the <code>do ... end</code> block since that's the last time a local variable within its scope was declared with that name.
* The local variable declaration on line four is able to use the old <code>var</code> local variable since the one on line five only overshadows it ''after'' its declaration.
* The second print instruction on line five will use the newly declared local variable <code>var</code> since it's the closest within its scope.
* The final print instruction on line seven will use the older local variable <code>var</code> since the newer one on line four is now out of scope since it was defined in a block further inside.

Template:Script

2024-10-07T01:57:51Z

Slyme: Add highlight parameter

<templatestyles src="Template:Script/style.css"/>
<div class="scriptbox">{{#if:{{{name|}}}|<div class="scriptname">{{{name}}}</div>|}}
{{#tag:syntaxHighlight|{{{1|{{{script}}}}}}
|lang="lua"
|start={{{line}}}
|line=
|highlight={{{highlight}}}}}
</div>
<noinclude>
<templatedata>
{
"params": {
"name": {
"label": "Script Name",
"type": "content",
"required": false,
"description": "The name of the script, to be shown as a label header."
},
"script": {
"aliases": [
"1"
],
"label": "Script",
"type": "string",
"required": true,
"description": "The script to be displayed"
},
"line": {
"label": "Line Number",
"type": "number",
"required": false,
"description": "What number to start counting on."
},
"highlight": {
"label": "Highlighted Lines",
"type": "string",
"required": false,
"description": "Lines to highlight."
}
},
"paramOrder": [
"script",
"name",
"line",
"highlight"
]
}
</templatedata>
</noinclude>

User:Slyme/Drafts/Lua Basics

2024-10-07T01:27:16Z

Slyme: Slyme moved page User:Slyme/Drafts/Lua Basics to User:Slyme/Discards/Lua Basics: Discarded draft

#REDIRECT [[User:Slyme/Discards/Lua Basics]]

User:Slyme/Discards/Lua Basics

2024-10-07T01:27:16Z

Slyme: Slyme moved page User:Slyme/Drafts/Lua Basics to User:Slyme/Discards/Lua Basics: Discarded draft

{{Notice/Warning
|content='''This page is ''heavily'' unfinished.'''<br>For the time being, please visit the real [[Lua Basics]] page.
}}

==The Interpreter==
The interpreter is just the thing that runs your Lua code. In Figura's case, it's a [https://github.com/FiguraMC/luaj/ custom version of LuaJ], an interpreter written in Java.

A Lua interpreter reads each line sequentially, executing each line before moving on to the next one. This makes it hard to break away from the sequence without breaking the program entirely for something like a sleep call.
==Comments==
Comments are used to tell the interpreter to ignore a part of the code, either because it's for human programmers to see or it's a piece of code that should not be executed.

Short comments, comments that only affect one line, start with <code>--</code>. From the two dashes to the end of the line, code will be ignored.
{{Script
|script=--This is a comment.
local x = 2 -- Everything after the two dashes will be ignored.
-- local y = 3 -- The preceding code will not run because it's part of a comment.
-- This is useful in case you need to document your code for future programmers or you need to stop code from running without removing it from the script.
}}
===Long Comments===
Long comments, comments that can go over multiple lines, come in the form of <code>--[[ ]]</code>. Everything between the two brackets is commented and, thus, ignored by the interpreter.
{{Script
|script=--[[
This is a block comment. None of the
lines within the comment will be executed
until the final bracket.
--]] -- Sometimes programmers will put two dashes before the end of block comments. This is not required but looks nice.
local z = 5 -- You can use both types of comments within the same script.
--[[
Block comments are useful for long
explanations of code or for ignoring
large swaths of code.
]]
}}
==Variables==
Think of variables as a bunch of boxes. Each variable is one box, a label printed on it with an object (or, in some cases, a few) stored inside.

To put something inside a variable, you'll want to set it equal to that something. For example...
{{Script
|script=local a = 247 -- Make a new local variable "a" and set the value within to be the number 247.
local b = "Hello, World!" -- Make a new local variable "b" and set the value within to be the string "Hello, World!"
c = 10 -- Make a new *global* variable "c" and set the value within to be the number 10.
}}
The last variable, <code>c</code>, is a global variable. This means that it can be used ''anywhere'' within the Lua environment. While this may seem like a good thing at first, there are many cases where this may not be a thing you want. For example, let's see how a system like below, assuming each script is run in sequence in the same environment, would fare with global variables
{{Script
|script=script = 1
return function() return script end
|name=test-script-1.lua
}}
{{Script
|script=script = 2
return function() return script end
|name=test-script-2.lua
}}
{{Script
|script=script = 3
return function() return script end
|name=test-script-3.lua
}}
{{Script
|script=print(require("test-script-1")()) --> 3
print(require("test-script-2")()) --> 3
print(require("test-script-3")()) --> 3
|name=script-checker.lua
}}
We'll get more into variable scopes later. Watch out for all other instances of <code>c</code> throughout the rest of the document, it may interfere with other scripts. ;)
=== Valid Names ===
Variable names...
* Can only use alphanumeric characters and <code>_</code>
* Must not start with a number.
* Cannot be the same as a Lua keyword (<code>and</code>, <code>or</code>, <code>if</code>, <code>while</code>, etc.)
For instance...
{{Script
|script=local a -- ✅ Valid
local _b -- ✅ Valid
local aBc123 -- ✅ Valid
local 123abc -- ❌ Invalid; Variable names cannot start with a number.
local foo-bar -- ❌ Invalid; Variable names can only use alphanumeric characters.
local and -- ❌ Invalid; Variable names cannot be the same as a Lua keyword.
local local -- ❌ Invalid; Variable names cannot be the same as a Lua keyword.
}}
=== Declaring Without Setting ===
In some cases, you may want to declare a local variable without setting its value. This can be done by just writing <code>local variableName</code> without adding a <code>=</code>
{{Script
|script=local a -- a is now initialized as a local variable with no value.
print(a) --> nil
a = 3 -- Variables already declared as locals do not need to be marked as local again.
print(a) --> 3
}}
==Types==
A type is any sort of object, whether it be a few words, a number, a true/false value, etc.
==={{Type|boolean}}===
Booleans hold one of two values: <code>true</code> or <code>false</code>.

These are typically returned when a relational operator (<code>==</code>, <code>></code>, <code><=</code>, etc.) or a boolean operator (<code>not</code>, <code>and</code>, etc.) is used.
{{Script
|script=print(true) --> true
print(5 > 3) --> true
print(10 <= 6) --> false
print(true and false) --> false
}}
==={{Type|number}}===
Numbers are numbers, either integer or decimal.

Numbers are typically returned when an arithmetic operator (<code>+</code>, <code>-</code>, <code>*</code>, <code>/</code>, etc.) is used.
{{Script
|script=print(5) --> 5
print(5 + 2) --> 7
print(5 * 2) --> 10
print(5 / 2) --> 2.5
}}
==={{Type|string}}===
Strings are sequences of characters, most notably text. When defined in code, strings must be wrapped in either quotes (<code>"</code>) or single quotes (<code>'</code>).

Strings can be modified using the [https://www.lua.org/manual/5.2/manual.html#6.4 String standard library], accessible using either the <code>string</code> global or by using the methods on strings themselves.

When defining a string in code, make sure to use <code>\n</code> in place of linebreaks within the string. Using real line breaks instead of <code>\n</code> will result in a syntax error.

You may also need to escape single/double quotes in case the character you want to use is already used to wrap the string. In that case, just put a backslash (<code>\</code>) in front of the character to escape it (for example, <code>"\""</code> is the same as <code>'"'</code>).
====Literal Strings====
Strings, when surrounded by double brackets (<code>[[]]</code>), take characters at face value. These are called literal strings and can be used to make a string span multiple lines.
{{Script
|script=print("Hello, World!") --> Hello, World!
print("\"Line 1\"
'Line 2'") -- ERROR! unfinished string near '""Line 1"'
print("\"Line 1\"\n'Line 2'") --> "Line 1"
-- 'Line 2'
print([["Line 1"
'Line 2']]) --> "Line 1"
-- 'Line 2'
}}
==={{Type|nil}}===
Unlike other types, {{Type|nil}} is the ''absence'' of a value. This is what's returned when you try to use a variable not defined yet.
{{Script
|script=print(a) --> nil
print(b) --> nil
print(c) --> 10
-- Oh, there's our lovely little global "c" again! Didn't expect that, did you?
}}
Scripts can at best return/display unwanted values and at worst error if a {{Type|nil}} pops up where it shouldn't.
{{Script
|script=string = nil
local a = "Hello, World!"
print(string.sub(a, 2, 5)) -- ERROR! attempt to index a nil value (global 'string')}}
==={{Type|table}}===
Tables are where things start to get more complex. Instead of containing ''one'' object, tables can store ''many'' objects in multiple different ways.

For instance, a table can store a sequence of objects. This is commonly called an array. Arrays start at an index of one and continue counting up for each item added to the table.

However, you don't ''just'' have to use numbers as indices. You can use any basic object (boolean, number, string, nil) you want! Doing so makes what's commonly called a dictionary, the indices called keys and the values called values.
{{Script
|script=local a = {"Hello,", "World!"}
print(a[1]) --> Hello,
a["diamond"] = true
print(a.diamond) --> true -- Doing something like a.diamond is the same as doing a["diamond"]
local b = {
[c] = true, -- I hope you remember what c is!
[true] = 56,
[5<3] = b or c -- Expressions can be used as keys and/or values. In this case, (5<3) comes out to true and (c and d) comes out to 10 since d is nil and global c is still 10.
["foo"] = "bar"
xyz = "abc" -- String keys can be removed from their brackets and quotes as long as they follow the variable name rules above.
}
print(b[b.foo == "bar"]) --> 56 -- Expressions can also be used to index a table.
}}
Sometimes, you may want to go over all items within a table. This can be done with a [[#Loops|for loop]].

User:Slyme/Discards/Lua Basics

2024-10-07T01:26:11Z

Slyme: Final edit before discarding.

User:Slyme/Discards/Lua Basics

2024-10-06T05:20:33Z

Slyme: First Draft, following sorta closely to the original.

{{Notice/Warning
|content='''This page is ''heavily'' unfinished.'''<br>For the time being, please visit the real [[Lua Basics]] page.
}}

==The Interpreter==
The interpreter is just the thing that runs your Lua code. In Figura's case, it's a [https://github.com/FiguraMC/luaj/ custom version of LuaJ], an interpreter written in Java.

A Lua interpreter reads each line sequentially, executing each line before moving on to the next one. This makes it hard to break away from the sequence without breaking the program entirely for something like a sleep call.
==Comments==
Comments are used to tell the interpreter to ignore a part of the code, either because it's for human programmers to see or it's a piece of code that should not be executed.

Short comments, comments that only affect one line, start with <code>--</code>. From the two dashes to the end of the line, code will be ignored.
{{Script
|script=--This is a comment.
local x = 2 -- Everything after the two dashes will be ignored.
-- local y = 3 -- The preceding code will not run because it's part of a comment.
-- This is useful in case you need to document your code for future programmers or you need to stop code from running without removing it from the script.
}}
===Long Comments===
Long comments, comments that can go over multiple lines, come in the form of <code>--[[ ]]</code>. Everything between the two brackets is commented and, thus, ignored by the interpreter.
{{Script
|script=--[[
This is a block comment. None of the
lines within the comment will be executed
until the final bracket.
--]] -- Sometimes programmers will put two dashes before the end of block comments. This is not required but looks nice.
local z = 5 -- You can use both types of comments within the same script.
--[[
Block comments are useful for long
explanations of code or for ignoring
large swaths of code.
]]
}}
==Variables==
Think of variables as a bunch of boxes. Each variable is one box, a label printed on it with an object (or, in some cases, a few) stored inside.

To put something inside a variable, you'll want to set it equal to that something. For example...
{{Script
|script=local a = 247 -- Make a new local variable "a" and set the value within to be the number 247.
local b = "Hello, World!" -- Make a new local variable "b" and set the value within to be the string "Hello, World!"
c = 10 -- Make a new *global* variable "c" and set the value within to be the number 10.
}}
The last variable, <code>c</code>, is a global variable. This means that it can be used ''anywhere'' within the Lua environment. While this may seem like a good thing at first, there are many cases where this may not be a thing you want. For example, let's see how a system like below, assuming each script is run in sequence in the same environment, would fare with global variables
{{Script
|script=script = 1
return function() return script end
|name=test-script-1.lua
}}
{{Script
|script=script = 2
return function() return script end
|name=test-script-2.lua
}}
{{Script
|script=script = 3
return function() return script end
|name=test-script-3.lua
}}
{{Script
|script=print(require("test-script-1")()) --> 3
print(require("test-script-2")()) --> 3
print(require("test-script-3")()) --> 3
|name=script-checker.lua
}}
Watch out for all other instances of <code>c</code> throughout the rest of the document, it may interfere with other scripts. ;)
=== Valid Names ===
Variable names...
* Can only use alphanumeric characters and <code>_</code>
* Must not start with a number.
* Cannot be the same as a Lua keyword (<code>and</code>, <code>or</code>, <code>if</code>, <code>while</code>, etc.)
For instance...
{{Script
|script=local a -- ✅ Valid
local _b -- ✅ Valid
local aBc123 -- ✅ Valid
local 123abc -- ❌ Invalid; Variable names cannot start with a number.
local foo-bar -- ❌ Invalid; Variable names can only use alphanumeric characters.
local and -- ❌ Invalid; Variable names cannot be the same as a Lua keyword.
local local -- ❌ Invalid; Variable names cannot be the same as a Lua keyword.
}}
=== Declaring Without Setting ===
In some cases, you may want to declare a local variable without setting its value. This can be done by just writing <code>local variableName</code> without adding a <code>=</code>
{{Script
|script=local a -- a is now initialized as a local variable with no value.
print(a) --> nil
a = 3 -- Variables already declared as locals do not need to be marked as local again.
print(a) --> 3
}}
==Types==
A type is any sort of object, whether it be a few words, a number, a true/false value, etc.
==={{Type|boolean}}===
Booleans hold one of two values: <code>true</code> or <code>false</code>.

These are typically returned when a relational operator (<code>==</code>, <code>></code>, <code><=</code>, etc.) or a boolean operator (<code>not</code>, <code>and</code>, etc.) is used.
{{Script
|script=print(true) --> true
print(5 > 3) --> true
print(10 <= 6) --> false
print(true and false) --> false
}}
==={{Type|number}}===
Numbers are numbers, either integer or decimal.

Numbers are typically returned when an arithmetic operator (<code>+</code>, <code>-</code>, <code>*</code>, <code>/</code>, etc.) is used.
{{Script
|script=print(5) --> 5
print(5 + 2) --> 7
print(5 * 2) --> 10
print(5 / 2) --> 2.5
}}
==={{Type|string}}===
Strings are sequences of characters, most notably text. When defined in code, strings must be wrapped in either quotes (<code>"</code>) or single quotes (<code>'</code>).

Strings can be modified using the [https://www.lua.org/manual/5.2/manual.html#6.4 String standard library], accessible using either the <code>string</code> global or by using the methods on strings themselves.

====Literal Strings====
Strings, when surrounded by double brackets (<code>[[]]</code>), take characters at face value. These are called literal strings and can be used to make a string span multiple lines.
==={{Type|nil}}===
Unlike other types, {{Type|nil}} is the ''absence'' of a value. This is what's returned when you try to use a variable not defined yet.
{{Script
|script=print(a) --> nil
print(b) --> nil
print(c) --> 10
-- Oh, there's our lovely little global "c" again! Didn't expect that, did you?
}}
Scripts can at best return/display unwanted values and at worst error if a {{Type|nil}} pops up where it shouldn't.
{{Script
|script=string = nil
local a = "Hello, World!"
print(string.sub(a, 2, 5)) -- ERROR! attempt to index a nil value (global 'string')}}

Template:Script

2024-10-06T03:23:43Z

Slyme: Created page with "<templatestyles src="Template:Script/style.css"/> <div class="scriptbox">{{#if:{{{name|}}}|<div class="scriptname">{{{name}}}</div>|}} {{#tag:syntaxHighlight|{{{1|{{{script}}}}}}|lang="lua"|start={{{line}}}|line=}} </div> <noinclude> <templatedata> { "params": { "name": { "label": "Script Name", "type": "content", "required": false, "description": "The name of the script, to be shown as a label header." }, "script": { "aliases": [ "1"..."

<templatestyles src="Template:Script/style.css"/>
<div class="scriptbox">{{#if:{{{name|}}}|<div class="scriptname">{{{name}}}</div>|}}
{{#tag:syntaxHighlight|{{{1|{{{script}}}}}}|lang="lua"|start={{{line}}}|line=}}
</div>
<noinclude>
<templatedata>
{
"params": {
"name": {
"label": "Script Name",
"type": "content",
"required": false,
"description": "The name of the script, to be shown as a label header."
},
"script": {
"aliases": [
"1"
],
"label": "Script",
"type": "string",
"required": true,
"description": "The script to be displayed"
},
"line": {
"label": "Line Number",
"type": "number",
"required": false,
"description": "What number to start counting on."
}
},
"paramOrder": [
"script",
"name",
"line"
]
}
</templatedata>
</noinclude>

Template:Script/style.css

2024-10-06T03:23:09Z

Slyme:

pre {
margin-top: 0;
}

.scriptbox {
margin-top: 14px;
}

.scriptname {
margin-bottom: .5em;
font-weight: bold;
}

Template:Script/style.css

2024-10-06T03:22:35Z

Slyme:

pre {
margin-top: 0;
}

.scriptbox {
margin-top: 14px;
}

.scriptname {
margin-bottom: .5em;
}

Template:Script/style.css

2024-10-06T03:20:35Z

Slyme:

pre {
margin-top: 0;
}

.scriptbox {
margin-top: 14px;
}

Template:Script/style.css

2024-10-06T03:20:20Z

Slyme:

pre {
margin-top: 0;
}

scriptbox {
margin-top: 14px;
}

Template:Script/style.css

2024-10-06T03:16:19Z

Slyme: Created page with "pre { margin-top: 0; }"

pre {
margin-top: 0;
}

Community Resources

2024-10-06T01:15:05Z

Slyme: Remove the "heavily unfinished" notice, I've finished out the assets.

{{Notice
|content='''Some of the resources listed here are not officially endorsed by FiguraMC.'''<br>
* Resources affiliated with FiguraMC will be marked as such with a ⭐ icon.
}}
= Documentation =
===[https://applejuiceyy.github.io/figs/ Figs]===
'''Figs''' is an online documentation browser for Figura, making using Figura's built-in documentation easier to use.
===[https://wiki.figuramc.org Figura Wiki] (YOU ARE HERE) ⭐===
The '''Figura Wiki''' is an online wiki that aims to document Figura, its scripting language, modeling, etc.
== Lua Documenation ==
===[https://manuel-3.github.io/lua-quickstart Lua Quickstart Guide]===
'''Manuel's Lua Quickstart Guide''' is a quick, online tutorial guiding users through the basics of Lua syntax.
===[http://lua.org/manual/5.1 Lua 5.1 Manual]===
The '''Lua Manual''' is a long document describing the ins and outs of vanilla Lua. Although some of it will not apply to Figura Lua, it's still very useful for learning about the standard libraries.
== Tutorials ==
===[https://www.youtube.com/playlist?list=PLNz7v2g2SFA8lOQUDS4z4-gIDLi_dWAhl Chloe's Video Tutorial Series]===
'''Chloe's Tutorial Series''' is a video series on YouTube that acts as a way for new users to get used to the mod. The series covers everything from modeling and modifying <code>avatar.json</code> files to scripting.
= Tools =
===[https://github.com/GrandpaScout/FiguraRewriteVSDocs GS' Figura VSCode Documentation]===
'''GrandpaScout's Figura VSCode Documentation''' is an addon for Visual Studio Code (along with Code OSS and VSCodium) that adds Figura's documentation and snippets to [https://marketplace.visualstudio.com/items?itemName=sumneko.lua sumneko's Lua Language Server plugin].
{{Collapsible
|content=* [https://github.com/GrandpaScout/FiguraRewriteVSDocs/wiki Install Guide]
|label=Additional Resources
}}
===[https://github.com/KitCat962/figura-format-bbplugin Katt's Figura Blockbench Extension]===
The '''Figura Blockbench Extension''' adds a new model format to Blockbench, the Figura Model format. It extends the base Generic Model format by adding tools to make the avatar creation process easier, lifting restrictions to the Generic Model format that Figura supports, and removing features Figura doesn't.
= Assets (Scripts, Libraries, APIs) =
{{Notice
|content='''Some assets only exist within the [https://discord.figuramc.org FiguraMC Discord].'''<br>
* Assets that link to the FiguraMC Discord will be marked with a 💬 icon.
}}
== Script Helpers ==
===[https://github.com/Manuel-3/figura-scripts/tree/main/src/runLater Run Later]===
'''Run Later''' is a script that allows users to run code after a set amount of time or after a condition is met, similar to a wait/sleep/halt instruction except it runs a function after the wait instead of the rest of the code.
== Animation Helpers ==
===[https://github.com/GrandpaScout/GSAnimBlend GSAnimBlend]===
'''GSAnimBlend''' is a script that automatically adds blends to the start and end of animations.
===[https://github.com/JimmyHelp/JimmyAnims Jimmy's Animation Handler]===
'''JimmyAnim''' (full name Jimmy's Animation Helper) is a library that plays specific Blockbench animations based on the player's current action.
{{Collapsible
|content=* [https://jimmyhelp.notion.site/JimmyAnims-79adfdca2fe04f9c9ede5e0bfd898b6a Documentation]
* [https://github.com/JimmyHelp/JimmyAnims/blob/main/JimmyExample.lua Example Usage]
|label=Additional Resources
}}
== World Interactions==
===[https://discord.com/channels/1129805506354085959/1132467393050968214/1132467393050968214 Origins API] 💬===
Katt's '''Origins API''' is an API that uses the player's NBT data to get information about the player's [https://modrinth.com/mod/origins Origin].
===[https://github.com/GrandpaScout/GSServerNet GSServerNet]===
'''GSServerNet''' allows Figura to communicate with the server/world the player is in using a companion datapack.
==Visual Elements==
===[https://github.com/Manuel-3/figura-scripts/tree/main/src/confetti Confetti]===
'''Confetti''' is a library that allows users to add custom particles, either sprite or modelpart, to their avatars
{{Collapsible
|content=* [https://github.com/Manuel-3/figura-scripts/blob/main/src/confetti/readme.md Documentation]
* [https://github.com/Manuel-3/figura-scripts/blob/main/src/confetti/example.zip Example Avatar]
|label=Additional Resources
}}
===[https://discord.com/channels/1129805506354085959/1137506926742216835 KattArmor] 💬===
'''KattArmor''' (sometimes called Katt Armor API/Library) is a library that allows users to edit their avatar's armor, whether by adding pivots using a script or by using unique models and textures.
{{Collapsible
|content=* [https://discord.com/channels/1129805506354085959/1137506926742216835/1155212562980425818 How-To Guide]
* [https://discord.com/channels/1129805506354085959/1137506926742216835/1262160359905562705 Example Avatars]
|label=Additional Resources
}}
===[https://github.com/MitchOfTarcoola/MOARArmsAPI MOAR Arms API]===
'''MOAR Arms API''' is a library that makes making an avatar with multiple arms easier, allowing an avatar to appear to hold more than two items at once.
===[https://github.com/lua-gods/figuraLibraries/tree/main/tail%20and%20ears Tail and Ears Physics]===
'''Tail and Ears Physics''' is a script that gives physics to a set of ears and multiple parts of a tail.
{{Collapsible
|content=* [https://github.com/lua-gods/figuraLibraries/blob/main/tail%20and%20ears/examples.lua Example Usage]
|label=Additional Resources
}}
===[https://github.com/lua-gods/figuraLibraries/blob/main/plushie/plushie.lua Plushie]===
'''Plushie''' snaps a skull model (specified in the config) to the floor below it and scales the model based on the amount above it.

= Community =
===[https://discord.figuramc.org FiguraMC Discord] ⭐===
The '''FiguraMC Discord Server''' is the central place for everything Figura, including help and support for the mod, avatar showcasing, and more. You'll also need to join this server to request whitelist to the FiguraSMP.
== Minecraft Servers ==
{{Notice
|content='''Some servers listed below are whitelisted.'''<br>
* Servers that have a public whitelist application process will be marked with a 🔒 icon.
* Servers that are invite-only will be marked with a 🛡️ icon.
}}
=== Figura Plaza ⭐ ===
'''IP: <code style="user-select: all">plaza.figuramc.org</code>''' • '''Version: 1.16.5 - 1.21'''

The '''Figura Plaza''' is an official lobby-like server where players can join, hang out with other Figura users, make avatars in company, play games, and occasionally attend events. The server does not have any survival gameplay, and disables PvP by default. The server also provides a selection of free temporary items to use when testing avatars.

=== Figura SMP ⭐🔒 ===
'''IP: <code style="user-select: all">vanilla.figuramc.org</code>''' • '''Version: 1.21'''

The '''Figura SMP''' (also referred to as Vanilla SMP) is an official survial server that stays close to the base game, plus a few server-side mods for quality-of-life purposes. You are perfectly able to join this server without any mods, and even on a vanilla client. You can read the server rules in the [https://discord.figuramc.org FiguraMC Discord Server]'s [https://discord.com/channels/1129805506354085959/1130186794873405510 #info] channel and get whitelisted by putting your name in [https://discord.com/channels/1129805506354085959/1130187119680311470 #whitelist].

==== Modded SMP ====
'''IP: <code style="user-select: none">[TBD]</code>''' • '''Version: 1.20.1-fabric''' • '''Modpack: <span style="user-select: none">[TBD]</span>'''

The '''Modded SMP''' is a seasonal modpack server adjacent to Figura SMP, each season coming with its own theme. '''Currently offline.''' The next season is themed after a nuclear apocalypse and is set for release Soon™. The ModdedSMP shares a whitelist with the VanillaSMP, meaning that [https://discord.com/channels/1129805506354085959/1130187119680311470 #whitelist] will whitelist you for both servers.

=== 4p5.nz 🛡️ ===
'''IP: <code style="user-select: all">4p5.nz</code>''' • '''Version: 1.20.1'''

'''4p5.nz''' is an invite-only creative/operator server where players have free reign over the world around them.

Lua Basics

2024-10-06T01:13:33Z

Slyme: Remove that warning at the top.

{{Notice
| content = I highly recommend reading the [https://www.lua.org/manual/5.2/ Lua Reference] and [https://www.lua.org/pil/contents.html Programming in Lua] if you have the time. I provide a basic rundown of the most used functionality for Figura, but not everything gets covered.
}}

==How a computer reads code==
Code is basically just a list of instructions telling the computer step by step what to do. It is read line-by-line and the instructions are executed right away.
==Comments==
When there are 2 minus signs <code>--</code>, everything after it is ignored by Lua. These are called comments. They have no effect on the code that is executed and can be safely removed. Their primary purpose is to add raw text that can be used to aid in the understanding of code.
<syntaxHighlight lang="lua">
-- Comments are not compiled and do not affect code
local a = 2 -- Everything up to the next newline will be ignored.
-- Can also be used to hide code from the compiler without actually removing it:
-- local b = 4
</syntaxHighlight>
Another form of comment is <code>--[[ ]]</code>. When this is used, everything between the square bracket pairs will be ignored. Newlines do not affect this. This type of comment is commonly referred to as a Long Comment.
<syntaxHighlight lang="lua">
local a = 2
--[[ comment comment
ignores newlines
ignores pretty much everything
]] local b=2 --long comments end strictly at the `]]`
</syntaxHighlight>
==Variables==
Variables store values. Lua is a dynamically typed language, meaning any variable can store a value of any type. You can define a variable using the `local` keyword. Local variables are accessible below the line they were declared, but will not breach their scope.
<syntaxHighlight lang="lua">
local a
</syntaxHighlight>
Most of the time, you will want to instantly assign a value to that variable. In lua, if you use `=` it will store the value on the right inside the variable on the left.
<syntaxHighlight lang="lua">
local a = 2 -- the variable named "a" now stores the value 2
</syntaxHighlight>
After a variable has been declared, you can assign a new value to it by using <code>=</code> again. Note that the <code>local</code> keyword is only used when creating the variable for the first time.
<syntaxHighlight lang="lua">
local a = 2
a = 4 -- the variable "a" now stores 4
</syntaxHighlight>
Multiple variables can be declared and assigned on one line.
<syntaxHighlight lang="lua">
local a, b = 1, 2
</syntaxHighlight>
Variables are limited in what characters can be used as an identifier (variable name). Only letters, numbers, and `_` can be used in a valid identifier, and it cannot start with a number. None of Lua's keywords (<code>and</code>, <code>or</code>, <code>if</code>, <code>while</code>, etc.) can be used as a variable name.
<syntaxHighlight lang="lua">
local a123
local _b
local KEKW
local 123A -- invalid. Starts with a number.
local has-water -- invalid. Uses character `-`
local and -- invalid. `and` is a lua keyword.
local local -- invalid. `local` is a lua keyword.
local _ -- This name specifically is used to denote throwaway variables in loops.
</syntaxHighlight>
If you assign a value to a value to a variable that has not been declared using <code>local</code>, you will create a ''global'' variable. Global variables are accessible from the entire Lua environment. This may seem like a good thing to the inexperienced, but because they are accessible anywhere it is common for users to make mistakes when they reuse global variables for other purposes and accidentally overwrite it.<br>
There is almost never a good reason for using global variables, so always stick to <code>local</code>.
<syntaxHighlight lang="lua">
-- c was not declared local beforehand,
-- meaning there is now the value `10` at global variable `c`
c = 10
</syntaxHighlight>
Variables can be used in place of values.
<syntaxHighlight lang="lua">
local a = 2
print(a) --> prints `2` to the chat
a = a + a
print(a) --> prints `4` to the chat
a = a + a
print(a) --> prints `8` to the chat
</syntaxHighlight>
When you try to use a variable that hasnt been assigned a value, the value `nil` will be returned.
<syntaxHighlight lang="lua">
local a
print(a) --> nil
print(d) --> nil

print(c) --> 10 (the global variable we declared earlier lol)
</syntaxHighlight>

==Functions==

A function contains code that can be executed by calling the function. This is useful if you want to use the same code multiple times and can make your code more structured.

To define a function you use the <code>function</code> keyword, then the name of the function and <code>()</code>.<br>
Any code after it will be considered inside this function, until you tell Lua that the function is done here by using the <code>end</code> keyword. For better readability we indent the code inside the function using spaces or tabs.<br>
The print statement will not execute until the function is called.

<syntaxHighlight lang="lua">
function hello()
print("Hello function!")
end
</syntaxHighlight>

Whenever you call a function by putting <code>()</code> after the function name, all the code inside the function will run line by line first, before continuing with the rest of your code.

<syntaxHighlight lang="lua">
print("Outside.")
hello()
print("Below hello.")
</syntaxHighlight>
This will output the following:
Outside.
Hello function!
Below hello.
You can also give the function some values to work with by putting variable names inside the <code>()</code>. These variables are called parameters. The function can also return a new value itself that is accessible from where the function is called. If no <code>return</code> is specified, the function returns <code>nil</code> (see "Types" section below).<br>
Here is an example of a function that calculates the sum of two numbers.

<syntaxHighlight lang="lua">
function sum(a,b) -- parameters seperated by commas
local s = a + b -- calculate the sum
return s -- return the sum to be used by tha caller
end

local var1 = 2
local var2 = 8
local var3 = sum(var1, var2) -- call the function and pass two variables. note that these do not have to be called a and b
print(var3) --> 10, as you might have noticed, `print` is also a function that takes a parameter
</syntaxHighlight>

==Values==
Values represent some form of data.<br>
There are many types of values for storing different types of data.

===boolean===
A boolean is a data type with 2 distinct values: <code>true</code> and <code>false</code>.

Most operators return a boolean and it's current state can be inverted with <code>not</code>.
<syntaxHighlight lang="lua">
local a = true
print(a) --> true
print(not a) --> false
a = not a -- a = false
print(a) --> false
print(not a) --> true
</syntaxHighlight>
===number===
A number is, well, a number.<br>
Numbers can use arithmetic operators.
<syntaxHighlight lang="lua">
local a = 14
local b = 4
print(a+b) --> 18
print(a-b) --> 10
print(a*b) --> 56
print(a/b) --> 3.5
print(a%b) --> 2
local c = 3.1459
local d = math.pi
</syntaxHighlight>
===string===
A string is a sequence of characters.<br>
Mostly used for holding and manipulating text data.

[https://www.lua.org/manual/5.2/manual.html#6.4 String functions] are accessible through the <code>string</code> global variable. All string values also contain these functions within themselves.

Strings are defined by encasing text in double quotes (<code>"</code>) or single quotes (<code>'</code>).

If you try to put a newline in a string, Lua will refuse and throw a syntax error. Newlines must be encoded into a string using other characters. Specifically <code>\n</code>.<br>
If you need to have either a <code>"</code> or <code>'</code> in a string and you cannot wrap the string in another quote type, you can escape the quote using <code>\</code>

Long Strings are defined by encasing text in 2 square brackets (<code>[[]]</code>). Long strings capture every single character between the pairs of square brackets including raw newlines.
<syntaxHighlight lang="lua">
local str = "foo"
print(str .. " bar") --> foo bar

local a = "This string has \"quotes\" in it."
print(a) --> This string has "quotes" in it.

local b = "This will result in
a syntax error"

local c = "This \nwill \nnot"

local d = [[neither
will
this]]
</syntaxHighlight>
===table===
A Lua table is a data structure that stores many values.

Tables operate on key-value pairs. You give the table a key in the form of a value, and it returns a value.<br>
Assigning works the same way. Give the table a key, and assign a value to the table at that key.
<syntaxHighlight lang="lua">
-- Define an empty table
local tbl = {}
-- Store the value 23 in the table with the key 54
tbl[54] = 23
-- Store the value false in the table with the key "stringKey"
tbl["stringKey"] = false

-- variables can be inputted, using their value as the key.
-- For instance, let's use our global c (which, if you don't remember, was set to 10) from earlier.
tbl[c] = "123"

tbl[67] = tbl[54]

print(tbl[54]) --> 23
print(tbl["stringKey"]) --> false
print(tbl[10]) --> "123"
print(tbl[67]) --> 23
</syntaxHighlight>
If your key is a string, you can use a different way of indexing that is easier to do. Do note that only strings that abide by identifier rules can be used this way. If the string is not a valid identifier, use <code>[]</code> indexing
<syntaxHighlight lang="lua">
local data={}
data.name="Chocolate"
data.amount=100
data.delicious=true
</syntaxHighlight>
Unlike other values which are passed around by value, tables are passed by reference.<br>
What this means is that when you create a table and assign it to a variable, then assign it to a different variable, you do not have 2 tables. You have 2 variables pointing to the same table.
<syntaxHighlight lang="lua">
local a = {}
local b = a
local c = {}
print(a) --> table4b8ab37d
print(b) --> table4b8ab37d
print(c) --> table82f1e9c2
-- table equality works on "is this the same table?".
-- The values inside do not matter.
print(a == b) --> true
print(a == c) --> false
-- same table in memory.
a.reeee = 2
print(b.reeee) --> 2
</syntaxHighlight>

===nil===
<code>nil</code> is commonly referred to as the absence of data.<br>
It is what is returned when no data is present.

===function===
Yes, functions are also a type of variable.

An alternative way to name a function to what we learned before is by assigning a function to a variable.<br>

<syntaxHighlight lang="lua">
local a = function()
print("function was called")
end
</syntaxHighlight>

This is functionally the same thing as:

<syntaxHighlight lang="lua">
local function a()
print("function was called")
end
</syntaxHighlight>

Like tables, functions are passed by reference, and equality is based on "is this the same function?". The actual contents of the function are not evaluated, so identical looking functions, while similar, are not equal.
<syntaxHighlight lang="lua">
local a=print
print(a == print) --> true

local b=function() end
local c=function() end
print(b == c) --> false

c = b
print(b == c) --> true

print(b()) --> nil, because b does not return anything
</syntaxHighlight>

Since functions are just another value type, they can be used as arguments to other functions.
<syntaxHighlight lang="lua">
local function do10(func)
for i=1,10 do -- this just means "repeat 10 times" increasing the variable `i` every time
func(i)
end
end

do10(print) --> 1,2,3,4,5,6,7,8,9,10
do10(function(v)
print(v*2)
end) --> 2,4,6,8,10,12,14,16,18,20
</syntaxHighlight>
Functions have access to all variables defined above where the function gets defined. Variables below where the function is defined is considered "out of scope" of the function.<br>
If a variable is used that is not defined above the function, the global variable with that identifier will be used
<syntaxHighlight lang="lua">
local a = 10
local b = "string lol"
local function d()
print(a)
print(b)
print(c) -- there is no `c` variable defined above here, so the global `c` will be used.
end
local c = 20
d()
--> 10
--> "string lol"
--> 10
-- If you forgot the countless times we've used the global c through this entire page, c is still 10.

local function e(b)
print(a)
print(b) -- variable `b` is redefined as a function parameter, so the other `b` is scope gets overshadowed
print(c) -- There *is* a `c` variable within scope this time
end
e("string kek")
--> 10
--> "string kek"
--> 20
</syntaxHighlight>
If a function is one of the values in a table, special syntax can be used to have the table itself be the first argument to the function. By indexing the function with colon (<code>:</code>) Lua will put the table itself as the first argument.

This is used heavily in Figura for many of its APIs. All objects of the same type share the exact same functions, differentiated only by the object placed in the first argument.
<syntaxHighlight lang="lua">
local tbl={}
tbl.key = function(t, a, b)
t[a] = b
end

tbl:key("a", "b")

-- this is functionally equivalent
tbl.key(tbl, "a", "b")

-- You can also use `:` when creating functions. The implied `self` argument will be used to refer to the first argument
function tbl:key(a, b)
self[a] = b
end
</syntaxHighlight>
===userdata===
Lua is commonly used when embedded in other software. In this case, it is embedded inside of Figura.<br>
userdata is the means of communicating with that software.

userdata is basically data initialized in Figura that gets interpreted as a Lua value. They function most similar to tables in the fact that they are indexed the same way to receive values, mostly functions.

This is why knowing when to use `:` to index userdata is important.
<syntaxHighlight lang="lua">
-- `models` is a value of type userdata. More specifically, it is a ModelPart created in Java and made accessible in Lua.
-- userdata commonly overrides what the print and tostring functions return to improve the ability to debug code.
print(models) --> models (ModelPart)
</syntaxHighlight>
==Variable Scope==
A Variable's Scope is the area the variable is accessible from.

A variable's scope begins when it is declared, and extends until the end of the current block.<br>
The scope of global variables is the Lua environment itself and will not clear until Lua itself is shut down.

All [[#control_statements|control statements]] will create new scopes when used. Functions also create their on scope when declared<br>
The `do end` statement can be used to create scopes, and doesn't have any other functionality. I will be using it to showcase how scopes affect variables, as explaining it raw will not get the point across.

<syntaxHighlight lang="lua">
local a=4
local b=8
do
-- a and b are accessible here
local c = 12
-- a, b, and c are accessible here
a = 16 -- variable `a` in the outer scope is now `16`

local b = 20 -- b in the other scope has been overshadowed by this variable. All future references to `b` will refer to this variable (until the end of the scope)

print(a,b,c,d) --> 16, 20, 12, nil
end
print(a,b,c,d) --> 16, 8, 10, nil
-- Global c is still 10.

local e
do
local f=0

-- interesting thing is that functions capture the current scope.
-- Even if we leave the scope, the function remembers the upvalue `f` and will continue to use it even if the scope `f` belongs to ends
-- oh yea `a` is overshadowed here too. But thats not as interesting.
e=function(a)
f=f+1
print(f, a)
end
e()--> 1, nil
e()--> 2, nil
end

e() --> 3, nil
e("a") --> 4, "a"
</syntaxHighlight>
==Value Truthiness==
All values have an implicit truthiness when used in the context of a boolean.

It's simple to remember: <code>nil</code> and <code>false</code> are both considered "falsely", and every other value is considered "truthy".

Truthiness is used in control statements, see the section about it below.

==Operators==
Operators, similar functions, take 1 or 2 values and outputs a result.<br>
They commonly take the form <code>leftSide operator rightSide</code>.<br>
I will continue to refer to the 2 values that operators operate on as <code>leftSide</code> and <code>rightSide</code> for the duration of this section.<br>

Operators have a priority system. It is surprisingly intuitive, but can be forced by surrounding the code you want to guarantee execute first in brackets `()`. For the true priority list, check out the [https://www.lua.org/manual/5.2/manual.html#3.4.7 Lua Reference Manual].

Do note that despite me saying that "Only x can use this operator", tables and userdata types are always exempt from this rule. However, they must be explicitly written to support these operators, so most will not support it by default.
===Arithmetic Addition (+)===
Its addition. 1+1 returns 2. Basic stuff.<br>
Only numbers can use this operator.
===Arithmetic Subtraction (-)===
Its subtraction. 2-3 returns -1. Basic stuff.<br>
Only numbers can use this operator.
===Arithmetic Multiplication (*)===
Its multiplication. 2*4 returns 8. Basic stuff.<br>
Only numbers can use this operator.
===Arithmetic Division (/)===
Its division. 5/2 returns 2.5. Basic stuff.<br>
Only numbers can use this operator.
===Arithmetic Modulo (%)===
Division actually has 2 components. The whole component, and the remainder component.<br>
Modulo returns this remainder component after the division leftSide/rightSide is done.<br>
5%2 returns 1, because 2 goes into 5 2 whole times, 2*2=4, 5-4=1.<br>
Only numbers can use this operator.
===Arithmetic Exponentiation (^)===
Its exponents. 2^3 returns 8. Basic stuff.<br>
Only numbers can use this operator.
===Arithmetic Negation (-)===
Only operates on the rightSide.<br>
This operator negates the number, similar to just adding a negative symbol in front of it.<br>
<syntaxHighlight lang="lua">
local a= -2
a=-a
print(a) --> 2
</syntaxHighlight>
===Relational Equality (==)===
Returns `true` if both values are considered the same value, `false` otherwise.<br>
All values can use this operator.
===Relational Inequality (~=)===
Returns `false` if both values are considered the same value, `true` otherwise.<br>
All values can use this operator.
===Relational Less Than (<)===
Returns `true` if the leftSide is considered less then the rightSide, `false` otherwise.<br>
Numbers compare as expected.
Strings compare using their ascii representations, comparing each character left to right until they are not equal. Then the operator is applied to those 2 character's ascii numbers and returned.
===Relational Greater Than (>)===
Returns `true` if the leftSide is considered greater then the rightSide, `false` otherwise.<br>
Numbers compare as expected.
Strings compare using their ascii representations, comparing each character left to right until they are not equal. Then the operator is applied to those 2 character's ascii numbers and returned.
===Relational Less Than or Equal To (<=)===
Returns `true` if the leftSide is considered less then or equal to the rightSide using equality operator rules, `false` otherwise.<br>
Numbers compare as expected.
Strings compare using their ascii representations, comparing each character left to right until they are not equal. Then the operator is applied to those 2 character's ascii numbers and returned.
===Relational Greater Than or Equal To (>=)===
Returns `true` if the leftSide is considered greater then or equal to the rightSide using equality operator rules, `false` otherwise.<br>
Numbers compare as expected.
Strings compare using their ascii representations, comparing each character left to right until they are not equal. Then the operator is applied to those 2 character's ascii numbers and returned.
===Logical And (and)===
This operator operates on truthiness.<br>
If the leftSide is considered truthy, it returns the rightSide. Otherwise, it returns the leftSide.<br>
This ends up with the return value being truthy only if both leftSide ''and'' rightSide are truthy.<br>
The following table puts this visually. L is leftSide, R is rightSide. F and T represent if the value is falsy or truthy, and the column under O represents which value actually gets returned by `and` as well as the truthiness of it.
{| class="wikitable"
|-
! Left !! Right !! Output
|-
| False || False || False (Left)
|-
| False || True || False (Left)
|-
| True || False || False (Right)
|-
| True || True || True (Right)
|}
The reason this is so complex is because it doesn't just work on booleans. It works on all value types.

===Logical Or (or)===
This operator operates on truthiness.<br>
If the leftSide is considered truthy, it returns the leftSide. Otherwise, it returns the rightSide.<br>
This ends up with the return value being truthy either the leftSide ''or'' rightSide are truthy.<br>
The following table puts this visually. L is leftSide, R is rightSide. F and T represent if the value is falsy or truthy, and the column under O represents which value actually gets returned by `or` as well as the truthiness of it.

{| class="wikitable"
|-
! Left !! Right !! Output
|-
| False || False || False (Right)
|-
| False || True || True (Right)
|-
| True || False || True (Left)
|-
| True || True || True (Left)
|}

The reason this is so complex is because it doesn't just work on booleans. It works on all value types.

===Logical Not (not)===
Only operates on the rightSide.<br>
This operator evaluates the truthiness of the value, then returns the boolean representation of the opposite.<br>
<code>not true</code> is <code>false</code>, <code>not 2</code> is <code>false</code>, <code>not false</code> is <code>true</code>, <code>not {}</code> is <code>false</code>, and <code>not nil</code> is <code>true</code>.<br>
All values can use this operator.
===String Concatenation (..)===
This returns a string from the values concatenated together.<br>
Only strings can use this operator.
===Length Operator (#)===
Only operates on the rightSide.<br>
This returns the length of the value<br>
For strings, its the amount of bytes stored in the string. (UTF-8 characters are more than one byte)<br>
For tables, lua iterates over <code>t[1], t[2], t[3] ... t[n]</code> until a nil value is found and returns the number of non-nil values found.

==Control Statements==
Control Statements affect the scope and flow of the program.
===<code>if then end</code>===
<code>if</code> statements allow for executing code only when a condition is met.

The basic structure looks like
<syntaxHighlight lang="lua">
if condition then
print("condition is true")
end
</syntaxHighlight>

<code>if</code> statements have an optional <code>elseif</code> clause, where if the previous condition failed this condition will be checked. In an <code>elseif</code> chain, only the first successful condition will actually execute, after which all other <code>elseif</code>s are ignored.

<syntaxHighlight lang="lua">
if condition then
print("condition")
elseif condition2 then
print("condition2")
elseif condition3 then
print("condition3")
end
</syntaxHighlight>

<code>if</code> statements also have an optional <code>else</code> clause, where if ''all'' previous conditions fail, the <code>else</code> clause will execute.

<syntaxHighlight lang="lua">
if condition then
print("condition")
else
print("not condition")
end

if condition then
print("condition")
elseif condition2 then
print("condition2")
else
print("not condition or condition2")
end
</syntaxHighlight>

<code>else</code> statements operate on [[#value_truthiness|Value Truthiness]]
<syntaxHighlight lang="lua">
local rand = math.random()<0.3
-- Use booleans as raw input to if statements
-- the `==` operator just returns a boolean anyways and is just wasted instructions
if rand then
print("random print statement lol")
end

-- getVehicle returns either an Entity userdata, or nil
local vehicle=player:getVehicle()
if vehicle then
print("Riding: ", vehicle:getName())
else
print("No Mount")
end
</syntaxHighlight>

===Loops===

<syntaxHighlight lang="lua">
for i=1,10 do
print(i)
end
--> 1,2,3,4,5,6,7,8,9,10

local x = 1
while x < 10 do
x = x + 1
print(x)
end
</syntaxHighlight>

--TODO this has been sitting locally for several months. I'm uploading it and finishing it later

Lua Basics

2024-10-06T01:13:05Z

Slyme: Ported Katt's Lua Basics page to MediaWiki and made a few minor edits.

{{Notice/Warning
|content=''''''
}}
----
{{Notice
|content=I highly recommend reading the [https://www.lua.org/manual/5.2/ Lua Reference] and [https://www.lua.org/pil/contents.html Programming in Lua] if you have the time. I provide a basic rundown of the most used functionality for Figura, but not everything gets covered.}}

==How a computer reads code==
Code is basically just a list of instructions telling the computer step by step what to do. It is read line-by-line and the instructions are executed right away.
==Comments==
When there are 2 minus signs <code>--</code>, everything after it is ignored by Lua. These are called comments. They have no effect on the code that is executed and can be safely removed. Their primary purpose is to add raw text that can be used to aid in the understanding of code.
<syntaxHighlight lang="lua">
-- Comments are not compiled and do not affect code
local a = 2 -- Everything up to the next newline will be ignored.
-- Can also be used to hide code from the compiler without actually removing it:
-- local b = 4
</syntaxHighlight>
Another form of comment is <code>--[[ ]]</code>. When this is used, everything between the square bracket pairs will be ignored. Newlines do not affect this. This type of comment is commonly referred to as a Long Comment.
<syntaxHighlight lang="lua">
local a = 2
--[[ comment comment
ignores newlines
ignores pretty much everything
]] local b=2 --long comments end strictly at the `]]`
</syntaxHighlight>
==Variables==
Variables store values. Lua is a dynamically typed language, meaning any variable can store a value of any type. You can define a variable using the `local` keyword. Local variables are accessible below the line they were declared, but will not breach their scope.
<syntaxHighlight lang="lua">
local a
</syntaxHighlight>
Most of the time, you will want to instantly assign a value to that variable. In lua, if you use `=` it will store the value on the right inside the variable on the left.
<syntaxHighlight lang="lua">
local a = 2 -- the variable named "a" now stores the value 2
</syntaxHighlight>
After a variable has been declared, you can assign a new value to it by using <code>=</code> again. Note that the <code>local</code> keyword is only used when creating the variable for the first time.
<syntaxHighlight lang="lua">
local a = 2
a = 4 -- the variable "a" now stores 4
</syntaxHighlight>
Multiple variables can be declared and assigned on one line.
<syntaxHighlight lang="lua">
local a, b = 1, 2
</syntaxHighlight>
Variables are limited in what characters can be used as an identifier (variable name). Only letters, numbers, and `_` can be used in a valid identifier, and it cannot start with a number. None of Lua's keywords (<code>and</code>, <code>or</code>, <code>if</code>, <code>while</code>, etc.) can be used as a variable name.
<syntaxHighlight lang="lua">
local a123
local _b
local KEKW
local 123A -- invalid. Starts with a number.
local has-water -- invalid. Uses character `-`
local and -- invalid. `and` is a lua keyword.
local local -- invalid. `local` is a lua keyword.
local _ -- This name specifically is used to denote throwaway variables in loops.
</syntaxHighlight>
If you assign a value to a value to a variable that has not been declared using <code>local</code>, you will create a ''global'' variable. Global variables are accessible from the entire Lua environment. This may seem like a good thing to the inexperienced, but because they are accessible anywhere it is common for users to make mistakes when they reuse global variables for other purposes and accidentally overwrite it.<br>
There is almost never a good reason for using global variables, so always stick to <code>local</code>.
<syntaxHighlight lang="lua">
-- c was not declared local beforehand,
-- meaning there is now the value `10` at global variable `c`
c = 10
</syntaxHighlight>
Variables can be used in place of values.
<syntaxHighlight lang="lua">
local a = 2
print(a) --> prints `2` to the chat
a = a + a
print(a) --> prints `4` to the chat
a = a + a
print(a) --> prints `8` to the chat
</syntaxHighlight>
When you try to use a variable that hasnt been assigned a value, the value `nil` will be returned.
<syntaxHighlight lang="lua">
local a
print(a) --> nil
print(d) --> nil

print(c) --> 10 (the global variable we declared earlier lol)
</syntaxHighlight>

==Functions==

A function contains code that can be executed by calling the function. This is useful if you want to use the same code multiple times and can make your code more structured.

To define a function you use the <code>function</code> keyword, then the name of the function and <code>()</code>.<br>
Any code after it will be considered inside this function, until you tell Lua that the function is done here by using the <code>end</code> keyword. For better readability we indent the code inside the function using spaces or tabs.<br>
The print statement will not execute until the function is called.

<syntaxHighlight lang="lua">
function hello()
print("Hello function!")
end
</syntaxHighlight>

Whenever you call a function by putting <code>()</code> after the function name, all the code inside the function will run line by line first, before continuing with the rest of your code.

<syntaxHighlight lang="lua">
print("Outside.")
hello()
print("Below hello.")
</syntaxHighlight>
This will output the following:
Outside.
Hello function!
Below hello.
You can also give the function some values to work with by putting variable names inside the <code>()</code>. These variables are called parameters. The function can also return a new value itself that is accessible from where the function is called. If no <code>return</code> is specified, the function returns <code>nil</code> (see "Types" section below).<br>
Here is an example of a function that calculates the sum of two numbers.

<syntaxHighlight lang="lua">
function sum(a,b) -- parameters seperated by commas
local s = a + b -- calculate the sum
return s -- return the sum to be used by tha caller
end

local var1 = 2
local var2 = 8
local var3 = sum(var1, var2) -- call the function and pass two variables. note that these do not have to be called a and b
print(var3) --> 10, as you might have noticed, `print` is also a function that takes a parameter
</syntaxHighlight>

==Values==
Values represent some form of data.<br>
There are many types of values for storing different types of data.

===boolean===
A boolean is a data type with 2 distinct values: <code>true</code> and <code>false</code>.

Most operators return a boolean and it's current state can be inverted with <code>not</code>.
<syntaxHighlight lang="lua">
local a = true
print(a) --> true
print(not a) --> false
a = not a -- a = false
print(a) --> false
print(not a) --> true
</syntaxHighlight>
===number===
A number is, well, a number.<br>
Numbers can use arithmetic operators.
<syntaxHighlight lang="lua">
local a = 14
local b = 4
print(a+b) --> 18
print(a-b) --> 10
print(a*b) --> 56
print(a/b) --> 3.5
print(a%b) --> 2
local c = 3.1459
local d = math.pi
</syntaxHighlight>
===string===
A string is a sequence of characters.<br>
Mostly used for holding and manipulating text data.

[https://www.lua.org/manual/5.2/manual.html#6.4 String functions] are accessible through the <code>string</code> global variable. All string values also contain these functions within themselves.

Strings are defined by encasing text in double quotes (<code>"</code>) or single quotes (<code>'</code>).

If you try to put a newline in a string, Lua will refuse and throw a syntax error. Newlines must be encoded into a string using other characters. Specifically <code>\n</code>.<br>
If you need to have either a <code>"</code> or <code>'</code> in a string and you cannot wrap the string in another quote type, you can escape the quote using <code>\</code>

Long Strings are defined by encasing text in 2 square brackets (<code>[[]]</code>). Long strings capture every single character between the pairs of square brackets including raw newlines.
<syntaxHighlight lang="lua">
local str = "foo"
print(str .. " bar") --> foo bar

local a = "This string has \"quotes\" in it."
print(a) --> This string has "quotes" in it.

local b = "This will result in
a syntax error"

local c = "This \nwill \nnot"

local d = [[neither
will
this]]
</syntaxHighlight>
===table===
A Lua table is a data structure that stores many values.

Tables operate on key-value pairs. You give the table a key in the form of a value, and it returns a value.<br>
Assigning works the same way. Give the table a key, and assign a value to the table at that key.
<syntaxHighlight lang="lua">
-- Define an empty table
local tbl = {}
-- Store the value 23 in the table with the key 54
tbl[54] = 23
-- Store the value false in the table with the key "stringKey"
tbl["stringKey"] = false

-- variables can be inputted, using their value as the key.
-- For instance, let's use our global c (which, if you don't remember, was set to 10) from earlier.
tbl[c] = "123"

tbl[67] = tbl[54]

print(tbl[54]) --> 23
print(tbl["stringKey"]) --> false
print(tbl[10]) --> "123"
print(tbl[67]) --> 23
</syntaxHighlight>
If your key is a string, you can use a different way of indexing that is easier to do. Do note that only strings that abide by identifier rules can be used this way. If the string is not a valid identifier, use <code>[]</code> indexing
<syntaxHighlight lang="lua">
local data={}
data.name="Chocolate"
data.amount=100
data.delicious=true
</syntaxHighlight>
Unlike other values which are passed around by value, tables are passed by reference.<br>
What this means is that when you create a table and assign it to a variable, then assign it to a different variable, you do not have 2 tables. You have 2 variables pointing to the same table.
<syntaxHighlight lang="lua">
local a = {}
local b = a
local c = {}
print(a) --> table4b8ab37d
print(b) --> table4b8ab37d
print(c) --> table82f1e9c2
-- table equality works on "is this the same table?".
-- The values inside do not matter.
print(a == b) --> true
print(a == c) --> false
-- same table in memory.
a.reeee = 2
print(b.reeee) --> 2
</syntaxHighlight>

===nil===
<code>nil</code> is commonly referred to as the absence of data.<br>
It is what is returned when no data is present.

===function===
Yes, functions are also a type of variable.

An alternative way to name a function to what we learned before is by assigning a function to a variable.<br>

<syntaxHighlight lang="lua">
local a = function()
print("function was called")
end
</syntaxHighlight>

This is functionally the same thing as:

<syntaxHighlight lang="lua">
local function a()
print("function was called")
end
</syntaxHighlight>

Like tables, functions are passed by reference, and equality is based on "is this the same function?". The actual contents of the function are not evaluated, so identical looking functions, while similar, are not equal.
<syntaxHighlight lang="lua">
local a=print
print(a == print) --> true

local b=function() end
local c=function() end
print(b == c) --> false

c = b
print(b == c) --> true

print(b()) --> nil, because b does not return anything
</syntaxHighlight>

Since functions are just another value type, they can be used as arguments to other functions.
<syntaxHighlight lang="lua">
local function do10(func)
for i=1,10 do -- this just means "repeat 10 times" increasing the variable `i` every time
func(i)
end
end

do10(print) --> 1,2,3,4,5,6,7,8,9,10
do10(function(v)
print(v*2)
end) --> 2,4,6,8,10,12,14,16,18,20
</syntaxHighlight>
Functions have access to all variables defined above where the function gets defined. Variables below where the function is defined is considered "out of scope" of the function.<br>
If a variable is used that is not defined above the function, the global variable with that identifier will be used
<syntaxHighlight lang="lua">
local a = 10
local b = "string lol"
local function d()
print(a)
print(b)
print(c) -- there is no `c` variable defined above here, so the global `c` will be used.
end
local c = 20
d()
--> 10
--> "string lol"
--> 10
-- If you forgot the countless times we've used the global c through this entire page, c is still 10.

local function e(b)
print(a)
print(b) -- variable `b` is redefined as a function parameter, so the other `b` is scope gets overshadowed
print(c) -- There *is* a `c` variable within scope this time
end
e("string kek")
--> 10
--> "string kek"
--> 20
</syntaxHighlight>
If a function is one of the values in a table, special syntax can be used to have the table itself be the first argument to the function. By indexing the function with colon (<code>:</code>) Lua will put the table itself as the first argument.

This is used heavily in Figura for many of its APIs. All objects of the same type share the exact same functions, differentiated only by the object placed in the first argument.
<syntaxHighlight lang="lua">
local tbl={}
tbl.key = function(t, a, b)
t[a] = b
end

tbl:key("a", "b")

-- this is functionally equivalent
tbl.key(tbl, "a", "b")

-- You can also use `:` when creating functions. The implied `self` argument will be used to refer to the first argument
function tbl:key(a, b)
self[a] = b
end
</syntaxHighlight>
===userdata===
Lua is commonly used when embedded in other software. In this case, it is embedded inside of Figura.<br>
userdata is the means of communicating with that software.

userdata is basically data initialized in Figura that gets interpreted as a Lua value. They function most similar to tables in the fact that they are indexed the same way to receive values, mostly functions.

This is why knowing when to use `:` to index userdata is important.
<syntaxHighlight lang="lua">
-- `models` is a value of type userdata. More specifically, it is a ModelPart created in Java and made accessible in Lua.
-- userdata commonly overrides what the print and tostring functions return to improve the ability to debug code.
print(models) --> models (ModelPart)
</syntaxHighlight>
==Variable Scope==
A Variable's Scope is the area the variable is accessible from.

A variable's scope begins when it is declared, and extends until the end of the current block.<br>
The scope of global variables is the Lua environment itself and will not clear until Lua itself is shut down.

All [[#control_statements|control statements]] will create new scopes when used. Functions also create their on scope when declared<br>
The `do end` statement can be used to create scopes, and doesn't have any other functionality. I will be using it to showcase how scopes affect variables, as explaining it raw will not get the point across.

<syntaxHighlight lang="lua">
local a=4
local b=8
do
-- a and b are accessible here
local c = 12
-- a, b, and c are accessible here
a = 16 -- variable `a` in the outer scope is now `16`

local b = 20 -- b in the other scope has been overshadowed by this variable. All future references to `b` will refer to this variable (until the end of the scope)

print(a,b,c,d) --> 16, 20, 12, nil
end
print(a,b,c,d) --> 16, 8, 10, nil
-- Global c is still 10.

local e
do
local f=0

-- interesting thing is that functions capture the current scope.
-- Even if we leave the scope, the function remembers the upvalue `f` and will continue to use it even if the scope `f` belongs to ends
-- oh yea `a` is overshadowed here too. But thats not as interesting.
e=function(a)
f=f+1
print(f, a)
end
e()--> 1, nil
e()--> 2, nil
end

e() --> 3, nil
e("a") --> 4, "a"
</syntaxHighlight>
==Value Truthiness==
All values have an implicit truthiness when used in the context of a boolean.

It's simple to remember: <code>nil</code> and <code>false</code> are both considered "falsely", and every other value is considered "truthy".

Truthiness is used in control statements, see the section about it below.

==Operators==
Operators, similar functions, take 1 or 2 values and outputs a result.<br>
They commonly take the form <code>leftSide operator rightSide</code>.<br>
I will continue to refer to the 2 values that operators operate on as <code>leftSide</code> and <code>rightSide</code> for the duration of this section.<br>

Operators have a priority system. It is surprisingly intuitive, but can be forced by surrounding the code you want to guarantee execute first in brackets `()`. For the true priority list, check out the [https://www.lua.org/manual/5.2/manual.html#3.4.7 Lua Reference Manual].

Do note that despite me saying that "Only x can use this operator", tables and userdata types are always exempt from this rule. However, they must be explicitly written to support these operators, so most will not support it by default.
===Arithmetic Addition (+)===
Its addition. 1+1 returns 2. Basic stuff.<br>
Only numbers can use this operator.
===Arithmetic Subtraction (-)===
Its subtraction. 2-3 returns -1. Basic stuff.<br>
Only numbers can use this operator.
===Arithmetic Multiplication (*)===
Its multiplication. 2*4 returns 8. Basic stuff.<br>
Only numbers can use this operator.
===Arithmetic Division (/)===
Its division. 5/2 returns 2.5. Basic stuff.<br>
Only numbers can use this operator.
===Arithmetic Modulo (%)===
Division actually has 2 components. The whole component, and the remainder component.<br>
Modulo returns this remainder component after the division leftSide/rightSide is done.<br>
5%2 returns 1, because 2 goes into 5 2 whole times, 2*2=4, 5-4=1.<br>
Only numbers can use this operator.
===Arithmetic Exponentiation (^)===
Its exponents. 2^3 returns 8. Basic stuff.<br>
Only numbers can use this operator.
===Arithmetic Negation (-)===
Only operates on the rightSide.<br>
This operator negates the number, similar to just adding a negative symbol in front of it.<br>
<syntaxHighlight lang="lua">
local a= -2
a=-a
print(a) --> 2
</syntaxHighlight>
===Relational Equality (==)===
Returns `true` if both values are considered the same value, `false` otherwise.<br>
All values can use this operator.
===Relational Inequality (~=)===
Returns `false` if both values are considered the same value, `true` otherwise.<br>
All values can use this operator.
===Relational Less Than (<)===
Returns `true` if the leftSide is considered less then the rightSide, `false` otherwise.<br>
Numbers compare as expected.
Strings compare using their ascii representations, comparing each character left to right until they are not equal. Then the operator is applied to those 2 character's ascii numbers and returned.
===Relational Greater Than (>)===
Returns `true` if the leftSide is considered greater then the rightSide, `false` otherwise.<br>
Numbers compare as expected.
Strings compare using their ascii representations, comparing each character left to right until they are not equal. Then the operator is applied to those 2 character's ascii numbers and returned.
===Relational Less Than or Equal To (<=)===
Returns `true` if the leftSide is considered less then or equal to the rightSide using equality operator rules, `false` otherwise.<br>
Numbers compare as expected.
Strings compare using their ascii representations, comparing each character left to right until they are not equal. Then the operator is applied to those 2 character's ascii numbers and returned.
===Relational Greater Than or Equal To (>=)===
Returns `true` if the leftSide is considered greater then or equal to the rightSide using equality operator rules, `false` otherwise.<br>
Numbers compare as expected.
Strings compare using their ascii representations, comparing each character left to right until they are not equal. Then the operator is applied to those 2 character's ascii numbers and returned.
===Logical And (and)===
This operator operates on truthiness.<br>
If the leftSide is considered truthy, it returns the rightSide. Otherwise, it returns the leftSide.<br>
This ends up with the return value being truthy only if both leftSide ''and'' rightSide are truthy.<br>
The following table puts this visually. L is leftSide, R is rightSide. F and T represent if the value is falsy or truthy, and the column under O represents which value actually gets returned by `and` as well as the truthiness of it.
{| class="wikitable"
|-
! Left !! Right !! Output
|-
| False || False || False (Left)
|-
| False || True || False (Left)
|-
| True || False || False (Right)
|-
| True || True || True (Right)
|}
The reason this is so complex is because it doesn't just work on booleans. It works on all value types.

===Logical Or (or)===
This operator operates on truthiness.<br>
If the leftSide is considered truthy, it returns the leftSide. Otherwise, it returns the rightSide.<br>
This ends up with the return value being truthy either the leftSide ''or'' rightSide are truthy.<br>
The following table puts this visually. L is leftSide, R is rightSide. F and T represent if the value is falsy or truthy, and the column under O represents which value actually gets returned by `or` as well as the truthiness of it.

{| class="wikitable"
|-
! Left !! Right !! Output
|-
| False || False || False (Right)
|-
| False || True || True (Right)
|-
| True || False || True (Left)
|-
| True || True || True (Left)
|}

The reason this is so complex is because it doesn't just work on booleans. It works on all value types.

===Logical Not (not)===
Only operates on the rightSide.<br>
This operator evaluates the truthiness of the value, then returns the boolean representation of the opposite.<br>
<code>not true</code> is <code>false</code>, <code>not 2</code> is <code>false</code>, <code>not false</code> is <code>true</code>, <code>not {}</code> is <code>false</code>, and <code>not nil</code> is <code>true</code>.<br>
All values can use this operator.
===String Concatenation (..)===
This returns a string from the values concatenated together.<br>
Only strings can use this operator.
===Length Operator (#)===
Only operates on the rightSide.<br>
This returns the length of the value<br>
For strings, its the amount of bytes stored in the string. (UTF-8 characters are more than one byte)<br>
For tables, lua iterates over <code>t[1], t[2], t[3] ... t[n]</code> until a nil value is found and returns the number of non-nil values found.

==Control Statements==
Control Statements affect the scope and flow of the program.
===<code>if then end</code>===
<code>if</code> statements allow for executing code only when a condition is met.

The basic structure looks like
<syntaxHighlight lang="lua">
if condition then
print("condition is true")
end
</syntaxHighlight>

<code>if</code> statements have an optional <code>elseif</code> clause, where if the previous condition failed this condition will be checked. In an <code>elseif</code> chain, only the first successful condition will actually execute, after which all other <code>elseif</code>s are ignored.

<syntaxHighlight lang="lua">
if condition then
print("condition")
elseif condition2 then
print("condition2")
elseif condition3 then
print("condition3")
end
</syntaxHighlight>

<code>if</code> statements also have an optional <code>else</code> clause, where if ''all'' previous conditions fail, the <code>else</code> clause will execute.

<syntaxHighlight lang="lua">
if condition then
print("condition")
else
print("not condition")
end

if condition then
print("condition")
elseif condition2 then
print("condition2")
else
print("not condition or condition2")
end
</syntaxHighlight>

<code>else</code> statements operate on [[#value_truthiness|Value Truthiness]]
<syntaxHighlight lang="lua">
local rand = math.random()<0.3
-- Use booleans as raw input to if statements
-- the `==` operator just returns a boolean anyways and is just wasted instructions
if rand then
print("random print statement lol")
end

-- getVehicle returns either an Entity userdata, or nil
local vehicle=player:getVehicle()
if vehicle then
print("Riding: ", vehicle:getName())
else
print("No Mount")
end
</syntaxHighlight>

===Loops===

<syntaxHighlight lang="lua">
for i=1,10 do
print(i)
end
--> 1,2,3,4,5,6,7,8,9,10

local x = 1
while x < 10 do
x = x + 1
print(x)
end
</syntaxHighlight>

--TODO this has been sitting locally for several months. I'm uploading it and finishing it later

Community Resources

2024-10-05T23:37:15Z

Slyme: Removed Squishy API from Community Resources because Wiki team decided on that on Sept. 25, 2024

{{Notice/Warning
|content='''This page is heavily unfinished.'''<br>
Please wait before referring other people to this page. If you're able to, please [[FiguraMC:Contributing|contribute]]!
}}
{{Notice
|content='''Some of the resources listed here are not officially endorsed by FiguraMC.'''<br>
* Resources affiliated with FiguraMC will be marked as such with a ⭐ icon.
}}
= Documentation =
===[https://applejuiceyy.github.io/figs/ Figs]===
'''Figs''' is an online documentation browser for Figura, making using Figura's built-in documentation easier to use.
===[https://wiki.figuramc.org Figura Wiki] (YOU ARE HERE) ⭐===
The '''Figura Wiki''' is an online wiki that aims to document Figura, its scripting language, modeling, etc.
== Lua Documenation ==
===[https://manuel-3.github.io/lua-quickstart Lua Quickstart Guide]===
'''Manuel's Lua Quickstart Guide''' is a quick, online tutorial guiding users through the basics of Lua syntax.
===[http://lua.org/manual/5.1 Lua 5.1 Manual]===
The '''Lua Manual''' is a long document describing the ins and outs of vanilla Lua. Although some of it will not apply to Figura Lua, it's still very useful for learning about the standard libraries.
== Tutorials ==
===[https://www.youtube.com/playlist?list=PLNz7v2g2SFA8lOQUDS4z4-gIDLi_dWAhl Chloe's Video Tutorial Series]===
'''Chloe's Tutorial Series''' is a video series on YouTube that acts as a way for new users to get used to the mod. The series covers everything from modeling and modifying <code>avatar.json</code> files to scripting.
= Tools =
===[https://github.com/GrandpaScout/FiguraRewriteVSDocs GS' Figura VSCode Documentation]===
'''GrandpaScout's Figura VSCode Documentation''' is an addon for Visual Studio Code (along with Code OSS and VSCodium) that adds Figura's documentation and snippets to [https://marketplace.visualstudio.com/items?itemName=sumneko.lua sumneko's Lua Language Server plugin].
{{Collapsible
|content=* [https://github.com/GrandpaScout/FiguraRewriteVSDocs/wiki Install Guide]
|label=Additional Resources
}}
===[https://github.com/KitCat962/figura-format-bbplugin Katt's Figura Blockbench Extension]===
The '''Figura Blockbench Extension''' adds a new model format to Blockbench, the Figura Model format. It extends the base Generic Model format by adding tools to make the avatar creation process easier, lifting restrictions to the Generic Model format that Figura supports, and removing features Figura doesn't.
= Assets (Scripts, Libraries, APIs) =
{{Notice
|content='''Some assets only exist within the [https://discord.figuramc.org FiguraMC Discord].'''<br>
* Assets that link to the FiguraMC Discord will be marked with a 💬 icon.
}}
== Script Helpers ==
===[https://github.com/Manuel-3/figura-scripts/tree/main/src/runLater Run Later]===
'''Run Later''' is a script that allows users to run code after a set amount of time or after a condition is met, similar to a wait/sleep/halt instruction except it runs a function after the wait instead of the rest of the code.
== Animation Helpers ==
===[https://github.com/GrandpaScout/GSAnimBlend GSAnimBlend]===
'''GSAnimBlend''' is a script that automatically adds blends to the start and end of animations.
===[https://github.com/JimmyHelp/JimmyAnims Jimmy's Animation Handler]===
'''JimmyAnim''' (full name Jimmy's Animation Helper) is a library that plays specific Blockbench animations based on the player's current action.
{{Collapsible
|content=* [https://jimmyhelp.notion.site/JimmyAnims-79adfdca2fe04f9c9ede5e0bfd898b6a Documentation]
* [https://github.com/JimmyHelp/JimmyAnims/blob/main/JimmyExample.lua Example Usage]
|label=Additional Resources
}}
== World Interactions==
===[https://discord.com/channels/1129805506354085959/1132467393050968214/1132467393050968214 Origins API] 💬===
Katt's '''Origins API''' is an API that uses the player's NBT data to get information about the player's [https://modrinth.com/mod/origins Origin].
===[https://github.com/GrandpaScout/GSServerNet GSServerNet]===
'''GSServerNet''' allows Figura to communicate with the server/world the player is in using a companion datapack.
==Visual Elements==
===[https://github.com/Manuel-3/figura-scripts/tree/main/src/confetti Confetti]===
'''Confetti''' is a library that allows users to add custom particles, either sprite or modelpart, to their avatars
{{Collapsible
|content=* [https://github.com/Manuel-3/figura-scripts/blob/main/src/confetti/readme.md Documentation]
* [https://github.com/Manuel-3/figura-scripts/blob/main/src/confetti/example.zip Example Avatar]
|label=Additional Resources
}}
===[https://discord.com/channels/1129805506354085959/1137506926742216835 KattArmor] 💬===
'''KattArmor''' (sometimes called Katt Armor API/Library) is a library that allows users to edit their avatar's armor, whether by adding pivots using a script or by using unique models and textures.
{{Collapsible
|content=* [https://discord.com/channels/1129805506354085959/1137506926742216835/1155212562980425818 How-To Guide]
* [https://discord.com/channels/1129805506354085959/1137506926742216835/1262160359905562705 Example Avatars]
|label=Additional Resources
}}
===[https://github.com/MitchOfTarcoola/MOARArmsAPI MOAR Arms API]===
'''MOAR Arms API''' is a library that makes making an avatar with multiple arms easier, allowing an avatar to appear to hold more than two items at once.
===[https://github.com/lua-gods/figuraLibraries/tree/main/tail%20and%20ears Tail and Ears Physics]===
'''Tail and Ears Physics''' is a script that gives physics to a set of ears and multiple parts of a tail.
{{Collapsible
|content=* [https://github.com/lua-gods/figuraLibraries/blob/main/tail%20and%20ears/examples.lua Example Usage]
|label=Additional Resources
}}
===[https://github.com/lua-gods/figuraLibraries/blob/main/plushie/plushie.lua Plushie]===
'''Plushie''' snaps a skull model (specified in the config) to the floor below it and scales the model based on the amount above it.

= Community =
===[https://discord.figuramc.org FiguraMC Discord] ⭐===
The '''FiguraMC Discord Server''' is the central place for everything Figura, including help and support for the mod, avatar showcasing, and more. You'll also need to join this server to request whitelist to the FiguraSMP.
== Minecraft Servers ==
{{Notice
|content='''Some servers listed below are whitelisted.'''<br>
* Servers that have a public whitelist application process will be marked with a 🔒 icon.
* Servers that are invite-only will be marked with a 🛡️ icon.
}}
=== Figura Plaza ⭐ ===
'''IP: <code style="user-select: all">plaza.figuramc.org</code>''' • '''Version: 1.16.5 - 1.21'''

The '''Figura Plaza''' is an official lobby-like server where players can join, hang out with other Figura users, make avatars in company, play games, and occasionally attend events. The server does not have any survival gameplay, and disables PvP by default. The server also provides a selection of free temporary items to use when testing avatars.

=== Figura SMP ⭐🔒 ===
'''IP: <code style="user-select: all">vanilla.figuramc.org</code>''' • '''Version: 1.21'''

The '''Figura SMP''' (also referred to as Vanilla SMP) is an official survial server that stays close to the base game, plus a few server-side mods for quality-of-life purposes. You are perfectly able to join this server without any mods, and even on a vanilla client. You can read the server rules in the [https://discord.figuramc.org FiguraMC Discord Server]'s [https://discord.com/channels/1129805506354085959/1130186794873405510 #info] channel and get whitelisted by putting your name in [https://discord.com/channels/1129805506354085959/1130187119680311470 #whitelist].

==== Modded SMP ====
'''IP: <code style="user-select: none">[TBD]</code>''' • '''Version: 1.20.1-fabric''' • '''Modpack: <span style="user-select: none">[TBD]</span>'''

The '''Modded SMP''' is a seasonal modpack server adjacent to Figura SMP, each season coming with its own theme. '''Currently offline.''' The next season is themed after a nuclear apocalypse and is set for release Soon™. The ModdedSMP shares a whitelist with the VanillaSMP, meaning that [https://discord.com/channels/1129805506354085959/1130187119680311470 #whitelist] will whitelist you for both servers.

=== 4p5.nz 🛡️ ===
'''IP: <code style="user-select: all">4p5.nz</code>''' • '''Version: 1.20.1'''

'''4p5.nz''' is an invite-only creative/operator server where players have free reign over the world around them.

User:Slyme/Sandbox

2024-10-05T23:27:25Z

Slyme: Blanked the page

Community Resources

2024-10-05T22:48:43Z

Slyme: Added the rest of the Community Spotlight assets and converted collapsibles to the template.

{{Notice/Warning
|content='''This page is heavily unfinished.'''<br>
Please wait before referring other people to this page. If you're able to, please [[FiguraMC:Contributing|contribute]]!
}}
{{Notice
|content='''Some of the resources listed here are not officially endorsed by FiguraMC.'''<br>
* Resources affiliated with FiguraMC will be marked as such with a ⭐ icon.
}}
= Documentation =
===[https://applejuiceyy.github.io/figs/ Figs]===
'''Figs''' is an online documentation browser for Figura, making using Figura's built-in documentation easier to use.
===[https://wiki.figuramc.org Figura Wiki] (YOU ARE HERE) ⭐===
The '''Figura Wiki''' is an online wiki that aims to document Figura, its scripting language, modeling, etc.
== Lua Documenation ==
===[https://manuel-3.github.io/lua-quickstart Lua Quickstart Guide]===
'''Manuel's Lua Quickstart Guide''' is a quick, online tutorial guiding users through the basics of Lua syntax.
===[http://lua.org/manual/5.1 Lua 5.1 Manual]===
The '''Lua Manual''' is a long document describing the ins and outs of vanilla Lua. Although some of it will not apply to Figura Lua, it's still very useful for learning about the standard libraries.
== Tutorials ==
===[https://www.youtube.com/playlist?list=PLNz7v2g2SFA8lOQUDS4z4-gIDLi_dWAhl Chloe's Video Tutorial Series]===
'''Chloe's Tutorial Series''' is a video series on YouTube that acts as a way for new users to get used to the mod. The series covers everything from modeling and modifying <code>avatar.json</code> files to scripting.
= Tools =
===[https://github.com/GrandpaScout/FiguraRewriteVSDocs GS' Figura VSCode Documentation]===
'''GrandpaScout's Figura VSCode Documentation''' is an addon for Visual Studio Code (along with Code OSS and VSCodium) that adds Figura's documentation and snippets to [https://marketplace.visualstudio.com/items?itemName=sumneko.lua sumneko's Lua Language Server plugin].
{{Collapsible
|content=* [https://github.com/GrandpaScout/FiguraRewriteVSDocs/wiki Install Guide]
|label=Additional Resources
}}
===[https://github.com/KitCat962/figura-format-bbplugin Katt's Figura Blockbench Extension]===
The '''Figura Blockbench Extension''' adds a new model format to Blockbench, the Figura Model format. It extends the base Generic Model format by adding tools to make the avatar creation process easier, lifting restrictions to the Generic Model format that Figura supports, and removing features Figura doesn't.
= Assets (Scripts, Libraries, APIs) =
{{Notice
|content='''Some assets only exist within the [https://discord.figuramc.org FiguraMC Discord].'''<br>
* Assets that link to the FiguraMC Discord will be marked with a 💬 icon.
}}
== Script Helpers ==
===[https://github.com/Manuel-3/figura-scripts/tree/main/src/runLater Run Later]===
'''Run Later''' is a script that allows users to run code after a set amount of time or after a condition is met, similar to a wait/sleep/halt instruction except it runs a function after the wait instead of the rest of the code.
== Animation Helpers ==
===[https://github.com/GrandpaScout/GSAnimBlend GSAnimBlend]===
'''GSAnimBlend''' is a script that automatically adds blends to the start and end of animations.
===[https://github.com/JimmyHelp/JimmyAnims Jimmy's Animation Handler]===
'''JimmyAnim''' (full name Jimmy's Animation Helper) is a library that plays specific Blockbench animations based on the player's current action.
{{Collapsible
|content=* [https://jimmyhelp.notion.site/JimmyAnims-79adfdca2fe04f9c9ede5e0bfd898b6a Documentation]
* [https://github.com/JimmyHelp/JimmyAnims/blob/main/JimmyExample.lua Example Usage]
|label=Additional Resources
}}
== World Interactions==
===[https://discord.com/channels/1129805506354085959/1132467393050968214/1132467393050968214 Origins API] 💬===
Katt's '''Origins API''' is an API that uses the player's NBT data to get information about the player's [https://modrinth.com/mod/origins Origin].
===[https://github.com/GrandpaScout/GSServerNet GSServerNet]===
'''GSServerNet''' allows Figura to communicate with the server/world the player is in using a companion datapack.
==Visual Elements==
===[https://github.com/Manuel-3/figura-scripts/tree/main/src/confetti Confetti]===
'''Confetti''' is a library that allows users to add custom particles, either sprite or modelpart, to their avatars
{{Collapsible
|content=* [https://github.com/Manuel-3/figura-scripts/blob/main/src/confetti/readme.md Documentation]
* [https://github.com/Manuel-3/figura-scripts/blob/main/src/confetti/example.zip Example Avatar]
|label=Additional Resources
}}
===[https://discord.com/channels/1129805506354085959/1137506926742216835 KattArmor] 💬===
'''KattArmor''' (sometimes called Katt Armor API/Library) is a library that allows users to edit their avatar's armor, whether by adding pivots using a script or by using unique models and textures.
{{Collapsible
|content=* [https://discord.com/channels/1129805506354085959/1137506926742216835/1155212562980425818 How-To Guide]
* [https://discord.com/channels/1129805506354085959/1137506926742216835/1262160359905562705 Example Avatars]
|label=Additional Resources
}}
===[https://github.com/MrSirSquishy/SquishyAPI Squishy API]===
'''Squishy API''' (sometimes called SquAPI) is a library that provides many useful features to avatar creators, including physics, eye movement, etc.
{{Collapsible
|content=* [https://mrsirsquishy.notion.site/Squishy-API-Guide-3e72692e93a248b5bd88353c96d8e6c5 Documentation]
|label=Additional Resources
}}
===[https://github.com/MitchOfTarcoola/MOARArmsAPI MOAR Arms API]===
'''MOAR Arms API''' is a library that makes making an avatar with multiple arms easier, allowing an avatar to appear to hold more than two items at once.
===[https://github.com/lua-gods/figuraLibraries/tree/main/tail%20and%20ears Tail and Ears Physics]===
'''Tail and Ears Physics''' is a script that gives physics to a set of ears and multiple parts of a tail.
{{Collapsible
|content=* [https://github.com/lua-gods/figuraLibraries/blob/main/tail%20and%20ears/examples.lua Example Usage]
|label=Additional Resources
}}
===[https://github.com/lua-gods/figuraLibraries/blob/main/plushie/plushie.lua Plushie]===
'''Plushie''' snaps a skull model (specified in the config) to the floor below it and scales the model based on the amount above it.
= Community =
===[https://discord.figuramc.org FiguraMC Discord] ⭐===
The '''FiguraMC Discord Server''' is the central place for everything Figura, including help and support for the mod, avatar showcasing, and more. You'll also need to join this server to request whitelist to the FiguraSMP.
== Minecraft Servers ==
{{Notice
|content='''Some servers listed below are whitelisted.'''<br>
* Servers that have a public whitelist application process will be marked with a 🔒 icon.
* Servers that are invite-only will be marked with a 🛡️ icon.
}}
=== Figura Plaza ⭐ ===
'''IP: <code style="user-select: all">plaza.figuramc.org</code>''' • '''Version: 1.16.5 - 1.21'''

The '''Figura Plaza''' is an official lobby-like server where players can join, hang out with other Figura users, make avatars in company, play games, and occasionally attend events. The server does not have any survival gameplay, and disables PvP by default. The server also provides a selection of free temporary items to use when testing avatars.

=== Figura SMP ⭐🔒 ===
'''IP: <code style="user-select: all">vanilla.figuramc.org</code>''' • '''Version: 1.21'''

The '''Figura SMP''' (also referred to as Vanilla SMP) is an official survial server that stays close to the base game, plus a few server-side mods for quality-of-life purposes. You are perfectly able to join this server without any mods, and even on a vanilla client. You can read the server rules in the [https://discord.figuramc.org FiguraMC Discord Server]'s [https://discord.com/channels/1129805506354085959/1130186794873405510 #info] channel and get whitelisted by putting your name in [https://discord.com/channels/1129805506354085959/1130187119680311470 #whitelist].

==== Modded SMP ====
'''IP: <code style="user-select: none">[TBD]</code>''' • '''Version: 1.20.1-fabric''' • '''Modpack: <span style="user-select: none">[TBD]</span>'''

The '''Modded SMP''' is a seasonal modpack server adjacent to Figura SMP, each season coming with its own theme. '''Currently offline.''' The next season is themed after a nuclear apocalypse and is set for release Soon™. The ModdedSMP shares a whitelist with the VanillaSMP, meaning that [https://discord.com/channels/1129805506354085959/1130187119680311470 #whitelist] will whitelist you for both servers.

=== 4p5.nz 🛡️ ===
'''IP: <code style="user-select: all">4p5.nz</code>''' • '''Version: 1.20.1'''

'''4p5.nz''' is an invite-only creative/operator server where players have free reign over the world around them.

Template:Collapsible

2024-10-05T22:34:04Z

Slyme:

<div class="mw-collapsible mw-collapsed">
<div class="mw-heading4">{{{2|{{{label|See more}}}}}}
<div class="mw-collapsible-toggle-placeholder"></div>
</div>
<div class="mw-collapsible-content">
{{{1|{{{content}}}}}}
</div>
</div><noinclude>
<templatedata>
{
"params": {
"label": {
"aliases": [
"2"
],
"label": "Label",
"type": "content",
"required": false,
"description": "The header above the content, shown even if collapsed."
},
"content": {
"aliases": [
"1"
],
"label": "Content",
"type": "content",
"required": true,
"description": "The content of the collapsible."
}
},
"paramOrder": [
"content",
"label"
]
}
</templatedata>
</noinclude>

Template:Collapsible

2024-10-05T22:26:38Z

Slyme: Created page with "<templatestyles src="Template:Notice/style.css"/><div class="mw-collapsible mw-collapsed"> <div class="mw-heading4">{{{2|{{{label|See more}}}}}} <div class="mw-collapsible-toggle-placeholder"></div> </div> <div class="mw-collapsible-content"> {{{1|{{{content}}}}}} </div> </div><noinclude> <templatedata> { "params": { "label": { "aliases": [ "2" ], "label": "Label", "type": "content", "required": false, "description": "The header above th..."

<templatestyles src="Template:Notice/style.css"/><div class="mw-collapsible mw-collapsed">
<div class="mw-heading4">{{{2|{{{label|See more}}}}}}
<div class="mw-collapsible-toggle-placeholder"></div>
</div>
<div class="mw-collapsible-content">
{{{1|{{{content}}}}}}
</div>
</div><noinclude>
<templatedata>
{
"params": {
"label": {
"aliases": [
"2"
],
"label": "Label",
"type": "content",
"required": false,
"description": "The header above the content, shown even if collapsed."
},
"content": {
"aliases": [
"1"
],
"label": "Content",
"type": "content",
"required": true,
"description": "The content of the collapsible."
}
},
"paramOrder": [
"content",
"label"
]
}
</templatedata>
</noinclude>

User:Slyme/Sandbox

2024-10-05T22:13:23Z

Slyme:

==Test==
foo bar
==Test==
foo bar
==Test==
foo bar
==Test==
foo bar
==Test==
foo bar
==Test==
foo bar
==Test==
foo bar
==Test==
foo bar
==Test==
foo bar
<div class="mw-heading2">HelloWorld</div>
foo bar

User:Slyme/Sandbox

2024-10-05T22:12:52Z

Slyme: Created page with "==Test== foo bar ==Test== foo bar ==Test== foo bar ==Test== foo bar ==Test== foo bar ==Test== foo bar ==Test== foo bar ==Test== foo bar ==Test== foo bar"

==Test==
foo bar
==Test==
foo bar
==Test==
foo bar
==Test==
foo bar
==Test==
foo bar
==Test==
foo bar
==Test==
foo bar
==Test==
foo bar
==Test==
foo bar

Community Resources

2024-10-05T20:46:13Z

Slyme: Unfuck the sidebar v2

{{Notice/Warning
|content='''This page is heavily unfinished.'''<br>
Please wait before referring other people to this page. If you're able to, please [[FiguraMC:Contributing|contribute]]!
}}
{{Notice
|content='''Some of the resources listed here are not officially endorsed by FiguraMC.'''<br>
* Resources affiliated with FiguraMC will be marked as such with a ⭐ icon.
}}
= Documentation =
===[https://applejuiceyy.github.io/figs/ Figs]===
'''Figs''' is an online documentation browser for Figura, making using Figura's built-in documentation easier to use.
===[https://wiki.figuramc.org Figura Wiki] (YOU ARE HERE) ⭐===
The '''Figura Wiki''' is an online wiki that aims to document Figura, its scripting language, modeling, etc.
== Lua Documenation ==
===[https://manuel-3.github.io/lua-quickstart Lua Quickstart Guide]===
'''Manuel's Lua Quickstart Guide''' is a quick, online tutorial guiding users through the basics of Lua syntax.
===[http://lua.org/manual/5.1 Lua 5.1 Manual]===
The '''Lua Manual''' is a long document describing the ins and outs of vanilla Lua. Although some of it will not apply to Figura Lua, it's still very useful for learning about the standard libraries.
== Tutorials ==
===[https://www.youtube.com/playlist?list=PLNz7v2g2SFA8lOQUDS4z4-gIDLi_dWAhl Chloe's Video Tutorial Series]===
'''Chloe's Tutorial Series''' is a video series on YouTube that acts as a way for new users to get used to the mod. The series covers everything from modeling and modifying <code>avatar.json</code> files to scripting.
= Tools =
===[https://github.com/GrandpaScout/FiguraRewriteVSDocs GS' Figura VSCode Documentation]===
'''GrandpaScout's Figura VSCode Documentation''' is an addon for Visual Studio Code (along with Code OSS and VSCodium) that adds Figura's documentation and snippets to [https://marketplace.visualstudio.com/items?itemName=sumneko.lua sumneko's Lua Language Server plugin].
<div class="mw-collapsible mw-collapsed">
<h4>
Additional Resources
<div class="mw-collapsible-toggle-placeholder"></div>
</h4>
<div class="mw-collapsible-content">
* [https://github.com/GrandpaScout/FiguraRewriteVSDocs/wiki Install Guide]
</div>
</div>
===[https://github.com/KitCat962/figura-format-bbplugin Katt's Figura Blockbench Extension]===
The '''Figura Blockbench Extension''' adds a new model format to Blockbench, the Figura Model format. It extends the base Generic Model format by adding tools to make the avatar creation process easier, lifting restrictions to the Generic Model format that Figura supports, and removing features Figura doesn't.
= Assets (Scripts, Libraries, APIs) =
{{Notice
|content='''Some assets only exist within the [https://discord.figuramc.org FiguraMC Discord].'''<br>
* Assets that link to the FiguraMC Discord will be marked with a 💬 icon.
}}
== Animation Helpers ==
===[https://github.com/GrandpaScout/GSAnimBlend GSAnimBlend]===
'''GSAnimBlend''' is a script that automatically adds blends to the start and end of animations.
===[https://github.com/JimmyHelp/JimmyAnims Jimmy's Animation Handler]===
'''JimmyAnim''' (full name Jimmy's Animation Helper) is a library that plays specific Blockbench animations based on the player's current action.
<div class="mw-collapsible mw-collapsed">
<h4>
Additional Resources
<div class="mw-collapsible-toggle-placeholder"></div>
</h4>
<div class="mw-collapsible-content">
* [https://jimmyhelp.notion.site/JimmyAnims-79adfdca2fe04f9c9ede5e0bfd898b6a Documentation]
* [https://github.com/JimmyHelp/JimmyAnims/blob/main/JimmyExample.lua Example Usage]
</div>
</div>
== World Interactions==
===[https://discord.com/channels/1129805506354085959/1132467393050968214/1132467393050968214 Origins API] 💬===
Katt's '''Origins API''' is an API that uses the player's NBT data to get information about the player's [https://modrinth.com/mod/origins Origin].
==Visual Elements==
===[https://github.com/Manuel-3/figura-scripts/tree/main/src/confetti Confetti]===
'''Confetti''' is a library that allows users to add custom particles, either sprite or modelpart, to their avatars
<div class="mw-collapsible mw-collapsed">
<h4>
Additional Resources
<div class="mw-collapsible-toggle-placeholder"></div>
</h4>
<div class="mw-collapsible-content">
* [https://github.com/Manuel-3/figura-scripts/blob/main/src/confetti/readme.md Documentation]
* [https://github.com/Manuel-3/figura-scripts/blob/main/src/confetti/example.zip Example Avatar]
</div>
</div>
===[https://discord.com/channels/1129805506354085959/1137506926742216835 KattArmor] 💬===
'''KattArmor''' (sometimes called Katt Armor API/Library) is a library that allows users to edit their avatar's armor, whether by adding pivots using a script or by using unique models and textures.

<div class="mw-collapsible mw-collapsed">
<h4>
Additional Resources
<div class="mw-collapsible-toggle-placeholder"></div>
</h4>
<div class="mw-collapsible-content">
* [https://discord.com/channels/1129805506354085959/1137506926742216835/1155212562980425818 How-To Guide]
* [https://discord.com/channels/1129805506354085959/1137506926742216835/1262160359905562705 Example Avatars]
</div>
</div>
= Community =
===[https://discord.figuramc.org FiguraMC Discord] ⭐===
The '''FiguraMC Discord Server''' is the central place for everything Figura, including help and support for the mod, avatar showcasing, and more. You'll also need to join this server to request whitelist to the FiguraSMP.
== Minecraft Servers ==
{{Notice
|content='''Some servers listed below are whitelisted.'''<br>
* Servers that have a public whitelist application process will be marked with a 🔒 icon.
* Servers that are invite-only will be marked with a 🛡️ icon.
}}
=== Figura Plaza ⭐ ===
'''IP: <code style="user-select: all">plaza.figuramc.org</code>''' • '''Version: 1.16.5 - 1.21'''

The '''Figura Plaza''' is an official lobby-like server where players can join, hang out with other Figura users, make avatars in company, play games, and occasionally attend events. The server does not have any survival gameplay, and disables PvP by default. The server also provides a selection of free temporary items to use when testing avatars.

=== Figura SMP ⭐🔒 ===
'''IP: <code style="user-select: all">vanilla.figuramc.org</code>''' • '''Version: 1.21'''

The '''Figura SMP''' (also referred to as Vanilla SMP) is an official survial server that stays close to the base game, plus a few server-side mods for quality-of-life purposes. You are perfectly able to join this server without any mods, and even on a vanilla client. You can read the server rules in the [https://discord.figuramc.org FiguraMC Discord Server]'s [https://discord.com/channels/1129805506354085959/1130186794873405510 #info] channel and get whitelisted by putting your name in [https://discord.com/channels/1129805506354085959/1130187119680311470 #whitelist].

==== Modded SMP ====
'''IP: <code style="user-select: none">[TBD]</code>''' • '''Version: 1.20.1-fabric''' • '''Modpack: <span style="user-select: none">[TBD]</span>'''

The '''Modded SMP''' is a seasonal modpack server adjacent to Figura SMP, each season coming with its own theme. '''Currently offline.''' The next season is themed after a nuclear apocalypse and is set for release Soon™. The ModdedSMP shares a whitelist with the VanillaSMP, meaning that [https://discord.com/channels/1129805506354085959/1130187119680311470 #whitelist] will whitelist you for both servers.

=== 4p5.nz 🛡️ ===
'''IP: <code style="user-select: all">4p5.nz</code>''' • '''Version: 1.20.1'''

'''4p5.nz''' is an invite-only creative/operator server where players have free reign over the world around them.

Community Resources

2024-10-05T20:44:05Z

Slyme:

{{Notice/Warning
|content='''This page is heavily unfinished.'''<br>
Please wait before referring other people to this page. If you're able to, please [[FiguraMC:Contributing|contribute]]!
}}
{{Notice
|content='''Some of the resources listed here are not officially endorsed by FiguraMC.'''<br>
* Resources affiliated with FiguraMC will be marked as such with a ⭐ icon.
}}
= Documentation =
==='''[https://applejuiceyy.github.io/figs/ Figs]'''===
'''Figs''' is an online documentation browser for Figura, making using Figura's built-in documentation easier to use.
==='''[https://wiki.figuramc.org Figura Wiki]''' (YOU ARE HERE) ⭐===
The '''Figura Wiki''' is an online wiki that aims to document Figura, its scripting language, modeling, etc.
== Lua Documenation ==
==='''[https://manuel-3.github.io/lua-quickstart Lua Quickstart Guide]'''===
'''Manuel's Lua Quickstart Guide''' is a quick, online tutorial guiding users through the basics of Lua syntax.
==='''[http://lua.org/manual/5.1 Lua 5.1 Manual]'''===
The '''Lua Manual''' is a long document describing the ins and outs of vanilla Lua. Although some of it will not apply to Figura Lua, it's still very useful for learning about the standard libraries.
== Tutorials ==
==='''[https://www.youtube.com/playlist?list=PLNz7v2g2SFA8lOQUDS4z4-gIDLi_dWAhl Chloe's Video Tutorial Series]'''===
'''Chloe's Tutorial Series''' is a video series on YouTube that acts as a way for new users to get used to the mod. The series covers everything from modeling and modifying <code>avatar.json</code> files to scripting.
= Tools =
==='''[https://github.com/GrandpaScout/FiguraRewriteVSDocs GS' Figura VSCode Documentation]'''===
'''GrandpaScout's Figura VSCode Documentation''' is an addon for Visual Studio Code (along with Code OSS and VSCodium) that adds Figura's documentation and snippets to [https://marketplace.visualstudio.com/items?itemName=sumneko.lua sumneko's Lua Language Server plugin].
<div class="mw-collapsible mw-collapsed">
<h4>
Additional Resources
<div class="mw-collapsible-toggle-placeholder"></div>
</h4>
<div class="mw-collapsible-content">
* [https://github.com/GrandpaScout/FiguraRewriteVSDocs/wiki Install Guide]
</div>
</div>
==='''[https://github.com/KitCat962/figura-format-bbplugin Katt's Figura Blockbench Extension]'''===
The '''Figura Blockbench Extension''' adds a new model format to Blockbench, the Figura Model format. It extends the base Generic Model format by adding tools to make the avatar creation process easier, lifting restrictions to the Generic Model format that Figura supports, and removing features Figura doesn't.
= Assets (Scripts, Libraries, APIs) =
{{Notice
|content='''Some assets only exist within the [https://discord.figuramc.org FiguraMC Discord].'''<br>
* Assets that link to the FiguraMC Discord will be marked with a 💬 icon.
}}
== Animation Helpers ==
==='''[https://github.com/GrandpaScout/GSAnimBlend GSAnimBlend]'''===
'''GSAnimBlend''' is a script that automatically adds blends to the start and end of animations.
==='''[https://github.com/JimmyHelp/JimmyAnims Jimmy's Animation Handler]'''===
'''JimmyAnim''' (full name Jimmy's Animation Helper) is a library that plays specific Blockbench animations based on the player's current action.
<div class="mw-collapsible mw-collapsed">
<h4>
Additional Resources
<div class="mw-collapsible-toggle-placeholder"></div>
</h4>
<div class="mw-collapsible-content">
* [https://jimmyhelp.notion.site/JimmyAnims-79adfdca2fe04f9c9ede5e0bfd898b6a Documentation]
* [https://github.com/JimmyHelp/JimmyAnims/blob/main/JimmyExample.lua Example Usage]
</div>
</div>
== World Interactions==
==='''[https://discord.com/channels/1129805506354085959/1132467393050968214/1132467393050968214 Origins API]''' 💬===
Katt's '''Origins API''' is an API that uses the player's NBT data to get information about the player's [https://modrinth.com/mod/origins Origin].
==Visual Elements==
==='''[https://github.com/Manuel-3/figura-scripts/tree/main/src/confetti Confetti]'''===
'''Confetti''' is a library that allows users to add custom particles, either sprite or modelpart, to their avatars
<div class="mw-collapsible mw-collapsed">
<h4>
Additional Resources
<div class="mw-collapsible-toggle-placeholder"></div>
</h4>
<div class="mw-collapsible-content">
* [https://github.com/Manuel-3/figura-scripts/blob/main/src/confetti/readme.md Documentation]
* [https://github.com/Manuel-3/figura-scripts/blob/main/src/confetti/example.zip Example Avatar]
</div>
</div>
==='''[https://discord.com/channels/1129805506354085959/1137506926742216835 KattArmor]''' 💬===
'''KattArmor''' (sometimes called Katt Armor API/Library) is a library that allows users to edit their avatar's armor, whether by adding pivots using a script or by using unique models and textures.

<div class="mw-collapsible mw-collapsed">
<h4>
Additional Resources
<div class="mw-collapsible-toggle-placeholder"></div>
</h4>
<div class="mw-collapsible-content">
* [https://discord.com/channels/1129805506354085959/1137506926742216835/1155212562980425818 How-To Guide]
* [https://discord.com/channels/1129805506354085959/1137506926742216835/1262160359905562705 Example Avatars]
</div>
</div>
= Community =
==='''[https://discord.figuramc.org FiguraMC Discord]''' ⭐===
The '''FiguraMC Discord Server''' is the central place for everything Figura, including help and support for the mod, avatar showcasing, and more. You'll also need to join this server to request whitelist to the FiguraSMP.
== Minecraft Servers ==
{{Notice
|content='''Some servers listed below are whitelisted.'''<br>
* Servers that have a public whitelist application process will be marked with a 🔒 icon.
* Servers that are invite-only will be marked with a 🛡️ icon.
}}
=== Figura Plaza ⭐ ===
'''IP: <code style="user-select: all">plaza.figuramc.org</code>''' • '''Version: 1.16.5 - 1.21'''

The '''Figura Plaza''' is an official lobby-like server where players can join, hang out with other Figura users, make avatars in company, play games, and occasionally attend events. The server does not have any survival gameplay, and disables PvP by default. The server also provides a selection of free temporary items to use when testing avatars.

=== Figura SMP ⭐🔒 ===
'''IP: <code style="user-select: all">vanilla.figuramc.org</code>''' • '''Version: 1.21'''

The '''Figura SMP''' (also referred to as Vanilla SMP) is an official survial server that stays close to the base game, plus a few server-side mods for quality-of-life purposes. You are perfectly able to join this server without any mods, and even on a vanilla client. You can read the server rules in the [https://discord.figuramc.org FiguraMC Discord Server]'s [https://discord.com/channels/1129805506354085959/1130186794873405510 #info] channel and get whitelisted by putting your name in [https://discord.com/channels/1129805506354085959/1130187119680311470 #whitelist].

==== Modded SMP ====
'''IP: <code style="user-select: none">[TBD]</code>''' • '''Version: 1.20.1-fabric''' • '''Modpack: <span style="user-select: none">[TBD]</span>'''

The '''Modded SMP''' is a seasonal modpack server adjacent to Figura SMP, each season coming with its own theme. '''Currently offline.''' The next season is themed after a nuclear apocalypse and is set for release Soon™. The ModdedSMP shares a whitelist with the VanillaSMP, meaning that [https://discord.com/channels/1129805506354085959/1130187119680311470 #whitelist] will whitelist you for both servers.

=== 4p5.nz 🛡️ ===
'''IP: <code style="user-select: all">4p5.nz</code>''' • '''Version: 1.20.1'''

'''4p5.nz''' is an invite-only creative/operator server where players have free reign over the world around them.

Community Resources

2024-10-05T19:30:47Z

Slyme: Adding more resources. If someone could make an inline icon template that would be amazing

{{Notice/Warning
|content='''This page is heavily unfinished.'''<br>
Please wait before referring other people to this page. If you're able to, please [[FiguraMC:Contributing|contribute]]!
}}
{{Notice
|content='''Some of the resources listed here are not officially endorsed by FiguraMC.'''<br>
* Resources affiliated with FiguraMC will be marked as such with a ⭐ icon.
}}
= Documentation =
==='''[https://applejuiceyy.github.io/figs/ Figs]'''===
'''Figs''' is an online documentation browser for Figura, making using Figura's built-in documentation easier to use.
==='''[https://wiki.figuramc.org Figura Wiki]''' (YOU ARE HERE) ⭐===
The '''Figura Wiki''' is an online wiki that aims to document Figura, its scripting language, modeling, etc.
== Lua Documenation ==
==='''[https://manuel-3.github.io/lua-quickstart Lua Quickstart Guide]'''===
'''Manuel's Lua Quickstart Guide''' is a quick, online tutorial guiding users through the basics of Lua syntax.
==='''[http://lua.org/manual/5.1 Lua 5.1 Manual]'''===
The '''Lua Manual''' is a long document describing the ins and outs of vanilla Lua. Although some of it will not apply to Figura Lua, it's still very useful for learning about the standard libraries.
== Tutorials ==
==='''[https://www.youtube.com/playlist?list=PLNz7v2g2SFA8lOQUDS4z4-gIDLi_dWAhl Chloe's Video Tutorial Series]'''===
'''Chloe's Tutorial Series''' is a video series on YouTube that acts as a way for new users to get used to the mod. The series covers everything from modeling and modifying <code>avatar.json</code> files to scripting.
= Tools =
==='''[https://github.com/GrandpaScout/FiguraRewriteVSDocs GS' Figura VSCode Documentation]'''===
'''GrandpaScout's Figura VSCode Documentation''' is an addon for Visual Studio Code (along with Code OSS and VSCodium) that adds Figura's documentation and snippets to [https://marketplace.visualstudio.com/items?itemName=sumneko.lua sumneko's Lua Language Server plugin].
<div class="mw-collapsible mw-collapsed">
<h4>
Additional Resources
<div class="mw-collapsible-toggle-placeholder"></div>
</h4>
<div class="mw-collapsible-content">
* [https://github.com/GrandpaScout/FiguraRewriteVSDocs/wiki Install Guide]
</div>
</div>
==='''[https://github.com/KitCat962/figura-format-bbplugin Katt's Figura Blockbench Extension]'''===
The '''Figura Blockbench Extension''' adds a new model format to Blockbench, the Figura Model format. It extends the base Generic Model format by adding tools to make the avatar creation process easier, lifting restrictions to the Generic Model format that Figura supports, and removing features Figura doesn't.
= Assets (Scripts, Libraries, APIs) =
{{Notice
|content='''Some assets only exist within the [https://discord.figuramc.org FiguraMC Discord].'''<br>
* Assets that link to the FiguraMC Discord will be marked with a 💬 icon.
}}
== Animation Helpers ==
==='''[https://github.com/GrandpaScout/GSAnimBlend GSAnimBlend]'''===
'''GSAnimBlend''' is a script that automatically adds blends to the start and end of animations.
==='''[https://github.com/JimmyHelp/JimmyAnims Jimmy's Animation Handler]'''===
'''JimmyAnim''' (full name Jimmy's Animation Helper) is a library that plays specific Blockbench animations based on the player's current action.
<div class="mw-collapsible mw-collapsed">
<h4>
Additional Resources
<div class="mw-collapsible-toggle-placeholder"></div>
</h4>
<div class="mw-collapsible-content">
* [https://jimmyhelp.notion.site/JimmyAnims-79adfdca2fe04f9c9ede5e0bfd898b6a Documentation]
* [https://github.com/JimmyHelp/JimmyAnims/blob/main/JimmyExample.lua Example Usage]
</div>
</div>
== World Interactions==
==='''[https://discord.com/channels/1129805506354085959/1132467393050968214/1132467393050968214 Origins API]''' 💬===
Katt's '''Origins API''' is an API that uses the player's NBT data to get information about the player's [https://modrinth.com/mod/origins Origin].
==Visual Elements==
==='''[https://github.com/Manuel-3/figura-scripts/tree/main/src/confetti Confetti]'''===
'''Confetti''' is a library that allows users to add custom particles, either sprite or modelpart, to their avatars
<div class="mw-collapsible mw-collapsed">
<h4>
Additional Resources
<div class="mw-collapsible-toggle-placeholder"></div>
</h4>
<div class="mw-collapsible-content">
* [https://github.com/Manuel-3/figura-scripts/blob/main/src/confetti/readme.md Documentation]
* [https://github.com/Manuel-3/figura-scripts/blob/main/src/confetti/example.zip Example Avatar]
</div>
</div>
==='''[https://discord.com/channels/1129805506354085959/1137506926742216835 KattArmor]''' 💬===
'''KattArmor''' (sometimes called Katt Armor API/Library) is a library that allows users to edit their avatar's armor, whether by adding pivots using a script or by using unique models and textures.

<div class="mw-collapsible mw-collapsed">
<h4>
Additional Resources
<div class="mw-collapsible-toggle-placeholder"></div>
</h4>
<div class="mw-collapsible-content">
* [https://discord.com/channels/1129805506354085959/1137506926742216835/1155212562980425818 How-To Guide]
* [https://discord.com/channels/1129805506354085959/1137506926742216835/1262160359905562705 Example Avatars]
</div>
</div>
= Community =
==='''[https://discord.figuramc.org FiguraMC Discord]''' ⭐===
The '''FiguraMC Discord Server''' is the central place for everything Figura, including help and support for the mod, avatar showcasing, and more. You'll also need to join this server to request whitelist to the FiguraSMP.
== Minecraft Servers ==
{{Notice
|content='''Some servers listed below are whitelisted.'''<br>
* Servers that have a public whitelist application process will be marked with a 🔒 icon.
* Servers that are invite-only will be marked with a 🛡️ icon.
}}
==='''Figura Plaza''' ⭐===
'''Figura Plaza''' is a lobby-like server where players can join, hang out with other Figura users, make avatars in company, play games, and occasionally attend events.
plaza.figuramc.org
==='''FiguraSMP''' ⭐🔒===
The '''FiguraSMP''' is a set of two survival multiplayer servers—Vanilla and Modded—that are ran in affiliation with FiguraMC.
*Vanilla FiguraSMP is a server that stays close to the base game, only adding quality of life features for public servers.
*ModdedSMP is a seasonal modpack server, each season coming with its own theme.

Below is the Vanilla FiguraSMP address since the Modded SMP is currently between seasons.
vanilla.figuramc.org
==='''4p5.nz''' 🛡️===
'''4p5.nz''' is an invite-only creative/operator server where players have free reign over the world around them.
4p5.nz

Community Resources

2024-10-05T05:33:19Z

Slyme: First Draft; please continue adding on!

User:Slyme

2024-09-28T22:47:49Z

Slyme: Created page with "== Hi, players! == It's me!<br><span style="font-size:8pt;color:#00000050">Profile Art by Deni</span> I'm Slyme, a person on the internet. I do quite a lot of stuff with Figura — making avatars, scripts, official emojis, and more! <hr style="width:50%;height:2px;background: linear-gradient(90deg, rgba(226,140,0,1) 0%, rgba(236,205,0,1) 25%, rgba(255,255,255,1) 50%, rgba(98,174,220,1) 75%,..."

== Hi, players! ==
[[File:Slyme-Avatar.png|thumb|alt=A portrait of Slyme, a green humanoid slime.|It's me!<br><span style="font-size:8pt;color:#00000050">Profile Art by Deni</span>]]
I'm Slyme, a person on the internet. I do quite a lot of stuff with Figura — making avatars, scripts, official emojis, and more!
<hr style="width:50%;height:2px;background: linear-gradient(90deg, rgba(226,140,0,1) 0%, rgba(236,205,0,1) 25%, rgba(255,255,255,1) 50%, rgba(98,174,220,1) 75%, rgba(32,56,86,1) 100%);border-bottom: solid 1px #0003;">
{| class="wikitable"
| '''Species'''
| Slime
|-
| [https://en.wikipedia.org/wiki/Tz_database '''Time Zone''']
| America/Chicago
|-
| '''Site'''
| https://slyme.xyz
|}

File:Slyme-Avatar.png

2024-09-28T22:25:59Z

Slyme: A portrait of Slyme, a green humanoid slime. Art by Deni

== Summary ==
A portrait of Slyme, a green humanoid slime.
Art by Deni