mirrors/CC-Tweaked
1
0
Fork 0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2025-01-08 08:20:29 +00:00
Code Issues Releases Wiki Activity

Fix wrong link in os.date docs

Browse Source 
Should be os.time, not os.date! Fixes #1999
This commit is contained in:
Jonathan Coates 2024-10-24 14:03:06 +01:00
parent d6a246c122
commit c271ed7c7f
No known key found for this signature in database
GPG Key ID: B9E431FF07C98D06
1 changed files with 25 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
projects/core/src/main/java/dan200/computercraft/core/apis/OSAPI.java
View File

@ -403,21 +403,39 @@ public class OSAPI implements ILuaAPI {
* function. The format string can also be prefixed with an exclamation mark
* ({@code !}) to use UTC time instead of the server's local timezone.
* <p>
* If the format is exactly {@code *t} (optionally prefixed with {@code !}), a
* table will be returned instead. This table has fields for the year, month,
* day, hour, minute, second, day of the week, day of the year, and whether
* Daylight Savings Time is in effect. This table can be converted to a UNIX
* timestamp (days since 1 January 1970) with {@link #date}.
* If the format is exactly {@code "*t"} (or {@code "!*t"} ), a table
* representation of the timestamp will be returned instead. This table has
* fields for the year, month, day, hour, minute, second, day of the week,
* day of the year, and whether Daylight Savings Time is in effect. This
* table can be converted back to a timestamp with {@link #time(IArguments)}.
*
* @param formatA The format of the string to return. This defaults to {@code %c}, which expands to a string similar to "Sat Dec 24 16:58:00 2011".
* @param timeA The time to convert to a string. This defaults to the current time.
* @return The resulting format string.
* @param timeA The timestamp to convert to a string. This defaults to the current time.
* @return The resulting formated string, or table.
* @throws LuaException If an invalid format is passed.
* @cc.since 1.83.0
* @cc.usage Print the current date in a user-friendly string.
* <pre>{@code
* os.date("%A %d %B %Y") -- See the reference above!
* }</pre>
*
* @cc.usage Convert a timestamp to a table.
* <pre>{@code
* os.date("!*t", 1242534247)
* --[=[ {
* -- Date
* year = 2009,
* month = 5,
* day = 17,
* yday = 137,
* wday = 1,
* -- Time
* hour = 4,
* min = 24,
* sec = 7,
* isdst = false,
* } ]=]
* }</pre>
*/
@LuaFunction
public final Object date(Optional<String> formatA, Optional<Long> timeA) throws LuaException {