mirror of
https://github.com/SquidDev-CC/CC-Tweaked
synced 2024-10-06 02:40:45 +00:00
ef8da8054f
This adds documentation comments to many of CC's Lua APIs, and a couple of the Java ones, through the use of stubs. We then export these to HTML using illuaminate [1] and upload them to our documentation site [2]. Uploads currently occur on pushes to master and any release/tag. The site is entirely static - there is no way to switch between versions, etc... but hopefully we can improve this in the future. [1]: github.com/SquidDev/illuaminate/ [2]: https://tweaked.cc/
53 lines
1.7 KiB
Lua
53 lines
1.7 KiB
Lua
function write(text) end
|
|
function scroll(lines) end
|
|
function setCursorPos(x, y) end
|
|
function setCursorBlink(blink) end
|
|
function getCursorPos() end
|
|
function getSize() end
|
|
function clear() end
|
|
function clearLine() end
|
|
function setTextColour(colour) end
|
|
setTextColor = setTextColour
|
|
function setBackgroundColour(colour) end
|
|
setBackgroundColor = setBackgroundColour
|
|
function isColour() end
|
|
isColor = isColour
|
|
function getTextColour() end
|
|
getTextColor = getTextColor
|
|
function getBackgroundColour() end
|
|
getBackgroundColour = getBackgroundColour
|
|
function blit(text, text_colours, background_colours) end
|
|
function setPaletteColour(colour, ...) end
|
|
setPaletteColour = setPaletteColour
|
|
function getPaletteColour(colour, ...) end
|
|
getPaletteColour = getPaletteColour
|
|
function nativePaletteColour(colour) end
|
|
nativePaletteColour = nativePaletteColour
|
|
|
|
--- @type Redirect
|
|
local Redirect = {}
|
|
|
|
Redirect.write = write
|
|
Redirect.scroll = scroll
|
|
Redirect.setCursorPos = setCursorPos
|
|
Redirect.setCursorBlink = setCursorBlink
|
|
Redirect.getCursorPos = getCursorPos
|
|
Redirect.getSize = getSize
|
|
Redirect.clear = clear
|
|
Redirect.clearLine = clearLine
|
|
Redirect.setTextColour = setTextColour
|
|
Redirect.setTextColor = setTextColor
|
|
Redirect.setBackgroundColour = setBackgroundColour
|
|
Redirect.setBackgroundColor = setBackgroundColor
|
|
Redirect.isColour = isColour
|
|
Redirect.isColor = isColor
|
|
Redirect.getTextColour = getTextColour
|
|
Redirect.getTextColor = getTextColor
|
|
Redirect.getBackgroundColour = getBackgroundColour
|
|
Redirect.getBackgroundColor = getBackgroundColor
|
|
Redirect.blit = blit
|
|
Redirect.setPaletteColour = setPaletteColour
|
|
Redirect.setPaletteColor = setPaletteColor
|
|
Redirect.getPaletteColour = getPaletteColour
|
|
Redirect.getPaletteColor = getPaletteColor
|