From 81af32e4cfe6e0fa868ce9421100bcc8f123f124 Mon Sep 17 00:00:00 2001 From: Rokas Puzonas Date: Sun, 1 May 2022 15:48:06 +0300 Subject: [PATCH] feat: manually add callback definitions --- config/library/index.lua | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 config/library/index.lua diff --git a/config/library/index.lua b/config/library/index.lua new file mode 100644 index 0000000..1ea58af --- /dev/null +++ b/config/library/index.lua @@ -0,0 +1,22 @@ +---@meta + +--- +---The **TIC** function is the 'main' update/draw callback and **must** be present in every program. It takes no parameters and is called sixty times per second (60fps). +--- +function TIC() end + +--- +---The **BOOT** function is called a single time when your cartridge is booted. It should be used for startup/initialization code. For scripting languages that allow code in the global scope (Lua, etc.) using `BOOT` is preferred rather than including source code in the global scope. +--- +function BOOT() end + +--- +---The **BDR** callback allows you to execute code _between_ the rendering of each scan line. The primary reason to do this is to manipulate the `palette`. Doing so makes it possible to use a different palette for each scan line, and therefore `more than 16 colors at a time`. +--- +---@param scanline number # The scan line about to be drawn (0..143) +function BDR(scanline) end + +--- +---The **OVR** callback is the final step in rendering a frame. It draws on a separate layer and can be used together with `BDR` to create separate background or foreground layers and other visual effects. +--- +function OVR() end