FiguraMC - User contributions [en]

Main Page

2026-04-07T19:04:11Z

TheKillerBunny: Add replace notice

{{Notice/Warning
|content=
<div style="font-size: 1.5em; font-weight: bold; margin: 0.5em 0 0 0;">This wiki has been replaced.</div>
Please use the [https://docs.figuramc.org/ the documentation at docs.figuramc.org].
}}

== Navigation ==
{{Navbox documentation}}

Blinking

2024-12-18T01:29:23Z

TheKillerBunny: TheKillerBunny moved page Blinking to Tutorial:Blinking

#REDIRECT [[Tutorial:Blinking]]

Tutorial:Blinking

2024-12-18T01:29:23Z

TheKillerBunny: TheKillerBunny moved page Blinking to Tutorial:Blinking

Tutorial:Blinking

2024-12-18T01:28:30Z

TheKillerBunny: nvm the completed code is too big

Tutorial:Blinking

2024-12-18T01:28:02Z

TheKillerBunny: Add completed code and fix spelling errors

[[File:EyeGroup.png|thumb]] Avatars may blink as a means to convey a character's personality and suggest liveliness. To blink, you must first have eyes that have been split into a separate [[ModelPart]]. Your script will scale this group to simulate blinking.
To begin with, define variables containing parameters the script will use: the [[ModelPart Indexing|path to]] the eye model, their height, and the length of the blinking animation.
<syntaxHighlight lang="lua">
local eyes = models.model.root.UpperBody.TheHead.Eyes
local EYE_HEIGHT = 2 --The height of your eyes in blockbench units
local BLINK_RATE = 4 * 20 -- 4 Seconds
</syntaxHighlight>
The <code>BLINK_RATE</code> variable is multiplied by 20 as the script will deal in ticks, and there are 20 ticks in a second.

Next, the logic that determines when to blink will be performed in a <code>TICK</code> event. 4 new variables will also be needed to store the calculated position and scale for the eyes, alongside a simple timer. These will be initialized outside of the <code>TICK</code> event.
<syntaxHighlight lang="lua">
local oldScale = vec(1, 1, 1)
local newScale = vec(1, 1, 1)
local oldPos = vec(0, 0, 0)
local newPos = vec(0, 0, 0)

local tick = 0
function events.TICK()
-- Sets old pos and scale for later interpolation
oldPos = newPos
oldScale = newScale
tick = tick + 1

-- If time to blink, set new position and scale to close the eyes, otherwise open them
if tick % BLINK_RATE == 0 then
newScale = vec(1, 0, 1)
newPos = vec(0, EYE_HEIGHT / -2, 0)
else
newScale = vec(1, 1, 1)
newPos = vec(0, 0, 0)
end
end
</syntaxHighlight>

In order to give the blinking a smooth appearance, the rendered position and scale will be calculated and set in a <code>RENDER</code> event, using the variables initialized earlier.

<syntaxHighlight lang="lua">
function events.RENDER(delta)
-- This interpolates the blinking to make for a smooth blink
local scale = math.lerp(oldScale, newScale, delta)
local pos = math.lerp(oldPos, newPos, delta)

eyes:setPos(pos):setScale(scale)
end
</syntaxHighlight>

Here is the completed code:
<syntaxHighlight lang="lua">
local eyes = models.model.root.UpperBody.TheHead.Eyes
local EYE_HEIGHT = 2 --The height of your eyes in blockbench units
local BLINK_RATE = 4 * 20 -- 4 Seconds

local oldScale = vec(1, 1, 1)
local newScale = vec(1, 1, 1)
local oldPos = vec(0, 0, 0)
local newPos = vec(0, 0, 0)

local tick = 0
function events.TICK()
-- Sets old pos and scale for later interpolation
oldPos = newPos
oldScale = newScale
tick = tick + 1

-- If time to blink, set new position and scale to close the eyes, otherwise open them
if tick % BLINK_RATE == 0 then
newScale = vec(1, 0, 1)
newPos = vec(0, EYE_HEIGHT / -2, 0)
else
newScale = vec(1, 1, 1)
newPos = vec(0, 0, 0)
end
end

function events.RENDER(delta)
-- This interpolates the blinking to make for a smooth blink
local scale = math.lerp(oldScale, newScale, delta)
local pos = math.lerp(oldPos, newPos, delta)

eyes:setPos(pos):setScale(scale)
end
</syntaxHighlight>

[[Category:Tutorials]]

Print

2024-12-15T00:40:17Z

TheKillerBunny: Created page with "Figura's print function is simlar to lua's print function, but has a couple extra features: * You can hover over a table to view it's children ** This includes userdata such as {{type|Vector3s}}"

Figura's print function is simlar to lua's print function, but has a couple extra features:

* You can hover over a table to view it's children
** This includes userdata such as {{type|Vector3s}}

Action wheel (tutorial)

2024-12-10T17:28:28Z

TheKillerBunny:

{{Distinguish|ActionWheelAPI}}
The Action Wheel is a GUI element added by Figura which allows you to add additional functionality to your avatar.

By default, the action wheel is opened by holding down the <kbd>B</kbd> key. This can be changed in Figura's Settings.

The Action Wheel consists of a set of [[Page|Pages]], of which only one can be active at a time.
Each page can have an unlimited number of [[Action|Actions]]. Only 8 Actions can be rendered at a time, however — if more than 8 Actions are active on a page, the scroll wheel can be used to navigate between the sets of Actions (8 at a time.)

For full documentation, see:
* {{type|ActionWheelAPI}} for the global <code>action_wheel</code>,
* {{type|Page}} for pages, and
* {{type|Action}} for actions.

== Basic Example ==
The first step to using the Action Wheel is to create a page to hold the Actions, via <code>[[ActionWheelAPI#newPage|newPage]]</code>.

<syntaxhighlight lang="lua" line="1" highlight="1">
local mainPage = action_wheel:newPage()
</syntaxhighlight>

This creates a new page, but doesn't do anything else. If you save the script and try to open the Action Wheel (<kbd>B</kbd>), you will see a message stating that there is no active page. Using <code>[[ActionWheelAPI#setPage|setPage]]</code> with the newly created page will change the current active page:

<syntaxhighlight lang="lua" line="1" highlight="2">
local mainPage = action_wheel:newPage()
action_wheel:setPage(mainPage)
</syntaxhighlight>

The message about not having an active page should be gone now, but the page is still empty. Let's add some actions.

=== Adding Actions ===

Create a new action by calling <code>[[Page#newAction|newAction]]</code> on a Page, like so:

<syntaxhighlight lang="lua" line="1" highlight="4">
local mainPage = action_wheel:newPage()
action_wheel:setPage(mainPage)

local action = mainPage:newAction()
</syntaxhighlight>

Because we haven't set up the visuals, the action is essentially invisible, but you should still be able to hover it with your mouse and have it be highlighted. Let's add some visuals!

{{note|1=
Most methods applying to Actions return the the Action being worked upon. This also applies to quite a few other kinds of object in Figura. In the documentation, this is noted by the presence of the word 'self' in the ''Return Type'' column. Methods that return 'self' are handy because they allow for 'chaining', as demonstrated below.
}}

* <code>[[Action#setTitle|title]]</code>: Set the text displayed when hovering over the action
* <code>[[Action#setItem|item]]</code>: Use an item as the icon to be displayed
* <code>[[Action#setHoverColor|hoverColor]]</code>: Set the background color of the action when it is hovered over, as red/green/blue

<syntaxhighlight lang="lua" line="1" highlight="5-7">
local mainPage = action_wheel:newPage()
action_wheel:setPage(mainPage)

local action = mainPage:newAction()
:title("My Action") -- displayed when hovering the action
:item("minecraft:stick") -- action icon
:hoverColor(1, 0, 1) -- magenta
</syntaxhighlight>

=== Making Actions work ===

Now that you can see the action, it's time to add some functionality to it. It is possible to define behavior for when an action is [[Action#field_leftClick|left-clicked]] and [[Action#field_rightClick|right-clicked]] separately. For this tutorial, we will define a left-click action.

<syntaxhighlight lang="lua" line="1" highlight="8-11">
local mainPage = action_wheel:newPage()
action_wheel:setPage(mainPage)

local action = mainPage:newAction()
:title("My Action") -- displayed when hovering the action
:item("minecraft:stick") -- action icon
:hoverColor(1, 0, 1) -- magenta
-- this method sets the leftClick field of the Action
:onLeftClick(function()
print("Hello, world!")
end)
</syntaxhighlight>

If you click the Action in your Action Wheel (don't forget to save), it should write "Hello, world!" in your chat.
However, there is a problem with the current code — its effects won't be seen by other players when playing multiplayer.

=== Making Actions work in multiplayer ===
{{hatnote|For more information, see [[Pings (Tutorial)]].|extraclasses=no-border}}

Due to the nature of Figura, all code is run client-side. Because the Action Wheel is entirely added and controlled by Figura, the Minecraft Server will '''never synchronize it with other clients'''. To fix this problem, we need to utilize Pings to synchronize the actions you take with the Action Wheel.

The first step to this process is to move the code that would normally be executed when you click the Action into a ping function. Next, replace the 'anonymous function' (<code>function()...end</code> block) with the ping function.

{{Notice/Warning|content=
All ping functions '''must have unique names'''. If you're adding multiple actions, you need to '''use a different name for each ping function.''' Otherwise, every Action will run the same function (this is probably not what you want!)
}}

{{note|1=
Choose a function name that describes what the function does. It will help you (and people giving support) understand your code when reading it in the future.
}}

<syntaxhighlight lang="lua" line="1" highlight="4-8,14-15">
local mainPage = action_wheel:newPage()
action_wheel:setPage(mainPage)

-- Create a ping function that does the same thing that the Action did before
-- The function needs to be defined above the code that defines the Action.
function pings.printHelloWorld()
print("Hello, world!")
end

local action = mainPage:newAction()
:title("My Action") -- displayed when hovering the action
:item("minecraft:stick") -- action icon
:hoverColor(1, 0, 1) -- magenta
-- Pass the ping function directly to onLeftClick - note that there is no () after 'printHelloWorld'
:onLeftClick(pings.printHelloWorld)
</syntaxhighlight>

This code correctly synchronizes your actions across clients!

If you need to pass arguments to the function (i.e. sending data only the host knows), you need to do a bit more work.
For this example, we are sending a random number to the function and we want to use Pings so that each client sees the same number (rather than selecting a different random number on each client.)

We need to wrap the call to the ping inside another function:

<syntaxhighlight lang="lua" line="1" highlight="12-14">
local mainPage = action_wheel:newPage()
action_wheel:setPage(mainPage)

function pings.printANumber(a)
print("the number is ", a)
end

local action = mainPage:newAction()
:title("My Action") -- displayed when hovering the action
:item("minecraft:stick") -- action icon
:hoverColor(1, 0, 1) -- magenta
:onLeftClick(function()
pings.printANumber(math.random())
end)
</syntaxhighlight>

Watch out for this common mistake:

<syntaxhighlight lang="lua">
-- THIS CODE DOES NOT WORK, DON'T DO THIS
-- ... more action stuff ...
:onLeftClick(pings.printANumber(math.random()))
</syntaxhighlight>

While this may appear to make sense, it actually '''calls the ping function''' and then sets the result as the left-click action. Because ping functions don't return values (effectively, they always return {{type|nil}}) this code removes the left-click action.

=== Full example ===
<syntaxhighlight lang="lua" line="1">
local mainPage = action_wheel:newPage()
action_wheel:setPage(mainPage)

function pings.actionClicked() -- don't forget to change the name if you're re-using this
print("Hello, world!")
-- one of the most common things to do is play an animation (like an emote wheel)
-- you'll need to fill out the path to your Blockbench model and name of the animation to use this
-- animations["<MODEL PATH HERE>"]["<ANIMATION NAME HERE>"]:play()
end

local action = mainPage:newAction()
:title("Action name")
:item("minecraft:stick")
:hoverColor(1, 0, 1)
:onLeftClick(pings.actionClicked)
</syntaxhighlight>

== Toggle Example ==
{{hatnote|Read the [[#Basic Example|Basic Example]] first to set up a page.|extraclasses=no-border}}

By using <code>[[Action#setOnToggle|setOnToggle]]</code> instead of <code>onLeftClick</code>, an Action can be turned into a toggle that can be turned on ({{type|true}}) and off ({{type|false}}).

There are also various Action methods that apply when an Action is toggled on. These are prefixed with <code>toggle</code>.

Toggle functions accept one argument (the toggle state, a {{type|boolean}}).

<syntaxhighlight lang="lua" line highlight="19">
-- this uses the mainPage from the previous tutorial

function pings.toggleModel(state) -- rename to something relevant
-- generally hiding your entire model is a bad idea but it demostrates the concept
models:setVisible(state)
--- If you want something to be enabled when the toggle is *disabled*, use 'not':
-- models:setVisible(not state)

--- You can play a looping animation continuously while a toggle is enabled:
--- Same deal as last time; replace the model name and animation name with your own
-- animations["<MODEL PATH HERE>"]["<ANIMATION NAME HERE>"]:setPlaying(state)
end

local modelToggle = mainPage:newAction() -- if erroring here: does the page exist?
:title("Model disabled")
:toggleTitle("Model enabled")
:item("red_wool")
:toggleItem("green_wool")
:setOnToggle(pings.toggleModel)
</syntaxhighlight>

== Using multiple Pages ==
Using multiple pages allows you to create more complex setups, such as an action opening a 'sub-menu' of sorts with more actions.

Setting up multiple pages is pretty simple — use <code>newPage</code> multiple times and store each page in its own variable.

<syntaxhighlight lang="lua" line>
local mainPage = action_wheel:newPage()
local secondPage = action_wheel:newPage()
action_wheel:setPage(mainPage)
</syntaxhighlight>

Create an action to switch to a different page:

<syntaxhighlight lang="lua" line highlight="5-13">
local mainPage = action_wheel:newPage()
local secondPage = action_wheel:newPage()
action_wheel:setPage(mainPage)

-- This action switches to the second page when clicked.
local switchToSecond = mainPage:newAction()
:title("Switch To Second Page")
:item("arrow")
:onLeftClick(function()
-- You don't need to ping page changes because they only matter
-- on the host (viewers don't care)
action_wheel:setPage(secondPage)
end)
</syntaxhighlight>

Do something similar to create a second action to go back:

<syntaxhighlight lang="lua" line highlight="15-20">
local mainPage = action_wheel:newPage()
local secondPage = action_wheel:newPage()
action_wheel:setPage(mainPage)

-- This action switches to the second page when clicked.
local switchToSecond = mainPage:newAction()
:title("Switch To Second Page")
:item("arrow")
:onLeftClick(function()
-- You don't need to ping page changes because they only matter
-- on the host (viewers don't care)
action_wheel:setPage(secondPage)
end)

local switchToMain = secondPage:newAction()
:title("Switch To Main Page")
:item("item_frame")
:onLeftClick(function()
action_wheel:setPage(mainPage)
end)
</syntaxhighlight>

Now you should be able to switch between the pages! Each page has its own set of actions.

Vectors and Matrices

2024-10-29T12:14:14Z

TheKillerBunny:

{{Stub}}
{{Distinguish|Vectors (Global)|Vector|Matrices (Global)}}
Vectors and matrices at their core are '''a set of numbers''' that represent something (e.g. a Vector3 could represent a position in the world.)

Vectors are one-dimensional; for example, a {{Type|Vector3}} holds 3 numbers. Vectors are most commonly used for representing the position and rotation of things.

Matrices are two-dimensional grids. All matrices are square, so a {{Type|Matrix3}} is a 3 by 3 grid of numbers. Matrices are most commonly used to represent transformations of vectors. For more in-depth information, see [[Wikipedia:Transformation matrix|the Wikipedia article on transformation matrices]].

== Vectors ==
Many functions that take in a vector will also take in the same amount of numbers and internally convert it into a Vector.

Vectors come in 3 types: Vector2, Vector3, and Vector4. The number refers to the size of the vector (Vector4 has 4 numbers, etc.) You can create a vector by using the global method <code>vec</code> as shown:
* vec(x {{Type|number}}, y {{Type|number}}, z {{Type|number?}}, w {{Type|number?}})
This method will return a vector based on how many arguments you input.

== Matrices ==
Matrices are a set of vectors, which are normally used to change where models are, how they look, etc.

== Navigation ==
[[Category:Types]]
{{Navbox documentation}}

Template:Notice

2024-10-24T16:36:29Z

TheKillerBunny:

<templatestyles src="Template:Notice/style.css"/><div class="noticebox" style="--border: {{{outline|#36c}}}; --background: {{{background|#def}}};color: {{{textcolor|#000}}}">
{{{1|{{{content}}}}}}
</div><noinclude>
<templatedata>
{
"params": {
"outline": {
"label": "Outline",
"description": "Color used for the border, including the left side color swatch.",
"default": "#36c"
},
"background": {
"label": "Background",
"description": "Color used for the background of the box.",
"default": "#def"
},
"content": {
"aliases": [
"1"
],
"label": "Content",
"type": "content",
"required": true
},
"textcolor": {
"aliases": [
"color"
],
"label": "Text Color",
"description": "Color to use for the box's text",
"type": "string",
"default": "#000"
}
},
"paramOrder": [
"content",
"outline",
"background",
"textcolor"
],
"format": "inline"
}
</templatedata>
</noinclude>

Template:Type

2024-10-24T16:28:54Z

TheKillerBunny: /* Examples */

<includeonly><templatestyles src="Template:Type/style.css"/>{{#invoke:Type|run}}</includeonly><noinclude> 
'''Displays a ''type widget''.'''

* All options are routed through [[Module:Type]]. (Edit to add aliases or custom links for matching types.)
* Stylesheet: [[Template:Type/style.css]]. (Edit to add colors and decorations for custom types.)

== Examples ==
* {{type|nil}} <code><nowiki>{{type|nil}}</nowiki></code>
* {{type|number}}
* {{type|integer}}, {{type|double}}, {{type|float}}
* {{type|numbers|?}} (optional number)
* {{type|string}}
* {{type|boolean}}
* {{type|function}}
* {{type|table}}
* {{type|Vector}} ({{type|Vector2}}, {{type|Vector3}}, {{type|Vector4}})
* {{type|Matrix}} ({{type|Matrix2}}, {{type|Matrix3}}, {{type|Matrix4}})
* {{type|Event}} (custom type that exists)
* {{type|CrashAPI}} (custom type that doesn't exist)
* {{type|Main Page|link=Event}} (links to [[Event]]) <code><nowiki>{{type|Main Page|link=Event}}</nowiki></code>
[[Template:Type/testcases|Testcases page.]]
<templatedata>
{
"params": {
"1": {
"label": "Type name",
"suggestedvalues": [
"nil",
"boolean",
"integer",
"number",
"string",
"function",
"table",
"Vector",
"Matrix"
],
"required": true,
"aliases": [
"name"
],
"description": "Type name ('table' etc.) Supports modifiers, like ? and [].",
"type": "string"
},
"2": {
"description": "Type modifiers (compatibility)",
"deprecated": "Attach modifiers directly to the type name."
},
"link": {
"label": "Custom link target",
"type": "wiki-page-name"
},
"text": {
"label": "Custom text",
"description": "If provided, this text will be displayed instead of the type name. The link and styling will still be determined by the type name.",
"type": "content"
}
},
"description": "Displays and links to types.",
"paramOrder": [
"1",
"link",
"text",
"2"
],
"format": "inline"
}
</templatedata></noinclude>

Template:Type

2024-10-24T16:28:30Z

TheKillerBunny: /* Examples */

<includeonly><templatestyles src="Template:Type/style.css"/>{{#invoke:Type|run}}</includeonly><noinclude> 
'''Displays a ''type widget''.'''

* All options are routed through [[Module:Type]]. (Edit to add aliases or custom links for matching types.)
* Stylesheet: [[Template:Type/style.css]]. (Edit to add colors and decorations for custom types.)

== Examples ==
* {{type|nil}} <code><nowiki>{{type|nil}}</nowiki></code>
* {{type|number}}
* {{type|integer}},{{type|double}},{{type|float}}
* {{type|numbers|?}} (optional number)
* {{type|string}}
* {{type|boolean}}
* {{type|function}}
* {{type|table}}
* {{type|Vector}} ({{type|Vector2}}, {{type|Vector3}}, {{type|Vector4}})
* {{type|Matrix}} ({{type|Matrix2}}, {{type|Matrix3}}, {{type|Matrix4}})
* {{type|Event}} (custom type that exists)
* {{type|CrashAPI}} (custom type that doesn't exist)
* {{type|Main Page|link=Event}} (links to [[Event]]) <code><nowiki>{{type|Main Page|link=Event}}</nowiki></code>
[[Template:Type/testcases|Testcases page.]]
<templatedata>
{
"params": {
"1": {
"label": "Type name",
"suggestedvalues": [
"nil",
"boolean",
"integer",
"number",
"string",
"function",
"table",
"Vector",
"Matrix"
],
"required": true,
"aliases": [
"name"
],
"description": "Type name ('table' etc.) Supports modifiers, like ? and [].",
"type": "string"
},
"2": {
"description": "Type modifiers (compatibility)",
"deprecated": "Attach modifiers directly to the type name."
},
"link": {
"label": "Custom link target",
"type": "wiki-page-name"
},
"text": {
"label": "Custom text",
"description": "If provided, this text will be displayed instead of the type name. The link and styling will still be determined by the type name.",
"type": "content"
}
},
"description": "Displays and links to types.",
"paramOrder": [
"1",
"link",
"text",
"2"
],
"format": "inline"
}
</templatedata></noinclude>

Module:Type

2024-10-24T16:27:24Z

TheKillerBunny:

local exports = {}

local builtin_url = "https://www.lua.org/manual/5.2/manual.html#2.1"
local BUILTINS = {
["nil"] = true,
["number"] = true,
["boolean"] = true,
["string"] = true,
["true"] = true,
["false"] = true,
["function"] = true,
["table"] = true,
-- not really a builtin but close enough
["any"] = true
}
local NOT_PLURAL = {
["Matrixs"] = true,
}
local ALIASES = {
["^bool$"] = "boolean",
["^[Ii]nteger$"] = "number",
["^[Dd]ouble$"] = "number",
["^[Ff]loat$"] = "number",
["^[Mm]atrices$"] = "Matrix",
["^[Mm]atrix[234]?$"] = "Matrix",
["^[Vv]ector[234]?$"] = "Vector",
}
local LINKS = {
["^Vector$"] = "Vectors and Matrices",
["^Matrix$"] = "Vectors and Matrices"
}

local function exists(page_name)
return mw.title.new(page_name).exists
end

local function infer_name_link(frame, type_data)
local name = type_data.name
name = name:gsub("%s*$", ""):gsub("^%s*", "")
if not NOT_PLURAL[name] then name = name:gsub("s$", "") end
for pat, repl in pairs(ALIASES) do
local new_name, count = name:gsub(pat, repl)
if count > 0 then name = new_name break end
end

type_data.css_name = name
if type_data.link then
if type_data.link:find("^https?://") then type_data.link_external = true end
return
end
if BUILTINS[name] then
type_data.link = builtin_url
type_data.link_external = true
return
end
local link
for pat, target in pairs(LINKS) do
if name:find(pat) then link = target break end
end
if not link then
if exists(name .. " (type)") then
link = name .. " (type)"
else
link = name
if not exists(name) then
type_data.extra_attr = (type_data.extra_attr or "") .. " data-missing"
end
end
end
if link:find("^https?://") then type_data.link_external = true end
type_data.link = link
end

local function create(frame, options)
infer_name_link(frame, options)

if options.modifiers and options.modifiers:find("^%s*$") then options.modifiers = nil end

local secondary_text = options.modifiers
local link = options.link
local text = options.text or options.name
local link_text
if options.link_external then
link_text = string.format("[%s %s]", options.link, text)
else
link_text = string.format("[[%s|%s]]", options.link, text)
end
local secondary = string.format([[<span class="lua-type-mod">%s</span>]], secondary_text or "")
return string.format(
[=[<span class="lua-type" data-name="%s"%s>%s%s</span>]=],
options.css_name, options.extra_attr or "", link_text, secondary_text and secondary or ""
)
end

-- local function resolve_type()

local function expand_types(type_name)
local name, modifiers = type_name:match("^([^?[]-)([[%]?]*)$")
if not name then error("Couldn't parse type name " .. type_name) end
local result = {}
if modifiers:find("?$") then
modifiers = modifiers:sub(1, -2) -- cut off the ?
table.insert(result, {name="nil"})
end
table.insert(result, 1, {name=name, modifiers=modifiers})
return result
end

function exports.run(frame)
local sb = ""
local input_args = frame:getParent().args

if not (input_args[1] or input_args.name) then error "need to specify at least one type name" end

local name = input_args[1] or input_args.name
local compatibility_mode = {["?"]=true,["[]"]=true, ["[]?"]=true}
if input_args[2] and compatibility_mode[input_args[2]] then
name = name .. input_args[2]
end

local type_structs = expand_types(name)
if input_args.text then type_structs[1].text = input_args.text end
if input_args.link then type_structs[1].link = input_args.link end
local strings = {}
for _, part in ipairs(type_structs) do table.insert(strings, create(frame, part)) end
return table.concat(strings, " | ")
end

return exports

Module:Type

2024-10-24T16:26:09Z

TheKillerBunny:

local exports = {}

local builtin_url = "https://www.lua.org/manual/5.2/manual.html#2.1"
local BUILTINS = {
["nil"] = true,
["number"] = true,
["integer"] = true,
["boolean"] = true,
["string"] = true,
["true"] = true,
["false"] = true,
["function"] = true,
["table"] = true,
-- not really a builtin but close enough
["any"] = true
}
local NOT_PLURAL = {
["Matrixs"] = true,
}
local ALIASES = {
["^bool$"] = "boolean",
["^[Ii]nteger$"] = "number",
["^[Dd]ouble$"] = "number",
["[Ff]loat$"] = "number",
["^[Mm]atrices$"] = "Matrix",
["^[Mm]atrix[234]?$"] = "Matrix",
["^[Vv]ector[234]?$"] = "Vector",
}
local LINKS = {
["^Vector$"] = "Vectors and Matrices",
["^Matrix$"] = "Vectors and Matrices"
}

local function exists(page_name)
return mw.title.new(page_name).exists
end

local function infer_name_link(frame, type_data)
local name = type_data.name
name = name:gsub("%s*$", ""):gsub("^%s*", "")
if not NOT_PLURAL[name] then name = name:gsub("s$", "") end
for pat, repl in pairs(ALIASES) do
local new_name, count = name:gsub(pat, repl)
if count > 0 then name = new_name break end
end

type_data.css_name = name
if type_data.link then
if type_data.link:find("^https?://") then type_data.link_external = true end
return
end
if BUILTINS[name] then
type_data.link = builtin_url
type_data.link_external = true
return
end
local link
for pat, target in pairs(LINKS) do
if name:find(pat) then link = target break end
end
if not link then
if exists(name .. " (type)") then
link = name .. " (type)"
else
link = name
if not exists(name) then
type_data.extra_attr = (type_data.extra_attr or "") .. " data-missing"
end
end
end
if link:find("^https?://") then type_data.link_external = true end
type_data.link = link
end

local function create(frame, options)
infer_name_link(frame, options)

if options.modifiers and options.modifiers:find("^%s*$") then options.modifiers = nil end

local secondary_text = options.modifiers
local link = options.link
local text = options.text or options.name
local link_text
if options.link_external then
link_text = string.format("[%s %s]", options.link, text)
else
link_text = string.format("[[%s|%s]]", options.link, text)
end
local secondary = string.format([[<span class="lua-type-mod">%s</span>]], secondary_text or "")
return string.format(
[=[<span class="lua-type" data-name="%s"%s>%s%s</span>]=],
options.css_name, options.extra_attr or "", link_text, secondary_text and secondary or ""
)
end

-- local function resolve_type()

local function expand_types(type_name)
local name, modifiers = type_name:match("^([^?[]-)([[%]?]*)$")
if not name then error("Couldn't parse type name " .. type_name) end
local result = {}
if modifiers:find("?$") then
modifiers = modifiers:sub(1, -2) -- cut off the ?
table.insert(result, {name="nil"})
end
table.insert(result, 1, {name=name, modifiers=modifiers})
return result
end

function exports.run(frame)
local sb = ""
local input_args = frame:getParent().args

if not (input_args[1] or input_args.name) then error "need to specify at least one type name" end

local name = input_args[1] or input_args.name
local compatibility_mode = {["?"]=true,["[]"]=true, ["[]?"]=true}
if input_args[2] and compatibility_mode[input_args[2]] then
name = name .. input_args[2]
end

local type_structs = expand_types(name)
if input_args.text then type_structs[1].text = input_args.text end
if input_args.link then type_structs[1].link = input_args.link end
local strings = {}
for _, part in ipairs(type_structs) do table.insert(strings, create(frame, part)) end
return table.concat(strings, " | ")
end

return exports

Template:Type

2024-10-24T16:22:45Z

TheKillerBunny:

<includeonly><templatestyles src="Template:Type/style.css"/>{{#invoke:Type|run}}</includeonly><noinclude> 
'''Displays a ''type widget''.'''

* All options are routed through [[Module:Type]]. (Edit to add aliases or custom links for matching types.)
* Stylesheet: [[Template:Type/style.css]]. (Edit to add colors and decorations for custom types.)

== Examples ==
* {{type|nil}} <code><nowiki>{{type|nil}}</nowiki></code>
* {{type|number}}
* {{type|integer}}
* {{type|numbers|?}} (optional number)
* {{type|string}}
* {{type|boolean}}
* {{type|function}}
* {{type|table}}
* {{type|Vector}} ({{type|Vector2}}, {{type|Vector3}}, {{type|Vector4}})
* {{type|Matrix}} ({{type|Matrix2}}, {{type|Matrix3}}, {{type|Matrix4}})
* {{type|Event}} (custom type that exists)
* {{type|CrashAPI}} (custom type that doesn't exist)
* {{type|Main Page|link=Event}} (links to [[Event]]) <code><nowiki>{{type|Main Page|link=Event}}</nowiki></code>
[[Template:Type/testcases|Testcases page.]]
<templatedata>
{
"params": {
"1": {
"label": "Type name",
"suggestedvalues": [
"nil",
"boolean",
"integer",
"number",
"string",
"function",
"table",
"Vector",
"Matrix"
],
"required": true,
"aliases": [
"name"
],
"description": "Type name ('table' etc.) Supports modifiers, like ? and [].",
"type": "string"
},
"2": {
"description": "Type modifiers (compatibility)",
"deprecated": "Attach modifiers directly to the type name."
},
"link": {
"label": "Custom link target",
"type": "wiki-page-name"
},
"text": {
"label": "Custom text",
"description": "If provided, this text will be displayed instead of the type name. The link and styling will still be determined by the type name.",
"type": "content"
}
},
"description": "Displays and links to types.",
"paramOrder": [
"1",
"link",
"text",
"2"
],
"format": "inline"
}
</templatedata></noinclude>

Colors

2024-10-24T16:17:58Z

TheKillerBunny: visibility

{| class="wikitable"
|-
! style="background-color: #5EA5FF;color: #000000;" | AWESOME_BLUE
| #5EA5FF
|-
! style="background-color: #99BBEE;color: #000000;" | SOFT_BLUE
| #99BBEE
|-
! style="background-color: #00F0FF;color: #000000;" | BLUE
| #00F0FF
|-
! style="background-color: #A672EF;color: #000000;" | PURPLE
| #A672EF
|-
! style="background-color: #FF2400;color: #000000;" | RED
| #FF2400
|-
! style="background-color: #FFC400;color: #000000;" | ORANGE
| #FFC400
|-
! style="background-color: #F8C53A;color: #000000;" | CHEESE
| #F8C53A
|-
! style="background-color: #5555FF;color: #000000;" | LUA_LOG
| #5555FF
|-
! style="background-color: #FF5555;color: #000000;" | LUA_ERROR
| #FF5555
|-
! style="background-color: #A155DA;color: #000000;" | LUA_PING
| #A155DA
|-
! style="background-color: #5AAAFF;color: #000000;" | DEFAULT
| #5AAAFF
|-
! style="background-color: #5865F2;color: #000000;" | DISCORD
| #5865F2
|-
! style="background-color: #27AAE0;color: #000000;" | KOFI
| #27AAE0
|-
! style="background-color: #FFFFFF;color: #000000;" | GITHUB
| #FFFFFF
|-
! style="background-color: #1BD96A;color: #000000;" | MODRINTH
| #1BD96A
|-
! style="background-color: #F16436;color: #000000;" | CURSEFORGE
| #F16436
|}

[[Category:Enums]]

Colors

2024-10-24T16:14:33Z

TheKillerBunny:

{| class="wikitable"
|-
! style="background-color: #5EA5FF;" | AWESOME_BLUE
| #5EA5FF
|-
! style="background-color: #99BBEE;" | SOFT_BLUE
| #99BBEE
|-
! style="background-color: #00F0FF;" | BLUE
| #00F0FF
|-
! style="background-color: #A672EF;" | PURPLE
| #A672EF
|-
! style="background-color: #FF2400;" | RED
| #FF2400
|-
! style="background-color: #FFC400;" | ORANGE
| #FFC400
|-
! style="background-color: #F8C53A;" | CHEESE
| #F8C53A
|-
! style="background-color: #5555FF;" | LUA_LOG
| #5555FF
|-
! style="background-color: #FF5555;" | LUA_ERROR
| #FF5555
|-
! style="background-color: #A155DA;" | LUA_PING
| #A155DA
|-
! style="background-color: #5AAAFF;" | DEFAULT
| #5AAAFF
|-
! style="background-color: #5865F2;" | DISCORD
| #5865F2
|-
! style="background-color: #27AAE0;" | KOFI
| #27AAE0
|-
! style="background-color: #FFFFFF;color: #000000;" | GITHUB
| #FFFFFF
|-
! style="background-color: #1BD96A;" | MODRINTH
| #1BD96A
|-
! style="background-color: #F16436;" | CURSEFORGE
| #F16436
|}

[[Category:Enums]]

ToJson

2024-10-16T18:29:15Z

TheKillerBunny: navbox

{| class="wikitable"
! Arguments
! Returns
|-
| Table: {{Type|table}}
| {{Type|string}}
|}

Serializes a table into a JSON string.<br />
See [[parseJson]]

== Navigation ==
{{Navbox documentation}}

ParseJson

2024-10-16T18:28:57Z

TheKillerBunny: navbox

{| class="wikitable"
! Arguments
! Returns
|-
| JSON: {{Type|string}}
| {{Type|table}}
|}

Deserializes a JSON string into a table.<br />
See [[toJson]]

== Navigation ==
{{Navbox documentation}}

ParseJson

2024-10-16T18:27:43Z

TheKillerBunny: Created page with "{| class="wikitable" ! Arguments ! Returns |- | JSON: {{Type|string}} | {{Type|table}} |} Deserializes a JSON string into a table.<br /> See toJson"

{| class="wikitable"
! Arguments
! Returns
|-
| JSON: {{Type|string}}
| {{Type|table}}
|}

Deserializes a JSON string into a table.<br />
See [[toJson]]

ToJson

2024-10-16T18:26:33Z

TheKillerBunny:

{| class="wikitable"
! Arguments
! Returns
|-
| Table: {{Type|table}}
| {{Type|string}}
|}

Serializes a table into a JSON string.<br />
See [[parseJson]]

ToJson

2024-10-16T18:26:18Z

TheKillerBunny:

{| class="wikitable"
! Arguments
! Returns
|-
| Table: {{Type|table}}
| {{Type|string}}
|}

Serializes a table into a JSON string
See [[parseJson]]

ToJson

2024-10-16T18:26:00Z

TheKillerBunny: Created page with "{| class="wikitable" ! Arguments ! Returns |- | Table: {{Type|table}} | {{Type|string}} |} Serializes a table into a JSON string"

{| class="wikitable"
! Arguments
! Returns
|-
| Table: {{Type|table}}
| {{Type|string}}
|}

Serializes a table into a JSON string

User:TheKillerBunny/Signature

2024-10-13T21:57:01Z

TheKillerBunny:

User:TheKillerBunny/Signature

2024-10-13T15:50:05Z

TheKillerBunny:

<hr />
<div style="margin-left: inherit;">
{{User:TheKillerBunny/Signature/Image|[[File:TKBunny-OpticalMediaIsPeak.svg|150px]]|Optical Media Is Peak}}

{{User:TheKillerBunny/Signature/Image|[[File:TheKillerBunny-Avatar.svg.svg|150px]]|TheKillerBunny}}

-- @[[User:TheKillerBunny|TheKillerBunny]] ([[User_talk:TheKillerBunny|talk]]|[[Special:Contributions/TheKillerBunny|contribs]])
</div>

User:TheKillerBunny/Signature

2024-10-13T15:49:13Z

TheKillerBunny:

<hr />
{{User:TheKillerBunny/Signature/Image|[[File:TKBunny-OpticalMediaIsPeak.svg|150px]]|Optical Media Is Peak}}

{{User:TheKillerBunny/Signature/Image|[[File:TheKillerBunny-Avatar.svg.svg|150px]]|TheKillerBunny}}

-- @[[User:TheKillerBunny|TheKillerBunny]] ([[User_talk:TheKillerBunny|talk]]|[[Special:Contributions/TheKillerBunny|contribs]])

User:TheKillerBunny/Signature

2024-10-13T15:48:26Z

TheKillerBunny:

{{User:TheKillerBunny/Signature/Image|[[File:TKBunny-OpticalMediaIsPeak.svg|150px]]|Optical Media Is Peak}}

{{User:TheKillerBunny/Signature/Image|[[File:TheKillerBunny-Avatar.svg.svg|150px]]|TheKillerBunny}}

-- @[[User:TheKillerBunny|TheKillerBunny]] ([[User_talk:TheKillerBunny|talk]]|[[Special:Contributions/TheKillerBunny|contribs]])

User:TheKillerBunny/Signature/Image

2024-10-13T15:45:55Z

TheKillerBunny: Undo revision 605 by TheKillerBunny (talk)

User:TheKillerBunny/Signature/Image

2024-10-13T15:44:46Z

TheKillerBunny: test

User:TheKillerBunny/Signature

2024-10-13T15:38:04Z

TheKillerBunny:

User:TheKillerBunny/Signature/Image

2024-10-13T15:36:52Z

TheKillerBunny: Created page with "<div style="display:inline-block;margin-top:6px;background:#f8f9fa;border:2px solid #777777;padding:0;"> {{{1}}} <hr style="background-color: black;" /> <p style="text-align:center;margin:0;padding:0;"> {{{2}}} </p> </div>"

User:TheKillerBunny/Signature

2024-10-13T15:35:01Z

TheKillerBunny: test

<hr />

.tkbunny-image {
display: inline-block;
margin-top: 6px;
width: 150px;
background: #f8f9fa;
border: 2px solid #777777;
padding: 0;
}
.tkbunny-image p {
text-align: center;
margin: 0;
padding: 0;
}
.tkbunny-image hr {
background-color: black;
}

<div style="display:inline-block;margin-top:6px;width:150px;background:#f8f9fa;border:2px solid #777777;padding:0;">
[[File:TKBunny-OpticalMediaIsPeak.svg|150px]]
<hr style="background-color: black;" />
<p style="text-align:center;margin:0;padding:0;">
Optical Media is Peak
</p>
</div>

<div style="display:inline-block;margin-top:6px;width:150px;background:#f8f9fa;border:2px solid #777777;padding:0;">
[[File:TheKillerBunny-Avatar.svg.svg|150px]]
<hr style="background-color: black;" />
<p style="text-align:center;margin:0;padding:0;">
TheKillerBunny
</p>
</div>
-- @[[User:TheKillerBunny|TheKillerBunny]] ([[User_talk:TheKillerBunny|talk]]|[[Special:Contributions/TheKillerBunny|contribs]])

User:TheKillerBunny/Signature/style.css

2024-10-13T15:26:17Z

TheKillerBunny:

.tkbunny-image {
display: inline-block;
margin-top: 6px;
width: 150px;
background: #f8f9fa;
border: 2px solid #777777;
padding: 0;
}
.tkbunny-image p {
text-align: center;
margin: 0;
padding: 0;
}
.tkbunny-image hr {
background-color: black;
}

User:TheKillerBunny/Signature

2024-10-13T15:25:55Z

TheKillerBunny:

<hr />
<templateStyles src="User:TheKillerBunny/Signature/style.css" />
<div class="tkbunny-image">
[[File:TKBunny-OpticalMediaIsPeak.svg|150px]]
<hr />
<p>
Optical Media is Peak
</p>
</div>

<div class="tkbunny-image">
[[File:TheKillerBunny-Avatar.svg.svg|150px]]
<hr />
<p>
TheKillerBunny
</p>
</div>
-- @[[User:TheKillerBunny|TheKillerBunny]] ([[User_talk:TheKillerBunny|talk]]|[[Special:Contributions/TheKillerBunny|contribs]])

User:TheKillerBunny/Signature

2024-10-13T15:24:58Z

TheKillerBunny: more testing

-- @[[User:TheKillerBunny|TheKillerBunny]] ([[User_talk:TheKillerBunny|talk]]|[[Special:Contributions/TheKillerBunny|contribs]])

User:TheKillerBunny/Signature

2024-10-13T15:24:18Z

TheKillerBunny: testing something

<hr />
<div class="image">
[[File:TKBunny-OpticalMediaIsPeak.svg|150px]]
<hr />
<p>
Optical Media is Peak
</p>
</div>

<div class="image">
[[File:TheKillerBunny-Avatar.svg.svg|150px]]
<hr />
<p>
TheKillerBunny
</p>
</div>
-- @[[User:TheKillerBunny|TheKillerBunny]] ([[User_talk:TheKillerBunny|talk]]|[[Special:Contributions/TheKillerBunny|contribs]])

User talk:TheKillerBunny

2024-10-13T15:23:10Z

TheKillerBunny: /* Testing something */ new section

This is a talk page I think

== Subject ==

Description
'''Bold Text'''

ooh cool you can "mention" users @[[User:TheKillerBunny|TheKillerBunny]]

making a custom signature here:

----Optical Media Is Peak<br>-@[[User:TheKillerBunny|TheKillerBunny]]

[[User:TheKillerBunny|Bunny]] ([[User talk:TheKillerBunny|talk]]) 17:01, 12 October 2024 (UTC)

:Ok I set my signature
:<br /><hr />Optical Media Is Peak<br />-@[[User:TheKillerBunny|TheKillerBunny]] 17:04, 12 October 2024 (UTC)
::Oh cool you can. I hit the limit so i'm done for now
::<hr /><div style="margin-top:6px;width:150px;background-color:white;border:2px solid black;">[[File:TKBunny-OpticalMediaIsPeak.svg|150px]]<hr /><center><p style="margin:-3px">Optical Media Is Peak</p></center></div>-@[[User:TheKillerBunny|TheKillerBunny]] 17:27, 12 October 2024 (UTC)
:::Ok I lied and changed up some colors
:::<hr /><div style="margin-top:6px;width:150px;background:#f8f9fa;border:2px solid #777;">[[File:TKBunny-OpticalMediaIsPeak.svg|150px]]<hr /><center><p style="margin:-3px">Optical Media Is Peak</p></center></div>-@[[User:TheKillerBunny|TheKillerBunny]] 17:32, 12 October 2024 (UTC)
::::ok final update im doing cool shit with my signature {{User:TheKillerBunny/Signature}} 18:43, 12 October 2024 (UTC)

== Testing something ==

Theoretically this should be working {{User:TheKillerBunny/Signature}} 15:23, 13 October 2024 (UTC)

User:TheKillerBunny/Signature

2024-10-12T18:45:14Z

TheKillerBunny:

<hr />
<templateStyles src="User:TheKillerBunny/Signature/style.css" />
<div class="image">
[[File:TKBunny-OpticalMediaIsPeak.svg|150px]]
<hr />
<p>
Optical Media is Peak
</p>
</div>

<div class="image">
[[File:TheKillerBunny-Avatar.svg.svg|150px]]
<hr />
<p>
TheKillerBunny
</p>
</div>
-- @[[User:TheKillerBunny|TheKillerBunny]] ([[User_talk:TheKillerBunny|talk]]|[[Special:Contributions/TheKillerBunny|contribs]])

User:TheKillerBunny/Signature

2024-10-12T18:44:16Z

TheKillerBunny:

----
<templateStyles src="User:TheKillerBunny/Signature/style.css" /><div>
<div class="image">
[[File:TKBunny-OpticalMediaIsPeak.svg|150px]]
----
<p>
Optical Media is Peak
</p>
</div>

<div class="image">
[[File:TheKillerBunny-Avatar.svg.svg|150px]]
----
<p>
TheKillerBunny
</p>
</div>
</div>
-- @[[User:TheKillerBunny|TheKillerBunny]] ([[User_talk:TheKillerBunny|talk]]|[[Special:Contributions/TheKillerBunny|contribs]])

User talk:TheKillerBunny

2024-10-12T18:43:36Z

TheKillerBunny: /* Subject */ Reply

User:TheKillerBunny/Signature

2024-10-12T18:43:09Z

TheKillerBunny:

----
<templateStyles src="User:TheKillerBunny/Signature/style.css" />
<div class="image">
[[File:TKBunny-OpticalMediaIsPeak.svg|150px]]
----
<p>
Optical Media is Peak
</p>
</div>

<div class="image">
[[File:TheKillerBunny-Avatar.svg.svg|150px]]
----
<p>
TheKillerBunny
</p>
</div>

-- @[[User:TheKillerBunny|TheKillerBunny]] ([[User_talk:TheKillerBunny|talk]]|[[Special:Contributions/TheKillerBunny|contribs]])

User:TheKillerBunny/Signature/style.css

2024-10-12T18:41:09Z

TheKillerBunny:

.image {
display: inline-block;
margin-top: 6px;
width: 150px;
background: #f8f9fa;
border: 2px solid #777777;
padding: 0;
}
.image p {
text-align: center;
margin: 0;
padding: 0;
}
.image hr {
background-color: black;
}

User:TheKillerBunny/Signature/style.css

2024-10-12T18:40:17Z

TheKillerBunny:

User:TheKillerBunny/Signature/style.css

2024-10-12T18:37:18Z

TheKillerBunny: TheKillerBunny changed the content model of the page User:TheKillerBunny/Signature/style.css from "CSS" to "Sanitized CSS": templateStyles

.image {
display: inline-block;
margin-top: 6px;
width: 150px;
background: #f8f9fa;
border: 2px solid #777777;
padding: 0;
}
.image p {
text-align: center;
margin: 0;
padding: 0;
}

User:TheKillerBunny/Signature/style.css

2024-10-12T18:33:18Z

TheKillerBunny: Created page with ".image { display: inline-block; margin-top: 6px; width: 150px; background: #f8f9fa; border: 2px solid #777777; padding: 0; } .image p { text-align: center; margin: 0; padding: 0; }"

.image {
display: inline-block;
margin-top: 6px;
width: 150px;
background: #f8f9fa;
border: 2px solid #777777;
padding: 0;
}
.image p {
text-align: center;
margin: 0;
padding: 0;
}

User:TheKillerBunny/Signature

2024-10-12T18:07:47Z

TheKillerBunny: Created page with "<hr /><div style="margin-top:6px;width:150px;background:#f8f9fa;border:2px solid #777;">150px<hr /><center><p style="margin:-3px">Optical Media Is Peak</p></center></div>-@TheKillerBunny"

<hr /><div style="margin-top:6px;width:150px;background:#f8f9fa;border:2px solid #777;">[[File:TKBunny-OpticalMediaIsPeak.svg|150px]]<hr /><center><p style="margin:-3px">Optical Media Is Peak</p></center></div>-@[[User:TheKillerBunny|TheKillerBunny]]

User:TheKillerBunny/SignatureEmbed

2024-10-12T18:06:41Z

TheKillerBunny: Created page with "{{User:TheKillerBunny/Signature}}"

User talk:TheKillerBunny

2024-10-12T17:32:16Z

TheKillerBunny: /* Subject */ Reply

User talk:TheKillerBunny

2024-10-12T17:27:01Z

TheKillerBunny: /* Subject */ Reply

User talk:TheKillerBunny

2024-10-12T17:04:13Z

TheKillerBunny: /* Subject */ Reply

User talk:TheKillerBunny

2024-10-12T17:01:03Z

TheKillerBunny: /* Subject */ new section