Reference
Every function Wax gives a mod, with its parameters and what it returns.
The guides explain one idea at a time. The reference lists everything. Use it when you know what you are looking for.
ui
Windows, overlays, notifications, hotkeys, themes and icons.
Controls
Every control and every option it takes.
game
The game tree, Instances, players, creatures and outlines.
Game tables
game.Data: the game's own tables, read and changed.
Tasks and signals
task, Signal and connections.
Mods
mod, log, print, persist, storage, require and raw.
Characters
game.Me, and the fields of every character.
Stats and modifiers
A character's stats and the effects that are on it.
Items and inventories
game.Items, inventories, Give and Take.
Time, weather and the prospect
game.Time, game.Weather and game.Prospect.
Creatures
The fields of a creature, and what the game's data says about a kind.
Creature models
What game.Creatures:GetModel gives.
Recipes
game.Recipes: finding and changing recipes.
The store
game.Workshop: categories, nodes and prices.
Assets
game.Assets: assets by path, materials and shapes.
Blueprints
game.Blueprints: things described in Lua and spawned.
Watching values
game.Frame, the signal for every frame.
To search all of it at once, open the Explorer. It also has the classes of the game itself, such
as IcarusPlayerCharacter, with their properties and functions.
How to read an entry
Each function has a line like this:
ui.Notify(text: any, options?: WaxNotifyOptions): WaxNotification- The names in brackets are what you pass in. After each name comes the kind of value it takes.
- A
?after a name means you may leave it out. - What comes after the last
:is what the function gives back.
Names that start with Wax are kinds of values that Wax defines. WaxNotifyOptions is a table of options,
and WaxNotification is the notification you get back. Click one to see what is in it.
Dot or colon
- Use a dot for functions that stand on their own:
ui.Notify(...),task.wait(1),storage.Save(...). - Use a colon for functions that act on one thing:
window:Button(...),label:Set(...),game:Find(...).
The reference shows each function the way you write it.
The reference and your editor
The reference comes from the same definition files that give your editor its completion list. Both show the same functions with the same descriptions.