<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>crates/livesplit-auto-splitting/README.md - fork/livesplit-core @ master</title>
<meta name="description" content="crates/livesplit-auto-splitting/README.md in fork/livesplit-core at master.">
<meta property="og:title" content="crates/livesplit-auto-splitting/README.md - fork/livesplit-core @ master">
<meta property="og:description" content="crates/livesplit-auto-splitting/README.md in fork/livesplit-core at master.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="master" data-tip="d8564b6a104c9f865b55a8fab2559b3fe571934e">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/livesplit-core</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/livesplit-core</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Christopher Serr</span><span class="commit-message" data-commit="526e60fce000098a35818086505eca7d7eff9f51">Merge pull request #547 from CryZe/wasi</span><span class="snapshot-sha sha" data-commit="526e60fce000098a35818086505eca7d7eff9f51">526e60f</span><time datetime="2022-07-28T18:17:24+02:00" title="2022-07-28 18:17:24 +0200">2022-07-28</time></p>
<header class="topbar"><details class="switcher"><summary>master</summary><div class="menu"><strong>branches</strong><a class="current" href="/fork/livesplit-core/ref/master/">master</a><strong>tags</strong><a href="/fork/livesplit-core/ref/v0.10.0/">v0.10.0</a><a href="/fork/livesplit-core/ref/v0.11.0/">v0.11.0</a><a href="/fork/livesplit-core/ref/v0.5.1/">v0.5.1</a><a href="/fork/livesplit-core/ref/v0.6.0/">v0.6.0</a><a href="/fork/livesplit-core/ref/v0.7.0/">v0.7.0</a><a href="/fork/livesplit-core/ref/v0.8.0/">v0.8.0</a><a href="/fork/livesplit-core/ref/v0.8.1/">v0.8.1</a><a href="/fork/livesplit-core/ref/v0.9.0/">v0.9.0</a><a class="all" href="/fork/livesplit-core/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/livesplit-core/">livesplit-core</a> / <a href="/fork/livesplit-core/ref/master/tree/crates/">crates</a> / <a href="/fork/livesplit-core/ref/master/tree/crates/livesplit-auto-splitting/">livesplit-auto-splitting</a> / <span class="cur">README.md</span></nav>
<span class="view-stats"><span>3.8 KiB</span><span>113 lines</span></span><span class="actions"><a class="raw" href="/fork/livesplit-core/raw/3da5dcd4082a6a03a038675372b7d9ea82d063b6/crates/livesplit-auto-splitting/README.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1>&lt;img src="https://raw.githubusercontent.com/LiveSplit/LiveSplit/master/LiveSplit/Resources/Icon.png" alt="LiveSplit" height="42" width="45" align="top"/&gt; livesplit-auto-splitting</h1>
<p>livesplit-auto-splitting is a library that provides a runtime for running
auto splitters that can control a speedrun timer. These auto splitters are
provided as WebAssembly modules.</p>
<h2>Requirements for the Auto Splitters</h2>
<p>The auto splitters must provide an <code>update</code> function with the following
signature:</p>
<pre class="language-rust"><a-at>#</a-at><a-p>[</a-p><a-at>no_mangle</a-at><a-p>]</a-p>
<a-k>pub</a-k> <a-k>extern</a-k> <a-s>&quot;C&quot;</a-s> <a-k>fn</a-k> <a-f>update</a-f><a-p>()</a-p> <a-p>{}</a-p></pre>
<p>This function is called periodically by the runtime at the configured tick
rate. The tick rate is 120 Hz by default, but can be changed by the auto
splitter.</p>
<p>In addition the WebAssembly module is expected to export a memory called
<code>memory</code>.</p>
<h2>API exposed to the Auto Splitters</h2>
<p>The following functions are provided to the auto splitters in the module
<code>env</code>:</p>
<pre class="language-rust"><a-at>#</a-at><a-p>[</a-p><a-at>repr</a-at><a-p>(</a-p><a-at>transparent</a-at><a-p>)]</a-p>
<a-k>pub</a-k> <a-k>struct</a-k> <a-t>Address</a-t><a-p>(</a-p><a-k>pub</a-k> <a-t>u64</a-t><a-p>);</a-p>

<a-at>#</a-at><a-p>[</a-p><a-at>repr</a-at><a-p>(</a-p><a-at>transparent</a-at><a-p>)]</a-p>
<a-k>pub</a-k> <a-k>struct</a-k> <a-t>NonZeroAddress</a-t><a-p>(</a-p><a-k>pub</a-k> <a-t>NonZeroU64</a-t><a-p>);</a-p>

<a-at>#</a-at><a-p>[</a-p><a-at>repr</a-at><a-p>(</a-p><a-at>transparent</a-at><a-p>)]</a-p>
<a-k>pub</a-k> <a-k>struct</a-k> <a-t>ProcessId</a-t><a-p>(</a-p><a-t>NonZeroU64</a-t><a-p>);</a-p>

<a-at>#</a-at><a-p>[</a-p><a-at>repr</a-at><a-p>(</a-p><a-at>transparent</a-at><a-p>)]</a-p>
<a-k>pub</a-k> <a-k>struct</a-k> <a-t>TimerState</a-t><a-p>(</a-p><a-t>u32</a-t><a-p>);</a-p>

<a-k>impl</a-k> <a-t>TimerState</a-t> <a-p>{</a-p>
    <a-c>/// The timer is not running.
</a-c>    <a-k>pub</a-k> <a-k>const</a-k> <a-cr>NOT_RUNNING</a-cr><a-p>:</a-p> <a-t>Self</a-t> = <a-f>Self</a-f><a-p>(</a-p><a-co>0</a-co><a-p>);</a-p>
    <a-c>/// The timer is running.
</a-c>    <a-k>pub</a-k> <a-k>const</a-k> <a-cr>RUNNING</a-cr><a-p>:</a-p> <a-t>Self</a-t> = <a-f>Self</a-f><a-p>(</a-p><a-co>1</a-co><a-p>);</a-p>
    <a-c>/// The timer started but got paused. This is separate from the game
</a-c>    <a-c>/// time being paused. Game time may even always be paused.
</a-c>    <a-k>pub</a-k> <a-k>const</a-k> <a-cr>PAUSED</a-cr><a-p>:</a-p> <a-t>Self</a-t> = <a-f>Self</a-f><a-p>(</a-p><a-co>2</a-co><a-p>);</a-p>
    <a-c>/// The timer has ended, but didn&#39;t get reset yet.
</a-c>    <a-k>pub</a-k> <a-k>const</a-k> <a-cr>ENDED</a-cr><a-p>:</a-p> <a-t>Self</a-t> = <a-f>Self</a-f><a-p>(</a-p><a-co>3</a-co><a-p>);</a-p>
<a-p>}</a-p>

<a-k>extern</a-k> <a-s>&quot;C&quot;</a-s> <a-p>{</a-p>
    <a-c>/// Gets the state that the timer currently is in.
</a-c>    <a-k>pub</a-k> <a-k>fn</a-k> <a-f>timer_get_state</a-f><a-p>()</a-p> -&gt; <a-t>TimerState</a-t><a-p>;</a-p>

    <a-c>/// Starts the timer.
</a-c>    <a-k>pub</a-k> <a-k>fn</a-k> <a-f>timer_start</a-f><a-p>();</a-p>
    <a-c>/// Splits the current segment.
</a-c>    <a-k>pub</a-k> <a-k>fn</a-k> <a-f>timer_split</a-f><a-p>();</a-p>
    <a-c>/// Resets the timer.
</a-c>    <a-k>pub</a-k> <a-k>fn</a-k> <a-f>timer_reset</a-f><a-p>();</a-p>
    <a-c>/// Sets a custom key value pair. This may be arbitrary information that
</a-c>    <a-c>/// the auto splitter wants to provide for visualization.
</a-c>    <a-k>pub</a-k> <a-k>fn</a-k> <a-f>timer_set_variable</a-f><a-p>(</a-p>
        <a-v>key_ptr</a-v><a-p>:</a-p> <a-o>*</a-o><a-k>const</a-k> <a-t>u8</a-t><a-p>,</a-p>
        <a-v>key_len</a-v><a-p>:</a-p> <a-t>usize</a-t><a-p>,</a-p>
        <a-v>value_ptr</a-v><a-p>:</a-p> <a-o>*</a-o><a-k>const</a-k> <a-t>u8</a-t><a-p>,</a-p>
        <a-v>value_len</a-v><a-p>:</a-p> <a-t>usize</a-t><a-p>,</a-p>
    <a-p>);</a-p>

    <a-c>/// Sets the game time.
</a-c>    <a-k>pub</a-k> <a-k>fn</a-k> <a-f>timer_set_game_time</a-f><a-p>(</a-p><a-v>secs</a-v><a-p>:</a-p> <a-t>i64</a-t><a-p>,</a-p> <a-v>nanos</a-v><a-p>:</a-p> <a-t>i32</a-t><a-p>);</a-p>
    <a-c>/// Pauses the game time. This does not pause the timer, only the
</a-c>    <a-c>/// automatic flow of time for the game time.
</a-c>    <a-k>pub</a-k> <a-k>fn</a-k> <a-f>timer_pause_game_time</a-f><a-p>();</a-p>
    <a-c>/// Resumes the game time. This does not resume the timer, only the
</a-c>    <a-c>/// automatic flow of time for the game time.
</a-c>    <a-k>pub</a-k> <a-k>fn</a-k> <a-f>timer_resume_game_time</a-f><a-p>();</a-p>

    <a-c>/// Attaches to a process based on its name.
</a-c>    <a-k>pub</a-k> <a-k>fn</a-k> <a-f>process_attach</a-f><a-p>(</a-p><a-v>name_ptr</a-v><a-p>:</a-p> <a-o>*</a-o><a-k>const</a-k> <a-t>u8</a-t><a-p>,</a-p> <a-v>name_len</a-v><a-p>:</a-p> <a-t>usize</a-t><a-p>)</a-p> -&gt; <a-t>Option</a-t><a-p>&lt;</a-p><a-t>ProcessId</a-t><a-p>&gt;;</a-p>
    <a-c>/// Detaches from a process.
</a-c>    <a-k>pub</a-k> <a-k>fn</a-k> <a-f>process_detach</a-f><a-p>(</a-p><a-v>process</a-v><a-p>:</a-p> <a-t>ProcessId</a-t><a-p>);</a-p>
    <a-c>/// Checks whether is a process is still open. You should detach from a
</a-c>    <a-c>/// process and stop using it if this returns `false`.
</a-c>    <a-k>pub</a-k> <a-k>fn</a-k> <a-f>process_is_open</a-f><a-p>(</a-p><a-v>process</a-v><a-p>:</a-p> <a-t>ProcessId</a-t><a-p>)</a-p> -&gt; <a-t>bool</a-t><a-p>;</a-p>
    <a-c>/// Reads memory from a process at the address given. This will write
</a-c>    <a-c>/// the memory to the buffer given. Returns `false` if this fails.
</a-c>    <a-k>pub</a-k> <a-k>fn</a-k> <a-f>process_read</a-f><a-p>(</a-p>
        <a-v>process</a-v><a-p>:</a-p> <a-t>ProcessId</a-t><a-p>,</a-p>
        <a-v>address</a-v><a-p>:</a-p> <a-t>Address</a-t><a-p>,</a-p>
        <a-v>buf_ptr</a-v><a-p>:</a-p> <a-o>*</a-o><a-k>mut</a-k> <a-t>u8</a-t><a-p>,</a-p>
        <a-v>buf_len</a-v><a-p>:</a-p> <a-t>usize</a-t><a-p>,</a-p>
    <a-p>)</a-p> -&gt; <a-t>bool</a-t><a-p>;</a-p>
    <a-c>/// Gets the address of a module in a process.
</a-c>    <a-k>pub</a-k> <a-k>fn</a-k> <a-f>process_get_module_address</a-f><a-p>(</a-p>
        <a-v>process</a-v><a-p>:</a-p> <a-t>ProcessId</a-t><a-p>,</a-p>
        <a-v>name_ptr</a-v><a-p>:</a-p> <a-o>*</a-o><a-k>const</a-k> <a-t>u8</a-t><a-p>,</a-p>
        <a-v>name_len</a-v><a-p>:</a-p> <a-t>usize</a-t><a-p>,</a-p>
    <a-p>)</a-p> -&gt; <a-t>Option</a-t><a-p>&lt;</a-p><a-t>NonZeroAddress</a-t><a-p>&gt;;</a-p>

    <a-c>/// Sets the tick rate of the runtime. This influences the amount of
</a-c>    <a-c>/// times the `update` function is called per second.
</a-c>    <a-k>pub</a-k> <a-k>fn</a-k> <a-f>runtime_set_tick_rate</a-f><a-p>(</a-p><a-v>ticks_per_second</a-v><a-p>:</a-p> <a-t>f64</a-t><a-p>);</a-p>
    <a-c>/// Prints a log message for debugging purposes.
</a-c>    <a-k>pub</a-k> <a-k>fn</a-k> <a-f>runtime_print_message</a-f><a-p>(</a-p><a-v>text_ptr</a-v><a-p>:</a-p> <a-o>*</a-o><a-k>const</a-k> <a-t>u8</a-t><a-p>,</a-p> <a-v>text_len</a-v><a-p>:</a-p> <a-t>usize</a-t><a-p>);</a-p>
<a-p>}</a-p></pre>
<p>On top of the runtime's API, there's also unstable <code>WASI</code> support via the
<code>unstable</code> feature.</p>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>&lt;img src=&quot;https://raw.githubusercontent.com/LiveSplit/LiveSplit/master/LiveSplit/Resources/Icon.png&quot; alt=&quot;LiveSplit&quot; height=&quot;42&quot; width=&quot;45&quot; align=&quot;top&quot;/&gt; livesplit-auto-splitting</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">livesplit-auto-splitting is a library that provides a runtime for running</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">auto splitters that can control a speedrun timer. These auto splitters are</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">provided as WebAssembly modules.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"><a-p>##</a-p> <a-tt>Requirements for the Auto Splitters</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text">The auto splitters must provide an `update` function with the following</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">signature:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>```</a-p><a-tl>rust</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"><a-p>#[no_mangle]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-p>pub </a-p><a-k>extern</a-k><a-p> </a-p><a-s>&quot;C&quot;</a-s><a-p> </a-p><a-k>fn</a-k><a-p> </a-p><a-f>update</a-f><a-p>() {}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"><a-p>This function is called periodically by the runtime at the configured tick</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"><a-p>rate. The tick rate is 120 Hz by default, but can be changed by the auto</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-p>splitter.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"><a-p>In addition the WebAssembly module is expected to export a memory called</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"><a-p>`memory`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"><a-p>## </a-p><a-tt>API exposed to the Auto Splitters</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-p>The following functions are provided to the auto splitters in the module</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-p>`env`:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p>```</a-p><a-tl>rust</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"><a-p>#[repr(transparent)]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"><a-p>pub </a-p><a-k>struct</a-k><a-p> </a-p><a-t>Address</a-t><a-p>(</a-p><a-k>pub</a-k><a-p> </a-p><a-t>u64</a-t><a-p>);</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"><a-p>#[repr(transparent)]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"><a-p>pub </a-p><a-k>struct</a-k><a-p> </a-p><a-t>NonZeroAddress</a-t><a-p>(</a-p><a-k>pub</a-k><a-p> </a-p><a-t>NonZeroU64</a-t><a-p>);</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"><a-p>#[repr(transparent)]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"><a-p>pub </a-p><a-k>struct</a-k><a-p> </a-p><a-t>ProcessId</a-t><a-p>(</a-p><a-t>NonZeroU64</a-t><a-p>);</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"><a-p>#[repr(transparent)]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"><a-p>pub </a-p><a-k>struct</a-k><a-p> </a-p><a-t>TimerState</a-t><a-p>(</a-p><a-t>u32</a-t><a-p>);</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"><a-p>impl </a-p><a-t>TimerState</a-t><a-p> {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"><a-p>    </a-p><a-c>/// The timer is not running.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"><a-p>    </a-p><a-k>pub</a-k><a-p> </a-p><a-k>const</a-k><a-p> </a-p><a-cr>NOT_RUNNING</a-cr><a-p>: </a-p><a-t>Self</a-t><a-p> = </a-p><a-f>Self</a-f><a-p>(</a-p><a-co>0</a-co><a-p>);</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"><a-p>    </a-p><a-c>/// The timer is running.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"><a-p>    </a-p><a-k>pub</a-k><a-p> </a-p><a-k>const</a-k><a-p> </a-p><a-cr>RUNNING</a-cr><a-p>: </a-p><a-t>Self</a-t><a-p> = </a-p><a-f>Self</a-f><a-p>(</a-p><a-co>1</a-co><a-p>);</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"><a-p>    </a-p><a-c>/// The timer started but got paused. This is separate from the game</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"><a-p>    </a-p><a-c>/// time being paused. Game time may even always be paused.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"><a-p>    </a-p><a-k>pub</a-k><a-p> </a-p><a-k>const</a-k><a-p> </a-p><a-cr>PAUSED</a-cr><a-p>: </a-p><a-t>Self</a-t><a-p> = </a-p><a-f>Self</a-f><a-p>(</a-p><a-co>2</a-co><a-p>);</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"><a-p>    </a-p><a-c>/// The timer has ended, but didn&#39;t get reset yet.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"><a-p>    </a-p><a-k>pub</a-k><a-p> </a-p><a-k>const</a-k><a-p> </a-p><a-cr>ENDED</a-cr><a-p>: </a-p><a-t>Self</a-t><a-p> = </a-p><a-f>Self</a-f><a-p>(</a-p><a-co>3</a-co><a-p>);</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text"><a-p>extern </a-p><a-s>&quot;C&quot;</a-s><a-p> {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text"><a-p>    </a-p><a-c>/// Gets the state that the timer currently is in.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text"><a-p>    </a-p><a-k>pub</a-k><a-p> </a-p><a-k>fn</a-k><a-p> </a-p><a-f>timer_get_state</a-f><a-p>() -&gt; </a-p><a-t>TimerState</a-t><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"><a-p>    </a-p><a-c>/// Starts the timer.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text"><a-p>    </a-p><a-k>pub</a-k><a-p> </a-p><a-k>fn</a-k><a-p> </a-p><a-f>timer_start</a-f><a-p>();</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text"><a-p>    </a-p><a-c>/// Splits the current segment.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"><a-p>    </a-p><a-k>pub</a-k><a-p> </a-p><a-k>fn</a-k><a-p> </a-p><a-f>timer_split</a-f><a-p>();</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text"><a-p>    </a-p><a-c>/// Resets the timer.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text"><a-p>    </a-p><a-k>pub</a-k><a-p> </a-p><a-k>fn</a-k><a-p> </a-p><a-f>timer_reset</a-f><a-p>();</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text"><a-p>    </a-p><a-c>/// Sets a custom key value pair. This may be arbitrary information that</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text"><a-p>    </a-p><a-c>/// the auto splitter wants to provide for visualization.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text"><a-p>    </a-p><a-k>pub</a-k><a-p> </a-p><a-k>fn</a-k><a-p> </a-p><a-f>timer_set_variable</a-f><a-p>(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L67" href="#L67">67</a><span class="code-text"><a-p>        </a-p><a-v>key_ptr</a-v><a-p>: </a-p><a-o>*</a-o><a-k>const</a-k><a-p> </a-p><a-t>u8</a-t><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L68" href="#L68">68</a><span class="code-text"><a-p>        </a-p><a-v>key_len</a-v><a-p>: </a-p><a-t>usize</a-t><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text"><a-p>        </a-p><a-v>value_ptr</a-v><a-p>: </a-p><a-o>*</a-o><a-k>const</a-k><a-p> </a-p><a-t>u8</a-t><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text"><a-p>        </a-p><a-v>value_len</a-v><a-p>: </a-p><a-t>usize</a-t><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text"><a-p>    );</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text"><a-p>    </a-p><a-c>/// Sets the game time.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text"><a-p>    </a-p><a-k>pub</a-k><a-p> </a-p><a-k>fn</a-k><a-p> </a-p><a-f>timer_set_game_time</a-f><a-p>(</a-p><a-v>secs</a-v><a-p>: </a-p><a-t>i64</a-t><a-p>, </a-p><a-v>nanos</a-v><a-p>: </a-p><a-t>i32</a-t><a-p>);</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text"><a-p>    </a-p><a-c>/// Pauses the game time. This does not pause the timer, only the</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L76" href="#L76">76</a><span class="code-text"><a-p>    </a-p><a-c>/// automatic flow of time for the game time.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L77" href="#L77">77</a><span class="code-text"><a-p>    </a-p><a-k>pub</a-k><a-p> </a-p><a-k>fn</a-k><a-p> </a-p><a-f>timer_pause_game_time</a-f><a-p>();</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L78" href="#L78">78</a><span class="code-text"><a-p>    </a-p><a-c>/// Resumes the game time. This does not resume the timer, only the</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L79" href="#L79">79</a><span class="code-text"><a-p>    </a-p><a-c>/// automatic flow of time for the game time.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L80" href="#L80">80</a><span class="code-text"><a-p>    </a-p><a-k>pub</a-k><a-p> </a-p><a-k>fn</a-k><a-p> </a-p><a-f>timer_resume_game_time</a-f><a-p>();</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L81" href="#L81">81</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L82" href="#L82">82</a><span class="code-text"><a-p>    </a-p><a-c>/// Attaches to a process based on its name.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L83" href="#L83">83</a><span class="code-text"><a-p>    </a-p><a-k>pub</a-k><a-p> </a-p><a-k>fn</a-k><a-p> </a-p><a-f>process_attach</a-f><a-p>(</a-p><a-v>name_ptr</a-v><a-p>: </a-p><a-o>*</a-o><a-k>const</a-k><a-p> </a-p><a-t>u8</a-t><a-p>, </a-p><a-v>name_len</a-v><a-p>: </a-p><a-t>usize</a-t><a-p>) -&gt; </a-p><a-t>Option</a-t><a-p>&lt;</a-p><a-t>ProcessId</a-t><a-p>&gt;;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L84" href="#L84">84</a><span class="code-text"><a-p>    </a-p><a-c>/// Detaches from a process.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L85" href="#L85">85</a><span class="code-text"><a-p>    </a-p><a-k>pub</a-k><a-p> </a-p><a-k>fn</a-k><a-p> </a-p><a-f>process_detach</a-f><a-p>(</a-p><a-v>process</a-v><a-p>: </a-p><a-t>ProcessId</a-t><a-p>);</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L86" href="#L86">86</a><span class="code-text"><a-p>    </a-p><a-c>/// Checks whether is a process is still open. You should detach from a</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L87" href="#L87">87</a><span class="code-text"><a-p>    </a-p><a-c>/// process and stop using it if this returns `false`.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L88" href="#L88">88</a><span class="code-text"><a-p>    </a-p><a-k>pub</a-k><a-p> </a-p><a-k>fn</a-k><a-p> </a-p><a-f>process_is_open</a-f><a-p>(</a-p><a-v>process</a-v><a-p>: </a-p><a-t>ProcessId</a-t><a-p>) -&gt; </a-p><a-t>bool</a-t><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L89" href="#L89">89</a><span class="code-text"><a-p>    </a-p><a-c>/// Reads memory from a process at the address given. This will write</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L90" href="#L90">90</a><span class="code-text"><a-p>    </a-p><a-c>/// the memory to the buffer given. Returns `false` if this fails.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L91" href="#L91">91</a><span class="code-text"><a-p>    </a-p><a-k>pub</a-k><a-p> </a-p><a-k>fn</a-k><a-p> </a-p><a-f>process_read</a-f><a-p>(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L92" href="#L92">92</a><span class="code-text"><a-p>        </a-p><a-v>process</a-v><a-p>: </a-p><a-t>ProcessId</a-t><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L93" href="#L93">93</a><span class="code-text"><a-p>        </a-p><a-v>address</a-v><a-p>: </a-p><a-t>Address</a-t><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L94" href="#L94">94</a><span class="code-text"><a-p>        </a-p><a-v>buf_ptr</a-v><a-p>: </a-p><a-o>*</a-o><a-k>mut</a-k><a-p> </a-p><a-t>u8</a-t><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L95" href="#L95">95</a><span class="code-text"><a-p>        </a-p><a-v>buf_len</a-v><a-p>: </a-p><a-t>usize</a-t><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L96" href="#L96">96</a><span class="code-text"><a-p>    ) -&gt; </a-p><a-t>bool</a-t><a-p>;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L97" href="#L97">97</a><span class="code-text"><a-p>    </a-p><a-c>/// Gets the address of a module in a process.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L98" href="#L98">98</a><span class="code-text"><a-p>    </a-p><a-k>pub</a-k><a-p> </a-p><a-k>fn</a-k><a-p> </a-p><a-f>process_get_module_address</a-f><a-p>(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L99" href="#L99">99</a><span class="code-text"><a-p>        </a-p><a-v>process</a-v><a-p>: </a-p><a-t>ProcessId</a-t><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L100" href="#L100">100</a><span class="code-text"><a-p>        </a-p><a-v>name_ptr</a-v><a-p>: </a-p><a-o>*</a-o><a-k>const</a-k><a-p> </a-p><a-t>u8</a-t><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L101" href="#L101">101</a><span class="code-text"><a-p>        </a-p><a-v>name_len</a-v><a-p>: </a-p><a-t>usize</a-t><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L102" href="#L102">102</a><span class="code-text"><a-p>    ) -&gt; </a-p><a-t>Option</a-t><a-p>&lt;</a-p><a-t>NonZeroAddress</a-t><a-p>&gt;;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L103" href="#L103">103</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L104" href="#L104">104</a><span class="code-text"><a-p>    </a-p><a-c>/// Sets the tick rate of the runtime. This influences the amount of</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L105" href="#L105">105</a><span class="code-text"><a-p>    </a-p><a-c>/// times the `update` function is called per second.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L106" href="#L106">106</a><span class="code-text"><a-p>    </a-p><a-k>pub</a-k><a-p> </a-p><a-k>fn</a-k><a-p> </a-p><a-f>runtime_set_tick_rate</a-f><a-p>(</a-p><a-v>ticks_per_second</a-v><a-p>: </a-p><a-t>f64</a-t><a-p>);</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L107" href="#L107">107</a><span class="code-text"><a-p>    </a-p><a-c>/// Prints a log message for debugging purposes.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L108" href="#L108">108</a><span class="code-text"><a-p>    </a-p><a-k>pub</a-k><a-p> </a-p><a-k>fn</a-k><a-p> </a-p><a-f>runtime_print_message</a-f><a-p>(</a-p><a-v>text_ptr</a-v><a-p>: </a-p><a-o>*</a-o><a-k>const</a-k><a-p> </a-p><a-t>u8</a-t><a-p>, </a-p><a-v>text_len</a-v><a-p>: </a-p><a-t>usize</a-t><a-p>);</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L109" href="#L109">109</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L110" href="#L110">110</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L111" href="#L111">111</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L112" href="#L112">112</a><span class="code-text">On top of the runtime&#39;s API, there&#39;s also unstable `WASI` support via the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L113" href="#L113">113</a><span class="code-text">`unstable` feature.</span></span></pre></div></div>
</main>
</body>
</html>
