diff options
Diffstat (limited to 'help/rest/text.txt')
| -rw-r--r-- | help/rest/text.txt | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/help/rest/text.txt b/help/rest/text.txt new file mode 100644 index 0000000..edabde4 --- /dev/null +++ b/help/rest/text.txt @@ -0,0 +1,28 @@ +.. _text: + +.. index:: + pair: menu item; Display text + pair: command line option; text + pair: command; text + +Display text +============ + +**Syntax**:(text string) + +Display the given text on the screen. This function is mainly useful in tutorials. +Text should be cleared by printing lots of spaces, or using the +:ref:`clearscreen` or :ref:`display` functions. You might also want to use the +:ref:`textposition` function to select the part of the screen to display the text on. + +To wait for the user to read the text, you can use the :ref:`textsleep` function. + +Example:: + + (clearscreen) + (textposition 'center 'middle) + (text "Welcome into my animation") + (textsleep) + (display) + +**Available as**: menu item, command line option, command
\ No newline at end of file |