-
-
Notifications
You must be signed in to change notification settings - Fork 215
Expand file tree
/
Copy pathUISystem.UIObject.html
More file actions
3 lines (3 loc) · 64.1 KB
/
UISystem.UIObject.html
File metadata and controls
3 lines (3 loc) · 64.1 KB
1
2
3
<!DOCTYPE html><html lang="en" style="font-size:16px"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="icon" href="./static/favicon.png"><meta name="description" content="LittleJS is a lightweight HTML5 game engine with fast WebGL rendering, physics, particles, sound, and more!"><meta name="keywords" content="javascript, game engine, html5, webgl, 2d, game development, indie games"><meta name="author" content="Frank Force"><meta property="og:title" content="LittleJS - The Tiny JavaScript Game Engine"><meta property="og:description" content="Lightweight HTML5 game engine with WebGL rendering, physics, and sound"><meta property="og:type" content="website"><title>Class: UIObject</title><!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(baseURL=(baseURL="https://killedbyapixel.github.io/LittleJS/docs/").replace(/https?:\/\//i,"")).substr(baseURL.indexOf("/"))</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124 C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124 c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227 c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6 V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474 c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323 c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848 S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328 c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body data-theme="dark"><div class="sidebar-container"><div class="sidebar" id="sidebar"><a href="/" class="sidebar-title sidebar-title-anchor">LittleJS - The Tiny JavaScript Game Engine That Can!</a><div class="sidebar-items-container"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="Audio.Sound.html">Sound</a></div><div class="sidebar-section-children"><a href="Audio.SoundInstance.html">SoundInstance</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dDistanceJoint.html">Box2dDistanceJoint</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dFrictionJoint.html">Box2dFrictionJoint</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dGearJoint.html">Box2dGearJoint</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dJoint.html">Box2dJoint</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dKinematicObject.html">Box2dKinematicObject</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dMotorJoint.html">Box2dMotorJoint</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dObject.html">Box2dObject</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dPinJoint.html">Box2dPinJoint</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dPlugin.html">Box2dPlugin</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dPrismaticJoint.html">Box2dPrismaticJoint</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dPulleyJoint.html">Box2dPulleyJoint</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dRevoluteJoint.html">Box2dRevoluteJoint</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dRopeJoint.html">Box2dRopeJoint</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dStaticObject.html">Box2dStaticObject</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dTargetJoint.html">Box2dTargetJoint</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dTileLayer.html">Box2dTileLayer</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dWeldJoint.html">Box2dWeldJoint</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dWheelJoint.html">Box2dWheelJoint</a></div><div class="sidebar-section-children"><a href="Box2dRaycastResult.html">Box2dRaycastResult</a></div><div class="sidebar-section-children"><a href="Draw.FontImage.html">FontImage</a></div><div class="sidebar-section-children"><a href="Draw.TextureInfo.html">TextureInfo</a></div><div class="sidebar-section-children"><a href="Draw.TileInfo.html">TileInfo</a></div><div class="sidebar-section-children"><a href="Engine.Color.html">Color</a></div><div class="sidebar-section-children"><a href="Engine.EngineObject.html">EngineObject</a></div><div class="sidebar-section-children"><a href="Engine.RandomGenerator.html">RandomGenerator</a></div><div class="sidebar-section-children"><a href="Engine.Timer.html">Timer</a></div><div class="sidebar-section-children"><a href="Engine.Vector2.html">Vector2</a></div><div class="sidebar-section-children"><a href="Medals.Medal.html">Medal</a></div><div class="sidebar-section-children"><a href="Newgrounds.NewgroundsMedal.html">NewgroundsMedal</a></div><div class="sidebar-section-children"><a href="Newgrounds.NewgroundsPlugin.html">NewgroundsPlugin</a></div><div class="sidebar-section-children"><a href="Particles.Particle.html">Particle</a></div><div class="sidebar-section-children"><a href="Particles.ParticleEmitter.html">ParticleEmitter</a></div><div class="sidebar-section-children"><a href="PostProcess.PostProcessPlugin.html">PostProcessPlugin</a></div><div class="sidebar-section-children"><a href="TileLayers.CanvasLayer.html">CanvasLayer</a></div><div class="sidebar-section-children"><a href="TileLayers.TileCollisionLayer.html">TileCollisionLayer</a></div><div class="sidebar-section-children"><a href="TileLayers.TileLayer.html">TileLayer</a></div><div class="sidebar-section-children"><a href="TileLayers.TileLayerData.html">TileLayerData</a></div><div class="sidebar-section-children"><a href="UISystem.UIButton.html">UIButton</a></div><div class="sidebar-section-children"><a href="UISystem.UICheckbox.html">UICheckbox</a></div><div class="sidebar-section-children"><a href="UISystem.UIObject.html">UIObject</a></div><div class="sidebar-section-children"><a href="UISystem.UIScrollbar.html">UIScrollbar</a></div><div class="sidebar-section-children"><a href="UISystem.UISystemPlugin.html">UISystemPlugin</a></div><div class="sidebar-section-children"><a href="UISystem.UIText.html">UIText</a></div><div class="sidebar-section-children"><a href="UISystem.UITile.html">UITile</a></div><div class="sidebar-section-children"><a href="UISystem.UIVideo.html">UIVideo</a></div><div class="sidebar-section-children"><a href="ZzFXM.ZzFXMusic.html">ZzFXMusic</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-namespaces"><div>Namespaces</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="Audio.html">Audio</a></div><div class="sidebar-section-children"><a href="Box2D.html">Box2D</a></div><div class="sidebar-section-children"><a href="Debug.html">Debug</a></div><div class="sidebar-section-children"><a href="Draw.html">Draw</a></div><div class="sidebar-section-children"><a href="DrawUtilities.html">DrawUtilities</a></div><div class="sidebar-section-children"><a href="Engine.html">Engine</a></div><div class="sidebar-section-children"><a href="Input.html">Input</a></div><div class="sidebar-section-children"><a href="Math.html">Math</a></div><div class="sidebar-section-children"><a href="Medals.html">Medals</a></div><div class="sidebar-section-children"><a href="Newgrounds.html">Newgrounds</a></div><div class="sidebar-section-children"><a href="Particles.html">Particles</a></div><div class="sidebar-section-children"><a href="PostProcess.html">PostProcess</a></div><div class="sidebar-section-children"><a href="Random.html">Random</a></div><div class="sidebar-section-children"><a href="Settings.html">Settings</a></div><div class="sidebar-section-children"><a href="TileLayers.html">TileLayers</a></div><div class="sidebar-section-children"><a href="UISystem.html">UISystem</a></div><div class="sidebar-section-children"><a href="Utilities.html">Utilities</a></div><div class="sidebar-section-children"><a href="WebGL.html">WebGL</a></div><div class="sidebar-section-children"><a href="ZzFXM.html">ZzFXM</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"><div class="navbar-item"><a id="" href="https://github.com/KilledByAPixel/LittleJS" target="_blank">GitHub</a></div><div class="navbar-item"><a id="" href="https://killedbyapixel.github.io/LittleJS/examples/" target="_blank">Examples</a></div><div class="navbar-item"><a id="" href="https://github.com/KilledByAPixel/LittleJS/blob/main/FAQ.md" target="_blank">FAQ</a></div></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section><header><h1 id="UIObject-title" class="has-anchor"><span class="ancestors"><a href="UISystem.html">UISystem</a>.</span> UIObject</h1><div class="class-description"><p>UI Object - Base level object for all UI elements</p></div></header><article><div class="container-overview"><h2 id="constructor" class="has-anchor">Constructor</h2><h3 class="name has-anchor" id="UIObject"><span class="type-signature"></span>new UIObject<span class="signature">(pos<span class="signature-attributes">opt</span>, size<span class="signature-attributes">opt</span>)</span></h3><div class="description"><p>Create a UIObject</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><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>pos</code></td><td class="type"><span class="param-type">Vector2</span></td><td class="attributes"><optional><br></td><td class="default">vec2()</td><td class="description last"></td></tr><tr><td class="name"><code>size</code></td><td class="type"><span class="param-type">Vector2</span></td><td class="attributes"><optional><br></td><td class="default">vec2(1)</td><td class="description last"></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line621">line 621</a></li></ul></dd></div></dl></div><h2 id="members" class="subsection-title has-anchor">Members</h2><h3 class="name has-anchor" id="activeColor"><span class="type-signature"></span>activeColor<span class="type-signature"></span></h3><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="type"><span class="param-type">Color</span></td><td class="description last"><p>Color of the object when active, uses hoverColor if undefined</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line641">line 641</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="canBeHover"><span class="type-signature"></span>canBeHover<span class="type-signature"></span></h3><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="type"><span class="param-type">boolean</span></td><td class="description last"><p>True if this can be a hover object</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line695">line 695</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="children"><span class="type-signature"></span>children<span class="type-signature"></span></h3><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="type"><span class="param-type">Array.<UIObject></span></td><td class="description last"><p>A list of this object's children</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line679">line 679</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="color"><span class="type-signature"></span>color<span class="type-signature"></span></h3><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="type"><span class="param-type">Color</span></td><td class="description last"><p>Color of the object</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line639">line 639</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="cornerRadius"><span class="type-signature"></span>cornerRadius<span class="type-signature"></span></h3><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="type"><span class="param-type">number</span></td><td class="description last"><p>Corner radius for rounded rects</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line659">line 659</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="disabled"><span class="type-signature"></span>disabled<span class="type-signature"></span></h3><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="type"><span class="param-type">boolean</span></td><td class="description last"><p>Is this object disabled?</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line647">line 647</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="disabledColor"><span class="type-signature"></span>disabledColor<span class="type-signature"></span></h3><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="type"><span class="param-type">Color</span></td><td class="description last"><p>Color when disabled</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line645">line 645</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="dragActivate"><span class="type-signature"></span>dragActivate<span class="type-signature"></span></h3><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="type"><span class="param-type">boolean</span></td><td class="description last"><p>Activate when dragged over with mouse held down</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line693">line 693</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="extraTouchSize"><span class="type-signature"></span>extraTouchSize<span class="type-signature"></span></h3><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="type"><span class="param-type">number</span></td><td class="description last"><p>Added size to make small buttons easier to touch on mobile devices</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line683">line 683</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="font"><span class="type-signature"></span>font<span class="type-signature"></span></h3><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="type"><span class="param-type">string</span></td><td class="description last"><p>Font for this object</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line661">line 661</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="fontStyle"><span class="type-signature"></span>fontStyle<span class="type-signature"></span></h3><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="type"><span class="param-type">string</span></td><td class="description last"><p>Font style for this object or undefined</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line663">line 663</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="gradientColor"><span class="type-signature"></span>gradientColor<span class="type-signature"></span></h3><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="type"><span class="param-type">Color</span></td><td class="description last"><p>Uses a gradient fill combined with color</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line655">line 655</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="hoverColor"><span class="type-signature"></span>hoverColor<span class="type-signature"></span></h3><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="type"><span class="param-type">Color</span></td><td class="description last"><p>Color used when hovering over the object</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line651">line 651</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="interactive"><span class="type-signature"></span>interactive<span class="type-signature"></span></h3><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="type"><span class="param-type">boolean</span></td><td class="description last"><p>Is this element interactive</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line691">line 691</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="lineColor"><span class="type-signature"></span>lineColor<span class="type-signature"></span></h3><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="type"><span class="param-type">Color</span></td><td class="description last"><p>Color for line drawing</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line653">line 653</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="lineWidth"><span class="type-signature"></span>lineWidth<span class="type-signature"></span></h3><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="type"><span class="param-type">number</span></td><td class="description last"><p>Width for line drawing</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line657">line 657</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="localPos"><span class="type-signature"></span>localPos<span class="type-signature"></span></h3><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="type"><span class="param-type">Vector2</span></td><td class="description last"><p>Local position of the object</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line633">line 633</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="navigationAutoSelect"><span class="type-signature"></span>navigationAutoSelect<span class="type-signature"></span></h3><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="type"><span class="param-type">boolean</span></td><td class="description last"><p>Should this be auto selected by navigation? Must also have valid navigation index.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line705">line 705</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="navigationIndex"><span class="type-signature"></span>navigationIndex<span class="type-signature"></span></h3><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="type"><span class="param-type">number</span></td><td class="description last"><p>Optional navigation order index, lower values are selected first</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line703">line 703</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="parent"><span class="type-signature"></span>parent<span class="type-signature"></span></h3><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="type"><span class="param-type">UIObject</span></td><td class="description last"><p>This object's parent, position is in parent space</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line681">line 681</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="pos"><span class="type-signature"></span>pos<span class="type-signature"></span></h3><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="type"><span class="param-type">Vector2</span></td><td class="description last"><p>Screen space position of the object</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line635">line 635</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="shadowBlur"><span class="type-signature"></span>shadowBlur<span class="type-signature"></span></h3><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="type"><span class="param-type">number</span></td><td class="description last"><p>Size of shadow blur</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line699">line 699</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="shadowColor"><span class="type-signature"></span>shadowColor<span class="type-signature"></span></h3><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="type"><span class="param-type">Color</span></td><td class="description last"><p>Color for shadow, undefined if no shadow</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line697">line 697</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="shadowOffset"><span class="type-signature"></span>shadowOffset<span class="type-signature"></span></h3><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="type"><span class="param-type">Vector2</span></td><td class="description last"><p>Offset of shadow blur</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line701">line 701</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="size"><span class="type-signature"></span>size<span class="type-signature"></span></h3><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="type"><span class="param-type">Vector2</span></td><td class="description last"><p>Screen space size of the object</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line637">line 637</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="soundClick"><span class="type-signature"></span>soundClick<span class="type-signature"></span></h3><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="type"><span class="param-type">Sound</span></td><td class="description last"><p>Sound when interactive element is clicked</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line689">line 689</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="soundPress"><span class="type-signature"></span>soundPress<span class="type-signature"></span></h3><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="type"><span class="param-type">Sound</span></td><td class="description last"><p>Sound when interactive element is pressed</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line685">line 685</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="soundRelease"><span class="type-signature"></span>soundRelease<span class="type-signature"></span></h3><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="type"><span class="param-type">Sound</span></td><td class="description last"><p>Sound when interactive element is released</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line687">line 687</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="text"><span class="type-signature"></span>text<span class="type-signature"></span></h3><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="type"><span class="param-type">string</span></td><td class="description last"><p>Text for this ui object</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line643">line 643</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="textColor"><span class="type-signature"></span>textColor<span class="type-signature"></span></h3><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="type"><span class="param-type">Color</span></td><td class="description last"><p>Color for text</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line649">line 649</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="textFitScale"><span class="type-signature"></span>textFitScale<span class="type-signature"></span></h3><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="type"><span class="param-type">number</span></td><td class="description last"><p>Scale text to fit in the object</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line669">line 669</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="textHeight"><span class="type-signature"></span>textHeight<span class="type-signature"></span></h3><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="type"><span class="param-type">number</span></td><td class="description last"><p>Override for text height</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line667">line 667</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="textLineColor"><span class="type-signature"></span>textLineColor<span class="type-signature"></span></h3><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="type"><span class="param-type">number</span></td><td class="description last"><p>Color for text line drawing</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line673">line 673</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="textLineWidth"><span class="type-signature"></span>textLineWidth<span class="type-signature"></span></h3><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="type"><span class="param-type">number</span></td><td class="description last"><p>Width for text line drawing</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line675">line 675</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="textShadow"><span class="type-signature"></span>textShadow<span class="type-signature"></span></h3><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="type"><span class="param-type">Vector2</span></td><td class="description last"><p>How much to offset the text shadow or undefined</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line671">line 671</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="textWidth"><span class="type-signature"></span>textWidth<span class="type-signature"></span></h3><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="type"><span class="param-type">number</span></td><td class="description last"><p>Override for text width</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line665">line 665</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="visible"><span class="type-signature"></span>visible<span class="type-signature"></span></h3><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="type"><span class="param-type">boolean</span></td><td class="description last"><p>Should this object be drawn</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line677">line 677</a></li></ul></dd></div></dl><h2 id="methods" class="subsection-title has-anchor">Methods</h2><h3 class="name has-anchor" id="addChild"><span class="type-signature"></span>addChild<span class="signature">(child)</span><span class="type-signature"> → {UIObject}</span></h3><div class="description"><p>Add a child UIObject to this object, returns child for chaining</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>child</code></td><td class="type"><span class="param-type">UIObject</span></td><td class="description last"></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line713">line 713</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>The child object added</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">UIObject</span></dd></dl></div><h3 class="name has-anchor" id="destroy"><span class="type-signature"></span>destroy<span class="signature">()</span></h3><div class="description"><p>Destroy this object, destroy its children, detach its parent, and mark it for removal</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line731">line 731</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="getTextSize"><span class="type-signature"></span>getTextSize<span class="signature">()</span><span class="type-signature"> → {Vector2}</span></h3><div class="description"><p>Get the size for text with overrides and scale</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line849">line 849</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Vector2</span></dd></dl></div><h3 class="name has-anchor" id="isActiveObject"><span class="type-signature"></span>isActiveObject<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h3><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line867">line 867</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>Is the mouse held onto this element</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">boolean</span></dd></dl></div><h3 class="name has-anchor" id="isHoverObject"><span class="type-signature"></span>isHoverObject<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h3><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line864">line 864</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>Is the mouse hovering over this element</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">boolean</span></dd></dl></div><h3 class="name has-anchor" id="isInteractive"><span class="type-signature"></span>isInteractive<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h3><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line873">line 873</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>Can it be interacted with</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">boolean</span></dd></dl></div><h3 class="name has-anchor" id="isMouseOverlapping"><span class="type-signature"></span>isMouseOverlapping<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h3><div class="description"><p>Check if the mouse is overlapping a box in screen space</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line748">line 748</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>True if overlapping</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">boolean</span></dd></dl></div><h3 class="name has-anchor" id="isNavigationObject"><span class="type-signature"></span>isNavigationObject<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h3><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line870">line 870</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><ul><li>Is the gamepad or keyboard navigation object</li></ul></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">boolean</span></dd></dl></div><h3 class="name has-anchor" id="navigatePressed"><span class="type-signature"></span>navigatePressed<span class="signature">()</span></h3><div class="description"><p>Called when the navigation button is pressed on this object</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line857">line 857</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="onChange"><span class="type-signature"></span>onChange<span class="signature">()</span></h3><div class="description"><p>Called when the state of this object changes</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line930">line 930</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="onClick"><span class="type-signature"></span>onClick<span class="signature">()</span></h3><div class="description"><p>Called when user clicks on this object</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line927">line 927</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="onEnter"><span class="type-signature"></span>onEnter<span class="signature">()</span></h3><div class="description"><p>Called when the mouse enters the object</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line915">line 915</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="onLeave"><span class="type-signature"></span>onLeave<span class="signature">()</span></h3><div class="description"><p>Called when the mouse leaves the object</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line918">line 918</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="onPress"><span class="type-signature"></span>onPress<span class="signature">()</span></h3><div class="description"><p>Called when the mouse is pressed while over the object</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line921">line 921</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="onRelease"><span class="type-signature"></span>onRelease<span class="signature">()</span></h3><div class="description"><p>Called when the mouse is released while over the object</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line924">line 924</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="onRender"><span class="type-signature"></span>onRender<span class="signature">()</span></h3><div class="description"><p>Called each frame before object renders</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line912">line 912</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="onUpdate"><span class="type-signature"></span>onUpdate<span class="signature">()</span></h3><div class="description"><p>Called each frame before object updates</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line909">line 909</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="removeChild"><span class="type-signature"></span>removeChild<span class="signature">(child)</span></h3><div class="description"><p>Remove a child UIObject from this object</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>child</code></td><td class="type"><span class="param-type">UIObject</span></td><td class="description last"></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line723">line 723</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="render"><span class="type-signature"></span>render<span class="signature">()</span></h3><div class="description"><p>Render the object, called automatically by plugin once each frame</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line825">line 825</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="renderDebug"><span class="type-signature"></span>renderDebug<span class="signature">(visible)</span></h3><div class="description"><p>Called if uiDebug is enabled</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>visible</code></td><td class="type"><span class="param-type">boolean</span></td><td class="default">true</td><td class="description last"></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line897">line 897</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="toString"><span class="type-signature"></span>toString<span class="signature">()</span><span class="type-signature"> → {string}</span></h3><div class="description"><p>Returns string containing info about this object for debugging</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line877">line 877</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">string</span></dd></dl></div><h3 class="name has-anchor" id="update"><span class="type-signature"></span>update<span class="signature">()</span></h3><div class="description"><p>Update the object, called automatically by plugin once each frame</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="plugins_uiSystem.js.html">plugins/uiSystem.js</a>, <a href="plugins_uiSystem.js.html#line759">line 759</a></li></ul></dd></div></dl></article></section><footer class="footer" id="PeOAagUepe"><div class="wrapper"><a href="https://github.com/KilledByAPixel/LittleJS">LittleJS - MIT License - Copyright 2021 Frank Force</a></div></footer></div></div></div><div class="search-container" id="PkfLWpAbet" style="display:none"><div class="wrapper" id="iCxFxjkHbP"><button class="icon-button search-close-button" id="VjLlGakifb" aria-label="close search"><svg><use xlink:href="#close-icon"></use></svg></button><div class="search-box-c"><svg><use xlink:href="#search-icon"></use></svg> <input type="text" id="vpcKVYIppa" class="search-input" placeholder="Search..." autofocus></div><div class="search-result-c" id="fWwVHRuDuN"><span class="search-result-c-text">Type anything to view search result</span></div></div></div><div class="mobile-menu-icon-container"><button class="icon-button" id="mobile-menu" data-isopen="false" aria-label="menu"><svg><use xlink:href="#menu-icon"></use></svg></button></div><div id="mobile-sidebar" class="mobile-sidebar-container"><div class="mobile-sidebar-wrapper"><a href="/" class="sidebar-title sidebar-title-anchor">LittleJS - The Tiny JavaScript Game Engine That Can!</a><div class="mobile-nav-links"><div class="navbar-item"><a id="" href="https://github.com/KilledByAPixel/LittleJS" target="_blank">GitHub</a></div><div class="navbar-item"><a id="" href="https://killedbyapixel.github.io/LittleJS/examples/" target="_blank">Examples</a></div><div class="navbar-item"><a id="" href="https://github.com/KilledByAPixel/LittleJS/blob/main/FAQ.md" target="_blank">FAQ</a></div></div><div class="mobile-sidebar-items-c"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="Audio.Sound.html">Sound</a></div><div class="sidebar-section-children"><a href="Audio.SoundInstance.html">SoundInstance</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dDistanceJoint.html">Box2dDistanceJoint</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dFrictionJoint.html">Box2dFrictionJoint</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dGearJoint.html">Box2dGearJoint</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dJoint.html">Box2dJoint</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dKinematicObject.html">Box2dKinematicObject</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dMotorJoint.html">Box2dMotorJoint</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dObject.html">Box2dObject</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dPinJoint.html">Box2dPinJoint</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dPlugin.html">Box2dPlugin</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dPrismaticJoint.html">Box2dPrismaticJoint</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dPulleyJoint.html">Box2dPulleyJoint</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dRevoluteJoint.html">Box2dRevoluteJoint</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dRopeJoint.html">Box2dRopeJoint</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dStaticObject.html">Box2dStaticObject</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dTargetJoint.html">Box2dTargetJoint</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dTileLayer.html">Box2dTileLayer</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dWeldJoint.html">Box2dWeldJoint</a></div><div class="sidebar-section-children"><a href="Box2D.Box2dWheelJoint.html">Box2dWheelJoint</a></div><div class="sidebar-section-children"><a href="Box2dRaycastResult.html">Box2dRaycastResult</a></div><div class="sidebar-section-children"><a href="Draw.FontImage.html">FontImage</a></div><div class="sidebar-section-children"><a href="Draw.TextureInfo.html">TextureInfo</a></div><div class="sidebar-section-children"><a href="Draw.TileInfo.html">TileInfo</a></div><div class="sidebar-section-children"><a href="Engine.Color.html">Color</a></div><div class="sidebar-section-children"><a href="Engine.EngineObject.html">EngineObject</a></div><div class="sidebar-section-children"><a href="Engine.RandomGenerator.html">RandomGenerator</a></div><div class="sidebar-section-children"><a href="Engine.Timer.html">Timer</a></div><div class="sidebar-section-children"><a href="Engine.Vector2.html">Vector2</a></div><div class="sidebar-section-children"><a href="Medals.Medal.html">Medal</a></div><div class="sidebar-section-children"><a href="Newgrounds.NewgroundsMedal.html">NewgroundsMedal</a></div><div class="sidebar-section-children"><a href="Newgrounds.NewgroundsPlugin.html">NewgroundsPlugin</a></div><div class="sidebar-section-children"><a href="Particles.Particle.html">Particle</a></div><div class="sidebar-section-children"><a href="Particles.ParticleEmitter.html">ParticleEmitter</a></div><div class="sidebar-section-children"><a href="PostProcess.PostProcessPlugin.html">PostProcessPlugin</a></div><div class="sidebar-section-children"><a href="TileLayers.CanvasLayer.html">CanvasLayer</a></div><div class="sidebar-section-children"><a href="TileLayers.TileCollisionLayer.html">TileCollisionLayer</a></div><div class="sidebar-section-children"><a href="TileLayers.TileLayer.html">TileLayer</a></div><div class="sidebar-section-children"><a href="TileLayers.TileLayerData.html">TileLayerData</a></div><div class="sidebar-section-children"><a href="UISystem.UIButton.html">UIButton</a></div><div class="sidebar-section-children"><a href="UISystem.UICheckbox.html">UICheckbox</a></div><div class="sidebar-section-children"><a href="UISystem.UIObject.html">UIObject</a></div><div class="sidebar-section-children"><a href="UISystem.UIScrollbar.html">UIScrollbar</a></div><div class="sidebar-section-children"><a href="UISystem.UISystemPlugin.html">UISystemPlugin</a></div><div class="sidebar-section-children"><a href="UISystem.UIText.html">UIText</a></div><div class="sidebar-section-children"><a href="UISystem.UITile.html">UITile</a></div><div class="sidebar-section-children"><a href="UISystem.UIVideo.html">UIVideo</a></div><div class="sidebar-section-children"><a href="ZzFXM.ZzFXMusic.html">ZzFXMusic</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-namespaces"><div>Namespaces</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="Audio.html">Audio</a></div><div class="sidebar-section-children"><a href="Box2D.html">Box2D</a></div><div class="sidebar-section-children"><a href="Debug.html">Debug</a></div><div class="sidebar-section-children"><a href="Draw.html">Draw</a></div><div class="sidebar-section-children"><a href="DrawUtilities.html">DrawUtilities</a></div><div class="sidebar-section-children"><a href="Engine.html">Engine</a></div><div class="sidebar-section-children"><a href="Input.html">Input</a></div><div class="sidebar-section-children"><a href="Math.html">Math</a></div><div class="sidebar-section-children"><a href="Medals.html">Medals</a></div><div class="sidebar-section-children"><a href="Newgrounds.html">Newgrounds</a></div><div class="sidebar-section-children"><a href="Particles.html">Particles</a></div><div class="sidebar-section-children"><a href="PostProcess.html">PostProcess</a></div><div class="sidebar-section-children"><a href="Random.html">Random</a></div><div class="sidebar-section-children"><a href="Settings.html">Settings</a></div><div class="sidebar-section-children"><a href="TileLayers.html">TileLayers</a></div><div class="sidebar-section-children"><a href="UISystem.html">UISystem</a></div><div class="sidebar-section-children"><a href="Utilities.html">Utilities</a></div><div class="sidebar-section-children"><a href="WebGL.html">WebGL</a></div><div class="sidebar-section-children"><a href="ZzFXM.html">ZzFXM</a></div></div></div><div class="mobile-navbar-actions"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div></div></div><script type="text/javascript" src="scripts/core.min.js"></script><script src="scripts/search.min.js" defer="defer"></script><script src="scripts/third-party/fuse.js" defer="defer"></script><script type="text/javascript">var tocbotInstance=tocbot.init({tocSelector:"#eed4d2a0bfd64539bb9df78095dec881",contentSelector:".main-content",headingSelector:"h1, h2, h3",hasInnerContainers:!0,scrollContainer:".main-content",headingsOffset:130,onClick:bringLinkToView})</script></body></html>