Difference between revisions of "Textutils (API)"

From ComputerCraft Wiki
Jump to: navigation, search
(Changing int to number)
m (Corrected description of textutils.pagedPrint(), removed "needs work" template.)
Line 1: Line 1:
{{NeedsWork|Needs <s>5</s> <s>3</s> 2 function pages<s>, 1 function descriptions</s>. ''[[User:AfterLifeLochie|AfterLifeLochie]] 02:40, 29 November 2012 (MSK)''}}
 
 
The Textutils API is used to format and manipulate strings easily.
 
The Textutils API is used to format and manipulate strings easily.
  
Line 25: Line 24:
 
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Prints tables in an ordered form, like [[textutils.tabulate]]. However, it waits for confirmation before scrolling down.</td></tr>
 
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Prints tables in an ordered form, like [[textutils.tabulate]]. However, it waits for confirmation before scrolling down.</td></tr>
  
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.pagedPrint]]({{type|string}} text, {{type|string}} confirmation_lines)</td><td style="border-top: solid #C9C9C9 1px; padding: .4em;">Prints string ''text'' onto the screen, but waits for confirmation before scrolling down.</td></tr>
+
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.pagedPrint]]({{type|string}} text [, {{type|number}} freeLines])</td><td style="border-top: solid #C9C9C9 1px; padding: .4em;">Prints string ''text'' onto the screen, but waits for confirmation (after at least ''freeLines'' have been printed) before scrolling down further.</td></tr>
  
 
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.serialize]]({{type|table}} table)</td>
 
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.serialize]]({{type|table}} table)</td>

Revision as of 13:12, 22 February 2014

The Textutils API is used to format and manipulate strings easily.

Grid disk.png   Textutils (API)

Method NameDescription
textutils.slowWrite(string text, number rate) Writes string text at current cursor position, character-by-character. Number argument rate is optional and is defaulted to 20. The higher the value of rate, the faster text is written (passing a value of 1 writes one character per second).
textutils.slowPrint(string text, number rate) Prints string text at current cursor position, character-by-character. Number argument rate is optional and is defaulted to 20. The higher the value of rate, the faster text is printed (passing a value of 1 prints one character per second). This function also prints a newline.
textutils.formatTime(number time, boolean TwentyFourHour) Takes input time and formats it in a more readable format. If second value is true, returns time in military time; if second value is false, returns time with AM or PM. Example: print(textutils.formatTime(os.time(), false))—os.time() returns MineCraft time.
textutils.tabulate(table table, table table2, ...) Prints tables in an ordered form. Each table is a row, the column width is auto-adjusted.
textutils.pagedTabulate(table table, table table2, ...) Prints tables in an ordered form, like textutils.tabulate. However, it waits for confirmation before scrolling down.
textutils.pagedPrint(string text [, number freeLines])Prints string text onto the screen, but waits for confirmation (after at least freeLines have been printed) before scrolling down further.
textutils.serialize(table table) Returns a string representation of the table table for storage or transmission.
textutils.unserialize(string text) Returns a table reassembled from string text.
textutils.urlEncode(string text) Makes a string safe to encode into a url. Spaces are replaced with +s. Unsafe characters such as '\', '£' and '}' are translated into ASCII code and preceded with a % for transmission. For reference visit: [1].