util Module

The util global module provides common utility functions for scripts.

Logging Functions

LogInfo(message)

Definition

util.LogInfo(message)

Writes an informational message to the log.

Parameters:: message (string) – Message to write to the log.

Example

Logging using the util.LogInfo(message) function.

util.LogInfo("Hello World!")

LogWarn(message)

Definition

util.LogWarn(message)

Writes a warning message to the log.

Parameters:: message (string) – Message to write to the log.

Example

Logging using the util.LogWarn(message) function.

util.LogWarn("Hello World!")

LogError(message)

Definition

util.LogError(message)

Writes an error message to the log.

Parameters:: message (string) – Message to write to the log.

Example

Logging using the util.LogError(message) function.

util.LogError("Hello World!")

LogCrit(message)

Definition

util.LogCrit(message)

Writes a critical/fatal error message to the log.

Parameters:: message (string) – Message to write to the log.

Example

Logging using the util.LogCrit(message) function.

util.LogCrit("Hello World!")

LogDebug(message)

Definition

util.LogDebug(message)

Writes a debug message to the log.

Parameters:: message (string) – Message to write to the log.

Example

Logging using the util.LogDebug(message) function.

util.LogDebug("Hello World!")

LogTrace(message)

Definition

util.LogTrace(message)

Writes a trace debug message to the log.

Parameters:: message (string) – Message to write to the log.

Example

Logging using the util.LogTrace(message) function.

util.LogTrace("Hello World!")

ToBool(value)

Definition

util.ToBool(value)

Tries to convert the given string to a boolean.

Parameters:: value (string) – String to convert to boolean.
Returns:: Converted boolean value, or nil if not convertible.
Return type:: boolean

Example

Converting a string to boolean using the util.ToBool(value) function.

util.ToBool("True")          -- returns true
util.ToBool("False")         -- returns false
util.ToBool("Hello World!")  -- returns nil