mirror of https://github.com/zeldaret/tmc
253 lines
16 KiB
HTML
253 lines
16 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8" />
|
|
<title>include/script.h file | The Minish Cap Docs</title>
|
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
|
|
<link rel="stylesheet" href="m-dark+documentation.compiled.css" />
|
|
<link rel="stylesheet" href="style.css" />
|
|
<link rel="icon" href="https://zelda64.dev/favicon.ico" type="image/vnd.microsoft.icon" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<meta name="theme-color" content="#22272e" />
|
|
</head>
|
|
<body>
|
|
<header><nav id="navigation">
|
|
<div class="m-container">
|
|
<div class="m-row">
|
|
<span id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m">
|
|
<a href="https://github.com/zeldaret/tmc">The Minish Cap</a> <span class="m-breadcrumb">|</span> <a href="index.html" class="m-thin">Docs</a>
|
|
</span>
|
|
<div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
|
|
<a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
|
|
<path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/>
|
|
</svg></a>
|
|
<a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
|
|
<a id="m-navbar-hide" href="#" title="Hide navigation"></a>
|
|
</div>
|
|
<div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
|
|
<div class="m-row">
|
|
<ol class="m-col-t-6 m-col-m-none">
|
|
<li><a href="modules.html">Modules</a></li>
|
|
<li><a href="pages.html">Pages</a></li>
|
|
</ol>
|
|
<ol class="m-col-t-6 m-col-m-none" start="3">
|
|
<li><a href="annotated.html">Classes</a></li>
|
|
<li><a href="files.html">Files</a></li>
|
|
<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
|
|
<use href="#m-doc-search-icon-path" />
|
|
</svg></a></li>
|
|
</ol>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</nav></header>
|
|
<main><article>
|
|
<div class="m-container m-container-inflatable">
|
|
<div class="m-row">
|
|
<div class="m-col-l-10 m-push-l-1">
|
|
<h1>
|
|
<span class="m-breadcrumb"><a href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a>/</span>script.h <span class="m-thin">file</span>
|
|
</h1>
|
|
<p><span></span></p>
|
|
<nav class="m-block m-default">
|
|
<h3>Contents</h3>
|
|
<ul>
|
|
<li>
|
|
Reference
|
|
<ul>
|
|
<li><a href="#nested-classes">Classes</a></li>
|
|
<li><a href="#enum-members">Enums</a></li>
|
|
<li><a href="#typedef-members">Typedefs</a></li>
|
|
<li><a href="#func-members">Functions</a></li>
|
|
<li><a href="#var-members">Variables</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<section id="nested-classes">
|
|
<h2><a href="#nested-classes">Classes</a></h2>
|
|
<dl class="m-doc">
|
|
<dt>
|
|
struct <a href="structScriptExecutionContext.html" class="m-doc">ScriptExecutionContext</a>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
<dt>
|
|
struct <a href="structActiveScriptInfo.html" class="m-doc">ActiveScriptInfo</a>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
</dl>
|
|
</section>
|
|
<section id="enum-members">
|
|
<h2><a href="#enum-members">Enums</a></h2>
|
|
<dl class="m-doc">
|
|
<dt id="aeea90390d6a8252704a6002f4d58ef3f">
|
|
<span class="m-doc-wrap-bumper">enum <a href="#aeea90390d6a8252704a6002f4d58ef3f" class="m-doc-self">SetMessageValueIndex</a> { </span><span class="m-doc-wrap"><a href="#aeea90390d6a8252704a6002f4d58ef3fa92c984a5e44c3d54a2dd665087665b94" class="m-doc">SMV_DEFAULT</a>,
|
|
<a href="#aeea90390d6a8252704a6002f4d58ef3fa65bdbfad6f86eefad7120671fb0f6b8b" class="m-doc">SMV_RUPEES</a>,
|
|
<a href="#aeea90390d6a8252704a6002f4d58ef3fa63cef8ee144b34c2a8a0344fb3b4ef07" class="m-doc">SMV_FIELD_0X14</a>,
|
|
<a href="#aeea90390d6a8252704a6002f4d58ef3fa04163ed9046b6137905121d8830a6641" class="m-doc">SMV_FIELD_0X18</a>,
|
|
<a href="#aeea90390d6a8252704a6002f4d58ef3fa799c08a1e9f4f536b766733784954732" class="m-doc">SMV_FIELD_0X1C</a> }</span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
</dl>
|
|
</section>
|
|
<section id="typedef-members">
|
|
<h2><a href="#typedef-members">Typedefs</a></h2>
|
|
<dl class="m-doc">
|
|
<dt id="ae4ed2d86bbfdcc0225129e15c3257d0c">
|
|
using <a href="#ae4ed2d86bbfdcc0225129e15c3257d0c" class="m-doc-self">Script</a> = <a href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa" class="m-doc">u16</a>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
</dl>
|
|
</section>
|
|
<section id="func-members">
|
|
<h2><a href="#func-members">Functions</a></h2>
|
|
<dl class="m-doc">
|
|
<dt id="ad472fc3991a574ac41774cb4202b8b75">
|
|
<span class="m-doc-wrap-bumper">auto <a href="#ad472fc3991a574ac41774cb4202b8b75" class="m-doc-self">CreateScriptExecutionContext</a>(</span><span class="m-doc-wrap">void) -> <a href="structScriptExecutionContext.html" class="m-doc">ScriptExecutionContext</a>*</span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
<dt id="acc617dcdb19abd71833e789ea3a88b3f">
|
|
<span class="m-doc-wrap-bumper">void <a href="#acc617dcdb19abd71833e789ea3a88b3f" class="m-doc-self">InitScriptForEntity</a>(</span><span class="m-doc-wrap"><a href="structEntity.html" class="m-doc">Entity</a>* entity,
|
|
<a href="structScriptExecutionContext.html" class="m-doc">ScriptExecutionContext</a>* context,
|
|
<a href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa" class="m-doc">u16</a>* script)</span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
<dt id="a3f5853fdb44d86de82ef363dad7d873d">
|
|
<span class="m-doc-wrap-bumper">void <a href="#a3f5853fdb44d86de82ef363dad7d873d" class="m-doc-self">ExecuteScript</a>(</span><span class="m-doc-wrap"><a href="structEntity.html" class="m-doc">Entity</a>* entity,
|
|
<a href="structScriptExecutionContext.html" class="m-doc">ScriptExecutionContext</a>* context)</span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
<dt id="ace5d681d949721840d259b609d2b0872">
|
|
<span class="m-doc-wrap-bumper">auto <a href="#ace5d681d949721840d259b609d2b0872" class="m-doc-self">GetNextScriptCommandHalfword</a>(</span><span class="m-doc-wrap"><a href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa" class="m-doc">u16</a>*) -> <a href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba" class="m-doc">u32</a></span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
<dt id="ad8810152dcaefbe4394baf4e4b6060ff">
|
|
<span class="m-doc-wrap-bumper">auto <a href="#ad8810152dcaefbe4394baf4e4b6060ff" class="m-doc-self">GetNextScriptCommandWord</a>(</span><span class="m-doc-wrap"><a href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa" class="m-doc">u16</a>*) -> <a href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba" class="m-doc">u32</a></span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
<dt id="ace13f105c9bd8d61dbe2b38209bbe720">
|
|
<span class="m-doc-wrap-bumper">auto <a href="#ace13f105c9bd8d61dbe2b38209bbe720" class="m-doc-self">GetNextScriptCommandWordAfterCommandMetadata</a>(</span><span class="m-doc-wrap"><a href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa" class="m-doc">u16</a>*) -> <a href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba" class="m-doc">u32</a></span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
<dt id="ae273b347b66c89a86eef440d86a7ce1f">
|
|
<span class="m-doc-wrap-bumper">auto <a href="#ae273b347b66c89a86eef440d86a7ce1f" class="m-doc-self">GetNextScriptCommandHalfwordAfterCommandMetadata</a>(</span><span class="m-doc-wrap"><a href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa" class="m-doc">u16</a>*) -> <a href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba" class="m-doc">u32</a></span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
<dt id="a2d77c7c29af5845549eda594594e72bd">
|
|
<span class="m-doc-wrap-bumper">void <a href="#a2d77c7c29af5845549eda594594e72bd" class="m-doc-self">UnloadCutsceneData</a>(</span><span class="m-doc-wrap"><a href="structEntity.html" class="m-doc">Entity</a>* entity)</span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
<dt id="a41574d509f554052ec5f856875243290">
|
|
<span class="m-doc-wrap-bumper">void <a href="#a41574d509f554052ec5f856875243290" class="m-doc-self">StartPlayerScript</a>(</span><span class="m-doc-wrap"><a href="script_8h.html#ae4ed2d86bbfdcc0225129e15c3257d0c" class="m-doc">Script</a>* script)</span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
<dt id="a9e2da97795eca48b7d0830c27e069d37">
|
|
<span class="m-doc-wrap-bumper">void <a href="#a9e2da97795eca48b7d0830c27e069d37" class="m-doc-self">InitScriptForNPC</a>(</span><span class="m-doc-wrap"><a href="structEntity.html" class="m-doc">Entity</a>* entity)</span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
<dt id="ab938bc56269269470025216c52801876">
|
|
<span class="m-doc-wrap-bumper">void <a href="#ab938bc56269269470025216c52801876" class="m-doc-self">sub_0807DD64</a>(</span><span class="m-doc-wrap"><a href="structEntity.html" class="m-doc">Entity</a>* entity)</span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
<dt id="a1ed73ad9cf46fa44059652b2609159a1">
|
|
<span class="m-doc-wrap-bumper">void <a href="#a1ed73ad9cf46fa44059652b2609159a1" class="m-doc-self">sub_0807DD80</a>(</span><span class="m-doc-wrap"><a href="structEntity.html" class="m-doc">Entity</a>* entity,
|
|
<a href="script_8h.html#ae4ed2d86bbfdcc0225129e15c3257d0c" class="m-doc">Script</a>* script)</span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
<dt id="a2e065dce918ae8b8833305ca5b8ad36d">
|
|
<span class="m-doc-wrap-bumper">void <a href="#a2e065dce918ae8b8833305ca5b8ad36d" class="m-doc-self">LookAt</a>(</span><span class="m-doc-wrap"><a href="structEntity.html" class="m-doc">Entity</a>* entity,
|
|
<a href="structScriptExecutionContext.html" class="m-doc">ScriptExecutionContext</a>* context,
|
|
<a href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba" class="m-doc">u32</a> x,
|
|
<a href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba" class="m-doc">u32</a> y)</span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
<dt id="a8be7724c25539e7904a6b2d9034a114f">
|
|
<span class="m-doc-wrap-bumper">auto <a href="#a8be7724c25539e7904a6b2d9034a114f" class="m-doc-self">StartCutscene</a>(</span><span class="m-doc-wrap"><a href="structEntity.html" class="m-doc">Entity</a>* entity,
|
|
<a href="script_8h.html#ae4ed2d86bbfdcc0225129e15c3257d0c" class="m-doc">Script</a>* script) -> <a href="structScriptExecutionContext.html" class="m-doc">ScriptExecutionContext</a>*</span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
<dt id="a8ef6da3bb8f1f3dc495bedb52171b55d">
|
|
<span class="m-doc-wrap-bumper">void <a href="#a8ef6da3bb8f1f3dc495bedb52171b55d" class="m-doc-self">ExecuteScriptForEntity</a>(</span><span class="m-doc-wrap"><a href="structEntity.html" class="m-doc">Entity</a>* entity,
|
|
void(*)(<a href="structEntity.html" class="m-doc">Entity</a>*, <a href="structScriptExecutionContext.html" class="m-doc">ScriptExecutionContext</a>*) postScriptCallback)</span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
<dt id="a76ca89762e4eb71f6cb35944bf7a3086">
|
|
<span class="m-doc-wrap-bumper">void <a href="#a76ca89762e4eb71f6cb35944bf7a3086" class="m-doc-self">HandlePostScriptActions</a>(</span><span class="m-doc-wrap"><a href="structEntity.html" class="m-doc">Entity</a>* entity,
|
|
<a href="structScriptExecutionContext.html" class="m-doc">ScriptExecutionContext</a>* context)</span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
<dt id="a483baba62666a46cc22c5638983417a0">
|
|
<span class="m-doc-wrap-bumper">void <a href="#a483baba62666a46cc22c5638983417a0" class="m-doc-self">HandleEntity0x82Actions</a>(</span><span class="m-doc-wrap"><a href="structEntity.html" class="m-doc">Entity</a>* entity)</span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
<dt id="aabb2a92c483415af79f55c040b45648c">
|
|
<span class="m-doc-wrap-bumper">void <a href="#aabb2a92c483415af79f55c040b45648c" class="m-doc-self">ExecuteScriptAndHandleAnimation</a>(</span><span class="m-doc-wrap"><a href="structEntity.html" class="m-doc">Entity</a>* entity,
|
|
void(*)(<a href="structEntity.html" class="m-doc">Entity</a>*, <a href="structScriptExecutionContext.html" class="m-doc">ScriptExecutionContext</a>*) postScriptCallback)</span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
</dl>
|
|
</section>
|
|
<section id="var-members">
|
|
<h2><a href="#var-members">Variables</a></h2>
|
|
<dl class="m-doc">
|
|
<dt id="a04bd1efd179aa06a402f30fb2c0c6c5a">
|
|
<a href="structActiveScriptInfo.html" class="m-doc">ActiveScriptInfo</a> <a href="#a04bd1efd179aa06a402f30fb2c0c6c5a" class="m-doc-self">gActiveScriptInfo</a>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
</dl>
|
|
</section>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</article></main>
|
|
<div class="m-doc-search" id="search">
|
|
<a href="#!" onclick="return hideSearch()"></a>
|
|
<div class="m-container">
|
|
<div class="m-row">
|
|
<div class="m-col-m-8 m-push-m-2">
|
|
<div class="m-doc-search-header m-text m-small">
|
|
<div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
|
|
<div id="search-symbolcount">…</div>
|
|
</div>
|
|
<div class="m-doc-search-content">
|
|
<form>
|
|
<input type="search" name="q" id="search-input" placeholder="Loading …" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" />
|
|
</form>
|
|
<noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript>
|
|
<div id="search-help" class="m-text m-dim m-text-center">
|
|
<p class="m-noindent">Search for symbols, directories, files, pages or
|
|
modules. You can omit any prefix from the symbol or file path; adding a
|
|
<code>:</code> or <code>/</code> suffix lists all members of given symbol or
|
|
directory.</p>
|
|
<p class="m-noindent">Use <span class="m-label m-dim">↓</span>
|
|
/ <span class="m-label m-dim">↑</span> to navigate through the list,
|
|
<span class="m-label m-dim">Enter</span> to go.
|
|
<span class="m-label m-dim">Tab</span> autocompletes common prefix, you can
|
|
copy a link to the result using <span class="m-label m-dim">⌘</span>
|
|
<span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span>
|
|
<span class="m-label m-dim">M</span> produces a Markdown link.</p>
|
|
</div>
|
|
<div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div>
|
|
<ul id="search-results"></ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<script src="search-v2.js"></script>
|
|
<script>
|
|
Search.download(window.location.pathname.substr(0, window.location.pathname.lastIndexOf('/') + 1) + 'searchdata-v2.bin');
|
|
</script>
|
|
<footer><nav>
|
|
<div class="m-container">
|
|
<div class="m-row">
|
|
<div class="m-col-l-10 m-push-l-1">
|
|
<p>The Minish Cap Docs. Created with <a href="https://doxygen.org/">Doxygen</a> 1.9.1 and <a href="https://mcss.mosra.cz/">m.css</a>.</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</nav></footer>
|
|
</body>
|
|
</html>
|