WakeupAt (System function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
Line 1: Line 1:
{{Template:System:WakeupAt subtitle}}
{{Template:System:WakeupAt subtitle}}


This page is [[under construction]].
The <var>[[WakeupAt (System function)|WakeupAt]]</var> function is an enhanced alternative     
as the User Language <var>Pause</var> statement, allowing wakeup time resolution of 1 millisecond,
and returns the current time in milliseconds.                                            
==Syntax==
==Syntax==
{{Template:System:WakeupAt syntax}}
{{Template:System:WakeupAt syntax}}
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%number</th><td>number</td></tr>
<tr><th>%number</th><td>The current time, after waking up, in milliseconds.</td></tr>
<tr><th nowrap="true"><var>%(System)</var></th>
<tr><th nowrap="true"><var>%(System)</var></th>
<td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods|shared]] method. <var>WakeupAt</var> can also be invoked via a <var>System</var> object variable, which may be <var>Null</var>.</td></tr>
<td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods|shared]] method. <var>WakeupAt</var> can also be invoked via a <var>System</var> object variable, which may be <var>Null</var>.</td></tr>
<tr><th>timeInMilliseconds</th>
<tr><th>timeInMilliseconds</th>
<td>number</td></tr>
<td>The time, in milliseconds, at which to wake up.</td></tr>
</table>
</table>


==Usage notes==
==Usage notes==
==Examples==
==Examples==
The following code fragment pauses for 1 second at the start of each iteration of the <var>Repeat</var> loop:
<p class="code">%time = %(system):[[CurrentTimeMilliseconds (System function)|currentTimeMilliseconds]]
repeat
  %time = %time + 1000
</p>
==See also==
==See also==
{{Template:System:WakeupAt footer}}
{{Template:System:WakeupAt footer}}

Revision as of 19:03, 1 October 2012

Wake up at a specific time in milliseconds (System class)

[Introduced in Sirius Mods 7.9]


The WakeupAt function is an enhanced alternative as the User Language Pause statement, allowing wakeup time resolution of 1 millisecond, and returns the current time in milliseconds.

Syntax

[%number =] %(System):WakeupAt( timeInMilliseconds)

Syntax terms

%numberThe current time, after waking up, in milliseconds.
%(System) The class name in parentheses denotes a shared method. WakeupAt can also be invoked via a System object variable, which may be Null.
timeInMilliseconds The time, in milliseconds, at which to wake up.

Usage notes

Examples

The following code fragment pauses for 1 second at the start of each iteration of the Repeat loop:

%time = %(system):currentTimeMilliseconds repeat %time = %time + 1000

See also