Mercurial > molko

annotate doc/api-molko-clock.rst @ 212:ddfe0a211169

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
rpg: experiment with map teleport
author David Demelier <markand@malikania.fr>
date Mon, 16 Nov 2020 14:26:13 +0100
parents 633a25df450e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
191
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 .. toctree::
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 .. _api-molko-clock:
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
3
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 Molko.Clock
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 ===========
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
6
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 Keep track of elapsed time.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
8
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 Constructors
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 ------------
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
11
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 .. js:function:: Molko.Clock()
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
13
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 Create a new clock object and start collecting time from now. This function
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 MUST be called as a constructor, not doing so will also raise an error.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
16
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 Methods
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 -------
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
19
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 .. js:method:: Molko.Clock.start()
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 Reset the clock from now.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
23
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 Properties
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 ----------
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
26
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 The following properties are available once an object has been constructed:
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
28
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 .. js:attribute:: Molko.Clock.elapsed
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
30
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 (Read-only) Number of milliseconds elapsed since construction of object or last
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 call to start function.