Creation Manual HTML Overview

Back

The Creation Manual is a pdf which describes how to write Lua code to mod the game Fractal Block World. To access the pdf, go back one page.

These HTML files just give a list of various functions. To see what the functions actually do, consult the Creation Manual.

The following pages list two types of functions:

1) Functions you define in your Lua scripts which are called by the engine. These functions always start with a double underscore. We call these functions "entry points".

2) API functions which you can call from your Lua code. When your Lua code is run, the program is always inside a "Lua state". There are 3 Lua states: Initialization, Game, and Chunk Generation. Various API functions can only be accessed from certain Lua states. The Chunk Generation API can only be accessed in the Chunk Generation Lua state. The Game API (and Game Window API) can only be accessed in the Game Lua state. The Initialization API can only be accessed in the Initialization Lua state.

---

Entry Points

Block Scripts: Init Entry Points

Block Scripts: Chunk Generation Entry Points

Block Scripts: Game Entry Points

Basic Entity Scripts: All Entry Points

Moving Entity Scripts: All Entry Points

Env Rect Scripts: All Entry Points

Window Scripts: All Entry Points

Game Scripts: All Entry Points

---

API Functions

Initialization API

Game API

Game API: Windows (Really part of the Game API).

Chunk Generation API

---

Entity Variables

Block Builtin Vars

Moving Entity Builtin Vars