Skip to main content

LuaAPI

Overview

The inZOI Lua API exposes the game's simulation and presentation types to Lua mods. Each type has its own page listing its properties, callable functions, and override points (hooks you can implement in Lua).

Types are grouped by environment. B2 (Simulation) is the primary modding surface and where override hooks live; B1 (Presentation) covers UI / FX / camera; Common / Engine are shared and Unreal types. Lua mods run on the B2 thread.

Environments

EnvironmentTypes
B2 - Simulation804
B1 - Presentation5642
Common / Engine73
Total6519

Using the API

Reference a type and override one of its hooks from a Lua mod:

-- Override a B2 action timing hook
FB2Action_Eat.Override_OnPlay = function(self)
-- custom behavior
end