How Do I… Tab

The API Reference section lists every GardenlyScript namespace (find, place, edit, measure, layers, selection, costs, terrain, etc.) and all their methods.

Each method entry shows:

• Method signature — name, parameter names and types
• Parameter table — each parameter with its type, whether it is required or optional, any allowed range or constraint, and its default value
• Return type — what the method returns
• Error table — possible errors thrown and when they occur
• Code example — a working snippet you can paste into your script

Use the search bar at the top to filter by namespace, method name, or description keyword. Type find to see all find methods, place.plant to jump straight to the plant-placement method, etc.

Each method is also annotated with a budget badge (read, mutation, creation, or none) so you know which operations count against the run limits.

The Lua Guide section below the API Reference is a compact Lua 5.5 cheatsheet for designers who are new to the language.

It is organised into collapsible sections:

• Variables and types — nil, boolean, number, string, table
• Truthiness — only nil and false are falsy; 0 and "" are truthy
• Strings — concatenation (..), string.format, string.len, string.sub
• Type conversions — tostring(), tonumber()
• Tables — arrays and dictionaries, table.insert, table.remove, #
• Loops — numeric for, ipairs, pairs, while, repeat … until
• Conditionals — if / elseif / else / end
• Functions — multiple return values, closures
• Error handling — pcall for safe calls that may error
• Math — math.floor, math.ceil, math.random, math.sqrt, etc.
• Nil safety — x = x or default pattern, optional chaining with and
• Scope — local vs. global variables

Each section includes short code examples. Click a section header to expand or collapse it.

All namespaces (such as find, place, edit, measure, layers, selection, costs, and terrain) are expanded by default. Click a namespace header to collapse or expand it. Each method row shows the method signature and return type inline so you can scan available methods at a glance without opening individual entries.

Click any method row to expand its detail panel. The panel shows the full parameter table — each parameter with its type, whether it is required or optional, allowed range or constraint, and default value. Below the parameters you will find the return type, a return detail description explaining the shape and fields of the returned value, and a throws table listing every error the method may raise and the condition that triggers it.

Each expanded method detail includes a working code example. Click the Insert into script button on the example to paste it at your current cursor position in the Code editor — no copy-and-paste required. Switch to the Editor tab to see the inserted snippet and continue editing from there.

Each method displays a budget badge indicating its operation category: read (counts against read limits), mutation (modifies existing entities), creation (adds new entities), or none (free operation). Methods also carry a stability label — stable, beta, alpha, experimental, or deprecated — so you know what to rely on for production automations. Methods gated to a higher subscription tier are greyed out with a tier label.

Click the Lua Guide pill to switch to the Lua 5.5 cheatsheet. The guide is organised into collapsible sections covering variables and types, truthiness rules, strings, type conversions, tables, loops, conditionals, functions, error handling with pcall, math helpers, nil safety patterns, and variable scope. Each section includes short code examples. Click a section header to expand or collapse it.