cqxqgtech/easy-scratch
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
master
easy-scratch/doc/scratch-vm/Thread.html

2856 lines
91 KiB
HTML
Raw Permalink Normal View History

easy-scratch项目源码
2025-02-12 12:27:32 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Thread - Documentation</title>
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
<script src="scripts/nav.js" defer></script>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav >
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="-_StackFrame.html">_StackFrame</a><ul class='methods'><li data-type='method'><a href="-_StackFrame.html#.create">create</a></li><li data-type='method'><a href="-_StackFrame.html#.release">release</a></li><li data-type='method'><a href="-_StackFrame.html#reset">reset</a></li><li data-type='method'><a href="-_StackFrame.html#reuse">reuse</a></li></ul></li><li><a href="BLE.html">BLE</a><ul class='methods'><li data-type='method'><a href="BLE.html#connectPeripheral">connectPeripheral</a></li><li data-type='method'><a href="BLE.html#didReceiveCall">didReceiveCall</a></li><li data-type='method'><a href="BLE.html#disconnect">disconnect</a></li><li data-type='method'><a href="BLE.html#handleDisconnectError">handleDisconnectError</a></li><li data-type='method'><a href="BLE.html#isConnected">isConnected</a></li><li data-type='method'><a href="BLE.html#read">read</a></li><li data-type='method'><a href="BLE.html#requestPeripheral">requestPeripheral</a></li><li data-type='method'><a href="BLE.html#startNotifications">startNotifications</a></li><li data-type='method'><a href="BLE.html#write">write</a></li></ul></li><li><a href="BlockCached.html">BlockCached</a></li><li><a href="Blocks.html">Blocks</a><ul class='methods'><li data-type='method'><a href="Blocks.html#_addScript">_addScript</a></li><li data-type='method'><a href="Blocks.html#_deleteScript">_deleteScript</a></li><li data-type='method'><a href="Blocks.html#_getBackdropField">_getBackdropField</a></li><li data-type='method'><a href="Blocks.html#_getBlockParams">_getBlockParams</a></li><li data-type='method'><a href="Blocks.html#_getCostumeField">_getCostumeField</a></li><li data-type='method'><a href="Blocks.html#_getCustomBlockInternal">_getCustomBlockInternal</a></li><li data-type='method'><a href="Blocks.html#_getSoundField">_getSoundField</a></li><li data-type='method'><a href="Blocks.html#_getSpriteField">_getSpriteField</a></li><li data-type='method'><a href="Blocks.html#blocklyListen">blocklyListen</a></li><li data-type='method'><a href="Blocks.html#blockToXML">blockToXML</a></li><li data-type='method'><a href="Blocks.html#changeBlock">changeBlock</a></li><li data-type='method'><a href="Blocks.html#createBlock">createBlock</a></li><li data-type='method'><a href="Blocks.html#deleteBlock">deleteBlock</a></li><li data-type='method'><a href="Blocks.html#emitProjectChanged">emitProjectChanged</a></li><li data-type='method'><a href="Blocks.html#getAllVariableAndListReferences">getAllVariableAndListReferences</a></li><li data-type='method'><a href="Blocks.html#getBlock">getBlock</a></li><li data-type='method'><a href="Blocks.html#getBranch">getBranch</a></li><li data-type='method'><a href="Blocks.html#getFields">getFields</a></li><li data-type='method'><a href="Blocks.html#getInputs">getInputs</a></li><li data-type='method'><a href="Blocks.html#getMutation">getMutation</a></li><li data-type='method'><a href="Blocks.html#getNextBlock">getNextBlock</a></li><li data-type='method'><a href="Blocks.html#getOpcode">getOpcode</a></li><li data-type='method'><a href="Blocks.html#getProcedureDefinition">getProcedureDefinition</a></li><li data-type='method'><a href="Blocks.html#getProcedureParamNamesAndIds">getProcedureParamNamesAndIds</a></li><li data-type='method'><a href="Blocks.html#getProcedureParamNamesIdsAndDefaults">getProcedureParamNamesIdsAndDefaults</a></li><li data-type='method'><a href="Blocks.html#getScripts">getScripts</a></li><li data-type='method'><a href="Blocks.html#getTopLevelScript">getTopLevelScript</a></li><li data-type='method'><a href="Blocks.html#moveBlock">moveBlock</a></li><li data-type='method'><a href="Blocks.html#mutationToXML">mutationToXML</a></li><li data-type='method'><a href="Blocks.html#resetCache">resetCache</a></li><li data-type='method'><a href="Blocks.html#runAllMonitored">runAllMonitored</a></li><li data-type='method'><a href="Blocks.html#toXML">toXML</a></li><li data-type='method'><a href="Blocks.html#updateAssetName">updateAssetName</a></li><li data-type='method'><a href
</nav>
<div id="main">
<h1 class="page-title">Thread</h1>
<section>
<header>
<h2>
Thread
</h2>
<div class="class-description"><p>A thread is a running stack context and all the metadata needed.</p></div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="Thread"><span class="type-signature"></span>new Thread<span class="signature">(firstBlock<span class="signature-attributes">nullable</span>)</span><span class="type-signature"></span></h4>
<dl class="details">
</dl>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>firstBlock</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;nullable><br>
</td>
<td class="description last"><p>First block to execute in the thread.</p></td>
</tr>
</tbody>
</table>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id=".STATUS_DONE"><span class="type-signature">(static, constant) </span>STATUS_DONE<span class="type-signature"></span></h4>
<dl class="details">
</dl>
<div class="description">
<p>Thread status for a finished/done thread.
Thread is in this state when there are no more blocks to execute.</p>
</div>
<h4 class="name" id=".STATUS_PROMISE_WAIT"><span class="type-signature">(static, constant) </span>STATUS_PROMISE_WAIT<span class="type-signature"></span></h4>
<dl class="details">
</dl>
<div class="description">
<p>Threads are in this state when a primitive is waiting on a promise;
execution is paused until the promise changes thread status.</p>
</div>
<h4 class="name" id=".STATUS_RUNNING"><span class="type-signature">(static, constant) </span>STATUS_RUNNING<span class="type-signature"></span></h4>
<dl class="details">
</dl>
<div class="description">
<p>Thread status for initialized or running thread.
This is the default state for a thread - execution should run normally,
stepping from block to block.</p>
</div>
<h4 class="name" id=".STATUS_YIELD"><span class="type-signature">(static, constant) </span>STATUS_YIELD<span class="type-signature"></span></h4>
<dl class="details">
</dl>
<div class="description">
<p>Thread status for yield.</p>
</div>
<h4 class="name" id=".STATUS_YIELD_TICK"><span class="type-signature">(static, constant) </span>STATUS_YIELD_TICK<span class="type-signature"></span></h4>
<dl class="details">
</dl>
<div class="description">
<p>Thread status for a single-tick yield. This will be cleared when the
thread is resumed.</p>
</div>
<h4 class="name" id="blockContainer"><span class="type-signature"></span>blockContainer<span class="type-signature"> :<a href="Blocks.html">Blocks</a></span></h4>
<dl class="details">
</dl>
<div class="description">
<p>The Blocks this thread will execute.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="Blocks.html">Blocks</a></span>
</li>
</ul>
<h4 class="name" id="blockGlowInFrame"><span class="type-signature">(nullable) </span>blockGlowInFrame<span class="type-signature"> :string</span></h4>
<dl class="details">
</dl>
<div class="description">
<p>Which block ID should glow during this frame, if any.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<h4 class="name" id="isKilled"><span class="type-signature"></span>isKilled<span class="type-signature"> :boolean</span></h4>
<dl class="details">
</dl>
<div class="description">
<p>Whether the thread is killed in the middle of execution.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">boolean</span>
</li>
</ul>
<h4 class="name" id="requestScriptGlowInFrame"><span class="type-signature"></span>requestScriptGlowInFrame<span class="type-signature"> :boolean</span></h4>
<dl class="details">
</dl>
<div class="description">
<p>Whether the thread requests its script to glow during this frame.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">boolean</span>
</li>
</ul>
<h4 class="name" id="stack"><span class="type-signature"></span>stack<span class="type-signature"> :Array.&lt;string></span></h4>
<dl class="details">
</dl>
<div class="description">
<p>Stack for the thread. When the sequencer enters a control structure,
the block is pushed onto the stack so we know where to exit.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.&lt;string></span>
</li>
</ul>
<h4 class="name" id="stackFrames"><span class="type-signature"></span>stackFrames<span class="type-signature"> :Array.&lt;<a href="-_StackFrame.html">_StackFrame</a>></span></h4>
<dl class="details">
</dl>
<div class="description">
<p>Stack frames for the thread. Store metadata for the executing blocks.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.&lt;<a href="-_StackFrame.html">_StackFrame</a>></span>
</li>
</ul>
<h4 class="name" id="status"><span class="type-signature"></span>status<span class="type-signature"> :number</span></h4>
<dl class="details">
</dl>
<div class="description">
<p>Status of the thread, one of three states (below)</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<h4 class="name" id="target"><span class="type-signature">(nullable) </span>target<span class="type-signature"> :<a href="Target.html">Target</a></span></h4>
<dl class="details">
</dl>
<div class="description">
<p>Target of this thread.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="Target.html">Target</a></span>
</li>
</ul>
<h4 class="name" id="topBlock"><span class="type-signature">(non-null) </span>topBlock<span class="type-signature"> :string</span></h4>
<dl class="details">
</dl>
<div class="description">
<p>ID of top block of the thread</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<h4 class="name" id="warpTimer"><span class="type-signature">(nullable) </span>warpTimer<span class="type-signature"> :<a href="Timer.html">Timer</a></span></h4>
<dl class="details">
</dl>
<div class="description">
<p>A timer for when the thread enters warp mode.
Substitutes the sequencer's count toward WORK_TIME on a per-thread basis.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="Timer.html">Timer</a></span>
</li>
</ul>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="atStackTop"><span class="type-signature"></span>atStackTop<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
<dl class="details">
</dl>
<div class="description">
<p>Whether the current execution of a thread is at the top of the stack.</p>
</div>
<h5>Returns:</h5>
<div class="param-desc">
<p>True if execution is at top of the stack.</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
<h4 class="name" id="getParam"><span class="type-signature"></span>getParam<span class="signature">(paramName<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> &rarr; {*}</span></h4>
<dl class="details">
</dl>
<div class="description">
<p>Get a parameter at the lowest possible level of the stack.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>paramName</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Name of parameter.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>value Value for parameter.</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">*</span>
</dd>
</dl>
<h4 class="name" id="goToNextBlock"><span class="type-signature"></span>goToNextBlock<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
</dl>
<div class="description">
<p>Switch the thread to the next block at the current level of the stack.
For example, this is used in a standard sequence of blocks,
where execution proceeds from one block to the next.</p>
</div>
<h4 class="name" id="initParams"><span class="type-signature"></span>initParams<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
</dl>
<div class="description">
<p>Initialize procedure parameters on this stack frame.</p>
</div>
<h4 class="name" id="isRecursiveCall"><span class="type-signature"></span>isRecursiveCall<span class="signature">(procedureCode<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
<dl class="details">
</dl>
<div class="description">
<p>Attempt to determine whether a procedure call is recursive,
by examining the stack.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>procedureCode</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Procedure code of procedure being called.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
<p>True if the call appears recursive.</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
<h4 class="name" id="peekParentStackFrame"><span class="type-signature"></span>peekParentStackFrame<span class="signature">()</span><span class="type-signature"> &rarr; (nullable) {object}</span></h4>
<dl class="details">
</dl>
<div class="description">
<p>Get stack frame above the current top.</p>
</div>
<h5>Returns:</h5>
<div class="param-desc">
<p>Second to last stack frame stored on this thread.</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
<h4 class="name" id="peekStack"><span class="type-signature"></span>peekStack<span class="signature">()</span><span class="type-signature"> &rarr; (nullable) {string}</span></h4>
<dl class="details">
</dl>
<div class="description">
<p>Get top stack item.</p>
</div>
<h5>Returns:</h5>
<div class="param-desc">
<p>Block ID on top of stack.</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id="peekStackFrame"><span class="type-signature"></span>peekStackFrame<span class="signature">()</span><span class="type-signature"> &rarr; (nullable) {object}</span></h4>
<dl class="details">
</dl>
<div class="description">
<p>Get top stack frame.</p>
</div>
<h5>Returns:</h5>
<div class="param-desc">
<p>Last stack frame stored on this thread.</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
<h4 class="name" id="popStack"><span class="type-signature"></span>popStack<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
<dl class="details">
</dl>
<div class="description">
<p>Pop last block on the stack and its stack frame.</p>
</div>
<h5>Returns:</h5>
<div class="param-desc">
<p>Block ID popped from the stack.</p>
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id="pushParam"><span class="type-signature"></span>pushParam<span class="signature">(paramName<span class="signature-attributes">non-null</span>, value)</span><span class="type-signature"></span></h4>
<dl class="details">
</dl>
<div class="description">
<p>Add a parameter to the stack frame.
Use when calling a procedure with parameter values.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>paramName</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Name of parameter.</p></td>
</tr>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last"><p>Value to set for parameter.</p></td>
</tr>
</tbody>
</table>
<h4 class="name" id="pushReportedValue"><span class="type-signature"></span>pushReportedValue<span class="signature">(value)</span><span class="type-signature"></span></h4>
<dl class="details">
</dl>
<div class="description">
<p>Push a reported value to the parent of the current stack frame.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last"><p>Reported value to push.</p></td>
</tr>
</tbody>
</table>
<h4 class="name" id="pushStack"><span class="type-signature"></span>pushStack<span class="signature">(blockId)</span><span class="type-signature"></span></h4>
<dl class="details">
</dl>
<div class="description">
<p>Push stack and update stack frames appropriately.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>blockId</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Block ID to push to stack.</p></td>
</tr>
</tbody>
</table>
<h4 class="name" id="reuseStackForNextBlock"><span class="type-signature"></span>reuseStackForNextBlock<span class="signature">(blockId)</span><span class="type-signature"></span></h4>
<dl class="details">
</dl>
<div class="description">
<p>Reset the stack frame for use by the next block.
(avoids popping and re-pushing a new stack frame - keeps the warpmode the same</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>blockId</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Block ID to push to stack.</p></td>
</tr>
</tbody>
</table>
<h4 class="name" id="stopThisScript"><span class="type-signature"></span>stopThisScript<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
</dl>
<div class="description">
<p>Pop back down the stack frame until we hit a procedure call or the stack frame is emptied</p>
</div>
</article>
</section>
</div>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>
<script>prettyPrint();</script>
<script src="scripts/polyfill.js"></script>
<script src="scripts/linenumber.js"></script>
</body>
</html>
Reference in New Issue Copy Permalink