https://wiki.figuramc.org/api.php?action=feedcontributions&feedformat=atom&user=PenguinEncounter
FiguraMC - User contributions [en]
2026-05-29T17:04:22Z
User contributions
MediaWiki 1.42.1
https://wiki.figuramc.org/index.php?title=Main_Page&diff=903
Main Page
2026-04-07T19:14:49Z
<p>PenguinEncounter: </p>
<hr />
<div>{{Notice/Warning<br />
|content=<br />
<div style="font-size: 1.5em; font-weight: bold; margin: 0.5em 0 0 0;">This wiki has been replaced by [https://docs.figuramc.org docs.figuramc.org].</div><br />
Please use the documentation available there.<br />
}}<br />
<br />
<div style="min-height: min(50svh, 20em);"></div></div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=Main_Page&diff=902
Main Page
2026-04-07T19:13:08Z
<p>PenguinEncounter: Remove navbox, move link to big text</p>
<hr />
<div>{{Notice/Warning<br />
|content=<br />
<div style="font-size: 1.5em; font-weight: bold; margin: 0.5em 0 0 0;">This wiki has been replaced by [https://docs.figuramc.org docs.figuramc.org].</div><br />
Please use the documentation available there.<br />
}}</div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=Multiplayer_Avatar_Interaction&diff=900
Multiplayer Avatar Interaction
2025-04-14T05:12:23Z
<p>PenguinEncounter: a bit of style cleanup</p>
<hr />
<div>Avatars can share values with one another to allow for interactions between them. An example of this would be the various petting scripts you can find in the community.<br />
<br />
The basic principle works like this:<br />
One avatar can store a value.<br />
Another avatar can get this stored value and do something based on it.<br />
<br />
To store a value that other avatars can read you use avatar:store(key, value)<br />
<br />
For example<br />
<syntaxhighlight lang="lua"><br />
avatar:store("amount", 1)<br />
</syntaxhighlight><br />
<br />
Note: It is recommended to never store any UserData objects as this could lead to security issues! Best to only store primitives like numbers, strings, or regular tables!<br />
<br />
Someone else can then read this value in their script by checking the avatarVars for each player.<br />
<br />
<syntaxhighlight lang="lua"><br />
for uuid, vars in pairs(world.avatarVars()) do<br />
print(uuid)<br />
printTable(vars)<br />
end<br />
</syntaxhighlight><br />
<br />
So for our example you could read the "amount" which we set to 1 and show the player name as well:<br />
<br />
<syntaxhighlight lang="lua"><br />
for uuid, vars in pairs(world.avatarVars()) do<br />
if vars["amount"] then<br />
local playerName = uuid<br />
for name, plr in pairs(world.getPlayers()) do<br />
if plr:getUUID() == uuid then<br />
playerName = name<br />
end<br />
end<br />
print(playerName, "has amount of", vars[key])<br />
end<br />
end<br />
</syntaxhighlight></div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=ModelPart_Indexing&diff=899
ModelPart Indexing
2025-04-12T23:58:46Z
<p>PenguinEncounter: how did i miss that what</p>
<hr />
<div><noinclude>{{Hatnote|For technical documentation on ModelParts, see [[ModelPart]].}}</noinclude><br />
<br />
When Figura loads your avatar, all the model files in your avatar are organized into a tree. The starting point of this tree is called <code>models</code>. All of the parts of your model, including cubes, meshes, and groups from your Blockbench models, as well as folders in your avatar and the model files themselves are converted to ModelParts and part of this tree.<br />
<br />
The name <code>models</code> does not refer to any specific model file in your avatar. Instead, model files are created as children of the <code>models</code> folder. '''If your Blockbench model is inside a subfolder of your avatar''', that folder becomes a child of <code>models</code>, and the model file becomes a child of the subfolder.<br />
<br />
{{tree|icon=BBModel.png|content=<code>model.bbmodel</code>|inner=<br />
{{tree|icon=BBGroup.png|content=root|inner=<br />
{{tree|icon=BBGroup.png|content=Head|inner=<br />
{{tree|icon=BBCube.png|content=Head}}<br />
{{tree|icon=BBCube.png|content=HeadLayer}}<br />
}}<br />
{{tree|icon=BBGroup.png|content=RightArm|inner=<br />
{{tree|icon=BBCube.png|content=RightArm}}<br />
{{tree|icon=BBCube.png|content=RightArmLayer}}<br />
}}<br />
{{tree|icon=BBCube.png|content=Cool Name}}<br />
{{tree|icon=BBGroup.png|content=Cool Group|inner=<br />
{{tree|icon=BBCube.png|content=cube}}<br />
}}<br />
}}<br />
}}<br />
<br />
To access a child part, ''index'' the parent part with the name of the child part.<br />
<br />
There are two ways to ''index'' something in Lua. The first way is by using dots:<br />
<br />
<div style="padding: 4px 6px; border-radius: 6px; border: 3px solid var(--color-success); width: fit-content; margin-top: 6px;"><code>models.model.root.Head</code></div><br />
<br />
This code sample first gets the <code>model</code> part (a file named <code>model.bbmodel</code>) and then the <code>Head</code> group inside it. The name of the cube, mesh, group, folder, or file needs to be within the quotes. To access deeper parts (for example, a <code>HeadLayer</code> cube within the <code>Head</code> group), add more dots and names:<br />
<br />
<div style="padding: 4px 6px; border-radius: 6px; border: 3px solid var(--color-success); width: fit-content; margin-top: 6px;"><code>models.model.root.Head.HeadLayer</code></div><br />
<br />
The second way to index is longer, and uses square brackets and quotes (<code>[""]</code>) to separate the names. '''This method is required if the name of a part contains characters that aren't letters, numbers, or underscores'''; this includes ''names with spaces'', like <code>Right Arm</code>.<br />
<br />
When using brackets to index, place the name '''between the quotes''', and '''don't include a period before it''':<br />
* <div style="padding: 3px 4px; border-radius: 4px; border: 2px solid var(--color-success); width: fit-content; margin-top: 6px;"><code>models["model"]["root"]["Cool Name"]</code> ✓ Correct</div><br />
* <div style="padding: 3px 4px; border-radius: 4px; border: 2px solid var(--color-success); width: fit-content; margin-top: 6px;"><code>models.model.root["Cool Name"]</code> ✓ Correct - both brackets and dots can be mixed together!</div><br />
* <div style="padding: 3px 4px; border-radius: 4px; border: 2px solid var(--color-destructive); width: fit-content; margin-top: 6px;"><code>models.model.root.["Cool Name"]</code> ✗ Incorrect: '''don't put a dot <code>.</code> before the bracket <code>[</code>.'''</div><br />
* <div style="padding: 3px 4px; border-radius: 4px; border: 2px solid var(--color-destructive); width: fit-content; margin-top: 6px;"><code>models.model.root[Cool Name]</code> ✗ Incorrect: '''name in brackets is missing a set of quotes'''</div><br />
<br />
To return to using dots for indexing after using brackets, place the dot after the closing bracket:<br />
* <div style="padding: 3px 4px; border-radius: 4px; border: 2px solid var(--color-success); width: fit-content; margin-top: 6px;"><code>models.model.root["Cool Group"].cube</code> ✓ Correct</div><br />
* <div style="padding: 3px 4px; border-radius: 4px; border: 2px solid var(--color-destructive); width: fit-content; margin-top: 6px;"><code>models.model.root["Cool Group"]cube</code> ✗ Incorrect: '''missing dot <code>.</code> after bracket'''<div><br />
<br />
=== A note on model files in folders ===<br />
<br />
If your Blockbench model file is within a folder in your avatar, the ''folder'' will become a part of the ModelPart tree. That means that if a model file named <code>player.bbmodel</code> is located in a folder named <code>models</code>, the model file has to be accessed with <code>models.models.player</code> (or <code>models["models"]["player"]</code>.)<br />
<br />
{{Notice|content=<br />
If you later want to use animations from a model, folders affect the indexing into the <code>animations</code> table too - but the system is a little different.<br />
<br />
Instead of indexing the folder and then the file, ''combine each folder name and the file name with a period <code>.</code> and index with the combined name'', even if the names of the folders and files contain special characters. For example, to get the animations from the <code>model 2.bbmodel</code> file in the <code>main models</code> folder:<br />
<br />
{{tree|icon=FSFolderClosed.png|content=<code>main models</code>|inner=<br />
{{tree|icon=BBModel.png|content=<code>model 2.bbmodel</code>}}<br />
}}<br />
<br />
<syntaxhighlight lang="lua"><br />
animations["main models.model 2"]<br />
</syntaxhighlight><br />
}}</div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=Module:Signatures/Signatures.css&diff=898
Module:Signatures/Signatures.css
2025-03-31T03:57:45Z
<p>PenguinEncounter: </p>
<hr />
<div>/** DARK MODE **/<br />
@media screen and (prefers-color-scheme: dark) {<br />
html.skin-theme-clientpref-os .lua-type-explicit > a {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-os .lua-type-explicit > a::before {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-os .lua-type-recolor-border {<br />
border: 1px solid #404040 !important;<br />
}<br />
html.skin-theme-clientpref-os .lua-type-recolor-bar {<br />
background-color: #b0b0b0 !important;<br />
}<br />
}<br />
<br />
html.skin-theme-clientpref-night .lua-type-explicit > a {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-night .lua-type-explicit > a::before {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-night .lua-type-recolor-border {<br />
border: 1px solid #404040 !important;<br />
}<br />
html.skin-theme-clientpref-night .lua-type-recolor-bar {<br />
background-color: #b0b0b0 !important;<br />
}<br />
<br />
/** TYPES **/<br />
.lua-type-union {<br />
display: inline-flex;<br />
flex-flow: row nowrap;<br />
padding: 1px 1px;<br />
gap: 3px;<br />
border-radius: 4px;<br />
border: 1px solid #b0b0b0;<br />
}<br />
.lua-type-union > .lua-type-union-bar {<br />
display: block;<br />
width: 1px;<br />
margin: 3px 0;<br />
align-self: stretch;<br />
background-color: #404040;<br />
}<br />
<br />
.lua-type-explicit {<br />
font-family: 'Roboto Mono','Menlo','Consolas','Liberation Mono','Fira Code','Courier New',monospace;<br />
display: contents; /* flatten 'a' as flex element */<br />
}<br />
.lua-type-explicit > .external.external::after {<br />
display: none;<br />
}<br />
.lua-type-explicit > a {<br />
border-radius: 4px;<br />
border: 1px solid #b0b0b0;<br />
color: #000000;<br />
text-decoration: none;<br />
padding: 0 4px;<br />
<br />
display: flex;<br />
flex-flow: row nowrap;<br />
}<br />
.lua-type-explicit > .external.external:hover {<br />
color: #000000;<br />
text-decoration: underline;<br />
}<br />
.lua-type-explicit > a:visited {<br />
color: #000000;<br />
}<br />
<br />
/** TYPE COLORS **/<br />
<br />
.lua-type-explicit.-lua-typedef a::before {<br />
content: "";<br />
width: 2px;<br />
margin: 4px 0;<br />
margin-right: 4px;<br />
display: inline-block;<br />
align-self: stretch;<br />
background-color: #c891ff;<br />
}<br />
<br />
.lua-type-explicit[data-name="nil"] a {<br />
background-color: #ffffff;<br />
border: 1px solid #808080;<br />
}<br />
.lua-type-explicit[data-name="any"] a {<br />
background-color: #ffffff;<br />
border: 1px dotted #808080;<br />
}<br />
.lua-type-explicit[data-name="table"] a {<br />
background-color: #ffffdd;<br />
}<br />
.lua-type-explicit[data-name="function"] a {<br />
background-color: #eeddff;<br />
}<br />
.lua-type-explicit[data-name="string"] a {<br />
background-color: #ddffdd;<br />
}<br />
.lua-type-explicit[data-name="boolean"] a {<br />
background-color: #ffddff;<br />
}<br />
.lua-type-explicit[data-name="number"] a, .lua-type-explicit[data-name="integer"] {<br />
background-color: #ddddff;<br />
}<br />
.lua-type-explicit[data-name^="Vector"] a {<br />
background-color: #ffeedd;<br />
}<br />
.lua-type-explicit[data-name^="Matrix"] a {<br />
background-color: #ffddee;<br />
}</div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=Module:Signatures/Signatures.css&diff=897
Module:Signatures/Signatures.css
2025-03-31T03:54:29Z
<p>PenguinEncounter: </p>
<hr />
<div>/** DARK MODE **/<br />
@media screen and (prefers-color-scheme: dark) {<br />
html.skin-theme-clientpref-os .lua-type-explicit > a {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-os .lua-type-explicit > a::before {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-os .lua-type-recolor-border {<br />
border: 1px solid #404040 !important;<br />
}<br />
html.skin-theme-clientpref-os .lua-type-recolor-bar {<br />
background-color: #b0b0b0 !important;<br />
}<br />
}<br />
<br />
html.skin-theme-clientpref-night .lua-type-explicit > a {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-night .lua-type-explicit > a::before {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-night .lua-type-recolor-border {<br />
border: 1px solid #404040 !important;<br />
}<br />
html.skin-theme-clientpref-night .lua-type-recolor-bar {<br />
background-color: #b0b0b0 !important;<br />
}<br />
<br />
/** TYPES **/<br />
.lua-type-union {<br />
display: inline-flex;<br />
flex-flow: row nowrap;<br />
padding: 1px 1px;<br />
gap: 3px;<br />
border-radius: 4px;<br />
border: 1px solid #b0b0b0;<br />
}<br />
.lua-type-union > .lua-type-union-bar {<br />
display: block;<br />
width: 1px;<br />
margin: 3px 0;<br />
align-self: stretch;<br />
background-color: #404040;<br />
}<br />
<br />
.lua-type-explicit {<br />
font-family: monospace;<br />
display: contents; /* flatten 'a' as flex element */<br />
}<br />
.lua-type-explicit > .external.external::after {<br />
display: none;<br />
}<br />
.lua-type-explicit > a {<br />
border-radius: 4px;<br />
border: 1px solid #b0b0b0;<br />
color: #000000;<br />
text-decoration: none;<br />
padding: 0 4px;<br />
<br />
display: flex;<br />
flex-flow: row nowrap;<br />
}<br />
.lua-type-explicit > .external.external:hover {<br />
color: #000000;<br />
text-decoration: underline;<br />
}<br />
.lua-type-explicit > a:visited {<br />
color: #000000;<br />
}<br />
<br />
/** TYPE COLORS **/<br />
<br />
.lua-type-explicit.-lua-typedef a::before {<br />
content: "";<br />
width: 2px;<br />
margin: 4px 0;<br />
margin-right: 4px;<br />
display: inline-block;<br />
align-self: stretch;<br />
background-color: #c891ff;<br />
}<br />
<br />
.lua-type-explicit[data-name="nil"] a {<br />
background-color: #ffffff;<br />
border: 1px solid #808080;<br />
}<br />
.lua-type-explicit[data-name="any"] a {<br />
background-color: #ffffff;<br />
border: 1px dotted #808080;<br />
}<br />
.lua-type-explicit[data-name="table"] a {<br />
background-color: #ffffdd;<br />
}<br />
.lua-type-explicit[data-name="function"] a {<br />
background-color: #eeddff;<br />
}<br />
.lua-type-explicit[data-name="string"] a {<br />
background-color: #ddffdd;<br />
}<br />
.lua-type-explicit[data-name="boolean"] a {<br />
background-color: #ffddff;<br />
}<br />
.lua-type-explicit[data-name="number"] a, .lua-type-explicit[data-name="integer"] {<br />
background-color: #ddddff;<br />
}<br />
.lua-type-explicit[data-name^="Vector"] a {<br />
background-color: #ffeedd;<br />
}<br />
.lua-type-explicit[data-name^="Matrix"] a {<br />
background-color: #ffddee;<br />
}</div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=Module:Signatures/Signatures.css&diff=896
Module:Signatures/Signatures.css
2025-03-31T03:53:33Z
<p>PenguinEncounter: </p>
<hr />
<div>/** DARK MODE **/<br />
@media screen and (prefers-color-scheme: dark) {<br />
html.skin-theme-clientpref-os .lua-type-explicit > a {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-os .lua-type-explicit > a::before {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-os .lua-type-recolor-border {<br />
border: 1px solid #404040 !important;<br />
}<br />
html.skin-theme-clientpref-os .lua-type-recolor-bar {<br />
background-color: #b0b0b0 !important;<br />
}<br />
}<br />
<br />
html.skin-theme-clientpref-night .lua-type-explicit > a {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-night .lua-type-explicit > a::before {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-night .lua-type-recolor-border {<br />
border: 1px solid #404040 !important;<br />
}<br />
html.skin-theme-clientpref-night .lua-type-recolor-bar {<br />
background-color: #b0b0b0 !important;<br />
}<br />
<br />
/** TYPES **/<br />
.lua-type-union {<br />
display: inline-flex;<br />
flex-flow: row nowrap;<br />
padding: 1px 1px;<br />
gap: 3px;<br />
border-radius: 4px;<br />
border: 1px solid #b0b0b0;<br />
}<br />
.lua-type-union > .lua-type-union-bar {<br />
display: block;<br />
width: 1px;<br />
margin: 3px 0;<br />
align-self: stretch;<br />
background-color: #404040;<br />
}<br />
<br />
.lua-type-explicit {<br />
font-family: monospace;<br />
display: contents; /* flatten 'a' as flex element */<br />
}<br />
.lua-type-explicit > .external.external::after {<br />
display: none;<br />
}<br />
.lua-type-explicit > a {<br />
border-radius: 4px;<br />
border: 1px solid #b0b0b0;<br />
color: #000000;<br />
text-decoration: none;<br />
padding: 0 4px;<br />
}<br />
.lua-type-explicit > .external.external:hover {<br />
color: #000000;<br />
text-decoration: underline;<br />
}<br />
.lua-type-explicit > a:visited {<br />
color: #000000;<br />
}<br />
<br />
/** TYPE COLORS **/<br />
<br />
.lua-type-explicit.-lua-typedef a::before {<br />
content: "";<br />
width: 2px;<br />
height: 100%;<br />
display: inline-block;<br />
background-color: #c891ff;<br />
margin-right: 4px;<br />
}<br />
<br />
.lua-type-explicit[data-name="nil"] a {<br />
background-color: #ffffff;<br />
border: 1px solid #808080;<br />
}<br />
.lua-type-explicit[data-name="any"] a {<br />
background-color: #ffffff;<br />
border: 1px dotted #808080;<br />
}<br />
.lua-type-explicit[data-name="table"] a {<br />
background-color: #ffffdd;<br />
}<br />
.lua-type-explicit[data-name="function"] a {<br />
background-color: #eeddff;<br />
}<br />
.lua-type-explicit[data-name="string"] a {<br />
background-color: #ddffdd;<br />
}<br />
.lua-type-explicit[data-name="boolean"] a {<br />
background-color: #ffddff;<br />
}<br />
.lua-type-explicit[data-name="number"] a, .lua-type-explicit[data-name="integer"] {<br />
background-color: #ddddff;<br />
}<br />
.lua-type-explicit[data-name^="Vector"] a {<br />
background-color: #ffeedd;<br />
}<br />
.lua-type-explicit[data-name^="Matrix"] a {<br />
background-color: #ffddee;<br />
}</div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=Module:Signatures/Signatures.css&diff=895
Module:Signatures/Signatures.css
2025-03-31T03:52:14Z
<p>PenguinEncounter: </p>
<hr />
<div>/** DARK MODE **/<br />
@media screen and (prefers-color-scheme: dark) {<br />
html.skin-theme-clientpref-os .lua-type-explicit > a {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-os .lua-type-explicit > a::after {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-os .lua-type-recolor-border {<br />
border: 1px solid #404040 !important;<br />
}<br />
html.skin-theme-clientpref-os .lua-type-recolor-bar {<br />
background-color: #b0b0b0 !important;<br />
}<br />
}<br />
<br />
html.skin-theme-clientpref-night .lua-type-explicit > a {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-night .lua-type-explicit > a::after {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-night .lua-type-recolor-border {<br />
border: 1px solid #404040 !important;<br />
}<br />
html.skin-theme-clientpref-night .lua-type-recolor-bar {<br />
background-color: #b0b0b0 !important;<br />
}<br />
<br />
/** TYPES **/<br />
.lua-type-union {<br />
display: inline-flex;<br />
flex-flow: row nowrap;<br />
padding: 1px 1px;<br />
gap: 3px;<br />
border-radius: 4px;<br />
border: 1px solid #b0b0b0;<br />
}<br />
.lua-type-union > .lua-type-union-bar {<br />
display: block;<br />
width: 1px;<br />
margin: 3px 0;<br />
align-self: stretch;<br />
background-color: #404040;<br />
}<br />
<br />
.lua-type-explicit {<br />
font-family: monospace;<br />
display: contents; /* flatten 'a' as flex element */<br />
}<br />
.lua-type-explicit > .external.external::after {<br />
display: none;<br />
}<br />
.lua-type-explicit > a {<br />
border-radius: 4px;<br />
border: 1px solid #b0b0b0;<br />
color: #000000;<br />
text-decoration: none;<br />
padding: 0 4px;<br />
}<br />
.lua-type-explicit > .external.external:hover {<br />
color: #000000;<br />
text-decoration: underline;<br />
}<br />
.lua-type-explicit > a:visited {<br />
color: #000000;<br />
}<br />
<br />
/** TYPE COLORS **/<br />
<br />
.lua-type-explicit.-lua-typedef a::after {<br />
content: "func";<br />
font-size: 0.3em;<br />
padding: 0 4px;<br />
display: inline-block;<br />
border: 2px solid #c891ff;<br />
border-radius: 4px;<br />
margin-left: 4px;<br />
}<br />
<br />
.lua-type-explicit[data-name="nil"] a {<br />
background-color: #ffffff;<br />
border: 1px solid #808080;<br />
}<br />
.lua-type-explicit[data-name="any"] a {<br />
background-color: #ffffff;<br />
border: 1px dotted #808080;<br />
}<br />
.lua-type-explicit[data-name="table"] a {<br />
background-color: #ffffdd;<br />
}<br />
.lua-type-explicit[data-name="function"] a {<br />
background-color: #eeddff;<br />
}<br />
.lua-type-explicit[data-name="string"] a {<br />
background-color: #ddffdd;<br />
}<br />
.lua-type-explicit[data-name="boolean"] a {<br />
background-color: #ffddff;<br />
}<br />
.lua-type-explicit[data-name="number"] a, .lua-type-explicit[data-name="integer"] {<br />
background-color: #ddddff;<br />
}<br />
.lua-type-explicit[data-name^="Vector"] a {<br />
background-color: #ffeedd;<br />
}<br />
.lua-type-explicit[data-name^="Matrix"] a {<br />
background-color: #ffddee;<br />
}</div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=Module:Signatures&diff=894
Module:Signatures
2025-03-31T03:50:59Z
<p>PenguinEncounter: </p>
<hr />
<div>-- a MediaWiki module<br />
<br />
--[[<br />
Syntax description:<br />
<name> <attr...> ...;;<br />
<modName> [modSyn];;<br />
]]<br />
<br />
---@alias docs.ModelKind "field" | "method" | "type"<br />
<br />
---Origin of this documentation item.<br />
---@alias docs.ModelOrigin<br />
---| "Lua" Lua 5.2 built-in types and APIs.<br />
---| "Figura" Figura types and APIs. Usually the default.<br />
---| "abstract" Describes ideas, but no concrete implementation exists.<br />
---| "typedef" Custom on-the-spot types, like function protocols or array types.<br />
<br />
---@alias Set<T> {[T]: true}<br />
<br />
---@class docs.DocModel<br />
---@field kind docs.ModelKind<br />
---@field name string?<br />
---@field prefixHint string?<br />
---@field attributes Set<string><br />
---@field origin docs.ModelOrigin<br />
<br />
---@class docs.FieldModel : docs.DocModel<br />
---@field kind "field"<br />
---@field canRead boolean<br />
---@field canWrite boolean<br />
---@field readType docs.TypeModel?<br />
---@field writeType docs.TypeModel?<br />
<br />
---@class docs.MethodModel : docs.DocModel<br />
---@field kind "method"<br />
---@field signatures docs.MethodSignature[]<br />
---@field isStatic boolean<br />
<br />
---@class docs.MethodSignature.Parameter<br />
---@field name string<br />
---@field type docs.TypeModel<br />
---@field vararg boolean?<br />
<br />
---@class docs.MethodSignature<br />
---@field returns docs.TypeModel[]<br />
---@field parameters docs.MethodSignature.Parameter[]<br />
<br />
---@class docs.TypeModel : docs.DocModel<br />
---@field kind "type"<br />
---@field typeKind "explicit" | "union"<br />
<br />
---@class docs.ExplicitType : docs.TypeModel<br />
---@field typeKind "explicit"<br />
---@field link string?<br />
<br />
---@class docs.UnionType : docs.TypeModel<br />
---@field typeKind "union"<br />
---@field anyOf docs.TypeModel[]<br />
<br />
---@type metatable<br />
local type_meta = {<br />
__tostring = function (t)<br />
return ("<type %s from %s>"):format(t.name or '(anonymous)', t.origin)<br />
end<br />
}<br />
<br />
---@class docs.spool : docs.DocModel<br />
---@field src string<br />
---@field cursor integer<br />
---@field cursorNext integer?<br />
local spool = {}<br />
<br />
---Create a new spool.<br />
---@param src string<br />
---@return docs.spool<br />
function spool.new(src)<br />
return setmetatable({<br />
src = src,<br />
cursor = 1<br />
}, {__index = spool})<br />
end<br />
<br />
---@return integer cursor<br />
function spool:consumeSpace()<br />
self.cursor = self.src:match("%s*()", self.cursor)<br />
return self.cursor<br />
end<br />
<br />
local unpack = unpack or table.unpack -- 5.2 compat<br />
<br />
---Starts matching from the current cursor position, and recieves the next cursor position from a position capture.<br />
---@param pattern string<br />
---@param noMatchMsg string Format pattern with 1 %d to hold the cursor value.<br />
---@return any ...<br />
function spool:matchc(pattern, noMatchMsg)<br />
local results = {self.src:match(pattern, self.cursor)}<br />
if #results == 0 then error(noMatchMsg:format(self.cursor)) end<br />
self.cursorNext = results[#results]<br />
results[#results] = nil<br />
return unpack(results)<br />
end<br />
<br />
---@return string<br />
function spool:peek()<br />
return self.src:sub(self.cursor, self.cursor)<br />
end<br />
<br />
function spool:adv()<br />
if self:isAtEOF() then return end<br />
self.cursor = self.cursor + 1<br />
end<br />
<br />
function spool:matchadv(pattern)<br />
local _, to = self.src:find(pattern, self.cursor)<br />
if to then<br />
self.cursor = to + 1<br />
return true<br />
end<br />
return false<br />
end<br />
<br />
function spool:commit()<br />
if not self.cursorNext then error "spool:commit(): Nothing to commit" end<br />
self.cursor = self.cursorNext<br />
self.cursorNext = nil<br />
end<br />
<br />
function spool:isAtEOF() return self.cursor > #self.src end<br />
<br />
local LUA_TYPES_URL = "https://www.lua.org/manual/5.2/manual.html#2.1"<br />
<br />
---@type table<string, docs.ExplicitType><br />
local typeDefinitions = {}<br />
---@type table<string, string><br />
local typeAlias = {}<br />
local types = setmetatable({}, {<br />
__index = function (t, k)<br />
local resolvedName = k<br />
local i = 0<br />
while typeAlias[resolvedName] do<br />
i = i + 1<br />
if i > 10 then error "internal: alias chain too long" end<br />
resolvedName = typeAlias[resolvedName]<br />
end<br />
return typeDefinitions[resolvedName]<br />
end<br />
})<br />
<br />
---@param name string<br />
---@param origin docs.ModelOrigin<br />
---@param link string?<br />
---@return docs.ExplicitType<br />
local function newExplicitType(name, origin, link)<br />
if typeDefinitions[name] then error "Type already exists" end<br />
---@type docs.ExplicitType<br />
local t = setmetatable({<br />
kind = "type",<br />
typeKind = "explicit",<br />
name = name,<br />
attributes = {},<br />
origin = origin,<br />
link = link<br />
}, type_meta)<br />
typeDefinitions[name] = t<br />
return t<br />
end<br />
<br />
---@param anyOf docs.TypeModel[]<br />
---@return docs.UnionType<br />
local function newUnionType(anyOf)<br />
local function flatten(typ)<br />
if not typ.kind or typ.typeKind == "union" then<br />
local iterator<br />
if not typ.kind then<br />
iterator = typ<br />
else<br />
iterator = typ.anyOf<br />
end<br />
local seen = {}<br />
local res = {}<br />
for _, typ2 in ipairs(iterator) do<br />
for _, v in ipairs(flatten(typ2)) do<br />
if not seen[v] then<br />
res[#res + 1] = v<br />
seen[v] = true<br />
end<br />
end<br />
end<br />
return res<br />
elseif typ.typeKind == "explicit" then<br />
return { typ }<br />
end<br />
error "No type"<br />
end<br />
---@type docs.UnionType<br />
return setmetatable({<br />
anyOf = flatten(anyOf),<br />
attributes = {},<br />
kind = "type",<br />
origin = "abstract",<br />
typeKind = "union"<br />
}, {<br />
__tostring = function (t)<br />
local chunks = {}<br />
for _, type in ipairs(t.anyOf) do<br />
chunks[#chunks+1] = tostring(type)<br />
end<br />
return table.concat(chunks, ' | ')<br />
end<br />
})<br />
end<br />
<br />
---@param name string<br />
---@param origin docs.ModelOrigin<br />
---@return docs.ExplicitType<br />
local function getOrDefineType(name, origin)<br />
local t = types[name]<br />
if t then return t end<br />
return newExplicitType(name, origin, name)<br />
end<br />
<br />
---Create a new type definition type.<br />
---@param typedefname string without #<br />
---@return docs.TypeModel<br />
local function newTypedef(typedefname)<br />
local prefixed = "#"..typedefname<br />
if typeDefinitions[prefixed] then return typeDefinitions[prefixed] end<br />
---@type docs.ExplicitType<br />
local t = setmetatable({<br />
kind = "type",<br />
typeKind = "explicit",<br />
name = typedefname,<br />
attributes = {},<br />
origin = "typedef",<br />
link = "#typedef_"..typedefname<br />
}, type_meta)<br />
typeDefinitions[prefixed] = t<br />
return t<br />
end<br />
<br />
do -- builtin types<br />
<br />
-- currying<br />
---@param sourceName string<br />
---@return fun(list: string[])<br />
local function alias(sourceName)<br />
return function(list)<br />
for _, v in ipairs(list) do<br />
typeAlias[v] = sourceName<br />
end<br />
end<br />
end<br />
<br />
newExplicitType("any", "abstract")<br />
alias "any" { "AnyType" }<br />
newExplicitType("void", "abstract")<br />
newExplicitType("nil", "Lua", LUA_TYPES_URL)<br />
alias "nil" { "null" }<br />
newExplicitType("boolean", "Lua", LUA_TYPES_URL)<br />
alias "boolean" { "Boolean" }<br />
newExplicitType("number", "Lua", LUA_TYPES_URL)<br />
alias "number" { "Number", "double", "float" }<br />
newExplicitType("integer", "Lua", LUA_TYPES_URL)<br />
alias "integer" { "Integer" }<br />
newExplicitType("string", "Lua", LUA_TYPES_URL)<br />
alias "string" { "String" }<br />
newExplicitType("function", "Lua", LUA_TYPES_URL)<br />
alias "function" { "Function" }<br />
newExplicitType("userdata", "Lua", LUA_TYPES_URL)<br />
alias "userdata" { "Userdata" }<br />
newExplicitType("table", "Lua", LUA_TYPES_URL)<br />
alias "table" { "Table" }<br />
end<br />
<br />
---@param s docs.spool<br />
local function parseComment(s)<br />
s:matchc("%*/()", "No end of comment found")<br />
s:commit()<br />
end<br />
<br />
---@param s docs.spool<br />
---@return docs.TypeModel<br />
local function parseSimpleType(s)<br />
if s:isAtEOF() then error("Expected a type at position " .. s.cursor .. " but instead found nothing") end<br />
local prefix = s:peek()<br />
if prefix == "#" then<br />
s:adv()<br />
local typename = s:matchc("^([a-zA-Z0-9]+) ?()", "Expected a typedef name at position %d, but found nothing after the #")<br />
s:commit()<br />
return newTypedef(typename)<br />
end<br />
local typename = s:matchc("^([a-zA-Z0-9]+) ?()", "Expected a type name at position %d, but found nothing")<br />
s:commit()<br />
local t = getOrDefineType(typename, "Figura")<br />
return t<br />
end<br />
<br />
---@param s docs.spool<br />
local function parseType(s)<br />
local t = parseSimpleType(s)<br />
s:consumeSpace()<br />
local nextC = s:peek()<br />
if nextC == '|' then<br />
local unions = {t}<br />
while nextC == '|' do<br />
s:adv()<br />
s:consumeSpace()<br />
unions[#unions+1] = parseSimpleType(s)<br />
s:consumeSpace()<br />
nextC = s:peek()<br />
end<br />
return newUnionType(unions)<br />
else<br />
return t<br />
end<br />
end<br />
<br />
local function noop() end<br />
<br />
---@type table<string, fun(line: string, model: docs.DocModel)><br />
local sharedModifiers = {<br />
prefixHint = function (line, model)<br />
if model.prefixHint then error "duplicate prefixHint declaration" end<br />
model.prefixHint = line<br />
end<br />
}<br />
---@type table<string, fun(model: docs.DocModel)><br />
local sharedAttributes = {<br />
global = noop<br />
}<br />
<br />
---@type table<string, fun(line: string, model: docs.MethodModel)><br />
local methodModifiers = {<br />
}<br />
methodModifiers = setmetatable(methodModifiers, {__index = sharedModifiers})<br />
---@type table<string, fun(model: docs.MethodModel)><br />
local methodAttributes = {<br />
static = function (model)<br />
model.isStatic = true<br />
end,<br />
hostOnly = noop<br />
}<br />
methodAttributes = setmetatable(methodAttributes, {__index = sharedAttributes})<br />
<br />
---@type table<string, fun(line: string, model: docs.FieldModel)><br />
local fieldModifiers = {<br />
["type"] = function (line, model)<br />
local s = spool.new(line)<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error "expected end of statement after field type" end<br />
model.readType = t<br />
model.writeType = t<br />
end,<br />
["readType"] = function (line, model)<br />
local s = spool.new(line)<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error "expected end of statement after field readType" end<br />
model.readType = t<br />
end,<br />
["writeType"] = function (line, model)<br />
local s = spool.new(line)<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error "expected end of statement after field writeType" end<br />
model.writeType = t<br />
end,<br />
}<br />
fieldModifiers = setmetatable(fieldModifiers, {__index = sharedModifiers})<br />
---@type table<string, fun(model: docs.FieldModel)><br />
local fieldAttributes = {<br />
readOnly = function (model)<br />
model.canWrite = false<br />
end,<br />
writeOnly = function (model)<br />
model.canRead = false<br />
end<br />
}<br />
fieldAttributes = setmetatable(fieldAttributes, {__index = sharedAttributes})<br />
<br />
---@param sigtext string<br />
local function parseMethodSignature(sigtext)<br />
local s = spool.new(sigtext)<br />
<br />
---@type docs.MethodSignature<br />
local model = {<br />
returns = {},<br />
parameters = {}<br />
}<br />
<br />
local function parseParameter(assumeV)<br />
---@type docs.MethodSignature.Parameter<br />
local param = setmetatable({<br />
name = "",<br />
type = typeDefinitions.void,<br />
vararg = false<br />
}, {<br />
__tostring = function (t)<br />
return ("<param %s (%s)>"):format(t.name, tostring(t.type))<br />
end<br />
})<br />
if assumeV then<br />
param.name = "..."<br />
param.vararg = true<br />
else<br />
-- already consumed: 'parameter '<br />
if s:matchadv("^%.%.%. ?") then<br />
param.name = "..."<br />
param.vararg = true<br />
else<br />
param.name = s:matchc("^([a-zA-Z0-9]+) ?()", "Expected parameter name at %d but found nothing")<br />
s:commit()<br />
end<br />
end<br />
s:consumeSpace()<br />
param.type = parseType(s)<br />
s:consumeSpace()<br />
if not s:matchadv('^;') then error("Expected a semicolon to end parameter declaration at position " .. s.cursor) end<br />
model.parameters[#model.parameters+1] = param<br />
end<br />
<br />
local function parseReturns()<br />
-- already consumed: 'returns '<br />
model.returns[#model.returns+1] = parseType(s)<br />
s:consumeSpace()<br />
while s:matchadv('^,') do<br />
s:consumeSpace()<br />
model.returns[#model.returns+1] = parseType(s)<br />
s:consumeSpace()<br />
end<br />
if not s:matchadv('^;') then error("Expected a semicolon to end returns declaration at position " .. s.cursor) end<br />
end<br />
<br />
local function parseStmt()<br />
if s:matchadv "^/%*" then<br />
return parseComment(s)<br />
end<br />
if s:matchadv "^returns " then<br />
return parseReturns()<br />
end<br />
if s:matchadv "^parameter%.%.%." then<br />
return parseParameter(true)<br />
end<br />
if s:matchadv "^parameter " then<br />
return parseParameter()<br />
end<br />
error("No valid signature statement at " .. s.cursor)<br />
end<br />
<br />
local function parse()<br />
s:consumeSpace()<br />
while not s:isAtEOF() do<br />
parseStmt()<br />
s:consumeSpace()<br />
end<br />
end<br />
parse()<br />
return model<br />
end<br />
<br />
---@param docstr string<br />
local function parseMethod(docstr)<br />
local s = spool.new(docstr)<br />
<br />
---@type docs.MethodModel<br />
local model = {<br />
kind = "method",<br />
attributes = {},<br />
isStatic = false,<br />
name = "<unnamed>",<br />
origin = "Figura",<br />
signatures = {},<br />
}<br />
local parseTopLevelStmt, parseMethodHeader, parseSignatureOuter<br />
local blockKw = {}<br />
<br />
function parseSignatureOuter()<br />
s:consumeSpace()<br />
---@type string<br />
local block_content = s:matchc("^(%b{})%s*;()", "Expected a bracketed block after 'signature' at position %d")<br />
local inside = block_content:sub(2, -2)<br />
local sig = parseMethodSignature(inside)<br />
model.signatures[#model.signatures+1] = sig<br />
s:commit()<br />
end<br />
blockKw.signature = parseSignatureOuter<br />
<br />
function parseMethodHeader()<br />
local name = s:matchc("^([^%s;]+) ?()", "Expected method name at %d")<br />
model.name = name<br />
s:commit()<br />
s:consumeSpace()<br />
local peek = s:peek()<br />
while #peek ~= 0 and peek ~= ';' do<br />
local attr = s:matchc("^([^%s;]+) ?()", "Expected something else!")<br />
if not methodAttributes[attr] then<br />
error(("Unknown method attribute '%s' at position %d in method header"):format(attr, s.cursor))<br />
end<br />
methodAttributes[attr](model)<br />
model.attributes[attr] = true<br />
s:commit()<br />
s:consumeSpace()<br />
peek = s:peek()<br />
end<br />
if peek == ';' then<br />
s:adv() -- advance past the ;<br />
else<br />
error("Reached end of method documentation while parsing header")<br />
end<br />
end<br />
<br />
function parseTopLevelStmt()<br />
local startAt = s.cursor<br />
---@type string<br />
local action = s:matchc("^([^%s;]+) ?()", "Expected a modifier or block keyword, but got nothing instead at position %d")<br />
s:commit()<br />
if methodModifiers[action] then<br />
---@type string<br />
local remainder = s:matchc("^(.-);%s*()", "Expected semicolon to end statement around %d")<br />
s:commit()<br />
return methodModifiers[action](remainder, model)<br />
end<br />
if blockKw[action] then return blockKw[action]() end<br />
error(("Expected a modifier or block keyword, but got '%s' instead at position %d"):format(action, startAt))<br />
end<br />
<br />
local function parse()<br />
s:consumeSpace()<br />
parseMethodHeader()<br />
s:consumeSpace()<br />
while not s:isAtEOF() do<br />
parseTopLevelStmt()<br />
s:consumeSpace()<br />
end<br />
end<br />
<br />
parse()<br />
return model<br />
end<br />
<br />
---@param docstr string<br />
---@return docs.FieldModel<br />
local function parseField(docstr)<br />
local s = spool.new(docstr)<br />
<br />
---@type docs.FieldModel<br />
local model = {<br />
kind = "field",<br />
attributes = {},<br />
name = "<unnamed>",<br />
origin = "Figura",<br />
canRead = true,<br />
canWrite = true<br />
}<br />
<br />
local parseTopLevelStmt, parseFieldHeader, parseSignatureOuter<br />
<br />
function parseFieldHeader()<br />
local name = s:matchc("^([^%s;]+) ?()", "Expected field name at %d")<br />
model.name = name<br />
s:commit()<br />
s:consumeSpace()<br />
local peek = s:peek()<br />
while #peek ~= 0 and peek ~= ';' do<br />
local attr = s:matchc("^([^%s;]+) ?()", "Expected something else!")<br />
if not fieldAttributes[attr] then<br />
error(("Unknown field attribute '%s' at position %d in field header"):format(attr, s.cursor))<br />
end<br />
fieldAttributes[attr](model)<br />
model.attributes[attr] = true<br />
s:commit()<br />
s:consumeSpace()<br />
peek = s:peek()<br />
end<br />
if peek == ';' then<br />
s:adv() -- advance past the ;<br />
else<br />
error("Reached end of field documentation while parsing header")<br />
end<br />
end<br />
<br />
function parseTopLevelStmt()<br />
local startAt = s.cursor<br />
---@type string<br />
local action = s:matchc("^([^%s;]+) ?()", "Expected a modifier, but got nothing instead at position %d")<br />
s:commit()<br />
if fieldModifiers[action] then<br />
---@type string<br />
local remainder = s:matchc("^(.-);%s*()", "Expected semicolon to end statement around %d")<br />
s:commit()<br />
return fieldModifiers[action](remainder, model)<br />
end<br />
error(("Expected a modifier, but got '%s' instead at position %d"):format(action, startAt))<br />
end<br />
<br />
local function parse()<br />
s:consumeSpace()<br />
parseFieldHeader()<br />
s:consumeSpace()<br />
while not s:isAtEOF() do<br />
parseTopLevelStmt()<br />
s:consumeSpace()<br />
end<br />
end<br />
<br />
parse()<br />
return model<br />
end<br />
<br />
local renderType<br />
<br />
---@param typeM docs.ExplicitType<br />
---@return string<br />
local function renderTypeExplicit(typeM)<br />
local formatstr<br />
if not typeM.link then<br />
formatstr = [=[<span class="lua-type-explicit" data-name="$TypeName" $ExtraAttr>$TypeName</span>]=]<br />
elseif typeM.link:find("^https?://") then<br />
formatstr = [=[<span class="lua-type-explicit" data-name="$TypeName" $ExtraAttr>[$Link $TypeName]</span>]=]<br />
elseif typeM.link:find("^#") then<br />
formatstr = [=[<span class="lua-type-explicit -lua-typedef" data-name="$TypeName" $ExtraAttr>[[$Link|$TypeName]]</span>]=]<br />
else<br />
formatstr = [=[<span class="lua-type-explicit" data-name="$TypeName" $ExtraAttr>[[$Link|$TypeName]]</span>]=]<br />
end<br />
local replacements = {<br />
Link = typeM.link,<br />
TypeName = typeM.name,<br />
ExtraAttr = ""<br />
}<br />
local formatted = formatstr:gsub("%$([a-zA-Z]+)", replacements)<br />
return formatted<br />
end<br />
<br />
---@param typeM docs.UnionType<br />
---@return string<br />
local function renderTypeUnion(typeM)<br />
if #typeM.anyOf == 1 then return renderType(typeM.anyOf[1]) end<br />
if #typeM.anyOf == 2 then<br />
-- todo: add ? for optionals<br />
end<br />
local formatstr = [=[<span class="lua-type-union lua-type-recolor-border">%s</span>]=]<br />
local separator = [=[<span class="lua-type-union-bar lua-type-recolor-bar"></span>]=]<br />
local chunks = {}<br />
for _, t in ipairs(typeM.anyOf) do<br />
chunks[#chunks+1] = renderType(t)<br />
end<br />
return formatstr:format(table.concat(chunks, separator))<br />
end<br />
<br />
---@param typeM docs.TypeModel<br />
---@return string<br />
function renderType(typeM)<br />
if typeM.typeKind == "explicit" then<br />
---@cast typeM docs.ExplicitType<br />
return renderTypeExplicit(typeM)<br />
elseif typeM.typeKind == "union" then<br />
---@cast typeM docs.UnionType<br />
return renderTypeUnion(typeM)<br />
end<br />
error(("An internal error occured: unsure how to render a %s type"):format(tostring(typeM.typeKind)))<br />
end<br />
<br />
---@param o any<br />
---@param i number?<br />
local function printFancy(o, i)<br />
i = i or 2<br />
local indent = (" "):rep(i)<br />
if type(o) == "table" then<br />
if getmetatable(o) and getmetatable(o).__tostring then<br />
return tostring(o)<br />
end<br />
local b = "{\n"<br />
for k, v in pairs(o) do<br />
b = b .. indent .. printFancy(k, i + 2) .. " = " .. printFancy(v, i + 2) .. ",\n"<br />
end<br />
b = b .. (" "):rep(i - 2) .. "}"<br />
return b<br />
else<br />
return tostring(o)<br />
end<br />
end<br />
<br />
local function parseAndRenderType(frame)<br />
local input_args = frame:getParent().args<br />
local nargs = 0<br />
while input_args[nargs + 1] do nargs = nargs + 1 end<br />
if nargs == 0 then error "Need to specify at least one type" end<br />
<br />
if nargs == 1 then<br />
local s = spool.new(input_args[1])<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error("Expected end of type at position " .. s.cursor) end<br />
return renderType(t)<br />
else<br />
local tabulated = {}<br />
for i = 1, nargs do tabulated[i] = input_args[i] end<br />
local s = spool.new(table.concat(tabulated, "|"))<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error("Expected end of type at position " .. s.cursor) end<br />
return renderType(t)<br />
end<br />
end<br />
<br />
-- local m = parseField [[<br />
-- player global readOnly;<br />
-- type PlayerAPI;<br />
-- ]]<br />
-- print(printFancy(m))<br />
<br />
return {<br />
type = parseAndRenderType<br />
}</div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=Module:Signatures/Signatures.css&diff=893
Module:Signatures/Signatures.css
2025-03-31T03:49:45Z
<p>PenguinEncounter: </p>
<hr />
<div>/** DARK MODE **/<br />
@media screen and (prefers-color-scheme: dark) {<br />
html.skin-theme-clientpref-os .lua-type-explicit > a {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-os .lua-type-explicit > a::after {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-os .lua-type-recolor-border {<br />
border: 1px solid #404040 !important;<br />
}<br />
html.skin-theme-clientpref-os .lua-type-recolor-bar {<br />
background-color: #b0b0b0 !important;<br />
}<br />
}<br />
<br />
html.skin-theme-clientpref-night .lua-type-explicit > a {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-night .lua-type-explicit > a::after {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-night .lua-type-recolor-border {<br />
border: 1px solid #404040 !important;<br />
}<br />
html.skin-theme-clientpref-night .lua-type-recolor-bar {<br />
background-color: #b0b0b0 !important;<br />
}<br />
<br />
/** TYPES **/<br />
.lua-type-union {<br />
display: inline-flex;<br />
flex-flow: row nowrap;<br />
padding: 1px 1px;<br />
gap: 3px;<br />
border-radius: 4px;<br />
border: 1px solid #b0b0b0;<br />
}<br />
.lua-type-union > .lua-type-union-bar {<br />
display: block;<br />
width: 1px;<br />
margin: 3px 0;<br />
align-self: stretch;<br />
background-color: #404040;<br />
}<br />
<br />
.lua-type-explicit {<br />
font-family: monospace;<br />
display: contents; /* flatten 'a' as flex element */<br />
}<br />
.lua-type-explicit > .external.external::after {<br />
display: none;<br />
}<br />
.lua-type-explicit > a {<br />
border-radius: 4px;<br />
border: 1px solid #b0b0b0;<br />
color: #000000;<br />
text-decoration: none;<br />
padding: 0 4px;<br />
}<br />
.lua-type-explicit > .external.external:hover {<br />
color: #000000;<br />
text-decoration: underline;<br />
}<br />
.lua-type-explicit > a:visited {<br />
color: #000000;<br />
}<br />
<br />
/** TYPE COLORS **/<br />
<br />
.lua-type-explicit.-lua-typedef a::after {<br />
content: "";<br />
width: 12px;<br />
height: 12px;<br />
display: inline-block;<br />
border: 2px solid #c891ff;<br />
border-radius: 4px;<br />
margin-left: 4px;<br />
}<br />
<br />
.lua-type-explicit[data-name="nil"] a {<br />
background-color: #ffffff;<br />
border: 1px solid #808080;<br />
}<br />
.lua-type-explicit[data-name="any"] a {<br />
background-color: #ffffff;<br />
border: 1px dotted #808080;<br />
}<br />
.lua-type-explicit[data-name="table"] a {<br />
background-color: #ffffdd;<br />
}<br />
.lua-type-explicit[data-name="function"] a {<br />
background-color: #eeddff;<br />
}<br />
.lua-type-explicit[data-name="string"] a {<br />
background-color: #ddffdd;<br />
}<br />
.lua-type-explicit[data-name="boolean"] a {<br />
background-color: #ffddff;<br />
}<br />
.lua-type-explicit[data-name="number"] a, .lua-type-explicit[data-name="integer"] {<br />
background-color: #ddddff;<br />
}<br />
.lua-type-explicit[data-name^="Vector"] a {<br />
background-color: #ffeedd;<br />
}<br />
.lua-type-explicit[data-name^="Matrix"] a {<br />
background-color: #ffddee;<br />
}</div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=Module:Signatures/Signatures.css&diff=892
Module:Signatures/Signatures.css
2025-03-31T03:48:30Z
<p>PenguinEncounter: </p>
<hr />
<div>/** DARK MODE **/<br />
@media screen and (prefers-color-scheme: dark) {<br />
html.skin-theme-clientpref-os .lua-type-explicit > a {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-os .lua-type-explicit > a::after {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-os .lua-type-recolor-border {<br />
border: 1px solid #404040 !important;<br />
}<br />
html.skin-theme-clientpref-os .lua-type-recolor-bar {<br />
background-color: #b0b0b0 !important;<br />
}<br />
}<br />
<br />
html.skin-theme-clientpref-night .lua-type-explicit > a {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-night .lua-type-explicit > a::after {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-night .lua-type-recolor-border {<br />
border: 1px solid #404040 !important;<br />
}<br />
html.skin-theme-clientpref-night .lua-type-recolor-bar {<br />
background-color: #b0b0b0 !important;<br />
}<br />
<br />
/** TYPES **/<br />
.lua-type-union {<br />
display: inline-flex;<br />
flex-flow: row nowrap;<br />
padding: 1px 1px;<br />
gap: 3px;<br />
border-radius: 4px;<br />
border: 1px solid #b0b0b0;<br />
}<br />
.lua-type-union > .lua-type-union-bar {<br />
display: block;<br />
width: 1px;<br />
margin: 3px 0;<br />
align-self: stretch;<br />
background-color: #404040;<br />
}<br />
<br />
.lua-type-explicit {<br />
font-family: monospace;<br />
display: contents; /* flatten 'a' as flex element */<br />
}<br />
.lua-type-explicit > .external.external::after {<br />
display: none;<br />
}<br />
.lua-type-explicit > a {<br />
border-radius: 4px;<br />
border: 1px solid #b0b0b0;<br />
color: #000000;<br />
text-decoration: none;<br />
padding: 0 4px;<br />
}<br />
.lua-type-explicit > .external.external:hover {<br />
color: #000000;<br />
text-decoration: underline;<br />
}<br />
.lua-type-explicit > a:visited {<br />
color: #000000;<br />
}<br />
<br />
/** TYPE COLORS **/<br />
<br />
.lua-type-explicit.-lua-typedef a::after {<br />
content: "";<br />
width: 6px;<br />
height: 6px;<br />
display: inline-block;<br />
border: 2px solid #eeddff;<br />
border-radius: 4px;<br />
margin-left: 4px;<br />
}<br />
<br />
.lua-type-explicit[data-name="nil"] a {<br />
background-color: #ffffff;<br />
border: 1px solid #808080;<br />
}<br />
.lua-type-explicit[data-name="any"] a {<br />
background-color: #ffffff;<br />
border: 1px dotted #808080;<br />
}<br />
.lua-type-explicit[data-name="table"] a {<br />
background-color: #ffffdd;<br />
}<br />
.lua-type-explicit[data-name="function"] a {<br />
background-color: #eeddff;<br />
}<br />
.lua-type-explicit[data-name="string"] a {<br />
background-color: #ddffdd;<br />
}<br />
.lua-type-explicit[data-name="boolean"] a {<br />
background-color: #ffddff;<br />
}<br />
.lua-type-explicit[data-name="number"] a, .lua-type-explicit[data-name="integer"] {<br />
background-color: #ddddff;<br />
}<br />
.lua-type-explicit[data-name^="Vector"] a {<br />
background-color: #ffeedd;<br />
}<br />
.lua-type-explicit[data-name^="Matrix"] a {<br />
background-color: #ffddee;<br />
}</div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=Module:Signatures/Signatures.css&diff=891
Module:Signatures/Signatures.css
2025-03-31T03:47:17Z
<p>PenguinEncounter: </p>
<hr />
<div>/** DARK MODE **/<br />
@media screen and (prefers-color-scheme: dark) {<br />
html.skin-theme-clientpref-os .lua-type-explicit > a {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-os .lua-type-explicit > a::after {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-os .lua-type-recolor-border {<br />
border: 1px solid #404040 !important;<br />
}<br />
html.skin-theme-clientpref-os .lua-type-recolor-bar {<br />
background-color: #b0b0b0 !important;<br />
}<br />
}<br />
<br />
html.skin-theme-clientpref-night .lua-type-explicit > a {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-night .lua-type-explicit > a::after {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-night .lua-type-recolor-border {<br />
border: 1px solid #404040 !important;<br />
}<br />
html.skin-theme-clientpref-night .lua-type-recolor-bar {<br />
background-color: #b0b0b0 !important;<br />
}<br />
<br />
/** TYPES **/<br />
.lua-type-union {<br />
display: inline-flex;<br />
flex-flow: row nowrap;<br />
padding: 1px 1px;<br />
gap: 3px;<br />
border-radius: 4px;<br />
border: 1px solid #b0b0b0;<br />
}<br />
.lua-type-union > .lua-type-union-bar {<br />
display: block;<br />
width: 1px;<br />
margin: 3px 0;<br />
align-self: stretch;<br />
background-color: #404040;<br />
}<br />
<br />
.lua-type-explicit {<br />
font-family: monospace;<br />
display: contents; /* flatten 'a' as flex element */<br />
}<br />
.lua-type-explicit > .external.external::after {<br />
display: none;<br />
}<br />
.lua-type-explicit > a {<br />
border-radius: 4px;<br />
border: 1px solid #b0b0b0;<br />
color: #000000;<br />
text-decoration: none;<br />
padding: 0 4px;<br />
}<br />
.lua-type-explicit > .external.external:hover {<br />
color: #000000;<br />
text-decoration: underline;<br />
}<br />
.lua-type-explicit > a:visited {<br />
color: #000000;<br />
}<br />
<br />
/** TYPE COLORS **/<br />
<br />
.lua-type-explicit.-lua-typedef a::after {<br />
content: "";<br />
width: 16px;<br />
height: 16px;<br />
display: inline-block;<br />
border: 1px solid #eeddff;<br />
border-radius: 4px;<br />
}<br />
<br />
.lua-type-explicit[data-name="nil"] a {<br />
background-color: #ffffff;<br />
border: 1px solid #808080;<br />
}<br />
.lua-type-explicit[data-name="any"] a {<br />
background-color: #ffffff;<br />
border: 1px dotted #808080;<br />
}<br />
.lua-type-explicit[data-name="table"] a {<br />
background-color: #ffffdd;<br />
}<br />
.lua-type-explicit[data-name="function"] a {<br />
background-color: #eeddff;<br />
}<br />
.lua-type-explicit[data-name="string"] a {<br />
background-color: #ddffdd;<br />
}<br />
.lua-type-explicit[data-name="boolean"] a {<br />
background-color: #ffddff;<br />
}<br />
.lua-type-explicit[data-name="number"] a, .lua-type-explicit[data-name="integer"] {<br />
background-color: #ddddff;<br />
}<br />
.lua-type-explicit[data-name^="Vector"] a {<br />
background-color: #ffeedd;<br />
}<br />
.lua-type-explicit[data-name^="Matrix"] a {<br />
background-color: #ffddee;<br />
}</div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=Module:Signatures/Signatures.css&diff=890
Module:Signatures/Signatures.css
2025-03-31T03:46:00Z
<p>PenguinEncounter: </p>
<hr />
<div>/** DARK MODE **/<br />
@media screen and (prefers-color-scheme: dark) {<br />
html.skin-theme-clientpref-os .lua-type-explicit > a {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-os .lua-type-explicit > a::after {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-os .lua-type-recolor-border {<br />
border: 1px solid #404040 !important;<br />
}<br />
html.skin-theme-clientpref-os .lua-type-recolor-bar {<br />
background-color: #b0b0b0 !important;<br />
}<br />
}<br />
<br />
html.skin-theme-clientpref-night .lua-type-explicit > a {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-night .lua-type-explicit > a::after {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-night .lua-type-recolor-border {<br />
border: 1px solid #404040 !important;<br />
}<br />
html.skin-theme-clientpref-night .lua-type-recolor-bar {<br />
background-color: #b0b0b0 !important;<br />
}<br />
<br />
/** TYPES **/<br />
.lua-type-union {<br />
display: inline-flex;<br />
flex-flow: row nowrap;<br />
padding: 1px 1px;<br />
gap: 3px;<br />
border-radius: 4px;<br />
border: 1px solid #b0b0b0;<br />
}<br />
.lua-type-union > .lua-type-union-bar {<br />
display: block;<br />
width: 1px;<br />
margin: 3px 0;<br />
align-self: stretch;<br />
background-color: #404040;<br />
}<br />
<br />
.lua-type-explicit {<br />
font-family: monospace;<br />
display: contents; /* flatten 'a' as flex element */<br />
}<br />
.lua-type-explicit > .external.external::after {<br />
display: none;<br />
}<br />
.lua-type-explicit > a {<br />
border-radius: 4px;<br />
border: 1px solid #b0b0b0;<br />
color: #000000;<br />
text-decoration: none;<br />
padding: 0 4px;<br />
}<br />
.lua-type-explicit > .external.external:hover {<br />
color: #000000;<br />
text-decoration: underline;<br />
}<br />
.lua-type-explicit > a:visited {<br />
color: #000000;<br />
}<br />
<br />
/** TYPE COLORS **/<br />
<br />
.lua-type-explicit.-lua-typedef a::after {<br />
content: "";<br />
width: 16px;<br />
height: 16px;<br />
border: 1px solid #eeddff;<br />
border-radius: 4px;<br />
}<br />
<br />
.lua-type-explicit[data-name="nil"] a {<br />
background-color: #ffffff;<br />
border: 1px solid #808080;<br />
}<br />
.lua-type-explicit[data-name="any"] a {<br />
background-color: #ffffff;<br />
border: 1px dotted #808080;<br />
}<br />
.lua-type-explicit[data-name="table"] a {<br />
background-color: #ffffdd;<br />
}<br />
.lua-type-explicit[data-name="function"] a {<br />
background-color: #eeddff;<br />
}<br />
.lua-type-explicit[data-name="string"] a {<br />
background-color: #ddffdd;<br />
}<br />
.lua-type-explicit[data-name="boolean"] a {<br />
background-color: #ffddff;<br />
}<br />
.lua-type-explicit[data-name="number"] a, .lua-type-explicit[data-name="integer"] {<br />
background-color: #ddddff;<br />
}<br />
.lua-type-explicit[data-name^="Vector"] a {<br />
background-color: #ffeedd;<br />
}<br />
.lua-type-explicit[data-name^="Matrix"] a {<br />
background-color: #ffddee;<br />
}</div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=User:PenguinEncounter/sandbox&diff=889
User:PenguinEncounter/sandbox
2025-03-31T03:42:22Z
<p>PenguinEncounter: </p>
<hr />
<div><div style="font-size: 3rem;">[https://wiki.figuramc.org/index.php/User:PenguinEncounter/sandbox?action=purge purge it]</div><br />
<br />
[[Media:FunctionProtocol.svg]]<br />
[[File:FunctionProtocol.svg]]<br />
<br />
{{User:PenguinEncounter/newtype|function|Vector2|#TickEventCallback}}<br />
<br />
For example, to get the cube {{Emoji|BBCube.png}} RightArm:<br />
<br />
This is what is in your project:<br />
<br />
{{#invoke:MatrixFields|run|size=4}}<br />
<br />
{{tree|icon=FSFolderOpen.png|content=<code>my_avatar</code>|inner=<br />
{{tree|icon=FiguraJSON.png|content=<code>avatar.json</code>}}<br />
{{tree|icon=BBModel.png|content=<code>model.bbmodel</code>}}<br />
}}<br />
<br />
<br />
{{tree|icon=BBModel.png|content=<code>model.bbmodel</code>|inner=<br />
{{tree|icon=BBGroup.png|content=Head|inner=<br />
{{tree|icon=BBCube.png|content=Head}}<br />
{{tree|icon=BBCube.png|content=HeadLayer}}<br />
}}<br />
{{tree|icon=BBGroup.png|content=RightArm<br>oops|inner=<br />
{{tree|icon=BBCube.png|content=RightArm}}<br />
{{tree|icon=BBCube.png|content=RightArmLayer}}<br />
}}<br />
}}<br />
<br />
== conspicuous example code ==<br />
{{#tag:syntaxhighlight|<br />
function events.tick()<br />
<nowiki>--[[wiki.figuramc.org, </nowiki>{{FULLPAGENAME}} rev. {{REVISIONID}}<nowiki>]]</nowiki><br />
models.model.Head:setVisible(false)<br />
end<br />
|lang=lua}}<br />
<br />
= <code>HostAPI:setTitleTimes</code> =<br />
{{Host only|kind=method}}<br />
Configures the hold, fade-in, and fade-out durations of titles displayed on the screen.<br />
<br />
== Usage ==<br />
{| class="wikitable"<br />
! Arguments !! Return Type<br />
|-<br />
| <code>setTitleTimes(timesData {{type|Vector3}})</code><br />
| self {{type|HostAPI}}<br />
|-<br />
| <code>setTitleTimes(fadeInTime {{type|integer}}, stayTime {{type|integer}}, fadeOutTime {{type|integer}})</code><br />
| self {{type|HostAPI}}<br />
|}<br />
<br />
== Examples ==<br />
<syntaxhighlight lang="lua"><br />
host:setTitleTimes(1, 1, 1)<br />
</syntaxhighlight><br />
<br />
== See Also ==<br />
<!-- idk --></div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=File:FunctionProtocol.svg&diff=888
File:FunctionProtocol.svg
2025-03-31T03:31:45Z
<p>PenguinEncounter: PenguinEncounter uploaded a new version of File:FunctionProtocol.svg</p>
<hr />
<div></div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=File:FunctionProtocol.svg&diff=887
File:FunctionProtocol.svg
2025-03-31T03:19:21Z
<p>PenguinEncounter: PenguinEncounter uploaded a new version of File:FunctionProtocol.svg</p>
<hr />
<div></div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=File:FunctionProtocol.svg&diff=886
File:FunctionProtocol.svg
2025-03-31T03:17:07Z
<p>PenguinEncounter: </p>
<hr />
<div></div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=Module:Signatures/Signatures.css&diff=885
Module:Signatures/Signatures.css
2025-03-31T02:52:42Z
<p>PenguinEncounter: </p>
<hr />
<div>/** DARK MODE **/<br />
@media screen and (prefers-color-scheme: dark) {<br />
html.skin-theme-clientpref-os .lua-type-explicit > a {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-os .lua-type-recolor-border {<br />
border: 1px solid #404040 !important;<br />
}<br />
html.skin-theme-clientpref-os .lua-type-recolor-bar {<br />
background-color: #b0b0b0 !important;<br />
}<br />
}<br />
<br />
html.skin-theme-clientpref-night .lua-type-explicit > a {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-night .lua-type-recolor-border {<br />
border: 1px solid #404040 !important;<br />
}<br />
html.skin-theme-clientpref-night .lua-type-recolor-bar {<br />
background-color: #b0b0b0 !important;<br />
}<br />
<br />
/** TYPES **/<br />
.lua-type-union {<br />
display: inline-flex;<br />
flex-flow: row nowrap;<br />
padding: 1px 1px;<br />
gap: 3px;<br />
border-radius: 4px;<br />
border: 1px solid #b0b0b0;<br />
}<br />
.lua-type-union > .lua-type-union-bar {<br />
display: block;<br />
width: 1px;<br />
margin: 3px 0;<br />
align-self: stretch;<br />
background-color: #404040;<br />
}<br />
<br />
.lua-type-explicit {<br />
font-family: monospace;<br />
display: contents; /* flatten 'a' as flex element */<br />
}<br />
.lua-type-explicit > .external.external::after {<br />
display: none;<br />
}<br />
.lua-type-explicit > a {<br />
border-radius: 4px;<br />
border: 1px solid #b0b0b0;<br />
color: #000000;<br />
text-decoration: none;<br />
padding: 0 4px;<br />
}<br />
.lua-type-explicit > .external.external:hover {<br />
color: #000000;<br />
text-decoration: underline;<br />
}<br />
.lua-type-explicit > a:visited {<br />
color: #000000;<br />
}<br />
<br />
/** TYPE COLORS **/<br />
<br />
.lua-type-explicit[data-name="nil"] a {<br />
background-color: #ffffff;<br />
border: 1px solid #808080;<br />
}<br />
.lua-type-explicit[data-name="any"] a {<br />
background-color: #ffffff;<br />
border: 1px dotted #808080;<br />
}<br />
.lua-type-explicit[data-name="table"] a {<br />
background-color: #ffffdd;<br />
}<br />
.lua-type-explicit[data-name="function"] a {<br />
background-color: #eeddff;<br />
}<br />
.lua-type-explicit[data-name="string"] a {<br />
background-color: #ddffdd;<br />
}<br />
.lua-type-explicit[data-name="boolean"] a {<br />
background-color: #ffddff;<br />
}<br />
.lua-type-explicit[data-name="number"] a, .lua-type-explicit[data-name="integer"] {<br />
background-color: #ddddff;<br />
}<br />
.lua-type-explicit[data-name^="Vector"] a {<br />
background-color: #ffeedd;<br />
}<br />
.lua-type-explicit[data-name^="Matrix"] a {<br />
background-color: #ffddee;<br />
}</div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=Module:Signatures/Signatures.css&diff=884
Module:Signatures/Signatures.css
2025-03-31T02:22:14Z
<p>PenguinEncounter: </p>
<hr />
<div>/** DARK MODE **/<br />
@media screen and (prefers-color-scheme: dark) {<br />
html.skin-theme-clientpref-os .lua-type-explicit > a {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-os .lua-type-recolor-border {<br />
border: 1px solid #404040 !important;<br />
}<br />
html.skin-theme-clientpref-os .lua-type-recolor-bar {<br />
background-color: #b0b0b0 !important;<br />
}<br />
}<br />
<br />
html.skin-theme-clientpref-night .lua-type-explicit > a {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-night .lua-type-recolor-border {<br />
border: 1px solid #404040 !important;<br />
}<br />
html.skin-theme-clientpref-night .lua-type-recolor-bar {<br />
background-color: #b0b0b0 !important;<br />
}<br />
<br />
/** TYPES **/<br />
.lua-type-union {<br />
display: inline-flex;<br />
flex-flow: row nowrap;<br />
padding: 1px 1px;<br />
gap: 3px;<br />
border-radius: 4px;<br />
border: 1px solid #b0b0b0;<br />
}<br />
.lua-type-union > .lua-type-union-bar {<br />
display: block;<br />
width: 2px;<br />
margin: 3px 0;<br />
align-self: stretch;<br />
background-color: #404040;<br />
}<br />
<br />
.lua-type-explicit {<br />
font-family: monospace;<br />
display: contents; /* flatten 'a' as flex element */<br />
}<br />
.lua-type-explicit > .external.external::after {<br />
display: none;<br />
}<br />
.lua-type-explicit > a {<br />
border-radius: 4px;<br />
border: 1px solid #b0b0b0;<br />
color: #000000;<br />
text-decoration: none;<br />
padding: 0 4px;<br />
}<br />
.lua-type-explicit > .external.external:hover {<br />
color: #000000;<br />
text-decoration: underline;<br />
}<br />
.lua-type-explicit > a:visited {<br />
color: #000000;<br />
}<br />
<br />
/** TYPE COLORS **/<br />
<br />
.lua-type-explicit[data-name="nil"] a {<br />
background-color: #ffffff;<br />
border: 1px solid #808080;<br />
}<br />
.lua-type-explicit[data-name="any"] a {<br />
background-color: #ffffff;<br />
border: 1px dotted #808080;<br />
}<br />
.lua-type-explicit[data-name="table"] a {<br />
background-color: #ffffdd;<br />
}<br />
.lua-type-explicit[data-name="function"] a {<br />
background-color: #eeddff;<br />
}<br />
.lua-type-explicit[data-name="string"] a {<br />
background-color: #ddffdd;<br />
}<br />
.lua-type-explicit[data-name="boolean"] a {<br />
background-color: #ffddff;<br />
}<br />
.lua-type-explicit[data-name="number"] a, .lua-type-explicit[data-name="integer"] {<br />
background-color: #ddddff;<br />
}<br />
.lua-type-explicit[data-name^="Vector"] a {<br />
background-color: #ffeedd;<br />
}<br />
.lua-type-explicit[data-name^="Matrix"] a {<br />
background-color: #ffddee;<br />
}</div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=Module:Signatures/Signatures.css&diff=883
Module:Signatures/Signatures.css
2025-03-31T02:20:52Z
<p>PenguinEncounter: </p>
<hr />
<div>@media screen and (prefers-color-scheme: dark) {<br />
html.skin-theme-clientpref-os .lua-type-explicit > a {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-os .lua-type-recolor-border {<br />
border: 1px solid #404040 !important;<br />
}<br />
html.skin-theme-clientpref-os .lua-type-recolor-bar {<br />
background-color: #b0b0b0 !important;<br />
}<br />
}<br />
<br />
html.skin-theme-clientpref-night .lua-type-explicit > a {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-night .lua-type-recolor-border {<br />
border: 1px solid #404040 !important;<br />
}<br />
html.skin-theme-clientpref-night .lua-type-recolor-bar {<br />
background-color: #b0b0b0 !important;<br />
}<br />
<br />
<br />
.lua-type-union {<br />
display: inline-flex;<br />
flex-flow: row nowrap;<br />
padding: 1px 1px;<br />
gap: 3px;<br />
border-radius: 4px;<br />
border: 1px solid #b0b0b0;<br />
}<br />
.lua-type-union > .lua-type-union-bar {<br />
display: block;<br />
width: 2px;<br />
margin: 3px 0;<br />
align-self: stretch;<br />
background-color: #404040;<br />
}<br />
<br />
.lua-type-explicit {<br />
font-family: monospace;<br />
display: contents; /* flatten 'a' as flex element */<br />
}<br />
.lua-type-explicit > .external::after {<br />
display: none;<br />
}<br />
.lua-type-explicit > a {<br />
border-radius: 4px;<br />
border: 1px solid #b0b0b0;<br />
color: #000000;<br />
text-decoration: none;<br />
padding: 0 4px;<br />
}<br />
.lua-type-explicit > .external:hover {<br />
color: #000000;<br />
text-decoration: underline;<br />
}<br />
.lua-type-explicit > a:visited {<br />
color: #000000;<br />
}<br />
<br />
.lua-type-explicit[data-name="nil"] a {<br />
background-color: #ffffff;<br />
border: 1px solid #808080;<br />
}<br />
.lua-type-explicit[data-name="any"] a {<br />
background-color: #ffffff;<br />
border: 1px dotted #808080;<br />
}<br />
.lua-type-explicit[data-name="table"] a {<br />
background-color: #ffffdd;<br />
}<br />
.lua-type-explicit[data-name="function"] a {<br />
background-color: #eeddff;<br />
}<br />
.lua-type-explicit[data-name="string"] a {<br />
background-color: #ddffdd;<br />
}<br />
.lua-type-explicit[data-name="boolean"] a {<br />
background-color: #ffddff;<br />
}<br />
.lua-type-explicit[data-name="number"] a, .lua-type-explicit[data-name="integer"] {<br />
background-color: #ddddff;<br />
}<br />
.lua-type-explicit[data-name^="Vector"] a {<br />
background-color: #ffeedd;<br />
}<br />
.lua-type-explicit[data-name^="Matrix"] a {<br />
background-color: #ffddee;<br />
}</div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=Module:Signatures/Signatures.css&diff=882
Module:Signatures/Signatures.css
2025-03-31T02:14:44Z
<p>PenguinEncounter: </p>
<hr />
<div>@media screen and (prefers-color-scheme: dark) {<br />
html.skin-theme-clientpref-os .lua-type-explicit > a {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-os .lua-type-recolor-border {<br />
border: 1px solid #404040 !important;<br />
}<br />
html.skin-theme-clientpref-os .lua-type-recolor-bar {<br />
background-color: #b0b0b0 !important;<br />
}<br />
}<br />
<br />
html.skin-theme-clientpref-night .lua-type-explicit > a {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-night .lua-type-recolor-border {<br />
border: 1px solid #404040 !important;<br />
}<br />
html.skin-theme-clientpref-night .lua-type-recolor-bar {<br />
background-color: #b0b0b0 !important;<br />
}<br />
<br />
<br />
.lua-type-union {<br />
display: inline-flex;<br />
flex-flow: row nowrap;<br />
padding: 1px 1px;<br />
gap: 3px;<br />
border-radius: 4px;<br />
border: 1px solid #b0b0b0;<br />
}<br />
.lua-type-union > .lua-type-union-bar {<br />
display: block;<br />
width: 2px;<br />
margin: 3px 0;<br />
align-self: stretch;<br />
background-color: #404040;<br />
}<br />
<br />
.lua-type-explicit {<br />
font-family: monospace;<br />
display: contents; /* flatten 'a' as flex element */<br />
}<br />
.lua-type-explicit > .external::after {<br />
display: none;<br />
}<br />
.lua-type-explicit > a {<br />
border-radius: 4px;<br />
border: 1px solid #b0b0b0;<br />
color: #000000;<br />
text-decoration: none;<br />
padding: 0 4px;<br />
}<br />
.lua-type-explicit > .external:hover {<br />
color: #000000;<br />
text-decoration: underline;<br />
}<br />
.lua-type-explicit > a:visited {<br />
color: #000000;<br />
}</div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=Module:Signatures/Signatures.css&diff=881
Module:Signatures/Signatures.css
2025-03-31T02:14:08Z
<p>PenguinEncounter: </p>
<hr />
<div>@media screen and (prefers-color-scheme: dark) {<br />
html.skin-theme-clientpref-os .lua-type-explicit > a {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-os .lua-type-recolor-border {<br />
border: 1px solid #404040 !important;<br />
}<br />
html.skin-theme-clientpref-os .lua-type-recolor-bar {<br />
background-color: #b0b0b0 !important;<br />
}<br />
}<br />
<br />
html.skin-theme-clientpref-night .lua-type-explicit > a {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-night .lua-type-recolor-border {<br />
border: 1px solid #404040 !important;<br />
}<br />
html.skin-theme-clientpref-night .lua-type-recolor-bar {<br />
background-color: #b0b0b0 !important;<br />
}<br />
<br />
<br />
.lua-type-union {<br />
display: inline-flex;<br />
flex-flow: row nowrap;<br />
padding: 1px 1px;<br />
gap: 3px;<br />
border-radius: 4px;<br />
border: 1px solid #b0b0b0;<br />
}<br />
.lua-type-union > .lua-type-union-bar {<br />
display: block;<br />
width: 2px;<br />
margin: 3px 0;<br />
align-self: stretch;<br />
background-color: #404040;<br />
}<br />
<br />
.lua-type-explicit {<br />
font-family: monospace;<br />
display: contents; /* flatten 'a' as flex element */<br />
}<br />
.lua-type-explicit > .external::after {<br />
display: none;<br />
}<br />
.lua-type-explicit > a {<br />
border-radius: 4px;<br />
border: 1px solid #b0b0b0;<br />
color: #000000;<br />
text-decoration: none;<br />
padding: 0 4px;<br />
}<br />
.lua-type-explicit > a:hover {<br />
color: #000000;<br />
text-decoration: underline;<br />
}<br />
.lua-type-explicit > a:visited {<br />
color: #000000;<br />
}</div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=Module:Signatures/Signatures.css&diff=880
Module:Signatures/Signatures.css
2025-03-31T02:10:46Z
<p>PenguinEncounter: </p>
<hr />
<div>@media screen and (prefers-color-scheme: dark) {<br />
html.skin-theme-clientpref-os .lua-type-explicit > a {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-os .lua-type-recolor-border {<br />
border: 1px solid #404040 !important;<br />
}<br />
html.skin-theme-clientpref-os .lua-type-recolor-bar {<br />
background-color: #b0b0b0 !important;<br />
}<br />
}<br />
<br />
html.skin-theme-clientpref-night .lua-type-explicit > a {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-night .lua-type-recolor-border {<br />
border: 1px solid #404040 !important;<br />
}<br />
html.skin-theme-clientpref-night .lua-type-recolor-bar {<br />
background-color: #b0b0b0 !important;<br />
}<br />
<br />
<br />
.lua-type-union {<br />
display: inline-flex;<br />
flex-flow: row nowrap;<br />
padding: 1px 1px;<br />
gap: 3px;<br />
border-radius: 4px;<br />
border: 1px solid #b0b0b0;<br />
}<br />
.lua-type-union > .lua-type-union-bar {<br />
display: block;<br />
width: 2px;<br />
margin: 3px 0;<br />
align-self: stretch;<br />
background-color: #404040;<br />
}<br />
<br />
.lua-type-explicit {<br />
font-family: monospace;<br />
display: contents; /* flatten 'a' as flex element */<br />
}<br />
.lua-type-explicit > .external::after {<br />
display: none;<br />
}<br />
.lua-type-explicit > a {<br />
border-radius: 4px;<br />
border: 1px solid #b0b0b0;<br />
color: #000000;<br />
text-decoration: none;<br />
padding: 0 4px;<br />
}<br />
.lua-type-explicit > a:visited {<br />
color: #000000;<br />
}</div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=Module:Signatures/Signatures.css&diff=879
Module:Signatures/Signatures.css
2025-03-31T02:08:59Z
<p>PenguinEncounter: </p>
<hr />
<div>@media screen and (prefers-color-scheme: dark) {<br />
html.skin-theme-clientpref-os .lua-type-explicit {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-os .lua-type-recolor-border {<br />
border: 1px solid #404040 !important;<br />
}<br />
html.skin-theme-clientpref-os .lua-type-recolor-bar {<br />
background-color: #b0b0b0 !important;<br />
}<br />
}<br />
<br />
html.skin-theme-clientpref-night .lua-type-explicit {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-night .lua-type-recolor-border {<br />
border: 1px solid #404040 !important;<br />
}<br />
html.skin-theme-clientpref-night .lua-type-recolor-bar {<br />
background-color: #b0b0b0 !important;<br />
}<br />
<br />
<br />
.lua-type-union {<br />
display: inline-flex;<br />
flex-flow: row nowrap;<br />
padding: 1px 1px;<br />
gap: 3px;<br />
border-radius: 4px;<br />
border: 1px solid #b0b0b0;<br />
}<br />
.lua-type-union > .lua-type-union-bar {<br />
display: block;<br />
width: 2px;<br />
margin: 3px 0;<br />
align-self: stretch;<br />
background-color: #404040;<br />
}<br />
<br />
.lua-type-explicit {<br />
font-family: monospace;<br />
display: contents; /* flatten 'a' as flex element */<br />
}<br />
.lua-type-explicit > .external::after {<br />
display: none;<br />
}<br />
.lua-type-explicit > a {<br />
border-radius: 4px;<br />
border: 1px solid #b0b0b0;<br />
color: #000000;<br />
text-decoration: none;<br />
padding: 0 4px;<br />
}<br />
.lua-type-explicit > a:visited {<br />
color: #000000;<br />
}</div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=Module:Signatures&diff=878
Module:Signatures
2025-03-31T02:01:52Z
<p>PenguinEncounter: </p>
<hr />
<div>-- a MediaWiki module<br />
<br />
--[[<br />
Syntax description:<br />
<name> <attr...> ...;;<br />
<modName> [modSyn];;<br />
]]<br />
<br />
---@alias docs.ModelKind "field" | "method" | "type"<br />
<br />
---Origin of this documentation item.<br />
---@alias docs.ModelOrigin<br />
---| "Lua" Lua 5.2 built-in types and APIs.<br />
---| "Figura" Figura types and APIs. Usually the default.<br />
---| "abstract" Describes ideas, but no concrete implementation exists.<br />
---| "typedef" Custom on-the-spot types, like function protocols or array types.<br />
<br />
---@alias Set<T> {[T]: true}<br />
<br />
---@class docs.DocModel<br />
---@field kind docs.ModelKind<br />
---@field name string?<br />
---@field prefixHint string?<br />
---@field attributes Set<string><br />
---@field origin docs.ModelOrigin<br />
<br />
---@class docs.FieldModel : docs.DocModel<br />
---@field kind "field"<br />
---@field canRead boolean<br />
---@field canWrite boolean<br />
---@field readType docs.TypeModel?<br />
---@field writeType docs.TypeModel?<br />
<br />
---@class docs.MethodModel : docs.DocModel<br />
---@field kind "method"<br />
---@field signatures docs.MethodSignature[]<br />
---@field isStatic boolean<br />
<br />
---@class docs.MethodSignature.Parameter<br />
---@field name string<br />
---@field type docs.TypeModel<br />
---@field vararg boolean?<br />
<br />
---@class docs.MethodSignature<br />
---@field returns docs.TypeModel[]<br />
---@field parameters docs.MethodSignature.Parameter[]<br />
<br />
---@class docs.TypeModel : docs.DocModel<br />
---@field kind "type"<br />
---@field typeKind "explicit" | "union"<br />
<br />
---@class docs.ExplicitType : docs.TypeModel<br />
---@field typeKind "explicit"<br />
---@field link string?<br />
<br />
---@class docs.UnionType : docs.TypeModel<br />
---@field typeKind "union"<br />
---@field anyOf docs.TypeModel[]<br />
<br />
---@type metatable<br />
local type_meta = {<br />
__tostring = function (t)<br />
return ("<type %s from %s>"):format(t.name or '(anonymous)', t.origin)<br />
end<br />
}<br />
<br />
---@class docs.spool : docs.DocModel<br />
---@field src string<br />
---@field cursor integer<br />
---@field cursorNext integer?<br />
local spool = {}<br />
<br />
---Create a new spool.<br />
---@param src string<br />
---@return docs.spool<br />
function spool.new(src)<br />
return setmetatable({<br />
src = src,<br />
cursor = 1<br />
}, {__index = spool})<br />
end<br />
<br />
---@return integer cursor<br />
function spool:consumeSpace()<br />
self.cursor = self.src:match("%s*()", self.cursor)<br />
return self.cursor<br />
end<br />
<br />
local unpack = unpack or table.unpack -- 5.2 compat<br />
<br />
---Starts matching from the current cursor position, and recieves the next cursor position from a position capture.<br />
---@param pattern string<br />
---@param noMatchMsg string Format pattern with 1 %d to hold the cursor value.<br />
---@return any ...<br />
function spool:matchc(pattern, noMatchMsg)<br />
local results = {self.src:match(pattern, self.cursor)}<br />
if #results == 0 then error(noMatchMsg:format(self.cursor)) end<br />
self.cursorNext = results[#results]<br />
results[#results] = nil<br />
return unpack(results)<br />
end<br />
<br />
---@return string<br />
function spool:peek()<br />
return self.src:sub(self.cursor, self.cursor)<br />
end<br />
<br />
function spool:adv()<br />
if self:isAtEOF() then return end<br />
self.cursor = self.cursor + 1<br />
end<br />
<br />
function spool:matchadv(pattern)<br />
local _, to = self.src:find(pattern, self.cursor)<br />
if to then<br />
self.cursor = to + 1<br />
return true<br />
end<br />
return false<br />
end<br />
<br />
function spool:commit()<br />
if not self.cursorNext then error "spool:commit(): Nothing to commit" end<br />
self.cursor = self.cursorNext<br />
self.cursorNext = nil<br />
end<br />
<br />
function spool:isAtEOF() return self.cursor > #self.src end<br />
<br />
local LUA_TYPES_URL = "https://www.lua.org/manual/5.2/manual.html#2.1"<br />
<br />
---@type table<string, docs.ExplicitType><br />
local typeDefinitions = {}<br />
---@type table<string, string><br />
local typeAlias = {}<br />
local types = setmetatable({}, {<br />
__index = function (t, k)<br />
local resolvedName = k<br />
local i = 0<br />
while typeAlias[resolvedName] do<br />
i = i + 1<br />
if i > 10 then error "internal: alias chain too long" end<br />
resolvedName = typeAlias[resolvedName]<br />
end<br />
return typeDefinitions[resolvedName]<br />
end<br />
})<br />
<br />
---@param name string<br />
---@param origin docs.ModelOrigin<br />
---@param link string?<br />
---@return docs.ExplicitType<br />
local function newExplicitType(name, origin, link)<br />
if typeDefinitions[name] then error "Type already exists" end<br />
---@type docs.ExplicitType<br />
local t = setmetatable({<br />
kind = "type",<br />
typeKind = "explicit",<br />
name = name,<br />
attributes = {},<br />
origin = origin,<br />
link = link<br />
}, type_meta)<br />
typeDefinitions[name] = t<br />
return t<br />
end<br />
<br />
---@param anyOf docs.TypeModel[]<br />
---@return docs.UnionType<br />
local function newUnionType(anyOf)<br />
local function flatten(typ)<br />
if not typ.kind or typ.typeKind == "union" then<br />
local iterator<br />
if not typ.kind then<br />
iterator = typ<br />
else<br />
iterator = typ.anyOf<br />
end<br />
local seen = {}<br />
local res = {}<br />
for _, typ2 in ipairs(iterator) do<br />
for _, v in ipairs(flatten(typ2)) do<br />
if not seen[v] then<br />
res[#res + 1] = v<br />
seen[v] = true<br />
end<br />
end<br />
end<br />
return res<br />
elseif typ.typeKind == "explicit" then<br />
return { typ }<br />
end<br />
error "No type"<br />
end<br />
---@type docs.UnionType<br />
return setmetatable({<br />
anyOf = flatten(anyOf),<br />
attributes = {},<br />
kind = "type",<br />
origin = "abstract",<br />
typeKind = "union"<br />
}, {<br />
__tostring = function (t)<br />
local chunks = {}<br />
for _, type in ipairs(t.anyOf) do<br />
chunks[#chunks+1] = tostring(type)<br />
end<br />
return table.concat(chunks, ' | ')<br />
end<br />
})<br />
end<br />
<br />
---@param name string<br />
---@param origin docs.ModelOrigin<br />
---@return docs.ExplicitType<br />
local function getOrDefineType(name, origin)<br />
local t = types[name]<br />
if t then return t end<br />
return newExplicitType(name, origin, name)<br />
end<br />
<br />
---Create a new type definition type.<br />
---@param typedefname string without #<br />
---@return docs.TypeModel<br />
local function newTypedef(typedefname)<br />
local prefixed = "#"..typedefname<br />
if typeDefinitions[prefixed] then return typeDefinitions[prefixed] end<br />
---@type docs.ExplicitType<br />
local t = setmetatable({<br />
kind = "type",<br />
typeKind = "explicit",<br />
name = typedefname,<br />
attributes = {},<br />
origin = "typedef",<br />
link = "#typedef_"..typedefname<br />
}, type_meta)<br />
typeDefinitions[prefixed] = t<br />
return t<br />
end<br />
<br />
do -- builtin types<br />
<br />
-- currying<br />
---@param sourceName string<br />
---@return fun(list: string[])<br />
local function alias(sourceName)<br />
return function(list)<br />
for _, v in ipairs(list) do<br />
typeAlias[v] = sourceName<br />
end<br />
end<br />
end<br />
<br />
newExplicitType("any", "abstract")<br />
alias "any" { "AnyType" }<br />
newExplicitType("void", "abstract")<br />
newExplicitType("nil", "Lua", LUA_TYPES_URL)<br />
alias "nil" { "null" }<br />
newExplicitType("boolean", "Lua", LUA_TYPES_URL)<br />
alias "boolean" { "Boolean" }<br />
newExplicitType("number", "Lua", LUA_TYPES_URL)<br />
alias "number" { "Number", "double", "float" }<br />
newExplicitType("integer", "Lua", LUA_TYPES_URL)<br />
alias "integer" { "Integer" }<br />
newExplicitType("string", "Lua", LUA_TYPES_URL)<br />
alias "string" { "String" }<br />
newExplicitType("function", "Lua", LUA_TYPES_URL)<br />
alias "function" { "Function" }<br />
newExplicitType("userdata", "Lua", LUA_TYPES_URL)<br />
alias "userdata" { "Userdata" }<br />
newExplicitType("table", "Lua", LUA_TYPES_URL)<br />
alias "table" { "Table" }<br />
end<br />
<br />
---@param s docs.spool<br />
local function parseComment(s)<br />
s:matchc("%*/()", "No end of comment found")<br />
s:commit()<br />
end<br />
<br />
---@param s docs.spool<br />
---@return docs.TypeModel<br />
local function parseSimpleType(s)<br />
if s:isAtEOF() then error("Expected a type at position " .. s.cursor .. " but instead found nothing") end<br />
local prefix = s:peek()<br />
if prefix == "#" then<br />
s:adv()<br />
local typename = s:matchc("^([a-zA-Z0-9]+) ?()", "Expected a typedef name at position %d, but found nothing after the #")<br />
s:commit()<br />
return newTypedef(typename)<br />
end<br />
local typename = s:matchc("^([a-zA-Z0-9]+) ?()", "Expected a type name at position %d, but found nothing")<br />
s:commit()<br />
local t = getOrDefineType(typename, "Figura")<br />
return t<br />
end<br />
<br />
---@param s docs.spool<br />
local function parseType(s)<br />
local t = parseSimpleType(s)<br />
s:consumeSpace()<br />
local nextC = s:peek()<br />
if nextC == '|' then<br />
local unions = {t}<br />
while nextC == '|' do<br />
s:adv()<br />
s:consumeSpace()<br />
unions[#unions+1] = parseSimpleType(s)<br />
s:consumeSpace()<br />
nextC = s:peek()<br />
end<br />
return newUnionType(unions)<br />
else<br />
return t<br />
end<br />
end<br />
<br />
local function noop() end<br />
<br />
---@type table<string, fun(line: string, model: docs.DocModel)><br />
local sharedModifiers = {<br />
prefixHint = function (line, model)<br />
if model.prefixHint then error "duplicate prefixHint declaration" end<br />
model.prefixHint = line<br />
end<br />
}<br />
---@type table<string, fun(model: docs.DocModel)><br />
local sharedAttributes = {<br />
global = noop<br />
}<br />
<br />
---@type table<string, fun(line: string, model: docs.MethodModel)><br />
local methodModifiers = {<br />
}<br />
methodModifiers = setmetatable(methodModifiers, {__index = sharedModifiers})<br />
---@type table<string, fun(model: docs.MethodModel)><br />
local methodAttributes = {<br />
static = function (model)<br />
model.isStatic = true<br />
end,<br />
hostOnly = noop<br />
}<br />
methodAttributes = setmetatable(methodAttributes, {__index = sharedAttributes})<br />
<br />
---@type table<string, fun(line: string, model: docs.FieldModel)><br />
local fieldModifiers = {<br />
["type"] = function (line, model)<br />
local s = spool.new(line)<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error "expected end of statement after field type" end<br />
model.readType = t<br />
model.writeType = t<br />
end,<br />
["readType"] = function (line, model)<br />
local s = spool.new(line)<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error "expected end of statement after field readType" end<br />
model.readType = t<br />
end,<br />
["writeType"] = function (line, model)<br />
local s = spool.new(line)<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error "expected end of statement after field writeType" end<br />
model.writeType = t<br />
end,<br />
}<br />
fieldModifiers = setmetatable(fieldModifiers, {__index = sharedModifiers})<br />
---@type table<string, fun(model: docs.FieldModel)><br />
local fieldAttributes = {<br />
readOnly = function (model)<br />
model.canWrite = false<br />
end,<br />
writeOnly = function (model)<br />
model.canRead = false<br />
end<br />
}<br />
fieldAttributes = setmetatable(fieldAttributes, {__index = sharedAttributes})<br />
<br />
---@param sigtext string<br />
local function parseMethodSignature(sigtext)<br />
local s = spool.new(sigtext)<br />
<br />
---@type docs.MethodSignature<br />
local model = {<br />
returns = {},<br />
parameters = {}<br />
}<br />
<br />
local function parseParameter(assumeV)<br />
---@type docs.MethodSignature.Parameter<br />
local param = setmetatable({<br />
name = "",<br />
type = typeDefinitions.void,<br />
vararg = false<br />
}, {<br />
__tostring = function (t)<br />
return ("<param %s (%s)>"):format(t.name, tostring(t.type))<br />
end<br />
})<br />
if assumeV then<br />
param.name = "..."<br />
param.vararg = true<br />
else<br />
-- already consumed: 'parameter '<br />
if s:matchadv("^%.%.%. ?") then<br />
param.name = "..."<br />
param.vararg = true<br />
else<br />
param.name = s:matchc("^([a-zA-Z0-9]+) ?()", "Expected parameter name at %d but found nothing")<br />
s:commit()<br />
end<br />
end<br />
s:consumeSpace()<br />
param.type = parseType(s)<br />
s:consumeSpace()<br />
if not s:matchadv('^;') then error("Expected a semicolon to end parameter declaration at position " .. s.cursor) end<br />
model.parameters[#model.parameters+1] = param<br />
end<br />
<br />
local function parseReturns()<br />
-- already consumed: 'returns '<br />
model.returns[#model.returns+1] = parseType(s)<br />
s:consumeSpace()<br />
while s:matchadv('^,') do<br />
s:consumeSpace()<br />
model.returns[#model.returns+1] = parseType(s)<br />
s:consumeSpace()<br />
end<br />
if not s:matchadv('^;') then error("Expected a semicolon to end returns declaration at position " .. s.cursor) end<br />
end<br />
<br />
local function parseStmt()<br />
if s:matchadv "^/%*" then<br />
return parseComment(s)<br />
end<br />
if s:matchadv "^returns " then<br />
return parseReturns()<br />
end<br />
if s:matchadv "^parameter%.%.%." then<br />
return parseParameter(true)<br />
end<br />
if s:matchadv "^parameter " then<br />
return parseParameter()<br />
end<br />
error("No valid signature statement at " .. s.cursor)<br />
end<br />
<br />
local function parse()<br />
s:consumeSpace()<br />
while not s:isAtEOF() do<br />
parseStmt()<br />
s:consumeSpace()<br />
end<br />
end<br />
parse()<br />
return model<br />
end<br />
<br />
---@param docstr string<br />
local function parseMethod(docstr)<br />
local s = spool.new(docstr)<br />
<br />
---@type docs.MethodModel<br />
local model = {<br />
kind = "method",<br />
attributes = {},<br />
isStatic = false,<br />
name = "<unnamed>",<br />
origin = "Figura",<br />
signatures = {},<br />
}<br />
local parseTopLevelStmt, parseMethodHeader, parseSignatureOuter<br />
local blockKw = {}<br />
<br />
function parseSignatureOuter()<br />
s:consumeSpace()<br />
---@type string<br />
local block_content = s:matchc("^(%b{})%s*;()", "Expected a bracketed block after 'signature' at position %d")<br />
local inside = block_content:sub(2, -2)<br />
local sig = parseMethodSignature(inside)<br />
model.signatures[#model.signatures+1] = sig<br />
s:commit()<br />
end<br />
blockKw.signature = parseSignatureOuter<br />
<br />
function parseMethodHeader()<br />
local name = s:matchc("^([^%s;]+) ?()", "Expected method name at %d")<br />
model.name = name<br />
s:commit()<br />
s:consumeSpace()<br />
local peek = s:peek()<br />
while #peek ~= 0 and peek ~= ';' do<br />
local attr = s:matchc("^([^%s;]+) ?()", "Expected something else!")<br />
if not methodAttributes[attr] then<br />
error(("Unknown method attribute '%s' at position %d in method header"):format(attr, s.cursor))<br />
end<br />
methodAttributes[attr](model)<br />
model.attributes[attr] = true<br />
s:commit()<br />
s:consumeSpace()<br />
peek = s:peek()<br />
end<br />
if peek == ';' then<br />
s:adv() -- advance past the ;<br />
else<br />
error("Reached end of method documentation while parsing header")<br />
end<br />
end<br />
<br />
function parseTopLevelStmt()<br />
local startAt = s.cursor<br />
---@type string<br />
local action = s:matchc("^([^%s;]+) ?()", "Expected a modifier or block keyword, but got nothing instead at position %d")<br />
s:commit()<br />
if methodModifiers[action] then<br />
---@type string<br />
local remainder = s:matchc("^(.-);%s*()", "Expected semicolon to end statement around %d")<br />
s:commit()<br />
return methodModifiers[action](remainder, model)<br />
end<br />
if blockKw[action] then return blockKw[action]() end<br />
error(("Expected a modifier or block keyword, but got '%s' instead at position %d"):format(action, startAt))<br />
end<br />
<br />
local function parse()<br />
s:consumeSpace()<br />
parseMethodHeader()<br />
s:consumeSpace()<br />
while not s:isAtEOF() do<br />
parseTopLevelStmt()<br />
s:consumeSpace()<br />
end<br />
end<br />
<br />
parse()<br />
return model<br />
end<br />
<br />
---@param docstr string<br />
---@return docs.FieldModel<br />
local function parseField(docstr)<br />
local s = spool.new(docstr)<br />
<br />
---@type docs.FieldModel<br />
local model = {<br />
kind = "field",<br />
attributes = {},<br />
name = "<unnamed>",<br />
origin = "Figura",<br />
canRead = true,<br />
canWrite = true<br />
}<br />
<br />
local parseTopLevelStmt, parseFieldHeader, parseSignatureOuter<br />
<br />
function parseFieldHeader()<br />
local name = s:matchc("^([^%s;]+) ?()", "Expected field name at %d")<br />
model.name = name<br />
s:commit()<br />
s:consumeSpace()<br />
local peek = s:peek()<br />
while #peek ~= 0 and peek ~= ';' do<br />
local attr = s:matchc("^([^%s;]+) ?()", "Expected something else!")<br />
if not fieldAttributes[attr] then<br />
error(("Unknown field attribute '%s' at position %d in field header"):format(attr, s.cursor))<br />
end<br />
fieldAttributes[attr](model)<br />
model.attributes[attr] = true<br />
s:commit()<br />
s:consumeSpace()<br />
peek = s:peek()<br />
end<br />
if peek == ';' then<br />
s:adv() -- advance past the ;<br />
else<br />
error("Reached end of field documentation while parsing header")<br />
end<br />
end<br />
<br />
function parseTopLevelStmt()<br />
local startAt = s.cursor<br />
---@type string<br />
local action = s:matchc("^([^%s;]+) ?()", "Expected a modifier, but got nothing instead at position %d")<br />
s:commit()<br />
if fieldModifiers[action] then<br />
---@type string<br />
local remainder = s:matchc("^(.-);%s*()", "Expected semicolon to end statement around %d")<br />
s:commit()<br />
return fieldModifiers[action](remainder, model)<br />
end<br />
error(("Expected a modifier, but got '%s' instead at position %d"):format(action, startAt))<br />
end<br />
<br />
local function parse()<br />
s:consumeSpace()<br />
parseFieldHeader()<br />
s:consumeSpace()<br />
while not s:isAtEOF() do<br />
parseTopLevelStmt()<br />
s:consumeSpace()<br />
end<br />
end<br />
<br />
parse()<br />
return model<br />
end<br />
<br />
local renderType<br />
<br />
---@param typeM docs.ExplicitType<br />
---@return string<br />
local function renderTypeExplicit(typeM)<br />
local formatstr<br />
if not typeM.link then<br />
formatstr = [=[<span class="lua-type-explicit" data-name="$TypeName" $ExtraAttr>$TypeName</span>]=]<br />
elseif typeM.link:find("^https?://") then<br />
formatstr = [=[<span class="lua-type-explicit" data-name="$TypeName" $ExtraAttr>[$Link $TypeName]</span>]=]<br />
else<br />
formatstr = [=[<span class="lua-type-explicit -lua-typedef" data-name="$TypeName" $ExtraAttr>[[$Link|$TypeName]]</span>]=]<br />
end<br />
local replacements = {<br />
Link = typeM.link,<br />
TypeName = typeM.name,<br />
ExtraAttr = ""<br />
}<br />
local formatted = formatstr:gsub("%$([a-zA-Z]+)", replacements)<br />
return formatted<br />
end<br />
<br />
---@param typeM docs.UnionType<br />
---@return string<br />
local function renderTypeUnion(typeM)<br />
if #typeM.anyOf == 1 then return renderType(typeM.anyOf[1]) end<br />
if #typeM.anyOf == 2 then<br />
-- todo: add ? for optionals<br />
end<br />
local formatstr = [=[<span class="lua-type-union lua-type-recolor-border">%s</span>]=]<br />
local separator = [=[<span class="lua-type-union-bar lua-type-recolor-bar"></span>]=]<br />
local chunks = {}<br />
for _, t in ipairs(typeM.anyOf) do<br />
chunks[#chunks+1] = renderType(t)<br />
end<br />
return formatstr:format(table.concat(chunks, separator))<br />
end<br />
<br />
---@param typeM docs.TypeModel<br />
---@return string<br />
function renderType(typeM)<br />
if typeM.typeKind == "explicit" then<br />
---@cast typeM docs.ExplicitType<br />
return renderTypeExplicit(typeM)<br />
elseif typeM.typeKind == "union" then<br />
---@cast typeM docs.UnionType<br />
return renderTypeUnion(typeM)<br />
end<br />
error(("An internal error occured: unsure how to render a %s type"):format(tostring(typeM.typeKind)))<br />
end<br />
<br />
---@param o any<br />
---@param i number?<br />
local function printFancy(o, i)<br />
i = i or 2<br />
local indent = (" "):rep(i)<br />
if type(o) == "table" then<br />
if getmetatable(o) and getmetatable(o).__tostring then<br />
return tostring(o)<br />
end<br />
local b = "{\n"<br />
for k, v in pairs(o) do<br />
b = b .. indent .. printFancy(k, i + 2) .. " = " .. printFancy(v, i + 2) .. ",\n"<br />
end<br />
b = b .. (" "):rep(i - 2) .. "}"<br />
return b<br />
else<br />
return tostring(o)<br />
end<br />
end<br />
<br />
local function parseAndRenderType(frame)<br />
local input_args = frame:getParent().args<br />
local nargs = 0<br />
while input_args[nargs + 1] do nargs = nargs + 1 end<br />
if nargs == 0 then error "Need to specify at least one type" end<br />
<br />
if nargs == 1 then<br />
local s = spool.new(input_args[1])<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error("Expected end of type at position " .. s.cursor) end<br />
return renderType(t)<br />
else<br />
local tabulated = {}<br />
for i = 1, nargs do tabulated[i] = input_args[i] end<br />
local s = spool.new(table.concat(tabulated, "|"))<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error("Expected end of type at position " .. s.cursor) end<br />
return renderType(t)<br />
end<br />
end<br />
<br />
-- local m = parseField [[<br />
-- player global readOnly;<br />
-- type PlayerAPI;<br />
-- ]]<br />
-- print(printFancy(m))<br />
<br />
return {<br />
type = parseAndRenderType<br />
}</div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=Module:Signatures/Signatures.css&diff=877
Module:Signatures/Signatures.css
2025-03-31T02:01:45Z
<p>PenguinEncounter: </p>
<hr />
<div>@media screen and (prefers-color-scheme: dark) {<br />
html.skin-theme-clientpref-os .lua-type-explicit {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-os .lua-type-recolor-border {<br />
border: 1px solid #404040 !important;<br />
}<br />
html.skin-theme-clientpref-os .lua-type-recolor-bar {<br />
background-color: #b0b0b0 !important;<br />
}<br />
}<br />
<br />
html.skin-theme-clientpref-night .lua-type-explicit {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-night .lua-type-recolor-border {<br />
border: 1px solid #404040 !important;<br />
}<br />
html.skin-theme-clientpref-night .lua-type-recolor-bar {<br />
background-color: #b0b0b0 !important;<br />
}<br />
<br />
<br />
.lua-type-union {<br />
display: inline-flex;<br />
flex-flow: row nowrap;<br />
padding: 1px 1px;<br />
gap: 3px;<br />
border-radius: 4px;<br />
border: 1px solid #b0b0b0;<br />
}<br />
.lua-type-union > .lua-type-union-bar {<br />
display: block;<br />
width: 2px;<br />
margin: 3px 0;<br />
align-self: stretch;<br />
background-color: #404040;<br />
}<br />
<br />
.lua-type-explicit {<br />
font-family: monospace;<br />
display: contents;<br />
}<br />
.lua-type-explicit > .external::after {<br />
display: none;<br />
}<br />
.lua-type-explicit > a {<br />
border-radius: 4px;<br />
border: 1px solid #b0b0b0;<br />
padding: 0 4px;<br />
}</div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=Module:Signatures/Signatures.css&diff=876
Module:Signatures/Signatures.css
2025-03-31T02:01:16Z
<p>PenguinEncounter: </p>
<hr />
<div>@media screen and (prefers-color-scheme: dark) {<br />
html.skin-theme-clientpref-os .lua-type-explicit {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-os .lua-type-recolor-border {<br />
border: 1px solid #404040 !important;<br />
}<br />
html.skin-theme-clientpref-os .lua-type-recolor-bar {<br />
background-color: #b0b0b0 !important;<br />
}<br />
}<br />
<br />
html.skin-theme-clientpref-night .lua-type-explicit {<br />
filter: invert() hue-rotate(180deg) brightness(110%);<br />
}<br />
html.skin-theme-clientpref-night .lua-type-recolor-border {<br />
border: 1px solid #404040 !important;<br />
}<br />
html.skin-theme-clientpref-night .lua-type-recolor-bar {<br />
background-color: #b0b0b0 !important;<br />
}<br />
<br />
<br />
.lua-type-union {<br />
display: inline-flex;<br />
flex-flow: row nowrap;<br />
padding: 1px 1px;<br />
gap: 3px;<br />
border-radius: 4px;<br />
border: 1px solid #eeeeee;<br />
}<br />
.lua-type-union > .lua-type-union-bar {<br />
display: block;<br />
width: 2px;<br />
margin: 3px 0;<br />
align-self: stretch;<br />
background-color: #404040;<br />
}<br />
<br />
.lua-type-explicit {<br />
font-family: monospace;<br />
display: contents;<br />
}<br />
.lua-type-explicit > .external::after {<br />
display: none;<br />
}<br />
.lua-type-explicit > a {<br />
border-radius: 4px;<br />
border: 1px solid #eeeeee;<br />
padding: 0 4px;<br />
}</div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=Module:Signatures/Signatures.css&diff=875
Module:Signatures/Signatures.css
2025-03-31T01:23:39Z
<p>PenguinEncounter: </p>
<hr />
<div>.lua-type-union {<br />
display: inline-flex;<br />
flex-flow: row nowrap;<br />
padding: 1px 1px;<br />
gap: 3px;<br />
border-radius: 4px;<br />
border: 1px solid var(--color-surface-2); /* FIXME: theming */<br />
}<br />
.lua-type-union > .lua-type-union-bar {<br />
display: block;<br />
width: 2px;<br />
margin: 3px 0;<br />
align-self: stretch;<br />
background-color: var(--color-surface-2); /* FIXME: theming */<br />
}<br />
<br />
.lua-type-explicit {<br />
font-family: monospace;<br />
display: contents;<br />
}<br />
.lua-type-explicit > .external::after {<br />
display: none;<br />
}<br />
.lua-type-explicit > a {<br />
border-radius: 4px;<br />
border: 1px solid var(--color-surface-2); /* FIXME: theming */<br />
padding: 0 4px;<br />
}</div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=Module:Signatures/Signatures.css&diff=874
Module:Signatures/Signatures.css
2025-03-31T01:20:49Z
<p>PenguinEncounter: </p>
<hr />
<div>.lua-type-union {<br />
display: inline-flex;<br />
flex-flow: row nowrap;<br />
padding: 1px 1px;<br />
gap: 3px;<br />
border-radius: 4px;<br />
border: 1px solid #404040; /* FIXME: theming */<br />
}<br />
.lua-type-union > .lua-type-union-bar {<br />
display: block;<br />
width: 2px;<br />
margin: 3px 0;<br />
align-self: stretch;<br />
background-color: #404040; /* FIXME: theming */<br />
}<br />
<br />
.lua-type-explicit {<br />
font-family: monospace;<br />
display: contents;<br />
}<br />
.lua-type-explicit > .external::after {<br />
display: none;<br />
}<br />
.lua-type-explicit > a {<br />
border-radius: 4px;<br />
border: 1px solid #404040; /* FIXME: theming */<br />
padding: 0 4px;<br />
}</div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=Module:Signatures&diff=873
Module:Signatures
2025-03-31T01:20:03Z
<p>PenguinEncounter: </p>
<hr />
<div>-- a MediaWiki module<br />
<br />
--[[<br />
Syntax description:<br />
<name> <attr...> ...;;<br />
<modName> [modSyn];;<br />
]]<br />
<br />
---@alias docs.ModelKind "field" | "method" | "type"<br />
<br />
---Origin of this documentation item.<br />
---@alias docs.ModelOrigin<br />
---| "Lua" Lua 5.2 built-in types and APIs.<br />
---| "Figura" Figura types and APIs. Usually the default.<br />
---| "abstract" Describes ideas, but no concrete implementation exists.<br />
---| "typedef" Custom on-the-spot types, like function protocols or array types.<br />
<br />
---@alias Set<T> {[T]: true}<br />
<br />
---@class docs.DocModel<br />
---@field kind docs.ModelKind<br />
---@field name string?<br />
---@field prefixHint string?<br />
---@field attributes Set<string><br />
---@field origin docs.ModelOrigin<br />
<br />
---@class docs.FieldModel : docs.DocModel<br />
---@field kind "field"<br />
---@field canRead boolean<br />
---@field canWrite boolean<br />
---@field readType docs.TypeModel?<br />
---@field writeType docs.TypeModel?<br />
<br />
---@class docs.MethodModel : docs.DocModel<br />
---@field kind "method"<br />
---@field signatures docs.MethodSignature[]<br />
---@field isStatic boolean<br />
<br />
---@class docs.MethodSignature.Parameter<br />
---@field name string<br />
---@field type docs.TypeModel<br />
---@field vararg boolean?<br />
<br />
---@class docs.MethodSignature<br />
---@field returns docs.TypeModel[]<br />
---@field parameters docs.MethodSignature.Parameter[]<br />
<br />
---@class docs.TypeModel : docs.DocModel<br />
---@field kind "type"<br />
---@field typeKind "explicit" | "union"<br />
<br />
---@class docs.ExplicitType : docs.TypeModel<br />
---@field typeKind "explicit"<br />
---@field link string?<br />
<br />
---@class docs.UnionType : docs.TypeModel<br />
---@field typeKind "union"<br />
---@field anyOf docs.TypeModel[]<br />
<br />
---@type metatable<br />
local type_meta = {<br />
__tostring = function (t)<br />
return ("<type %s from %s>"):format(t.name or '(anonymous)', t.origin)<br />
end<br />
}<br />
<br />
---@class docs.spool : docs.DocModel<br />
---@field src string<br />
---@field cursor integer<br />
---@field cursorNext integer?<br />
local spool = {}<br />
<br />
---Create a new spool.<br />
---@param src string<br />
---@return docs.spool<br />
function spool.new(src)<br />
return setmetatable({<br />
src = src,<br />
cursor = 1<br />
}, {__index = spool})<br />
end<br />
<br />
---@return integer cursor<br />
function spool:consumeSpace()<br />
self.cursor = self.src:match("%s*()", self.cursor)<br />
return self.cursor<br />
end<br />
<br />
local unpack = unpack or table.unpack -- 5.2 compat<br />
<br />
---Starts matching from the current cursor position, and recieves the next cursor position from a position capture.<br />
---@param pattern string<br />
---@param noMatchMsg string Format pattern with 1 %d to hold the cursor value.<br />
---@return any ...<br />
function spool:matchc(pattern, noMatchMsg)<br />
local results = {self.src:match(pattern, self.cursor)}<br />
if #results == 0 then error(noMatchMsg:format(self.cursor)) end<br />
self.cursorNext = results[#results]<br />
results[#results] = nil<br />
return unpack(results)<br />
end<br />
<br />
---@return string<br />
function spool:peek()<br />
return self.src:sub(self.cursor, self.cursor)<br />
end<br />
<br />
function spool:adv()<br />
if self:isAtEOF() then return end<br />
self.cursor = self.cursor + 1<br />
end<br />
<br />
function spool:matchadv(pattern)<br />
local _, to = self.src:find(pattern, self.cursor)<br />
if to then<br />
self.cursor = to + 1<br />
return true<br />
end<br />
return false<br />
end<br />
<br />
function spool:commit()<br />
if not self.cursorNext then error "spool:commit(): Nothing to commit" end<br />
self.cursor = self.cursorNext<br />
self.cursorNext = nil<br />
end<br />
<br />
function spool:isAtEOF() return self.cursor > #self.src end<br />
<br />
local LUA_TYPES_URL = "https://www.lua.org/manual/5.2/manual.html#2.1"<br />
<br />
---@type table<string, docs.ExplicitType><br />
local typeDefinitions = {}<br />
---@type table<string, string><br />
local typeAlias = {}<br />
local types = setmetatable({}, {<br />
__index = function (t, k)<br />
local resolvedName = k<br />
local i = 0<br />
while typeAlias[resolvedName] do<br />
i = i + 1<br />
if i > 10 then error "internal: alias chain too long" end<br />
resolvedName = typeAlias[resolvedName]<br />
end<br />
return typeDefinitions[resolvedName]<br />
end<br />
})<br />
<br />
---@param name string<br />
---@param origin docs.ModelOrigin<br />
---@param link string?<br />
---@return docs.ExplicitType<br />
local function newExplicitType(name, origin, link)<br />
if typeDefinitions[name] then error "Type already exists" end<br />
---@type docs.ExplicitType<br />
local t = setmetatable({<br />
kind = "type",<br />
typeKind = "explicit",<br />
name = name,<br />
attributes = {},<br />
origin = origin,<br />
link = link<br />
}, type_meta)<br />
typeDefinitions[name] = t<br />
return t<br />
end<br />
<br />
---@param anyOf docs.TypeModel[]<br />
---@return docs.UnionType<br />
local function newUnionType(anyOf)<br />
local function flatten(typ)<br />
if not typ.kind or typ.typeKind == "union" then<br />
local iterator<br />
if not typ.kind then<br />
iterator = typ<br />
else<br />
iterator = typ.anyOf<br />
end<br />
local seen = {}<br />
local res = {}<br />
for _, typ2 in ipairs(iterator) do<br />
for _, v in ipairs(flatten(typ2)) do<br />
if not seen[v] then<br />
res[#res + 1] = v<br />
seen[v] = true<br />
end<br />
end<br />
end<br />
return res<br />
elseif typ.typeKind == "explicit" then<br />
return { typ }<br />
end<br />
error "No type"<br />
end<br />
---@type docs.UnionType<br />
return setmetatable({<br />
anyOf = flatten(anyOf),<br />
attributes = {},<br />
kind = "type",<br />
origin = "abstract",<br />
typeKind = "union"<br />
}, {<br />
__tostring = function (t)<br />
local chunks = {}<br />
for _, type in ipairs(t.anyOf) do<br />
chunks[#chunks+1] = tostring(type)<br />
end<br />
return table.concat(chunks, ' | ')<br />
end<br />
})<br />
end<br />
<br />
---@param name string<br />
---@param origin docs.ModelOrigin<br />
---@return docs.ExplicitType<br />
local function getOrDefineType(name, origin)<br />
local t = types[name]<br />
if t then return t end<br />
return newExplicitType(name, origin, name)<br />
end<br />
<br />
---Create a new type definition type.<br />
---@param typedefname string without #<br />
---@return docs.TypeModel<br />
local function newTypedef(typedefname)<br />
local prefixed = "#"..typedefname<br />
if typeDefinitions[prefixed] then return typeDefinitions[prefixed] end<br />
---@type docs.ExplicitType<br />
local t = setmetatable({<br />
kind = "type",<br />
typeKind = "explicit",<br />
name = typedefname,<br />
attributes = {},<br />
origin = "typedef",<br />
link = "#typedef_"..typedefname<br />
}, type_meta)<br />
typeDefinitions[prefixed] = t<br />
return t<br />
end<br />
<br />
do -- builtin types<br />
<br />
-- currying<br />
---@param sourceName string<br />
---@return fun(list: string[])<br />
local function alias(sourceName)<br />
return function(list)<br />
for _, v in ipairs(list) do<br />
typeAlias[v] = sourceName<br />
end<br />
end<br />
end<br />
<br />
newExplicitType("any", "abstract")<br />
alias "any" { "AnyType" }<br />
newExplicitType("void", "abstract")<br />
newExplicitType("nil", "Lua", LUA_TYPES_URL)<br />
alias "nil" { "null" }<br />
newExplicitType("boolean", "Lua", LUA_TYPES_URL)<br />
alias "boolean" { "Boolean" }<br />
newExplicitType("number", "Lua", LUA_TYPES_URL)<br />
alias "number" { "Number", "double", "float" }<br />
newExplicitType("integer", "Lua", LUA_TYPES_URL)<br />
alias "integer" { "Integer" }<br />
newExplicitType("string", "Lua", LUA_TYPES_URL)<br />
alias "string" { "String" }<br />
newExplicitType("function", "Lua", LUA_TYPES_URL)<br />
alias "function" { "Function" }<br />
newExplicitType("userdata", "Lua", LUA_TYPES_URL)<br />
alias "userdata" { "Userdata" }<br />
newExplicitType("table", "Lua", LUA_TYPES_URL)<br />
alias "table" { "Table" }<br />
end<br />
<br />
---@param s docs.spool<br />
local function parseComment(s)<br />
s:matchc("%*/()", "No end of comment found")<br />
s:commit()<br />
end<br />
<br />
---@param s docs.spool<br />
---@return docs.TypeModel<br />
local function parseSimpleType(s)<br />
if s:isAtEOF() then error("Expected a type at position " .. s.cursor .. " but instead found nothing") end<br />
local prefix = s:peek()<br />
if prefix == "#" then<br />
s:adv()<br />
local typename = s:matchc("^([a-zA-Z0-9]+) ?()", "Expected a typedef name at position %d, but found nothing after the #")<br />
s:commit()<br />
return newTypedef(typename)<br />
end<br />
local typename = s:matchc("^([a-zA-Z0-9]+) ?()", "Expected a type name at position %d, but found nothing")<br />
s:commit()<br />
local t = getOrDefineType(typename, "Figura")<br />
return t<br />
end<br />
<br />
---@param s docs.spool<br />
local function parseType(s)<br />
local t = parseSimpleType(s)<br />
s:consumeSpace()<br />
local nextC = s:peek()<br />
if nextC == '|' then<br />
local unions = {t}<br />
while nextC == '|' do<br />
s:adv()<br />
s:consumeSpace()<br />
unions[#unions+1] = parseSimpleType(s)<br />
s:consumeSpace()<br />
nextC = s:peek()<br />
end<br />
return newUnionType(unions)<br />
else<br />
return t<br />
end<br />
end<br />
<br />
local function noop() end<br />
<br />
---@type table<string, fun(line: string, model: docs.DocModel)><br />
local sharedModifiers = {<br />
prefixHint = function (line, model)<br />
if model.prefixHint then error "duplicate prefixHint declaration" end<br />
model.prefixHint = line<br />
end<br />
}<br />
---@type table<string, fun(model: docs.DocModel)><br />
local sharedAttributes = {<br />
global = noop<br />
}<br />
<br />
---@type table<string, fun(line: string, model: docs.MethodModel)><br />
local methodModifiers = {<br />
}<br />
methodModifiers = setmetatable(methodModifiers, {__index = sharedModifiers})<br />
---@type table<string, fun(model: docs.MethodModel)><br />
local methodAttributes = {<br />
static = function (model)<br />
model.isStatic = true<br />
end,<br />
hostOnly = noop<br />
}<br />
methodAttributes = setmetatable(methodAttributes, {__index = sharedAttributes})<br />
<br />
---@type table<string, fun(line: string, model: docs.FieldModel)><br />
local fieldModifiers = {<br />
["type"] = function (line, model)<br />
local s = spool.new(line)<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error "expected end of statement after field type" end<br />
model.readType = t<br />
model.writeType = t<br />
end,<br />
["readType"] = function (line, model)<br />
local s = spool.new(line)<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error "expected end of statement after field readType" end<br />
model.readType = t<br />
end,<br />
["writeType"] = function (line, model)<br />
local s = spool.new(line)<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error "expected end of statement after field writeType" end<br />
model.writeType = t<br />
end,<br />
}<br />
fieldModifiers = setmetatable(fieldModifiers, {__index = sharedModifiers})<br />
---@type table<string, fun(model: docs.FieldModel)><br />
local fieldAttributes = {<br />
readOnly = function (model)<br />
model.canWrite = false<br />
end,<br />
writeOnly = function (model)<br />
model.canRead = false<br />
end<br />
}<br />
fieldAttributes = setmetatable(fieldAttributes, {__index = sharedAttributes})<br />
<br />
---@param sigtext string<br />
local function parseMethodSignature(sigtext)<br />
local s = spool.new(sigtext)<br />
<br />
---@type docs.MethodSignature<br />
local model = {<br />
returns = {},<br />
parameters = {}<br />
}<br />
<br />
local function parseParameter(assumeV)<br />
---@type docs.MethodSignature.Parameter<br />
local param = setmetatable({<br />
name = "",<br />
type = typeDefinitions.void,<br />
vararg = false<br />
}, {<br />
__tostring = function (t)<br />
return ("<param %s (%s)>"):format(t.name, tostring(t.type))<br />
end<br />
})<br />
if assumeV then<br />
param.name = "..."<br />
param.vararg = true<br />
else<br />
-- already consumed: 'parameter '<br />
if s:matchadv("^%.%.%. ?") then<br />
param.name = "..."<br />
param.vararg = true<br />
else<br />
param.name = s:matchc("^([a-zA-Z0-9]+) ?()", "Expected parameter name at %d but found nothing")<br />
s:commit()<br />
end<br />
end<br />
s:consumeSpace()<br />
param.type = parseType(s)<br />
s:consumeSpace()<br />
if not s:matchadv('^;') then error("Expected a semicolon to end parameter declaration at position " .. s.cursor) end<br />
model.parameters[#model.parameters+1] = param<br />
end<br />
<br />
local function parseReturns()<br />
-- already consumed: 'returns '<br />
model.returns[#model.returns+1] = parseType(s)<br />
s:consumeSpace()<br />
while s:matchadv('^,') do<br />
s:consumeSpace()<br />
model.returns[#model.returns+1] = parseType(s)<br />
s:consumeSpace()<br />
end<br />
if not s:matchadv('^;') then error("Expected a semicolon to end returns declaration at position " .. s.cursor) end<br />
end<br />
<br />
local function parseStmt()<br />
if s:matchadv "^/%*" then<br />
return parseComment(s)<br />
end<br />
if s:matchadv "^returns " then<br />
return parseReturns()<br />
end<br />
if s:matchadv "^parameter%.%.%." then<br />
return parseParameter(true)<br />
end<br />
if s:matchadv "^parameter " then<br />
return parseParameter()<br />
end<br />
error("No valid signature statement at " .. s.cursor)<br />
end<br />
<br />
local function parse()<br />
s:consumeSpace()<br />
while not s:isAtEOF() do<br />
parseStmt()<br />
s:consumeSpace()<br />
end<br />
end<br />
parse()<br />
return model<br />
end<br />
<br />
---@param docstr string<br />
local function parseMethod(docstr)<br />
local s = spool.new(docstr)<br />
<br />
---@type docs.MethodModel<br />
local model = {<br />
kind = "method",<br />
attributes = {},<br />
isStatic = false,<br />
name = "<unnamed>",<br />
origin = "Figura",<br />
signatures = {},<br />
}<br />
local parseTopLevelStmt, parseMethodHeader, parseSignatureOuter<br />
local blockKw = {}<br />
<br />
function parseSignatureOuter()<br />
s:consumeSpace()<br />
---@type string<br />
local block_content = s:matchc("^(%b{})%s*;()", "Expected a bracketed block after 'signature' at position %d")<br />
local inside = block_content:sub(2, -2)<br />
local sig = parseMethodSignature(inside)<br />
model.signatures[#model.signatures+1] = sig<br />
s:commit()<br />
end<br />
blockKw.signature = parseSignatureOuter<br />
<br />
function parseMethodHeader()<br />
local name = s:matchc("^([^%s;]+) ?()", "Expected method name at %d")<br />
model.name = name<br />
s:commit()<br />
s:consumeSpace()<br />
local peek = s:peek()<br />
while #peek ~= 0 and peek ~= ';' do<br />
local attr = s:matchc("^([^%s;]+) ?()", "Expected something else!")<br />
if not methodAttributes[attr] then<br />
error(("Unknown method attribute '%s' at position %d in method header"):format(attr, s.cursor))<br />
end<br />
methodAttributes[attr](model)<br />
model.attributes[attr] = true<br />
s:commit()<br />
s:consumeSpace()<br />
peek = s:peek()<br />
end<br />
if peek == ';' then<br />
s:adv() -- advance past the ;<br />
else<br />
error("Reached end of method documentation while parsing header")<br />
end<br />
end<br />
<br />
function parseTopLevelStmt()<br />
local startAt = s.cursor<br />
---@type string<br />
local action = s:matchc("^([^%s;]+) ?()", "Expected a modifier or block keyword, but got nothing instead at position %d")<br />
s:commit()<br />
if methodModifiers[action] then<br />
---@type string<br />
local remainder = s:matchc("^(.-);%s*()", "Expected semicolon to end statement around %d")<br />
s:commit()<br />
return methodModifiers[action](remainder, model)<br />
end<br />
if blockKw[action] then return blockKw[action]() end<br />
error(("Expected a modifier or block keyword, but got '%s' instead at position %d"):format(action, startAt))<br />
end<br />
<br />
local function parse()<br />
s:consumeSpace()<br />
parseMethodHeader()<br />
s:consumeSpace()<br />
while not s:isAtEOF() do<br />
parseTopLevelStmt()<br />
s:consumeSpace()<br />
end<br />
end<br />
<br />
parse()<br />
return model<br />
end<br />
<br />
---@param docstr string<br />
---@return docs.FieldModel<br />
local function parseField(docstr)<br />
local s = spool.new(docstr)<br />
<br />
---@type docs.FieldModel<br />
local model = {<br />
kind = "field",<br />
attributes = {},<br />
name = "<unnamed>",<br />
origin = "Figura",<br />
canRead = true,<br />
canWrite = true<br />
}<br />
<br />
local parseTopLevelStmt, parseFieldHeader, parseSignatureOuter<br />
<br />
function parseFieldHeader()<br />
local name = s:matchc("^([^%s;]+) ?()", "Expected field name at %d")<br />
model.name = name<br />
s:commit()<br />
s:consumeSpace()<br />
local peek = s:peek()<br />
while #peek ~= 0 and peek ~= ';' do<br />
local attr = s:matchc("^([^%s;]+) ?()", "Expected something else!")<br />
if not fieldAttributes[attr] then<br />
error(("Unknown field attribute '%s' at position %d in field header"):format(attr, s.cursor))<br />
end<br />
fieldAttributes[attr](model)<br />
model.attributes[attr] = true<br />
s:commit()<br />
s:consumeSpace()<br />
peek = s:peek()<br />
end<br />
if peek == ';' then<br />
s:adv() -- advance past the ;<br />
else<br />
error("Reached end of field documentation while parsing header")<br />
end<br />
end<br />
<br />
function parseTopLevelStmt()<br />
local startAt = s.cursor<br />
---@type string<br />
local action = s:matchc("^([^%s;]+) ?()", "Expected a modifier, but got nothing instead at position %d")<br />
s:commit()<br />
if fieldModifiers[action] then<br />
---@type string<br />
local remainder = s:matchc("^(.-);%s*()", "Expected semicolon to end statement around %d")<br />
s:commit()<br />
return fieldModifiers[action](remainder, model)<br />
end<br />
error(("Expected a modifier, but got '%s' instead at position %d"):format(action, startAt))<br />
end<br />
<br />
local function parse()<br />
s:consumeSpace()<br />
parseFieldHeader()<br />
s:consumeSpace()<br />
while not s:isAtEOF() do<br />
parseTopLevelStmt()<br />
s:consumeSpace()<br />
end<br />
end<br />
<br />
parse()<br />
return model<br />
end<br />
<br />
local renderType<br />
<br />
---@param typeM docs.ExplicitType<br />
---@return string<br />
local function renderTypeExplicit(typeM)<br />
local formatstr<br />
if not typeM.link then<br />
formatstr = [=[<span class="lua-type-explicit" data-name="$TypeName" $ExtraAttr>$TypeName</span>]=]<br />
elseif typeM.link:find("^https?://") then<br />
formatstr = [=[<span class="lua-type-explicit" data-name="$TypeName" $ExtraAttr>[$Link $TypeName]</span>]=]<br />
else<br />
formatstr = [=[<span class="lua-type-explicit" data-name="$TypeName" $ExtraAttr>[[$Link|$TypeName]]</span>]=]<br />
end<br />
local replacements = {<br />
Link = typeM.link,<br />
TypeName = typeM.name,<br />
ExtraAttr = ""<br />
}<br />
local formatted = formatstr:gsub("%$([a-zA-Z]+)", replacements)<br />
return formatted<br />
end<br />
<br />
---@param typeM docs.UnionType<br />
---@return string<br />
local function renderTypeUnion(typeM)<br />
if #typeM.anyOf == 1 then return renderType(typeM.anyOf[1]) end<br />
if #typeM.anyOf == 2 then<br />
-- todo: add ? for optionals<br />
end<br />
local formatstr = [=[<span class="lua-type-union">%s</span>]=]<br />
local separator = [=[<span class="lua-type-union-bar"></span>]=]<br />
local chunks = {}<br />
for _, t in ipairs(typeM.anyOf) do<br />
chunks[#chunks+1] = renderType(t)<br />
end<br />
return formatstr:format(table.concat(chunks, separator))<br />
end<br />
<br />
---@param typeM docs.TypeModel<br />
---@return string<br />
function renderType(typeM)<br />
if typeM.typeKind == "explicit" then<br />
---@cast typeM docs.ExplicitType<br />
return renderTypeExplicit(typeM)<br />
elseif typeM.typeKind == "union" then<br />
---@cast typeM docs.UnionType<br />
return renderTypeUnion(typeM)<br />
end<br />
error(("An internal error occured: unsure how to render a %s type"):format(tostring(typeM.typeKind)))<br />
end<br />
<br />
---@param o any<br />
---@param i number?<br />
local function printFancy(o, i)<br />
i = i or 2<br />
local indent = (" "):rep(i)<br />
if type(o) == "table" then<br />
if getmetatable(o) and getmetatable(o).__tostring then<br />
return tostring(o)<br />
end<br />
local b = "{\n"<br />
for k, v in pairs(o) do<br />
b = b .. indent .. printFancy(k, i + 2) .. " = " .. printFancy(v, i + 2) .. ",\n"<br />
end<br />
b = b .. (" "):rep(i - 2) .. "}"<br />
return b<br />
else<br />
return tostring(o)<br />
end<br />
end<br />
<br />
local function parseAndRenderType(frame)<br />
local input_args = frame:getParent().args<br />
local nargs = 0<br />
while input_args[nargs + 1] do nargs = nargs + 1 end<br />
if nargs == 0 then error "Need to specify at least one type" end<br />
<br />
if nargs == 1 then<br />
local s = spool.new(input_args[1])<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error("Expected end of type at position " .. s.cursor) end<br />
return renderType(t)<br />
else<br />
local tabulated = {}<br />
for i = 1, nargs do tabulated[i] = input_args[i] end<br />
local s = spool.new(table.concat(tabulated, "|"))<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error("Expected end of type at position " .. s.cursor) end<br />
return renderType(t)<br />
end<br />
end<br />
<br />
-- local m = parseField [[<br />
-- player global readOnly;<br />
-- type PlayerAPI;<br />
-- ]]<br />
-- print(printFancy(m))<br />
<br />
return {<br />
type = parseAndRenderType<br />
}</div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=Module:Signatures&diff=872
Module:Signatures
2025-03-31T01:19:26Z
<p>PenguinEncounter: </p>
<hr />
<div>-- a MediaWiki module<br />
<br />
--[[<br />
Syntax description:<br />
<name> <attr...> ...;;<br />
<modName> [modSyn];;<br />
]]<br />
<br />
---@alias docs.ModelKind "field" | "method" | "type"<br />
<br />
---Origin of this documentation item.<br />
---@alias docs.ModelOrigin<br />
---| "Lua" Lua 5.2 built-in types and APIs.<br />
---| "Figura" Figura types and APIs. Usually the default.<br />
---| "abstract" Describes ideas, but no concrete implementation exists.<br />
---| "typedef" Custom on-the-spot types, like function protocols or array types.<br />
<br />
---@alias Set<T> {[T]: true}<br />
<br />
---@class docs.DocModel<br />
---@field kind docs.ModelKind<br />
---@field name string?<br />
---@field prefixHint string?<br />
---@field attributes Set<string><br />
---@field origin docs.ModelOrigin<br />
<br />
---@class docs.FieldModel : docs.DocModel<br />
---@field kind "field"<br />
---@field canRead boolean<br />
---@field canWrite boolean<br />
---@field readType docs.TypeModel?<br />
---@field writeType docs.TypeModel?<br />
<br />
---@class docs.MethodModel : docs.DocModel<br />
---@field kind "method"<br />
---@field signatures docs.MethodSignature[]<br />
---@field isStatic boolean<br />
<br />
---@class docs.MethodSignature.Parameter<br />
---@field name string<br />
---@field type docs.TypeModel<br />
---@field vararg boolean?<br />
<br />
---@class docs.MethodSignature<br />
---@field returns docs.TypeModel[]<br />
---@field parameters docs.MethodSignature.Parameter[]<br />
<br />
---@class docs.TypeModel : docs.DocModel<br />
---@field kind "type"<br />
---@field typeKind "explicit" | "union"<br />
<br />
---@class docs.ExplicitType : docs.TypeModel<br />
---@field typeKind "explicit"<br />
---@field link string?<br />
<br />
---@class docs.UnionType : docs.TypeModel<br />
---@field typeKind "union"<br />
---@field anyOf docs.TypeModel[]<br />
<br />
---@type metatable<br />
local type_meta = {<br />
__tostring = function (t)<br />
return ("<type %s from %s>"):format(t.name or '(anonymous)', t.origin)<br />
end<br />
}<br />
<br />
---@class docs.spool : docs.DocModel<br />
---@field src string<br />
---@field cursor integer<br />
---@field cursorNext integer?<br />
local spool = {}<br />
<br />
---Create a new spool.<br />
---@param src string<br />
---@return docs.spool<br />
function spool.new(src)<br />
return setmetatable({<br />
src = src,<br />
cursor = 1<br />
}, {__index = spool})<br />
end<br />
<br />
---@return integer cursor<br />
function spool:consumeSpace()<br />
self.cursor = self.src:match("%s*()", self.cursor)<br />
return self.cursor<br />
end<br />
<br />
local unpack = unpack or table.unpack -- 5.2 compat<br />
<br />
---Starts matching from the current cursor position, and recieves the next cursor position from a position capture.<br />
---@param pattern string<br />
---@param noMatchMsg string Format pattern with 1 %d to hold the cursor value.<br />
---@return any ...<br />
function spool:matchc(pattern, noMatchMsg)<br />
local results = {self.src:match(pattern, self.cursor)}<br />
if #results == 0 then error(noMatchMsg:format(self.cursor)) end<br />
self.cursorNext = results[#results]<br />
results[#results] = nil<br />
return unpack(results)<br />
end<br />
<br />
---@return string<br />
function spool:peek()<br />
return self.src:sub(self.cursor, self.cursor)<br />
end<br />
<br />
function spool:adv()<br />
if self:isAtEOF() then return end<br />
self.cursor = self.cursor + 1<br />
end<br />
<br />
function spool:matchadv(pattern)<br />
local _, to = self.src:find(pattern, self.cursor)<br />
if to then<br />
self.cursor = to + 1<br />
return true<br />
end<br />
return false<br />
end<br />
<br />
function spool:commit()<br />
if not self.cursorNext then error "spool:commit(): Nothing to commit" end<br />
self.cursor = self.cursorNext<br />
self.cursorNext = nil<br />
end<br />
<br />
function spool:isAtEOF() return self.cursor > #self.src end<br />
<br />
local LUA_TYPES_URL = "https://www.lua.org/manual/5.2/manual.html#2.1"<br />
<br />
---@type table<string, docs.ExplicitType><br />
local typeDefinitions = {}<br />
---@type table<string, string><br />
local typeAlias = {}<br />
local types = setmetatable({}, {<br />
__index = function (t, k)<br />
local resolvedName = k<br />
local i = 0<br />
while typeAlias[resolvedName] do<br />
i = i + 1<br />
if i > 10 then error "internal: alias chain too long" end<br />
resolvedName = typeAlias[resolvedName]<br />
end<br />
return typeDefinitions[resolvedName]<br />
end<br />
})<br />
<br />
---@param name string<br />
---@param origin docs.ModelOrigin<br />
---@param link string?<br />
---@return docs.ExplicitType<br />
local function newExplicitType(name, origin, link)<br />
if typeDefinitions[name] then error "Type already exists" end<br />
---@type docs.ExplicitType<br />
local t = setmetatable({<br />
kind = "type",<br />
typeKind = "explicit",<br />
name = name,<br />
attributes = {},<br />
origin = origin,<br />
link = link<br />
}, type_meta)<br />
typeDefinitions[name] = t<br />
return t<br />
end<br />
<br />
---@param anyOf docs.TypeModel[]<br />
---@return docs.UnionType<br />
local function newUnionType(anyOf)<br />
local function flatten(typ)<br />
if not typ.kind or typ.typeKind == "union" then<br />
local iterator<br />
if not typ.kind then<br />
iterator = typ<br />
else<br />
iterator = typ.anyOf<br />
end<br />
local seen = {}<br />
local res = {}<br />
for _, typ2 in ipairs(iterator) do<br />
for _, v in ipairs(flatten(typ2)) do<br />
if not seen[v] then<br />
res[#res + 1] = v<br />
seen[v] = true<br />
end<br />
end<br />
end<br />
return res<br />
elseif typ.typeKind == "explicit" then<br />
return { typ }<br />
end<br />
error "No type"<br />
end<br />
---@type docs.UnionType<br />
return setmetatable({<br />
anyOf = flatten(anyOf),<br />
attributes = {},<br />
kind = "type",<br />
origin = "abstract",<br />
typeKind = "union"<br />
}, {<br />
__tostring = function (t)<br />
local chunks = {}<br />
for _, type in ipairs(t.anyOf) do<br />
chunks[#chunks+1] = tostring(type)<br />
end<br />
return table.concat(chunks, ' | ')<br />
end<br />
})<br />
end<br />
<br />
---@param name string<br />
---@param origin docs.ModelOrigin<br />
---@return docs.ExplicitType<br />
local function getOrDefineType(name, origin)<br />
local t = types[name]<br />
if t then return t end<br />
return newExplicitType(name, origin, name)<br />
end<br />
<br />
---Create a new type definition type.<br />
---@param typedefname string without #<br />
---@return docs.TypeModel<br />
local function newTypedef(typedefname)<br />
local prefixed = "#"..typedefname<br />
if typeDefinitions[prefixed] then return typeDefinitions[prefixed] end<br />
---@type docs.ExplicitType<br />
local t = setmetatable({<br />
kind = "type",<br />
typeKind = "explicit",<br />
name = typedefname,<br />
attributes = {},<br />
origin = "typedef",<br />
link = "#typedef_"..typedefname<br />
}, type_meta)<br />
typeDefinitions[prefixed] = t<br />
return t<br />
end<br />
<br />
do -- builtin types<br />
<br />
-- currying<br />
---@param sourceName string<br />
---@return fun(list: string[])<br />
local function alias(sourceName)<br />
return function(list)<br />
for _, v in ipairs(list) do<br />
typeAlias[v] = sourceName<br />
end<br />
end<br />
end<br />
<br />
newExplicitType("any", "abstract")<br />
alias "any" { "AnyType" }<br />
newExplicitType("void", "abstract")<br />
newExplicitType("nil", "Lua", LUA_TYPES_URL)<br />
alias "nil" { "null" }<br />
newExplicitType("boolean", "Lua", LUA_TYPES_URL)<br />
alias "boolean" { "Boolean" }<br />
newExplicitType("number", "Lua", LUA_TYPES_URL)<br />
alias "number" { "Number", "double", "float" }<br />
newExplicitType("integer", "Lua", LUA_TYPES_URL)<br />
alias "integer" { "Integer" }<br />
newExplicitType("string", "Lua", LUA_TYPES_URL)<br />
alias "string" { "String" }<br />
newExplicitType("function", "Lua", LUA_TYPES_URL)<br />
alias "function" { "Function" }<br />
newExplicitType("userdata", "Lua", LUA_TYPES_URL)<br />
alias "userdata" { "Userdata" }<br />
newExplicitType("table", "Lua", LUA_TYPES_URL)<br />
alias "table" { "Table" }<br />
end<br />
<br />
---@param s docs.spool<br />
local function parseComment(s)<br />
s:matchc("%*/()", "No end of comment found")<br />
s:commit()<br />
end<br />
<br />
---@param s docs.spool<br />
---@return docs.TypeModel<br />
local function parseSimpleType(s)<br />
if s:isAtEOF() then error("Expected a type at position " .. s.cursor .. " but instead found nothing") end<br />
local prefix = s:peek()<br />
if prefix == "#" then<br />
s:adv()<br />
local typename = s:matchc("^([a-zA-Z0-9]+) ?()", "Expected a typedef name at position %d, but found nothing after the #")<br />
s:commit()<br />
return newTypedef(typename)<br />
end<br />
local typename = s:matchc("^([a-zA-Z0-9]+) ?()", "Expected a type name at position %d, but found nothing")<br />
s:commit()<br />
local t = getOrDefineType(typename, "Figura")<br />
return t<br />
end<br />
<br />
---@param s docs.spool<br />
local function parseType(s)<br />
local t = parseSimpleType(s)<br />
s:consumeSpace()<br />
local nextC = s:peek()<br />
if nextC == '|' then<br />
local unions = {t}<br />
while nextC == '|' do<br />
s:adv()<br />
s:consumeSpace()<br />
unions[#unions+1] = parseSimpleType(s)<br />
s:consumeSpace()<br />
nextC = s:peek()<br />
end<br />
return newUnionType(unions)<br />
else<br />
return t<br />
end<br />
end<br />
<br />
local function noop() end<br />
<br />
---@type table<string, fun(line: string, model: docs.DocModel)><br />
local sharedModifiers = {<br />
prefixHint = function (line, model)<br />
if model.prefixHint then error "duplicate prefixHint declaration" end<br />
model.prefixHint = line<br />
end<br />
}<br />
---@type table<string, fun(model: docs.DocModel)><br />
local sharedAttributes = {<br />
global = noop<br />
}<br />
<br />
---@type table<string, fun(line: string, model: docs.MethodModel)><br />
local methodModifiers = {<br />
}<br />
methodModifiers = setmetatable(methodModifiers, {__index = sharedModifiers})<br />
---@type table<string, fun(model: docs.MethodModel)><br />
local methodAttributes = {<br />
static = function (model)<br />
model.isStatic = true<br />
end,<br />
hostOnly = noop<br />
}<br />
methodAttributes = setmetatable(methodAttributes, {__index = sharedAttributes})<br />
<br />
---@type table<string, fun(line: string, model: docs.FieldModel)><br />
local fieldModifiers = {<br />
["type"] = function (line, model)<br />
local s = spool.new(line)<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error "expected end of statement after field type" end<br />
model.readType = t<br />
model.writeType = t<br />
end,<br />
["readType"] = function (line, model)<br />
local s = spool.new(line)<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error "expected end of statement after field readType" end<br />
model.readType = t<br />
end,<br />
["writeType"] = function (line, model)<br />
local s = spool.new(line)<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error "expected end of statement after field writeType" end<br />
model.writeType = t<br />
end,<br />
}<br />
fieldModifiers = setmetatable(fieldModifiers, {__index = sharedModifiers})<br />
---@type table<string, fun(model: docs.FieldModel)><br />
local fieldAttributes = {<br />
readOnly = function (model)<br />
model.canWrite = false<br />
end,<br />
writeOnly = function (model)<br />
model.canRead = false<br />
end<br />
}<br />
fieldAttributes = setmetatable(fieldAttributes, {__index = sharedAttributes})<br />
<br />
---@param sigtext string<br />
local function parseMethodSignature(sigtext)<br />
local s = spool.new(sigtext)<br />
<br />
---@type docs.MethodSignature<br />
local model = {<br />
returns = {},<br />
parameters = {}<br />
}<br />
<br />
local function parseParameter(assumeV)<br />
---@type docs.MethodSignature.Parameter<br />
local param = setmetatable({<br />
name = "",<br />
type = typeDefinitions.void,<br />
vararg = false<br />
}, {<br />
__tostring = function (t)<br />
return ("<param %s (%s)>"):format(t.name, tostring(t.type))<br />
end<br />
})<br />
if assumeV then<br />
param.name = "..."<br />
param.vararg = true<br />
else<br />
-- already consumed: 'parameter '<br />
if s:matchadv("^%.%.%. ?") then<br />
param.name = "..."<br />
param.vararg = true<br />
else<br />
param.name = s:matchc("^([a-zA-Z0-9]+) ?()", "Expected parameter name at %d but found nothing")<br />
s:commit()<br />
end<br />
end<br />
s:consumeSpace()<br />
param.type = parseType(s)<br />
s:consumeSpace()<br />
if not s:matchadv('^;') then error("Expected a semicolon to end parameter declaration at position " .. s.cursor) end<br />
model.parameters[#model.parameters+1] = param<br />
end<br />
<br />
local function parseReturns()<br />
-- already consumed: 'returns '<br />
model.returns[#model.returns+1] = parseType(s)<br />
s:consumeSpace()<br />
while s:matchadv('^,') do<br />
s:consumeSpace()<br />
model.returns[#model.returns+1] = parseType(s)<br />
s:consumeSpace()<br />
end<br />
if not s:matchadv('^;') then error("Expected a semicolon to end returns declaration at position " .. s.cursor) end<br />
end<br />
<br />
local function parseStmt()<br />
if s:matchadv "^/%*" then<br />
return parseComment(s)<br />
end<br />
if s:matchadv "^returns " then<br />
return parseReturns()<br />
end<br />
if s:matchadv "^parameter%.%.%." then<br />
return parseParameter(true)<br />
end<br />
if s:matchadv "^parameter " then<br />
return parseParameter()<br />
end<br />
error("No valid signature statement at " .. s.cursor)<br />
end<br />
<br />
local function parse()<br />
s:consumeSpace()<br />
while not s:isAtEOF() do<br />
parseStmt()<br />
s:consumeSpace()<br />
end<br />
end<br />
parse()<br />
return model<br />
end<br />
<br />
---@param docstr string<br />
local function parseMethod(docstr)<br />
local s = spool.new(docstr)<br />
<br />
---@type docs.MethodModel<br />
local model = {<br />
kind = "method",<br />
attributes = {},<br />
isStatic = false,<br />
name = "<unnamed>",<br />
origin = "Figura",<br />
signatures = {},<br />
}<br />
local parseTopLevelStmt, parseMethodHeader, parseSignatureOuter<br />
local blockKw = {}<br />
<br />
function parseSignatureOuter()<br />
s:consumeSpace()<br />
---@type string<br />
local block_content = s:matchc("^(%b{})%s*;()", "Expected a bracketed block after 'signature' at position %d")<br />
local inside = block_content:sub(2, -2)<br />
local sig = parseMethodSignature(inside)<br />
model.signatures[#model.signatures+1] = sig<br />
s:commit()<br />
end<br />
blockKw.signature = parseSignatureOuter<br />
<br />
function parseMethodHeader()<br />
local name = s:matchc("^([^%s;]+) ?()", "Expected method name at %d")<br />
model.name = name<br />
s:commit()<br />
s:consumeSpace()<br />
local peek = s:peek()<br />
while #peek ~= 0 and peek ~= ';' do<br />
local attr = s:matchc("^([^%s;]+) ?()", "Expected something else!")<br />
if not methodAttributes[attr] then<br />
error(("Unknown method attribute '%s' at position %d in method header"):format(attr, s.cursor))<br />
end<br />
methodAttributes[attr](model)<br />
model.attributes[attr] = true<br />
s:commit()<br />
s:consumeSpace()<br />
peek = s:peek()<br />
end<br />
if peek == ';' then<br />
s:adv() -- advance past the ;<br />
else<br />
error("Reached end of method documentation while parsing header")<br />
end<br />
end<br />
<br />
function parseTopLevelStmt()<br />
local startAt = s.cursor<br />
---@type string<br />
local action = s:matchc("^([^%s;]+) ?()", "Expected a modifier or block keyword, but got nothing instead at position %d")<br />
s:commit()<br />
if methodModifiers[action] then<br />
---@type string<br />
local remainder = s:matchc("^(.-);%s*()", "Expected semicolon to end statement around %d")<br />
s:commit()<br />
return methodModifiers[action](remainder, model)<br />
end<br />
if blockKw[action] then return blockKw[action]() end<br />
error(("Expected a modifier or block keyword, but got '%s' instead at position %d"):format(action, startAt))<br />
end<br />
<br />
local function parse()<br />
s:consumeSpace()<br />
parseMethodHeader()<br />
s:consumeSpace()<br />
while not s:isAtEOF() do<br />
parseTopLevelStmt()<br />
s:consumeSpace()<br />
end<br />
end<br />
<br />
parse()<br />
return model<br />
end<br />
<br />
---@param docstr string<br />
---@return docs.FieldModel<br />
local function parseField(docstr)<br />
local s = spool.new(docstr)<br />
<br />
---@type docs.FieldModel<br />
local model = {<br />
kind = "field",<br />
attributes = {},<br />
name = "<unnamed>",<br />
origin = "Figura",<br />
canRead = true,<br />
canWrite = true<br />
}<br />
<br />
local parseTopLevelStmt, parseFieldHeader, parseSignatureOuter<br />
<br />
function parseFieldHeader()<br />
local name = s:matchc("^([^%s;]+) ?()", "Expected field name at %d")<br />
model.name = name<br />
s:commit()<br />
s:consumeSpace()<br />
local peek = s:peek()<br />
while #peek ~= 0 and peek ~= ';' do<br />
local attr = s:matchc("^([^%s;]+) ?()", "Expected something else!")<br />
if not fieldAttributes[attr] then<br />
error(("Unknown field attribute '%s' at position %d in field header"):format(attr, s.cursor))<br />
end<br />
fieldAttributes[attr](model)<br />
model.attributes[attr] = true<br />
s:commit()<br />
s:consumeSpace()<br />
peek = s:peek()<br />
end<br />
if peek == ';' then<br />
s:adv() -- advance past the ;<br />
else<br />
error("Reached end of field documentation while parsing header")<br />
end<br />
end<br />
<br />
function parseTopLevelStmt()<br />
local startAt = s.cursor<br />
---@type string<br />
local action = s:matchc("^([^%s;]+) ?()", "Expected a modifier, but got nothing instead at position %d")<br />
s:commit()<br />
if fieldModifiers[action] then<br />
---@type string<br />
local remainder = s:matchc("^(.-);%s*()", "Expected semicolon to end statement around %d")<br />
s:commit()<br />
return fieldModifiers[action](remainder, model)<br />
end<br />
error(("Expected a modifier, but got '%s' instead at position %d"):format(action, startAt))<br />
end<br />
<br />
local function parse()<br />
s:consumeSpace()<br />
parseFieldHeader()<br />
s:consumeSpace()<br />
while not s:isAtEOF() do<br />
parseTopLevelStmt()<br />
s:consumeSpace()<br />
end<br />
end<br />
<br />
parse()<br />
return model<br />
end<br />
<br />
local renderType<br />
<br />
---@param typeM docs.ExplicitType<br />
---@return string<br />
local function renderTypeExplicit(typeM)<br />
local formatstr<br />
if not typeM.link then<br />
formatstr = [=[<span class="lua-type-explicit" data-name="$TypeName" $ExtraAttr>$TypeName</span>]=]<br />
elseif typeM.link:find("^https?://") then<br />
formatstr = [=[<span class="lua-type-explicit" data-name="$TypeName" $ExtraAttr>[$Link $TypeName]</span>]=]<br />
else<br />
formatstr = [=[<span class="lua-type-explicit" data-name="$TypeName" $ExtraAttr>[[$Link|$TypeName]]</span>]=]<br />
end<br />
local replacements = {<br />
Link = typeM.link,<br />
TypeName = typeM.name,<br />
ExtraAttr = ""<br />
}<br />
local formatted = formatstr:gsub("%$([a-zA-Z]+)", replacements)<br />
return formatted<br />
end<br />
<br />
---@param typeM docs.UnionType<br />
---@return string<br />
local function renderTypeUnion(typeM)<br />
if #typeM.anyOf == 1 then return renderType(typeM.anyOf[1]) end<br />
if #typeM.anyOf == 2 then<br />
-- todo: add ? for optionals<br />
end<br />
local formatstr = [=[<span class="lua-type-union">%s</span>]=]<br />
local separator = [=[<span class="lua-type-union-bar"></span>]=]<br />
local chunks = {}<br />
for _, t in ipairs(typeM.anyOf) do<br />
chunks[#chunks+1] = renderType(t)<br />
end<br />
return formatstr:format(table.concat(chunks, ""))<br />
end<br />
<br />
---@param typeM docs.TypeModel<br />
---@return string<br />
function renderType(typeM)<br />
if typeM.typeKind == "explicit" then<br />
---@cast typeM docs.ExplicitType<br />
return renderTypeExplicit(typeM)<br />
elseif typeM.typeKind == "union" then<br />
---@cast typeM docs.UnionType<br />
return renderTypeUnion(typeM)<br />
end<br />
error(("An internal error occured: unsure how to render a %s type"):format(tostring(typeM.typeKind)))<br />
end<br />
<br />
---@param o any<br />
---@param i number?<br />
local function printFancy(o, i)<br />
i = i or 2<br />
local indent = (" "):rep(i)<br />
if type(o) == "table" then<br />
if getmetatable(o) and getmetatable(o).__tostring then<br />
return tostring(o)<br />
end<br />
local b = "{\n"<br />
for k, v in pairs(o) do<br />
b = b .. indent .. printFancy(k, i + 2) .. " = " .. printFancy(v, i + 2) .. ",\n"<br />
end<br />
b = b .. (" "):rep(i - 2) .. "}"<br />
return b<br />
else<br />
return tostring(o)<br />
end<br />
end<br />
<br />
local function parseAndRenderType(frame)<br />
local input_args = frame:getParent().args<br />
local nargs = 0<br />
while input_args[nargs + 1] do nargs = nargs + 1 end<br />
if nargs == 0 then error "Need to specify at least one type" end<br />
<br />
if nargs == 1 then<br />
local s = spool.new(input_args[1])<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error("Expected end of type at position " .. s.cursor) end<br />
return renderType(t)<br />
else<br />
local tabulated = {}<br />
for i = 1, nargs do tabulated[i] = input_args[i] end<br />
local s = spool.new(table.concat(tabulated, "|"))<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error("Expected end of type at position " .. s.cursor) end<br />
return renderType(t)<br />
end<br />
end<br />
<br />
-- local m = parseField [[<br />
-- player global readOnly;<br />
-- type PlayerAPI;<br />
-- ]]<br />
-- print(printFancy(m))<br />
<br />
return {<br />
type = parseAndRenderType<br />
}</div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=Module:Signatures/Signatures.css&diff=871
Module:Signatures/Signatures.css
2025-03-31T01:19:20Z
<p>PenguinEncounter: </p>
<hr />
<div>.lua-type-union {<br />
display: inline-flex;<br />
flex-flow: row nowrap;<br />
padding: 1px 1px;<br />
gap: 2px;<br />
border-radius: 4px;<br />
border: 1px solid #404040; /* FIXME: theming */<br />
}<br />
.lua-type-union > .lua-type-union-bar {<br />
display: block;<br />
width: 2px;<br />
align-self: stretch;<br />
background-color: #404040; /* FIXME: theming */<br />
}<br />
<br />
.lua-type-explicit {<br />
font-family: monospace;<br />
display: contents;<br />
}<br />
.lua-type-explicit > .external::after {<br />
display: none;<br />
}<br />
.lua-type-explicit > a {<br />
border-radius: 4px;<br />
border: 1px solid #404040; /* FIXME: theming */<br />
padding: 0 4px;<br />
}</div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=Module:Signatures/Signatures.css&diff=870
Module:Signatures/Signatures.css
2025-03-31T01:17:26Z
<p>PenguinEncounter: </p>
<hr />
<div>.lua-type-union {<br />
display: inline-flex;<br />
flex-flow: row nowrap;<br />
padding: 1px 1px;<br />
gap: 4px;<br />
border-radius: 4px;<br />
border: 1px solid #404040; /* FIXME: theming */<br />
}<br />
<br />
.lua-type-explicit {<br />
font-family: monospace;<br />
display: contents;<br />
}<br />
.lua-type-explicit > .external::after {<br />
display: none;<br />
}<br />
.lua-type-explicit > a {<br />
border-radius: 4px;<br />
border: 1px solid #404040; /* FIXME: theming */<br />
padding: 2px 4px;<br />
}</div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=Module:Signatures/Signatures.css&diff=869
Module:Signatures/Signatures.css
2025-03-31T01:15:58Z
<p>PenguinEncounter: </p>
<hr />
<div>.lua-type-union {<br />
display: inline-flex;<br />
flex-flow: row nowrap;<br />
padding: 1px 4px;<br />
gap: 4px;<br />
border-radius: 4px;<br />
border: 1px solid #404040; /* FIXME: theming */<br />
}<br />
<br />
.lua-type-explicit {<br />
border-radius: 4px;<br />
border: 1px solid #404040; /* FIXME: theming */<br />
padding: 2px 4px;<br />
font-family: monospace;<br />
display: contents;<br />
}</div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=Module:Signatures/Signatures.css&diff=868
Module:Signatures/Signatures.css
2025-03-31T00:51:20Z
<p>PenguinEncounter: </p>
<hr />
<div>.lua-type-union {<br />
display: inline-flex;<br />
flex-flow: row nowrap;<br />
padding: 1px 4px;<br />
gap: 4px;<br />
border-radius: 4px;<br />
border: 1px solid #404040; /* FIXME: theming */<br />
}<br />
<br />
.lua-type-explicit {<br />
border-radius: 4px;<br />
border: 1px solid #404040; /* FIXME: theming */<br />
padding: 2px 4px;<br />
font-family: monospace;<br />
}</div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=Module:Signatures/Signatures.css&diff=867
Module:Signatures/Signatures.css
2025-03-31T00:50:04Z
<p>PenguinEncounter: </p>
<hr />
<div>.lua-type-union {<br />
display: inline-flex;<br />
flex-flow: row nowrap;<br />
padding: 2px 4px;<br />
gap: 4px;<br />
}</div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=Module:Signatures&diff=866
Module:Signatures
2025-03-31T00:49:57Z
<p>PenguinEncounter: </p>
<hr />
<div>-- a MediaWiki module<br />
<br />
--[[<br />
Syntax description:<br />
<name> <attr...> ...;;<br />
<modName> [modSyn];;<br />
]]<br />
<br />
---@alias docs.ModelKind "field" | "method" | "type"<br />
<br />
---Origin of this documentation item.<br />
---@alias docs.ModelOrigin<br />
---| "Lua" Lua 5.2 built-in types and APIs.<br />
---| "Figura" Figura types and APIs. Usually the default.<br />
---| "abstract" Describes ideas, but no concrete implementation exists.<br />
---| "typedef" Custom on-the-spot types, like function protocols or array types.<br />
<br />
---@alias Set<T> {[T]: true}<br />
<br />
---@class docs.DocModel<br />
---@field kind docs.ModelKind<br />
---@field name string?<br />
---@field prefixHint string?<br />
---@field attributes Set<string><br />
---@field origin docs.ModelOrigin<br />
<br />
---@class docs.FieldModel : docs.DocModel<br />
---@field kind "field"<br />
---@field canRead boolean<br />
---@field canWrite boolean<br />
---@field readType docs.TypeModel?<br />
---@field writeType docs.TypeModel?<br />
<br />
---@class docs.MethodModel : docs.DocModel<br />
---@field kind "method"<br />
---@field signatures docs.MethodSignature[]<br />
---@field isStatic boolean<br />
<br />
---@class docs.MethodSignature.Parameter<br />
---@field name string<br />
---@field type docs.TypeModel<br />
---@field vararg boolean?<br />
<br />
---@class docs.MethodSignature<br />
---@field returns docs.TypeModel[]<br />
---@field parameters docs.MethodSignature.Parameter[]<br />
<br />
---@class docs.TypeModel : docs.DocModel<br />
---@field kind "type"<br />
---@field typeKind "explicit" | "union"<br />
<br />
---@class docs.ExplicitType : docs.TypeModel<br />
---@field typeKind "explicit"<br />
---@field link string?<br />
<br />
---@class docs.UnionType : docs.TypeModel<br />
---@field typeKind "union"<br />
---@field anyOf docs.TypeModel[]<br />
<br />
---@type metatable<br />
local type_meta = {<br />
__tostring = function (t)<br />
return ("<type %s from %s>"):format(t.name or '(anonymous)', t.origin)<br />
end<br />
}<br />
<br />
---@class docs.spool : docs.DocModel<br />
---@field src string<br />
---@field cursor integer<br />
---@field cursorNext integer?<br />
local spool = {}<br />
<br />
---Create a new spool.<br />
---@param src string<br />
---@return docs.spool<br />
function spool.new(src)<br />
return setmetatable({<br />
src = src,<br />
cursor = 1<br />
}, {__index = spool})<br />
end<br />
<br />
---@return integer cursor<br />
function spool:consumeSpace()<br />
self.cursor = self.src:match("%s*()", self.cursor)<br />
return self.cursor<br />
end<br />
<br />
local unpack = unpack or table.unpack -- 5.2 compat<br />
<br />
---Starts matching from the current cursor position, and recieves the next cursor position from a position capture.<br />
---@param pattern string<br />
---@param noMatchMsg string Format pattern with 1 %d to hold the cursor value.<br />
---@return any ...<br />
function spool:matchc(pattern, noMatchMsg)<br />
local results = {self.src:match(pattern, self.cursor)}<br />
if #results == 0 then error(noMatchMsg:format(self.cursor)) end<br />
self.cursorNext = results[#results]<br />
results[#results] = nil<br />
return unpack(results)<br />
end<br />
<br />
---@return string<br />
function spool:peek()<br />
return self.src:sub(self.cursor, self.cursor)<br />
end<br />
<br />
function spool:adv()<br />
if self:isAtEOF() then return end<br />
self.cursor = self.cursor + 1<br />
end<br />
<br />
function spool:matchadv(pattern)<br />
local _, to = self.src:find(pattern, self.cursor)<br />
if to then<br />
self.cursor = to + 1<br />
return true<br />
end<br />
return false<br />
end<br />
<br />
function spool:commit()<br />
if not self.cursorNext then error "spool:commit(): Nothing to commit" end<br />
self.cursor = self.cursorNext<br />
self.cursorNext = nil<br />
end<br />
<br />
function spool:isAtEOF() return self.cursor > #self.src end<br />
<br />
local LUA_TYPES_URL = "https://www.lua.org/manual/5.2/manual.html#2.1"<br />
<br />
---@type table<string, docs.ExplicitType><br />
local typeDefinitions = {}<br />
---@type table<string, string><br />
local typeAlias = {}<br />
local types = setmetatable({}, {<br />
__index = function (t, k)<br />
local resolvedName = k<br />
local i = 0<br />
while typeAlias[resolvedName] do<br />
i = i + 1<br />
if i > 10 then error "internal: alias chain too long" end<br />
resolvedName = typeAlias[resolvedName]<br />
end<br />
return typeDefinitions[resolvedName]<br />
end<br />
})<br />
<br />
---@param name string<br />
---@param origin docs.ModelOrigin<br />
---@param link string?<br />
---@return docs.ExplicitType<br />
local function newExplicitType(name, origin, link)<br />
if typeDefinitions[name] then error "Type already exists" end<br />
---@type docs.ExplicitType<br />
local t = setmetatable({<br />
kind = "type",<br />
typeKind = "explicit",<br />
name = name,<br />
attributes = {},<br />
origin = origin,<br />
link = link<br />
}, type_meta)<br />
typeDefinitions[name] = t<br />
return t<br />
end<br />
<br />
---@param anyOf docs.TypeModel[]<br />
---@return docs.UnionType<br />
local function newUnionType(anyOf)<br />
local function flatten(typ)<br />
if not typ.kind or typ.typeKind == "union" then<br />
local iterator<br />
if not typ.kind then<br />
iterator = typ<br />
else<br />
iterator = typ.anyOf<br />
end<br />
local seen = {}<br />
local res = {}<br />
for _, typ2 in ipairs(iterator) do<br />
for _, v in ipairs(flatten(typ2)) do<br />
if not seen[v] then<br />
res[#res + 1] = v<br />
seen[v] = true<br />
end<br />
end<br />
end<br />
return res<br />
elseif typ.typeKind == "explicit" then<br />
return { typ }<br />
end<br />
error "No type"<br />
end<br />
---@type docs.UnionType<br />
return setmetatable({<br />
anyOf = flatten(anyOf),<br />
attributes = {},<br />
kind = "type",<br />
origin = "abstract",<br />
typeKind = "union"<br />
}, {<br />
__tostring = function (t)<br />
local chunks = {}<br />
for _, type in ipairs(t.anyOf) do<br />
chunks[#chunks+1] = tostring(type)<br />
end<br />
return table.concat(chunks, ' | ')<br />
end<br />
})<br />
end<br />
<br />
---@param name string<br />
---@param origin docs.ModelOrigin<br />
---@return docs.ExplicitType<br />
local function getOrDefineType(name, origin)<br />
local t = types[name]<br />
if t then return t end<br />
return newExplicitType(name, origin, name)<br />
end<br />
<br />
---Create a new type definition type.<br />
---@param typedefname string without #<br />
---@return docs.TypeModel<br />
local function newTypedef(typedefname)<br />
local prefixed = "#"..typedefname<br />
if typeDefinitions[prefixed] then return typeDefinitions[prefixed] end<br />
---@type docs.ExplicitType<br />
local t = setmetatable({<br />
kind = "type",<br />
typeKind = "explicit",<br />
name = typedefname,<br />
attributes = {},<br />
origin = "typedef",<br />
link = "#typedef_"..typedefname<br />
}, type_meta)<br />
typeDefinitions[prefixed] = t<br />
return t<br />
end<br />
<br />
do -- builtin types<br />
<br />
-- currying<br />
---@param sourceName string<br />
---@return fun(list: string[])<br />
local function alias(sourceName)<br />
return function(list)<br />
for _, v in ipairs(list) do<br />
typeAlias[v] = sourceName<br />
end<br />
end<br />
end<br />
<br />
newExplicitType("any", "abstract")<br />
alias "any" { "AnyType" }<br />
newExplicitType("void", "abstract")<br />
newExplicitType("nil", "Lua", LUA_TYPES_URL)<br />
alias "nil" { "null" }<br />
newExplicitType("boolean", "Lua", LUA_TYPES_URL)<br />
alias "boolean" { "Boolean" }<br />
newExplicitType("number", "Lua", LUA_TYPES_URL)<br />
alias "number" { "Number", "double", "float" }<br />
newExplicitType("integer", "Lua", LUA_TYPES_URL)<br />
alias "integer" { "Integer" }<br />
newExplicitType("string", "Lua", LUA_TYPES_URL)<br />
alias "string" { "String" }<br />
newExplicitType("function", "Lua", LUA_TYPES_URL)<br />
alias "function" { "Function" }<br />
newExplicitType("userdata", "Lua", LUA_TYPES_URL)<br />
alias "userdata" { "Userdata" }<br />
newExplicitType("table", "Lua", LUA_TYPES_URL)<br />
alias "table" { "Table" }<br />
end<br />
<br />
---@param s docs.spool<br />
local function parseComment(s)<br />
s:matchc("%*/()", "No end of comment found")<br />
s:commit()<br />
end<br />
<br />
---@param s docs.spool<br />
---@return docs.TypeModel<br />
local function parseSimpleType(s)<br />
if s:isAtEOF() then error("Expected a type at position " .. s.cursor .. " but instead found nothing") end<br />
local prefix = s:peek()<br />
if prefix == "#" then<br />
s:adv()<br />
local typename = s:matchc("^([a-zA-Z0-9]+) ?()", "Expected a typedef name at position %d, but found nothing after the #")<br />
s:commit()<br />
return newTypedef(typename)<br />
end<br />
local typename = s:matchc("^([a-zA-Z0-9]+) ?()", "Expected a type name at position %d, but found nothing")<br />
s:commit()<br />
local t = getOrDefineType(typename, "Figura")<br />
return t<br />
end<br />
<br />
---@param s docs.spool<br />
local function parseType(s)<br />
local t = parseSimpleType(s)<br />
s:consumeSpace()<br />
local nextC = s:peek()<br />
if nextC == '|' then<br />
local unions = {t}<br />
while nextC == '|' do<br />
s:adv()<br />
s:consumeSpace()<br />
unions[#unions+1] = parseSimpleType(s)<br />
s:consumeSpace()<br />
nextC = s:peek()<br />
end<br />
return newUnionType(unions)<br />
else<br />
return t<br />
end<br />
end<br />
<br />
local function noop() end<br />
<br />
---@type table<string, fun(line: string, model: docs.DocModel)><br />
local sharedModifiers = {<br />
prefixHint = function (line, model)<br />
if model.prefixHint then error "duplicate prefixHint declaration" end<br />
model.prefixHint = line<br />
end<br />
}<br />
---@type table<string, fun(model: docs.DocModel)><br />
local sharedAttributes = {<br />
global = noop<br />
}<br />
<br />
---@type table<string, fun(line: string, model: docs.MethodModel)><br />
local methodModifiers = {<br />
}<br />
methodModifiers = setmetatable(methodModifiers, {__index = sharedModifiers})<br />
---@type table<string, fun(model: docs.MethodModel)><br />
local methodAttributes = {<br />
static = function (model)<br />
model.isStatic = true<br />
end,<br />
hostOnly = noop<br />
}<br />
methodAttributes = setmetatable(methodAttributes, {__index = sharedAttributes})<br />
<br />
---@type table<string, fun(line: string, model: docs.FieldModel)><br />
local fieldModifiers = {<br />
["type"] = function (line, model)<br />
local s = spool.new(line)<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error "expected end of statement after field type" end<br />
model.readType = t<br />
model.writeType = t<br />
end,<br />
["readType"] = function (line, model)<br />
local s = spool.new(line)<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error "expected end of statement after field readType" end<br />
model.readType = t<br />
end,<br />
["writeType"] = function (line, model)<br />
local s = spool.new(line)<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error "expected end of statement after field writeType" end<br />
model.writeType = t<br />
end,<br />
}<br />
fieldModifiers = setmetatable(fieldModifiers, {__index = sharedModifiers})<br />
---@type table<string, fun(model: docs.FieldModel)><br />
local fieldAttributes = {<br />
readOnly = function (model)<br />
model.canWrite = false<br />
end,<br />
writeOnly = function (model)<br />
model.canRead = false<br />
end<br />
}<br />
fieldAttributes = setmetatable(fieldAttributes, {__index = sharedAttributes})<br />
<br />
---@param sigtext string<br />
local function parseMethodSignature(sigtext)<br />
local s = spool.new(sigtext)<br />
<br />
---@type docs.MethodSignature<br />
local model = {<br />
returns = {},<br />
parameters = {}<br />
}<br />
<br />
local function parseParameter(assumeV)<br />
---@type docs.MethodSignature.Parameter<br />
local param = setmetatable({<br />
name = "",<br />
type = typeDefinitions.void,<br />
vararg = false<br />
}, {<br />
__tostring = function (t)<br />
return ("<param %s (%s)>"):format(t.name, tostring(t.type))<br />
end<br />
})<br />
if assumeV then<br />
param.name = "..."<br />
param.vararg = true<br />
else<br />
-- already consumed: 'parameter '<br />
if s:matchadv("^%.%.%. ?") then<br />
param.name = "..."<br />
param.vararg = true<br />
else<br />
param.name = s:matchc("^([a-zA-Z0-9]+) ?()", "Expected parameter name at %d but found nothing")<br />
s:commit()<br />
end<br />
end<br />
s:consumeSpace()<br />
param.type = parseType(s)<br />
s:consumeSpace()<br />
if not s:matchadv('^;') then error("Expected a semicolon to end parameter declaration at position " .. s.cursor) end<br />
model.parameters[#model.parameters+1] = param<br />
end<br />
<br />
local function parseReturns()<br />
-- already consumed: 'returns '<br />
model.returns[#model.returns+1] = parseType(s)<br />
s:consumeSpace()<br />
while s:matchadv('^,') do<br />
s:consumeSpace()<br />
model.returns[#model.returns+1] = parseType(s)<br />
s:consumeSpace()<br />
end<br />
if not s:matchadv('^;') then error("Expected a semicolon to end returns declaration at position " .. s.cursor) end<br />
end<br />
<br />
local function parseStmt()<br />
if s:matchadv "^/%*" then<br />
return parseComment(s)<br />
end<br />
if s:matchadv "^returns " then<br />
return parseReturns()<br />
end<br />
if s:matchadv "^parameter%.%.%." then<br />
return parseParameter(true)<br />
end<br />
if s:matchadv "^parameter " then<br />
return parseParameter()<br />
end<br />
error("No valid signature statement at " .. s.cursor)<br />
end<br />
<br />
local function parse()<br />
s:consumeSpace()<br />
while not s:isAtEOF() do<br />
parseStmt()<br />
s:consumeSpace()<br />
end<br />
end<br />
parse()<br />
return model<br />
end<br />
<br />
---@param docstr string<br />
local function parseMethod(docstr)<br />
local s = spool.new(docstr)<br />
<br />
---@type docs.MethodModel<br />
local model = {<br />
kind = "method",<br />
attributes = {},<br />
isStatic = false,<br />
name = "<unnamed>",<br />
origin = "Figura",<br />
signatures = {},<br />
}<br />
local parseTopLevelStmt, parseMethodHeader, parseSignatureOuter<br />
local blockKw = {}<br />
<br />
function parseSignatureOuter()<br />
s:consumeSpace()<br />
---@type string<br />
local block_content = s:matchc("^(%b{})%s*;()", "Expected a bracketed block after 'signature' at position %d")<br />
local inside = block_content:sub(2, -2)<br />
local sig = parseMethodSignature(inside)<br />
model.signatures[#model.signatures+1] = sig<br />
s:commit()<br />
end<br />
blockKw.signature = parseSignatureOuter<br />
<br />
function parseMethodHeader()<br />
local name = s:matchc("^([^%s;]+) ?()", "Expected method name at %d")<br />
model.name = name<br />
s:commit()<br />
s:consumeSpace()<br />
local peek = s:peek()<br />
while #peek ~= 0 and peek ~= ';' do<br />
local attr = s:matchc("^([^%s;]+) ?()", "Expected something else!")<br />
if not methodAttributes[attr] then<br />
error(("Unknown method attribute '%s' at position %d in method header"):format(attr, s.cursor))<br />
end<br />
methodAttributes[attr](model)<br />
model.attributes[attr] = true<br />
s:commit()<br />
s:consumeSpace()<br />
peek = s:peek()<br />
end<br />
if peek == ';' then<br />
s:adv() -- advance past the ;<br />
else<br />
error("Reached end of method documentation while parsing header")<br />
end<br />
end<br />
<br />
function parseTopLevelStmt()<br />
local startAt = s.cursor<br />
---@type string<br />
local action = s:matchc("^([^%s;]+) ?()", "Expected a modifier or block keyword, but got nothing instead at position %d")<br />
s:commit()<br />
if methodModifiers[action] then<br />
---@type string<br />
local remainder = s:matchc("^(.-);%s*()", "Expected semicolon to end statement around %d")<br />
s:commit()<br />
return methodModifiers[action](remainder, model)<br />
end<br />
if blockKw[action] then return blockKw[action]() end<br />
error(("Expected a modifier or block keyword, but got '%s' instead at position %d"):format(action, startAt))<br />
end<br />
<br />
local function parse()<br />
s:consumeSpace()<br />
parseMethodHeader()<br />
s:consumeSpace()<br />
while not s:isAtEOF() do<br />
parseTopLevelStmt()<br />
s:consumeSpace()<br />
end<br />
end<br />
<br />
parse()<br />
return model<br />
end<br />
<br />
---@param docstr string<br />
---@return docs.FieldModel<br />
local function parseField(docstr)<br />
local s = spool.new(docstr)<br />
<br />
---@type docs.FieldModel<br />
local model = {<br />
kind = "field",<br />
attributes = {},<br />
name = "<unnamed>",<br />
origin = "Figura",<br />
canRead = true,<br />
canWrite = true<br />
}<br />
<br />
local parseTopLevelStmt, parseFieldHeader, parseSignatureOuter<br />
<br />
function parseFieldHeader()<br />
local name = s:matchc("^([^%s;]+) ?()", "Expected field name at %d")<br />
model.name = name<br />
s:commit()<br />
s:consumeSpace()<br />
local peek = s:peek()<br />
while #peek ~= 0 and peek ~= ';' do<br />
local attr = s:matchc("^([^%s;]+) ?()", "Expected something else!")<br />
if not fieldAttributes[attr] then<br />
error(("Unknown field attribute '%s' at position %d in field header"):format(attr, s.cursor))<br />
end<br />
fieldAttributes[attr](model)<br />
model.attributes[attr] = true<br />
s:commit()<br />
s:consumeSpace()<br />
peek = s:peek()<br />
end<br />
if peek == ';' then<br />
s:adv() -- advance past the ;<br />
else<br />
error("Reached end of field documentation while parsing header")<br />
end<br />
end<br />
<br />
function parseTopLevelStmt()<br />
local startAt = s.cursor<br />
---@type string<br />
local action = s:matchc("^([^%s;]+) ?()", "Expected a modifier, but got nothing instead at position %d")<br />
s:commit()<br />
if fieldModifiers[action] then<br />
---@type string<br />
local remainder = s:matchc("^(.-);%s*()", "Expected semicolon to end statement around %d")<br />
s:commit()<br />
return fieldModifiers[action](remainder, model)<br />
end<br />
error(("Expected a modifier, but got '%s' instead at position %d"):format(action, startAt))<br />
end<br />
<br />
local function parse()<br />
s:consumeSpace()<br />
parseFieldHeader()<br />
s:consumeSpace()<br />
while not s:isAtEOF() do<br />
parseTopLevelStmt()<br />
s:consumeSpace()<br />
end<br />
end<br />
<br />
parse()<br />
return model<br />
end<br />
<br />
local renderType<br />
<br />
---@param typeM docs.ExplicitType<br />
---@return string<br />
local function renderTypeExplicit(typeM)<br />
local formatstr<br />
if not typeM.link then<br />
formatstr = [=[<span class="lua-type-explicit" data-name="$TypeName" $ExtraAttr>$TypeName</span>]=]<br />
elseif typeM.link:find("^https?://") then<br />
formatstr = [=[<span class="lua-type-explicit" data-name="$TypeName" $ExtraAttr>[$Link $TypeName]</span>]=]<br />
else<br />
formatstr = [=[<span class="lua-type-explicit" data-name="$TypeName" $ExtraAttr>[[$Link|$TypeName]]</span>]=]<br />
end<br />
local replacements = {<br />
Link = typeM.link,<br />
TypeName = typeM.name,<br />
ExtraAttr = ""<br />
}<br />
local formatted = formatstr:gsub("%$([a-zA-Z]+)", replacements)<br />
return formatted<br />
end<br />
<br />
---@param typeM docs.UnionType<br />
---@return string<br />
local function renderTypeUnion(typeM)<br />
if #typeM.anyOf == 1 then return renderType(typeM.anyOf[1]) end<br />
if #typeM.anyOf == 2 then<br />
-- todo: add ? for optionals<br />
end<br />
local formatstr = [=[<span class="lua-type-union">%s</span>]=]<br />
local chunks = {}<br />
for _, t in ipairs(typeM.anyOf) do<br />
chunks[#chunks+1] = renderType(t)<br />
end<br />
return formatstr:format(table.concat(chunks, ""))<br />
end<br />
<br />
---@param typeM docs.TypeModel<br />
---@return string<br />
function renderType(typeM)<br />
if typeM.typeKind == "explicit" then<br />
---@cast typeM docs.ExplicitType<br />
return renderTypeExplicit(typeM)<br />
elseif typeM.typeKind == "union" then<br />
---@cast typeM docs.UnionType<br />
return renderTypeUnion(typeM)<br />
end<br />
error(("An internal error occured: unsure how to render a %s type"):format(tostring(typeM.typeKind)))<br />
end<br />
<br />
---@param o any<br />
---@param i number?<br />
local function printFancy(o, i)<br />
i = i or 2<br />
local indent = (" "):rep(i)<br />
if type(o) == "table" then<br />
if getmetatable(o) and getmetatable(o).__tostring then<br />
return tostring(o)<br />
end<br />
local b = "{\n"<br />
for k, v in pairs(o) do<br />
b = b .. indent .. printFancy(k, i + 2) .. " = " .. printFancy(v, i + 2) .. ",\n"<br />
end<br />
b = b .. (" "):rep(i - 2) .. "}"<br />
return b<br />
else<br />
return tostring(o)<br />
end<br />
end<br />
<br />
local function parseAndRenderType(frame)<br />
local input_args = frame:getParent().args<br />
local nargs = 0<br />
while input_args[nargs + 1] do nargs = nargs + 1 end<br />
if nargs == 0 then error "Need to specify at least one type" end<br />
<br />
if nargs == 1 then<br />
local s = spool.new(input_args[1])<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error("Expected end of type at position " .. s.cursor) end<br />
return renderType(t)<br />
else<br />
local tabulated = {}<br />
for i = 1, nargs do tabulated[i] = input_args[i] end<br />
local s = spool.new(table.concat(tabulated, "|"))<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error("Expected end of type at position " .. s.cursor) end<br />
return renderType(t)<br />
end<br />
end<br />
<br />
-- local m = parseField [[<br />
-- player global readOnly;<br />
-- type PlayerAPI;<br />
-- ]]<br />
-- print(printFancy(m))<br />
<br />
return {<br />
type = parseAndRenderType<br />
}</div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=User:PenguinEncounter/newtype&diff=865
User:PenguinEncounter/newtype
2025-03-31T00:47:13Z
<p>PenguinEncounter: </p>
<hr />
<div><templatestyles src="Module:Signatures/Signatures.css"/>{{#invoke:Signatures|type}}</div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=Module:Signatures/Signatures.css&diff=864
Module:Signatures/Signatures.css
2025-03-31T00:46:47Z
<p>PenguinEncounter: new CSS</p>
<hr />
<div>.lua-type-union {<br />
display: inline-flex;<br />
flex-flow: row nowrap;<br />
padding: 3px 1px;<br />
}</div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=User:PenguinEncounter/sandbox&diff=863
User:PenguinEncounter/sandbox
2025-03-31T00:44:29Z
<p>PenguinEncounter: </p>
<hr />
<div><div style="font-size: 3rem;">[https://wiki.figuramc.org/index.php/User:PenguinEncounter/sandbox?action=purge purge it]</div><br />
<br />
{{User:PenguinEncounter/newtype|function|Vector2|#TickEventCallback}}<br />
<br />
For example, to get the cube {{Emoji|BBCube.png}} RightArm:<br />
<br />
This is what is in your project:<br />
<br />
{{#invoke:MatrixFields|run|size=4}}<br />
<br />
{{tree|icon=FSFolderOpen.png|content=<code>my_avatar</code>|inner=<br />
{{tree|icon=FiguraJSON.png|content=<code>avatar.json</code>}}<br />
{{tree|icon=BBModel.png|content=<code>model.bbmodel</code>}}<br />
}}<br />
<br />
<br />
{{tree|icon=BBModel.png|content=<code>model.bbmodel</code>|inner=<br />
{{tree|icon=BBGroup.png|content=Head|inner=<br />
{{tree|icon=BBCube.png|content=Head}}<br />
{{tree|icon=BBCube.png|content=HeadLayer}}<br />
}}<br />
{{tree|icon=BBGroup.png|content=RightArm<br>oops|inner=<br />
{{tree|icon=BBCube.png|content=RightArm}}<br />
{{tree|icon=BBCube.png|content=RightArmLayer}}<br />
}}<br />
}}<br />
<br />
== conspicuous example code ==<br />
{{#tag:syntaxhighlight|<br />
function events.tick()<br />
<nowiki>--[[wiki.figuramc.org, </nowiki>{{FULLPAGENAME}} rev. {{REVISIONID}}<nowiki>]]</nowiki><br />
models.model.Head:setVisible(false)<br />
end<br />
|lang=lua}}<br />
<br />
= <code>HostAPI:setTitleTimes</code> =<br />
{{Host only|kind=method}}<br />
Configures the hold, fade-in, and fade-out durations of titles displayed on the screen.<br />
<br />
== Usage ==<br />
{| class="wikitable"<br />
! Arguments !! Return Type<br />
|-<br />
| <code>setTitleTimes(timesData {{type|Vector3}})</code><br />
| self {{type|HostAPI}}<br />
|-<br />
| <code>setTitleTimes(fadeInTime {{type|integer}}, stayTime {{type|integer}}, fadeOutTime {{type|integer}})</code><br />
| self {{type|HostAPI}}<br />
|}<br />
<br />
== Examples ==<br />
<syntaxhighlight lang="lua"><br />
host:setTitleTimes(1, 1, 1)<br />
</syntaxhighlight><br />
<br />
== See Also ==<br />
<!-- idk --></div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=Module:Signatures&diff=862
Module:Signatures
2025-03-31T00:44:04Z
<p>PenguinEncounter: </p>
<hr />
<div>-- a MediaWiki module<br />
<br />
--[[<br />
Syntax description:<br />
<name> <attr...> ...;;<br />
<modName> [modSyn];;<br />
]]<br />
<br />
---@alias docs.ModelKind "field" | "method" | "type"<br />
<br />
---Origin of this documentation item.<br />
---@alias docs.ModelOrigin<br />
---| "Lua" Lua 5.2 built-in types and APIs.<br />
---| "Figura" Figura types and APIs. Usually the default.<br />
---| "abstract" Describes ideas, but no concrete implementation exists.<br />
---| "typedef" Custom on-the-spot types, like function protocols or array types.<br />
<br />
---@alias Set<T> {[T]: true}<br />
<br />
---@class docs.DocModel<br />
---@field kind docs.ModelKind<br />
---@field name string?<br />
---@field prefixHint string?<br />
---@field attributes Set<string><br />
---@field origin docs.ModelOrigin<br />
<br />
---@class docs.FieldModel : docs.DocModel<br />
---@field kind "field"<br />
---@field canRead boolean<br />
---@field canWrite boolean<br />
---@field readType docs.TypeModel?<br />
---@field writeType docs.TypeModel?<br />
<br />
---@class docs.MethodModel : docs.DocModel<br />
---@field kind "method"<br />
---@field signatures docs.MethodSignature[]<br />
---@field isStatic boolean<br />
<br />
---@class docs.MethodSignature.Parameter<br />
---@field name string<br />
---@field type docs.TypeModel<br />
---@field vararg boolean?<br />
<br />
---@class docs.MethodSignature<br />
---@field returns docs.TypeModel[]<br />
---@field parameters docs.MethodSignature.Parameter[]<br />
<br />
---@class docs.TypeModel : docs.DocModel<br />
---@field kind "type"<br />
---@field typeKind "explicit" | "union"<br />
<br />
---@class docs.ExplicitType : docs.TypeModel<br />
---@field typeKind "explicit"<br />
---@field link string?<br />
<br />
---@class docs.UnionType : docs.TypeModel<br />
---@field typeKind "union"<br />
---@field anyOf docs.TypeModel[]<br />
<br />
---@type metatable<br />
local type_meta = {<br />
__tostring = function (t)<br />
return ("<type %s from %s>"):format(t.name or '(anonymous)', t.origin)<br />
end<br />
}<br />
<br />
---@class docs.spool : docs.DocModel<br />
---@field src string<br />
---@field cursor integer<br />
---@field cursorNext integer?<br />
local spool = {}<br />
<br />
---Create a new spool.<br />
---@param src string<br />
---@return docs.spool<br />
function spool.new(src)<br />
return setmetatable({<br />
src = src,<br />
cursor = 1<br />
}, {__index = spool})<br />
end<br />
<br />
---@return integer cursor<br />
function spool:consumeSpace()<br />
self.cursor = self.src:match("%s*()", self.cursor)<br />
return self.cursor<br />
end<br />
<br />
local unpack = unpack or table.unpack -- 5.2 compat<br />
<br />
---Starts matching from the current cursor position, and recieves the next cursor position from a position capture.<br />
---@param pattern string<br />
---@param noMatchMsg string Format pattern with 1 %d to hold the cursor value.<br />
---@return any ...<br />
function spool:matchc(pattern, noMatchMsg)<br />
local results = {self.src:match(pattern, self.cursor)}<br />
if #results == 0 then error(noMatchMsg:format(self.cursor)) end<br />
self.cursorNext = results[#results]<br />
results[#results] = nil<br />
return unpack(results)<br />
end<br />
<br />
---@return string<br />
function spool:peek()<br />
return self.src:sub(self.cursor, self.cursor)<br />
end<br />
<br />
function spool:adv()<br />
if self:isAtEOF() then return end<br />
self.cursor = self.cursor + 1<br />
end<br />
<br />
function spool:matchadv(pattern)<br />
local _, to = self.src:find(pattern, self.cursor)<br />
if to then<br />
self.cursor = to + 1<br />
return true<br />
end<br />
return false<br />
end<br />
<br />
function spool:commit()<br />
if not self.cursorNext then error "spool:commit(): Nothing to commit" end<br />
self.cursor = self.cursorNext<br />
self.cursorNext = nil<br />
end<br />
<br />
function spool:isAtEOF() return self.cursor > #self.src end<br />
<br />
local LUA_TYPES_URL = "https://www.lua.org/manual/5.2/manual.html#2.1"<br />
<br />
---@type table<string, docs.ExplicitType><br />
local typeDefinitions = {}<br />
---@type table<string, string><br />
local typeAlias = {}<br />
local types = setmetatable({}, {<br />
__index = function (t, k)<br />
local resolvedName = k<br />
local i = 0<br />
while typeAlias[resolvedName] do<br />
i = i + 1<br />
if i > 10 then error "internal: alias chain too long" end<br />
resolvedName = typeAlias[resolvedName]<br />
end<br />
return typeDefinitions[resolvedName]<br />
end<br />
})<br />
<br />
---@param name string<br />
---@param origin docs.ModelOrigin<br />
---@param link string?<br />
---@return docs.ExplicitType<br />
local function newExplicitType(name, origin, link)<br />
if typeDefinitions[name] then error "Type already exists" end<br />
---@type docs.ExplicitType<br />
local t = setmetatable({<br />
kind = "type",<br />
typeKind = "explicit",<br />
name = name,<br />
attributes = {},<br />
origin = origin,<br />
link = link<br />
}, type_meta)<br />
typeDefinitions[name] = t<br />
return t<br />
end<br />
<br />
---@param anyOf docs.TypeModel[]<br />
---@return docs.UnionType<br />
local function newUnionType(anyOf)<br />
local function flatten(typ)<br />
if not typ.kind or typ.typeKind == "union" then<br />
local iterator<br />
if not typ.kind then<br />
iterator = typ<br />
else<br />
iterator = typ.anyOf<br />
end<br />
local seen = {}<br />
local res = {}<br />
for _, typ2 in ipairs(iterator) do<br />
for _, v in ipairs(flatten(typ2)) do<br />
if not seen[v] then<br />
res[#res + 1] = v<br />
seen[v] = true<br />
end<br />
end<br />
end<br />
return res<br />
elseif typ.typeKind == "explicit" then<br />
return { typ }<br />
end<br />
error "No type"<br />
end<br />
---@type docs.UnionType<br />
return setmetatable({<br />
anyOf = flatten(anyOf),<br />
attributes = {},<br />
kind = "type",<br />
origin = "abstract",<br />
typeKind = "union"<br />
}, {<br />
__tostring = function (t)<br />
local chunks = {}<br />
for _, type in ipairs(t.anyOf) do<br />
chunks[#chunks+1] = tostring(type)<br />
end<br />
return table.concat(chunks, ' | ')<br />
end<br />
})<br />
end<br />
<br />
---@param name string<br />
---@param origin docs.ModelOrigin<br />
---@return docs.ExplicitType<br />
local function getOrDefineType(name, origin)<br />
local t = types[name]<br />
if t then return t end<br />
return newExplicitType(name, origin, name)<br />
end<br />
<br />
---Create a new type definition type.<br />
---@param typedefname string without #<br />
---@return docs.TypeModel<br />
local function newTypedef(typedefname)<br />
local prefixed = "#"..typedefname<br />
if typeDefinitions[prefixed] then return typeDefinitions[prefixed] end<br />
---@type docs.ExplicitType<br />
local t = setmetatable({<br />
kind = "type",<br />
typeKind = "explicit",<br />
name = typedefname,<br />
attributes = {},<br />
origin = "typedef",<br />
link = "#typedef_"..typedefname<br />
}, type_meta)<br />
typeDefinitions[prefixed] = t<br />
return t<br />
end<br />
<br />
do -- builtin types<br />
<br />
-- currying<br />
---@param sourceName string<br />
---@return fun(list: string[])<br />
local function alias(sourceName)<br />
return function(list)<br />
for _, v in ipairs(list) do<br />
typeAlias[v] = sourceName<br />
end<br />
end<br />
end<br />
<br />
newExplicitType("any", "abstract")<br />
alias "any" { "AnyType" }<br />
newExplicitType("void", "abstract")<br />
newExplicitType("nil", "Lua", LUA_TYPES_URL)<br />
alias "nil" { "null" }<br />
newExplicitType("boolean", "Lua", LUA_TYPES_URL)<br />
alias "boolean" { "Boolean" }<br />
newExplicitType("number", "Lua", LUA_TYPES_URL)<br />
alias "number" { "Number", "double", "float" }<br />
newExplicitType("integer", "Lua", LUA_TYPES_URL)<br />
alias "integer" { "Integer" }<br />
newExplicitType("string", "Lua", LUA_TYPES_URL)<br />
alias "string" { "String" }<br />
newExplicitType("function", "Lua", LUA_TYPES_URL)<br />
alias "function" { "Function" }<br />
newExplicitType("userdata", "Lua", LUA_TYPES_URL)<br />
alias "userdata" { "Userdata" }<br />
newExplicitType("table", "Lua", LUA_TYPES_URL)<br />
alias "table" { "Table" }<br />
end<br />
<br />
---@param s docs.spool<br />
local function parseComment(s)<br />
s:matchc("%*/()", "No end of comment found")<br />
s:commit()<br />
end<br />
<br />
---@param s docs.spool<br />
---@return docs.TypeModel<br />
local function parseSimpleType(s)<br />
if s:isAtEOF() then error("Expected a type at position " .. s.cursor .. " but instead found nothing") end<br />
local prefix = s:peek()<br />
if prefix == "#" then<br />
s:adv()<br />
local typename = s:matchc("^([a-zA-Z0-9]+) ?()", "Expected a typedef name at position %d, but found nothing after the #")<br />
s:commit()<br />
return newTypedef(typename)<br />
end<br />
local typename = s:matchc("^([a-zA-Z0-9]+) ?()", "Expected a type name at position %d, but found nothing")<br />
s:commit()<br />
local t = getOrDefineType(typename, "Figura")<br />
return t<br />
end<br />
<br />
---@param s docs.spool<br />
local function parseType(s)<br />
local t = parseSimpleType(s)<br />
s:consumeSpace()<br />
local nextC = s:peek()<br />
if nextC == '|' then<br />
local unions = {t}<br />
while nextC == '|' do<br />
s:adv()<br />
s:consumeSpace()<br />
unions[#unions+1] = parseSimpleType(s)<br />
s:consumeSpace()<br />
nextC = s:peek()<br />
end<br />
return newUnionType(unions)<br />
else<br />
return t<br />
end<br />
end<br />
<br />
local function noop() end<br />
<br />
---@type table<string, fun(line: string, model: docs.DocModel)><br />
local sharedModifiers = {<br />
prefixHint = function (line, model)<br />
if model.prefixHint then error "duplicate prefixHint declaration" end<br />
model.prefixHint = line<br />
end<br />
}<br />
---@type table<string, fun(model: docs.DocModel)><br />
local sharedAttributes = {<br />
global = noop<br />
}<br />
<br />
---@type table<string, fun(line: string, model: docs.MethodModel)><br />
local methodModifiers = {<br />
}<br />
methodModifiers = setmetatable(methodModifiers, {__index = sharedModifiers})<br />
---@type table<string, fun(model: docs.MethodModel)><br />
local methodAttributes = {<br />
static = function (model)<br />
model.isStatic = true<br />
end,<br />
hostOnly = noop<br />
}<br />
methodAttributes = setmetatable(methodAttributes, {__index = sharedAttributes})<br />
<br />
---@type table<string, fun(line: string, model: docs.FieldModel)><br />
local fieldModifiers = {<br />
["type"] = function (line, model)<br />
local s = spool.new(line)<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error "expected end of statement after field type" end<br />
model.readType = t<br />
model.writeType = t<br />
end,<br />
["readType"] = function (line, model)<br />
local s = spool.new(line)<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error "expected end of statement after field readType" end<br />
model.readType = t<br />
end,<br />
["writeType"] = function (line, model)<br />
local s = spool.new(line)<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error "expected end of statement after field writeType" end<br />
model.writeType = t<br />
end,<br />
}<br />
fieldModifiers = setmetatable(fieldModifiers, {__index = sharedModifiers})<br />
---@type table<string, fun(model: docs.FieldModel)><br />
local fieldAttributes = {<br />
readOnly = function (model)<br />
model.canWrite = false<br />
end,<br />
writeOnly = function (model)<br />
model.canRead = false<br />
end<br />
}<br />
fieldAttributes = setmetatable(fieldAttributes, {__index = sharedAttributes})<br />
<br />
---@param sigtext string<br />
local function parseMethodSignature(sigtext)<br />
local s = spool.new(sigtext)<br />
<br />
---@type docs.MethodSignature<br />
local model = {<br />
returns = {},<br />
parameters = {}<br />
}<br />
<br />
local function parseParameter(assumeV)<br />
---@type docs.MethodSignature.Parameter<br />
local param = setmetatable({<br />
name = "",<br />
type = typeDefinitions.void,<br />
vararg = false<br />
}, {<br />
__tostring = function (t)<br />
return ("<param %s (%s)>"):format(t.name, tostring(t.type))<br />
end<br />
})<br />
if assumeV then<br />
param.name = "..."<br />
param.vararg = true<br />
else<br />
-- already consumed: 'parameter '<br />
if s:matchadv("^%.%.%. ?") then<br />
param.name = "..."<br />
param.vararg = true<br />
else<br />
param.name = s:matchc("^([a-zA-Z0-9]+) ?()", "Expected parameter name at %d but found nothing")<br />
s:commit()<br />
end<br />
end<br />
s:consumeSpace()<br />
param.type = parseType(s)<br />
s:consumeSpace()<br />
if not s:matchadv('^;') then error("Expected a semicolon to end parameter declaration at position " .. s.cursor) end<br />
model.parameters[#model.parameters+1] = param<br />
end<br />
<br />
local function parseReturns()<br />
-- already consumed: 'returns '<br />
model.returns[#model.returns+1] = parseType(s)<br />
s:consumeSpace()<br />
while s:matchadv('^,') do<br />
s:consumeSpace()<br />
model.returns[#model.returns+1] = parseType(s)<br />
s:consumeSpace()<br />
end<br />
if not s:matchadv('^;') then error("Expected a semicolon to end returns declaration at position " .. s.cursor) end<br />
end<br />
<br />
local function parseStmt()<br />
if s:matchadv "^/%*" then<br />
return parseComment(s)<br />
end<br />
if s:matchadv "^returns " then<br />
return parseReturns()<br />
end<br />
if s:matchadv "^parameter%.%.%." then<br />
return parseParameter(true)<br />
end<br />
if s:matchadv "^parameter " then<br />
return parseParameter()<br />
end<br />
error("No valid signature statement at " .. s.cursor)<br />
end<br />
<br />
local function parse()<br />
s:consumeSpace()<br />
while not s:isAtEOF() do<br />
parseStmt()<br />
s:consumeSpace()<br />
end<br />
end<br />
parse()<br />
return model<br />
end<br />
<br />
---@param docstr string<br />
local function parseMethod(docstr)<br />
local s = spool.new(docstr)<br />
<br />
---@type docs.MethodModel<br />
local model = {<br />
kind = "method",<br />
attributes = {},<br />
isStatic = false,<br />
name = "<unnamed>",<br />
origin = "Figura",<br />
signatures = {},<br />
}<br />
local parseTopLevelStmt, parseMethodHeader, parseSignatureOuter<br />
local blockKw = {}<br />
<br />
function parseSignatureOuter()<br />
s:consumeSpace()<br />
---@type string<br />
local block_content = s:matchc("^(%b{})%s*;()", "Expected a bracketed block after 'signature' at position %d")<br />
local inside = block_content:sub(2, -2)<br />
local sig = parseMethodSignature(inside)<br />
model.signatures[#model.signatures+1] = sig<br />
s:commit()<br />
end<br />
blockKw.signature = parseSignatureOuter<br />
<br />
function parseMethodHeader()<br />
local name = s:matchc("^([^%s;]+) ?()", "Expected method name at %d")<br />
model.name = name<br />
s:commit()<br />
s:consumeSpace()<br />
local peek = s:peek()<br />
while #peek ~= 0 and peek ~= ';' do<br />
local attr = s:matchc("^([^%s;]+) ?()", "Expected something else!")<br />
if not methodAttributes[attr] then<br />
error(("Unknown method attribute '%s' at position %d in method header"):format(attr, s.cursor))<br />
end<br />
methodAttributes[attr](model)<br />
model.attributes[attr] = true<br />
s:commit()<br />
s:consumeSpace()<br />
peek = s:peek()<br />
end<br />
if peek == ';' then<br />
s:adv() -- advance past the ;<br />
else<br />
error("Reached end of method documentation while parsing header")<br />
end<br />
end<br />
<br />
function parseTopLevelStmt()<br />
local startAt = s.cursor<br />
---@type string<br />
local action = s:matchc("^([^%s;]+) ?()", "Expected a modifier or block keyword, but got nothing instead at position %d")<br />
s:commit()<br />
if methodModifiers[action] then<br />
---@type string<br />
local remainder = s:matchc("^(.-);%s*()", "Expected semicolon to end statement around %d")<br />
s:commit()<br />
return methodModifiers[action](remainder, model)<br />
end<br />
if blockKw[action] then return blockKw[action]() end<br />
error(("Expected a modifier or block keyword, but got '%s' instead at position %d"):format(action, startAt))<br />
end<br />
<br />
local function parse()<br />
s:consumeSpace()<br />
parseMethodHeader()<br />
s:consumeSpace()<br />
while not s:isAtEOF() do<br />
parseTopLevelStmt()<br />
s:consumeSpace()<br />
end<br />
end<br />
<br />
parse()<br />
return model<br />
end<br />
<br />
---@param docstr string<br />
---@return docs.FieldModel<br />
local function parseField(docstr)<br />
local s = spool.new(docstr)<br />
<br />
---@type docs.FieldModel<br />
local model = {<br />
kind = "field",<br />
attributes = {},<br />
name = "<unnamed>",<br />
origin = "Figura",<br />
canRead = true,<br />
canWrite = true<br />
}<br />
<br />
local parseTopLevelStmt, parseFieldHeader, parseSignatureOuter<br />
<br />
function parseFieldHeader()<br />
local name = s:matchc("^([^%s;]+) ?()", "Expected field name at %d")<br />
model.name = name<br />
s:commit()<br />
s:consumeSpace()<br />
local peek = s:peek()<br />
while #peek ~= 0 and peek ~= ';' do<br />
local attr = s:matchc("^([^%s;]+) ?()", "Expected something else!")<br />
if not fieldAttributes[attr] then<br />
error(("Unknown field attribute '%s' at position %d in field header"):format(attr, s.cursor))<br />
end<br />
fieldAttributes[attr](model)<br />
model.attributes[attr] = true<br />
s:commit()<br />
s:consumeSpace()<br />
peek = s:peek()<br />
end<br />
if peek == ';' then<br />
s:adv() -- advance past the ;<br />
else<br />
error("Reached end of field documentation while parsing header")<br />
end<br />
end<br />
<br />
function parseTopLevelStmt()<br />
local startAt = s.cursor<br />
---@type string<br />
local action = s:matchc("^([^%s;]+) ?()", "Expected a modifier, but got nothing instead at position %d")<br />
s:commit()<br />
if fieldModifiers[action] then<br />
---@type string<br />
local remainder = s:matchc("^(.-);%s*()", "Expected semicolon to end statement around %d")<br />
s:commit()<br />
return fieldModifiers[action](remainder, model)<br />
end<br />
error(("Expected a modifier, but got '%s' instead at position %d"):format(action, startAt))<br />
end<br />
<br />
local function parse()<br />
s:consumeSpace()<br />
parseFieldHeader()<br />
s:consumeSpace()<br />
while not s:isAtEOF() do<br />
parseTopLevelStmt()<br />
s:consumeSpace()<br />
end<br />
end<br />
<br />
parse()<br />
return model<br />
end<br />
<br />
local renderType<br />
<br />
---@param typeM docs.ExplicitType<br />
---@return string<br />
local function renderTypeExplicit(typeM)<br />
local formatstr<br />
if not typeM.link then<br />
formatstr = [=[<span class="lua-type-explicit" data-name="$TypeName" $ExtraAttr>$TypeName</span>]=]<br />
elseif typeM.link:find("^https?://") then<br />
formatstr = [=[<span class="lua-type-explicit" data-name="$TypeName" $ExtraAttr>[$Link $TypeName]</span>]=]<br />
else<br />
formatstr = [=[<span class="lua-type-explicit" data-name="$TypeName" $ExtraAttr>[[$Link|$TypeName]]</span>]=]<br />
end<br />
local replacements = {<br />
Link = typeM.link,<br />
TypeName = typeM.name,<br />
ExtraAttr = ""<br />
}<br />
local formatted = formatstr:gsub("%$([a-zA-Z]+)", replacements)<br />
return formatted<br />
end<br />
<br />
---@param typeM docs.UnionType<br />
---@return string<br />
local function renderTypeUnion(typeM)<br />
if #typeM.anyOf == 1 then return renderType(typeM.anyOf[1]) end<br />
if #typeM.anyOf == 2 then<br />
-- todo: add ? for optionals<br />
end<br />
local formatstr = [=[<span class="lua-type-union">%s</span>]=]<br />
local chunks = {}<br />
for _, t in ipairs(typeM.anyOf) do<br />
chunks[#chunks+1] = renderType(t)<br />
end<br />
return formatstr:format(table.concat(chunks, " / "))<br />
end<br />
<br />
---@param typeM docs.TypeModel<br />
---@return string<br />
function renderType(typeM)<br />
if typeM.typeKind == "explicit" then<br />
---@cast typeM docs.ExplicitType<br />
return renderTypeExplicit(typeM)<br />
elseif typeM.typeKind == "union" then<br />
---@cast typeM docs.UnionType<br />
return renderTypeUnion(typeM)<br />
end<br />
error(("An internal error occured: unsure how to render a %s type"):format(tostring(typeM.typeKind)))<br />
end<br />
<br />
---@param o any<br />
---@param i number?<br />
local function printFancy(o, i)<br />
i = i or 2<br />
local indent = (" "):rep(i)<br />
if type(o) == "table" then<br />
if getmetatable(o) and getmetatable(o).__tostring then<br />
return tostring(o)<br />
end<br />
local b = "{\n"<br />
for k, v in pairs(o) do<br />
b = b .. indent .. printFancy(k, i + 2) .. " = " .. printFancy(v, i + 2) .. ",\n"<br />
end<br />
b = b .. (" "):rep(i - 2) .. "}"<br />
return b<br />
else<br />
return tostring(o)<br />
end<br />
end<br />
<br />
local function parseAndRenderType(frame)<br />
local input_args = frame:getParent().args<br />
local nargs = 0<br />
while input_args[nargs + 1] do nargs = nargs + 1 end<br />
if nargs == 0 then error "Need to specify at least one type" end<br />
<br />
if nargs == 1 then<br />
local s = spool.new(input_args[1])<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error("Expected end of type at position " .. s.cursor) end<br />
return renderType(t)<br />
else<br />
local tabulated = {}<br />
for i = 1, nargs do tabulated[i] = input_args[i] end<br />
local s = spool.new(table.concat(tabulated, "|"))<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error("Expected end of type at position " .. s.cursor) end<br />
return renderType(t)<br />
end<br />
end<br />
<br />
-- local m = parseField [[<br />
-- player global readOnly;<br />
-- type PlayerAPI;<br />
-- ]]<br />
-- print(printFancy(m))<br />
<br />
return {<br />
type = parseAndRenderType<br />
}</div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=Module:Signatures&diff=861
Module:Signatures
2025-03-31T00:43:22Z
<p>PenguinEncounter: </p>
<hr />
<div>-- a MediaWiki module<br />
<br />
--[[<br />
Syntax description:<br />
<name> <attr...> ...;;<br />
<modName> [modSyn];;<br />
]]<br />
<br />
---@alias docs.ModelKind "field" | "method" | "type"<br />
<br />
---Origin of this documentation item.<br />
---@alias docs.ModelOrigin<br />
---| "Lua" Lua 5.2 built-in types and APIs.<br />
---| "Figura" Figura types and APIs. Usually the default.<br />
---| "abstract" Describes ideas, but no concrete implementation exists.<br />
---| "typedef" Custom on-the-spot types, like function protocols or array types.<br />
<br />
---@alias Set<T> {[T]: true}<br />
<br />
---@class docs.DocModel<br />
---@field kind docs.ModelKind<br />
---@field name string?<br />
---@field prefixHint string?<br />
---@field attributes Set<string><br />
---@field origin docs.ModelOrigin<br />
<br />
---@class docs.FieldModel : docs.DocModel<br />
---@field kind "field"<br />
---@field canRead boolean<br />
---@field canWrite boolean<br />
---@field readType docs.TypeModel?<br />
---@field writeType docs.TypeModel?<br />
<br />
---@class docs.MethodModel : docs.DocModel<br />
---@field kind "method"<br />
---@field signatures docs.MethodSignature[]<br />
---@field isStatic boolean<br />
<br />
---@class docs.MethodSignature.Parameter<br />
---@field name string<br />
---@field type docs.TypeModel<br />
---@field vararg boolean?<br />
<br />
---@class docs.MethodSignature<br />
---@field returns docs.TypeModel[]<br />
---@field parameters docs.MethodSignature.Parameter[]<br />
<br />
---@class docs.TypeModel : docs.DocModel<br />
---@field kind "type"<br />
---@field typeKind "explicit" | "union"<br />
<br />
---@class docs.ExplicitType : docs.TypeModel<br />
---@field typeKind "explicit"<br />
---@field link string?<br />
<br />
---@class docs.UnionType : docs.TypeModel<br />
---@field typeKind "union"<br />
---@field anyOf docs.TypeModel[]<br />
<br />
---@type metatable<br />
local type_meta = {<br />
__tostring = function (t)<br />
return ("<type %s from %s>"):format(t.name or '(anonymous)', t.origin)<br />
end<br />
}<br />
<br />
---@class docs.spool : docs.DocModel<br />
---@field src string<br />
---@field cursor integer<br />
---@field cursorNext integer?<br />
local spool = {}<br />
<br />
---Create a new spool.<br />
---@param src string<br />
---@return docs.spool<br />
function spool.new(src)<br />
return setmetatable({<br />
src = src,<br />
cursor = 1<br />
}, {__index = spool})<br />
end<br />
<br />
---@return integer cursor<br />
function spool:consumeSpace()<br />
self.cursor = self.src:match("%s*()", self.cursor)<br />
return self.cursor<br />
end<br />
<br />
local unpack = unpack or table.unpack -- 5.2 compat<br />
<br />
---Starts matching from the current cursor position, and recieves the next cursor position from a position capture.<br />
---@param pattern string<br />
---@param noMatchMsg string Format pattern with 1 %d to hold the cursor value.<br />
---@return any ...<br />
function spool:matchc(pattern, noMatchMsg)<br />
local results = {self.src:match(pattern, self.cursor)}<br />
if #results == 0 then error(noMatchMsg:format(self.cursor)) end<br />
self.cursorNext = results[#results]<br />
results[#results] = nil<br />
return unpack(results)<br />
end<br />
<br />
---@return string<br />
function spool:peek()<br />
return self.src:sub(self.cursor, self.cursor)<br />
end<br />
<br />
function spool:adv()<br />
if self:isAtEOF() then return end<br />
self.cursor = self.cursor + 1<br />
end<br />
<br />
function spool:matchadv(pattern)<br />
local _, to = self.src:find(pattern, self.cursor)<br />
if to then<br />
self.cursor = to + 1<br />
return true<br />
end<br />
return false<br />
end<br />
<br />
function spool:commit()<br />
if not self.cursorNext then error "spool:commit(): Nothing to commit" end<br />
self.cursor = self.cursorNext<br />
self.cursorNext = nil<br />
end<br />
<br />
function spool:isAtEOF() return self.cursor > #self.src end<br />
<br />
local LUA_TYPES_URL = "https://www.lua.org/manual/5.2/manual.html#2.1"<br />
<br />
---@type table<string, docs.ExplicitType><br />
local typeDefinitions = {}<br />
---@type table<string, string><br />
local typeAlias = {}<br />
local types = setmetatable({}, {<br />
__index = function (t, k)<br />
local resolvedName = k<br />
local i = 0<br />
while typeAlias[resolvedName] do<br />
i = i + 1<br />
if i > 10 then error "internal: alias chain too long" end<br />
resolvedName = typeAlias[resolvedName]<br />
end<br />
return typeDefinitions[resolvedName]<br />
end<br />
})<br />
<br />
---@param name string<br />
---@param origin docs.ModelOrigin<br />
---@param link string?<br />
---@return docs.ExplicitType<br />
local function newExplicitType(name, origin, link)<br />
if typeDefinitions[name] then error "Type already exists" end<br />
---@type docs.ExplicitType<br />
local t = setmetatable({<br />
kind = "type",<br />
typeKind = "explicit",<br />
name = name,<br />
attributes = {},<br />
origin = origin,<br />
link = link<br />
}, type_meta)<br />
typeDefinitions[name] = t<br />
return t<br />
end<br />
<br />
---@param anyOf docs.TypeModel[]<br />
---@return docs.UnionType<br />
local function newUnionType(anyOf)<br />
local function flatten(typ)<br />
if not typ.kind or typ.typeKind == "union" then<br />
local iterator<br />
if not typ.kind then<br />
iterator = typ<br />
else<br />
iterator = typ.anyOf<br />
end<br />
local seen = {}<br />
local res = {}<br />
for _, typ2 in ipairs(iterator) do<br />
for _, v in ipairs(flatten(typ2)) do<br />
if not seen[v] then<br />
res[#res + 1] = v<br />
seen[v] = true<br />
end<br />
end<br />
end<br />
return res<br />
elseif typ.typeKind == "explicit" then<br />
return { typ }<br />
end<br />
error "No type"<br />
end<br />
---@type docs.UnionType<br />
return setmetatable({<br />
anyOf = flatten(anyOf),<br />
attributes = {},<br />
kind = "type",<br />
origin = "abstract",<br />
typeKind = "union"<br />
}, {<br />
__tostring = function (t)<br />
local chunks = {}<br />
for _, type in ipairs(t.anyOf) do<br />
chunks[#chunks+1] = tostring(type)<br />
end<br />
return table.concat(chunks, ' | ')<br />
end<br />
})<br />
end<br />
<br />
---@param name string<br />
---@param origin docs.ModelOrigin<br />
---@return docs.ExplicitType<br />
local function getOrDefineType(name, origin)<br />
local t = types[name]<br />
if t then return t end<br />
return newExplicitType(name, origin, name)<br />
end<br />
<br />
---Create a new type definition type.<br />
---@param typedefname string without #<br />
---@return docs.TypeModel<br />
local function newTypedef(typedefname)<br />
local prefixed = "#"..typedefname<br />
if typeDefinitions[prefixed] then return typeDefinitions[prefixed] end<br />
---@type docs.ExplicitType<br />
local t = setmetatable({<br />
kind = "type",<br />
typeKind = "explicit",<br />
name = typedefname,<br />
attributes = {},<br />
origin = "typedef",<br />
link = "#typedef_"..typedefname<br />
}, type_meta)<br />
typeDefinitions[prefixed] = t<br />
return t<br />
end<br />
<br />
do -- builtin types<br />
<br />
-- currying<br />
---@param sourceName string<br />
---@return fun(list: string[])<br />
local function alias(sourceName)<br />
return function(list)<br />
for _, v in ipairs(list) do<br />
typeAlias[v] = sourceName<br />
end<br />
end<br />
end<br />
<br />
newExplicitType("any", "abstract")<br />
alias "any" { "AnyType" }<br />
newExplicitType("void", "abstract")<br />
newExplicitType("nil", "Lua", LUA_TYPES_URL)<br />
alias "nil" { "null" }<br />
newExplicitType("boolean", "Lua", LUA_TYPES_URL)<br />
alias "boolean" { "Boolean" }<br />
newExplicitType("number", "Lua", LUA_TYPES_URL)<br />
alias "number" { "Number", "double", "float" }<br />
newExplicitType("integer", "Lua", LUA_TYPES_URL)<br />
alias "integer" { "Integer" }<br />
newExplicitType("string", "Lua", LUA_TYPES_URL)<br />
alias "string" { "String" }<br />
newExplicitType("function", "Lua", LUA_TYPES_URL)<br />
alias "function" { "Function" }<br />
newExplicitType("userdata", "Lua", LUA_TYPES_URL)<br />
alias "userdata" { "Userdata" }<br />
newExplicitType("table", "Lua", LUA_TYPES_URL)<br />
alias "table" { "Table" }<br />
end<br />
<br />
---@param s docs.spool<br />
local function parseComment(s)<br />
s:matchc("%*/()", "No end of comment found")<br />
s:commit()<br />
end<br />
<br />
---@param s docs.spool<br />
---@return docs.TypeModel<br />
local function parseSimpleType(s)<br />
if s:isAtEOF() then error("Expected a type at position " .. s.cursor .. " but instead found nothing") end<br />
local prefix = s:peek()<br />
if prefix == "#" then<br />
s:adv()<br />
local typename = s:matchc("^([a-zA-Z0-9]+) ?()", "Expected a typedef name at position %d, but found nothing after the #")<br />
s:commit()<br />
return newTypedef(typename)<br />
end<br />
local typename = s:matchc("^([a-zA-Z0-9]+) ?()", "Expected a type name at position %d, but found nothing")<br />
s:commit()<br />
local t = getOrDefineType(typename, "Figura")<br />
return t<br />
end<br />
<br />
---@param s docs.spool<br />
local function parseType(s)<br />
local t = parseSimpleType(s)<br />
s:consumeSpace()<br />
local nextC = s:peek()<br />
if nextC == '|' then<br />
local unions = {t}<br />
while nextC == '|' do<br />
s:adv()<br />
s:consumeSpace()<br />
unions[#unions+1] = parseSimpleType(s)<br />
s:consumeSpace()<br />
nextC = s:peek()<br />
end<br />
return newUnionType(unions)<br />
else<br />
return t<br />
end<br />
end<br />
<br />
local function noop() end<br />
<br />
---@type table<string, fun(line: string, model: docs.DocModel)><br />
local sharedModifiers = {<br />
prefixHint = function (line, model)<br />
if model.prefixHint then error "duplicate prefixHint declaration" end<br />
model.prefixHint = line<br />
end<br />
}<br />
---@type table<string, fun(model: docs.DocModel)><br />
local sharedAttributes = {<br />
global = noop<br />
}<br />
<br />
---@type table<string, fun(line: string, model: docs.MethodModel)><br />
local methodModifiers = {<br />
}<br />
methodModifiers = setmetatable(methodModifiers, {__index = sharedModifiers})<br />
---@type table<string, fun(model: docs.MethodModel)><br />
local methodAttributes = {<br />
static = function (model)<br />
model.isStatic = true<br />
end,<br />
hostOnly = noop<br />
}<br />
methodAttributes = setmetatable(methodAttributes, {__index = sharedAttributes})<br />
<br />
---@type table<string, fun(line: string, model: docs.FieldModel)><br />
local fieldModifiers = {<br />
["type"] = function (line, model)<br />
local s = spool.new(line)<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error "expected end of statement after field type" end<br />
model.readType = t<br />
model.writeType = t<br />
end,<br />
["readType"] = function (line, model)<br />
local s = spool.new(line)<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error "expected end of statement after field readType" end<br />
model.readType = t<br />
end,<br />
["writeType"] = function (line, model)<br />
local s = spool.new(line)<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error "expected end of statement after field writeType" end<br />
model.writeType = t<br />
end,<br />
}<br />
fieldModifiers = setmetatable(fieldModifiers, {__index = sharedModifiers})<br />
---@type table<string, fun(model: docs.FieldModel)><br />
local fieldAttributes = {<br />
readOnly = function (model)<br />
model.canWrite = false<br />
end,<br />
writeOnly = function (model)<br />
model.canRead = false<br />
end<br />
}<br />
fieldAttributes = setmetatable(fieldAttributes, {__index = sharedAttributes})<br />
<br />
---@param sigtext string<br />
local function parseMethodSignature(sigtext)<br />
local s = spool.new(sigtext)<br />
<br />
---@type docs.MethodSignature<br />
local model = {<br />
returns = {},<br />
parameters = {}<br />
}<br />
<br />
local function parseParameter(assumeV)<br />
---@type docs.MethodSignature.Parameter<br />
local param = setmetatable({<br />
name = "",<br />
type = typeDefinitions.void,<br />
vararg = false<br />
}, {<br />
__tostring = function (t)<br />
return ("<param %s (%s)>"):format(t.name, tostring(t.type))<br />
end<br />
})<br />
if assumeV then<br />
param.name = "..."<br />
param.vararg = true<br />
else<br />
-- already consumed: 'parameter '<br />
if s:matchadv("^%.%.%. ?") then<br />
param.name = "..."<br />
param.vararg = true<br />
else<br />
param.name = s:matchc("^([a-zA-Z0-9]+) ?()", "Expected parameter name at %d but found nothing")<br />
s:commit()<br />
end<br />
end<br />
s:consumeSpace()<br />
param.type = parseType(s)<br />
s:consumeSpace()<br />
if not s:matchadv('^;') then error("Expected a semicolon to end parameter declaration at position " .. s.cursor) end<br />
model.parameters[#model.parameters+1] = param<br />
end<br />
<br />
local function parseReturns()<br />
-- already consumed: 'returns '<br />
model.returns[#model.returns+1] = parseType(s)<br />
s:consumeSpace()<br />
while s:matchadv('^,') do<br />
s:consumeSpace()<br />
model.returns[#model.returns+1] = parseType(s)<br />
s:consumeSpace()<br />
end<br />
if not s:matchadv('^;') then error("Expected a semicolon to end returns declaration at position " .. s.cursor) end<br />
end<br />
<br />
local function parseStmt()<br />
if s:matchadv "^/%*" then<br />
return parseComment(s)<br />
end<br />
if s:matchadv "^returns " then<br />
return parseReturns()<br />
end<br />
if s:matchadv "^parameter%.%.%." then<br />
return parseParameter(true)<br />
end<br />
if s:matchadv "^parameter " then<br />
return parseParameter()<br />
end<br />
error("No valid signature statement at " .. s.cursor)<br />
end<br />
<br />
local function parse()<br />
s:consumeSpace()<br />
while not s:isAtEOF() do<br />
parseStmt()<br />
s:consumeSpace()<br />
end<br />
end<br />
parse()<br />
return model<br />
end<br />
<br />
---@param docstr string<br />
local function parseMethod(docstr)<br />
local s = spool.new(docstr)<br />
<br />
---@type docs.MethodModel<br />
local model = {<br />
kind = "method",<br />
attributes = {},<br />
isStatic = false,<br />
name = "<unnamed>",<br />
origin = "Figura",<br />
signatures = {},<br />
}<br />
local parseTopLevelStmt, parseMethodHeader, parseSignatureOuter<br />
local blockKw = {}<br />
<br />
function parseSignatureOuter()<br />
s:consumeSpace()<br />
---@type string<br />
local block_content = s:matchc("^(%b{})%s*;()", "Expected a bracketed block after 'signature' at position %d")<br />
local inside = block_content:sub(2, -2)<br />
local sig = parseMethodSignature(inside)<br />
model.signatures[#model.signatures+1] = sig<br />
s:commit()<br />
end<br />
blockKw.signature = parseSignatureOuter<br />
<br />
function parseMethodHeader()<br />
local name = s:matchc("^([^%s;]+) ?()", "Expected method name at %d")<br />
model.name = name<br />
s:commit()<br />
s:consumeSpace()<br />
local peek = s:peek()<br />
while #peek ~= 0 and peek ~= ';' do<br />
local attr = s:matchc("^([^%s;]+) ?()", "Expected something else!")<br />
if not methodAttributes[attr] then<br />
error(("Unknown method attribute '%s' at position %d in method header"):format(attr, s.cursor))<br />
end<br />
methodAttributes[attr](model)<br />
model.attributes[attr] = true<br />
s:commit()<br />
s:consumeSpace()<br />
peek = s:peek()<br />
end<br />
if peek == ';' then<br />
s:adv() -- advance past the ;<br />
else<br />
error("Reached end of method documentation while parsing header")<br />
end<br />
end<br />
<br />
function parseTopLevelStmt()<br />
local startAt = s.cursor<br />
---@type string<br />
local action = s:matchc("^([^%s;]+) ?()", "Expected a modifier or block keyword, but got nothing instead at position %d")<br />
s:commit()<br />
if methodModifiers[action] then<br />
---@type string<br />
local remainder = s:matchc("^(.-);%s*()", "Expected semicolon to end statement around %d")<br />
s:commit()<br />
return methodModifiers[action](remainder, model)<br />
end<br />
if blockKw[action] then return blockKw[action]() end<br />
error(("Expected a modifier or block keyword, but got '%s' instead at position %d"):format(action, startAt))<br />
end<br />
<br />
local function parse()<br />
s:consumeSpace()<br />
parseMethodHeader()<br />
s:consumeSpace()<br />
while not s:isAtEOF() do<br />
parseTopLevelStmt()<br />
s:consumeSpace()<br />
end<br />
end<br />
<br />
parse()<br />
return model<br />
end<br />
<br />
---@param docstr string<br />
---@return docs.FieldModel<br />
local function parseField(docstr)<br />
local s = spool.new(docstr)<br />
<br />
---@type docs.FieldModel<br />
local model = {<br />
kind = "field",<br />
attributes = {},<br />
name = "<unnamed>",<br />
origin = "Figura",<br />
canRead = true,<br />
canWrite = true<br />
}<br />
<br />
local parseTopLevelStmt, parseFieldHeader, parseSignatureOuter<br />
<br />
function parseFieldHeader()<br />
local name = s:matchc("^([^%s;]+) ?()", "Expected field name at %d")<br />
model.name = name<br />
s:commit()<br />
s:consumeSpace()<br />
local peek = s:peek()<br />
while #peek ~= 0 and peek ~= ';' do<br />
local attr = s:matchc("^([^%s;]+) ?()", "Expected something else!")<br />
if not fieldAttributes[attr] then<br />
error(("Unknown field attribute '%s' at position %d in field header"):format(attr, s.cursor))<br />
end<br />
fieldAttributes[attr](model)<br />
model.attributes[attr] = true<br />
s:commit()<br />
s:consumeSpace()<br />
peek = s:peek()<br />
end<br />
if peek == ';' then<br />
s:adv() -- advance past the ;<br />
else<br />
error("Reached end of field documentation while parsing header")<br />
end<br />
end<br />
<br />
function parseTopLevelStmt()<br />
local startAt = s.cursor<br />
---@type string<br />
local action = s:matchc("^([^%s;]+) ?()", "Expected a modifier, but got nothing instead at position %d")<br />
s:commit()<br />
if fieldModifiers[action] then<br />
---@type string<br />
local remainder = s:matchc("^(.-);%s*()", "Expected semicolon to end statement around %d")<br />
s:commit()<br />
return fieldModifiers[action](remainder, model)<br />
end<br />
error(("Expected a modifier, but got '%s' instead at position %d"):format(action, startAt))<br />
end<br />
<br />
local function parse()<br />
s:consumeSpace()<br />
parseFieldHeader()<br />
s:consumeSpace()<br />
while not s:isAtEOF() do<br />
parseTopLevelStmt()<br />
s:consumeSpace()<br />
end<br />
end<br />
<br />
parse()<br />
return model<br />
end<br />
<br />
local renderType<br />
<br />
---@param typeM docs.ExplicitType<br />
---@return string<br />
local function renderTypeExplicit(typeM)<br />
local formatstr<br />
if not typeM.link then<br />
formatstr = [=[<span class="lua-type-explicit" data-name="$TypeName" $ExtraAttr>$TypeName</span>]=]<br />
elseif typeM.link:find("^https?://") then<br />
formatstr = [=[<span class="lua-type-explicit" data-name="$TypeName" $ExtraAttr>[$Link $TypeName]</span>]=]<br />
else<br />
formatstr = [=[<span class="lua-type-explicit" data-name="$TypeName" $ExtraAttr>[[$Link|$TypeName]]</span>]=]<br />
end<br />
local replacements = {<br />
Link = typeM.link,<br />
TypeName = typeM.name,<br />
ExtraAttr = ""<br />
}<br />
local formatted = formatstr:gsub("%$([a-zA-Z]+)", replacements)<br />
return formatted<br />
end<br />
<br />
---@param typeM docs.UnionType<br />
---@return string<br />
local function renderTypeUnion(typeM)<br />
if #typeM.anyOf == 1 then return renderType(typeM.anyOf[1]) end<br />
if #typeM.anyOf == 2 then<br />
-- todo: add ? for optionals<br />
end<br />
local formatstr = [=[<span class="lua-type-union">%s</span>]=]<br />
local chunks = {}<br />
for _, t in ipairs(typeM.anyOf) do<br />
chunks[#chunks+1] = renderType(t)<br />
end<br />
return formatstr:format(table.concat(chunks, " "))<br />
end<br />
<br />
---@param typeM docs.TypeModel<br />
---@return string<br />
function renderType(typeM)<br />
if typeM.typeKind == "explicit" then<br />
---@cast typeM docs.ExplicitType<br />
return renderTypeExplicit(typeM)<br />
elseif typeM.typeKind == "union" then<br />
---@cast typeM docs.UnionType<br />
return renderTypeUnion(typeM)<br />
end<br />
error(("An internal error occured: unsure how to render a %s type"):format(tostring(typeM.typeKind)))<br />
end<br />
<br />
---@param o any<br />
---@param i number?<br />
local function printFancy(o, i)<br />
i = i or 2<br />
local indent = (" "):rep(i)<br />
if type(o) == "table" then<br />
if getmetatable(o) and getmetatable(o).__tostring then<br />
return tostring(o)<br />
end<br />
local b = "{\n"<br />
for k, v in pairs(o) do<br />
b = b .. indent .. printFancy(k, i + 2) .. " = " .. printFancy(v, i + 2) .. ",\n"<br />
end<br />
b = b .. (" "):rep(i - 2) .. "}"<br />
return b<br />
else<br />
return tostring(o)<br />
end<br />
end<br />
<br />
local function parseAndRenderType(frame)<br />
local input_args = frame:getParent().args<br />
local nargs = 0<br />
while input_args[nargs + 1] do nargs = nargs + 1 end<br />
if nargs == 0 then error "Need to specify at least one type" end<br />
<br />
if nargs == 1 then<br />
local s = spool.new(input_args[1])<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error("Expected end of type at position " .. s.cursor) end<br />
return renderType(t)<br />
else<br />
local tabulated = {}<br />
for i = 1, nargs do tabulated[i] = input_args[i] end<br />
local s = spool.new(table.concat(tabulated, "|"))<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error("Expected end of type at position " .. s.cursor) end<br />
return renderType(t)<br />
end<br />
end<br />
<br />
-- local m = parseField [[<br />
-- player global readOnly;<br />
-- type PlayerAPI;<br />
-- ]]<br />
-- print(printFancy(m))<br />
<br />
return {<br />
type = parseAndRenderType<br />
}</div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=Module:Signatures&diff=860
Module:Signatures
2025-03-30T23:54:09Z
<p>PenguinEncounter: </p>
<hr />
<div>-- a MediaWiki module<br />
<br />
--[[<br />
Syntax description:<br />
<name> <attr...> ...;;<br />
<modName> [modSyn];;<br />
]]<br />
<br />
---@alias docs.ModelKind "field" | "method" | "type"<br />
<br />
---Origin of this documentation item.<br />
---@alias docs.ModelOrigin<br />
---| "Lua" Lua 5.2 built-in types and APIs.<br />
---| "Figura" Figura types and APIs. Usually the default.<br />
---| "abstract" Describes ideas, but no concrete implementation exists.<br />
---| "typedef" Custom on-the-spot types, like function protocols or array types.<br />
<br />
---@alias Set<T> {[T]: true}<br />
<br />
---@class docs.DocModel<br />
---@field kind docs.ModelKind<br />
---@field name string?<br />
---@field prefixHint string?<br />
---@field attributes Set<string><br />
---@field origin docs.ModelOrigin<br />
<br />
---@class docs.FieldModel : docs.DocModel<br />
---@field kind "field"<br />
---@field canRead boolean<br />
---@field canWrite boolean<br />
---@field readType docs.TypeModel?<br />
---@field writeType docs.TypeModel?<br />
<br />
---@class docs.MethodModel : docs.DocModel<br />
---@field kind "method"<br />
---@field signatures docs.MethodSignature[]<br />
---@field isStatic boolean<br />
<br />
---@class docs.MethodSignature.Parameter<br />
---@field name string<br />
---@field type docs.TypeModel<br />
---@field vararg boolean?<br />
<br />
---@class docs.MethodSignature<br />
---@field returns docs.TypeModel[]<br />
---@field parameters docs.MethodSignature.Parameter[]<br />
<br />
---@class docs.TypeModel : docs.DocModel<br />
---@field kind "type"<br />
---@field typeKind "explicit" | "union"<br />
<br />
---@class docs.ExplicitType : docs.TypeModel<br />
---@field typeKind "explicit"<br />
---@field link string?<br />
<br />
---@class docs.UnionType : docs.TypeModel<br />
---@field typeKind "union"<br />
---@field anyOf docs.TypeModel[]<br />
<br />
---@type metatable<br />
local type_meta = {<br />
__tostring = function (t)<br />
return ("<type %s from %s>"):format(t.name or '(anonymous)', t.origin)<br />
end<br />
}<br />
<br />
---@class docs.spool : docs.DocModel<br />
---@field src string<br />
---@field cursor integer<br />
---@field cursorNext integer?<br />
local spool = {}<br />
<br />
---Create a new spool.<br />
---@param src string<br />
---@return docs.spool<br />
function spool.new(src)<br />
return setmetatable({<br />
src = src,<br />
cursor = 1<br />
}, {__index = spool})<br />
end<br />
<br />
---@return integer cursor<br />
function spool:consumeSpace()<br />
self.cursor = self.src:match("%s*()", self.cursor)<br />
return self.cursor<br />
end<br />
<br />
local unpack = unpack or table.unpack -- 5.2 compat<br />
<br />
---Starts matching from the current cursor position, and recieves the next cursor position from a position capture.<br />
---@param pattern string<br />
---@param noMatchMsg string Format pattern with 1 %d to hold the cursor value.<br />
---@return any ...<br />
function spool:matchc(pattern, noMatchMsg)<br />
local results = {self.src:match(pattern, self.cursor)}<br />
if #results == 0 then error(noMatchMsg:format(self.cursor)) end<br />
self.cursorNext = results[#results]<br />
results[#results] = nil<br />
return unpack(results)<br />
end<br />
<br />
---@return string<br />
function spool:peek()<br />
return self.src:sub(self.cursor, self.cursor)<br />
end<br />
<br />
function spool:adv()<br />
if self:isAtEOF() then return end<br />
self.cursor = self.cursor + 1<br />
end<br />
<br />
function spool:matchadv(pattern)<br />
local _, to = self.src:find(pattern, self.cursor)<br />
if to then<br />
self.cursor = to + 1<br />
return true<br />
end<br />
return false<br />
end<br />
<br />
function spool:commit()<br />
if not self.cursorNext then error "spool:commit(): Nothing to commit" end<br />
self.cursor = self.cursorNext<br />
self.cursorNext = nil<br />
end<br />
<br />
function spool:isAtEOF() return self.cursor > #self.src end<br />
<br />
local LUA_TYPES_URL = "https://www.lua.org/manual/5.2/manual.html#2.1"<br />
<br />
---@type table<string, docs.ExplicitType><br />
local typeDefinitions = {}<br />
---@type table<string, string><br />
local typeAlias = {}<br />
local types = setmetatable({}, {<br />
__index = function (t, k)<br />
local resolvedName = k<br />
local i = 0<br />
while typeAlias[resolvedName] do<br />
i = i + 1<br />
if i > 10 then error "internal: alias chain too long" end<br />
resolvedName = typeAlias[resolvedName]<br />
end<br />
return typeDefinitions[resolvedName]<br />
end<br />
})<br />
<br />
---@param name string<br />
---@param origin docs.ModelOrigin<br />
---@param link string?<br />
---@return docs.ExplicitType<br />
local function newExplicitType(name, origin, link)<br />
if typeDefinitions[name] then error "Type already exists" end<br />
---@type docs.ExplicitType<br />
local t = setmetatable({<br />
kind = "type",<br />
typeKind = "explicit",<br />
name = name,<br />
attributes = {},<br />
origin = origin,<br />
link = link<br />
}, type_meta)<br />
typeDefinitions[name] = t<br />
return t<br />
end<br />
<br />
---@param anyOf docs.TypeModel[]<br />
---@return docs.UnionType<br />
local function newUnionType(anyOf)<br />
local function flatten(typ)<br />
if not typ.kind or typ.typeKind == "union" then<br />
local iterator<br />
if not typ.kind then<br />
iterator = typ<br />
else<br />
iterator = typ.anyOf<br />
end<br />
local seen = {}<br />
local res = {}<br />
for _, typ2 in ipairs(iterator) do<br />
for _, v in ipairs(flatten(typ2)) do<br />
if not seen[v] then<br />
res[#res + 1] = v<br />
seen[v] = true<br />
end<br />
end<br />
end<br />
return res<br />
elseif typ.typeKind == "explicit" then<br />
return { typ }<br />
end<br />
error "No type"<br />
end<br />
---@type docs.UnionType<br />
return setmetatable({<br />
anyOf = flatten(anyOf),<br />
attributes = {},<br />
kind = "type",<br />
origin = "abstract",<br />
typeKind = "union"<br />
}, {<br />
__tostring = function (t)<br />
local chunks = {}<br />
for _, type in ipairs(t.anyOf) do<br />
chunks[#chunks+1] = tostring(type)<br />
end<br />
return table.concat(chunks, ' | ')<br />
end<br />
})<br />
end<br />
<br />
---@param name string<br />
---@param origin docs.ModelOrigin<br />
---@return docs.ExplicitType<br />
local function getOrDefineType(name, origin)<br />
local t = types[name]<br />
if t then return t end<br />
return newExplicitType(name, origin, name)<br />
end<br />
<br />
---Create a new type definition type.<br />
---@param typedefname string without #<br />
---@return docs.TypeModel<br />
local function newTypedef(typedefname)<br />
local prefixed = "#"..typedefname<br />
if typeDefinitions[prefixed] then return typeDefinitions[prefixed] end<br />
---@type docs.ExplicitType<br />
local t = setmetatable({<br />
kind = "type",<br />
typeKind = "explicit",<br />
name = typedefname,<br />
attributes = {},<br />
origin = "typedef",<br />
link = "#typedef_"..typedefname<br />
}, type_meta)<br />
typeDefinitions[prefixed] = t<br />
return t<br />
end<br />
<br />
do -- builtin types<br />
<br />
-- currying<br />
---@param sourceName string<br />
---@return fun(list: string[])<br />
local function alias(sourceName)<br />
return function(list)<br />
for _, v in ipairs(list) do<br />
typeAlias[v] = sourceName<br />
end<br />
end<br />
end<br />
<br />
newExplicitType("any", "abstract")<br />
alias "any" { "AnyType" }<br />
newExplicitType("void", "abstract")<br />
newExplicitType("nil", "Lua", LUA_TYPES_URL)<br />
alias "nil" { "null" }<br />
newExplicitType("boolean", "Lua", LUA_TYPES_URL)<br />
alias "boolean" { "Boolean" }<br />
newExplicitType("number", "Lua", LUA_TYPES_URL)<br />
alias "number" { "Number", "double", "float" }<br />
newExplicitType("integer", "Lua", LUA_TYPES_URL)<br />
alias "integer" { "Integer" }<br />
newExplicitType("string", "Lua", LUA_TYPES_URL)<br />
alias "string" { "String" }<br />
newExplicitType("function", "Lua", LUA_TYPES_URL)<br />
alias "function" { "Function" }<br />
newExplicitType("userdata", "Lua", LUA_TYPES_URL)<br />
alias "userdata" { "Userdata" }<br />
newExplicitType("table", "Lua", LUA_TYPES_URL)<br />
alias "table" { "Table" }<br />
end<br />
<br />
---@param s docs.spool<br />
local function parseComment(s)<br />
s:matchc("%*/()", "No end of comment found")<br />
s:commit()<br />
end<br />
<br />
---@param s docs.spool<br />
---@return docs.TypeModel<br />
local function parseSimpleType(s)<br />
if s:isAtEOF() then error("Expected a type at position " .. s.cursor .. " but instead found nothing") end<br />
local prefix = s:peek()<br />
if prefix == "#" then<br />
s:adv()<br />
local typename = s:matchc("^([a-zA-Z0-9]+) ?()", "Expected a typedef name at position %d, but found nothing after the #")<br />
s:commit()<br />
return newTypedef(typename)<br />
end<br />
local typename = s:matchc("^([a-zA-Z0-9]+) ?()", "Expected a type name at position %d, but found nothing")<br />
s:commit()<br />
local t = getOrDefineType(typename, "Figura")<br />
return t<br />
end<br />
<br />
---@param s docs.spool<br />
local function parseType(s)<br />
local t = parseSimpleType(s)<br />
s:consumeSpace()<br />
local nextC = s:peek()<br />
if nextC == '|' then<br />
local unions = {t}<br />
while nextC == '|' do<br />
s:adv()<br />
s:consumeSpace()<br />
unions[#unions+1] = parseSimpleType(s)<br />
s:consumeSpace()<br />
nextC = s:peek()<br />
end<br />
return newUnionType(unions)<br />
else<br />
return t<br />
end<br />
end<br />
<br />
local function noop() end<br />
<br />
---@type table<string, fun(line: string, model: docs.DocModel)><br />
local sharedModifiers = {<br />
prefixHint = function (line, model)<br />
if model.prefixHint then error "duplicate prefixHint declaration" end<br />
model.prefixHint = line<br />
end<br />
}<br />
---@type table<string, fun(model: docs.DocModel)><br />
local sharedAttributes = {<br />
global = noop<br />
}<br />
<br />
---@type table<string, fun(line: string, model: docs.MethodModel)><br />
local methodModifiers = {<br />
}<br />
methodModifiers = setmetatable(methodModifiers, {__index = sharedModifiers})<br />
---@type table<string, fun(model: docs.MethodModel)><br />
local methodAttributes = {<br />
static = function (model)<br />
model.isStatic = true<br />
end,<br />
hostOnly = noop<br />
}<br />
methodAttributes = setmetatable(methodAttributes, {__index = sharedAttributes})<br />
<br />
---@type table<string, fun(line: string, model: docs.FieldModel)><br />
local fieldModifiers = {<br />
["type"] = function (line, model)<br />
local s = spool.new(line)<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error "expected end of statement after field type" end<br />
model.readType = t<br />
model.writeType = t<br />
end,<br />
["readType"] = function (line, model)<br />
local s = spool.new(line)<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error "expected end of statement after field readType" end<br />
model.readType = t<br />
end,<br />
["writeType"] = function (line, model)<br />
local s = spool.new(line)<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error "expected end of statement after field writeType" end<br />
model.writeType = t<br />
end,<br />
}<br />
fieldModifiers = setmetatable(fieldModifiers, {__index = sharedModifiers})<br />
---@type table<string, fun(model: docs.FieldModel)><br />
local fieldAttributes = {<br />
readOnly = function (model)<br />
model.canWrite = false<br />
end,<br />
writeOnly = function (model)<br />
model.canRead = false<br />
end<br />
}<br />
fieldAttributes = setmetatable(fieldAttributes, {__index = sharedAttributes})<br />
<br />
---@param sigtext string<br />
local function parseMethodSignature(sigtext)<br />
local s = spool.new(sigtext)<br />
<br />
---@type docs.MethodSignature<br />
local model = {<br />
returns = {},<br />
parameters = {}<br />
}<br />
<br />
local function parseParameter(assumeV)<br />
---@type docs.MethodSignature.Parameter<br />
local param = setmetatable({<br />
name = "",<br />
type = typeDefinitions.void,<br />
vararg = false<br />
}, {<br />
__tostring = function (t)<br />
return ("<param %s (%s)>"):format(t.name, tostring(t.type))<br />
end<br />
})<br />
if assumeV then<br />
param.name = "..."<br />
param.vararg = true<br />
else<br />
-- already consumed: 'parameter '<br />
if s:matchadv("^%.%.%. ?") then<br />
param.name = "..."<br />
param.vararg = true<br />
else<br />
param.name = s:matchc("^([a-zA-Z0-9]+) ?()", "Expected parameter name at %d but found nothing")<br />
s:commit()<br />
end<br />
end<br />
s:consumeSpace()<br />
param.type = parseType(s)<br />
s:consumeSpace()<br />
if not s:matchadv('^;') then error("Expected a semicolon to end parameter declaration at position " .. s.cursor) end<br />
model.parameters[#model.parameters+1] = param<br />
end<br />
<br />
local function parseReturns()<br />
-- already consumed: 'returns '<br />
model.returns[#model.returns+1] = parseType(s)<br />
s:consumeSpace()<br />
while s:matchadv('^,') do<br />
s:consumeSpace()<br />
model.returns[#model.returns+1] = parseType(s)<br />
s:consumeSpace()<br />
end<br />
if not s:matchadv('^;') then error("Expected a semicolon to end returns declaration at position " .. s.cursor) end<br />
end<br />
<br />
local function parseStmt()<br />
if s:matchadv "^/%*" then<br />
return parseComment(s)<br />
end<br />
if s:matchadv "^returns " then<br />
return parseReturns()<br />
end<br />
if s:matchadv "^parameter%.%.%." then<br />
return parseParameter(true)<br />
end<br />
if s:matchadv "^parameter " then<br />
return parseParameter()<br />
end<br />
error("No valid signature statement at " .. s.cursor)<br />
end<br />
<br />
local function parse()<br />
s:consumeSpace()<br />
while not s:isAtEOF() do<br />
parseStmt()<br />
s:consumeSpace()<br />
end<br />
end<br />
parse()<br />
return model<br />
end<br />
<br />
---@param docstr string<br />
local function parseMethod(docstr)<br />
local s = spool.new(docstr)<br />
<br />
---@type docs.MethodModel<br />
local model = {<br />
kind = "method",<br />
attributes = {},<br />
isStatic = false,<br />
name = "<unnamed>",<br />
origin = "Figura",<br />
signatures = {},<br />
}<br />
local parseTopLevelStmt, parseMethodHeader, parseSignatureOuter<br />
local blockKw = {}<br />
<br />
function parseSignatureOuter()<br />
s:consumeSpace()<br />
---@type string<br />
local block_content = s:matchc("^(%b{})%s*;()", "Expected a bracketed block after 'signature' at position %d")<br />
local inside = block_content:sub(2, -2)<br />
local sig = parseMethodSignature(inside)<br />
model.signatures[#model.signatures+1] = sig<br />
s:commit()<br />
end<br />
blockKw.signature = parseSignatureOuter<br />
<br />
function parseMethodHeader()<br />
local name = s:matchc("^([^%s;]+) ?()", "Expected method name at %d")<br />
model.name = name<br />
s:commit()<br />
s:consumeSpace()<br />
local peek = s:peek()<br />
while #peek ~= 0 and peek ~= ';' do<br />
local attr = s:matchc("^([^%s;]+) ?()", "Expected something else!")<br />
if not methodAttributes[attr] then<br />
error(("Unknown method attribute '%s' at position %d in method header"):format(attr, s.cursor))<br />
end<br />
methodAttributes[attr](model)<br />
model.attributes[attr] = true<br />
s:commit()<br />
s:consumeSpace()<br />
peek = s:peek()<br />
end<br />
if peek == ';' then<br />
s:adv() -- advance past the ;<br />
else<br />
error("Reached end of method documentation while parsing header")<br />
end<br />
end<br />
<br />
function parseTopLevelStmt()<br />
local startAt = s.cursor<br />
---@type string<br />
local action = s:matchc("^([^%s;]+) ?()", "Expected a modifier or block keyword, but got nothing instead at position %d")<br />
s:commit()<br />
if methodModifiers[action] then<br />
---@type string<br />
local remainder = s:matchc("^(.-);%s*()", "Expected semicolon to end statement around %d")<br />
s:commit()<br />
return methodModifiers[action](remainder, model)<br />
end<br />
if blockKw[action] then return blockKw[action]() end<br />
error(("Expected a modifier or block keyword, but got '%s' instead at position %d"):format(action, startAt))<br />
end<br />
<br />
local function parse()<br />
s:consumeSpace()<br />
parseMethodHeader()<br />
s:consumeSpace()<br />
while not s:isAtEOF() do<br />
parseTopLevelStmt()<br />
s:consumeSpace()<br />
end<br />
end<br />
<br />
parse()<br />
return model<br />
end<br />
<br />
---@param docstr string<br />
---@return docs.FieldModel<br />
local function parseField(docstr)<br />
local s = spool.new(docstr)<br />
<br />
---@type docs.FieldModel<br />
local model = {<br />
kind = "field",<br />
attributes = {},<br />
name = "<unnamed>",<br />
origin = "Figura",<br />
canRead = true,<br />
canWrite = true<br />
}<br />
<br />
local parseTopLevelStmt, parseFieldHeader, parseSignatureOuter<br />
<br />
function parseFieldHeader()<br />
local name = s:matchc("^([^%s;]+) ?()", "Expected field name at %d")<br />
model.name = name<br />
s:commit()<br />
s:consumeSpace()<br />
local peek = s:peek()<br />
while #peek ~= 0 and peek ~= ';' do<br />
local attr = s:matchc("^([^%s;]+) ?()", "Expected something else!")<br />
if not fieldAttributes[attr] then<br />
error(("Unknown field attribute '%s' at position %d in field header"):format(attr, s.cursor))<br />
end<br />
fieldAttributes[attr](model)<br />
model.attributes[attr] = true<br />
s:commit()<br />
s:consumeSpace()<br />
peek = s:peek()<br />
end<br />
if peek == ';' then<br />
s:adv() -- advance past the ;<br />
else<br />
error("Reached end of field documentation while parsing header")<br />
end<br />
end<br />
<br />
function parseTopLevelStmt()<br />
local startAt = s.cursor<br />
---@type string<br />
local action = s:matchc("^([^%s;]+) ?()", "Expected a modifier, but got nothing instead at position %d")<br />
s:commit()<br />
if fieldModifiers[action] then<br />
---@type string<br />
local remainder = s:matchc("^(.-);%s*()", "Expected semicolon to end statement around %d")<br />
s:commit()<br />
return fieldModifiers[action](remainder, model)<br />
end<br />
error(("Expected a modifier, but got '%s' instead at position %d"):format(action, startAt))<br />
end<br />
<br />
local function parse()<br />
s:consumeSpace()<br />
parseFieldHeader()<br />
s:consumeSpace()<br />
while not s:isAtEOF() do<br />
parseTopLevelStmt()<br />
s:consumeSpace()<br />
end<br />
end<br />
<br />
parse()<br />
return model<br />
end<br />
<br />
---@param typeM docs.TypeModel<br />
local function renderType(typeM)<br />
return tostring(typeM)<br />
end<br />
<br />
---@param o any<br />
---@param i number?<br />
local function printFancy(o, i)<br />
i = i or 2<br />
local indent = (" "):rep(i)<br />
if type(o) == "table" then<br />
if getmetatable(o) and getmetatable(o).__tostring then<br />
return tostring(o)<br />
end<br />
local b = "{\n"<br />
for k, v in pairs(o) do<br />
b = b .. indent .. printFancy(k, i + 2) .. " = " .. printFancy(v, i + 2) .. ",\n"<br />
end<br />
b = b .. (" "):rep(i - 2) .. "}"<br />
return b<br />
else<br />
return tostring(o)<br />
end<br />
end<br />
<br />
local function parseAndRenderType(frame)<br />
local input_args = frame:getParent().args<br />
local nargs = 0<br />
while input_args[nargs + 1] do nargs = nargs + 1 end<br />
if nargs == 0 then error "Need to specify at least one type" end<br />
<br />
if nargs == 1 then<br />
local s = spool.new(input_args[1])<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error("Expected end of type at position " .. s.cursor) end<br />
return renderType(t)<br />
else<br />
local tabulated = {}<br />
for i = 1, nargs do tabulated[i] = input_args[i] end<br />
local s = spool.new(table.concat(tabulated, "|"))<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error("Expected end of type at position " .. s.cursor) end<br />
return renderType(t)<br />
end<br />
end<br />
<br />
-- local m = parseField [[<br />
-- player global readOnly;<br />
-- type PlayerAPI;<br />
-- ]]<br />
-- print(printFancy(m))<br />
<br />
return {<br />
type = parseAndRenderType<br />
}</div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=Module:Signatures&diff=859
Module:Signatures
2025-03-30T23:53:48Z
<p>PenguinEncounter: </p>
<hr />
<div>-- a MediaWiki module<br />
<br />
--[[<br />
Syntax description:<br />
<name> <attr...> ...;;<br />
<modName> [modSyn];;<br />
]]<br />
<br />
---@alias docs.ModelKind "field" | "method" | "type"<br />
<br />
---Origin of this documentation item.<br />
---@alias docs.ModelOrigin<br />
---| "Lua" Lua 5.2 built-in types and APIs.<br />
---| "Figura" Figura types and APIs. Usually the default.<br />
---| "abstract" Describes ideas, but no concrete implementation exists.<br />
---| "typedef" Custom on-the-spot types, like function protocols or array types.<br />
<br />
---@alias Set<T> {[T]: true}<br />
<br />
---@class docs.DocModel<br />
---@field kind docs.ModelKind<br />
---@field name string?<br />
---@field prefixHint string?<br />
---@field attributes Set<string><br />
---@field origin docs.ModelOrigin<br />
<br />
---@class docs.FieldModel : docs.DocModel<br />
---@field kind "field"<br />
---@field canRead boolean<br />
---@field canWrite boolean<br />
---@field readType docs.TypeModel?<br />
---@field writeType docs.TypeModel?<br />
<br />
---@class docs.MethodModel : docs.DocModel<br />
---@field kind "method"<br />
---@field signatures docs.MethodSignature[]<br />
---@field isStatic boolean<br />
<br />
---@class docs.MethodSignature.Parameter<br />
---@field name string<br />
---@field type docs.TypeModel<br />
---@field vararg boolean?<br />
<br />
---@class docs.MethodSignature<br />
---@field returns docs.TypeModel[]<br />
---@field parameters docs.MethodSignature.Parameter[]<br />
<br />
---@class docs.TypeModel : docs.DocModel<br />
---@field kind "type"<br />
---@field typeKind "explicit" | "union"<br />
<br />
---@class docs.ExplicitType : docs.TypeModel<br />
---@field typeKind "explicit"<br />
---@field link string?<br />
<br />
---@class docs.UnionType : docs.TypeModel<br />
---@field typeKind "union"<br />
---@field anyOf docs.TypeModel[]<br />
<br />
---@type metatable<br />
local type_meta = {<br />
__tostring = function (t)<br />
return ("<type %s from %s>"):format(t.name or '(anonymous)', t.origin)<br />
end<br />
}<br />
<br />
---@class docs.spool : docs.DocModel<br />
---@field src string<br />
---@field cursor integer<br />
---@field cursorNext integer?<br />
local spool = {}<br />
<br />
---Create a new spool.<br />
---@param src string<br />
---@return docs.spool<br />
function spool.new(src)<br />
return setmetatable({<br />
src = src,<br />
cursor = 1<br />
}, {__index = spool})<br />
end<br />
<br />
---@return integer cursor<br />
function spool:consumeSpace()<br />
self.cursor = self.src:match("%s*()", self.cursor)<br />
return self.cursor<br />
end<br />
<br />
local unpack = unpack or table.unpack -- 5.2 compat<br />
<br />
---Starts matching from the current cursor position, and recieves the next cursor position from a position capture.<br />
---@param pattern string<br />
---@param noMatchMsg string Format pattern with 1 %d to hold the cursor value.<br />
---@return any ...<br />
function spool:matchc(pattern, noMatchMsg)<br />
local results = {self.src:match(pattern, self.cursor)}<br />
if #results == 0 then error(noMatchMsg:format(self.cursor)) end<br />
self.cursorNext = results[#results]<br />
results[#results] = nil<br />
return unpack(results)<br />
end<br />
<br />
---@return string<br />
function spool:peek()<br />
return self.src:sub(self.cursor, self.cursor)<br />
end<br />
<br />
function spool:adv()<br />
if self:isAtEOF() then return end<br />
self.cursor = self.cursor + 1<br />
end<br />
<br />
function spool:matchadv(pattern)<br />
local _, to = self.src:find(pattern, self.cursor)<br />
if to then<br />
self.cursor = to + 1<br />
return true<br />
end<br />
return false<br />
end<br />
<br />
function spool:commit()<br />
if not self.cursorNext then error "spool:commit(): Nothing to commit" end<br />
self.cursor = self.cursorNext<br />
self.cursorNext = nil<br />
end<br />
<br />
function spool:isAtEOF() return self.cursor > #self.src end<br />
<br />
local LUA_TYPES_URL = "https://www.lua.org/manual/5.2/manual.html#2.1"<br />
<br />
---@type table<string, docs.ExplicitType><br />
local typeDefinitions = {}<br />
---@type table<string, string><br />
local typeAlias = {}<br />
local types = setmetatable({}, {<br />
__index = function (t, k)<br />
local resolvedName = k<br />
local i = 0<br />
while typeAlias[resolvedName] do<br />
i = i + 1<br />
if i > 10 then error "internal: alias chain too long" end<br />
resolvedName = typeAlias[resolvedName]<br />
end<br />
return typeDefinitions[resolvedName]<br />
end<br />
})<br />
<br />
---@param name string<br />
---@param origin docs.ModelOrigin<br />
---@param link string?<br />
---@return docs.ExplicitType<br />
local function newExplicitType(name, origin, link)<br />
if typeDefinitions[name] then error "Type already exists" end<br />
---@type docs.ExplicitType<br />
local t = setmetatable({<br />
kind = "type",<br />
typeKind = "explicit",<br />
name = name,<br />
attributes = {},<br />
origin = origin,<br />
link = link<br />
}, type_meta)<br />
typeDefinitions[name] = t<br />
return t<br />
end<br />
<br />
---@param anyOf docs.TypeModel[]<br />
---@return docs.UnionType<br />
local function newUnionType(anyOf)<br />
local function flatten(typ)<br />
if not typ.kind or typ.typeKind == "union" then<br />
local iterator<br />
if not typ.kind then<br />
iterator = typ<br />
else<br />
iterator = typ.anyOf<br />
end<br />
local seen = {}<br />
local res = {}<br />
for _, typ2 in ipairs(iterator) do<br />
for _, v in ipairs(flatten(typ2)) do<br />
if not seen[v] then<br />
res[#res + 1] = v<br />
seen[v] = true<br />
end<br />
end<br />
end<br />
return res<br />
elseif typ.typeKind == "explicit" then<br />
return { typ }<br />
end<br />
error "No type"<br />
end<br />
---@type docs.UnionType<br />
return setmetatable({<br />
anyOf = flatten(anyOf),<br />
attributes = {},<br />
kind = "type",<br />
origin = "abstract",<br />
typeKind = "union"<br />
}, {<br />
__tostring = function (t)<br />
local chunks = {}<br />
for _, type in ipairs(t.anyOf) do<br />
chunks[#chunks+1] = tostring(type)<br />
end<br />
return table.concat(chunks, ' | ')<br />
end<br />
})<br />
end<br />
<br />
---@param name string<br />
---@param origin docs.ModelOrigin<br />
---@return docs.ExplicitType<br />
local function getOrDefineType(name, origin)<br />
local t = types[name]<br />
if t then return t end<br />
return newExplicitType(name, origin, name)<br />
end<br />
<br />
---Create a new type definition type.<br />
---@param typedefname string without #<br />
---@return docs.TypeModel<br />
local function newTypedef(typedefname)<br />
local prefixed = "#"..typedefname<br />
if typeDefinitions[prefixed] then return typeDefinitions[prefixed] end<br />
---@type docs.ExplicitType<br />
local t = setmetatable({<br />
kind = "type",<br />
typeKind = "explicit",<br />
name = typedefname,<br />
attributes = {},<br />
origin = "typedef",<br />
link = "#typedef_"..typedefname<br />
}, type_meta)<br />
typeDefinitions[prefixed] = t<br />
return t<br />
end<br />
<br />
do -- builtin types<br />
<br />
-- currying<br />
---@param sourceName string<br />
---@return fun(list: string[])<br />
local function alias(sourceName)<br />
return function(list)<br />
for _, v in ipairs(list) do<br />
typeAlias[v] = sourceName<br />
end<br />
end<br />
end<br />
<br />
newExplicitType("any", "abstract")<br />
alias "any" { "AnyType" }<br />
newExplicitType("void", "abstract")<br />
newExplicitType("nil", "Lua", LUA_TYPES_URL)<br />
alias "nil" { "null" }<br />
newExplicitType("boolean", "Lua", LUA_TYPES_URL)<br />
alias "boolean" { "Boolean" }<br />
newExplicitType("number", "Lua", LUA_TYPES_URL)<br />
alias "number" { "Number", "double", "float" }<br />
newExplicitType("integer", "Lua", LUA_TYPES_URL)<br />
alias "integer" { "Integer" }<br />
newExplicitType("string", "Lua", LUA_TYPES_URL)<br />
alias "string" { "String" }<br />
newExplicitType("function", "Lua", LUA_TYPES_URL)<br />
alias "function" { "Function" }<br />
newExplicitType("userdata", "Lua", LUA_TYPES_URL)<br />
alias "userdata" { "Userdata" }<br />
newExplicitType("table", "Lua", LUA_TYPES_URL)<br />
alias "table" { "Table" }<br />
end<br />
<br />
---@param s docs.spool<br />
local function parseComment(s)<br />
s:matchc("%*/()", "No end of comment found")<br />
s:commit()<br />
end<br />
<br />
---@param s docs.spool<br />
---@return docs.TypeModel<br />
local function parseSimpleType(s)<br />
if s:isAtEOF() then error("Expected a type at position " .. s.cursor .. " but instead found nothing") end<br />
local prefix = s:peek()<br />
if prefix == "#" then<br />
s:adv()<br />
local typename = s:matchc("^([a-zA-Z0-9]+) ?()", "Expected a typedef name at position %d, but found nothing after the #")<br />
s:commit()<br />
return newTypedef(typename)<br />
end<br />
local typename = s:matchc("^([a-zA-Z0-9]+) ?()", "Expected a type name at position %d, but found nothing")<br />
s:commit()<br />
local t = getOrDefineType(typename, "Figura")<br />
return t<br />
end<br />
<br />
---@param s docs.spool<br />
local function parseType(s)<br />
local t = parseSimpleType(s)<br />
s:consumeSpace()<br />
local nextC = s:peek()<br />
if nextC == '|' then<br />
local unions = {t}<br />
while nextC == '|' do<br />
s:adv()<br />
s:consumeSpace()<br />
unions[#unions+1] = parseSimpleType(s)<br />
s:consumeSpace()<br />
nextC = s:peek()<br />
end<br />
return newUnionType(unions)<br />
else<br />
return t<br />
end<br />
end<br />
<br />
local function noop() end<br />
<br />
---@type table<string, fun(line: string, model: docs.DocModel)><br />
local sharedModifiers = {<br />
prefixHint = function (line, model)<br />
if model.prefixHint then error "duplicate prefixHint declaration" end<br />
model.prefixHint = line<br />
end<br />
}<br />
---@type table<string, fun(model: docs.DocModel)><br />
local sharedAttributes = {<br />
global = noop<br />
}<br />
<br />
---@type table<string, fun(line: string, model: docs.MethodModel)><br />
local methodModifiers = {<br />
}<br />
methodModifiers = setmetatable(methodModifiers, {__index = sharedModifiers})<br />
---@type table<string, fun(model: docs.MethodModel)><br />
local methodAttributes = {<br />
static = function (model)<br />
model.isStatic = true<br />
end,<br />
hostOnly = noop<br />
}<br />
methodAttributes = setmetatable(methodAttributes, {__index = sharedAttributes})<br />
<br />
---@type table<string, fun(line: string, model: docs.FieldModel)><br />
local fieldModifiers = {<br />
["type"] = function (line, model)<br />
local s = spool.new(line)<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error "expected end of statement after field type" end<br />
model.readType = t<br />
model.writeType = t<br />
end,<br />
["readType"] = function (line, model)<br />
local s = spool.new(line)<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error "expected end of statement after field readType" end<br />
model.readType = t<br />
end,<br />
["writeType"] = function (line, model)<br />
local s = spool.new(line)<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error "expected end of statement after field writeType" end<br />
model.writeType = t<br />
end,<br />
}<br />
fieldModifiers = setmetatable(fieldModifiers, {__index = sharedModifiers})<br />
---@type table<string, fun(model: docs.FieldModel)><br />
local fieldAttributes = {<br />
readOnly = function (model)<br />
model.canWrite = false<br />
end,<br />
writeOnly = function (model)<br />
model.canRead = false<br />
end<br />
}<br />
fieldAttributes = setmetatable(fieldAttributes, {__index = sharedAttributes})<br />
<br />
---@param sigtext string<br />
local function parseMethodSignature(sigtext)<br />
local s = spool.new(sigtext)<br />
<br />
---@type docs.MethodSignature<br />
local model = {<br />
returns = {},<br />
parameters = {}<br />
}<br />
<br />
local function parseParameter(assumeV)<br />
---@type docs.MethodSignature.Parameter<br />
local param = setmetatable({<br />
name = "",<br />
type = typeDefinitions.void,<br />
vararg = false<br />
}, {<br />
__tostring = function (t)<br />
return ("<param %s (%s)>"):format(t.name, tostring(t.type))<br />
end<br />
})<br />
if assumeV then<br />
param.name = "..."<br />
param.vararg = true<br />
else<br />
-- already consumed: 'parameter '<br />
if s:matchadv("^%.%.%. ?") then<br />
param.name = "..."<br />
param.vararg = true<br />
else<br />
param.name = s:matchc("^([a-zA-Z0-9]+) ?()", "Expected parameter name at %d but found nothing")<br />
s:commit()<br />
end<br />
end<br />
s:consumeSpace()<br />
param.type = parseType(s)<br />
s:consumeSpace()<br />
if not s:matchadv('^;') then error("Expected a semicolon to end parameter declaration at position " .. s.cursor) end<br />
model.parameters[#model.parameters+1] = param<br />
end<br />
<br />
local function parseReturns()<br />
-- already consumed: 'returns '<br />
model.returns[#model.returns+1] = parseType(s)<br />
s:consumeSpace()<br />
while s:matchadv('^,') do<br />
s:consumeSpace()<br />
model.returns[#model.returns+1] = parseType(s)<br />
s:consumeSpace()<br />
end<br />
if not s:matchadv('^;') then error("Expected a semicolon to end returns declaration at position " .. s.cursor) end<br />
end<br />
<br />
local function parseStmt()<br />
if s:matchadv "^/%*" then<br />
return parseComment(s)<br />
end<br />
if s:matchadv "^returns " then<br />
return parseReturns()<br />
end<br />
if s:matchadv "^parameter%.%.%." then<br />
return parseParameter(true)<br />
end<br />
if s:matchadv "^parameter " then<br />
return parseParameter()<br />
end<br />
error("No valid signature statement at " .. s.cursor)<br />
end<br />
<br />
local function parse()<br />
s:consumeSpace()<br />
while not s:isAtEOF() do<br />
parseStmt()<br />
s:consumeSpace()<br />
end<br />
end<br />
parse()<br />
return model<br />
end<br />
<br />
---@param docstr string<br />
local function parseMethod(docstr)<br />
local s = spool.new(docstr)<br />
<br />
---@type docs.MethodModel<br />
local model = {<br />
kind = "method",<br />
attributes = {},<br />
isStatic = false,<br />
name = "<unnamed>",<br />
origin = "Figura",<br />
signatures = {},<br />
}<br />
local parseTopLevelStmt, parseMethodHeader, parseSignatureOuter<br />
local blockKw = {}<br />
<br />
function parseSignatureOuter()<br />
s:consumeSpace()<br />
---@type string<br />
local block_content = s:matchc("^(%b{})%s*;()", "Expected a bracketed block after 'signature' at position %d")<br />
local inside = block_content:sub(2, -2)<br />
local sig = parseMethodSignature(inside)<br />
model.signatures[#model.signatures+1] = sig<br />
s:commit()<br />
end<br />
blockKw.signature = parseSignatureOuter<br />
<br />
function parseMethodHeader()<br />
local name = s:matchc("^([^%s;]+) ?()", "Expected method name at %d")<br />
model.name = name<br />
s:commit()<br />
s:consumeSpace()<br />
local peek = s:peek()<br />
while #peek ~= 0 and peek ~= ';' do<br />
local attr = s:matchc("^([^%s;]+) ?()", "Expected something else!")<br />
if not methodAttributes[attr] then<br />
error(("Unknown method attribute '%s' at position %d in method header"):format(attr, s.cursor))<br />
end<br />
methodAttributes[attr](model)<br />
model.attributes[attr] = true<br />
s:commit()<br />
s:consumeSpace()<br />
peek = s:peek()<br />
end<br />
if peek == ';' then<br />
s:adv() -- advance past the ;<br />
else<br />
error("Reached end of method documentation while parsing header")<br />
end<br />
end<br />
<br />
function parseTopLevelStmt()<br />
local startAt = s.cursor<br />
---@type string<br />
local action = s:matchc("^([^%s;]+) ?()", "Expected a modifier or block keyword, but got nothing instead at position %d")<br />
s:commit()<br />
if methodModifiers[action] then<br />
---@type string<br />
local remainder = s:matchc("^(.-);%s*()", "Expected semicolon to end statement around %d")<br />
s:commit()<br />
return methodModifiers[action](remainder, model)<br />
end<br />
if blockKw[action] then return blockKw[action]() end<br />
error(("Expected a modifier or block keyword, but got '%s' instead at position %d"):format(action, startAt))<br />
end<br />
<br />
local function parse()<br />
s:consumeSpace()<br />
parseMethodHeader()<br />
s:consumeSpace()<br />
while not s:isAtEOF() do<br />
parseTopLevelStmt()<br />
s:consumeSpace()<br />
end<br />
end<br />
<br />
parse()<br />
return model<br />
end<br />
<br />
---@param docstr string<br />
---@return docs.FieldModel<br />
local function parseField(docstr)<br />
local s = spool.new(docstr)<br />
<br />
---@type docs.FieldModel<br />
local model = {<br />
kind = "field",<br />
attributes = {},<br />
name = "<unnamed>",<br />
origin = "Figura",<br />
canRead = true,<br />
canWrite = true<br />
}<br />
<br />
local parseTopLevelStmt, parseFieldHeader, parseSignatureOuter<br />
<br />
function parseFieldHeader()<br />
local name = s:matchc("^([^%s;]+) ?()", "Expected field name at %d")<br />
model.name = name<br />
s:commit()<br />
s:consumeSpace()<br />
local peek = s:peek()<br />
while #peek ~= 0 and peek ~= ';' do<br />
local attr = s:matchc("^([^%s;]+) ?()", "Expected something else!")<br />
if not fieldAttributes[attr] then<br />
error(("Unknown field attribute '%s' at position %d in field header"):format(attr, s.cursor))<br />
end<br />
fieldAttributes[attr](model)<br />
model.attributes[attr] = true<br />
s:commit()<br />
s:consumeSpace()<br />
peek = s:peek()<br />
end<br />
if peek == ';' then<br />
s:adv() -- advance past the ;<br />
else<br />
error("Reached end of field documentation while parsing header")<br />
end<br />
end<br />
<br />
function parseTopLevelStmt()<br />
local startAt = s.cursor<br />
---@type string<br />
local action = s:matchc("^([^%s;]+) ?()", "Expected a modifier, but got nothing instead at position %d")<br />
s:commit()<br />
if fieldModifiers[action] then<br />
---@type string<br />
local remainder = s:matchc("^(.-);%s*()", "Expected semicolon to end statement around %d")<br />
s:commit()<br />
return fieldModifiers[action](remainder, model)<br />
end<br />
error(("Expected a modifier, but got '%s' instead at position %d"):format(action, startAt))<br />
end<br />
<br />
local function parse()<br />
s:consumeSpace()<br />
parseFieldHeader()<br />
s:consumeSpace()<br />
while not s:isAtEOF() do<br />
parseTopLevelStmt()<br />
s:consumeSpace()<br />
end<br />
end<br />
<br />
parse()<br />
return model<br />
end<br />
<br />
---@param typeM docs.TypeModel<br />
local function renderType(typeM)<br />
return tostring(typeM)<br />
end<br />
<br />
---@param o any<br />
---@param i number?<br />
local function printFancy(o, i)<br />
i = i or 2<br />
local indent = (" "):rep(i)<br />
if type(o) == "table" then<br />
if getmetatable(o) and getmetatable(o).__tostring then<br />
return tostring(o)<br />
end<br />
local b = "{\n"<br />
for k, v in pairs(o) do<br />
b = b .. indent .. printFancy(k, i + 2) .. " = " .. printFancy(v, i + 2) .. ",\n"<br />
end<br />
b = b .. (" "):rep(i - 2) .. "}"<br />
return b<br />
else<br />
return tostring(o)<br />
end<br />
end<br />
<br />
local function parseAndRenderType(frame)<br />
local input_args = frame:getParent().args<br />
local nargs = 0<br />
while input_args[nargs + 1] do nargs = nargs + 1 end<br />
if nargs == 0 then error "Need to specify at least one type" end<br />
<br />
if nargs == 1 then<br />
local s = spool.new(input_args[1])<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error("Expected end of type at position " .. s.cursor) end<br />
return renderType(t)<br />
else<br />
local tabulated = {}<br />
for i = 1, nargs do tabulated[i] = input_args[i] end<br />
do return table.concat(tabulated, "|") end<br />
local s = spool.new(table.concat(input_args, "|"))<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error("Expected end of type at position " .. s.cursor) end<br />
return renderType(t)<br />
end<br />
end<br />
<br />
-- local m = parseField [[<br />
-- player global readOnly;<br />
-- type PlayerAPI;<br />
-- ]]<br />
-- print(printFancy(m))<br />
<br />
return {<br />
type = parseAndRenderType<br />
}</div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=Module:Signatures&diff=858
Module:Signatures
2025-03-30T23:51:08Z
<p>PenguinEncounter: </p>
<hr />
<div>-- a MediaWiki module<br />
<br />
--[[<br />
Syntax description:<br />
<name> <attr...> ...;;<br />
<modName> [modSyn];;<br />
]]<br />
<br />
---@alias docs.ModelKind "field" | "method" | "type"<br />
<br />
---Origin of this documentation item.<br />
---@alias docs.ModelOrigin<br />
---| "Lua" Lua 5.2 built-in types and APIs.<br />
---| "Figura" Figura types and APIs. Usually the default.<br />
---| "abstract" Describes ideas, but no concrete implementation exists.<br />
---| "typedef" Custom on-the-spot types, like function protocols or array types.<br />
<br />
---@alias Set<T> {[T]: true}<br />
<br />
---@class docs.DocModel<br />
---@field kind docs.ModelKind<br />
---@field name string?<br />
---@field prefixHint string?<br />
---@field attributes Set<string><br />
---@field origin docs.ModelOrigin<br />
<br />
---@class docs.FieldModel : docs.DocModel<br />
---@field kind "field"<br />
---@field canRead boolean<br />
---@field canWrite boolean<br />
---@field readType docs.TypeModel?<br />
---@field writeType docs.TypeModel?<br />
<br />
---@class docs.MethodModel : docs.DocModel<br />
---@field kind "method"<br />
---@field signatures docs.MethodSignature[]<br />
---@field isStatic boolean<br />
<br />
---@class docs.MethodSignature.Parameter<br />
---@field name string<br />
---@field type docs.TypeModel<br />
---@field vararg boolean?<br />
<br />
---@class docs.MethodSignature<br />
---@field returns docs.TypeModel[]<br />
---@field parameters docs.MethodSignature.Parameter[]<br />
<br />
---@class docs.TypeModel : docs.DocModel<br />
---@field kind "type"<br />
---@field typeKind "explicit" | "union"<br />
<br />
---@class docs.ExplicitType : docs.TypeModel<br />
---@field typeKind "explicit"<br />
---@field link string?<br />
<br />
---@class docs.UnionType : docs.TypeModel<br />
---@field typeKind "union"<br />
---@field anyOf docs.TypeModel[]<br />
<br />
---@type metatable<br />
local type_meta = {<br />
__tostring = function (t)<br />
return ("<type %s from %s>"):format(t.name or '(anonymous)', t.origin)<br />
end<br />
}<br />
<br />
---@class docs.spool : docs.DocModel<br />
---@field src string<br />
---@field cursor integer<br />
---@field cursorNext integer?<br />
local spool = {}<br />
<br />
---Create a new spool.<br />
---@param src string<br />
---@return docs.spool<br />
function spool.new(src)<br />
return setmetatable({<br />
src = src,<br />
cursor = 1<br />
}, {__index = spool})<br />
end<br />
<br />
---@return integer cursor<br />
function spool:consumeSpace()<br />
self.cursor = self.src:match("%s*()", self.cursor)<br />
return self.cursor<br />
end<br />
<br />
local unpack = unpack or table.unpack -- 5.2 compat<br />
<br />
---Starts matching from the current cursor position, and recieves the next cursor position from a position capture.<br />
---@param pattern string<br />
---@param noMatchMsg string Format pattern with 1 %d to hold the cursor value.<br />
---@return any ...<br />
function spool:matchc(pattern, noMatchMsg)<br />
local results = {self.src:match(pattern, self.cursor)}<br />
if #results == 0 then error(noMatchMsg:format(self.cursor)) end<br />
self.cursorNext = results[#results]<br />
results[#results] = nil<br />
return unpack(results)<br />
end<br />
<br />
---@return string<br />
function spool:peek()<br />
return self.src:sub(self.cursor, self.cursor)<br />
end<br />
<br />
function spool:adv()<br />
if self:isAtEOF() then return end<br />
self.cursor = self.cursor + 1<br />
end<br />
<br />
function spool:matchadv(pattern)<br />
local _, to = self.src:find(pattern, self.cursor)<br />
if to then<br />
self.cursor = to + 1<br />
return true<br />
end<br />
return false<br />
end<br />
<br />
function spool:commit()<br />
if not self.cursorNext then error "spool:commit(): Nothing to commit" end<br />
self.cursor = self.cursorNext<br />
self.cursorNext = nil<br />
end<br />
<br />
function spool:isAtEOF() return self.cursor > #self.src end<br />
<br />
local LUA_TYPES_URL = "https://www.lua.org/manual/5.2/manual.html#2.1"<br />
<br />
---@type table<string, docs.ExplicitType><br />
local typeDefinitions = {}<br />
---@type table<string, string><br />
local typeAlias = {}<br />
local types = setmetatable({}, {<br />
__index = function (t, k)<br />
local resolvedName = k<br />
local i = 0<br />
while typeAlias[resolvedName] do<br />
i = i + 1<br />
if i > 10 then error "internal: alias chain too long" end<br />
resolvedName = typeAlias[resolvedName]<br />
end<br />
return typeDefinitions[resolvedName]<br />
end<br />
})<br />
<br />
---@param name string<br />
---@param origin docs.ModelOrigin<br />
---@param link string?<br />
---@return docs.ExplicitType<br />
local function newExplicitType(name, origin, link)<br />
if typeDefinitions[name] then error "Type already exists" end<br />
---@type docs.ExplicitType<br />
local t = setmetatable({<br />
kind = "type",<br />
typeKind = "explicit",<br />
name = name,<br />
attributes = {},<br />
origin = origin,<br />
link = link<br />
}, type_meta)<br />
typeDefinitions[name] = t<br />
return t<br />
end<br />
<br />
---@param anyOf docs.TypeModel[]<br />
---@return docs.UnionType<br />
local function newUnionType(anyOf)<br />
local function flatten(typ)<br />
if not typ.kind or typ.typeKind == "union" then<br />
local iterator<br />
if not typ.kind then<br />
iterator = typ<br />
else<br />
iterator = typ.anyOf<br />
end<br />
local seen = {}<br />
local res = {}<br />
for _, typ2 in ipairs(iterator) do<br />
for _, v in ipairs(flatten(typ2)) do<br />
if not seen[v] then<br />
res[#res + 1] = v<br />
seen[v] = true<br />
end<br />
end<br />
end<br />
return res<br />
elseif typ.typeKind == "explicit" then<br />
return { typ }<br />
end<br />
error "No type"<br />
end<br />
---@type docs.UnionType<br />
return setmetatable({<br />
anyOf = flatten(anyOf),<br />
attributes = {},<br />
kind = "type",<br />
origin = "abstract",<br />
typeKind = "union"<br />
}, {<br />
__tostring = function (t)<br />
local chunks = {}<br />
for _, type in ipairs(t.anyOf) do<br />
chunks[#chunks+1] = tostring(type)<br />
end<br />
return table.concat(chunks, ' | ')<br />
end<br />
})<br />
end<br />
<br />
---@param name string<br />
---@param origin docs.ModelOrigin<br />
---@return docs.ExplicitType<br />
local function getOrDefineType(name, origin)<br />
local t = types[name]<br />
if t then return t end<br />
return newExplicitType(name, origin, name)<br />
end<br />
<br />
---Create a new type definition type.<br />
---@param typedefname string without #<br />
---@return docs.TypeModel<br />
local function newTypedef(typedefname)<br />
local prefixed = "#"..typedefname<br />
if typeDefinitions[prefixed] then return typeDefinitions[prefixed] end<br />
---@type docs.ExplicitType<br />
local t = setmetatable({<br />
kind = "type",<br />
typeKind = "explicit",<br />
name = typedefname,<br />
attributes = {},<br />
origin = "typedef",<br />
link = "#typedef_"..typedefname<br />
}, type_meta)<br />
typeDefinitions[prefixed] = t<br />
return t<br />
end<br />
<br />
do -- builtin types<br />
<br />
-- currying<br />
---@param sourceName string<br />
---@return fun(list: string[])<br />
local function alias(sourceName)<br />
return function(list)<br />
for _, v in ipairs(list) do<br />
typeAlias[v] = sourceName<br />
end<br />
end<br />
end<br />
<br />
newExplicitType("any", "abstract")<br />
alias "any" { "AnyType" }<br />
newExplicitType("void", "abstract")<br />
newExplicitType("nil", "Lua", LUA_TYPES_URL)<br />
alias "nil" { "null" }<br />
newExplicitType("boolean", "Lua", LUA_TYPES_URL)<br />
alias "boolean" { "Boolean" }<br />
newExplicitType("number", "Lua", LUA_TYPES_URL)<br />
alias "number" { "Number", "double", "float" }<br />
newExplicitType("integer", "Lua", LUA_TYPES_URL)<br />
alias "integer" { "Integer" }<br />
newExplicitType("string", "Lua", LUA_TYPES_URL)<br />
alias "string" { "String" }<br />
newExplicitType("function", "Lua", LUA_TYPES_URL)<br />
alias "function" { "Function" }<br />
newExplicitType("userdata", "Lua", LUA_TYPES_URL)<br />
alias "userdata" { "Userdata" }<br />
newExplicitType("table", "Lua", LUA_TYPES_URL)<br />
alias "table" { "Table" }<br />
end<br />
<br />
---@param s docs.spool<br />
local function parseComment(s)<br />
s:matchc("%*/()", "No end of comment found")<br />
s:commit()<br />
end<br />
<br />
---@param s docs.spool<br />
---@return docs.TypeModel<br />
local function parseSimpleType(s)<br />
if s:isAtEOF() then error("Expected a type at position " .. s.cursor .. " but instead found nothing") end<br />
local prefix = s:peek()<br />
if prefix == "#" then<br />
s:adv()<br />
local typename = s:matchc("^([a-zA-Z0-9]+) ?()", "Expected a typedef name at position %d, but found nothing after the #")<br />
s:commit()<br />
return newTypedef(typename)<br />
end<br />
local typename = s:matchc("^([a-zA-Z0-9]+) ?()", "Expected a type name at position %d, but found nothing")<br />
s:commit()<br />
local t = getOrDefineType(typename, "Figura")<br />
return t<br />
end<br />
<br />
---@param s docs.spool<br />
local function parseType(s)<br />
local t = parseSimpleType(s)<br />
s:consumeSpace()<br />
local nextC = s:peek()<br />
if nextC == '|' then<br />
local unions = {t}<br />
while nextC == '|' do<br />
s:adv()<br />
s:consumeSpace()<br />
unions[#unions+1] = parseSimpleType(s)<br />
s:consumeSpace()<br />
nextC = s:peek()<br />
end<br />
return newUnionType(unions)<br />
else<br />
return t<br />
end<br />
end<br />
<br />
local function noop() end<br />
<br />
---@type table<string, fun(line: string, model: docs.DocModel)><br />
local sharedModifiers = {<br />
prefixHint = function (line, model)<br />
if model.prefixHint then error "duplicate prefixHint declaration" end<br />
model.prefixHint = line<br />
end<br />
}<br />
---@type table<string, fun(model: docs.DocModel)><br />
local sharedAttributes = {<br />
global = noop<br />
}<br />
<br />
---@type table<string, fun(line: string, model: docs.MethodModel)><br />
local methodModifiers = {<br />
}<br />
methodModifiers = setmetatable(methodModifiers, {__index = sharedModifiers})<br />
---@type table<string, fun(model: docs.MethodModel)><br />
local methodAttributes = {<br />
static = function (model)<br />
model.isStatic = true<br />
end,<br />
hostOnly = noop<br />
}<br />
methodAttributes = setmetatable(methodAttributes, {__index = sharedAttributes})<br />
<br />
---@type table<string, fun(line: string, model: docs.FieldModel)><br />
local fieldModifiers = {<br />
["type"] = function (line, model)<br />
local s = spool.new(line)<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error "expected end of statement after field type" end<br />
model.readType = t<br />
model.writeType = t<br />
end,<br />
["readType"] = function (line, model)<br />
local s = spool.new(line)<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error "expected end of statement after field readType" end<br />
model.readType = t<br />
end,<br />
["writeType"] = function (line, model)<br />
local s = spool.new(line)<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error "expected end of statement after field writeType" end<br />
model.writeType = t<br />
end,<br />
}<br />
fieldModifiers = setmetatable(fieldModifiers, {__index = sharedModifiers})<br />
---@type table<string, fun(model: docs.FieldModel)><br />
local fieldAttributes = {<br />
readOnly = function (model)<br />
model.canWrite = false<br />
end,<br />
writeOnly = function (model)<br />
model.canRead = false<br />
end<br />
}<br />
fieldAttributes = setmetatable(fieldAttributes, {__index = sharedAttributes})<br />
<br />
---@param sigtext string<br />
local function parseMethodSignature(sigtext)<br />
local s = spool.new(sigtext)<br />
<br />
---@type docs.MethodSignature<br />
local model = {<br />
returns = {},<br />
parameters = {}<br />
}<br />
<br />
local function parseParameter(assumeV)<br />
---@type docs.MethodSignature.Parameter<br />
local param = setmetatable({<br />
name = "",<br />
type = typeDefinitions.void,<br />
vararg = false<br />
}, {<br />
__tostring = function (t)<br />
return ("<param %s (%s)>"):format(t.name, tostring(t.type))<br />
end<br />
})<br />
if assumeV then<br />
param.name = "..."<br />
param.vararg = true<br />
else<br />
-- already consumed: 'parameter '<br />
if s:matchadv("^%.%.%. ?") then<br />
param.name = "..."<br />
param.vararg = true<br />
else<br />
param.name = s:matchc("^([a-zA-Z0-9]+) ?()", "Expected parameter name at %d but found nothing")<br />
s:commit()<br />
end<br />
end<br />
s:consumeSpace()<br />
param.type = parseType(s)<br />
s:consumeSpace()<br />
if not s:matchadv('^;') then error("Expected a semicolon to end parameter declaration at position " .. s.cursor) end<br />
model.parameters[#model.parameters+1] = param<br />
end<br />
<br />
local function parseReturns()<br />
-- already consumed: 'returns '<br />
model.returns[#model.returns+1] = parseType(s)<br />
s:consumeSpace()<br />
while s:matchadv('^,') do<br />
s:consumeSpace()<br />
model.returns[#model.returns+1] = parseType(s)<br />
s:consumeSpace()<br />
end<br />
if not s:matchadv('^;') then error("Expected a semicolon to end returns declaration at position " .. s.cursor) end<br />
end<br />
<br />
local function parseStmt()<br />
if s:matchadv "^/%*" then<br />
return parseComment(s)<br />
end<br />
if s:matchadv "^returns " then<br />
return parseReturns()<br />
end<br />
if s:matchadv "^parameter%.%.%." then<br />
return parseParameter(true)<br />
end<br />
if s:matchadv "^parameter " then<br />
return parseParameter()<br />
end<br />
error("No valid signature statement at " .. s.cursor)<br />
end<br />
<br />
local function parse()<br />
s:consumeSpace()<br />
while not s:isAtEOF() do<br />
parseStmt()<br />
s:consumeSpace()<br />
end<br />
end<br />
parse()<br />
return model<br />
end<br />
<br />
---@param docstr string<br />
local function parseMethod(docstr)<br />
local s = spool.new(docstr)<br />
<br />
---@type docs.MethodModel<br />
local model = {<br />
kind = "method",<br />
attributes = {},<br />
isStatic = false,<br />
name = "<unnamed>",<br />
origin = "Figura",<br />
signatures = {},<br />
}<br />
local parseTopLevelStmt, parseMethodHeader, parseSignatureOuter<br />
local blockKw = {}<br />
<br />
function parseSignatureOuter()<br />
s:consumeSpace()<br />
---@type string<br />
local block_content = s:matchc("^(%b{})%s*;()", "Expected a bracketed block after 'signature' at position %d")<br />
local inside = block_content:sub(2, -2)<br />
local sig = parseMethodSignature(inside)<br />
model.signatures[#model.signatures+1] = sig<br />
s:commit()<br />
end<br />
blockKw.signature = parseSignatureOuter<br />
<br />
function parseMethodHeader()<br />
local name = s:matchc("^([^%s;]+) ?()", "Expected method name at %d")<br />
model.name = name<br />
s:commit()<br />
s:consumeSpace()<br />
local peek = s:peek()<br />
while #peek ~= 0 and peek ~= ';' do<br />
local attr = s:matchc("^([^%s;]+) ?()", "Expected something else!")<br />
if not methodAttributes[attr] then<br />
error(("Unknown method attribute '%s' at position %d in method header"):format(attr, s.cursor))<br />
end<br />
methodAttributes[attr](model)<br />
model.attributes[attr] = true<br />
s:commit()<br />
s:consumeSpace()<br />
peek = s:peek()<br />
end<br />
if peek == ';' then<br />
s:adv() -- advance past the ;<br />
else<br />
error("Reached end of method documentation while parsing header")<br />
end<br />
end<br />
<br />
function parseTopLevelStmt()<br />
local startAt = s.cursor<br />
---@type string<br />
local action = s:matchc("^([^%s;]+) ?()", "Expected a modifier or block keyword, but got nothing instead at position %d")<br />
s:commit()<br />
if methodModifiers[action] then<br />
---@type string<br />
local remainder = s:matchc("^(.-);%s*()", "Expected semicolon to end statement around %d")<br />
s:commit()<br />
return methodModifiers[action](remainder, model)<br />
end<br />
if blockKw[action] then return blockKw[action]() end<br />
error(("Expected a modifier or block keyword, but got '%s' instead at position %d"):format(action, startAt))<br />
end<br />
<br />
local function parse()<br />
s:consumeSpace()<br />
parseMethodHeader()<br />
s:consumeSpace()<br />
while not s:isAtEOF() do<br />
parseTopLevelStmt()<br />
s:consumeSpace()<br />
end<br />
end<br />
<br />
parse()<br />
return model<br />
end<br />
<br />
---@param docstr string<br />
---@return docs.FieldModel<br />
local function parseField(docstr)<br />
local s = spool.new(docstr)<br />
<br />
---@type docs.FieldModel<br />
local model = {<br />
kind = "field",<br />
attributes = {},<br />
name = "<unnamed>",<br />
origin = "Figura",<br />
canRead = true,<br />
canWrite = true<br />
}<br />
<br />
local parseTopLevelStmt, parseFieldHeader, parseSignatureOuter<br />
<br />
function parseFieldHeader()<br />
local name = s:matchc("^([^%s;]+) ?()", "Expected field name at %d")<br />
model.name = name<br />
s:commit()<br />
s:consumeSpace()<br />
local peek = s:peek()<br />
while #peek ~= 0 and peek ~= ';' do<br />
local attr = s:matchc("^([^%s;]+) ?()", "Expected something else!")<br />
if not fieldAttributes[attr] then<br />
error(("Unknown field attribute '%s' at position %d in field header"):format(attr, s.cursor))<br />
end<br />
fieldAttributes[attr](model)<br />
model.attributes[attr] = true<br />
s:commit()<br />
s:consumeSpace()<br />
peek = s:peek()<br />
end<br />
if peek == ';' then<br />
s:adv() -- advance past the ;<br />
else<br />
error("Reached end of field documentation while parsing header")<br />
end<br />
end<br />
<br />
function parseTopLevelStmt()<br />
local startAt = s.cursor<br />
---@type string<br />
local action = s:matchc("^([^%s;]+) ?()", "Expected a modifier, but got nothing instead at position %d")<br />
s:commit()<br />
if fieldModifiers[action] then<br />
---@type string<br />
local remainder = s:matchc("^(.-);%s*()", "Expected semicolon to end statement around %d")<br />
s:commit()<br />
return fieldModifiers[action](remainder, model)<br />
end<br />
error(("Expected a modifier, but got '%s' instead at position %d"):format(action, startAt))<br />
end<br />
<br />
local function parse()<br />
s:consumeSpace()<br />
parseFieldHeader()<br />
s:consumeSpace()<br />
while not s:isAtEOF() do<br />
parseTopLevelStmt()<br />
s:consumeSpace()<br />
end<br />
end<br />
<br />
parse()<br />
return model<br />
end<br />
<br />
---@param typeM docs.TypeModel<br />
local function renderType(typeM)<br />
return tostring(typeM)<br />
end<br />
<br />
---@param o any<br />
---@param i number?<br />
local function printFancy(o, i)<br />
i = i or 2<br />
local indent = (" "):rep(i)<br />
if type(o) == "table" then<br />
if getmetatable(o) and getmetatable(o).__tostring then<br />
return tostring(o)<br />
end<br />
local b = "{\n"<br />
for k, v in pairs(o) do<br />
b = b .. indent .. printFancy(k, i + 2) .. " = " .. printFancy(v, i + 2) .. ",\n"<br />
end<br />
b = b .. (" "):rep(i - 2) .. "}"<br />
return b<br />
else<br />
return tostring(o)<br />
end<br />
end<br />
<br />
local function parseAndRenderType(frame)<br />
local input_args = frame:getParent().args<br />
do return table.maxn(input_args) end<br />
if not input_args[1] then error "Need to specify at least one type" end<br />
<br />
if not input_args[2] then<br />
local s = spool.new(input_args[1])<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error("Expected end of type at position " .. s.cursor) end<br />
return renderType(t)<br />
else<br />
do return table.concat(input_args, "|") end<br />
local s = spool.new(table.concat(input_args, "|"))<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error("Expected end of type at position " .. s.cursor) end<br />
return renderType(t)<br />
end<br />
end<br />
<br />
-- local m = parseField [[<br />
-- player global readOnly;<br />
-- type PlayerAPI;<br />
-- ]]<br />
-- print(printFancy(m))<br />
<br />
return {<br />
type = parseAndRenderType<br />
}</div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=Module:Signatures&diff=857
Module:Signatures
2025-03-30T23:50:25Z
<p>PenguinEncounter: </p>
<hr />
<div>-- a MediaWiki module<br />
<br />
--[[<br />
Syntax description:<br />
<name> <attr...> ...;;<br />
<modName> [modSyn];;<br />
]]<br />
<br />
---@alias docs.ModelKind "field" | "method" | "type"<br />
<br />
---Origin of this documentation item.<br />
---@alias docs.ModelOrigin<br />
---| "Lua" Lua 5.2 built-in types and APIs.<br />
---| "Figura" Figura types and APIs. Usually the default.<br />
---| "abstract" Describes ideas, but no concrete implementation exists.<br />
---| "typedef" Custom on-the-spot types, like function protocols or array types.<br />
<br />
---@alias Set<T> {[T]: true}<br />
<br />
---@class docs.DocModel<br />
---@field kind docs.ModelKind<br />
---@field name string?<br />
---@field prefixHint string?<br />
---@field attributes Set<string><br />
---@field origin docs.ModelOrigin<br />
<br />
---@class docs.FieldModel : docs.DocModel<br />
---@field kind "field"<br />
---@field canRead boolean<br />
---@field canWrite boolean<br />
---@field readType docs.TypeModel?<br />
---@field writeType docs.TypeModel?<br />
<br />
---@class docs.MethodModel : docs.DocModel<br />
---@field kind "method"<br />
---@field signatures docs.MethodSignature[]<br />
---@field isStatic boolean<br />
<br />
---@class docs.MethodSignature.Parameter<br />
---@field name string<br />
---@field type docs.TypeModel<br />
---@field vararg boolean?<br />
<br />
---@class docs.MethodSignature<br />
---@field returns docs.TypeModel[]<br />
---@field parameters docs.MethodSignature.Parameter[]<br />
<br />
---@class docs.TypeModel : docs.DocModel<br />
---@field kind "type"<br />
---@field typeKind "explicit" | "union"<br />
<br />
---@class docs.ExplicitType : docs.TypeModel<br />
---@field typeKind "explicit"<br />
---@field link string?<br />
<br />
---@class docs.UnionType : docs.TypeModel<br />
---@field typeKind "union"<br />
---@field anyOf docs.TypeModel[]<br />
<br />
---@type metatable<br />
local type_meta = {<br />
__tostring = function (t)<br />
return ("<type %s from %s>"):format(t.name or '(anonymous)', t.origin)<br />
end<br />
}<br />
<br />
---@class docs.spool : docs.DocModel<br />
---@field src string<br />
---@field cursor integer<br />
---@field cursorNext integer?<br />
local spool = {}<br />
<br />
---Create a new spool.<br />
---@param src string<br />
---@return docs.spool<br />
function spool.new(src)<br />
return setmetatable({<br />
src = src,<br />
cursor = 1<br />
}, {__index = spool})<br />
end<br />
<br />
---@return integer cursor<br />
function spool:consumeSpace()<br />
self.cursor = self.src:match("%s*()", self.cursor)<br />
return self.cursor<br />
end<br />
<br />
local unpack = unpack or table.unpack -- 5.2 compat<br />
<br />
---Starts matching from the current cursor position, and recieves the next cursor position from a position capture.<br />
---@param pattern string<br />
---@param noMatchMsg string Format pattern with 1 %d to hold the cursor value.<br />
---@return any ...<br />
function spool:matchc(pattern, noMatchMsg)<br />
local results = {self.src:match(pattern, self.cursor)}<br />
if #results == 0 then error(noMatchMsg:format(self.cursor)) end<br />
self.cursorNext = results[#results]<br />
results[#results] = nil<br />
return unpack(results)<br />
end<br />
<br />
---@return string<br />
function spool:peek()<br />
return self.src:sub(self.cursor, self.cursor)<br />
end<br />
<br />
function spool:adv()<br />
if self:isAtEOF() then return end<br />
self.cursor = self.cursor + 1<br />
end<br />
<br />
function spool:matchadv(pattern)<br />
local _, to = self.src:find(pattern, self.cursor)<br />
if to then<br />
self.cursor = to + 1<br />
return true<br />
end<br />
return false<br />
end<br />
<br />
function spool:commit()<br />
if not self.cursorNext then error "spool:commit(): Nothing to commit" end<br />
self.cursor = self.cursorNext<br />
self.cursorNext = nil<br />
end<br />
<br />
function spool:isAtEOF() return self.cursor > #self.src end<br />
<br />
local LUA_TYPES_URL = "https://www.lua.org/manual/5.2/manual.html#2.1"<br />
<br />
---@type table<string, docs.ExplicitType><br />
local typeDefinitions = {}<br />
---@type table<string, string><br />
local typeAlias = {}<br />
local types = setmetatable({}, {<br />
__index = function (t, k)<br />
local resolvedName = k<br />
local i = 0<br />
while typeAlias[resolvedName] do<br />
i = i + 1<br />
if i > 10 then error "internal: alias chain too long" end<br />
resolvedName = typeAlias[resolvedName]<br />
end<br />
return typeDefinitions[resolvedName]<br />
end<br />
})<br />
<br />
---@param name string<br />
---@param origin docs.ModelOrigin<br />
---@param link string?<br />
---@return docs.ExplicitType<br />
local function newExplicitType(name, origin, link)<br />
if typeDefinitions[name] then error "Type already exists" end<br />
---@type docs.ExplicitType<br />
local t = setmetatable({<br />
kind = "type",<br />
typeKind = "explicit",<br />
name = name,<br />
attributes = {},<br />
origin = origin,<br />
link = link<br />
}, type_meta)<br />
typeDefinitions[name] = t<br />
return t<br />
end<br />
<br />
---@param anyOf docs.TypeModel[]<br />
---@return docs.UnionType<br />
local function newUnionType(anyOf)<br />
local function flatten(typ)<br />
if not typ.kind or typ.typeKind == "union" then<br />
local iterator<br />
if not typ.kind then<br />
iterator = typ<br />
else<br />
iterator = typ.anyOf<br />
end<br />
local seen = {}<br />
local res = {}<br />
for _, typ2 in ipairs(iterator) do<br />
for _, v in ipairs(flatten(typ2)) do<br />
if not seen[v] then<br />
res[#res + 1] = v<br />
seen[v] = true<br />
end<br />
end<br />
end<br />
return res<br />
elseif typ.typeKind == "explicit" then<br />
return { typ }<br />
end<br />
error "No type"<br />
end<br />
---@type docs.UnionType<br />
return setmetatable({<br />
anyOf = flatten(anyOf),<br />
attributes = {},<br />
kind = "type",<br />
origin = "abstract",<br />
typeKind = "union"<br />
}, {<br />
__tostring = function (t)<br />
local chunks = {}<br />
for _, type in ipairs(t.anyOf) do<br />
chunks[#chunks+1] = tostring(type)<br />
end<br />
return table.concat(chunks, ' | ')<br />
end<br />
})<br />
end<br />
<br />
---@param name string<br />
---@param origin docs.ModelOrigin<br />
---@return docs.ExplicitType<br />
local function getOrDefineType(name, origin)<br />
local t = types[name]<br />
if t then return t end<br />
return newExplicitType(name, origin, name)<br />
end<br />
<br />
---Create a new type definition type.<br />
---@param typedefname string without #<br />
---@return docs.TypeModel<br />
local function newTypedef(typedefname)<br />
local prefixed = "#"..typedefname<br />
if typeDefinitions[prefixed] then return typeDefinitions[prefixed] end<br />
---@type docs.ExplicitType<br />
local t = setmetatable({<br />
kind = "type",<br />
typeKind = "explicit",<br />
name = typedefname,<br />
attributes = {},<br />
origin = "typedef",<br />
link = "#typedef_"..typedefname<br />
}, type_meta)<br />
typeDefinitions[prefixed] = t<br />
return t<br />
end<br />
<br />
do -- builtin types<br />
<br />
-- currying<br />
---@param sourceName string<br />
---@return fun(list: string[])<br />
local function alias(sourceName)<br />
return function(list)<br />
for _, v in ipairs(list) do<br />
typeAlias[v] = sourceName<br />
end<br />
end<br />
end<br />
<br />
newExplicitType("any", "abstract")<br />
alias "any" { "AnyType" }<br />
newExplicitType("void", "abstract")<br />
newExplicitType("nil", "Lua", LUA_TYPES_URL)<br />
alias "nil" { "null" }<br />
newExplicitType("boolean", "Lua", LUA_TYPES_URL)<br />
alias "boolean" { "Boolean" }<br />
newExplicitType("number", "Lua", LUA_TYPES_URL)<br />
alias "number" { "Number", "double", "float" }<br />
newExplicitType("integer", "Lua", LUA_TYPES_URL)<br />
alias "integer" { "Integer" }<br />
newExplicitType("string", "Lua", LUA_TYPES_URL)<br />
alias "string" { "String" }<br />
newExplicitType("function", "Lua", LUA_TYPES_URL)<br />
alias "function" { "Function" }<br />
newExplicitType("userdata", "Lua", LUA_TYPES_URL)<br />
alias "userdata" { "Userdata" }<br />
newExplicitType("table", "Lua", LUA_TYPES_URL)<br />
alias "table" { "Table" }<br />
end<br />
<br />
---@param s docs.spool<br />
local function parseComment(s)<br />
s:matchc("%*/()", "No end of comment found")<br />
s:commit()<br />
end<br />
<br />
---@param s docs.spool<br />
---@return docs.TypeModel<br />
local function parseSimpleType(s)<br />
if s:isAtEOF() then error("Expected a type at position " .. s.cursor .. " but instead found nothing") end<br />
local prefix = s:peek()<br />
if prefix == "#" then<br />
s:adv()<br />
local typename = s:matchc("^([a-zA-Z0-9]+) ?()", "Expected a typedef name at position %d, but found nothing after the #")<br />
s:commit()<br />
return newTypedef(typename)<br />
end<br />
local typename = s:matchc("^([a-zA-Z0-9]+) ?()", "Expected a type name at position %d, but found nothing")<br />
s:commit()<br />
local t = getOrDefineType(typename, "Figura")<br />
return t<br />
end<br />
<br />
---@param s docs.spool<br />
local function parseType(s)<br />
local t = parseSimpleType(s)<br />
s:consumeSpace()<br />
local nextC = s:peek()<br />
if nextC == '|' then<br />
local unions = {t}<br />
while nextC == '|' do<br />
s:adv()<br />
s:consumeSpace()<br />
unions[#unions+1] = parseSimpleType(s)<br />
s:consumeSpace()<br />
nextC = s:peek()<br />
end<br />
return newUnionType(unions)<br />
else<br />
return t<br />
end<br />
end<br />
<br />
local function noop() end<br />
<br />
---@type table<string, fun(line: string, model: docs.DocModel)><br />
local sharedModifiers = {<br />
prefixHint = function (line, model)<br />
if model.prefixHint then error "duplicate prefixHint declaration" end<br />
model.prefixHint = line<br />
end<br />
}<br />
---@type table<string, fun(model: docs.DocModel)><br />
local sharedAttributes = {<br />
global = noop<br />
}<br />
<br />
---@type table<string, fun(line: string, model: docs.MethodModel)><br />
local methodModifiers = {<br />
}<br />
methodModifiers = setmetatable(methodModifiers, {__index = sharedModifiers})<br />
---@type table<string, fun(model: docs.MethodModel)><br />
local methodAttributes = {<br />
static = function (model)<br />
model.isStatic = true<br />
end,<br />
hostOnly = noop<br />
}<br />
methodAttributes = setmetatable(methodAttributes, {__index = sharedAttributes})<br />
<br />
---@type table<string, fun(line: string, model: docs.FieldModel)><br />
local fieldModifiers = {<br />
["type"] = function (line, model)<br />
local s = spool.new(line)<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error "expected end of statement after field type" end<br />
model.readType = t<br />
model.writeType = t<br />
end,<br />
["readType"] = function (line, model)<br />
local s = spool.new(line)<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error "expected end of statement after field readType" end<br />
model.readType = t<br />
end,<br />
["writeType"] = function (line, model)<br />
local s = spool.new(line)<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error "expected end of statement after field writeType" end<br />
model.writeType = t<br />
end,<br />
}<br />
fieldModifiers = setmetatable(fieldModifiers, {__index = sharedModifiers})<br />
---@type table<string, fun(model: docs.FieldModel)><br />
local fieldAttributes = {<br />
readOnly = function (model)<br />
model.canWrite = false<br />
end,<br />
writeOnly = function (model)<br />
model.canRead = false<br />
end<br />
}<br />
fieldAttributes = setmetatable(fieldAttributes, {__index = sharedAttributes})<br />
<br />
---@param sigtext string<br />
local function parseMethodSignature(sigtext)<br />
local s = spool.new(sigtext)<br />
<br />
---@type docs.MethodSignature<br />
local model = {<br />
returns = {},<br />
parameters = {}<br />
}<br />
<br />
local function parseParameter(assumeV)<br />
---@type docs.MethodSignature.Parameter<br />
local param = setmetatable({<br />
name = "",<br />
type = typeDefinitions.void,<br />
vararg = false<br />
}, {<br />
__tostring = function (t)<br />
return ("<param %s (%s)>"):format(t.name, tostring(t.type))<br />
end<br />
})<br />
if assumeV then<br />
param.name = "..."<br />
param.vararg = true<br />
else<br />
-- already consumed: 'parameter '<br />
if s:matchadv("^%.%.%. ?") then<br />
param.name = "..."<br />
param.vararg = true<br />
else<br />
param.name = s:matchc("^([a-zA-Z0-9]+) ?()", "Expected parameter name at %d but found nothing")<br />
s:commit()<br />
end<br />
end<br />
s:consumeSpace()<br />
param.type = parseType(s)<br />
s:consumeSpace()<br />
if not s:matchadv('^;') then error("Expected a semicolon to end parameter declaration at position " .. s.cursor) end<br />
model.parameters[#model.parameters+1] = param<br />
end<br />
<br />
local function parseReturns()<br />
-- already consumed: 'returns '<br />
model.returns[#model.returns+1] = parseType(s)<br />
s:consumeSpace()<br />
while s:matchadv('^,') do<br />
s:consumeSpace()<br />
model.returns[#model.returns+1] = parseType(s)<br />
s:consumeSpace()<br />
end<br />
if not s:matchadv('^;') then error("Expected a semicolon to end returns declaration at position " .. s.cursor) end<br />
end<br />
<br />
local function parseStmt()<br />
if s:matchadv "^/%*" then<br />
return parseComment(s)<br />
end<br />
if s:matchadv "^returns " then<br />
return parseReturns()<br />
end<br />
if s:matchadv "^parameter%.%.%." then<br />
return parseParameter(true)<br />
end<br />
if s:matchadv "^parameter " then<br />
return parseParameter()<br />
end<br />
error("No valid signature statement at " .. s.cursor)<br />
end<br />
<br />
local function parse()<br />
s:consumeSpace()<br />
while not s:isAtEOF() do<br />
parseStmt()<br />
s:consumeSpace()<br />
end<br />
end<br />
parse()<br />
return model<br />
end<br />
<br />
---@param docstr string<br />
local function parseMethod(docstr)<br />
local s = spool.new(docstr)<br />
<br />
---@type docs.MethodModel<br />
local model = {<br />
kind = "method",<br />
attributes = {},<br />
isStatic = false,<br />
name = "<unnamed>",<br />
origin = "Figura",<br />
signatures = {},<br />
}<br />
local parseTopLevelStmt, parseMethodHeader, parseSignatureOuter<br />
local blockKw = {}<br />
<br />
function parseSignatureOuter()<br />
s:consumeSpace()<br />
---@type string<br />
local block_content = s:matchc("^(%b{})%s*;()", "Expected a bracketed block after 'signature' at position %d")<br />
local inside = block_content:sub(2, -2)<br />
local sig = parseMethodSignature(inside)<br />
model.signatures[#model.signatures+1] = sig<br />
s:commit()<br />
end<br />
blockKw.signature = parseSignatureOuter<br />
<br />
function parseMethodHeader()<br />
local name = s:matchc("^([^%s;]+) ?()", "Expected method name at %d")<br />
model.name = name<br />
s:commit()<br />
s:consumeSpace()<br />
local peek = s:peek()<br />
while #peek ~= 0 and peek ~= ';' do<br />
local attr = s:matchc("^([^%s;]+) ?()", "Expected something else!")<br />
if not methodAttributes[attr] then<br />
error(("Unknown method attribute '%s' at position %d in method header"):format(attr, s.cursor))<br />
end<br />
methodAttributes[attr](model)<br />
model.attributes[attr] = true<br />
s:commit()<br />
s:consumeSpace()<br />
peek = s:peek()<br />
end<br />
if peek == ';' then<br />
s:adv() -- advance past the ;<br />
else<br />
error("Reached end of method documentation while parsing header")<br />
end<br />
end<br />
<br />
function parseTopLevelStmt()<br />
local startAt = s.cursor<br />
---@type string<br />
local action = s:matchc("^([^%s;]+) ?()", "Expected a modifier or block keyword, but got nothing instead at position %d")<br />
s:commit()<br />
if methodModifiers[action] then<br />
---@type string<br />
local remainder = s:matchc("^(.-);%s*()", "Expected semicolon to end statement around %d")<br />
s:commit()<br />
return methodModifiers[action](remainder, model)<br />
end<br />
if blockKw[action] then return blockKw[action]() end<br />
error(("Expected a modifier or block keyword, but got '%s' instead at position %d"):format(action, startAt))<br />
end<br />
<br />
local function parse()<br />
s:consumeSpace()<br />
parseMethodHeader()<br />
s:consumeSpace()<br />
while not s:isAtEOF() do<br />
parseTopLevelStmt()<br />
s:consumeSpace()<br />
end<br />
end<br />
<br />
parse()<br />
return model<br />
end<br />
<br />
---@param docstr string<br />
---@return docs.FieldModel<br />
local function parseField(docstr)<br />
local s = spool.new(docstr)<br />
<br />
---@type docs.FieldModel<br />
local model = {<br />
kind = "field",<br />
attributes = {},<br />
name = "<unnamed>",<br />
origin = "Figura",<br />
canRead = true,<br />
canWrite = true<br />
}<br />
<br />
local parseTopLevelStmt, parseFieldHeader, parseSignatureOuter<br />
<br />
function parseFieldHeader()<br />
local name = s:matchc("^([^%s;]+) ?()", "Expected field name at %d")<br />
model.name = name<br />
s:commit()<br />
s:consumeSpace()<br />
local peek = s:peek()<br />
while #peek ~= 0 and peek ~= ';' do<br />
local attr = s:matchc("^([^%s;]+) ?()", "Expected something else!")<br />
if not fieldAttributes[attr] then<br />
error(("Unknown field attribute '%s' at position %d in field header"):format(attr, s.cursor))<br />
end<br />
fieldAttributes[attr](model)<br />
model.attributes[attr] = true<br />
s:commit()<br />
s:consumeSpace()<br />
peek = s:peek()<br />
end<br />
if peek == ';' then<br />
s:adv() -- advance past the ;<br />
else<br />
error("Reached end of field documentation while parsing header")<br />
end<br />
end<br />
<br />
function parseTopLevelStmt()<br />
local startAt = s.cursor<br />
---@type string<br />
local action = s:matchc("^([^%s;]+) ?()", "Expected a modifier, but got nothing instead at position %d")<br />
s:commit()<br />
if fieldModifiers[action] then<br />
---@type string<br />
local remainder = s:matchc("^(.-);%s*()", "Expected semicolon to end statement around %d")<br />
s:commit()<br />
return fieldModifiers[action](remainder, model)<br />
end<br />
error(("Expected a modifier, but got '%s' instead at position %d"):format(action, startAt))<br />
end<br />
<br />
local function parse()<br />
s:consumeSpace()<br />
parseFieldHeader()<br />
s:consumeSpace()<br />
while not s:isAtEOF() do<br />
parseTopLevelStmt()<br />
s:consumeSpace()<br />
end<br />
end<br />
<br />
parse()<br />
return model<br />
end<br />
<br />
---@param typeM docs.TypeModel<br />
local function renderType(typeM)<br />
return tostring(typeM)<br />
end<br />
<br />
---@param o any<br />
---@param i number?<br />
local function printFancy(o, i)<br />
i = i or 2<br />
local indent = (" "):rep(i)<br />
if type(o) == "table" then<br />
if getmetatable(o) and getmetatable(o).__tostring then<br />
return tostring(o)<br />
end<br />
local b = "{\n"<br />
for k, v in pairs(o) do<br />
b = b .. indent .. printFancy(k, i + 2) .. " = " .. printFancy(v, i + 2) .. ",\n"<br />
end<br />
b = b .. (" "):rep(i - 2) .. "}"<br />
return b<br />
else<br />
return tostring(o)<br />
end<br />
end<br />
<br />
local function parseAndRenderType(frame)<br />
local input_args = frame:getParent().args<br />
do return #input_args end<br />
if not input_args[1] then error "Need to specify at least one type" end<br />
if #input_args == 1 then<br />
local s = spool.new(input_args[1])<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error("Expected end of type at position " .. s.cursor) end<br />
return renderType(t)<br />
else<br />
do return table.concat(input_args, "|") end<br />
local s = spool.new(table.concat(input_args, "|"))<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error("Expected end of type at position " .. s.cursor) end<br />
return renderType(t)<br />
end<br />
end<br />
<br />
-- local m = parseField [[<br />
-- player global readOnly;<br />
-- type PlayerAPI;<br />
-- ]]<br />
-- print(printFancy(m))<br />
<br />
return {<br />
type = parseAndRenderType<br />
}</div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=User:PenguinEncounter/sandbox&diff=856
User:PenguinEncounter/sandbox
2025-03-30T23:48:57Z
<p>PenguinEncounter: </p>
<hr />
<div><div style="font-size: 3rem;">[https://wiki.figuramc.org/index.php/User:PenguinEncounter/sandbox?action=purge purge it]</div><br />
<br />
{{User:PenguinEncounter/newtype|boolean|other}}<br />
<br />
For example, to get the cube {{Emoji|BBCube.png}} RightArm:<br />
<br />
This is what is in your project:<br />
<br />
{{#invoke:MatrixFields|run|size=4}}<br />
<br />
{{tree|icon=FSFolderOpen.png|content=<code>my_avatar</code>|inner=<br />
{{tree|icon=FiguraJSON.png|content=<code>avatar.json</code>}}<br />
{{tree|icon=BBModel.png|content=<code>model.bbmodel</code>}}<br />
}}<br />
<br />
<br />
{{tree|icon=BBModel.png|content=<code>model.bbmodel</code>|inner=<br />
{{tree|icon=BBGroup.png|content=Head|inner=<br />
{{tree|icon=BBCube.png|content=Head}}<br />
{{tree|icon=BBCube.png|content=HeadLayer}}<br />
}}<br />
{{tree|icon=BBGroup.png|content=RightArm<br>oops|inner=<br />
{{tree|icon=BBCube.png|content=RightArm}}<br />
{{tree|icon=BBCube.png|content=RightArmLayer}}<br />
}}<br />
}}<br />
<br />
== conspicuous example code ==<br />
{{#tag:syntaxhighlight|<br />
function events.tick()<br />
<nowiki>--[[wiki.figuramc.org, </nowiki>{{FULLPAGENAME}} rev. {{REVISIONID}}<nowiki>]]</nowiki><br />
models.model.Head:setVisible(false)<br />
end<br />
|lang=lua}}<br />
<br />
= <code>HostAPI:setTitleTimes</code> =<br />
{{Host only|kind=method}}<br />
Configures the hold, fade-in, and fade-out durations of titles displayed on the screen.<br />
<br />
== Usage ==<br />
{| class="wikitable"<br />
! Arguments !! Return Type<br />
|-<br />
| <code>setTitleTimes(timesData {{type|Vector3}})</code><br />
| self {{type|HostAPI}}<br />
|-<br />
| <code>setTitleTimes(fadeInTime {{type|integer}}, stayTime {{type|integer}}, fadeOutTime {{type|integer}})</code><br />
| self {{type|HostAPI}}<br />
|}<br />
<br />
== Examples ==<br />
<syntaxhighlight lang="lua"><br />
host:setTitleTimes(1, 1, 1)<br />
</syntaxhighlight><br />
<br />
== See Also ==<br />
<!-- idk --></div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=Module:Signatures&diff=855
Module:Signatures
2025-03-30T23:48:53Z
<p>PenguinEncounter: </p>
<hr />
<div>-- a MediaWiki module<br />
<br />
--[[<br />
Syntax description:<br />
<name> <attr...> ...;;<br />
<modName> [modSyn];;<br />
]]<br />
<br />
---@alias docs.ModelKind "field" | "method" | "type"<br />
<br />
---Origin of this documentation item.<br />
---@alias docs.ModelOrigin<br />
---| "Lua" Lua 5.2 built-in types and APIs.<br />
---| "Figura" Figura types and APIs. Usually the default.<br />
---| "abstract" Describes ideas, but no concrete implementation exists.<br />
---| "typedef" Custom on-the-spot types, like function protocols or array types.<br />
<br />
---@alias Set<T> {[T]: true}<br />
<br />
---@class docs.DocModel<br />
---@field kind docs.ModelKind<br />
---@field name string?<br />
---@field prefixHint string?<br />
---@field attributes Set<string><br />
---@field origin docs.ModelOrigin<br />
<br />
---@class docs.FieldModel : docs.DocModel<br />
---@field kind "field"<br />
---@field canRead boolean<br />
---@field canWrite boolean<br />
---@field readType docs.TypeModel?<br />
---@field writeType docs.TypeModel?<br />
<br />
---@class docs.MethodModel : docs.DocModel<br />
---@field kind "method"<br />
---@field signatures docs.MethodSignature[]<br />
---@field isStatic boolean<br />
<br />
---@class docs.MethodSignature.Parameter<br />
---@field name string<br />
---@field type docs.TypeModel<br />
---@field vararg boolean?<br />
<br />
---@class docs.MethodSignature<br />
---@field returns docs.TypeModel[]<br />
---@field parameters docs.MethodSignature.Parameter[]<br />
<br />
---@class docs.TypeModel : docs.DocModel<br />
---@field kind "type"<br />
---@field typeKind "explicit" | "union"<br />
<br />
---@class docs.ExplicitType : docs.TypeModel<br />
---@field typeKind "explicit"<br />
---@field link string?<br />
<br />
---@class docs.UnionType : docs.TypeModel<br />
---@field typeKind "union"<br />
---@field anyOf docs.TypeModel[]<br />
<br />
---@type metatable<br />
local type_meta = {<br />
__tostring = function (t)<br />
return ("<type %s from %s>"):format(t.name or '(anonymous)', t.origin)<br />
end<br />
}<br />
<br />
---@class docs.spool : docs.DocModel<br />
---@field src string<br />
---@field cursor integer<br />
---@field cursorNext integer?<br />
local spool = {}<br />
<br />
---Create a new spool.<br />
---@param src string<br />
---@return docs.spool<br />
function spool.new(src)<br />
return setmetatable({<br />
src = src,<br />
cursor = 1<br />
}, {__index = spool})<br />
end<br />
<br />
---@return integer cursor<br />
function spool:consumeSpace()<br />
self.cursor = self.src:match("%s*()", self.cursor)<br />
return self.cursor<br />
end<br />
<br />
local unpack = unpack or table.unpack -- 5.2 compat<br />
<br />
---Starts matching from the current cursor position, and recieves the next cursor position from a position capture.<br />
---@param pattern string<br />
---@param noMatchMsg string Format pattern with 1 %d to hold the cursor value.<br />
---@return any ...<br />
function spool:matchc(pattern, noMatchMsg)<br />
local results = {self.src:match(pattern, self.cursor)}<br />
if #results == 0 then error(noMatchMsg:format(self.cursor)) end<br />
self.cursorNext = results[#results]<br />
results[#results] = nil<br />
return unpack(results)<br />
end<br />
<br />
---@return string<br />
function spool:peek()<br />
return self.src:sub(self.cursor, self.cursor)<br />
end<br />
<br />
function spool:adv()<br />
if self:isAtEOF() then return end<br />
self.cursor = self.cursor + 1<br />
end<br />
<br />
function spool:matchadv(pattern)<br />
local _, to = self.src:find(pattern, self.cursor)<br />
if to then<br />
self.cursor = to + 1<br />
return true<br />
end<br />
return false<br />
end<br />
<br />
function spool:commit()<br />
if not self.cursorNext then error "spool:commit(): Nothing to commit" end<br />
self.cursor = self.cursorNext<br />
self.cursorNext = nil<br />
end<br />
<br />
function spool:isAtEOF() return self.cursor > #self.src end<br />
<br />
local LUA_TYPES_URL = "https://www.lua.org/manual/5.2/manual.html#2.1"<br />
<br />
---@type table<string, docs.ExplicitType><br />
local typeDefinitions = {}<br />
---@type table<string, string><br />
local typeAlias = {}<br />
local types = setmetatable({}, {<br />
__index = function (t, k)<br />
local resolvedName = k<br />
local i = 0<br />
while typeAlias[resolvedName] do<br />
i = i + 1<br />
if i > 10 then error "internal: alias chain too long" end<br />
resolvedName = typeAlias[resolvedName]<br />
end<br />
return typeDefinitions[resolvedName]<br />
end<br />
})<br />
<br />
---@param name string<br />
---@param origin docs.ModelOrigin<br />
---@param link string?<br />
---@return docs.ExplicitType<br />
local function newExplicitType(name, origin, link)<br />
if typeDefinitions[name] then error "Type already exists" end<br />
---@type docs.ExplicitType<br />
local t = setmetatable({<br />
kind = "type",<br />
typeKind = "explicit",<br />
name = name,<br />
attributes = {},<br />
origin = origin,<br />
link = link<br />
}, type_meta)<br />
typeDefinitions[name] = t<br />
return t<br />
end<br />
<br />
---@param anyOf docs.TypeModel[]<br />
---@return docs.UnionType<br />
local function newUnionType(anyOf)<br />
local function flatten(typ)<br />
if not typ.kind or typ.typeKind == "union" then<br />
local iterator<br />
if not typ.kind then<br />
iterator = typ<br />
else<br />
iterator = typ.anyOf<br />
end<br />
local seen = {}<br />
local res = {}<br />
for _, typ2 in ipairs(iterator) do<br />
for _, v in ipairs(flatten(typ2)) do<br />
if not seen[v] then<br />
res[#res + 1] = v<br />
seen[v] = true<br />
end<br />
end<br />
end<br />
return res<br />
elseif typ.typeKind == "explicit" then<br />
return { typ }<br />
end<br />
error "No type"<br />
end<br />
---@type docs.UnionType<br />
return setmetatable({<br />
anyOf = flatten(anyOf),<br />
attributes = {},<br />
kind = "type",<br />
origin = "abstract",<br />
typeKind = "union"<br />
}, {<br />
__tostring = function (t)<br />
local chunks = {}<br />
for _, type in ipairs(t.anyOf) do<br />
chunks[#chunks+1] = tostring(type)<br />
end<br />
return table.concat(chunks, ' | ')<br />
end<br />
})<br />
end<br />
<br />
---@param name string<br />
---@param origin docs.ModelOrigin<br />
---@return docs.ExplicitType<br />
local function getOrDefineType(name, origin)<br />
local t = types[name]<br />
if t then return t end<br />
return newExplicitType(name, origin, name)<br />
end<br />
<br />
---Create a new type definition type.<br />
---@param typedefname string without #<br />
---@return docs.TypeModel<br />
local function newTypedef(typedefname)<br />
local prefixed = "#"..typedefname<br />
if typeDefinitions[prefixed] then return typeDefinitions[prefixed] end<br />
---@type docs.ExplicitType<br />
local t = setmetatable({<br />
kind = "type",<br />
typeKind = "explicit",<br />
name = typedefname,<br />
attributes = {},<br />
origin = "typedef",<br />
link = "#typedef_"..typedefname<br />
}, type_meta)<br />
typeDefinitions[prefixed] = t<br />
return t<br />
end<br />
<br />
do -- builtin types<br />
<br />
-- currying<br />
---@param sourceName string<br />
---@return fun(list: string[])<br />
local function alias(sourceName)<br />
return function(list)<br />
for _, v in ipairs(list) do<br />
typeAlias[v] = sourceName<br />
end<br />
end<br />
end<br />
<br />
newExplicitType("any", "abstract")<br />
alias "any" { "AnyType" }<br />
newExplicitType("void", "abstract")<br />
newExplicitType("nil", "Lua", LUA_TYPES_URL)<br />
alias "nil" { "null" }<br />
newExplicitType("boolean", "Lua", LUA_TYPES_URL)<br />
alias "boolean" { "Boolean" }<br />
newExplicitType("number", "Lua", LUA_TYPES_URL)<br />
alias "number" { "Number", "double", "float" }<br />
newExplicitType("integer", "Lua", LUA_TYPES_URL)<br />
alias "integer" { "Integer" }<br />
newExplicitType("string", "Lua", LUA_TYPES_URL)<br />
alias "string" { "String" }<br />
newExplicitType("function", "Lua", LUA_TYPES_URL)<br />
alias "function" { "Function" }<br />
newExplicitType("userdata", "Lua", LUA_TYPES_URL)<br />
alias "userdata" { "Userdata" }<br />
newExplicitType("table", "Lua", LUA_TYPES_URL)<br />
alias "table" { "Table" }<br />
end<br />
<br />
---@param s docs.spool<br />
local function parseComment(s)<br />
s:matchc("%*/()", "No end of comment found")<br />
s:commit()<br />
end<br />
<br />
---@param s docs.spool<br />
---@return docs.TypeModel<br />
local function parseSimpleType(s)<br />
if s:isAtEOF() then error("Expected a type at position " .. s.cursor .. " but instead found nothing") end<br />
local prefix = s:peek()<br />
if prefix == "#" then<br />
s:adv()<br />
local typename = s:matchc("^([a-zA-Z0-9]+) ?()", "Expected a typedef name at position %d, but found nothing after the #")<br />
s:commit()<br />
return newTypedef(typename)<br />
end<br />
local typename = s:matchc("^([a-zA-Z0-9]+) ?()", "Expected a type name at position %d, but found nothing")<br />
s:commit()<br />
local t = getOrDefineType(typename, "Figura")<br />
return t<br />
end<br />
<br />
---@param s docs.spool<br />
local function parseType(s)<br />
local t = parseSimpleType(s)<br />
s:consumeSpace()<br />
local nextC = s:peek()<br />
if nextC == '|' then<br />
local unions = {t}<br />
while nextC == '|' do<br />
s:adv()<br />
s:consumeSpace()<br />
unions[#unions+1] = parseSimpleType(s)<br />
s:consumeSpace()<br />
nextC = s:peek()<br />
end<br />
return newUnionType(unions)<br />
else<br />
return t<br />
end<br />
end<br />
<br />
local function noop() end<br />
<br />
---@type table<string, fun(line: string, model: docs.DocModel)><br />
local sharedModifiers = {<br />
prefixHint = function (line, model)<br />
if model.prefixHint then error "duplicate prefixHint declaration" end<br />
model.prefixHint = line<br />
end<br />
}<br />
---@type table<string, fun(model: docs.DocModel)><br />
local sharedAttributes = {<br />
global = noop<br />
}<br />
<br />
---@type table<string, fun(line: string, model: docs.MethodModel)><br />
local methodModifiers = {<br />
}<br />
methodModifiers = setmetatable(methodModifiers, {__index = sharedModifiers})<br />
---@type table<string, fun(model: docs.MethodModel)><br />
local methodAttributes = {<br />
static = function (model)<br />
model.isStatic = true<br />
end,<br />
hostOnly = noop<br />
}<br />
methodAttributes = setmetatable(methodAttributes, {__index = sharedAttributes})<br />
<br />
---@type table<string, fun(line: string, model: docs.FieldModel)><br />
local fieldModifiers = {<br />
["type"] = function (line, model)<br />
local s = spool.new(line)<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error "expected end of statement after field type" end<br />
model.readType = t<br />
model.writeType = t<br />
end,<br />
["readType"] = function (line, model)<br />
local s = spool.new(line)<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error "expected end of statement after field readType" end<br />
model.readType = t<br />
end,<br />
["writeType"] = function (line, model)<br />
local s = spool.new(line)<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error "expected end of statement after field writeType" end<br />
model.writeType = t<br />
end,<br />
}<br />
fieldModifiers = setmetatable(fieldModifiers, {__index = sharedModifiers})<br />
---@type table<string, fun(model: docs.FieldModel)><br />
local fieldAttributes = {<br />
readOnly = function (model)<br />
model.canWrite = false<br />
end,<br />
writeOnly = function (model)<br />
model.canRead = false<br />
end<br />
}<br />
fieldAttributes = setmetatable(fieldAttributes, {__index = sharedAttributes})<br />
<br />
---@param sigtext string<br />
local function parseMethodSignature(sigtext)<br />
local s = spool.new(sigtext)<br />
<br />
---@type docs.MethodSignature<br />
local model = {<br />
returns = {},<br />
parameters = {}<br />
}<br />
<br />
local function parseParameter(assumeV)<br />
---@type docs.MethodSignature.Parameter<br />
local param = setmetatable({<br />
name = "",<br />
type = typeDefinitions.void,<br />
vararg = false<br />
}, {<br />
__tostring = function (t)<br />
return ("<param %s (%s)>"):format(t.name, tostring(t.type))<br />
end<br />
})<br />
if assumeV then<br />
param.name = "..."<br />
param.vararg = true<br />
else<br />
-- already consumed: 'parameter '<br />
if s:matchadv("^%.%.%. ?") then<br />
param.name = "..."<br />
param.vararg = true<br />
else<br />
param.name = s:matchc("^([a-zA-Z0-9]+) ?()", "Expected parameter name at %d but found nothing")<br />
s:commit()<br />
end<br />
end<br />
s:consumeSpace()<br />
param.type = parseType(s)<br />
s:consumeSpace()<br />
if not s:matchadv('^;') then error("Expected a semicolon to end parameter declaration at position " .. s.cursor) end<br />
model.parameters[#model.parameters+1] = param<br />
end<br />
<br />
local function parseReturns()<br />
-- already consumed: 'returns '<br />
model.returns[#model.returns+1] = parseType(s)<br />
s:consumeSpace()<br />
while s:matchadv('^,') do<br />
s:consumeSpace()<br />
model.returns[#model.returns+1] = parseType(s)<br />
s:consumeSpace()<br />
end<br />
if not s:matchadv('^;') then error("Expected a semicolon to end returns declaration at position " .. s.cursor) end<br />
end<br />
<br />
local function parseStmt()<br />
if s:matchadv "^/%*" then<br />
return parseComment(s)<br />
end<br />
if s:matchadv "^returns " then<br />
return parseReturns()<br />
end<br />
if s:matchadv "^parameter%.%.%." then<br />
return parseParameter(true)<br />
end<br />
if s:matchadv "^parameter " then<br />
return parseParameter()<br />
end<br />
error("No valid signature statement at " .. s.cursor)<br />
end<br />
<br />
local function parse()<br />
s:consumeSpace()<br />
while not s:isAtEOF() do<br />
parseStmt()<br />
s:consumeSpace()<br />
end<br />
end<br />
parse()<br />
return model<br />
end<br />
<br />
---@param docstr string<br />
local function parseMethod(docstr)<br />
local s = spool.new(docstr)<br />
<br />
---@type docs.MethodModel<br />
local model = {<br />
kind = "method",<br />
attributes = {},<br />
isStatic = false,<br />
name = "<unnamed>",<br />
origin = "Figura",<br />
signatures = {},<br />
}<br />
local parseTopLevelStmt, parseMethodHeader, parseSignatureOuter<br />
local blockKw = {}<br />
<br />
function parseSignatureOuter()<br />
s:consumeSpace()<br />
---@type string<br />
local block_content = s:matchc("^(%b{})%s*;()", "Expected a bracketed block after 'signature' at position %d")<br />
local inside = block_content:sub(2, -2)<br />
local sig = parseMethodSignature(inside)<br />
model.signatures[#model.signatures+1] = sig<br />
s:commit()<br />
end<br />
blockKw.signature = parseSignatureOuter<br />
<br />
function parseMethodHeader()<br />
local name = s:matchc("^([^%s;]+) ?()", "Expected method name at %d")<br />
model.name = name<br />
s:commit()<br />
s:consumeSpace()<br />
local peek = s:peek()<br />
while #peek ~= 0 and peek ~= ';' do<br />
local attr = s:matchc("^([^%s;]+) ?()", "Expected something else!")<br />
if not methodAttributes[attr] then<br />
error(("Unknown method attribute '%s' at position %d in method header"):format(attr, s.cursor))<br />
end<br />
methodAttributes[attr](model)<br />
model.attributes[attr] = true<br />
s:commit()<br />
s:consumeSpace()<br />
peek = s:peek()<br />
end<br />
if peek == ';' then<br />
s:adv() -- advance past the ;<br />
else<br />
error("Reached end of method documentation while parsing header")<br />
end<br />
end<br />
<br />
function parseTopLevelStmt()<br />
local startAt = s.cursor<br />
---@type string<br />
local action = s:matchc("^([^%s;]+) ?()", "Expected a modifier or block keyword, but got nothing instead at position %d")<br />
s:commit()<br />
if methodModifiers[action] then<br />
---@type string<br />
local remainder = s:matchc("^(.-);%s*()", "Expected semicolon to end statement around %d")<br />
s:commit()<br />
return methodModifiers[action](remainder, model)<br />
end<br />
if blockKw[action] then return blockKw[action]() end<br />
error(("Expected a modifier or block keyword, but got '%s' instead at position %d"):format(action, startAt))<br />
end<br />
<br />
local function parse()<br />
s:consumeSpace()<br />
parseMethodHeader()<br />
s:consumeSpace()<br />
while not s:isAtEOF() do<br />
parseTopLevelStmt()<br />
s:consumeSpace()<br />
end<br />
end<br />
<br />
parse()<br />
return model<br />
end<br />
<br />
---@param docstr string<br />
---@return docs.FieldModel<br />
local function parseField(docstr)<br />
local s = spool.new(docstr)<br />
<br />
---@type docs.FieldModel<br />
local model = {<br />
kind = "field",<br />
attributes = {},<br />
name = "<unnamed>",<br />
origin = "Figura",<br />
canRead = true,<br />
canWrite = true<br />
}<br />
<br />
local parseTopLevelStmt, parseFieldHeader, parseSignatureOuter<br />
<br />
function parseFieldHeader()<br />
local name = s:matchc("^([^%s;]+) ?()", "Expected field name at %d")<br />
model.name = name<br />
s:commit()<br />
s:consumeSpace()<br />
local peek = s:peek()<br />
while #peek ~= 0 and peek ~= ';' do<br />
local attr = s:matchc("^([^%s;]+) ?()", "Expected something else!")<br />
if not fieldAttributes[attr] then<br />
error(("Unknown field attribute '%s' at position %d in field header"):format(attr, s.cursor))<br />
end<br />
fieldAttributes[attr](model)<br />
model.attributes[attr] = true<br />
s:commit()<br />
s:consumeSpace()<br />
peek = s:peek()<br />
end<br />
if peek == ';' then<br />
s:adv() -- advance past the ;<br />
else<br />
error("Reached end of field documentation while parsing header")<br />
end<br />
end<br />
<br />
function parseTopLevelStmt()<br />
local startAt = s.cursor<br />
---@type string<br />
local action = s:matchc("^([^%s;]+) ?()", "Expected a modifier, but got nothing instead at position %d")<br />
s:commit()<br />
if fieldModifiers[action] then<br />
---@type string<br />
local remainder = s:matchc("^(.-);%s*()", "Expected semicolon to end statement around %d")<br />
s:commit()<br />
return fieldModifiers[action](remainder, model)<br />
end<br />
error(("Expected a modifier, but got '%s' instead at position %d"):format(action, startAt))<br />
end<br />
<br />
local function parse()<br />
s:consumeSpace()<br />
parseFieldHeader()<br />
s:consumeSpace()<br />
while not s:isAtEOF() do<br />
parseTopLevelStmt()<br />
s:consumeSpace()<br />
end<br />
end<br />
<br />
parse()<br />
return model<br />
end<br />
<br />
---@param typeM docs.TypeModel<br />
local function renderType(typeM)<br />
return tostring(typeM)<br />
end<br />
<br />
---@param o any<br />
---@param i number?<br />
local function printFancy(o, i)<br />
i = i or 2<br />
local indent = (" "):rep(i)<br />
if type(o) == "table" then<br />
if getmetatable(o) and getmetatable(o).__tostring then<br />
return tostring(o)<br />
end<br />
local b = "{\n"<br />
for k, v in pairs(o) do<br />
b = b .. indent .. printFancy(k, i + 2) .. " = " .. printFancy(v, i + 2) .. ",\n"<br />
end<br />
b = b .. (" "):rep(i - 2) .. "}"<br />
return b<br />
else<br />
return tostring(o)<br />
end<br />
end<br />
<br />
local function parseAndRenderType(frame)<br />
local input_args = frame:getParent().args<br />
do return printFancy(input_args) end<br />
if not input_args[1] then error "Need to specify at least one type" end<br />
if #input_args == 1 then<br />
do return input_args[1] end<br />
local s = spool.new(input_args[1])<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error("Expected end of type at position " .. s.cursor) end<br />
return renderType(t)<br />
else<br />
do return table.concat(input_args, "|") end<br />
local s = spool.new(table.concat(input_args, "|"))<br />
local t = parseType(s)<br />
s:consumeSpace()<br />
if not s:isAtEOF() then error("Expected end of type at position " .. s.cursor) end<br />
return renderType(t)<br />
end<br />
end<br />
<br />
-- local m = parseField [[<br />
-- player global readOnly;<br />
-- type PlayerAPI;<br />
-- ]]<br />
-- print(printFancy(m))<br />
<br />
return {<br />
type = parseAndRenderType<br />
}</div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=User:PenguinEncounter/sandbox&diff=854
User:PenguinEncounter/sandbox
2025-03-30T23:47:11Z
<p>PenguinEncounter: </p>
<hr />
<div><div style="font-size: 3rem;">[https://wiki.figuramc.org/index.php/User:PenguinEncounter/sandbox?action=purge purge it]</div><br />
<br />
{{User:PenguinEncounter/newtype|boolean}}<br />
<br />
For example, to get the cube {{Emoji|BBCube.png}} RightArm:<br />
<br />
This is what is in your project:<br />
<br />
{{#invoke:MatrixFields|run|size=4}}<br />
<br />
{{tree|icon=FSFolderOpen.png|content=<code>my_avatar</code>|inner=<br />
{{tree|icon=FiguraJSON.png|content=<code>avatar.json</code>}}<br />
{{tree|icon=BBModel.png|content=<code>model.bbmodel</code>}}<br />
}}<br />
<br />
<br />
{{tree|icon=BBModel.png|content=<code>model.bbmodel</code>|inner=<br />
{{tree|icon=BBGroup.png|content=Head|inner=<br />
{{tree|icon=BBCube.png|content=Head}}<br />
{{tree|icon=BBCube.png|content=HeadLayer}}<br />
}}<br />
{{tree|icon=BBGroup.png|content=RightArm<br>oops|inner=<br />
{{tree|icon=BBCube.png|content=RightArm}}<br />
{{tree|icon=BBCube.png|content=RightArmLayer}}<br />
}}<br />
}}<br />
<br />
== conspicuous example code ==<br />
{{#tag:syntaxhighlight|<br />
function events.tick()<br />
<nowiki>--[[wiki.figuramc.org, </nowiki>{{FULLPAGENAME}} rev. {{REVISIONID}}<nowiki>]]</nowiki><br />
models.model.Head:setVisible(false)<br />
end<br />
|lang=lua}}<br />
<br />
= <code>HostAPI:setTitleTimes</code> =<br />
{{Host only|kind=method}}<br />
Configures the hold, fade-in, and fade-out durations of titles displayed on the screen.<br />
<br />
== Usage ==<br />
{| class="wikitable"<br />
! Arguments !! Return Type<br />
|-<br />
| <code>setTitleTimes(timesData {{type|Vector3}})</code><br />
| self {{type|HostAPI}}<br />
|-<br />
| <code>setTitleTimes(fadeInTime {{type|integer}}, stayTime {{type|integer}}, fadeOutTime {{type|integer}})</code><br />
| self {{type|HostAPI}}<br />
|}<br />
<br />
== Examples ==<br />
<syntaxhighlight lang="lua"><br />
host:setTitleTimes(1, 1, 1)<br />
</syntaxhighlight><br />
<br />
== See Also ==<br />
<!-- idk --></div>
PenguinEncounter
https://wiki.figuramc.org/index.php?title=User:PenguinEncounter/sandbox&diff=853
User:PenguinEncounter/sandbox
2025-03-30T23:46:07Z
<p>PenguinEncounter: </p>
<hr />
<div>{{User:PenguinEncounter/newtype|boolean}}<br />
<br />
For example, to get the cube {{Emoji|BBCube.png}} RightArm:<br />
<br />
This is what is in your project:<br />
<br />
{{#invoke:MatrixFields|run|size=4}}<br />
<br />
{{tree|icon=FSFolderOpen.png|content=<code>my_avatar</code>|inner=<br />
{{tree|icon=FiguraJSON.png|content=<code>avatar.json</code>}}<br />
{{tree|icon=BBModel.png|content=<code>model.bbmodel</code>}}<br />
}}<br />
<br />
<br />
{{tree|icon=BBModel.png|content=<code>model.bbmodel</code>|inner=<br />
{{tree|icon=BBGroup.png|content=Head|inner=<br />
{{tree|icon=BBCube.png|content=Head}}<br />
{{tree|icon=BBCube.png|content=HeadLayer}}<br />
}}<br />
{{tree|icon=BBGroup.png|content=RightArm<br>oops|inner=<br />
{{tree|icon=BBCube.png|content=RightArm}}<br />
{{tree|icon=BBCube.png|content=RightArmLayer}}<br />
}}<br />
}}<br />
<br />
== conspicuous example code ==<br />
{{#tag:syntaxhighlight|<br />
function events.tick()<br />
<nowiki>--[[wiki.figuramc.org, </nowiki>{{FULLPAGENAME}} rev. {{REVISIONID}}<nowiki>]]</nowiki><br />
models.model.Head:setVisible(false)<br />
end<br />
|lang=lua}}<br />
<br />
= <code>HostAPI:setTitleTimes</code> =<br />
{{Host only|kind=method}}<br />
Configures the hold, fade-in, and fade-out durations of titles displayed on the screen.<br />
<br />
== Usage ==<br />
{| class="wikitable"<br />
! Arguments !! Return Type<br />
|-<br />
| <code>setTitleTimes(timesData {{type|Vector3}})</code><br />
| self {{type|HostAPI}}<br />
|-<br />
| <code>setTitleTimes(fadeInTime {{type|integer}}, stayTime {{type|integer}}, fadeOutTime {{type|integer}})</code><br />
| self {{type|HostAPI}}<br />
|}<br />
<br />
== Examples ==<br />
<syntaxhighlight lang="lua"><br />
host:setTitleTimes(1, 1, 1)<br />
</syntaxhighlight><br />
<br />
== See Also ==<br />
<!-- idk --></div>
PenguinEncounter