Web   ·   Wiki   ·   Activities   ·   Blog   ·   Lists   ·   Chat   ·   Meeting   ·   Bugs   ·   Git   ·   Translate   ·   Archive   ·   People   ·   Donate
summaryrefslogtreecommitdiffstats
path: root/help/rest/text.txt
blob: edabde48cd08755bda79e2c848399e81684fc1aa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
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