1
0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2025-09-01 01:57:55 +00:00

Clean up some examples a little bit

Would be good if they didn't crash and burn on entry :).
This commit is contained in:
SquidDev
2020-11-12 19:40:18 +00:00
parent 9f57e77ed3
commit 7f90f2f7ca
13 changed files with 28 additions and 31 deletions

View File

@@ -15,7 +15,7 @@
function isDriveRoot(path) end
--[[- Provides completion for a file or directory name, suitable for use with
@{read}.
@{_G.read}.
When a directory is a possible candidate for completion, two entries are
included - one with a trailing slash (indicating that entries within this

View File

@@ -85,6 +85,9 @@ the `terminate` event yourself - the program will not stop execution when
function pullEventRaw(filter) end
--- Pauses execution for the specified number of seconds, alias of @{_G.sleep}.
--
-- @tparam number time The number of seconds to sleep for, rounded up to the
-- nearest multiple of 0.05.
function sleep(time) end
--- Get the current CraftOS version (for example, `CraftOS 1.8`).
@@ -93,6 +96,7 @@ function sleep(time) end
-- should return `CraftOS 1.8`.
--
-- @treturn string The current CraftOS version.
-- @usage os.version()
function version() end
--[[- Run the program at the given path with the specified environment and
@@ -113,7 +117,7 @@ such as @{loadfile}.
@treturn boolean Whether or not the program ran successfully.
@usage Run the default shell from within your program:
os.run({}, "/rom/programs/shell")
os.run({}, "/rom/programs/shell.lua")
@see shell.run
@see loadfile