1
0
Fork 0
mirror of https://github.com/ganelson/inform.git synced 2024-07-08 10:04:21 +03:00
inform7/docs/standard_rules/S-prm.html
2020-04-15 23:49:59 +01:00

123 lines
19 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>Preamble</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="../index.html">
<img src="../docs-src/Figures/Inform.png" height=72">
</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">extensions and kits</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="index.html"><span class="selectedlink">standard_rules</span></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 'Preamble' generated by 7-->
<ul class="crumbs"><li><a href="../index.html">Home</a></li><li><a href="../extensions.html">Extensions</a></li><li><a href="index.html">srules</a></li><li><b>Preamble</b></li></ul><p class="purpose">The titling line and rubric, use options and a few other preliminaries before the Standard Rules get properly started.</p>
<ul class="toc"><li><a href="S-prm.html#SP1">&#167;1. Title</a></li><li><a href="S-prm.html#SP2">&#167;2. Verbs</a></li><li><a href="S-prm.html#SP4">&#167;4. Use Options</a></li></ul><hr class="tocbar">
<p class="inwebparagraph"><a id="SP1"></a><b>&#167;1. Title. </b>Every Inform 7 extension begins with a standard titling line and a
rubric text, and the Standard Rules are no exception:
</p>
<pre class="display">
<span class="identifier">Version</span><span class="plain"> [[</span><span class="identifier">Version</span><span class="plain"> </span><span class="identifier">Number</span><span class="plain">]] </span><span class="identifier">of</span><span class="plain"> </span><span class="identifier">the</span><span class="plain"> </span><span class="identifier">Standard</span><span class="plain"> </span><span class="identifier">Rules</span><span class="plain"> </span><span class="identifier">by</span><span class="plain"> </span><span class="identifier">Graham</span><span class="plain"> </span><span class="identifier">Nelson</span><span class="plain"> </span><span class="identifier">begins</span><span class="plain"> </span><span class="identifier">here</span><span class="plain">.</span>
<span class="string">"The Standard Rules, included in every project, define phrases, actions and</span>
<span class="string">activities for interactive fiction."</span>
<span class="identifier">Part</span><span class="plain"> </span><span class="identifier">One</span><span class="plain"> - </span><span class="identifier">Preamble</span>
</pre>
<p class="inwebparagraph"></p>
<p class="inwebparagraph"><a id="SP2"></a><b>&#167;2. Verbs. </b>This continues the built-in verbs (i.e. those with meaning built in to the
Inform compiler), adding those which are relevant only to IF.
</p>
<p class="inwebparagraph">Note the plus notation, added in May 2016, which marks for a second object
phrase, and is thus only useful for built-in meanings.
</p>
<pre class="display">
<span class="identifier">The</span><span class="plain"> </span><span class="identifier">verb</span><span class="plain"> </span><span class="identifier">to</span><span class="plain"> </span><span class="identifier">begin</span><span class="plain"> </span><span class="identifier">when</span><span class="plain"> </span><span class="identifier">means</span><span class="plain"> </span><span class="identifier">the</span><span class="plain"> </span><span class="identifier">built</span><span class="plain">-</span><span class="identifier">in</span><span class="plain"> </span><span class="identifier">scene</span><span class="plain">-</span><span class="identifier">begins</span><span class="plain">-</span><span class="identifier">when</span><span class="plain"> </span><span class="identifier">meaning</span><span class="plain">.</span>
<span class="identifier">The</span><span class="plain"> </span><span class="identifier">verb</span><span class="plain"> </span><span class="identifier">to</span><span class="plain"> </span><span class="identifier">end</span><span class="plain"> </span><span class="identifier">when</span><span class="plain"> </span><span class="identifier">means</span><span class="plain"> </span><span class="identifier">the</span><span class="plain"> </span><span class="identifier">built</span><span class="plain">-</span><span class="identifier">in</span><span class="plain"> </span><span class="identifier">scene</span><span class="plain">-</span><span class="identifier">ends</span><span class="plain">-</span><span class="identifier">when</span><span class="plain"> </span><span class="identifier">meaning</span><span class="plain">.</span>
<span class="identifier">The</span><span class="plain"> </span><span class="identifier">verb</span><span class="plain"> </span><span class="identifier">to</span><span class="plain"> </span><span class="identifier">end</span><span class="plain"> + </span><span class="identifier">when</span><span class="plain"> </span><span class="identifier">means</span><span class="plain"> </span><span class="identifier">the</span><span class="plain"> </span><span class="identifier">built</span><span class="plain">-</span><span class="identifier">in</span><span class="plain"> </span><span class="identifier">scene</span><span class="plain">-</span><span class="identifier">ends</span><span class="plain">-</span><span class="identifier">when</span><span class="plain"> </span><span class="identifier">meaning</span><span class="plain">.</span>
</pre>
<p class="inwebparagraph"></p>
<p class="inwebparagraph"><a id="SP3"></a><b>&#167;3. </b>Verbs used as imperatives: "Test ... with ...", for example.
</p>
<pre class="display">
<span class="identifier">The</span><span class="plain"> </span><span class="identifier">verb</span><span class="plain"> </span><span class="identifier">to</span><span class="plain"> </span><span class="identifier">test</span><span class="plain"> + </span><span class="identifier">with</span><span class="plain"> </span><span class="identifier">in</span><span class="plain"> </span><span class="identifier">the</span><span class="plain"> </span><span class="identifier">imperative</span><span class="plain"> </span><span class="identifier">means</span><span class="plain"> </span><span class="identifier">the</span><span class="plain"> </span><span class="identifier">built</span><span class="plain">-</span><span class="identifier">in</span><span class="plain"> </span><span class="identifier">test</span><span class="plain">-</span><span class="identifier">with</span><span class="plain"> </span><span class="identifier">meaning</span><span class="plain">.</span>
<span class="identifier">The</span><span class="plain"> </span><span class="identifier">verb</span><span class="plain"> </span><span class="identifier">to</span><span class="plain"> </span><span class="identifier">understand</span><span class="plain"> + </span><span class="identifier">as</span><span class="plain"> </span><span class="identifier">in</span><span class="plain"> </span><span class="identifier">the</span><span class="plain"> </span><span class="identifier">imperative</span><span class="plain"> </span><span class="identifier">means</span><span class="plain"> </span><span class="identifier">the</span><span class="plain"> </span><span class="identifier">built</span><span class="plain">-</span><span class="identifier">in</span><span class="plain"> </span><span class="identifier">understand</span><span class="plain">-</span><span class="identifier">as</span><span class="plain"> </span><span class="identifier">meaning</span><span class="plain">.</span>
<span class="identifier">The</span><span class="plain"> </span><span class="identifier">verb</span><span class="plain"> </span><span class="identifier">to</span><span class="plain"> </span><span class="identifier">release</span><span class="plain"> </span><span class="identifier">along</span><span class="plain"> </span><span class="identifier">with</span><span class="plain"> </span><span class="identifier">in</span><span class="plain"> </span><span class="identifier">the</span><span class="plain"> </span><span class="identifier">imperative</span><span class="plain"> </span><span class="identifier">means</span><span class="plain"> </span><span class="identifier">the</span><span class="plain"> </span><span class="identifier">built</span><span class="plain">-</span><span class="identifier">in</span><span class="plain"> </span><span class="identifier">release</span><span class="plain">-</span><span class="identifier">along</span><span class="plain">-</span><span class="identifier">with</span><span class="plain"> </span><span class="identifier">meaning</span><span class="plain">.</span>
<span class="identifier">The</span><span class="plain"> </span><span class="identifier">verb</span><span class="plain"> </span><span class="identifier">to</span><span class="plain"> </span><span class="identifier">index</span><span class="plain"> </span><span class="identifier">map</span><span class="plain"> </span><span class="identifier">with</span><span class="plain"> </span><span class="identifier">in</span><span class="plain"> </span><span class="identifier">the</span><span class="plain"> </span><span class="identifier">imperative</span><span class="plain"> </span><span class="identifier">means</span><span class="plain"> </span><span class="identifier">the</span><span class="plain"> </span><span class="identifier">built</span><span class="plain">-</span><span class="identifier">in</span><span class="plain"> </span><span class="identifier">index</span><span class="plain">-</span><span class="identifier">map</span><span class="plain">-</span><span class="identifier">with</span><span class="plain"> </span><span class="identifier">meaning</span><span class="plain">.</span>
</pre>
<p class="inwebparagraph"></p>
<p class="inwebparagraph"><a id="SP4"></a><b>&#167;4. Use Options. </b>In fact, many of the definitions below are handled slightly differently in
the <code class="display"><span class="extract">srules</span></code> template files, to avoid the need for conditional compilatipn
(and thus to enable the template to be assimilated just once); but we
continue to give them the traditional constant names, for the sake of any
third-party extensions using these.
</p>
<pre class="display">
<span class="identifier">Use</span><span class="plain"> </span><span class="identifier">command</span><span class="plain"> </span><span class="identifier">line</span><span class="plain"> </span><span class="identifier">echoing</span><span class="plain"> </span><span class="identifier">translates</span><span class="plain"> </span><span class="identifier">as</span><span class="plain"> (- </span><span class="identifier">Constant</span><span class="plain"> </span><span class="identifier">ECHO_COMMANDS</span><span class="plain">; -).</span>
<span class="identifier">Use</span><span class="plain"> </span><span class="identifier">full</span><span class="plain">-</span><span class="identifier">length</span><span class="plain"> </span><span class="identifier">room</span><span class="plain"> </span><span class="identifier">descriptions</span><span class="plain"> </span><span class="identifier">translates</span><span class="plain"> </span><span class="identifier">as</span><span class="plain"> (- #</span><span class="identifier">IFNDEF</span><span class="plain"> </span><span class="identifier">I7_LOOKMODE</span><span class="plain">; </span><span class="identifier">Constant</span><span class="plain"> </span><span class="identifier">I7_LOOKMODE</span><span class="plain"> = </span><span class="constant">2</span><span class="plain">; #</span><span class="identifier">ENDIF</span><span class="plain">; -).</span>
<span class="identifier">Use</span><span class="plain"> </span><span class="identifier">abbreviated</span><span class="plain"> </span><span class="identifier">room</span><span class="plain"> </span><span class="identifier">descriptions</span><span class="plain"> </span><span class="identifier">translates</span><span class="plain"> </span><span class="identifier">as</span><span class="plain"> (- #</span><span class="identifier">IFNDEF</span><span class="plain"> </span><span class="identifier">I7_LOOKMODE</span><span class="plain">; </span><span class="identifier">Constant</span><span class="plain"> </span><span class="identifier">I7_LOOKMODE</span><span class="plain"> = </span><span class="constant">3</span><span class="plain">; #</span><span class="identifier">ENDIF</span><span class="plain">; -).</span>
<span class="identifier">Use</span><span class="plain"> </span><span class="identifier">scoring</span><span class="plain"> </span><span class="identifier">translates</span><span class="plain"> </span><span class="identifier">as</span><span class="plain"> (- #</span><span class="identifier">IFNDEF</span><span class="plain"> </span><span class="identifier">USE_SCORING</span><span class="plain">; </span><span class="identifier">Constant</span><span class="plain"> </span><span class="identifier">USE_SCORING</span><span class="plain"> = </span><span class="constant">1</span><span class="plain">; #</span><span class="identifier">ENDIF</span><span class="plain">; -).</span>
<span class="identifier">Use</span><span class="plain"> </span><span class="identifier">no</span><span class="plain"> </span><span class="identifier">scoring</span><span class="plain"> </span><span class="identifier">translates</span><span class="plain"> </span><span class="identifier">as</span><span class="plain"> (- #</span><span class="identifier">IFNDEF</span><span class="plain"> </span><span class="identifier">USE_SCORING</span><span class="plain">; </span><span class="identifier">Constant</span><span class="plain"> </span><span class="identifier">USE_SCORING</span><span class="plain"> = </span><span class="constant">0</span><span class="plain">; #</span><span class="identifier">ENDIF</span><span class="plain">; -).</span>
<span class="identifier">Use</span><span class="plain"> </span><span class="identifier">manual</span><span class="plain"> </span><span class="identifier">pronouns</span><span class="plain"> </span><span class="identifier">translates</span><span class="plain"> </span><span class="identifier">as</span><span class="plain"> (- </span><span class="identifier">Constant</span><span class="plain"> </span><span class="identifier">MANUAL_PRONOUNS</span><span class="plain">; -).</span>
<span class="identifier">Use</span><span class="plain"> </span><span class="identifier">undo</span><span class="plain"> </span><span class="identifier">prevention</span><span class="plain"> </span><span class="identifier">translates</span><span class="plain"> </span><span class="identifier">as</span><span class="plain"> (- </span><span class="identifier">Constant</span><span class="plain"> </span><span class="identifier">PREVENT_UNDO</span><span class="plain">; -).</span>
<span class="identifier">Use</span><span class="plain"> </span><span class="identifier">VERBOSE</span><span class="plain"> </span><span class="identifier">room</span><span class="plain"> </span><span class="identifier">descriptions</span><span class="plain"> </span><span class="identifier">translates</span><span class="plain"> </span><span class="identifier">as</span><span class="plain"> (- </span><span class="identifier">Constant</span><span class="plain"> </span><span class="identifier">DEFAULT_VERBOSE_DESCRIPTIONS</span><span class="plain">; -).</span>
<span class="identifier">Use</span><span class="plain"> </span><span class="identifier">BRIEF</span><span class="plain"> </span><span class="identifier">room</span><span class="plain"> </span><span class="identifier">descriptions</span><span class="plain"> </span><span class="identifier">translates</span><span class="plain"> </span><span class="identifier">as</span><span class="plain"> (- </span><span class="identifier">Constant</span><span class="plain"> </span><span class="identifier">DEFAULT_BRIEF_DESCRIPTIONS</span><span class="plain">; -).</span>
<span class="identifier">Use</span><span class="plain"> </span><span class="identifier">SUPERBRIEF</span><span class="plain"> </span><span class="identifier">room</span><span class="plain"> </span><span class="identifier">descriptions</span><span class="plain"> </span><span class="identifier">translates</span><span class="plain"> </span><span class="identifier">as</span><span class="plain"> (- </span><span class="identifier">Constant</span><span class="plain"> </span><span class="identifier">DEFAULT_SUPERBRIEF_DESCRIPTIONS</span><span class="plain">; -).</span>
</pre>
<p class="inwebparagraph"></p>
<p class="inwebparagraph"><a id="SP5"></a><b>&#167;5. </b>This setting is to do with the command parser's handling of multiple objects.
Essentially it means that "take all" can pick up at most 100 items.
</p>
<pre class="display">
<span class="identifier">Use</span><span class="plain"> </span><span class="identifier">maximum</span><span class="plain"> </span><span class="identifier">things</span><span class="plain"> </span><span class="identifier">understood</span><span class="plain"> </span><span class="identifier">at</span><span class="plain"> </span><span class="identifier">once</span><span class="plain"> </span><span class="identifier">of</span><span class="plain"> </span><span class="identifier">at</span><span class="plain"> </span><span class="identifier">least</span><span class="plain"> </span><span class="constant">100</span><span class="plain"> </span><span class="identifier">translates</span><span class="plain"> </span><span class="identifier">as</span>
<span class="plain">(- </span><span class="identifier">Constant</span><span class="plain"> </span><span class="identifier">MATCH_LIST_WORDS</span><span class="plain"> = {</span><span class="identifier">N</span><span class="plain">}; -).</span>
<span class="identifier">Use</span><span class="plain"> </span><span class="identifier">maximum</span><span class="plain"> </span><span class="identifier">things</span><span class="plain"> </span><span class="identifier">understood</span><span class="plain"> </span><span class="identifier">at</span><span class="plain"> </span><span class="identifier">once</span><span class="plain"> </span><span class="identifier">of</span><span class="plain"> </span><span class="identifier">at</span><span class="plain"> </span><span class="identifier">least</span><span class="plain"> </span><span class="constant">100</span><span class="plain">.</span>
</pre>
<p class="inwebparagraph"></p>
<hr class="tocbar">
<ul class="toc"><li><i>(This section begins Sections.)</i></li><li><a href="S-pwm.html">Continue with 'Physical World Model'</a></li></ul><hr class="tocbar">
<!--End of weave-->
</main>
</body>
</html>