kontra
Version:
Kontra HTML5 game development library
434 lines (382 loc) • 16.8 kB
HTML
<html lang="en">
<head>
<title>Kontra.js – Animation</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="https://straker.github.io/kontra/">
<script>
// adjust path based on location (github pages required kontra url)
if (window.location.host.indexOf('localhost') !== -1) {
let base = document.querySelector('base');
base.setAttribute('href', '/');
}
</script>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/prism/1.16.0/themes/prism.min.css">
<link rel="stylesheet" href="assets/styles.css">
<script src="assets/js/kontra.js"></script>
</head>
<body>
<div class="content">
<header class="main-nav">
<div id="kontra-heading" class="nav-heading">Kontra</div>
<a href="#main">Skip navigation</a>
<nav>
<button class="menu-button" aria-expanded="false" aria-controls="menu"><span aria-hidden="true">☰</span> Menu</button>
<!-- add role=list back to list so screen readers still read it as list when
css list-style: none is set
@see https://web-a11y.slack.com/archives/C042TSFGN/p1501699529181172 -->
<ul id="menu" role="list">
<li><a href="." >Introduction</a></li>
<li><a href="getting-started" >Getting Started</a></li>
<li><a href="download" >Download</a></li>
<li><a href="tutorials" >Tutorials</a></li>
<li><a href="made-with-kontra" >Made With Kontra</a></li>
<li>
<span id="api" class="nav-api-heading">API</span>
<ul aria-labelledby="api">
<li><a href="api/animation" aria-current="page">Animation</a></li>
<li><a href="api/assets" >Assets</a></li>
<li><a href="api/core" >Core</a></li>
<li><a href="api/events" >Events</a></li>
<li><a href="api/gameLoop" >GameLoop</a></li>
<li><a href="api/keyboard" >Keyboard</a></li>
<li><a href="api/plugin" >Plugin</a></li>
<li><a href="api/pointer" >Pointer</a></li>
<li><a href="api/pool" >Pool</a></li>
<li><a href="api/quadtree" >Quadtree</a></li>
<li><a href="api/sprite" >Sprite</a></li>
<li><a href="api/spriteSheet" >SpriteSheet</a></li>
<li><a href="api/store" >Store</a></li>
<li><a href="api/tileEngine" >TileEngine</a></li>
<li><a href="api/vector" >Vector</a></li>
</ul>
</li>
</ul>
</nav>
<div class="scroll-indicator" aria-hidden="true"><span>^</span></div>
</header>
<main id="main">
<div>
<a href="https://github.com/straker/kontra" class="github-corner" aria-label="View source on GitHub"><svg width="80" height="80" viewBox="0 0 250 250" style="fill:#151513; color:#fff; position: absolute; top: 0; border: 0; right: 0;" aria-hidden="true"><path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path><path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path><path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"></path></svg></a>
<h1>Animation(​properties)
</h1>
<p>An object for drawing sprite sheet animations.</p>
<p>An animation defines the sequence of frames to use from a sprite sheet. It also defines at what speed the animation should run using <code>frameRate</code>.</p>
<p>Typically you don't create an <a href="Animation">Animation</a> directly, but rather you would create them from <a href="SpriteSheet">SpriteSheet</a> by passing the <code>animations</code> argument.</p>
<div class="tablist">
<ul role="tablist">
<li role="presentation" data-tab="global">
<button role="tab" id="animation-global-tab">Global Object</button>
</li>
<li role="presentation" data-tab="es">
<button role="tab" id="animation-es-tab">ES Module Import</button>
</li>
<li role="presentation" data-tab="bundle">
<button role="tab" id="animation-bundle-tab">Module Bundler</button>
</li>
<li role="presentation"></li>
</ul>
<section role="tabpanel" aria-labelledby=animation-global-tab data-tabpanel="global"><pre><code class="language-js">let { SpriteSheet, Animation } = kontra;
let image = new Image();
image.src = 'assets/imgs/character_walk_sheet.png';
image.onload = function() {
let spriteSheet = SpriteSheet({
image: image,
frameWidth: 72,
frameHeight: 97
});
// you typically wouldn't create an Animation this way
let animation = Animation({
spriteSheet: spriteSheet,
frames: [1,2,3,6],
frameRate: 30
});
};</code></pre></section>
<section role="tabpanel" aria-labelledby=animation-es-tab data-tabpanel="es"><pre><code class="language-js">import { SpriteSheet, Animation } from 'path/to/kontra.mjs';
let image = new Image();
image.src = 'assets/imgs/character_walk_sheet.png';
image.onload = function() {
let spriteSheet = SpriteSheet({
image: image,
frameWidth: 72,
frameHeight: 97
});
// you typically wouldn't create an Animation this way
let animation = Animation({
spriteSheet: spriteSheet,
frames: [1,2,3,6],
frameRate: 30
});
};</code></pre></section>
<section role="tabpanel" aria-labelledby=animation-bundle-tab data-tabpanel="bundle"><pre><code class="language-js">import { SpriteSheet, Animation } from 'kontra';
let image = new Image();
image.src = 'assets/imgs/character_walk_sheet.png';
image.onload = function() {
let spriteSheet = SpriteSheet({
image: image,
frameWidth: 72,
frameHeight: 97
});
// you typically wouldn't create an Animation this way
let animation = Animation({
spriteSheet: spriteSheet,
frames: [1,2,3,6],
frameRate: 30
});
};</code></pre></section>
</div>
<h3 id="title-Animation"><span class="visually-hidden">Animation</span> Parameters</span></h3>
<dl aria-labelledby="title-Animation">
<dt>
<code>properties</code>
</dt>
<dd><p>Object. Properties of the animation.</p>
</dd>
<dt>
<code>properties.spriteSheet</code>
</dt>
<dd><p><a href="SpriteSheet">SpriteSheet</a>. Sprite sheet for the animation.</p>
</dd>
<dt>
<code>properties.frames</code>
</dt>
<dd><p>An Array of Numbers. List of frames of the animation.</p>
</dd>
<dt>
<code>properties.frameRate</code>
</dt>
<dd><p>Number. Number of frames to display in one second.</p>
</dd>
<dt>
<code>properties.loop</code>
<span class="optional">Optional</span>
</dt>
<dd><p>Boolean. If the animation should loop. Defaults to <code>true</code>.</p>
</dd>
</dl>
<section class="toc">
<h2 id="toc"><a href="#toc" class="section-link">Table of Contents<span aria-hidden="true">#</span></a></h2>
<ul aria-labelledby="toc">
<li>
<h3 id="properties">Properties</h3>
<ul aria-labelledby="properties">
<li>
<a href="api/animation#frameRate">
<span>Animation​.frameRate</span>
</a>
</li>
<li>
<a href="api/animation#frames">
<span>Animation​.frames</span>
</a>
</li>
<li>
<a href="api/animation#height">
<span>Animation​.height</span>
</a>
</li>
<li>
<a href="api/animation#loop">
<span>Animation​.loop</span>
</a>
</li>
<li>
<a href="api/animation#margin">
<span>Animation​.margin</span>
</a>
</li>
<li>
<a href="api/animation#spriteSheet">
<span>Animation​.spriteSheet</span>
</a>
</li>
<li>
<a href="api/animation#width">
<span>Animation​.width</span>
</a>
</li>
</ul>
</li>
<li>
<h3 id="methods">Methods</h3>
<ul aria-labelledby="methods">
<li>
<a href="api/animation#clone">
<span>Animation​.clone(​)</span>
</a>
</li>
<li>
<a href="api/animation#render">
<span>Animation​.render(​properties)</span>
</a>
</li>
<li>
<a href="api/animation#reset">
<span>Animation​.reset(​)</span>
</a>
</li>
<li>
<a href="api/animation#update">
<span>Animation​.update(​[dt])</span>
</a>
</li>
</ul>
</li>
</ul>
</section>
<section>
<h2 id="clone">
<a href="api/animation#clone" class="section-link">
<span>Animation​.clone(​)</span>
<span aria-hidden="true">#</span>
</a>
</h2>
<p>Clone an animation so it can be used more than once. By default animations passed to <a href="Sprite">Sprite</a> will be cloned so no two sprites update the same animation. Otherwise two sprites who shared the same animation would make it update twice as fast.</p>
<h3><span class="visually-hidden">clone</span> Return value</h3>
<p><p>A new <a href="Animation">Animation</a> instance.</p>
</p>
</section>
<section>
<h2 id="frameRate">
<a href="api/animation#frameRate" class="section-link">
<span>Animation​.frameRate</span>
<span aria-hidden="true">#</span>
</a>
</h2>
<p>Number of frames to display per second. Adjusting this value will change the speed of the animation.</p>
</section>
<section>
<h2 id="frames">
<a href="api/animation#frames" class="section-link">
<span>Animation​.frames</span>
<span aria-hidden="true">#</span>
</a>
</h2>
<p>Sequence of frames to use from the sprite sheet.</p>
</section>
<section>
<h2 id="height">
<a href="api/animation#height" class="section-link">
<span>Animation​.height</span>
<span aria-hidden="true">#</span>
</a>
</h2>
<p>The height of an individual frame. Taken from the property of the same name in the <a href="#spriteSheet">spriteSheet</a>.</p>
</section>
<section>
<h2 id="loop">
<a href="api/animation#loop" class="section-link">
<span>Animation​.loop</span>
<span aria-hidden="true">#</span>
</a>
</h2>
<p>If the animation should loop back to the beginning once completed.</p>
</section>
<section>
<h2 id="margin">
<a href="api/animation#margin" class="section-link">
<span>Animation​.margin</span>
<span aria-hidden="true">#</span>
</a>
</h2>
<p>The space between each frame. Taken from the property of the same name in the <a href="#spriteSheet">spriteSheet</a>.</p>
</section>
<section>
<h2 id="render">
<a href="api/animation#render" class="section-link">
<span>Animation​.render(​properties)</span>
<span aria-hidden="true">#</span>
</a>
</h2>
<p>Draw the current frame of the animation.</p>
<h3 id="title-render"><span class="visually-hidden">render</span> Parameters</span></h3>
<dl aria-labelledby="title-render">
<dt>
<code>properties</code>
</dt>
<dd><p>Object. Properties to draw the animation.</p>
</dd>
<dt>
<code>properties.x</code>
</dt>
<dd><p>Number. X position to draw the animation.</p>
</dd>
<dt>
<code>properties.y</code>
</dt>
<dd><p>Number. Y position to draw the animation.</p>
</dd>
<dt>
<code>properties.width</code>
<span class="optional">Optional</span>
</dt>
<dd><p>Number. width of the sprite. Defaults to <a href="#width">Animation.width</a>.</p>
</dd>
<dt>
<code>properties.height</code>
<span class="optional">Optional</span>
</dt>
<dd><p>Number. height of the sprite. Defaults to <a href="#height">Animation.height</a>.</p>
</dd>
<dt>
<code>properties.context</code>
<span class="optional">Optional</span>
</dt>
<dd><p>CanvasRenderingContext2D. The context the animation should draw to. Defaults to <a href="api/core#getContext">core.getContext()</a>.</p>
</dd>
</dl>
</section>
<section>
<h2 id="reset">
<a href="api/animation#reset" class="section-link">
<span>Animation​.reset(​)</span>
<span aria-hidden="true">#</span>
</a>
</h2>
<p>Reset an animation to the first frame.</p>
</section>
<section>
<h2 id="spriteSheet">
<a href="api/animation#spriteSheet" class="section-link">
<span>Animation​.spriteSheet</span>
<span aria-hidden="true">#</span>
</a>
</h2>
<p>The sprite sheet to use for the animation.</p>
</section>
<section>
<h2 id="update">
<a href="api/animation#update" class="section-link">
<span>Animation​.update(​[dt])</span>
<span aria-hidden="true">#</span>
</a>
</h2>
<p>Update the animation.</p>
<h3 id="title-update"><span class="visually-hidden">update</span> Parameters</span></h3>
<dl aria-labelledby="title-update">
<dt>
<code>dt</code>
<span class="optional">Optional</span>
</dt>
<dd><p>Number. Time since last update. Defaults to <code>1/60</code>.</p>
</dd>
</dl>
</section>
<section>
<h2 id="width">
<a href="api/animation#width" class="section-link">
<span>Animation​.width</span>
<span aria-hidden="true">#</span>
</a>
</h2>
<p>The width of an individual frame. Taken from the property of the same name in the <a href="#spriteSheet">spriteSheet</a>.</p>
</section>
</div>
</main>
</div>
<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.16.0/prism.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.16.0/components/prism-javascript.min.js"></script>
<script src="assets/js/navbar.js"></script>
<script src="assets/js/exampleTabList.js"></script>
</body>
</html>