CurrentTimeString (System function): Difference between revisions
Jump to navigation
Jump to search
m (Remove empty section headers) |
No edit summary |
||
| (15 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:System:CurrentTimeString subtitle}} | {{Template:System:CurrentTimeString subtitle}} | ||
==Syntax== | ==Syntax== | ||
{{Template:System:CurrentTimeString syntax}} | {{Template:System:CurrentTimeString syntax}} | ||
| Line 6: | Line 5: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%string</th><td>The returned value is the current time; it is a string in the format specified by the <var class="term">format</var> argument.</td></tr> | <tr><th>%string</th><td>The returned value is the current time; it is a string in the format specified by the <var class="term">format</var> argument.</td></tr> | ||
<tr><th>%(System)</th> | <tr><th><var class="nobr">%(System)</var></th> | ||
<td>The class name in parentheses denotes a shared method. <var>CurrentTimeString</var> can also be invoked via a <var>System</var> object variable, which may be null.</td></tr> | <td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods|shared]] method. <var>CurrentTimeString</var> can also be invoked via a <var>System</var> object variable, which may be null.</td></tr> | ||
<tr><th>format</th> | <tr><th>format</th> | ||
<td><var></var>A [[Datetime string formats|datetime format]] string. This argument is optional; the default is <code>YY-MM-DD</code>.</td></tr> | <td><var></var>A [[Datetime string formats|datetime format]] string. This argument is optional; the default is <code>YY-MM-DD</code>.</td></tr> | ||
| Line 13: | Line 12: | ||
==See also== | ==See also== | ||
<ul><li> | <ul> | ||
<li>Related <var>System</var> methods: | |||
<ul> | |||
<li><var>[[CurrentTimeMilliseconds (System function)|CurrentTimeMilliseconds]]</var> | |||
<li><var>[[CurrentTimeSeconds (System function)|CurrentTimeSeconds]]</var> | |||
<li><var>[[CurrentTimeDays (System function)|CurrentTimeDays]]</var> | |||
</ul> | |||
<li>Related intrinsic methods: | |||
<ul> | |||
<li><var>[[DaysToString (Float_function)|DaysToString]]</var> | |||
<li><var>[[MillisecondsToString (Float_function)|MillisecondsToString]]</var> | |||
<li><var>[[SecondsToString (Float_function)|SecondsToString]]</var> | |||
<li><var>[[StringToDays (String_function)|StringToDays]]</var> | |||
<li><var>[[StringToSeconds (String_function)|StringToSeconds]]</var> | |||
<li><var>[[TimeStringConvert (String_function)|TimeStringConvert]]</var> | |||
</ul> | |||
</ul> | |||
{{Template:System:CurrentTimeString footer}} | {{Template:System:CurrentTimeString footer}} | ||
Latest revision as of 19:21, 3 September 2015
Current time as a string (System class)
[Introduced in Sirius Mods 7.8]
Syntax
%string = %(System):CurrentTimeString[( [format])] Throws InvalidDateString
Syntax terms
| %string | The returned value is the current time; it is a string in the format specified by the format argument. |
|---|---|
| %(System) | The class name in parentheses denotes a shared method. CurrentTimeString can also be invoked via a System object variable, which may be null. |
| format | A datetime format string. This argument is optional; the default is YY-MM-DD. |
See also
- Related System methods:
- Related intrinsic methods: