Built-ins API documentation

Version: alpha

Built-in scripting functions.

FUNCTION
hash()

hashes a string
hash_to_hex()

get hex representation of a hash value as a string
pprint()

pretty printing

Functions

hash()

hash(s)

All ids in the engine are represented as hashes, so a string needs to be hashed before it can be compared with an id.

PARAMETERS

s

string string to hash

RETURNS

hash

hash a hashed string

EXAMPLES

To compare a message_id in an on-message callback function:

function on_message(self, message_id, message, sender)
    if message_id == hash("my_message") then
        -- Act on the message here
    end
end

hash_to_hex()

hash_to_hex(h)

Returns a hexadecimal representation of a hash value. The returned string is always padded with leading zeros.

PARAMETERS

h

hash hash value to get hex string for

RETURNS

hex

string hex representation of the hash

EXAMPLES

local h = hash("my_hash")
local hexstr = hash_to_hex(h)
print(hexstr) --> a2bc06d97f580aab

pprint()

pprint(v)

Pretty printing of Lua values. This function prints Lua values in a manner similar to +print()+, but will also recurse into tables and pretty print them. There is a limit to how deep the function will recurse.

PARAMETERS

v

any value to print

EXAMPLES

Pretty printing a Lua table with a nested table:

local t2 = { 1, 2, 3, 4 }
local t = { key = "value", key2 = 1234, key3 = t2 }
pprint(t)

Resulting in the following output (note that the key order in non array Lua tables is undefined):

{
  key3 = {
    1 = 1,
    2 = 2,
    3 = 3,
    4 = 4,
  }
  key2 = 1234,
  key = value,
}