LumixEngine

Engine API

The API can be found in lumix.d.lua.

Safety

Lua API is almost as unsafe as C++ API and most calls are not not checked. It means that calling method on invalid objects or accessing properties on those objects can crash or overwrite random memory.

	local e = getSomeEntity()
	...
	e.position = { 1, 2, 3 } -- this is invalid if `e` is destroyed 

Entity

declare class Entity 
	world : World
	name : string
	parent : Entity?
	rotation : any
	position : Vec3
	scale : Vec3
	hasComponent : (Entity, any) -> boolean
	getComponent : (Entity, any) -> any
	destroy : (Entity) -> ()
	createComponent : (Entity, any) -> any

	-- all components

end

this

When inside an entity’s script, the this variable can be used to access the current entity:

this.position = { 1, 2, 3 }

Components

Each component is automatically exposed as a member of Entity:

this.gui_rect.enabled = false

Component methods are also available:

local speed_input_idx = this.animator:getInputIndex("speed_y")

To add a new item to an array property, use the add method:

this.lua_script.scripts:add()

Environments of other entities can be accessed through Entity.lua_script[index]:

-- entityA.lua
some_prop = 1

-- entityB.lua
local entityA = getEntityA()
local env = entityA.lua_script[1]
env.some_prop = 2

World

declare class World
	getActivePartition : (World) -> number
	setActivePartition : (World, number) -> ()
	createPartition : (World, string) -> number
	load : (World, string, any) -> ()
	getModule : (string) -> any,
	createEntity : () -> Entity,
	createEntityEx : (any) -> Entity,
	findEntityByName : (string) -> Entity?

	... all modules
end

World can be accessed through Entity. Each module is automatically exposed in World.

local gui = this.world:getModule("gui")

local new_entity = this.world:createEntity()
new_entity.position = { 10, 10, 10 }

Logging

declare LumixAPI: {
	logError : (string) -> (),
	logInfo : (string) -> (),
}

LumixAPI.logError("Hello world")

This site is open source. Improve this page.