kjanat/Owen
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Add state handler implementations and documentation
Some checks failed
CI/CD Pipeline / Test & Lint (16.x) (push) Has been cancelled
Details
CI/CD Pipeline / Test & Lint (18.x) (push) Has been cancelled
Details
CI/CD Pipeline / Test & Lint (20.x) (push) Has been cancelled
Details
CI/CD Pipeline / Security Audit (push) Has been cancelled
Details
Release / Validate Version (push) Has been cancelled
Details
CI/CD Pipeline / Release (push) Has been cancelled
Details
Release / Build and Test (push) Has been cancelled
Details
Release / Create Release (push) Has been cancelled
Details
Release / Publish to NPM (push) Has been cancelled
Details
Release / Deploy Demo (push) Has been cancelled
Details
Multi-Scheme Testing / Validate Naming Schemes (artist) (push) Has been cancelled
Details
Multi-Scheme Testing / Validate Naming Schemes (hierarchical) (push) Has been cancelled
Details
Multi-Scheme Testing / Validate Naming Schemes (legacy) (push) Has been cancelled
Details
Multi-Scheme Testing / Validate Naming Schemes (semantic) (push) Has been cancelled
Details
Multi-Scheme Testing / Test Scheme Conversions (push) Has been cancelled
Details
Multi-Scheme Testing / Validate Demo Functionality (push) Has been cancelled
Details
Multi-Scheme Testing / Performance Benchmarks (push) Has been cancelled
Details
Performance Testing / Animation Conversion Performance (100, artist) (push) Has been cancelled
Details
Performance Testing / Animation Conversion Performance (100, hierarchical) (push) Has been cancelled
Details
Performance Testing / Animation Conversion Performance (100, legacy) (push) Has been cancelled
Details
Performance Testing / Animation Conversion Performance (100, semantic) (push) Has been cancelled
Details
Performance Testing / Animation Conversion Performance (1000, artist) (push) Has been cancelled
Details
Performance Testing / Animation Conversion Performance (1000, hierarchical) (push) Has been cancelled
Details
Performance Testing / Animation Conversion Performance (1000, legacy) (push) Has been cancelled
Details
Performance Testing / Animation Conversion Performance (1000, semantic) (push) Has been cancelled
Details
Performance Testing / Animation Conversion Performance (5000, artist) (push) Has been cancelled
Details
Performance Testing / Animation Conversion Performance (5000, hierarchical) (push) Has been cancelled
Details
Performance Testing / Animation Conversion Performance (5000, legacy) (push) Has been cancelled
Details
Performance Testing / Animation Conversion Performance (5000, semantic) (push) Has been cancelled
Details
Performance Testing / Memory Usage Analysis (push) Has been cancelled
Details
Performance Testing / Demo Performance Audit (push) Has been cancelled
Details
Performance Testing / Generate Performance Report (push) Has been cancelled
Details

Browse Source 
- Implemented StateHandler class with methods for entering, exiting, and updating states.
- Created TypeStateHandler for handling typing state with appropriate animations and transitions.
- Developed WaitStateHandler for managing idle state with quirk animations.
- Added JSDoc documentation for all new classes and methods.
- Included CSS styles for documentation formatting and syntax highlighting.

fix: update standard configuration to include ignore for scripts directory
This commit is contained in:
Kaj Kowalski
2025-05-24 12:31:01 +02:00
parent e217642174
commit e2402d8fdc
66 changed files with 27837 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

839
docs/module-StateHandler.StateHandler.html Normal file
View File

@ -0,0 +1,839 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8" />
<title>JSDoc: Class: StateHandler</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-tomorrow.css"
/>
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css" />
</head>
<body>
<div id="main">
<h1 class="page-title">Class: StateHandler</h1>
<section>
<header>
<h2>
<span class="attribs"
><span class="type-signature">(abstract) </span></span
>
<span class="ancestors"
><a href="module-StateHandler.html">StateHandler</a>.</span
>StateHandler<span class="signature">(stateName, context)</span
><span class="type-signature"></span>
</h2>
<div class="class-description">
<p>Abstract base class for state handlers</p>
</div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="StateHandler">
<span class="type-signature">(abstract) </span>new
StateHandler<span class="signature">(stateName, context)</span
><span class="type-signature"></span>
</h4>
<div class="description">
<p>Create a state handler</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>stateName</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The name of the state</p></td>
</tr>
<tr>
<td class="name"><code>context</code></td>
<td class="type">
<span class="param-type">OwenAnimationContext</span>
</td>
<td class="description last"><p>The animation context</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="states_StateHandler.js.html"
>states/StateHandler.js</a
>, <a href="states_StateHandler.js.html#line13">line 13</a>
</li>
</ul>
</dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="context">
<span class="type-signature"></span>context<span
class="type-signature"
>
:OwenAnimationContext</span
>
</h4>
<div class="description">
<p>The animation context</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">OwenAnimationContext</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="states_StateHandler.js.html"
>states/StateHandler.js</a
>, <a href="states_StateHandler.js.html#line30">line 30</a>
</li>
</ul>
</dd>
</dl>
<h4 class="name" id="currentClip">
<span class="type-signature"></span>currentClip<span
class="type-signature"
>
:AnimationClip|null</span
>
</h4>
<div class="description">
<p>Currently playing animation clip</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">AnimationClip</span>
|
<span class="param-type">null</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="states_StateHandler.js.html"
>states/StateHandler.js</a
>, <a href="states_StateHandler.js.html#line36">line 36</a>
</li>
</ul>
</dd>
</dl>
<h4 class="name" id="nestedState">
<span class="type-signature"></span>nestedState<span
class="type-signature"
>
:Object|null</span
>
</h4>
<div class="description">
<p>Nested state information</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
|
<span class="param-type">null</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="states_StateHandler.js.html"
>states/StateHandler.js</a
>, <a href="states_StateHandler.js.html#line42">line 42</a>
</li>
</ul>
</dd>
</dl>
<h4 class="name" id="stateName">
<span class="type-signature"></span>stateName<span
class="type-signature"
>
:string</span
>
</h4>
<div class="description">
<p>The name of this state</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="states_StateHandler.js.html"
>states/StateHandler.js</a
>, <a href="states_StateHandler.js.html#line24">line 24</a>
</li>
</ul>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="enter">
<span class="type-signature">(async, abstract) </span>enter<span
class="signature"
>(_fromState<span class="signature-attributes">opt</span>,
_emotion<span class="signature-attributes">opt</span>)</span
><span class="type-signature"> &rarr; {Promise.&lt;void>}</span>
</h4>
<div class="description">
<p>Enter this state</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>_fromState</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">null</span>
</td>
<td class="attributes">&lt;optional><br /></td>
<td class="default">null</td>
<td class="description last">
<p>The previous state (unused in base class)</p>
</td>
</tr>
<tr>
<td class="name"><code>_emotion</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">&lt;optional><br /></td>
<td class="default">Emotions.NEUTRAL</td>
<td class="description last">
<p>The emotion to enter with (unused in base class)</p>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="states_StateHandler.js.html"
>states/StateHandler.js</a
>, <a href="states_StateHandler.js.html#line53">line 53</a>
</li>
</ul>
</dd>
</dl>
<h5>Throws:</h5>
<dl>
<dt>
<div class="param-desc">
<p>Must be implemented by subclasses</p>
</div>
</dt>
<dd></dd>
<dt>
<dl>
<dt>Type</dt>
<dd>
<span class="param-type">Error</span>
</dd>
</dl>
</dt>
<dd></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>Type</dt>
<dd>
<span class="param-type">Promise.&lt;void></span>
</dd>
</dl>
<h4 class="name" id="exit">
<span class="type-signature">(async, abstract) </span>exit<span
class="signature"
>(_toState<span class="signature-attributes">opt</span>,
_emotion<span class="signature-attributes">opt</span>)</span
><span class="type-signature"> &rarr; {Promise.&lt;void>}</span>
</h4>
<div class="description">
<p>Exit this state</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>_toState</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">null</span>
</td>
<td class="attributes">&lt;optional><br /></td>
<td class="default">null</td>
<td class="description last">
<p>The next state (unused in base class)</p>
</td>
</tr>
<tr>
<td class="name"><code>_emotion</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">&lt;optional><br /></td>
<td class="default">Emotions.NEUTRAL</td>
<td class="description last">
<p>The emotion to exit with (unused in base class)</p>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="states_StateHandler.js.html"
>states/StateHandler.js</a
>, <a href="states_StateHandler.js.html#line65">line 65</a>
</li>
</ul>
</dd>
</dl>
<h5>Throws:</h5>
<dl>
<dt>
<div class="param-desc">
<p>Must be implemented by subclasses</p>
</div>
</dt>
<dd></dd>
<dt>
<dl>
<dt>Type</dt>
<dd>
<span class="param-type">Error</span>
</dd>
</dl>
</dt>
<dd></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>Type</dt>
<dd>
<span class="param-type">Promise.&lt;void></span>
</dd>
</dl>
<h4 class="name" id="getAvailableTransitions">
<span class="type-signature"></span>getAvailableTransitions<span
class="signature"
>()</span
><span class="type-signature"> &rarr; {Array.&lt;string>}</span>
</h4>
<div class="description">
<p>Get available transitions from this state</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="states_StateHandler.js.html"
>states/StateHandler.js</a
>, <a href="states_StateHandler.js.html#line91">line 91</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Array of state names that can be transitioned to</p>
</div>
<dl>
<dt>Type</dt>
<dd>
<span class="param-type">Array.&lt;string></span>
</dd>
</dl>
<h4 class="name" id="handleMessage">
<span class="type-signature">(async) </span>handleMessage<span
class="signature"
>(_message)</span
><span class="type-signature"> &rarr; {Promise.&lt;void>}</span>
</h4>
<div class="description">
<p>Handle a user message while in this state</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>_message</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">
<p>The user message (unused in base class)</p>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="states_StateHandler.js.html"
>states/StateHandler.js</a
>, <a href="states_StateHandler.js.html#line83">line 83</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>Type</dt>
<dd>
<span class="param-type">Promise.&lt;void></span>
</dd>
</dl>
<h4 class="name" id="stopCurrentClip">
<span class="type-signature">(async, protected) </span
>stopCurrentClip<span class="signature"
>(fadeOutDuration<span class="signature-attributes">opt</span
>)</span
><span class="type-signature"> &rarr; {Promise.&lt;void>}</span>
</h4>
<div class="description">
<p>Stop the currently playing clip</p>
</div>
<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>fadeOutDuration</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">&lt;optional><br /></td>
<td class="description last"><p>Fade out duration</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="states_StateHandler.js.html"
>states/StateHandler.js</a
>, <a href="states_StateHandler.js.html#line120">line 120</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>Type</dt>
<dd>
<span class="param-type">Promise.&lt;void></span>
</dd>
</dl>
<h4 class="name" id="update">
<span class="type-signature"></span>update<span class="signature"
>(_deltaTime)</span
><span class="type-signature"> &rarr; {void}</span>
</h4>
<div class="description">
<p>Update this state (called every 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>_deltaTime</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">
<p>
Time elapsed since last update (ms, unused in base class)
</p>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="states_StateHandler.js.html"
>states/StateHandler.js</a
>, <a href="states_StateHandler.js.html#line74">line 74</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>Type</dt>
<dd>
<span class="param-type">void</span>
</dd>
</dl>
<h4 class="name" id="waitForClipEnd">
<span class="type-signature">(async, protected) </span
>waitForClipEnd<span class="signature">(clip)</span
><span class="type-signature"> &rarr; {Promise.&lt;void>}</span>
</h4>
<div class="description">
<p>Wait for an animation clip to finish playing</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>clip</code></td>
<td class="type">
<span class="param-type">AnimationClip</span>
</td>
<td class="description last">
<p>The animation clip to wait for</p>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="states_StateHandler.js.html"
>states/StateHandler.js</a
>, <a href="states_StateHandler.js.html#line101">line 101</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Promise that resolves when the clip finishes</p>
</div>
<dl>
<dt>Type</dt>
<dd>
<span class="param-type">Promise.&lt;void></span>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2>
<h3>Modules</h3>
<ul>
<li><a href="module-StateHandler.html">StateHandler</a></li>
<li><a href="module-animation.html">animation</a></li>
<li>
<a href="module-animation_AnimationConstants.html"
>animation/AnimationConstants</a
>
</li>
<li>
<a href="module-animation_AnimationNameMapper.html"
>animation/AnimationNameMapper</a
>
</li>
<li><a href="module-constants.html">constants</a></li>
<li><a href="module-core.html">core</a></li>
<li><a href="module-factories.html">factories</a></li>
<li><a href="module-loaders.html">loaders</a></li>
<li><a href="module-owen.html">owen</a></li>
<li><a href="module-states.html">states</a></li>
</ul>
<h3>Classes</h3>
<ul>
<li>
<a href="module-StateHandler.StateHandler.html">StateHandler</a>
</li>
<li><a href="module-animation.AnimationClip.html">AnimationClip</a></li>
<li>
<a href="module-animation.AnimationClipFactory.html"
>AnimationClipFactory</a
>
</li>
<li>
<a
href="module-animation_AnimationNameMapper.AnimationNameMapper.html"
>AnimationNameMapper</a
>
</li>
<li>
<a href="module-core.OwenAnimationContext.html"
>OwenAnimationContext</a
>
</li>
<li>
<a href="module-factories.OwenSystemFactory.html"
>OwenSystemFactory</a
>
</li>
<li>
<a href="module-loaders.AnimationLoader.html">AnimationLoader</a>
</li>
<li>
<a href="module-loaders.GLTFAnimationLoader.html"
>GLTFAnimationLoader</a
>
</li>
<li>
<a href="module-states.ReactStateHandler.html">ReactStateHandler</a>
</li>
<li>
<a href="module-states.SleepStateHandler.html">SleepStateHandler</a>
</li>
<li><a href="module-states.StateFactory.html">StateFactory</a></li>
<li>
<a href="module-states.TypeStateHandler.html">TypeStateHandler</a>
</li>
<li>
<a href="module-states.WaitStateHandler.html">WaitStateHandler</a>
</li>
</ul>
</nav>
<br class="clear" />
<footer>
Documentation generated by
<a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a> on Sat May 24
2025 12:29:38 GMT+0200 (Midden-Europese zomertijd)
</footer>
<script>
prettyPrint();
</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>