This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
scripting:console [2009-07-04 13:40] 127.0.0.1 external edit |
— (current) | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== The Console Library ====== | ||
- | |||
- | With the functions in the ''Console'' library you can output text on the Cafu in-game console. | ||
- | |||
- | |||
- | ===== Print(s) ===== | ||
- | |||
- | 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: === | ||
- | <code lua> | ||
- | Console.Print("Hello!\n"); -- Prints "Hello" to the in-game console. | ||
- | </code> | ||
- | |||
- | |||
- | ===== 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: === | ||
- | <code lua> | ||
- | Console.DevPrint("Hello!\n"); -- Prints "[Dev] Hello" to the in-game console (in developer mode). | ||
- | </code> | ||
- | |||
- | |||
- | ===== 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: === | ||
- | <code lua> | ||
- | Console.Warning("Problem here!\n"); -- Prints "Warning: Problem here!" to the in-game console. | ||
- | Console.Print ("Warning: ".."Problem here!\n"); -- Same result as above. | ||
- | </code> | ||
- | |||
- | |||
- | ===== 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: === | ||
- | <code lua> | ||
- | Console.DevWarning("Problem here!\n"); -- Prints "[Dev] Warning: Problem here!" to the in-game console | ||
- | -- (in developer mode). | ||
- | </code> | ||