EngineInterface

This class exposes most of the functions used to access assets, evaluate GML code, etc.

ResourceIdByName

Converts the name of a resource into its ID.

Name	Type	Description
`name`	`string`	The name of the resource. (e.g. `obj_player`)

Type	Description
`int`	The resource ID.

local engine = API.GetEngine()
local res_id = engine:ResourceIdByName("obj_player")

Gets an object reference from its ID.

Name	Type	Description
`id`	`int`	The ID of the object.

Type	Description
`ObjectInterface`	The object reference.

local engine = API.GetEngine()
local obj = engine:GetObjectById(0)

Gets an object reference from its name.

Name	Type	Description
`name`	`string`	The name of the object.

Type	Description
`ObjectInterface`	The object reference.

local engine = API.GetEngine()
local obj = engine:GetObjectByName("obj_player")

Evaluates GML code using the built-in GML interpreter.

Name	Type	Description
`code`	`string`	The code to evaluate.

local engine = API.GetEngine()
engine:Eval([[var msg = "Hello from GML!";
show_message(msg);
game_end();]])

Last modified: 29 March 2025