Skip to content

Scene

Generated

This page is auto-generated from psxsplash-main/src/luaapi.hh by scripts/py/gen_lua_api_docs.py. Edits won't survive the next build — fix the source comments instead.

3 entries, 2 with worked examples mined from godot-ps1/demo/scripts/ and the bundled templates.

Methods

Scene.Load(sceneIndex)

Requests a scene transition to the given index (0-based). The actual load happens at the end of the current frame.

Example

Scene.Load(1)

Source: godot-ps1/demo/scripts/intro_splash.lua line 35.

Scene.GetIndex() -> number

Returns the index of the currently loaded scene.

Scene.PauseFor(frames) -> nil

Hit-stop / freeze. Holds gameplay tick (animation, cutscene, skin, collision, Lua onUpdate, controls, player movement) for frames frames while keeping render + camera shake + music alive. Souls / Hades-style impact crunch. Stacks via max(remaining, requested).

Example

Scene.PauseFor(4)

Source: godot-ps1/demo/scripts/boss_smoke_brain.lua line 83.