User Tools

Site Tools


This is an old revision of the document!


The Console Library

With the functions in the Console library you can output text on the Cafu in-game console.

Prints the string s to the Cafu in-game console.

Parameters:

Name Type Description
s string The message to be printed to the in-game console.

Returns:

Nothing (nil).

Example:

    Console.Print("Hello!\n");   -- Prints "Hello" to the in-game console.

DevPrint(s)

Prints a developer message to the in-game console.

If the “developer” console variable is set, this prints the string s, prepended by “[Dev] ”, to the Cafu in-game console. If the “developer” console variable is not set, nothing is printed.

Parameters:

Name Type Description
s string The developer message to be printed to the in-game console.

Returns:

Nothing (nil).

Example:

    Console.DevPrint("Hello!\n");   -- Prints "[Dev] Hello" to the in-game console (in developer mode).

Warning(s)

Prints a warning to the Cafu in-game console. This is the same as function Print(s), except that the text “Warning: ” is automatically prepended to the output.

Parameters:

Name Type Description
s string The warning to be printed to the in-game console.

Returns:

Nothing (nil).

Example:

    Console.Warning("Problem here!\n");   -- Prints "Warning: Problem here!" to the in-game console.
    Console.Print  ("Warning: ".."Problem here!\n");   -- Same result as above.

DevWarning(s)

Prints a developer warning to the in-game console.

If the “developer” console variable is set, this prints the string s, prepended by “[Dev] Warning: ”, to the Cafu in-game console. If the “developer” console variable is not set, nothing is printed.

Parameters:

Name Type Description
s string The developer warning to be printed to the in-game console.

Returns:

Nothing (nil).

Example:

    Console.DevWarning("Problem here!\n");   -- Prints "[Dev] Warning: Problem here!" to the in-game console
                                             -- (in developer mode).
scripting/console.1246707620.txt.gz · Last modified: 2013-01-07 12:07 (external edit)