Skip to content

Message functions

cancel_speechbubble

source

function cancel_speechbubble()

Hide the speech bubble currently on screen, if any, by expiring its timer.

cancel_toast

source

function cancel_toast()

Hide the toast message currently on screen, if any, by expiring its timer.

console_prinspect

source

function console_prinspect(...: any)
...: any

Prinspect to in-game console.

console_print

source

function console_print(message: string)
message: string

Print a log message to in-game console with a comment identifying the script that sent it.

log_print

source

function log_print(message: string)
message: string

Log to spelunky.log

lua_print

same as printsource

function lua_print(message: string)
message: string

Standard lua print function, prints directly to the terminal but not to the game

message

source

function message(message: string)
message: string

Same as print

messpect

source

function messpect(...: any)
...: any

Same as prinspect

prinspect

source

prinspect(state.level, state.level_next)
local some_stuff_in_a_table = {
some = state.time_total,
stuff = state.world
}
prinspect(some_stuff_in_a_table)
function prinspect(...: any)
...: any

Prints any type of object by first funneling it through inspect, no need for a manual tostring or inspect.

print

source

function print(message: string)
message: string

Print a log message on screen.

printf

written in Luasource

Short for print(string.format(...))

say

source

function say(entity_uid: integer, message: string, sound_type: integer, top: boolean)
entity_uid: integer
message: string
sound_type: integer
top: boolean

Show a message coming from an entity

speechbubble_visible

source

function speechbubble_visible(): boolean

Returns boolean

Returns true while a speech bubble is on screen.

toast

source

function toast(message: string)
message: string

Show a message that looks like a level feeling.

toast_visible

source

function toast_visible(): boolean

Returns boolean

Returns true while a toast message is on screen.