ComputerCraft Wiki - User contributions [en]

Textutils.slowPrint

2012-08-13T19:22:26Z

Zalerinian: Added the page

{{lowercase}}
{{Function
|name=textutils.slowPrint
|args= [[string (type)|string]] text
|returns=Text printed on the screen
|api=textutils
|addon=ComputerCraft
|desc=Prints to the screen
|examples=
{{Example
|desc=Prints text to the screen, character by character.
|code=textutils.slowPrint("Hello World!")
|output=Hello, world!
}}
}}

Textutils.slowWrite

2012-08-13T19:21:13Z

Zalerinian: Made the page

{{lowercase}}
{{Function
|name=textutils.slowWrite
|args= [[string (type)|string]] text
|returns=Text written on the screen
|api=textutils
|addon=ComputerCraft
|desc=Writes to the screen
|examples=
{{Example
|desc=Writes text to the screen, character by character.
|code=textutils.slowWrite("Hello World!")
|output=Hello, world!
}}
}}

Os.shutdown

2012-06-25T21:42:19Z

Zalerinian: Added the page

{{lowercase}}
{{Function
|name=os.shutdown()
|args=None
|returns=None
|api=os
|addon=ComputerCraft
|desc=Shuts down the computer
|examples=
{{Example
|desc=shut Down
|code=os.shutdown()
}}

Alternatively you could hold ctrl + S for one second to shutdown the computer outside of a program.
}}

Os.reboot

2012-06-25T21:40:06Z

Zalerinian: Added the page

{{lowercase}}
{{Function
|name=os.reboot
|args=None
|returns=None
|api=os
|addon=ComputerCraft
|desc=Restarts the computer
|examples=
{{Example
|desc=Restart
|code=os.reboot()
}}
}}

Turtle.select

2012-06-25T21:34:02Z

Zalerinian: Added a reference picture for slot numbers

{{lowercase}}
{{Function
|name=turtle.select
|args=[[int (type)|int]] slotNumber
|api=turtle
|returns=[[boolean]] whether the slot number specified is greater than nine or not.
|addon=ComputerCraft
|desc=Attempts to select the specified slot.
|examples=
{{Example
|desc=Selects the specified slot
|code=print(turtle.select(5))
|output=true
}}

A picture reference[http://i.imgur.com/1BNQH.png]
}}

Fs.list

2012-05-27T16:49:22Z

Zalerinian: fixed code error.

{{lowercase}}
{{Function
|name=fs.list
|args=[[string (type)|string]] path
|api=fs
|returns=[[table (type)|table]] list of files and folders in <var>path</var>, which must be a directory
|desc=Returns a list of all the files contained in a directory as a table
|examples=
{{Example
|desc=Displays a list of all files and folders in the root directory of a computer as a table
|code=abc = fs.list("")
i = 1
while i ~= 15 do
print(abc[i])
i = i+1
end

|output=A list of all files and folders in the root directory as a table
}}
}}

abc = fs.list("") <- will get all the files and directories in the system root into a table, all saved as 'abc'.

i = 1 <- sets i equal to one.

while i ~= 15 do <- While i is not 15, continue to do this.

print(abc[i]) <- print the files and directories.

i = i+1 <- add 1 to i each run so a different file/directory gets listed next.

end <- end the loop.

this code will print 15 lines, blank or not, with the contents of the root directory.

Fs.list

2012-05-27T15:30:19Z

Zalerinian: fixed my own formatting error.

{{lowercase}}
{{Function
|name=fs.list
|args=[[string (type)|string]] path
|api=fs
|returns=[[table (type)|table]] list of files and folders in <var>path</var>, which must be a directory
|desc=Returns a list of all the files contained in a directory as a table
|examples=
{{Example
|desc=Displays a list of all files and folders in the root directory of a computer as a table
|code=abc = fs.list("")
i = 1
while i ~= nil do
print(abc[i])
i = i+1
end

|output=A list of all files and folders in the root directory as a table
}}
}}

abc = fs.list("") <- will get all the files and directories in the system root into a table, all saved as 'abc'.

i = 1 <- sets i equal to one.

while i ~= nil do <- While i isn't nil, continue to do this.

print(abc[i]) <- print the files and directories.

i = i+1 <- add 1 to i each run so a different file/directory gets listed next.

end <- end the loop.

Fs.list

2012-05-27T15:29:39Z

Zalerinian: Made the cod easier to read and added an explanation of it.

{{lowercase}}
{{Function
|name=fs.list
|args=[[string (type)|string]] path
|api=fs
|returns=[[table (type)|table]] list of files and folders in <var>path</var>, which must be a directory
|desc=Returns a list of all the files contained in a directory as a table
|examples=
{{Example
|desc=Displays a list of all files and folders in the root directory of a computer as a table
|code=abc = fs.list("")
i = 1
while i ~= nil do
print(abc[i])
i = i+1
end

|output=A list of all files and folders in the root directory as a table
}}
}}

abc = fs.list("") <- will get all the files and directories in the system root into a table, all saved as 'abc'.
i = 1 <- sets i equal to one.
while i ~= nil do <- While i isn't nil, continue to do this.
print(abc[i]) <- print the files and directories.
i = i+1 <- add 1 to i each run so a different file/directory gets listed next.
end <- end the loop.

Fs (API)

2012-05-26T15:34:30Z

Zalerinian: Made the last paragraph in the Path Names section many times easier to understand.

The FS API allows you to mess around with the filesystem.
{| border="1" cellpadding="2" cellspacing="0"
!style="background:#EEE" width="200px"|Method name
!style="background:#EEE" width="*"|Description
|-
|[[fs.list]](path)
|Lists the directories and files in the given directory
|-
|[[fs.exists]](path)
|Checks if a path refers to an existing file or directory
|-
|[[fs.isDir]](path)
|Checks if a path refers to an existing directory
|-
|[[fs.isReadOnly]](path)
|Checks if a path is read-only (i.e. cannot be modified)
|-
|[[fs.getName]](path)
|Gets the final component of a pathname
|-
|[[fs.getDrive]](path)
|Gets the type of storage medium holding a file or directory
|-
|[[fs.makeDir]](path)
|Makes a directory
|-
|[[fs.move]](fromPath, toPath)
|Moves a file or directory to a new location
|-
|[[fs.copy]](fromPath, toPath)
|Copies a file or directory to a new location
|-
|[[fs.delete]](path)
|Deletes a file or directory
|-
|[[fs.combine]](basePath, localPath)
|Combines two path components, returning a path consisting of the local path nested inside the base path
|-
|[[fs.open]](path, mode)
|Opens a file so it can be read or written
|}
[[Category:APIs]]

== Path Names ==

All of these functions except for [[fs.combine]] refer solely to absolute paths. This means that the current working directory, as set by the <code>cd</code> command or the [[shell.setDir]] function, is ignored. Each path name consists of a list of nonempty path components separated by forward slashes, and those path components are taken one by one with the first being contained in the root directory of the computer.

If you need to deal with paths provided by the user that may be absolute or may be relative to the current working directory, use [[shell.resolve]].

Unlike most real-world operating systems, ComputerCraft's absolute path name system does not need to be started with a forward slash ( / ). Making the directory "a/b/c" is the same as making "/a/b/c". Leaving the slashes is just a matter of preference to the coder.

Fs.open

2012-05-25T16:14:14Z

Zalerinian: Fixed a link

{{lowercase}}
{{Function
|name=fs.open
|args=[[string (type)|string]] path, [[string (type)|string]]
mode
|api=fs
|returns=[[table]] the file handle, or <code>nil</code> if the mode was read-only or the file did not exist
|desc=Opens a file; <var>mode</var> consists of a first character which is one of
"r" to open the file read-only,

"w" to open it for writing and remove any existing data, or

"a" to open for writing but keep existing data and append any writes to the end of the file, plus optionally the second character

"b" to open the file for binary access instead of text access
(text mode will perform end-of-line conversions necessary to move text files between Windows, Linux, and Mac OS systems; binary files should not have these conversions applied as they will be corrupted)
|examples=
{{Example
|desc=Creates the file "abcd" and holds a file handle to it
|code=h = fs.open("abcd", "w")
}}
}}

== File Handles ==

A file handle allows access to a file. A file handle is a table; the functions within the table are accessed with the dot operator (not the colon operator, as may be more intuitive!). The examples below assume a file has already been opened and the handle stored in the variable <var>h</var>.

=== Files opened in text read mode ===

A file opened in mode "r" (text read mode) exposes the following functions.

{{Function
|name=<var>h</var>.readLine
|api=fs
|returns=[[string]] the next line read from the file, with the end-of-line character stripped; or nil if there are no more lines in the file
|desc=Reads the next line from the file
}}
{{Function
|name=<var>h</var>.readAll
|api=fs
|returns=[[string]] the entire rest of the file, with the end-of-line character on the very last line (if present) stripped
|desc=Reads the rest of the text in the file
}}
{{Function
|name=<var>h</var>.close
|api=fs
|desc=Closes the file handle, after which it can no longer be used
}}

=== Files opened in text write/append mode ===

A file opened in mode "w" (text write mode) or "a" (text append mode) exposes the following functions:

{{Function
|name=<var>h</var>.write
|args=[[string (type)|string]] data
|api=fs
|desc=Writes a string of characters to the file exactly as they appear in the string <var>data</var>
}}
{{Function
|name=<var>h</var>.writeLine
|args=[[string (type)|string]] data
|api=fs
|desc=Writes a string of characters to the file, then appends an end-of-line character
}}
{{Function
|name=<var>h</var>.close
|api=fs
|desc=Closes the file handle, after which it can no longer be used
}}

=== Files opened in binary read mode ===

A file opened in mode "rb" (binary read mode) exposes the following functions:

{{Function
|name=<var>h</var>.read
|api=fs
|returns=[[int]] the byte read from the file, or <code>nil</code> if there are no more bytes
|desc=Reads a single byte from the file and returns it
}}
{{Function
|name=<var>h</var>.close
|api=fs
|desc=Closes the file handle, after which it can no longer be used
}}

=== Files opened in binary write/append mode ===

A file opened in mode "wb" (binary write mode) or "ab" (binary append mode) exposes the following functions:

{{Function
|name=<var>h</var>.write
|args=[[int]] byte
|api=fs
|desc=Writes a single byte into the file
}}
{{Function
|name=<var>h</var>.close
|api=fs
|desc=Closes the file handle, after which it can no longer be used
}}

Fs.open

2012-05-25T16:10:51Z

Zalerinian: Reformatted the description

{{lowercase}}
{{Function
|name=fs.open
|args=[[string (type)|string]] path, [[string(type)|string]] mode
|api=fs
|returns=[[table]] the file handle, or <code>nil</code> if the mode was read-only or the file did not exist
|desc=Opens a file; <var>mode</var> consists of a first character which is one of
"r" to open the file read-only,

"w" to open it for writing and remove any existing data, or

"a" to open for writing but keep existing data and append any writes to the end of the file, plus optionally the second character

"b" to open the file for binary access instead of text access
(text mode will perform end-of-line conversions necessary to move text files between Windows, Linux, and Mac OS systems; binary files should not have these conversions applied as they will be corrupted)
|examples=
{{Example
|desc=Creates the file "abcd" and holds a file handle to it
|code=h = fs.open("abcd", "w")
}}
}}

== File Handles ==

A file handle allows access to a file. A file handle is a table; the functions within the table are accessed with the dot operator (not the colon operator, as may be more intuitive!). The examples below assume a file has already been opened and the handle stored in the variable <var>h</var>.

=== Files opened in text read mode ===

A file opened in mode "r" (text read mode) exposes the following functions.

{{Function
|name=<var>h</var>.readLine
|api=fs
|returns=[[string]] the next line read from the file, with the end-of-line character stripped; or nil if there are no more lines in the file
|desc=Reads the next line from the file
}}
{{Function
|name=<var>h</var>.readAll
|api=fs
|returns=[[string]] the entire rest of the file, with the end-of-line character on the very last line (if present) stripped
|desc=Reads the rest of the text in the file
}}
{{Function
|name=<var>h</var>.close
|api=fs
|desc=Closes the file handle, after which it can no longer be used
}}

=== Files opened in text write/append mode ===

A file opened in mode "w" (text write mode) or "a" (text append mode) exposes the following functions:

{{Function
|name=<var>h</var>.write
|args=[[string (type)|string]] data
|api=fs
|desc=Writes a string of characters to the file exactly as they appear in the string <var>data</var>
}}
{{Function
|name=<var>h</var>.writeLine
|args=[[string (type)|string]] data
|api=fs
|desc=Writes a string of characters to the file, then appends an end-of-line character
}}
{{Function
|name=<var>h</var>.close
|api=fs
|desc=Closes the file handle, after which it can no longer be used
}}

=== Files opened in binary read mode ===

A file opened in mode "rb" (binary read mode) exposes the following functions:

{{Function
|name=<var>h</var>.read
|api=fs
|returns=[[int]] the byte read from the file, or <code>nil</code> if there are no more bytes
|desc=Reads a single byte from the file and returns it
}}
{{Function
|name=<var>h</var>.close
|api=fs
|desc=Closes the file handle, after which it can no longer be used
}}

=== Files opened in binary write/append mode ===

A file opened in mode "wb" (binary write mode) or "ab" (binary append mode) exposes the following functions:

{{Function
|name=<var>h</var>.write
|args=[[int]] byte
|api=fs
|desc=Writes a single byte into the file
}}
{{Function
|name=<var>h</var>.close
|api=fs
|desc=Closes the file handle, after which it can no longer be used
}}

Term.restore

2012-05-20T14:58:08Z

Zalerinian: Created page with "{{lowercase}} {{Function |name=term.write |args= string none |returns=Nothing |api=term |addon=ComputerCraft |desc=Restores the program from running on a mon..."

{{lowercase}}
{{Function
|name=term.write
|args= [[string (type)|string]] none
|returns=Nothing
|api=term
|addon=ComputerCraft
|desc=Restores the program from running on a monitor to run on the computer
|examples=
{{Example
|desc=Restores a program to the computer.
This will only work if the computer was running a program on a monitor
|code=term.restore()
}}
}}

Shell (API)

2012-05-06T12:09:17Z

Zalerinian: fixed an error

The shell API allows you to interface with the [http://en.wikipedia.org/wiki/Shell_%28computing%29 shell].

{| border="1" cellpadding="2" cellspacing="0"
!style="background:#EEE" width="200px"|Method name
!style="background:#EEE" width="*"|Description
|-
|shell.exit()
|Exits the program
|-
|shell.dir()
|Returns the directory
|-
|shell.setDir( path )
|Sets the directory
|-
|shell.path()
|Returns the path
|-
|shell.setPath( path )
|Sets the path
|-
|shell.resolve( localpath )
|<no description given>
|-
|shell.resolveProgram( name )
|<no description given>
|-
|shell.aliases()
|Returns aliases.
|-
|shell.setAlias( alias, command )
|Sets an alias.
|-
|shell.clearAlias( alias, command )
|Clears an alias.
|-
|shell.programs()
|Returns programs.
|-
|shell.run( program, arguments )
|Runs a program.
|-
|shell.getRunningProgram()
|Returns the absolute path to the currently-executing program.
|-
|}

[[Category:APIs]]

User:Zalerinian

2012-05-06T05:52:09Z

Zalerinian:

Personal Quote: Potato
--[[User:Zalerinian| ~Z]] 05:52, 6 May 2012 (UTC)

User:Zalerinian

2012-05-06T05:45:45Z

Zalerinian: Created page with "Personal Quote: Potato --~~~~"

Personal Quote: Potato
--[[User:Zalerinian|Zalerinian]] 05:45, 6 May 2012 (UTC)

Term (API)

2012-05-06T05:43:32Z

Zalerinian: Added pages for term.write and term.clear

The Terminal API provides functions for ASCII graphics.
{| border="1" cellpadding="2" cellspacing="0"
!style="background:#EEE" width="200px"|Method name
!style="background:#EEE" width="*"|Description
|-
|[http://computercraft.info/wiki/index.php?title=Term.write() term.write( text )]
|Writes text to the screen.
|-
|[http://computercraft.info/wiki/index.php?title=Term.clear() term.clear()]
|Clears the entire screen
|-
|term.clearLine()
|Clears the line the cursor is on
|-
|term.getCursorPos()
|Returns two arguments containing the x and the y position of the cursor
|-
|term.setCursorPos( x, y )
|Sets the cursor's position.
|-
|term.setCursorBlink( b )
|Disables the blinking or turns it on.
|-
|term.getSize()
|Returns two arguments containing the x and the y values stating the size of the screen. (Good for if you're making something to be compatible with both [[Turtles]] and [[Consoles]].
|-
|term.scroll( n )
|Scrolls the terminal.
|-
|term.redirect( side )
|Redirects terminal output to a monitor.
|-
|term.restore()
|Restores terminal output to the console.
|-
|}
[[Category:APIs]]

Term.write

2012-05-06T05:42:53Z

Zalerinian: Term.write() page added.

{{lowercase}}
{{Function
|name=term.write
|args= [[string (type)|string]] text
|returns=Text written on the screen
|api=term
|addon=ComputerCraft
|desc=Writes to the screen
|examples=
{{Example
|desc=Writes text to the screen.
This does not produce a new line, and anything else printed or written after this will be on the same line.
|code=term.write("text")
}}
}}

Term.clear

2012-05-06T05:31:13Z

Zalerinian: Added Page for Term.clear

{{lowercase}}
{{Function
|name=term.clear
|args=none
|returns=none
|api=term
|addon=ComputerCraft
|desc=Clears the screen
|examples=
{{Example
|desc=Clears any text on the console or monitor.
|code=term.clear()
}}
}}

Shell (API)

2012-05-06T05:23:34Z

Zalerinian:

Shell (API)

2012-05-06T05:09:12Z

Zalerinian: