Lua Documentation

Globals

ENTS

Contains handles to all valid and invalid entities in the game. Checking validity of these is up to you.

GAME

A table intended to be used for Lua-driven game logic functions. These functions can be overridden by event.handler handlers.

function GAME:event_one()
  print("Hello World!")
end

event.handler("event_one", "my_event_handler", function()
  print("No, I say hello!")
  return true -- Override the GAME function here.
end)

Expected output:

...
No, I say hello!

Functions

Libraries

game

setstage

bind

getstage

player

event

run

handler

platform

time

timesec

timeusec

sleep

usleep

nsleep

ent

create

clear

remove

util

lerp

kibibytes

mebibytes

gibibytes

kbytes

mbytes

gbytes

radians

degrees

meters

Events

init

Provides 0 arguments, expects 0 return values

post_init

Provides 0 arguments, expects 0 return values

pre_update

Provides 0 arguments, expects 0 return values

update

Provides 0 arguments, expects 0 return values

post_update

Provides 0 arguments, expects 0 return values

pre_update_lazy

Provides 0 arguments, expects 0 return values

update_lazy

Provides 0 arguments, expects 0 return values

post_update_lazy

Provides 0 arguments, expects 0 return values

pre_update_paused

Provides 0 arguments, expects 0 return values

update_paused

Provides 0 arguments, expects 0 return values

post_update_paused

Provides 0 arguments, expects 0 return values

pre_create_bindings

Provides 0 arguments, expects 1 (or zero) return values

create_bindings

Provides 0 arguments, expects 0 return values

post_create_bindings

Provides 0 arguments, expects 0 return values

process_input

Provides 1 arguments, expects 1 (or zero) return values

pre_stage_destroy

Provides 0 arguments, expects 1 (or zero) return values

post_stage_destroy

Provides 0 arguments, expects 0 return values

pre_set_stage

Provides 2 arguments, expects 1 (or zero) return values

post_set_stage

Provides 0 arguments, expects 0 return values

ent_create

Provides 1 arguments, expects 0 return values

pre_ent_remove

Provides 1 arguments, expects 0 return values

can_remove_entity

Provides 1 arguments, expects 1 (or zero) return values

ent_removed

Provides 1 arguments, expects 0 return values

player_created

Provides 1 arguments, expects 0 return values

pre_clear_entities

Provides 0 arguments, expects 0 return values

can_clear_entity

Provides 1 arguments, expects 1 (or zero) return values

post_clear_entities

Provides 0 arguments, expects 0 return values