Difference between revisions of "Textutils (API)"

From ComputerCraft Wiki
Jump to: navigation, search
(Added description for pagedTabulate)
m (Whoops, fixed grammar and spelling)
Line 23: Line 23:
  
 
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.pagedTabulate]]([[table (type)|table]] table, [[table (type)|table]] table2, ...)</td>
 
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.pagedTabulate]]([[table (type)|table]] 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 conformation 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]]([[string (type)|string]] text, [[string (type)|string]] confirmation_lines)</td>
 
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.pagedPrint]]([[string (type)|string]] text, [[string (type)|string]] confirmation_lines)</td>

Revision as of 01:31, 13 April 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.slowPrint(string text, int rate) Slowly prints the text. Only difference is, it leaves a new-line after it.
textutils.slowWrite(string text, int rate) Slowly writes the text.
textutils.formatTime(int time, bool TwentyFourHour) Put a time into it, and it spews it out in a different format. Example: print(textutils.formatTime(os.time(), false))
textutils.tabulate(table table, table table2, ...) Prints tables in an ordered form. Each table is a row, the column(s)' 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 the 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].