Skip to content

log


add

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

Creates and displays a log entry under the provided key
Example Usage
log.add("123", "This is an example '123' log entry")

Note

The key must exist before calling


add_info

void log.add_info(...)

Creates and displays a log entry under the 'Inf' key
Example Usage
log.add_info("This is an example 'Inf' log entry")

Note

The 'Inf' key will be created internally if nonexistent


add_error

void log.add_error(...)

Creates and displays a log entry under the 'Err' key
Example Usage
log.add_error("This is an example 'Err' log entry")

Note

The 'Err' key will be created internally if nonexistent


add_warning

void log.add_warning(...)

Creates and displays a log entry under the 'Wrn' key
Example Usage
log.add_warning("This is an example 'Wrn' log entry")

Note

The 'Wrn' key will be created internally if nonexistent


add_success

void log.add_success(...)

Creates and displays a log entry under the 'Suc' key
Example Usage
log.add_success("This is an example 'Suc' log entry")

Note

The 'Suc' key will be created internally if nonexistent


new_key

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

Creates a new key with the provided parameters
Example Usage
log.new_key("123", 1.0, 1.0, 1.0, true)

has_key

bool log.has_key(string key)

Returns true if the key exists
Example Usage
local exists = log.has_key("123")

clear_key

void log.clear_key(string key)

Clears all log entries under the provided key
Example Usage
log.clear_key("123")

delete_key

void log.delete_key(string key)

Clears all log entries under the provided key and disposes of it
Example Usage
log.delete_key("123")

set_key_colour

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

Sets the colour of the provided key
Example Usage
log.set_key_colour("123", 1.0, 1.0, 1.0)

get_key_colour

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

Gets the colour of the provided key
Example Usage
local r, g, b = log.get_key_colour("123")

set_key_visibility

void log.set_key_visibility(string key, bool visible)

Sets the visibility of the provided key
Example Usage
log.set_key_visibility("123", true)

get_key_visibility

bool log.get_key_visibility(string key)

Gets the visibility of the provided key
Example Usage
local visible = log.get_key_visibility("123")