Global Lua Namespace

Globals

Functions:

  • class
  • dofile
  • enumType
  • print
  • type

  • class(base?)

    Creates a new class object.

    Parameters:

    TypeNameDescription
    tablebase?An optional base class to inherit from. (Defaults to inheriting from no class)

    Returns:

    TypeDescription
    tableClass table.

    dofile(filename)

    Opens the named file and executes its contents as a Lua chunk. In case of errors, dofile propagates the error to its caller.

    Parameters:

    TypeNameDescription
    stringfilenameThe name of the file to be loaded.

    enumType(object)

    Returns the type of an object as an enum integer. This includes standard Lua types and userdata types specific to this API.

    Parameters:

    TypeNameDescription
    anyobjectThe object instance.

    Returns:

    TypeDescription
    integerThe object type.

    print(...)

    Prints data to the console. This is useful for debugging.

    Note:

    If the game is running with the `-dev` flag, any output will be added to the game logs.

    Parameters:

    TypeNameDescription
    any...The arguments to be printed.

    type(object)

    Returns the type of an object as a string. This includes standard Lua types and userdata types specific to this API.

    Parameters:

    TypeNameDescription
    anyobjectThe object instance.

    Returns:

    TypeDescription
    stringThe object type.