1
0
Fork 0
mirror of https://github.com/ganelson/inform.git synced 2024-07-08 10:04:21 +03:00
inform7/docs/WorldModelKit/S-ft.html
2020-04-07 01:06:09 +01:00

94 lines
6 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>S/at2</title>
<meta name="viewport" content="width=device-width initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta http-equiv="Content-Language" content="en-gb">
<link href="../inweb.css" rel="stylesheet" rev="stylesheet" type="text/css">
</head>
<body>
<nav role="navigation">
<h1><a href="../webs.html">Sources</a></h1>
<ul>
<li><a href="../compiler.html">compiler tools</a></li>
<li><a href="../other.html">other tools</a></li>
<li><a href="../extensions.html"><b>extensions and kits</b></a></li>
<li><a href="../units.html">unit test tools</a></li>
</ul>
<h2>Extensions</h2>
<ul>
<li><a href="../basic_inform/index.html">Basic Inform</a></li>
<li><a href="../standard_rules/index.html">Standard Rules</a></li>
</ul>
<h2>Kits</h2>
<ul>
<li><a href="../BasicInformKit/index.html">BasicInformKit</a></li>
<li><a href="../BasicInformExtrasKit/index.html">BasicInformExtrasKit</a></li>
<li><a href="../CommandParserKit/index.html">CommandParserKit</a></li>
<li><a href="../EnglishLanguageKit/index.html">EnglishLanguageKit</a></li>
<li><a href="../WorldModelKit/index.html">WorldModelKit</a></li>
</ul>
</nav>
<main role="main">
<!--Weave of 'S/ft' generated by 7-->
<ul class="crumbs"><li><a href="../webs.html">Source</a></li><li><a href="../extensions.html">Kits</a></li><li><a href="index.html">WorldModelKit</a></li><li><b>Figures Template</b></li></ul><p class="purpose">To display figures and play sound effects.</p>
<ul class="toc"><li><a href="#SP1">&#167;1. Resource Usage</a></li><li><a href="#SP2">&#167;2. Figures</a></li><li><a href="#SP3">&#167;3. Sound Effects</a></li></ul><hr class="tocbar">
<p class="inwebparagraph"><a id="SP1"></a><b>&#167;1. Resource Usage. </b>We record whether pictures or sounds have been used before by storing
single byte flags in the following array. (The extra 5 values allow for the
fact that it can be legal to use low undeclared sound effect resource
numbers in the Z-machine for short beeps, though this is deprecated in I7.)
</p>
<p class="inwebparagraph">Pictures and sounds are identified within blorb archives by resource ID
numbers which count upwards from 1 in order of creation, but can mix
pictures and sounds freely. (For instance, 1 might be a picture, 2 and 3
sound effects, then 4 a picture again, etc.) ID number 1 is in fact always
a picture: it means the cover art, and is the I6 representation of the
value "figure of cover".
</p>
<pre class="display">
<span class="reserved">Array</span><span class="plain"> </span><span class="identifier">ResourceUsageFlags</span><span class="plain"> -&gt; (</span><span class="identifier">ICOUNT_FIGURE_NAME</span><span class="plain"> + </span><span class="identifier">ICOUNT_SOUND_NAME</span><span class="plain"> + </span><span class="constant">5</span><span class="plain">);</span>
</pre>
<p class="inwebparagraph"></p>
<p class="inwebparagraph"><a id="SP2"></a><b>&#167;2. Figures. </b></p>
<pre class="display">
<span class="plain">[ </span><span class="identifier">DisplayFigure</span><span class="plain"> </span><span class="identifier">resource_ID</span><span class="plain"> </span><span class="identifier">one_time</span><span class="plain">;</span>
<span class="reserved">if</span><span class="plain"> ((</span><span class="identifier">one_time</span><span class="plain">) &amp;&amp; (</span><span class="identifier">ResourceUsageFlags</span><span class="plain">-&gt;</span><span class="identifier">resource_ID</span><span class="plain">)) </span><span class="reserved">return</span><span class="plain">;</span>
<span class="identifier">ResourceUsageFlags</span><span class="plain">-&gt;</span><span class="identifier">resource_ID</span><span class="plain"> = </span><span class="reserved">true</span><span class="plain">;</span>
<span class="reserved">print</span><span class="plain"> </span><span class="string">"^"</span><span class="plain">; </span><span class="identifier">VM_Picture</span><span class="plain">(</span><span class="identifier">resource_ID</span><span class="plain">); </span><span class="reserved">print</span><span class="plain"> </span><span class="string">"^"</span><span class="plain">;</span>
<span class="plain">];</span>
</pre>
<p class="inwebparagraph"></p>
<p class="inwebparagraph"><a id="SP3"></a><b>&#167;3. Sound Effects. </b></p>
<pre class="display">
<span class="plain">[ </span><span class="identifier">PlaySound</span><span class="plain"> </span><span class="identifier">resource_ID</span><span class="plain"> </span><span class="identifier">one_time</span><span class="plain">;</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">resource_ID</span><span class="plain"> == </span><span class="constant">0</span><span class="plain">) </span><span class="reserved">return</span><span class="plain">; </span><span class="comment">The "silence" non-sound effect</span>
<span class="reserved">if</span><span class="plain"> ((</span><span class="identifier">one_time</span><span class="plain">) &amp;&amp; (</span><span class="identifier">ResourceUsageFlags</span><span class="plain">-&gt;</span><span class="identifier">resource_ID</span><span class="plain">)) </span><span class="reserved">return</span><span class="plain">;</span>
<span class="identifier">ResourceUsageFlags</span><span class="plain">-&gt;</span><span class="identifier">resource_ID</span><span class="plain"> = </span><span class="reserved">true</span><span class="plain">;</span>
<span class="identifier">VM_SoundEffect</span><span class="plain">(</span><span class="identifier">resource_ID</span><span class="plain">);</span>
<span class="plain">];</span>
</pre>
<p class="inwebparagraph"></p>
<hr class="tocbar">
<ul class="toc"><li><a href="S-at2.html">Back to 'Activities Template'</a></li><li><a href="S-ot3.html">Continue with 'OutOfWorld Template'</a></li></ul><hr class="tocbar">
<!--End of weave-->
</main>
</body>
</html>