MKlegoman357: Updated/Improved

2015-02-16T21:03:58Z

Updated/Improved

Bomb Bloke: Created page with "{{lowercase}} {{Function |name=textutils.pagedPrint |args= string text [, number freeLines] |returns=The number of lines printed. |api=text..."

2014-02-22T13:11:10Z

Created page with "{{lowercase}} {{Function |name=textutils.pagedPrint |args= string text [, number freeLines] |returns=The number of lines printed. |api=text..."

New page

{{lowercase}}
{{Function
|name=textutils.pagedPrint
|args= [[string (type)|string]] text [, [[number (type)|number]] freeLines]
|returns=The number of lines printed.
|api=textutils
|addon=ComputerCraft
|desc=Prints a given string to the display. If the action can be completed without scrolling, it acts much the same as [[print|print()]]; otherwise, it will throw up a "Press any key to continue" prompt at the bottom of the display. Each press will cause it to scroll down and write a single line more before prompting again, if need be.<br><br>

If ''freeLines'' is specified, then that amount of lines will be auto-scrolled before the first prompt appears (generally meaning the initial amount of lines printed at least equals ''freeLines'' + 1). Each press after this point will still only scroll a single line, however. If not specified, the function will not scroll at all without prompting.
|examples=
{{Example
|desc=Prints a lengthy string (thirty copies of a sentence generated with [http://lua-users.org/wiki/StringLibraryTutorial string.rep()]), prompting the user to continue if any scrolling is required past the first ten lines.
|code=textutils.pagedPrint(string.rep("This is a rather verbose dose of repetition. ",30), 9)
|output="This is a rather verbose dose of repetition. This is a rather verbose dose of repetition. This is a rather verbose dose of repetition. "...etc printed to the display, with a "Press any key to continue" prompt if scrolling is required after at least ten lines have been written.
}}
}}

[[Category:API_Functions]]

@@ Line 2: / Line 2: @@
 {{Function
 |name=textutils.pagedPrint
-|args= [[string (type)|string]] text [, [[number (type)|number]] freeLines]
+|args={{type|string}} text [, {{type|number}} freeLines]
-|returns=The number of lines printed.
+|returns={{type|number}} linesPrinted
 |api=textutils
 |addon=ComputerCraft
-|desc=Prints a given string to the display. If the action can be completed without scrolling, it acts much the same as [[print|print()]]; otherwise, it will throw up a "Press any key to continue" prompt at the bottom of the display. Each press will cause it to scroll down and write a single line more before prompting again, if need be.<br><br>
+|desc=Prints a given string to the display. If the action can be completed without scrolling, it acts much the same as [[print]](); otherwise, it will throw up a "Press any key to continue" prompt at the bottom of the display. Each press will cause it to scroll down and write a single line more before prompting again, if need be.<br><br>
-If ''freeLines'' is specified, then that amount of lines will be auto-scrolled before the first prompt appears (generally meaning the initial amount of lines printed at least equals ''freeLines'' + 1). Each press after this point will still only scroll a single line, however. If not specified, the function will not scroll at all without prompting.
+If <var>freeLines</var> is specified, then that amount of lines will be auto-scrolled before the first prompt appears (generally meaning the initial amount of lines printed at least equals <var>freeLines + 1</var>). Each press after this point will still only scroll a single line, however. If not specified, the function will not scroll at all without prompting. Default value for <var>freeLines</var> is <var>0</var>.
 |examples=
 {{Example
 |desc=Prints a lengthy string (thirty copies of a sentence generated with [http://lua-users.org/wiki/StringLibraryTutorial string.rep()]), prompting the user to continue if any scrolling is required past the first ten lines.
-|code=textutils.pagedPrint(string.rep("This is a rather verbose dose of repetition. ",30), 9)
+|code='''textutils.pagedPrint( [[string_(API)|string.rep]]( "This is a rather verbose dose of repetition. ", 30 ), 9 )'''
 |output="This is a rather verbose dose of repetition. This is a rather verbose dose of repetition. This is a rather verbose dose of repetition. "...etc printed to the display, with a "Press any key to continue" prompt if scrolling is required after at least ten lines have been written.
 }}

Textutils.pagedPrint - Revision history

MKlegoman357: Updated/Improved

Bomb Bloke: Created page with "{{lowercase}} {{Function |name=textutils.pagedPrint |args= string text [, number freeLines] |returns=The number of lines printed. |api=text..."