Difference between revisions of "Textutils (API)"

From ComputerCraft Wiki
Jump to: navigation, search
m (Changed to use type template)
(Made function descriptions a little more informative and beginner-friendly. Users shouldn't have to visit individual pages to understand what any function does.)
Line 9: Line 9:
  
 
<tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Method Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>
 
<tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Method Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>
 +
 +
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.slowWrite]]({{type|string}} text, {{type|int}} rate)</td>
 +
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">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).</td></tr>
  
 
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.slowPrint]]({{type|string}} text, {{type|int}} rate)</td>
 
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.slowPrint]]({{type|string}} text, {{type|int}} rate)</td>
−
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Slowly prints the text. Only difference is, it leaves a new-line after it.</td></tr>
+
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">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.</td></tr>
−
 
+
−
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.slowWrite]]({{type|string}} text, {{type|int}} rate)</td>
+
−
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Slowly writes the text.</td></tr>
+
  
 
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.formatTime]]({{type|int}} time, {{type|boolean}} TwentyFourHour)</td>
 
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.formatTime]]({{type|int}} time, {{type|boolean}} TwentyFourHour)</td>
−
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Put a time into it, and it spews it out in a different format. Example: print(textutils.formatTime(os.time(), false))</td></tr>
+
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">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.</td></tr>
  
 
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.tabulate]]({{type|table}} table, {{type|table}} table2, ...)</td>
 
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.tabulate]]({{type|table}} table, {{type|table}} table2, ...)</td>
−
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Prints tables in an ordered form. Each table is a row, the column(s)' width is auto-adjusted.</td></tr>
+
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Prints tables in an ordered form. Each table is a row, the column width is auto-adjusted.</td></tr>
  
 
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.pagedTabulate]]({{type|table}} table, {{type|table}} table2, ...)</td>
 
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.pagedTabulate]]({{type|table}} table, {{type|table}} table2, ...)</td>
−
<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>
+
<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>
−
<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: #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>
Line 32: Line 31:
  
 
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.unserialize]]({{type|string}} text)</td>
 
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.unserialize]]({{type|string}} text)</td>
−
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns a table reassembled from the string ''text''.</td></tr>
+
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns a table reassembled from string ''text''.</td></tr>
  
 
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.urlEncode]]({{type|string}} text)</td>
 
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.urlEncode]]({{type|string}} text)</td>
 
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">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: [http://www.blooberry.com/indexdot/html/topics/urlencoding.htm].</td></tr>
 
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">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: [http://www.blooberry.com/indexdot/html/topics/urlencoding.htm].</td></tr>
 
</table>
 
</table>
−
 
  
 
[[Category:APIs]]
 
[[Category:APIs]]

Revision as of 09:55, 5 May 2013

This page needs some serious TLC, stat!
Please help us by cleaning it, fixing it up, or sparing it some love.
(Reason: Needs 5 3 function pages, 1 function descriptions. AfterLifeLochie 02:40, 29 November 2012 (MSK))

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

Grid disk.png   Textutils (API)

Method NameDescription
textutils.slowWrite(string text, int 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, int 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(int 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, string confirmation_lines)Prints string text onto the screen, but waits for confirmation before scrolling down.
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].
Retrieved from "https://www.computercraft.info/wiki/index.php?title=Textutils_(API)&oldid=5577"