New since the November 2025 update: system.setConfig("key", value) and system.getConfig("key") read and write configuration values directly in the game.

⌛particleSystem

particleSystem

Methods

new(settings)
draw()
update()
updateDraw()

Fields

images table
emissionDirection table
visibility table
velocityOverLife table
angularVelocityOverLife table
motionRandomnessOverLife table
sizeOverLife table
spinOverLife table
weightOverLife table
velocity table
velocityOverLife table
weight table
life table
size table
rotation table
angularVelocity table
motionRandomness table
spin table
numberOfEmitted table
visibilityOverLife table
colorOverLife table
center table

directionToRotation bool

imageChoice int
creationRate int
maximum int
warmup int
length float
angle float
radius float
innerRadius float
sizeX float
sizeY float
loops int
duration float
directionToRotationOffset float

imageChoice string
transferMode string

new(settings)

Parameter Type Description
settings table

draw()

update()

updateDraw()

⌛system

system

Methods

getDisplayModes()
controllerGuid(device)
controllerName(device)
controllerCount()
joystickCount()
joystickIsController(id)
pauseCurrentActions()
resumeAllActions()
pauseCurrentAnimations()
resumeAllAnimations()
pauseBackgroundMusic()
pauseAllSounds()
resumeBackgroundMusic()
resumeAllSounds()
systemInfo()
skipText()
skipCutscene()
registerActionPartHook(actionPartCommand, hook)

Fields

vramUsed readonly
memoryUsed readonly
lastFrameTime readonly
frameTime readonly
cacheContents readonly
savegamesCount readonly
selectedSavegame readonly
savegamesScrollPos readonly

pauseOnFocusLost bool
pauseMainLoops bool
pauseEngineUpdate bool

getDisplayModes()

Return Type Description
table {1="1920x1080",...}

controllerGuid(device)

Parameter Type Description
device int
Return Type Description
string guid

controllerName(device)

Parameter Type Description
device int
Return Type Description
string joystickName
string gamecontrollerName

controllerCount()

Return Type Description
int maxid

joystickCount()

Return Type Description
int joystick count

joystickIsController(id)

Parameter Type Description
id int
Return Type Description
bool

pauseCurrentActions()

resumeAllActions()

pauseCurrentAnimations()

resumeAllAnimations()

pauseBackgroundMusic()

pauseAllSounds()

resumeBackgroundMusic()

resumeAllSounds()

systemInfo()

Return Type Description
table infos

skipText()

skipCutscene()

registerActionPartHook(actionPartCommand, hook)

local ADD_REMOVE_ITEM = 150
system.registerActionPartHook(ADD_REMOVE_ITEM, "addRemoveItem")

function addRemoveItem(actionPart)
  if actionPart.Int == 0 then
    -- added
  elseif actionPart.Int == 1 then
    -- removed
  end
  local evt = {}
  evt.item      = actionPart.Link
  evt.character = actionPart.AltLink
  -- now do something
  return true -- don't execute
  --return false // still execute
end

Parameter Type Description
actionPartCommand int
hook string