aboutsummaryrefslogtreecommitdiff
path: root/assets/manual/man/man3advtrains/rwt_copy.3advtrains.md
diff options
context:
space:
mode:
Diffstat (limited to 'assets/manual/man/man3advtrains/rwt_copy.3advtrains.md')
-rw-r--r--assets/manual/man/man3advtrains/rwt_copy.3advtrains.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/assets/manual/man/man3advtrains/rwt_copy.3advtrains.md b/assets/manual/man/man3advtrains/rwt_copy.3advtrains.md
new file mode 100644
index 0000000..99dfaf1
--- /dev/null
+++ b/assets/manual/man/man3advtrains/rwt_copy.3advtrains.md
@@ -0,0 +1,28 @@
+% RWT_COPY(3ADVTRAINS) | Advtrains Developer's Manual
+
+# NAME
+`copy`, `new`, `to_table`, `to_secs`, `to_string` - Create and copy railway time objects
+
+# SYNOPSIS
+
+* `copy(obj)`
+* `new(cycles, minutes, seconds)`
+* `to_table(obj)`
+* `to_secs(obj [, cycles])`
+* `to_string(obj [, no_cycles])`
+
+# DESCRIPTION
+
+* `copy()` returns a copy of `obj`.
+* `new()` creates a new railway time object with the given number of cycles, minutes, and seconds.
+* `to_table()`, `to_secs()`, and `to_string()` convert `obj` to a table, number, or string, respectively. If `cycles` is passed to `to_secs()`, that value is used as the number of cycles. If `no_cycles` is passed to `to_string()`, the number of cycles is set to zero.
+
+# RETURN VALUE
+
+* `copy()` returns the copy that is created. If `obj` is a table, the returned value is not identical to `obj`.
+* `new()` returns the newly created object as a table.
+* `to_table()`, `to_secs()`, `to_string()` returns the conveerted object.
+
+# NOTES
+
+`to_table()` returns `obj` if it is a table.