kontra

<!DOCTYPE html> <html lang="en"> <head> <title>Kontra.js – Keyboard</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>  <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" >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" aria-current="page">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>Keyboard </h1> <p>A minimalistic keyboard API. You can use it move the main sprite or respond to a key press.</p> <div class="tablist"> <ul role="tablist"> <li role="presentation" data-tab="global"> <button role="tab" id="keyboard-global-tab">Global Object</button> </li> <li role="presentation" data-tab="es"> <button role="tab" id="keyboard-es-tab">ES Module Import</button> </li> <li role="presentation" data-tab="bundle"> <button role="tab" id="keyboard-bundle-tab">Module Bundler</button> </li> <li role="presentation"></li> </ul> <section role="tabpanel" aria-labelledby=keyboard-global-tab data-tabpanel="global"><pre><code class="language-js">let { initKeys, keyPressed } = kontra; // this function must be called first before keyboard // functions will work initKeys(); function update() { if (keyPressed('left')) { // move left } }</code></pre></section> <section role="tabpanel" aria-labelledby=keyboard-es-tab data-tabpanel="es"><pre><code class="language-js">import { initKeys, keyPressed } from 'path/to/kontra.mjs'; // this function must be called first before keyboard // functions will work initKeys(); function update() { if (keyPressed('left')) { // move left } }</code></pre></section> <section role="tabpanel" aria-labelledby=keyboard-bundle-tab data-tabpanel="bundle"><pre><code class="language-js">import { initKeys, keyPressed } from 'kontra'; // this function must be called first before keyboard // functions will work initKeys(); function update() { if (keyPressed('left')) { // move left } }</code></pre></section> </div> <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> <ul> <li><a href="api/keyboard#available-keys">Available Keys</a></li> </ul> </li> <li> <h3 id="properties">Properties</h3> <ul aria-labelledby="properties"> <li> <a href="api/keyboard#keyMap"> <span>keyMap</span> </a> </li> </ul> </li> <li> <h3 id="methods">Methods</h3> <ul aria-labelledby="methods"> <li> <a href="api/keyboard#bindKeys"> <span>bindKeys(keys)</span> </a> </li> <li> <a href="api/keyboard#initKeys"> <span>initKeys()</span> </a> </li> <li> <a href="api/keyboard#keyPressed"> <span>keyPressed(key)</span> </a> </li> <li> <a href="api/keyboard#unbindKeys"> <span>unbindKeys(keys)</span> </a> </li> </ul> </li> </ul> </section> <section> <h2 id="available-keys"> <a href="#available-keys" class="section-link"> <span>Available Keys</span> <span aria-hidden="true">#</span> </a> </h2> <p>Below is a list of keys that are provided by default. If you need to extend this list, you can use the <a href="#keyMap">keyMap</a> property.</p> <ul> <li>a-z</li> <li>0-9</li> <li>enter, esc, space, left, up, right, down</li> </ul> </section> <section> <h2 id="bindKeys"> <a href="api/keyboard#bindKeys" class="section-link"> <span>bindKeys(keys)</span> <span aria-hidden="true">#</span> </a> </h2> <p>Bind a set of keys that will call the callback function when they are pressed. Takes a single key or an array of keys. Is passed the original KeyboardEvent as a parameter.</p> <div class="tablist"> <ul role="tablist"> <li role="presentation" data-tab="global"> <button role="tab" id="bindkeys-global-tab">Global Object</button> </li> <li role="presentation" data-tab="es"> <button role="tab" id="bindkeys-es-tab">ES Module Import</button> </li> <li role="presentation" data-tab="bundle"> <button role="tab" id="bindkeys-bundle-tab">Module Bundler</button> </li> <li role="presentation"></li> </ul> <section role="tabpanel" aria-labelledby=bindkeys-global-tab data-tabpanel="global"><pre><code class="language-js">let { initKeys, bindKeys } = kontra; initKeys(); bindKeys('p', function(e) { // pause the game }); bindKeys(['enter', 'space'], function(e) { e.preventDefault(); // fire gun });</code></pre></section> <section role="tabpanel" aria-labelledby=bindkeys-es-tab data-tabpanel="es"><pre><code class="language-js">import { initKeys, bindKeys } from 'path/to/kontra.mjs'; initKeys(); bindKeys('p', function(e) { // pause the game }); bindKeys(['enter', 'space'], function(e) { e.preventDefault(); // fire gun });</code></pre></section> <section role="tabpanel" aria-labelledby=bindkeys-bundle-tab data-tabpanel="bundle"><pre><code class="language-js">import { initKeys, bindKeys } from 'kontra'; initKeys(); bindKeys('p', function(e) { // pause the game }); bindKeys(['enter', 'space'], function(e) { e.preventDefault(); // fire gun });</code></pre></section> </div> <h3 id="title-bindKeys"><span class="visually-hidden">bindKeys</span> Parameters</span></h3> <dl aria-labelledby="title-bindKeys"> <dt> <code>keys</code> </dt> <dd><p>String or an Array of Strings. Key or keys to bind.</p> </dd> </dl> </section> <section> <h2 id="initKeys"> <a href="api/keyboard#initKeys" class="section-link"> <span>initKeys()</span> <span aria-hidden="true">#</span> </a> </h2> <p>Initialize keyboard event listeners. This function must be called before using other keyboard functions.</p> </section> <section> <h2 id="keyMap"> <a href="api/keyboard#keyMap" class="section-link"> <span>keyMap</span> <span aria-hidden="true">#</span> </a> </h2> <p>A map of keycodes to key names. Add to this object to expand the list of <a href="#available-keys">available keys</a>.</p> <div class="tablist"> <ul role="tablist"> <li role="presentation" data-tab="global"> <button role="tab" id="keymap-global-tab">Global Object</button> </li> <li role="presentation" data-tab="es"> <button role="tab" id="keymap-es-tab">ES Module Import</button> </li> <li role="presentation" data-tab="bundle"> <button role="tab" id="keymap-bundle-tab">Module Bundler</button> </li> <li role="presentation"></li> </ul> <section role="tabpanel" aria-labelledby=keymap-global-tab data-tabpanel="global"><pre><code class="language-js">let { keyMap, bindKeys } = kontra; keyMap[34] = 'pageDown'; bindKeys('pageDown', function(e) { // handle pageDown key });</code></pre></section> <section role="tabpanel" aria-labelledby=keymap-es-tab data-tabpanel="es"><pre><code class="language-js">import { keyMap, bindKeys } from 'path/to/kontra.mjs'; keyMap[34] = 'pageDown'; bindKeys('pageDown', function(e) { // handle pageDown key });</code></pre></section> <section role="tabpanel" aria-labelledby=keymap-bundle-tab data-tabpanel="bundle"><pre><code class="language-js">import { keyMap, bindKeys } from 'kontra'; keyMap[34] = 'pageDown'; bindKeys('pageDown', function(e) { // handle pageDown key });</code></pre></section> </div> </section> <section> <h2 id="keyPressed"> <a href="api/keyboard#keyPressed" class="section-link"> <span>keyPressed(key)</span> <span aria-hidden="true">#</span> </a> </h2> <p>Check if a key is currently pressed. Use during an <code>update()</code> function to perform actions each frame.</p> <div class="tablist"> <ul role="tablist"> <li role="presentation" data-tab="global"> <button role="tab" id="keypressed-global-tab">Global Object</button> </li> <li role="presentation" data-tab="es"> <button role="tab" id="keypressed-es-tab">ES Module Import</button> </li> <li role="presentation" data-tab="bundle"> <button role="tab" id="keypressed-bundle-tab">Module Bundler</button> </li> <li role="presentation"></li> </ul> <section role="tabpanel" aria-labelledby=keypressed-global-tab data-tabpanel="global"><pre><code class="language-js">let { Sprite, initKeys, keyPressed } = kontra; initKeys(); let sprite = Sprite({ update: function() { if (keyPressed('left')){ // left arrow pressed } else if (keyPressed('right')) { // right arrow pressed } if (keyPressed('up')) { // up arrow pressed } else if (keyPressed('down')) { // down arrow pressed } } });</code></pre></section> <section role="tabpanel" aria-labelledby=keypressed-es-tab data-tabpanel="es"><pre><code class="language-js">import { Sprite, initKeys, keyPressed } from 'path/to/kontra.mjs'; initKeys(); let sprite = Sprite({ update: function() { if (keyPressed('left')){ // left arrow pressed } else if (keyPressed('right')) { // right arrow pressed } if (keyPressed('up')) { // up arrow pressed } else if (keyPressed('down')) { // down arrow pressed } } });</code></pre></section> <section role="tabpanel" aria-labelledby=keypressed-bundle-tab data-tabpanel="bundle"><pre><code class="language-js">import { Sprite, initKeys, keyPressed } from 'kontra'; initKeys(); let sprite = Sprite({ update: function() { if (keyPressed('left')){ // left arrow pressed } else if (keyPressed('right')) { // right arrow pressed } if (keyPressed('up')) { // up arrow pressed } else if (keyPressed('down')) { // down arrow pressed } } });</code></pre></section> </div> <h3 id="title-keyPressed"><span class="visually-hidden">keyPressed</span> Parameters</span></h3> <dl aria-labelledby="title-keyPressed"> <dt> <code>key</code> </dt> <dd><p>String. Key to check for pressed state.</p> </dd> </dl> <h3><span class="visually-hidden">keyPressed</span> Return value</h3> <p><p><code>true</code> if the key is pressed, <code>false</code> otherwise.</p> </p> </section> <section> <h2 id="unbindKeys"> <a href="api/keyboard#unbindKeys" class="section-link"> <span>unbindKeys(keys)</span> <span aria-hidden="true">#</span> </a> </h2> <p>Remove the callback function for a bound set of keys. Takes a single key or an array of keys.</p> <div class="tablist"> <ul role="tablist"> <li role="presentation" data-tab="global"> <button role="tab" id="unbindkeys-global-tab">Global Object</button> </li> <li role="presentation" data-tab="es"> <button role="tab" id="unbindkeys-es-tab">ES Module Import</button> </li> <li role="presentation" data-tab="bundle"> <button role="tab" id="unbindkeys-bundle-tab">Module Bundler</button> </li> <li role="presentation"></li> </ul> <section role="tabpanel" aria-labelledby=unbindkeys-global-tab data-tabpanel="global"><pre><code class="language-js">let { unbindKeys } = kontra; unbindKeys('left'); unbindKeys(['enter', 'space']);</code></pre></section> <section role="tabpanel" aria-labelledby=unbindkeys-es-tab data-tabpanel="es"><pre><code class="language-js">import { unbindKeys } from 'path/to/kontra.mjs'; unbindKeys('left'); unbindKeys(['enter', 'space']);</code></pre></section> <section role="tabpanel" aria-labelledby=unbindkeys-bundle-tab data-tabpanel="bundle"><pre><code class="language-js">import { unbindKeys } from 'kontra'; unbindKeys('left'); unbindKeys(['enter', 'space']);</code></pre></section> </div> <h3 id="title-unbindKeys"><span class="visually-hidden">unbindKeys</span> Parameters</span></h3> <dl aria-labelledby="title-unbindKeys"> <dt> <code>keys</code> </dt> <dd><p>String or an Array of Strings. Key or keys to unbind.</p> </dd> </dl> </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>