mirror of
https://github.com/SquidDev-CC/CC-Tweaked
synced 2025-10-22 01:17:38 +00:00
Switch to GitHub-style admonitions/alerts
As these are just a custom syntax on top of blockquotes, these work much better with text editors.
This commit is contained in:
Jonathan Coates
@@ -37,10 +37,9 @@ import java.util.function.Function;
|
||||
* {@link #copy} and {@link #delete}.</li>
|
||||
* </ul>
|
||||
* <p>
|
||||
* :::note
|
||||
* All functions in the API work on absolute paths, and do not take the @{shell.dir|current directory} into account.
|
||||
* You can use @{shell.resolve} to convert a relative path into an absolute one.
|
||||
* :::
|
||||
* > [!NOTE]
|
||||
* > All functions in the API work on absolute paths, and do not take the @{shell.dir|current directory} into account.
|
||||
* > You can use @{shell.resolve} to convert a relative path into an absolute one.
|
||||
* <p>
|
||||
* ## Mounts
|
||||
* While a computer can only have one hard drive and filesystem, other filesystems may be "mounted" inside it. For
|
||||
|
||||
@@ -353,13 +353,12 @@ public class OSAPI implements ILuaAPI {
|
||||
* * If called with {@code local}, returns the number of milliseconds since 1
|
||||
* January 1970 in the server's local timezone.
|
||||
* <p>
|
||||
* :::info
|
||||
* The {@code ingame} time zone assumes that one Minecraft day consists of 86,400,000
|
||||
* milliseconds. Since one in-game day is much faster than a real day (20 minutes), this
|
||||
* will change quicker than real time - one real second is equal to 72000 in-game
|
||||
* milliseconds. If you wish to convert this value to real time, divide by 72000; to
|
||||
* convert to ticks (where a day is 24000 ticks), divide by 3600.
|
||||
* :::
|
||||
* > [!INFO]
|
||||
* > The {@code ingame} time zone assumes that one Minecraft day consists of 86,400,000
|
||||
* > milliseconds. Since one in-game day is much faster than a real day (20 minutes), this
|
||||
* > will change quicker than real time - one real second is equal to 72000 in-game
|
||||
* > milliseconds. If you wish to convert this value to real time, divide by 72000; to
|
||||
* > convert to ticks (where a day is 24000 ticks), divide by 3600.
|
||||
*
|
||||
* @param args The locale to get the milliseconds for. Defaults to {@code ingame} if not set.
|
||||
* @return The milliseconds since the epoch depending on the selected locale.
|
||||
|
||||
@@ -5,10 +5,9 @@
|
||||
--[[- Execute [Minecraft commands][mc] and gather data from the results from
|
||||
a command computer.
|
||||
|
||||
:::note
|
||||
This API is only available on Command computers. It is not accessible to normal
|
||||
players.
|
||||
:::
|
||||
> [!NOTE]
|
||||
> This API is only available on Command computers. It is not accessible to normal
|
||||
> players.
|
||||
|
||||
While one may use @{commands.exec} directly to execute a command, the
|
||||
commands API also provides helper methods to execute every command. For
|
||||
|
||||
@@ -9,10 +9,9 @@ locally attached drive, specify “side” as one of the six sides (e.g. `left`)
|
||||
use a remote disk drive, specify its name as printed when enabling its modem
|
||||
(e.g. `drive_0`).
|
||||
|
||||
:::tip
|
||||
All computers (except command computers), turtles and pocket computers can be
|
||||
placed within a disk drive to access it's internal storage like a disk.
|
||||
:::
|
||||
> [!TIP]
|
||||
> All computers (except command computers), turtles and pocket computers can be
|
||||
> placed within a disk drive to access it's internal storage like a disk.
|
||||
|
||||
@module disk
|
||||
@since 1.2
|
||||
|
||||
@@ -12,11 +12,10 @@ and the fourth should be either above or below the other three. The three in a
|
||||
plane should not be in a line with each other. You can set up hosts using the
|
||||
gps program.
|
||||
|
||||
:::note
|
||||
When entering in the coordinates for the host you need to put in the `x`, `y`,
|
||||
and `z` coordinates of the block that the modem is connected to, not the modem.
|
||||
All modem distances are measured from the block that the modem is placed on.
|
||||
:::
|
||||
> [!NOTE]
|
||||
> When entering in the coordinates for the host you need to put in the `x`, `y`,
|
||||
> and `z` coordinates of the block that the modem is connected to, not the modem.
|
||||
> All modem distances are measured from the block that the modem is placed on.
|
||||
|
||||
Also note that you may choose which axes x, y, or z refers to - so long as your
|
||||
systems have the same definition as any GPS servers that're in range, it works
|
||||
|
||||
@@ -17,25 +17,23 @@ etc) can safely be used in one without affecting the event queue accessed by
|
||||
the other.
|
||||
|
||||
|
||||
:::caution
|
||||
When using this API, be careful to pass the functions you want to run in
|
||||
parallel, and _not_ the result of calling those functions.
|
||||
|
||||
For instance, the following is correct:
|
||||
|
||||
```lua
|
||||
local function do_sleep() sleep(1) end
|
||||
parallel.waitForAny(do_sleep, rednet.receive)
|
||||
```
|
||||
|
||||
but the following is **NOT**:
|
||||
|
||||
```lua
|
||||
local function do_sleep() sleep(1) end
|
||||
parallel.waitForAny(do_sleep(), rednet.receive)
|
||||
```
|
||||
|
||||
:::
|
||||
> [!WARNING]
|
||||
> When using this API, be careful to pass the functions you want to run in
|
||||
> parallel, and _not_ the result of calling those functions.
|
||||
>
|
||||
> For instance, the following is correct:
|
||||
>
|
||||
> ```lua
|
||||
> local function do_sleep() sleep(1) end
|
||||
> parallel.waitForAny(do_sleep, rednet.receive)
|
||||
> ```
|
||||
>
|
||||
> but the following is **NOT**:
|
||||
>
|
||||
> ```lua
|
||||
> local function do_sleep() sleep(1) end
|
||||
> parallel.waitForAny(do_sleep(), rednet.receive)
|
||||
> ```
|
||||
|
||||
@module parallel
|
||||
@since 1.2
|
||||
|
||||
@@ -35,11 +35,10 @@ Once you have the name of a peripheral, you can call functions on it using the
|
||||
@{peripheral.call} function. This takes the name of our peripheral, the name of
|
||||
the function we want to call, and then its arguments.
|
||||
|
||||
:::info
|
||||
Some bits of the peripheral API call peripheral functions *methods* instead
|
||||
(for example, the @{peripheral.getMethods} function). Don't worry, they're the
|
||||
same thing!
|
||||
:::
|
||||
> [!INFO]
|
||||
> Some bits of the peripheral API call peripheral functions *methods* instead
|
||||
> (for example, the @{peripheral.getMethods} function). Don't worry, they're the
|
||||
> same thing!
|
||||
|
||||
Let's say we have a monitor above our computer (and so "top") and want to
|
||||
@{monitor.write|write some text to it}. We'd write the following:
|
||||
|
||||
@@ -16,15 +16,14 @@ Once rednet is opened, you can send messages using @{rednet.send} and receive
|
||||
them using @{rednet.receive}. It's also possible to send a message to _every_
|
||||
rednet-using computer using @{rednet.broadcast}.
|
||||
|
||||
:::caution Network security
|
||||
|
||||
While rednet provides a friendly way to send messages to specific computers, it
|
||||
doesn't provide any guarantees about security. Other computers could be
|
||||
listening in to your messages, or even pretending to send messages from other computers!
|
||||
|
||||
If you're playing on a multi-player server (or at least one where you don't
|
||||
trust other players), it's worth encrypting or signing your rednet messages.
|
||||
:::
|
||||
> [Network security][!WARNING]
|
||||
>
|
||||
> While rednet provides a friendly way to send messages to specific computers, it
|
||||
> doesn't provide any guarantees about security. Other computers could be
|
||||
> listening in to your messages, or even pretending to send messages from other computers!
|
||||
>
|
||||
> If you're playing on a multi-player server (or at least one where you don't
|
||||
> trust other players), it's worth encrypting or signing your rednet messages.
|
||||
|
||||
## Protocols and hostnames
|
||||
Several rednet messages accept "protocol"s - simple string names describing what
|
||||
|
||||
@@ -8,10 +8,9 @@ When a computer starts, it reads the current value of settings from the
|
||||
`/.settings` file. These values then may be @{settings.get|read} or
|
||||
@{settings.set|modified}.
|
||||
|
||||
:::caution
|
||||
Calling @{settings.set} does _not_ update the settings file by default. You
|
||||
_must_ call @{settings.save} to persist values.
|
||||
:::
|
||||
> [!WARNING]
|
||||
> Calling @{settings.set} does _not_ update the settings file by default. You
|
||||
> _must_ call @{settings.save} to persist values.
|
||||
|
||||
@module settings
|
||||
@since 1.78
|
||||
@@ -113,10 +112,9 @@ end
|
||||
|
||||
--[[- Set the value of a setting.
|
||||
|
||||
:::caution
|
||||
Calling @{settings.set} does _not_ update the settings file by default. You
|
||||
_must_ call @{settings.save} to persist values.
|
||||
:::
|
||||
> [!WARNING]
|
||||
> Calling @{settings.set} does _not_ update the settings file by default. You
|
||||
> _must_ call @{settings.save} to persist values.
|
||||
|
||||
@tparam string name The name of the setting to set
|
||||
@param value The setting's value. This cannot be `nil`, and must be
|
||||
|
||||
@@ -95,10 +95,9 @@ end
|
||||
The returned encoder is itself a function. This function accepts a table of amplitude data between -128 and 127 and
|
||||
returns the encoded DFPWM data.
|
||||
|
||||
:::caution Reusing encoders
|
||||
Encoders have lots of internal state which tracks the state of the current stream. If you reuse an encoder for multiple
|
||||
streams, or use different encoders for the same stream, the resulting audio may not sound correct.
|
||||
:::
|
||||
> [Reusing encoders][!WARNING]
|
||||
> Encoders have lots of internal state which tracks the state of the current stream. If you reuse an encoder for multiple
|
||||
> streams, or use different encoders for the same stream, the resulting audio may not sound correct.
|
||||
|
||||
@treturn function(pcm: { number... }):string The encoder function
|
||||
@see encode A helper function for encoding an entire file of audio at once.
|
||||
@@ -138,10 +137,9 @@ end
|
||||
The returned decoder is itself a function. This function accepts a string and returns a table of amplitudes, each value
|
||||
between -128 and 127.
|
||||
|
||||
:::caution Reusing decoders
|
||||
Decoders have lots of internal state which tracks the state of the current stream. If you reuse an decoder for multiple
|
||||
streams, or use different decoders for the same stream, the resulting audio may not sound correct.
|
||||
:::
|
||||
> [Reusing decoders][!WARNING]
|
||||
> Decoders have lots of internal state which tracks the state of the current stream. If you reuse an decoder for
|
||||
> multiple streams, or use different decoders for the same stream, the resulting audio may not sound correct.
|
||||
|
||||
@treturn function(dfpwm: string):{ number... } The encoder function
|
||||
@see decode A helper function for decoding an entire file of audio at once.
|
||||
|
||||
@@ -4,10 +4,9 @@
|
||||
|
||||
--[[- A pretty-printer for Lua errors.
|
||||
|
||||
:::warning
|
||||
This is an internal module and SHOULD NOT be used in your own code. It may
|
||||
be removed or changed at any time.
|
||||
:::
|
||||
> [!DANGER]
|
||||
> This is an internal module and SHOULD NOT be used in your own code. It may
|
||||
> be removed or changed at any time.
|
||||
|
||||
This consumes a list of messages and "annotations" and displays the error to the
|
||||
terminal.
|
||||
|
||||
@@ -4,10 +4,9 @@
|
||||
|
||||
--[[- Internal tools for working with errors.
|
||||
|
||||
:::warning
|
||||
This is an internal module and SHOULD NOT be used in your own code. It may
|
||||
be removed or changed at any time.
|
||||
:::
|
||||
> [!DANGER]
|
||||
> This is an internal module and SHOULD NOT be used in your own code. It may
|
||||
> be removed or changed at any time.
|
||||
|
||||
@local
|
||||
]]
|
||||
|
||||
@@ -4,10 +4,9 @@
|
||||
|
||||
--[[- Upload a list of files, as received by the @{event!file_transfer} event.
|
||||
|
||||
:::warning
|
||||
This is an internal module and SHOULD NOT be used in your own code. It may
|
||||
be removed or changed at any time.
|
||||
:::
|
||||
> [!DANGER]
|
||||
> This is an internal module and SHOULD NOT be used in your own code. It may
|
||||
> be removed or changed at any time.
|
||||
|
||||
@local
|
||||
]]
|
||||
|
||||
@@ -4,10 +4,9 @@
|
||||
|
||||
--[[- The error messages reported by our lexer and parser.
|
||||
|
||||
:::warning
|
||||
This is an internal module and SHOULD NOT be used in your own code. It may
|
||||
be removed or changed at any time.
|
||||
:::
|
||||
> [!DANGER]
|
||||
> This is an internal module and SHOULD NOT be used in your own code. It may
|
||||
> be removed or changed at any time.
|
||||
|
||||
This provides a list of factory methods which take source positions and produce
|
||||
appropriate error messages targeting that location. These error messages can
|
||||
|
||||
@@ -4,10 +4,9 @@
|
||||
|
||||
--[[- The main entrypoint to our Lua parser
|
||||
|
||||
:::warning
|
||||
This is an internal module and SHOULD NOT be used in your own code. It may
|
||||
be removed or changed at any time.
|
||||
:::
|
||||
> [!DANGER]
|
||||
> This is an internal module and SHOULD NOT be used in your own code. It may
|
||||
> be removed or changed at any time.
|
||||
|
||||
@local
|
||||
]]
|
||||
|
||||
@@ -4,10 +4,9 @@
|
||||
|
||||
--[[- A lexer for Lua source code.
|
||||
|
||||
:::warning
|
||||
This is an internal module and SHOULD NOT be used in your own code. It may
|
||||
be removed or changed at any time.
|
||||
:::
|
||||
> [!DANGER]
|
||||
> This is an internal module and SHOULD NOT be used in your own code. It may
|
||||
> be removed or changed at any time.
|
||||
|
||||
This module provides utilities for lexing Lua code, returning tokens compatible
|
||||
with @{cc.internal.syntax.parser}. While all lexers are roughly the same, there
|
||||
|
||||
@@ -4,10 +4,9 @@
|
||||
|
||||
--[[- A parser for Lua programs and expressions.
|
||||
|
||||
:::warning
|
||||
This is an internal module and SHOULD NOT be used in your own code. It may
|
||||
be removed or changed at any time.
|
||||
:::
|
||||
> [!DANGER]
|
||||
> This is an internal module and SHOULD NOT be used in your own code. It may
|
||||
> be removed or changed at any time.
|
||||
|
||||
Most of the code in this module is automatically generated from the Lua grammar,
|
||||
hence being mostly unreadable!
|
||||
|
||||
Reference in New Issue
Block a user