Namespaces

log

Methods

Creates and displays a log entry under the provided key

function log.add(key: string, ...): void

-- example usage
log.add("123", "This is an example '123' log entry")

The key must exist before calling

Creates and displays a log entry under the Inf key

function log.add_info(...): void

-- example usage
log.add_info("This is an example 'Inf' log entry")

The Inf key will be created internally if nonexistent

Creates and displays a log entry under the Err key

function log.add_error(...): void

-- example usage
log.add_error("This is an example 'Err' log entry")

The Err key will be created internally if nonexistent

Creates and displays a log entry under the Wrn key

function log.add_warning(...): void

-- example usage
log.add_warning("This is an example 'Wrn' log entry")

The Wrn key will be created internally if nonexistent

Creates and displays a log entry under the Suc key

function log.add_success(...): void

-- example usage
log.add_success("This is an example 'Suc' log entry")

The Suc key will be created internally if nonexistent

Creates a new key with the provided parameters

function log.new_key(key: string, red: float, green: float, blue: float, visible: bool): void

-- example usage
log.new_key("123", 1.0, 1.0, 1.0, true)

Returns true if the key exists

function log.has_key(key: string): bool

-- example usage
local exists = log.has_key("123")

Clears all log entries under the provided key

function log.clear_key(key: string): void

-- example usage
log.clear_key("123")

Clears all log entries under the provided key and disposes of it

function log.delete_key(key: string): void

-- example usage
log.delete_key("123")

Sets the colour of the provided key

function log.set_key_colour(key: string, red: float, green: float, blue: float): void

-- example usage
log.set_key_colour("123", 1.0, 1.0, 1.0)

Gets the colour of the provided key

function log.get_key_colour(key: string): float, float, float

-- example usage
local r, g, b = log.get_key_colour("123")

Sets the visibility of the provided key

function log.set_key_visibility(key: string, visible: bool): void

-- example usage
log.set_key_visibility("123", true)

Gets the visibility of the provided key

function log.get_key_visibility(key: string): bool

-- example usage
local visible = log.get_key_visibility("123")

hash

memory