Textutils (API) - Revision history

Bomb Bloke: New CC 1.76 parameter for textutils.serializeJSON()

2015-12-26T02:07:55Z

New CC 1.76 parameter for textutils.serializeJSON()

Bomb Bloke: textutils.complete()

2015-07-19T11:00:11Z

textutils.complete()

MKlegoman357: Reformatted table with {{API Table}} Template. Fixed parameters, return values, descriptions.

2015-02-16T20:20:22Z

Reformatted table with {{API Table}} Template. Fixed parameters, return values, descriptions.

Show changes

Bomb Bloke: Addition of textutils.serializeJSON by CC 1.7.

2015-02-16T12:09:19Z

Addition of textutils.serializeJSON by CC 1.7.

Bomb Bloke: Well, that wasn't exactly right either...

2014-02-22T13:20:54Z

Well, that wasn't exactly right either...

Bomb Bloke: Corrected description of textutils.pagedPrint(), removed "needs work" template.

2014-02-22T13:12:37Z

Corrected description of textutils.pagedPrint(), removed "needs work" template.

Cranium: Changing int to number

2013-07-18T10:38:45Z

Changing int to number

TheCoryKid: I need to start using [Show preview].

2013-05-05T09:58:07Z

I need to start using [Show preview].

TheCoryKid: Made function descriptions a little more informative and beginner-friendly. Users shouldn't have to visit individual pages to understand what any function does.

2013-05-05T09:55:16Z

Made function descriptions a little more informative and beginner-friendly. Users shouldn't have to visit individual pages to understand what any function does.

Smiley43210: Changed to use type template

2013-05-02T15:41:34Z

Changed to use type template

@@ Line 52: / Line 52: @@
 {{API table/row
-|[[textutils.serializeJSON]]({{type|table}}/{{type|string}}/{{type|number}}/{{type|boolean}} data)
+|[[textutils.serializeJSON]]({{type|table}}/{{type|string}}/{{type|number}}/{{type|boolean}} data [, {{type|boolean}} unquote keys])
 |{{type|string}} serializedData
 |Returns a JSON representation of the data <var>data</var> in a form of a {{type|string}}, mainly for [[Commands (API)|command usage]]. Also exists as textutils.seriali'''s'''eJSON. ''Requires CC 1.7 or later.''

@@ Line 54: / Line 54: @@
 |[[textutils.serializeJSON]]({{type|table}}/{{type|string}}/{{type|number}}/{{type|boolean}} data)
 |{{type|string}} serializedData
-|Returns a JSON representation of the data <var>data</var> in a form of a {{type|string}}, mainly for [[Commands (API)|command usage]]. Also exists as textutils.seriali'''s'''eJSON. Requires CC 1.7 or later.
+|Returns a JSON representation of the data <var>data</var> in a form of a {{type|string}}, mainly for [[Commands (API)|command usage]]. Also exists as textutils.seriali'''s'''eJSON. ''Requires CC 1.7 or later.''
 |odd}}
@@ Line 62: / Line 62: @@
 |Makes a string safe to encode into a url. Spaces are replaced with <var>+</var>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].
 |}}
 }}
 [[Category:APIs]]

@@ Line 27: / Line 27: @@
 <tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.serialize]]({{type|table}} table)</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns a string representation of the table ''table'' for storage or transmission.</td></tr>
+<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns a string representation of the table ''table'' for storage or transmission. Also exists as textutils.seriali'''s'''e under CC 1.6 or later.</td></tr>
 <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 string ''text''.</td></tr>
+<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns a table reassembled from string ''text''. Also exists as textutils.unseriali'''s'''e under CC 1.6 or later.</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.serializeJSON]]({{type|table}} table)</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>
 </table>
 [[Category:APIs]]

@@ Line 24: / 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>
-<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: #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 scrolled) 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>

@@ Line 1: / Line 1: @@
 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>
-<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>

@@ Line 10: / Line 10: @@
 <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: #FFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.slowWrite]]({{type|string}} text, {{type|int}} rate)</td>
+<tr style="background-color: #FFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.slowWrite]]({{type|string}} text, {{type|number}} 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: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.slowPrint]]({{type|string}} text, {{type|int}} rate)</td>
+<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.slowPrint]]({{type|string}} text, {{type|number}} rate)</td>
 <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: #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|number}} time, {{type|boolean}} TwentyFourHour)</td>
 <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>

@@ Line 10: / Line 10: @@
 <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: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.slowPrint]]([[string (type)|string]] text, [[int (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>
-<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.slowWrite]]([[string (type)|string]] text, [[int (type)|int]] rate)</td>
+<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]]([[int (type)|int]] time, [[boolean (type)|bool]] 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>
-<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.tabulate]]([[table (type)|table]] 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>
-<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]]({{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>
-<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]]({{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: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.serialize]]([[table (type)|table]] table)</td>
+<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.serialize]]({{type|table}} table)</td>
 <td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns a string representation of the table ''table'' for storage or transmission.</td></tr>
-<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.unserialize]]([[string (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>
-<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.urlEncode]]([[string (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>
 </table>