Documentation

Start here

• Getting started

  Write and run your first AeoScript file.

Language

• Functions

  Write code once. Call it when you need it.

• Variables

  Keep a value and use it later.

• Control flow

  Choose what runs and repeat work.

• Baskets

  Store values in order.

• Maps

  Store values by key.

• Types

  Know what kind of value you have.

• Syntax

  Read and write AeoScript statements.

• Operators

  Calculate, compare, and combine values.

Scripting with Worldkiln

• Finding Objects

  Choose a lookup that searches the objects you need.

• Events

  Let scripts communicate without directly calling each other.

• Waiting

  Pause a script and continue where it stopped.

• Actors and Modules

  Attach behavior to an Actor or share functions between scripts.

• Cells

  Read and change voxel World objects during Play.

• Entity scripts

  Keep per-object state and respond to lifecycle calls.

• Live Entities

  Control objects that exist during Play.

• UI

  Create controls or find controls made in the editor.

• Input

  React to keys or read gameplay input.

• Audio

  Play sounds from AudioEmitter Cells.

• Script control

  Enable or disable scripts during the game.

• Save data [BETA]

  Keep supported game values between sessions.

• Attributes

  Add named values to Cells and Actors.

• Script bindings

  Attach a script to a specific object.

• Names and IDs

  Choose names for discovery and IDs for exact objects.

• Play-mode changes

  Understand what resets when Play stops.

Worldkiln

• Getting started with Worldkiln

  Create a project, build a small World, and test it.

• Building

  Place, paint, select, and remove World Cells.

• Editor workspace

  Find the tools that edit and test your project.

• Hierarchy

  Organize Actors and their scripts.

• Characters

  Use Character packages for objects that move and animate.

• Camera

  Set the gameplay view and handle nearby obstacles.

• Physics

  Choose how objects collide and move.

• Lighting

  Choose the World lighting and test it while building.

• Projects and builds

  Save authored work and package a standalone game.

• Settings

  Adjust editor preferences and display options.

Tutorials

• Your first World

  Build a floor and test the Player spawn.

• Your first script

  Print a message when Play starts.

• Make a pickup

  Hide a pickup when the Player touches it.

• Create a runtime Cell

  Create a temporary Block when Play starts.

• Make a timed Block

  Create a Block, then remove it after a delay.

Troubleshooting

• Debugging scripts

  Read Output and check the values your script uses.

• Script errors

  Fix the first error, then run the script again.

Reference

Find an API · Standard library