ShowTutorial
A tutorial box with a text that stays a while.
The game’s own tutorial box - the framed panel that explains a mechanic - with your text, for ms milliseconds or
until HideTutorial takes it down by its id. A second call with the same id replaces the text. Good for rules,
a countdown with a hint, or anything a player should read at leisure; the party invitation is one of these.
Syntax
Section titled “Syntax”ShowTutorial(pid, id, text [, ms])| Parameter | Type | |
|---|---|---|
pid |
number | the player (-1 = everyone) |
id |
string | a name of your own for the box, to hide it later |
text |
string | the text (a newline starts a new line) |
ms |
number | how long it stays, milliseconds (8000; up to 60000) (optional) |
Returns
Section titled “Returns”boolean
Example
Section titled “Example”ShowTutorial(pid, "arena_rules", "No horses in the ring.\nThe first to three wins.", 10000)See also
Section titled “See also”ShowTutorialForAll · HideTutorial · the GameText and HUD group of the index