text: Ext.data.JsonP.Core_IgeViewport({"tagname":"class","name":"Core.IgeViewport","autodetected":{},"files":[{"filename":"IgeViewport.js","href":"IgeViewport.html#Core-IgeViewport"}],"alternateClassNames":["IgeViewport"],"extends":"IgeEntity","members":[{"name":"$","tagname":"method","owner":"Core.IgeObject","id":"method-S-","meta":{}},{"name":"$$","tagname":"method","owner":"Core.IgeObject","id":"method-S-S-","meta":{}},{"name":"_childMounted","tagname":"method","owner":"Core.IgeEntity","id":"method-_childMounted","meta":{"private":true}},{"name":"_childUnMounted","tagname":"method","owner":"Core.IgeObject","id":"method-_childUnMounted","meta":{"private":true}},{"name":"_depthSortVisit","tagname":"method","owner":"Core.IgeObject","id":"method-_depthSortVisit","meta":{"private":true}},{"name":"_handleMouseDown","tagname":"method","owner":"Core.IgeEntity","id":"method-_handleMouseDown","meta":{"private":true}},{"name":"_handleMouseIn","tagname":"method","owner":"Core.IgeEntity","id":"method-_handleMouseIn","meta":{"private":true}},{"name":"_handleMouseOut","tagname":"method","owner":"Core.IgeEntity","id":"method-_handleMouseOut","meta":{"private":true}},{"name":"_handleMouseUp","tagname":"method","owner":"Core.IgeEntity","id":"method-_handleMouseUp","meta":{"private":true}},{"name":"_handleMouseWheel","tagname":"method","owner":"Core.IgeEntity","id":"method-_handleMouseWheel","meta":{"private":true}},{"name":"_mounted","tagname":"method","owner":"Core.IgeObject","id":"method-_mounted","meta":{"private":true}},{"name":"_mouseInTrigger","tagname":"method","owner":"Core.IgeEntity","id":"method-_mouseInTrigger","meta":{"private":true}},{"name":"_objLoadReassign","tagname":"method","owner":"Core.IgeObject","id":"method-_objLoadReassign","meta":{"private":true}},{"name":"_objSaveReassign","tagname":"method","owner":"Core.IgeObject","id":"method-_objSaveReassign","meta":{"private":true}},{"name":"_originAccessorX","tagname":"method","owner":"Core.IgeEntity","id":"method-_originAccessorX","meta":{"private":true}},{"name":"_originAccessorY","tagname":"method","owner":"Core.IgeEntity","id":"method-_originAccessorY","meta":{"private":true}},{"name":"_originAccessorZ","tagname":"method","owner":"Core.IgeEntity","id":"method-_originAccessorZ","meta":{"private":true}},{"name":"_processInterpolate","tagname":"method","owner":"Core.IgeEntity","id":"method-_processInterpolate","meta":{"private":true}},{"name":"_processRemovals","tagname":"method","owner":"Core.IgeEventingClass","id":"method-_processRemovals","meta":{"private":true}},{"name":"_processTickBehaviours","tagname":"method","owner":"Core.IgeObject","id":"method-_processTickBehaviours","meta":{"private":true}},{"name":"_processUpdateBehaviours","tagname":"method","owner":"Core.IgeObject","id":"method-_processUpdateBehaviours","meta":{"private":true}},{"name":"_refreshCache","tagname":"method","owner":"Core.IgeEntity","id":"method-_refreshCache","meta":{"private":true}},{"name":"_renderCache","tagname":"method","owner":"Core.IgeEntity","id":"method-_renderCache","meta":{"private":true}},{"name":"_renderEntity","tagname":"method","owner":"Core.IgeEntity","id":"method-_renderEntity","meta":{"private":true}},{"name":"_resizeEvent","tagname":"method","owner":"Core.IgeViewport","id":"method-_resizeEvent","meta":{"private":true}},{"name":"_rotateAccessorX","tagname":"method","owner":"Core.IgeEntity","id":"method-_rotateAccessorX","meta":{"private":true}},{"name":"_rotateAccessorY","tagname":"method","owner":"Core.IgeEntity","id":"method-_rotateAccessorY","meta":{"private":true}},{"name":"_rotateAccessorZ","tagname":"method","owner":"Core.IgeEntity","id":"method-_rotateAccessorZ","meta":{"private":true}},{"name":"_scaleAccessorX","tagname":"method","owner":"Core.IgeEntity","id":"method-_scaleAccessorX","meta":{"private":true}},{"name":"_scaleAccessorY","tagname":"method","owner":"Core.IgeEntity","id":"method-_scaleAccessorY","meta":{"private":true}},{"name":"_scaleAccessorZ","tagname":"method","owner":"Core.IgeEntity","id":"method-_scaleAccessorZ","meta":{"private":true}},{"name":"_streamData","tagname":"method","owner":"Core.IgeEntity","id":"method-_streamData","meta":{"private":true}},{"name":"_streamSync","tagname":"method","owner":"Core.IgeEntity","id":"method-_streamSync","meta":{"private":true}},{"name":"_stringify","tagname":"method","owner":"Core.IgeViewport","id":"method-_stringify","meta":{}},{"name":"_swapVars","tagname":"method","owner":"Core.IgeEntity","id":"method-_swapVars","meta":{"private":true}},{"name":"_transformContext","tagname":"method","owner":"Core.IgeEntity","id":"method-_transformContext","meta":{"private":true}},{"name":"_transformPoint","tagname":"method","owner":"Core.IgeEntity","id":"method-_transformPoint","meta":{"private":true}},{"name":"_transformPoints","tagname":"method","owner":"Core.IgeEntity","id":"method-_transformPoints","meta":{"private":true}},{"name":"_translateAccessorX","tagname":"method","owner":"Core.IgeEntity","id":"method-_translateAccessorX","meta":{"private":true}},{"name":"_translateAccessorY","tagname":"method","owner":"Core.IgeEntity","id":"method-_translateAccessorY","meta":{"private":true}},{"name":"_translateAccessorZ","tagname":"method","owner":"Core.IgeEntity","id":"method-_translateAccessorZ","meta":{"private":true}},{"name":"_unMounted","tagname":"method","owner":"Core.IgeObject","id":"method-_unMounted","meta":{"private":true}},{"name":"aabb","tagname":"method","owner":"Core.IgeEntity","id":"method-aabb","meta":{}},{"name":"addBehaviour","tagname":"method","owner":"Core.IgeObject","id":"method-addBehaviour","meta":{}},{"name":"addComponent","tagname":"method","owner":"Core.IgeClass","id":"method-addComponent","meta":{}},{"name":"addGroup","tagname":"method","owner":"Core.IgeObject","id":"method-addGroup","meta":{"chainable":true}},{"name":"alive","tagname":"method","owner":"Core.IgeObject","id":"method-alive","meta":{}},{"name":"anchor","tagname":"method","owner":"Core.IgeEntity","id":"method-anchor","meta":{}},{"name":"autoSize","tagname":"method","owner":"Core.IgeViewport","id":"method-autoSize","meta":{}},{"name":"backgroundPattern","tagname":"method","owner":"Core.IgeEntity","id":"method-backgroundPattern","meta":{}},{"name":"bounds2d","tagname":"method","owner":"Core.IgeEntity","id":"method-bounds2d","meta":{}},{"name":"bounds3d","tagname":"method","owner":"Core.IgeEntity","id":"method-bounds3d","meta":{}},{"name":"cache","tagname":"method","owner":"Core.IgeEntity","id":"method-cache","meta":{}},{"name":"cacheDirty","tagname":"method","owner":"Core.IgeEntity","id":"method-cacheDirty","meta":{}},{"name":"cacheSmoothing","tagname":"method","owner":"Core.IgeEntity","id":"method-cacheSmoothing","meta":{}},{"name":"category","tagname":"method","owner":"Core.IgeObject","id":"method-category","meta":{}},{"name":"cell","tagname":"method","owner":"Core.IgeEntity","id":"method-cell","meta":{}},{"name":"cellById","tagname":"method","owner":"Core.IgeEntity","id":"method-cellById","meta":{}},{"name":"children","tagname":"method","owner":"Core.IgeObject","id":"method-children","meta":{}},{"name":"classId","tagname":"method","owner":"Core.IgeClass","id":"method-classId","meta":{}},{"name":"clone","tagname":"method","owner":"Core.IgeObject","id":"method-clone","meta":{}},{"name":"compositeAabb","tagname":"method","owner":"Core.IgeEntity","id":"method-compositeAabb","meta":{}},{"name":"compositeCache","tagname":"method","owner":"Core.IgeEntity","id":"method-compositeCache","meta":{}},{"name":"compositeStream","tagname":"method","owner":"Core.IgeEntity","id":"method-compositeStream","meta":{}},{"name":"data","tagname":"method","owner":"Core.IgeClass","id":"method-data","meta":{}},{"name":"deathTime","tagname":"method","owner":"Core.IgeEntity","id":"method-deathTime","meta":{}},{"name":"debugTransforms","tagname":"method","owner":"Core.IgeEntity","id":"method-debugTransforms","meta":{"chainable":true}},{"name":"depth","tagname":"method","owner":"Core.IgeObject","id":"method-depth","meta":{}},{"name":"depthSortChildren","tagname":"method","owner":"Core.IgeObject","id":"method-depthSortChildren","meta":{}},{"name":"depthSortMode","tagname":"method","owner":"Core.IgeObject","id":"method-depthSortMode","meta":{}},{"name":"destroy","tagname":"method","owner":"Core.IgeEntity","id":"method-destroy","meta":{}},{"name":"destroyBehaviours","tagname":"method","owner":"Core.IgeObject","id":"method-destroyBehaviours","meta":{}},{"name":"destroyChildren","tagname":"method","owner":"Core.IgeObject","id":"method-destroyChildren","meta":{"chainable":true}},{"name":"destroyComponents","tagname":"method","owner":"Core.IgeObject","id":"method-destroyComponents","meta":{"chainable":true}},{"name":"dimensionsFromCell","tagname":"method","owner":"Core.IgeEntity","id":"method-dimensionsFromCell","meta":{"chainable":true}},{"name":"dimensionsFromTexture","tagname":"method","owner":"Core.IgeEntity","id":"method-dimensionsFromTexture","meta":{"chainable":true}},{"name":"disableInterpolation","tagname":"method","owner":"Core.IgeEntity","id":"method-disableInterpolation","meta":{}},{"name":"drawBounds","tagname":"method","owner":"Core.IgeObject","id":"method-drawBounds","meta":{}},{"name":"drawBoundsData","tagname":"method","owner":"Core.IgeObject","id":"method-drawBoundsData","meta":{}},{"name":"drawMouse","tagname":"method","owner":"Core.IgeObject","id":"method-drawMouse","meta":{}},{"name":"drawMouseData","tagname":"method","owner":"Core.IgeObject","id":"method-drawMouseData","meta":{}},{"name":"emit","tagname":"method","owner":"Core.IgeEventingClass","id":"method-emit","meta":{}},{"name":"eventList","tagname":"method","owner":"Core.IgeEventingClass","id":"method-eventList","meta":{}},{"name":"extend","tagname":"method","owner":"Core.IgeClass","id":"method-extend","meta":{}},{"name":"group","tagname":"method","owner":"Core.IgeObject","id":"method-group","meta":{"deprecated":{"text":"<p>Use category() instead. A warning method to help developers move to the new groups system.</p>\n"}}},{"name":"groupCount","tagname":"method","owner":"Core.IgeObject","id":"method-groupCount","meta":{}},{"name":"groups","tagname":"method","owner":"Core.IgeObject","id":"method-groups","meta":{}},{"name":"hasBehaviour","tagname":"method","owner":"Core.IgeObject","id":"method-hasBehaviour","meta":{}},{"name":"hasParent","tagname":"method","owner":"Core.IgeObject","id":"method-hasParent","meta":{}},{"name":"height","tagname":"method","owner":"Core.IgeEntity","id":"method-height","meta":{}},{"name":"heightByTile","tagname":"method","owner":"Core.IgeEntity","id":"method-heightByTile","meta":{"chainable":true}},{"name":"hide","tagname":"method","owner":"Core.IgeEntity","id":"method-hide","meta":{"chainable":true}},{"name":"highlight","tagname":"method","owner":"Core.IgeEntity","id":"method-highlight","meta":{}},{"name":"id","tagname":"method","owner":"Core.IgeObject","id":"method-id","meta":{}},{"name":"ignoreCameraComposite","tagname":"method","owner":"Core.IgeEntity","id":"method-ignoreCameraComposite","meta":{}},{"name":"implement","tagname":"method","owner":"Core.IgeClass","id":"method-implement","meta":{}},{"name":"inAllGroups","tagname":"method","owner":"Core.IgeObject","id":"method-inAllGroups","meta":{}},{"name":"inAnyGroup","tagname":"method","owner":"Core.IgeObject","id":"method-inAnyGroup","meta":{}},{"name":"inGroup","tagname":"method","owner":"Core.IgeObject","id":"method-inGroup","meta":{}},{"name":"indestructible","tagname":"method","owner":"Core.IgeObject","id":"method-indestructible","meta":{}},{"name":"interpolateValue","tagname":"method","owner":"Core.IgeEntity","id":"method-interpolateValue","meta":{}},{"name":"isBehind","tagname":"method","owner":"Core.IgeEntity","id":"method-isBehind","meta":{}},{"name":"isHidden","tagname":"method","owner":"Core.IgeEntity","id":"method-isHidden","meta":{}},{"name":"isVisible","tagname":"method","owner":"Core.IgeEntity","id":"method-isVisible","meta":{}},{"name":"isoBoundsPoly","tagname":"method","owner":"Core.IgeEntity","id":"method-isoBoundsPoly","meta":{"deprecated":{"text":"<p>Use bounds3dPolygon instead</p>\n"}}},{"name":"isometric","tagname":"method","owner":"Core.IgeObject","id":"method-isometric","meta":{}},{"name":"isometricMounts","tagname":"method","owner":"Core.IgeObject","id":"method-isometricMounts","meta":{}},{"name":"layer","tagname":"method","owner":"Core.IgeObject","id":"method-layer","meta":{}},{"name":"lifeSpan","tagname":"method","owner":"Core.IgeEntity","id":"method-lifeSpan","meta":{}},{"name":"loadGraph","tagname":"method","owner":"Core.IgeObject","id":"method-loadGraph","meta":{}},{"name":"loadSpecialProp","tagname":"method","owner":"Core.IgeObject","id":"method-loadSpecialProp","meta":{}},{"name":"localAabb","tagname":"method","owner":"Core.IgeEntity","id":"method-localAabb","meta":{}},{"name":"localIsoBoundsPoly","tagname":"method","owner":"Core.IgeEntity","id":"method-localIsoBoundsPoly","meta":{"deprecated":{"text":"<p>Use bounds3dPolygon instead</p>\n"}}},{"name":"localToWorld","tagname":"method","owner":"Core.IgeEntity","id":"method-localToWorld","meta":{}},{"name":"localToWorldPoint","tagname":"method","owner":"Core.IgeEntity","id":"method-localToWorldPoint","meta":{}},{"name":"log","tagname":"method","owner":"Core.IgeClass","id":"method-log","meta":{}},{"name":"managed","tagname":"method","owner":"Core.IgeObject","id":"method-managed","meta":{}},{"name":"minimumVisibleArea","tagname":"method","owner":"Core.IgeViewport","id":"method-minimumVisibleArea","meta":{"chainable":true}},{"name":"mode","tagname":"method","owner":"Core.IgeObject","id":"method-mode","meta":{}},{"name":"mount","tagname":"method","owner":"Core.IgeObject","id":"method-mount","meta":{}},{"name":"mouseDown","tagname":"method","owner":"Core.IgeEntity","id":"method-mouseDown","meta":{}},{"name":"mouseDownOff","tagname":"method","owner":"Core.IgeEntity","id":"method-mouseDownOff","meta":{"chainable":true}},{"name":"mouseEventTrigger","tagname":"method","owner":"Core.IgeEntity","id":"method-mouseEventTrigger","meta":{"deprecated":{"text":"\n"}}},{"name":"mouseEventsActive","tagname":"method","owner":"Core.IgeEntity","id":"method-mouseEventsActive","meta":{}},{"name":"mouseInIsoBounds","tagname":"method","owner":"Core.IgeEntity","id":"method-mouseInIsoBounds","meta":{"deprecated":{"text":"<p>Use mouseInBounds3d instead</p>\n"}}},{"name":"mouseMove","tagname":"method","owner":"Core.IgeEntity","id":"method-mouseMove","meta":{}},{"name":"mouseMoveOff","tagname":"method","owner":"Core.IgeEntity","id":"method-mouseMoveOff","meta":{"chainable":true}},{"name":"mouseOut","tagname":"method","owner":"Core.IgeEntity","id":"method-mouseOut","meta":{}},{"name":"mouseOutOff","tagname":"method","owner":"Core.IgeEntity","id":"method-mouseOutOff","meta":{"chainable":true}},{"name":"mouseOver","tagname":"method","owner":"Core.IgeEntity","id":"method-mouseOver","meta":{}},{"name":"mouseOverOff","tagname":"method","owner":"Core.IgeEntity","id":"method-mouseOverOff","meta":{"chainable":true}},{"name":"mousePos","tagname":"method","owner":"Core.IgeViewport","id":"method-mousePos","meta":{}},{"name":"mousePosAbsolute","tagname":"method","owner":"Core.IgeEntity","id":"method-mousePosAbsolute","meta":{}},{"name":"mousePosWorld","tagname":"method","owner":"Core.IgeEntity","id":"method-mousePosWorld","meta":{}},{"name":"mouseUp","tagname":"method","owner":"Core.IgeEntity","id":"method-mouseUp","meta":{}},{"name":"mouseUpOff","tagname":"method","owner":"Core.IgeEntity","id":"method-mouseUpOff","meta":{"chainable":true}},{"name":"mouseWheel","tagname":"method","owner":"Core.IgeEntity","id":"method-mouseWheel","meta":{}},{"name":"mouseWheelOff","tagname":"method","owner":"Core.IgeEntity","id":"method-mouseWheelOff","meta":{"chainable":true}},{"name":"newFrame","tagname":"method","owner":"Core.IgeEntity","id":"method-newFrame","meta":{}},{"name":"noAabb","tagname":"method","owner":"Core.IgeEntity","id":"method-noAabb","meta":{}},{"name":"objLoad","tagname":"method","owner":"Core.IgeObject","id":"method-objLoad","meta":{}},{"name":"objSave","tagname":"method","owner":"Core.IgeObject","id":"method-objSave","meta":{}},{"name":"occupyTile","tagname":"method","owner":"Core.IgeEntity","id":"method-occupyTile","meta":{"chainable":true}},{"name":"off","tagname":"method","owner":"Core.IgeEventingClass","id":"method-off","meta":{}},{"name":"on","tagname":"method","owner":"Core.IgeEventingClass","id":"method-on","meta":{}},{"name":"opacity","tagname":"method","owner":"Core.IgeEntity","id":"method-opacity","meta":{}},{"name":"origin","tagname":"method","owner":"Core.IgeEntity","id":"method-origin","meta":{}},{"name":"originBy","tagname":"method","owner":"Core.IgeEntity","id":"method-originBy","meta":{}},{"name":"originTo","tagname":"method","owner":"Core.IgeEntity","id":"method-originTo","meta":{}},{"name":"overTiles","tagname":"method","owner":"Core.IgeEntity","id":"method-overTiles","meta":{"private":true}},{"name":"paintAabbs","tagname":"method","owner":"Core.IgeViewport","id":"method-paintAabbs","meta":{}},{"name":"parent","tagname":"method","owner":"Core.IgeObject","id":"method-parent","meta":{}},{"name":"removeAllGroups","tagname":"method","owner":"Core.IgeObject","id":"method-removeAllGroups","meta":{"chainable":true}},{"name":"removeBehaviour","tagname":"method","owner":"Core.IgeObject","id":"method-removeBehaviour","meta":{}},{"name":"removeComponent","tagname":"method","owner":"Core.IgeClass","id":"method-removeComponent","meta":{}},{"name":"removeGroup","tagname":"method","owner":"Core.IgeObject","id":"method-removeGroup","meta":{"chainable":true}},{"name":"rotate","tagname":"method","owner":"Core.IgeEntity","id":"method-rotate","meta":{}},{"name":"rotateBy","tagname":"method","owner":"Core.IgeEntity","id":"method-rotateBy","meta":{}},{"name":"rotateTo","tagname":"method","owner":"Core.IgeEntity","id":"method-rotateTo","meta":{}},{"name":"rotateToPoint","tagname":"method","owner":"Core.IgeEntity","id":"method-rotateToPoint","meta":{"chainable":true}},{"name":"saveSpecialProp","tagname":"method","owner":"Core.IgeObject","id":"method-saveSpecialProp","meta":{}},{"name":"scale","tagname":"method","owner":"Core.IgeEntity","id":"method-scale","meta":{}},{"name":"scaleBy","tagname":"method","owner":"Core.IgeEntity","id":"method-scaleBy","meta":{}},{"name":"scaleTo","tagname":"method","owner":"Core.IgeEntity","id":"method-scaleTo","meta":{}},{"name":"scene","tagname":"method","owner":"Core.IgeViewport","id":"method-scene","meta":{}},{"name":"screenPosition","tagname":"method","owner":"Core.IgeViewport","id":"method-screenPosition","meta":{}},{"name":"show","tagname":"method","owner":"Core.IgeEntity","id":"method-show","meta":{"chainable":true}},{"name":"size3d","tagname":"method","owner":"Core.IgeEntity","id":"method-size3d","meta":{"deprecated":{"text":"<p>Use bounds3d instead</p>\n"}}},{"name":"streamControl","tagname":"method","owner":"Core.IgeEntity","id":"method-streamControl","meta":{}},{"name":"streamCreate","tagname":"method","owner":"Core.IgeEntity","id":"method-streamCreate","meta":{}},{"name":"streamCreateData","tagname":"method","owner":"Core.IgeEntity","id":"method-streamCreateData","meta":{}},{"name":"streamDestroy","tagname":"method","owner":"Core.IgeEntity","id":"method-streamDestroy","meta":{}},{"name":"streamEmitCreated","tagname":"method","owner":"Core.IgeEntity","id":"method-streamEmitCreated","meta":{}},{"name":"streamFloatPrecision","tagname":"method","owner":"Core.IgeEntity","id":"method-streamFloatPrecision","meta":{}},{"name":"streamForceUpdate","tagname":"method","owner":"Core.IgeEntity","id":"method-streamForceUpdate","meta":{"chainable":true}},{"name":"streamMode","tagname":"method","owner":"Core.IgeEntity","id":"method-streamMode","meta":{}},{"name":"streamProperty","tagname":"method","owner":"Core.IgeEntity","id":"method-streamProperty","meta":{}},{"name":"streamSectionData","tagname":"method","owner":"Core.IgeEntity","id":"method-streamSectionData","meta":{}},{"name":"streamSections","tagname":"method","owner":"Core.IgeEntity","id":"method-streamSections","meta":{}},{"name":"streamSectionsPull","tagname":"method","owner":"Core.IgeEntity","id":"method-streamSectionsPull","meta":{"chainable":true}},{"name":"streamSectionsPush","tagname":"method","owner":"Core.IgeEntity","id":"method-streamSectionsPush","meta":{"chainable":true}},{"name":"streamSync","tagname":"method","owner":"Core.IgeEntity","id":"method-streamSync","meta":{"chainable":true}},{"name":"streamSyncInterval","tagname":"method","owner":"Core.IgeEntity","id":"method-streamSyncInterval","meta":{}},{"name":"stringify","tagname":"method","owner":"Core.IgeObject","id":"method-stringify","meta":{}},{"name":"texture","tagname":"method","owner":"Core.IgeEntity","id":"method-texture","meta":{}},{"name":"tick","tagname":"method","owner":"Core.IgeViewport","id":"method-tick","meta":{}},{"name":"translate","tagname":"method","owner":"Core.IgeEntity","id":"method-translate","meta":{}},{"name":"translateBy","tagname":"method","owner":"Core.IgeEntity","id":"method-translateBy","meta":{}},{"name":"translateTo","tagname":"method","owner":"Core.IgeEntity","id":"method-translateTo","meta":{}},{"name":"translateToPoint","tagname":"method","owner":"Core.IgeEntity","id":"method-translateToPoint","meta":{}},{"name":"translateToTile","tagname":"method","owner":"Core.IgeEntity","id":"method-translateToTile","meta":{"chainable":true}},{"name":"unMount","tagname":"method","owner":"Core.IgeObject","id":"method-unMount","meta":{}},{"name":"unOccupyTile","tagname":"method","owner":"Core.IgeEntity","id":"method-unOccupyTile","meta":{"chainable":true,"private":true}},{"name":"update","tagname":"method","owner":"Core.IgeViewport","id":"method-update","meta":{}},{"name":"updateTransform","tagname":"method","owner":"Core.IgeEntity","id":"method-updateTransform","meta":{"chainable":true}},{"name":"vanilla","tagname":"method","owner":"Core.IgeClass","id":"method-vanilla","meta":{}},{"name":"viewArea","tagname":"method","owner":"Core.IgeViewport","id":"method-viewArea","meta":{}},{"name":"viewCheckChildren","tagname":"method","owner":"Core.IgeObject","id":"method-viewCheckChildren","meta":{"chainable":true,"experimental":{"text":"\n"}}},{"name":"viewChecking","tagname":"method","owner":"Core.IgeObject","id":"method-viewChecking","meta":{}},{"name":"width","tagname":"method","owner":"Core.IgeEntity","id":"method-width","meta":{}},{"name":"widthByTile","tagname":"method","owner":"Core.IgeEntity","id":"method-widthByTile","meta":{"chainable":true}},{"name":"worldPosition","tagname":"method","owner":"Core.IgeEntity","id":"method-worldPosition","meta":{}},{"name":"worldRotationZ","tagname":"method","owner":"Core.IgeEntity","id":"method-worldRotationZ","meta":{}},{"name":"compositeReady","tagname":"event","owner":"Core.IgeEntity","id":"event-compositeReady","meta":{}},{"name":"destroyed","tagname":"event","owner":"Core.IgeEntity","id":"event-destroyed","meta":{}},{"name":"interpolationLag","tagname":"event","owner":"Core.IgeEntity","id":"event-interpolationLag","meta":{}},{"name":"mounted","tagname":"event","owner":"Core.IgeObject","id":"event-mounted","meta":{}},{"name":"mouseDown","tagname":"event","owner":"Core.IgeEntity","id":"event-mouseDown","meta":{}},{"name":"mouseMove","tagname":"event","owner":"Core.IgeEntity","id":"event-mouseMove","meta":{}},{"name":"mouseOut","tagname":"event","owner":"Core.IgeEntity","id":"event-mouseOut","meta":{}},{"name":"mouseOver","tagname":"event","owner":"Core.IgeEntity","id":"event-mouseOver","meta":{}},{"name":"mouseUp","tagname":"event","owner":"Core.IgeEntity","id":"event-mouseUp","meta":{}},{"name":"mouseWheel","tagname":"event","owner":"Core.IgeEntity","id":"event-mouseWheel","meta":{}},{"name":"streamPropChange","tagname":"event","owner":"Core.IgeEntity","id":"event-streamPropChange","meta":{}}],"aliases":{},"id":"class-Core.IgeViewport","component":false,"superclasses":["Core.IgeClass","Core.IgeEventingClass","Core.IgeObject","Core.IgeEntity"],"subclasses":[],"mixedInto":[],"mixins":[],"parentMixins":[],"requires":[],"uses":[],"html":"<div><pre class=\"hierarchy\"><h4>Alternate names</h4><div class='alternate-class-name'>IgeViewport</div><h4>Hierarchy</h4><div class='subclass first-child'><a href='#!/api/Core.IgeClass' rel='Core.IgeClass' class='docClass'>Core.IgeClass</a><div class='subclass '><a href='#!/api/Core.IgeEventingClass' rel='Core.IgeEventingClass' class='docClass'>Core.IgeEventingClass</a><div class='subclass '><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='docClass'>Core.IgeObject</a><div class='subclass '><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='docClass'>Core.IgeEntity</a><div class='subclass '><strong>Core.IgeViewport</strong></div></div></div></div></div><h4>Files</h4><div class='dependency'><a href='source/IgeViewport.html#Core-IgeViewport' target='_blank'>IgeViewport.js</a></div></pre><div class='doc-contents'><p>Creates a new viewport.</p>\n</div><div class='members'><div class='members-section'><div class='definedBy'>Defined By</div><h3 class='members-title icon-method'>Methods</h3><div class='subsection'><div id='method-S-' class='member first-child inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-S-' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-S-' class='name expandable'>$</a>( <span class='pre'>id</span> ) : Object/undefined<span class=\"signature\"></span></div><div class='description'><div class='short'>Finds a child entity that matches the id mounted to this\nor any other child entity down the scenegraph chain. ...</div><div class='long'><p>Finds a child entity that matches the id mounted to this\nor any other child entity down the scenegraph chain. Will\nonly return an object if the entity found has this entity\nas an ancestor (parent or parent of parent etc).</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>id</span> : String<div class='sub-desc'><p>The id of the entity to find.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>Object/undefined</span><div class='sub-desc'><p>The entity or undefined.</p>\n</div></li></ul></div></div></div><div id='method-S-S-' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-S-S-' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-S-S-' class='name expandable'>$$</a>( <span class='pre'>categoryName</span> ) : Object[]<span class=\"signature\"></span></div><div class='description'><div class='short'>Finds all child entities of this or any child of this entity\ndown the scenegraph who's category matches the category ...</div><div class='long'><p>Finds all child entities of this or any child of this entity\ndown the scenegraph who's category matches the category name\npassed.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>categoryName</span> : String<div class='sub-desc'><p>The category name to scan for.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>Object[]</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-_childMounted' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-_childMounted' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-_childMounted' class='name expandable'>_childMounted</a>( <span class='pre'>child</span> )<span class=\"signature\"><span class='private' >private</span></span></div><div class='description'><div class='short'>Override the _childMounted method and apply entity-based flags. ...</div><div class='long'><p>Override the _childMounted method and apply entity-based flags.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>child</span> : <a href=\"#!/api/Core.IgeEntity\" rel=\"Core.IgeEntity\" class=\"docClass\">IgeEntity</a><div class='sub-desc'>\n</div></li></ul><p>Overrides: <a href=\"#!/api/Core.IgeObject-method-_childMounted\" rel=\"Core.IgeObject-method-_childMounted\" class=\"docClass\">Core.IgeObject._childMounted</a></p></div></div></div><div id='method-_childUnMounted' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-_childUnMounted' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-_childUnMounted' class='name expandable'>_childUnMounted</a>( <span class='pre'>obj</span> )<span class=\"signature\"><span class='private' >private</span></span></div><div class='description'><div class='short'>Called when a child object is un-mounted to this object. ...</div><div class='long'><p>Called when a child object is un-mounted to this object.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>obj</span> : Object<div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-_depthSortVisit' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-_depthSortVisit' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-_depthSortVisit' class='name expandable'>_depthSortVisit</a>( <span class='pre'>u, sortObj</span> )<span class=\"signature\"><span class='private' >private</span></span></div><div class='description'><div class='short'> ...</div><div class='long'>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>u</span> : Number<div class='sub-desc'>\n</div></li><li><span class='pre'>sortObj</span> : Object<div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-_handleMouseDown' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-_handleMouseDown' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-_handleMouseDown' class='name expandable'>_handleMouseDown</a>( <span class='pre'>event, evc, data</span> )<span class=\"signature\"><span class='private' >private</span></span></div><div class='description'><div class='short'>Handler method that determines if a mouse-down event\nshould be fired. ...</div><div class='long'><p>Handler method that determines if a mouse-down event\nshould be fired.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>event</span> : Object<div class='sub-desc'></div></li><li><span class='pre'>evc</span> : Object<div class='sub-desc'></div></li><li><span class='pre'>data</span> : Object<div class='sub-desc'></div></li></ul><h3 class='pa'>Fires</h3><ul><li><a href=\"#!/api/Core.IgeEntity-event-mouseDown\" rel=\"Core.IgeEntity-event-mouseDown\" class=\"docClass\">mouseDown</a></li></ul></div></div></div><div id='method-_handleMouseIn' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-_handleMouseIn' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-_handleMouseIn' class='name expandable'>_handleMouseIn</a>( <span class='pre'>event, evc, data</span> )<span class=\"signature\"><span class='private' >private</span></span></div><div class='description'><div class='short'>Handler method that determines which mouse-move event\nto fire, a mouse-over or a mouse-move. ...</div><div class='long'><p>Handler method that determines which mouse-move event\nto fire, a mouse-over or a mouse-move.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>event</span> : Object<div class='sub-desc'></div></li><li><span class='pre'>evc</span> : Object<div class='sub-desc'></div></li><li><span class='pre'>data</span> : Object<div class='sub-desc'></div></li></ul><h3 class='pa'>Fires</h3><ul><li><a href=\"#!/api/Core.IgeEntity-event-mouseOver\" rel=\"Core.IgeEntity-event-mouseOver\" class=\"docClass\">mouseOver</a></li><li><a href=\"#!/api/Core.IgeEntity-event-mouseMove\" rel=\"Core.IgeEntity-event-mouseMove\" class=\"docClass\">mouseMove</a></li></ul></div></div></div><div id='method-_handleMouseOut' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-_handleMouseOut' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-_handleMouseOut' class='name expandable'>_handleMouseOut</a>( <span class='pre'>event, evc, data</span> )<span class=\"signature\"><span class='private' >private</span></span></div><div class='description'><div class='short'>Handler method that determines if a mouse-out event\nshould be fired. ...</div><div class='long'><p>Handler method that determines if a mouse-out event\nshould be fired.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>event</span> : Object<div class='sub-desc'></div></li><li><span class='pre'>evc</span> : Object<div class='sub-desc'></div></li><li><span class='pre'>data</span> : Object<div class='sub-desc'></div></li></ul><h3 class='pa'>Fires</h3><ul><li><a href=\"#!/api/Core.IgeEntity-event-mouseOut\" rel=\"Core.IgeEntity-event-mouseOut\" class=\"docClass\">mouseOut</a></li></ul></div></div></div><div id='method-_handleMouseUp' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-_handleMouseUp' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-_handleMouseUp' class='name expandable'>_handleMouseUp</a>( <span class='pre'>event, evc, data</span> )<span class=\"signature\"><span class='private' >private</span></span></div><div class='description'><div class='short'>Handler method that determines if a mouse-up event\nshould be fired. ...</div><div class='long'><p>Handler method that determines if a mouse-up event\nshould be fired.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>event</span> : Object<div class='sub-desc'></div></li><li><span class='pre'>evc</span> : Object<div class='sub-desc'></div></li><li><span class='pre'>data</span> : Object<div class='sub-desc'></div></li></ul><h3 class='pa'>Fires</h3><ul><li><a href=\"#!/api/Core.IgeEntity-event-mouseUp\" rel=\"Core.IgeEntity-event-mouseUp\" class=\"docClass\">mouseUp</a></li></ul></div></div></div><div id='method-_handleMouseWheel' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-_handleMouseWheel' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-_handleMouseWheel' class='name expandable'>_handleMouseWheel</a>( <span class='pre'>event, evc, data</span> )<span class=\"signature\"><span class='private' >private</span></span></div><div class='description'><div class='short'>Handler method that determines if a mouse-wheel event\nshould be fired. ...</div><div class='long'><p>Handler method that determines if a mouse-wheel event\nshould be fired.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>event</span> : Object<div class='sub-desc'></div></li><li><span class='pre'>evc</span> : Object<div class='sub-desc'></div></li><li><span class='pre'>data</span> : Object<div class='sub-desc'></div></li></ul><h3 class='pa'>Fires</h3><ul><li><a href=\"#!/api/Core.IgeEntity-event-mouseWheel\" rel=\"Core.IgeEntity-event-mouseWheel\" class=\"docClass\">mouseWheel</a></li></ul></div></div></div><div id='method-_mounted' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-_mounted' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-_mounted' class='name expandable'>_mounted</a>( <span class='pre'>obj</span> )<span class=\"signature\"><span class='private' >private</span></span></div><div class='description'><div class='short'>Called when this object is mounted to another object. ...</div><div class='long'><p>Called when this object is mounted to another object.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>obj</span> : Object<div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-_mouseInTrigger' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-_mouseInTrigger' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-_mouseInTrigger' class='name expandable'>_mouseInTrigger</a>( <span class='pre'>evc, data</span> )<span class=\"signature\"><span class='private' >private</span></span></div><div class='description'><div class='short'>Checks mouse input types and fires the correct mouse event\nhandler. ...</div><div class='long'><p>Checks mouse input types and fires the correct mouse event\nhandler. This is an internal method that should never be\ncalled externally.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>evc</span> : Object<div class='sub-desc'><p>The input component event control object.</p>\n</div></li><li><span class='pre'>data</span> : Object<div class='sub-desc'><p>Data passed by the input component into\nthe new event.</p>\n</div></li></ul><h3 class='pa'>Fires</h3><ul><li><a href=\"#!/api/Core.IgeEntity-event-mouseDown\" rel=\"Core.IgeEntity-event-mouseDown\" class=\"docClass\">mouseDown</a></li><li><a href=\"#!/api/Core.IgeEntity-event-mouseMove\" rel=\"Core.IgeEntity-event-mouseMove\" class=\"docClass\">mouseMove</a></li><li><a href=\"#!/api/Core.IgeEntity-event-mouseOver\" rel=\"Core.IgeEntity-event-mouseOver\" class=\"docClass\">mouseOver</a></li><li><a href=\"#!/api/Core.IgeEntity-event-mouseUp\" rel=\"Core.IgeEntity-event-mouseUp\" class=\"docClass\">mouseUp</a></li><li><a href=\"#!/api/Core.IgeEntity-event-mouseWheel\" rel=\"Core.IgeEntity-event-mouseWheel\" class=\"docClass\">mouseWheel</a></li></ul></div></div></div><div id='method-_objLoadReassign' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-_objLoadReassign' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-_objLoadReassign' class='name expandable'>_objLoadReassign</a>( <span class='pre'>obj, newProps</span> )<span class=\"signature\"><span class='private' >private</span></span></div><div class='description'><div class='short'> ...</div><div class='long'>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>obj</span> : Object<div class='sub-desc'>\n</div></li><li><span class='pre'>newProps</span> : Array<div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-_objSaveReassign' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-_objSaveReassign' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-_objSaveReassign' class='name expandable'>_objSaveReassign</a>( <span class='pre'>obj, ref</span> ) : Object<span class=\"signature\"><span class='private' >private</span></span></div><div class='description'><div class='short'> ...</div><div class='long'>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>obj</span> : Object<div class='sub-desc'>\n</div></li><li><span class='pre'>ref</span> : Array<div class='sub-desc'>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>Object</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-_originAccessorX' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-_originAccessorX' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-_originAccessorX' class='name expandable'>_originAccessorX</a>( <span class='pre'>[val]</span> ) : *<span class=\"signature\"><span class='private' >private</span></span></div><div class='description'><div class='short'>The origin accessor method for the x axis. ...</div><div class='long'><p>The origin accessor method for the x axis. This\nmethod is not called directly but is accessed through\nthe accessor object obtained by calling entity.origin().</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Number (optional)<div class='sub-desc'><p>The new value to apply to the co-ordinate.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-_originAccessorY' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-_originAccessorY' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-_originAccessorY' class='name expandable'>_originAccessorY</a>( <span class='pre'>[val]</span> ) : *<span class=\"signature\"><span class='private' >private</span></span></div><div class='description'><div class='short'>The origin accessor method for the y axis. ...</div><div class='long'><p>The origin accessor method for the y axis. This\nmethod is not called directly but is accessed through\nthe accessor object obtained by calling entity.origin().</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Number (optional)<div class='sub-desc'><p>The new value to apply to the co-ordinate.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-_originAccessorZ' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-_originAccessorZ' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-_originAccessorZ' class='name expandable'>_originAccessorZ</a>( <span class='pre'>[val]</span> ) : *<span class=\"signature\"><span class='private' >private</span></span></div><div class='description'><div class='short'>The origin accessor method for the z axis. ...</div><div class='long'><p>The origin accessor method for the z axis. This\nmethod is not called directly but is accessed through\nthe accessor object obtained by calling entity.origin().</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Number (optional)<div class='sub-desc'><p>The new value to apply to the co-ordinate.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-_processInterpolate' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-_processInterpolate' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-_processInterpolate' class='name expandable'>_processInterpolate</a>( <span class='pre'>renderTime, maxLerp</span> )<span class=\"signature\"><span class='private' >private</span></span></div><div class='description'><div class='short'>Processes the time stream for the entity. ...</div><div class='long'><p>Processes the time stream for the entity.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>renderTime</span> : Number<div class='sub-desc'><p>The time that the time stream is\ntargeting to render the entity at.</p>\n</div></li><li><span class='pre'>maxLerp</span> : Number<div class='sub-desc'><p>The maximum lerp before the value\nis assigned directly instead of being interpolated.</p>\n</div></li></ul><h3 class='pa'>Fires</h3><ul><li><a href=\"#!/api/Core.IgeEntity-event-interpolationLag\" rel=\"Core.IgeEntity-event-interpolationLag\" class=\"docClass\">interpolationLag</a></li></ul></div></div></div><div id='method-_processRemovals' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEventingClass' rel='Core.IgeEventingClass' class='defined-in docClass'>Core.IgeEventingClass</a><br/><a href='source/IgeEventingClass.html#Core-IgeEventingClass-method-_processRemovals' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEventingClass-method-_processRemovals' class='name expandable'>_processRemovals</a>( <span class='pre'></span> )<span class=\"signature\"><span class='private' >private</span></span></div><div class='description'><div class='short'>Loops the removals array and processes off() calls for\neach array item. ...</div><div class='long'><p>Loops the removals array and processes off() calls for\neach array item.</p>\n</div></div></div><div id='method-_processTickBehaviours' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-_processTickBehaviours' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-_processTickBehaviours' class='name expandable'>_processTickBehaviours</a>( <span class='pre'>ctx</span> )<span class=\"signature\"><span class='private' >private</span></span></div><div class='description'><div class='short'>Calls each behaviour method for the object. ...</div><div class='long'><p>Calls each behaviour method for the object.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>ctx</span> : Object<div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-_processUpdateBehaviours' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-_processUpdateBehaviours' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-_processUpdateBehaviours' class='name expandable'>_processUpdateBehaviours</a>( <span class='pre'>ctx, tickDelta</span> )<span class=\"signature\"><span class='private' >private</span></span></div><div class='description'><div class='short'>Calls each behaviour method for the object. ...</div><div class='long'><p>Calls each behaviour method for the object.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>ctx</span> : Object<div class='sub-desc'>\n</div></li><li><span class='pre'>tickDelta</span> : Object<div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-_refreshCache' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-_refreshCache' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-_refreshCache' class='name expandable'>_refreshCache</a>( <span class='pre'>dontTransform</span> )<span class=\"signature\"><span class='private' >private</span></span></div><div class='description'><div class='short'> ...</div><div class='long'>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>dontTransform</span> : Object<div class='sub-desc'>\n</div></li></ul><h3 class='pa'>Fires</h3><ul><li><a href=\"#!/api/Core.IgeEntity-event-compositeReady\" rel=\"Core.IgeEntity-event-compositeReady\" class=\"docClass\">compositeReady</a></li></ul></div></div></div><div id='method-_renderCache' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-_renderCache' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-_renderCache' class='name expandable'>_renderCache</a>( <span class='pre'>ctx</span> )<span class=\"signature\"><span class='private' >private</span></span></div><div class='description'><div class='short'>Draws the cached off-screen canvas image data to the passed canvas\ncontext. ...</div><div class='long'><p>Draws the cached off-screen canvas image data to the passed canvas\ncontext.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>ctx</span> : CanvasRenderingContext2D<div class='sub-desc'><p>The canvas context to render\nthe entity to.</p>\n</div></li></ul></div></div></div><div id='method-_renderEntity' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-_renderEntity' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-_renderEntity' class='name expandable'>_renderEntity</a>( <span class='pre'>ctx</span> )<span class=\"signature\"><span class='private' >private</span></span></div><div class='description'><div class='short'>Handles calling the texture.render() method if a texture\nis applied to the entity. ...</div><div class='long'><p>Handles calling the texture.render() method if a texture\nis applied to the entity. This part of the tick process has\nbeen abstracted to allow it to be overridden by an extending\nclass.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>ctx</span> : CanvasRenderingContext2D<div class='sub-desc'><p>The canvas context to render\nthe entity to.</p>\n</div></li></ul></div></div></div><div id='method-_resizeEvent' class='member  not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='Core.IgeViewport'>Core.IgeViewport</span><br/><a href='source/IgeViewport.html#Core-IgeViewport-method-_resizeEvent' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeViewport-method-_resizeEvent' class='name expandable'>_resizeEvent</a>( <span class='pre'>event</span> )<span class=\"signature\"><span class='private' >private</span></span></div><div class='description'><div class='short'>Handles screen resize events. ...</div><div class='long'><p>Handles screen resize events.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>event</span> : Object<div class='sub-desc'>\n</div></li></ul><p>Overrides: <a href=\"#!/api/Core.IgeObject-method-_resizeEvent\" rel=\"Core.IgeObject-method-_resizeEvent\" class=\"docClass\">Core.IgeObject._resizeEvent</a></p></div></div></div><div id='method-_rotateAccessorX' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-_rotateAccessorX' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-_rotateAccessorX' class='name expandable'>_rotateAccessorX</a>( <span class='pre'>[val]</span> ) : *<span class=\"signature\"><span class='private' >private</span></span></div><div class='description'><div class='short'>The rotate accessor method for the x axis. ...</div><div class='long'><p>The rotate accessor method for the x axis. This\nmethod is not called directly but is accessed through\nthe accessor object obtained by calling entity.rotate().</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Number (optional)<div class='sub-desc'><p>The new value to apply to the co-ordinate.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-_rotateAccessorY' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-_rotateAccessorY' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-_rotateAccessorY' class='name expandable'>_rotateAccessorY</a>( <span class='pre'>[val]</span> ) : *<span class=\"signature\"><span class='private' >private</span></span></div><div class='description'><div class='short'>The rotate accessor method for the y axis. ...</div><div class='long'><p>The rotate accessor method for the y axis. This\nmethod is not called directly but is accessed through\nthe accessor object obtained by calling entity.rotate().</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Number (optional)<div class='sub-desc'><p>The new value to apply to the co-ordinate.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-_rotateAccessorZ' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-_rotateAccessorZ' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-_rotateAccessorZ' class='name expandable'>_rotateAccessorZ</a>( <span class='pre'>[val]</span> ) : *<span class=\"signature\"><span class='private' >private</span></span></div><div class='description'><div class='short'>The rotate accessor method for the z axis. ...</div><div class='long'><p>The rotate accessor method for the z axis. This\nmethod is not called directly but is accessed through\nthe accessor object obtained by calling entity.rotate().</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Number (optional)<div class='sub-desc'><p>The new value to apply to the co-ordinate.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-_scaleAccessorX' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-_scaleAccessorX' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-_scaleAccessorX' class='name expandable'>_scaleAccessorX</a>( <span class='pre'>[val]</span> ) : *<span class=\"signature\"><span class='private' >private</span></span></div><div class='description'><div class='short'>The scale accessor method for the x axis. ...</div><div class='long'><p>The scale accessor method for the x axis. This\nmethod is not called directly but is accessed through\nthe accessor object obtained by calling entity.scale().</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Number (optional)<div class='sub-desc'><p>The new value to apply to the co-ordinate.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-_scaleAccessorY' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-_scaleAccessorY' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-_scaleAccessorY' class='name expandable'>_scaleAccessorY</a>( <span class='pre'>[val]</span> ) : *<span class=\"signature\"><span class='private' >private</span></span></div><div class='description'><div class='short'>The scale accessor method for the y axis. ...</div><div class='long'><p>The scale accessor method for the y axis. This\nmethod is not called directly but is accessed through\nthe accessor object obtained by calling entity.scale().</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Number (optional)<div class='sub-desc'><p>The new value to apply to the co-ordinate.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-_scaleAccessorZ' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-_scaleAccessorZ' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-_scaleAccessorZ' class='name expandable'>_scaleAccessorZ</a>( <span class='pre'>[val]</span> ) : *<span class=\"signature\"><span class='private' >private</span></span></div><div class='description'><div class='short'>The scale accessor method for the z axis. ...</div><div class='long'><p>The scale accessor method for the z axis. This\nmethod is not called directly but is accessed through\nthe accessor object obtained by calling entity.scale().</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Number (optional)<div class='sub-desc'><p>The new value to apply to the co-ordinate.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-_streamData' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-_streamData' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-_streamData' class='name expandable'>_streamData</a>( <span class='pre'></span> ) : String<span class=\"signature\"><span class='private' >private</span></span></div><div class='description'><div class='short'>Generates and returns the current stream data for this entity. ...</div><div class='long'><p>Generates and returns the current stream data for this entity. The\ndata will usually include only properties that have changed since\nthe last time the stream data was generated. The returned data is\na string that has been compressed in various ways to reduce network\noverhead during transmission.</p>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'>String</span><div class='sub-desc'><p>The string representation of the stream data for\nthis entity.</p>\n</div></li></ul><h3 class='pa'>Fires</h3><ul><li><a href=\"#!/api/Core.IgeEntity-event-streamPropChange\" rel=\"Core.IgeEntity-event-streamPropChange\" class=\"docClass\">streamPropChange</a></li></ul></div></div></div><div id='method-_streamSync' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-_streamSync' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-_streamSync' class='name expandable'>_streamSync</a>( <span class='pre'>recipientArr, streamRoomId</span> )<span class=\"signature\"><span class='private' >private</span></span></div><div class='description'><div class='short'>Asks the stream system to queue the stream data to the specified\nclient id or array of ids. ...</div><div class='long'><p>Asks the stream system to queue the stream data to the specified\nclient id or array of ids.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>recipientArr</span> : Array<div class='sub-desc'><p>The array of ids of the client(s) to\nqueue stream data for. The stream data being queued\nis returned by a call to this._streamData().</p>\n</div></li><li><span class='pre'>streamRoomId</span> : String<div class='sub-desc'><p>The id of the room the entity belongs\nin (can be undefined or null if no room assigned).</p>\n</div></li></ul><h3 class='pa'>Fires</h3><ul><li><a href=\"#!/api/Core.IgeEntity-event-streamPropChange\" rel=\"Core.IgeEntity-event-streamPropChange\" class=\"docClass\">streamPropChange</a></li></ul></div></div></div><div id='method-_stringify' class='member  not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='Core.IgeViewport'>Core.IgeViewport</span><br/><a href='source/IgeViewport.html#Core-IgeViewport-method-_stringify' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeViewport-method-_stringify' class='name expandable'>_stringify</a>( <span class='pre'></span> ) : String<span class=\"signature\"></span></div><div class='description'><div class='short'>Returns a string containing a code fragment that when\nevaluated will reproduce this object's properties via\nchained c...</div><div class='long'><p>Returns a string containing a code fragment that when\nevaluated will reproduce this object's properties via\nchained commands. This method will only check for\nproperties that are directly related to this class.\nOther properties are handled by their own class method.</p>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'>String</span><div class='sub-desc'>\n</div></li></ul><p>Overrides: <a href=\"#!/api/Core.IgeEntity-method-_stringify\" rel=\"Core.IgeEntity-method-_stringify\" class=\"docClass\">Core.IgeEntity._stringify</a></p></div></div></div><div id='method-_swapVars' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-_swapVars' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-_swapVars' class='name expandable'>_swapVars</a>( <span class='pre'>x, y</span> ) : Array<span class=\"signature\"><span class='private' >private</span></span></div><div class='description'><div class='short'>Takes two values and returns them as an array where index [0]\nis the y argument and index[1] is the x argument. ...</div><div class='long'><p>Takes two values and returns them as an array where index [0]\nis the y argument and index[1] is the x argument. This method\nis used specifically in the 3d bounds intersection process to\ndetermine entity depth sorting.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>x</span> : Number<div class='sub-desc'><p>The first value.</p>\n</div></li><li><span class='pre'>y</span> : Number<div class='sub-desc'><p>The second value.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>Array</span><div class='sub-desc'><p>The swapped arguments.</p>\n</div></li></ul></div></div></div><div id='method-_transformContext' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-_transformContext' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-_transformContext' class='name expandable'>_transformContext</a>( <span class='pre'>ctx</span> )<span class=\"signature\"><span class='private' >private</span></span></div><div class='description'><div class='short'>Sets the canvas context transform properties to match the the game\nobject's current transform values. ...</div><div class='long'><p>Sets the canvas context transform properties to match the the game\nobject's current transform values.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>ctx</span> : CanvasRenderingContext2D<div class='sub-desc'><p>The canvas context to apply\nthe transformation matrix to.</p>\n\n<h1>Transform a canvas context to the entity's local matrix values</h1>\n\n<pre><code>var canvas = document.createElement('canvas');\ncanvas.width = 800;\ncanvas.height = 600;\n\nvar ctx = canvas.getContext('2d');\nentity._transformContext(ctx);\n</code></pre>\n</div></li></ul></div></div></div><div id='method-_transformPoint' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-_transformPoint' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-_transformPoint' class='name expandable'>_transformPoint</a>( <span class='pre'>point</span> ) : <a href=\"#!/api/Core.IgePoint3d\" rel=\"Core.IgePoint3d\" class=\"docClass\">IgePoint3d</a><span class=\"signature\"><span class='private' >private</span></span></div><div class='description'><div class='short'>Transforms a point by the entity's parent world matrix and\nit's own local matrix transforming the point to this entit...</div><div class='long'><p>Transforms a point by the entity's parent world matrix and\nit's own local matrix transforming the point to this entity's\nworld space.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>point</span> : <a href=\"#!/api/Core.IgePoint3d\" rel=\"Core.IgePoint3d\" class=\"docClass\">IgePoint3d</a><div class='sub-desc'><p>The point to transform.</p>\n\n<h1>Transform a point by the entity's world matrix values</h1>\n\n<pre><code>var point = new IgePoint3d(0, 0, 0);\nentity._transformPoint(point);\n\nconsole.log(point);\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgePoint3d\" rel=\"Core.IgePoint3d\" class=\"docClass\">IgePoint3d</a></span><div class='sub-desc'><p>The transformed point.</p>\n</div></li></ul></div></div></div><div id='method-_transformPoints' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-_transformPoints' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-_transformPoints' class='name expandable'>_transformPoints</a>( <span class='pre'>points</span> )<span class=\"signature\"><span class='private' >private</span></span></div><div class='description'><div class='short'>Helper method to transform an array of points using _transformPoint. ...</div><div class='long'><p>Helper method to transform an array of points using _transformPoint.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>points</span> : Array<div class='sub-desc'><p>The points array to transform.</p>\n</div></li></ul></div></div></div><div id='method-_translateAccessorX' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-_translateAccessorX' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-_translateAccessorX' class='name expandable'>_translateAccessorX</a>( <span class='pre'>[val]</span> ) : *<span class=\"signature\"><span class='private' >private</span></span></div><div class='description'><div class='short'>The translate accessor method for the x axis. ...</div><div class='long'><p>The translate accessor method for the x axis. This\nmethod is not called directly but is accessed through\nthe accessor object obtained by calling entity.translate().</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Number (optional)<div class='sub-desc'><p>The new value to apply to the co-ordinate.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-_translateAccessorY' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-_translateAccessorY' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-_translateAccessorY' class='name expandable'>_translateAccessorY</a>( <span class='pre'>[val]</span> ) : *<span class=\"signature\"><span class='private' >private</span></span></div><div class='description'><div class='short'>The translate accessor method for the y axis. ...</div><div class='long'><p>The translate accessor method for the y axis. This\nmethod is not called directly but is accessed through\nthe accessor object obtained by calling entity.translate().</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Number (optional)<div class='sub-desc'><p>The new value to apply to the co-ordinate.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-_translateAccessorZ' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-_translateAccessorZ' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-_translateAccessorZ' class='name expandable'>_translateAccessorZ</a>( <span class='pre'>[val]</span> ) : *<span class=\"signature\"><span class='private' >private</span></span></div><div class='description'><div class='short'>The translate accessor method for the z axis. ...</div><div class='long'><p>The translate accessor method for the z axis. This\nmethod is not called directly but is accessed through\nthe accessor object obtained by calling entity.translate().</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Number (optional)<div class='sub-desc'><p>The new value to apply to the co-ordinate.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-_unMounted' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-_unMounted' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-_unMounted' class='name expandable'>_unMounted</a>( <span class='pre'>obj</span> )<span class=\"signature\"><span class='private' >private</span></span></div><div class='description'><div class='short'>Called when this object is un-mounted from it's parent. ...</div><div class='long'><p>Called when this object is un-mounted from it's parent.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>obj</span> : Object<div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-aabb' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-aabb' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-aabb' class='name expandable'>aabb</a>( <span class='pre'>[recalculate]</span> ) : <a href=\"#!/api/Core.IgeRect\" rel=\"Core.IgeRect\" class=\"docClass\">IgeRect</a><span class=\"signature\"></span></div><div class='description'><div class='short'>Calculates and returns the current axis-aligned bounding box in\nworld co-ordinates. ...</div><div class='long'><p>Calculates and returns the current axis-aligned bounding box in\nworld co-ordinates.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>recalculate</span> : Boolean (optional)<div class='sub-desc'><p>If true this will force the\nrecalculation of the AABB instead of returning a cached\nvalue.</p>\n\n<h1>Get the entity axis-aligned bounding box dimensions</h1>\n\n<pre><code>var aabb = entity.aabb();\n\nconsole.log(aabb.x);\nconsole.log(aabb.y);\nconsole.log(aabb.width);\nconsole.log(aabb.height);\n</code></pre>\n\n<h1>Get the entity axis-aligned bounding box dimensions forcing the engine to update the values first</h1>\n\n<pre><code>var aabb = entity.aabb(true); // Call with true to force update\n\nconsole.log(aabb.x);\nconsole.log(aabb.y);\nconsole.log(aabb.width);\nconsole.log(aabb.height);\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeRect\" rel=\"Core.IgeRect\" class=\"docClass\">IgeRect</a></span><div class='sub-desc'><p>The axis-aligned bounding box in world co-ordinates.</p>\n</div></li></ul></div></div></div><div id='method-addBehaviour' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-addBehaviour' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-addBehaviour' class='name expandable'>addBehaviour</a>( <span class='pre'>id, behaviour, [duringTick]</span> ) : <a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a>/Boolean<span class=\"signature\"></span></div><div class='description'><div class='short'>Adds a behaviour to the object's active behaviour list. ...</div><div class='long'><p>Adds a behaviour to the object's active behaviour list.</p>\n\n<h1>Add a behaviour with the id \"myBehaviour\"</h1>\n\n<pre><code>var entity = new IgeEntity();\nentity.addBehaviour('myBehaviour', function () {\n    // Code here will execute during each engine update for\n    // this entity. I can access the entity via the \"this\"\n    // keyword such as:\n    this._somePropertyOfTheEntity = 'moo';\n});\n\n// Now since each update we are setting _somePropertyOfTheEntity\n// to equal \"moo\" we can console log the property and get\n// the value as \"moo\"\nconsole.log(entity._somePropertyOfTheEntity);\n</code></pre>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>id</span> : String<div class='sub-desc'>\n</div></li><li><span class='pre'>behaviour</span> : Function<div class='sub-desc'>\n</div></li><li><span class='pre'>duringTick</span> : Boolean (optional)<div class='sub-desc'><p>If true, will execute the behaviour\nduring the tick() method instead of the update() method.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a>/Boolean</span><div class='sub-desc'><p>Returns this on success or false on failure.</p>\n</div></li></ul></div></div></div><div id='method-addComponent' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeClass' rel='Core.IgeClass' class='defined-in docClass'>Core.IgeClass</a><br/><a href='source/IgeClass.html#Core-IgeClass-method-addComponent' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeClass-method-addComponent' class='name expandable'>addComponent</a>( <span class='pre'>component, [options]</span> ) : <a href=\"#!/api/Core.IgeClass\" rel=\"Core.IgeClass\" class=\"docClass\">IgeClass</a><span class=\"signature\"></span></div><div class='description'><div class='short'>Creates a new instance of the component argument passing\nthe options argument to the component as it is initialised. ...</div><div class='long'><p>Creates a new instance of the component argument passing\nthe options argument to the component as it is initialised.\nThe new component instance is then added to \"this\" via\na property name that is defined in the component class as\n\"componentId\".</p>\n\n<h1>Add the velocity component to an entity</h1>\n\n<pre><code>var entity = new IgeEntity();\nentity.addComponent(IgeVelocityComponent);\n\n// Now that the component is added, we can access\n// the component via it's namespace. Call the\n// \"byAngleAndPower\" method of the velocity component:\nentity.velocity.byAngleAndPower(Math.radians(20), 0.1);\n</code></pre>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>component</span> : <a href=\"#!/api/Core.IgeClass\" rel=\"Core.IgeClass\" class=\"docClass\">IgeClass</a><div class='sub-desc'><p>The class definition of the component.</p>\n</div></li><li><span class='pre'>options</span> : Object (optional)<div class='sub-desc'><p>An options parameter to pass to the component\non init.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeClass\" rel=\"Core.IgeClass\" class=\"docClass\">IgeClass</a></span><div class='sub-desc'><p>this</p>\n</div></li></ul></div></div></div><div id='method-addGroup' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-addGroup' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-addGroup' class='name expandable'>addGroup</a>( <span class='pre'>groupName</span> ) : <a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a><span class=\"signature\"><span class='chainable' >chainable</span></span></div><div class='description'><div class='short'>Adds this entity to a group or groups passed as\narguments. ...</div><div class='long'><p>Adds this entity to a group or groups passed as\narguments.</p>\n\n<h1>Add entity to a single group</h1>\n\n<pre><code>var entity = new IgeEntity();\nentity.addGroup('g1');\n</code></pre>\n\n<h1>Add entity to multiple groups</h1>\n\n<pre><code>var entity = new IgeEntity();\nentity.addGroup('g1', 'g2', 'g3');\n</code></pre>\n\n<h1>Add entity to multiple groups via an array</h1>\n\n<pre><code>var entity = new IgeEntity();\nentity.addGroup(['g1', 'g2', 'g3']);\n</code></pre>\n\n<h1>Add entity to multiple groups via multiple arrays</h1>\n\n<pre><code>var entity = new IgeEntity();\nentity.addGroup(['g1', 'g2', 'g3'], ['g4', 'g5']);\n</code></pre>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>groupName</span> : String/String[]<div class='sub-desc'><p>A group or array of group names\nto add the entity to.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a></span><div class='sub-desc'><p>this</p>\n</div></li></ul></div></div></div><div id='method-alive' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-alive' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-alive' class='name expandable'>alive</a>( <span class='pre'>[val]</span> ) : <a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a>/Boolean<span class=\"signature\"></span></div><div class='description'><div class='short'>Determines if the object is alive or not. ...</div><div class='long'><p>Determines if the object is alive or not. The alive\nvalue is automatically set to false when the object's\ndestroy() method is called. Useful for checking if\nan object that you are holding a reference to has been\ndestroyed.</p>\n\n<h1>Get the alive flag value</h1>\n\n<pre><code>var entity = new IgeEntity();\nconsole.log(entity.alive());\n</code></pre>\n\n<h1>Set the alive flag value</h1>\n\n<pre><code>var entity = new IgeEntity();\nentity.alive(true);\n</code></pre>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Boolean (optional)<div class='sub-desc'><p>The value to set the alive flag\nto.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a>/Boolean</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-anchor' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-anchor' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-anchor' class='name expandable'>anchor</a>( <span class='pre'>[x], [y]</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the anchor position that this entity's texture\nwill be adjusted by. ...</div><div class='long'><p>Gets / sets the anchor position that this entity's texture\nwill be adjusted by.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>x</span> : Number (optional)<div class='sub-desc'><p>The x anchor value.</p>\n</div></li><li><span class='pre'>y</span> : Number (optional)<div class='sub-desc'><p>The y anchor value.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'><p>\"this\" when arguments are passed to allow method\nchaining or the current value if no arguments are specified.</p>\n</div></li></ul></div></div></div><div id='method-autoSize' class='member  not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='Core.IgeViewport'>Core.IgeViewport</span><br/><a href='source/IgeViewport.html#Core-IgeViewport-method-autoSize' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeViewport-method-autoSize' class='name expandable'>autoSize</a>( <span class='pre'>val</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the auto-size property. ...</div><div class='long'><p>Gets / sets the auto-size property. If set to true, the viewport will\nautomatically resize to fill the entire scene.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Object<div class='sub-desc'>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-backgroundPattern' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-backgroundPattern' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-backgroundPattern' class='name expandable'>backgroundPattern</a>( <span class='pre'>texture, [repeat], [trackCamera], [isoTile]</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the texture to use as the background\npattern for this entity. ...</div><div class='long'><p>Gets / sets the texture to use as the background\npattern for this entity.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>texture</span> : <a href=\"#!/api/Core.IgeTexture\" rel=\"Core.IgeTexture\" class=\"docClass\">IgeTexture</a><div class='sub-desc'><p>The texture to use as\nthe background.</p>\n</div></li><li><span class='pre'>repeat</span> : String (optional)<div class='sub-desc'><p>The type of repeat mode either: \"repeat\",\n\"repeat-x\", \"repeat-y\" or \"none\".</p>\n</div></li><li><span class='pre'>trackCamera</span> : Boolean (optional)<div class='sub-desc'><p>If set to true, will track the camera\ntranslation and \"move\" the background with the camera.</p>\n</div></li><li><span class='pre'>isoTile</span> : Boolean (optional)<div class='sub-desc'><p>If true the tiles of the background will\nbe treated as isometric and will therefore be drawn so that they are\nlayered seamlessly in isometric view.</p>\n\n<h1>Set a background pattern for this entity with 2d tiling</h1>\n\n<pre><code>var texture = new IgeTexture('path/to/my/texture.png');\nentity.backgroundPattern(texture, 'repeat', true, false);\n</code></pre>\n\n<h1>Set a background pattern for this entity with isometric tiling</h1>\n\n<pre><code>var texture = new IgeTexture('path/to/my/texture.png');\nentity.backgroundPattern(texture, 'repeat', true, true);\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-bounds2d' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-bounds2d' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-bounds2d' class='name expandable'>bounds2d</a>( <span class='pre'>[x], [y]</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the 2d geometry of the entity. ...</div><div class='long'><p>Gets / sets the 2d geometry of the entity. The x and y values are\nrelative to the center of the entity. This geometry is used when\nrendering textures for the entity and positioning in world space as\nwell as UI positioning calculations. It holds no bearing on isometric\npositioning.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>x</span> : Number (optional)<div class='sub-desc'><p>The new x value in pixels.</p>\n</div></li><li><span class='pre'>y</span> : Number (optional)<div class='sub-desc'><p>The new y value in pixels.</p>\n\n<h1>Set the dimensions of the entity (width and height)</h1>\n\n<pre><code>entity.bounds2d(40, 40);\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'><p>\"this\" when arguments are passed to allow method\nchaining or the current value if no arguments are specified.</p>\n</div></li></ul></div></div></div><div id='method-bounds3d' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-bounds3d' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-bounds3d' class='name expandable'>bounds3d</a>( <span class='pre'>[x], [y], [z]</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the 3d geometry of the entity. ...</div><div class='long'><p>Gets / sets the 3d geometry of the entity. The x and y values are\nrelative to the center of the entity and the z value is wholly\npositive from the \"floor\". Used to define a 3d bounding cuboid for\nthe entity used in isometric depth sorting and hit testing.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>x</span> : Number (optional)<div class='sub-desc'><p>The new x value in pixels.</p>\n</div></li><li><span class='pre'>y</span> : Number (optional)<div class='sub-desc'><p>The new y value in pixels.</p>\n</div></li><li><span class='pre'>z</span> : Number (optional)<div class='sub-desc'><p>The new z value in pixels.</p>\n\n<h1>Set the dimensions of the entity (width, height and length)</h1>\n\n<pre><code>entity.bounds3d(40, 40, 20);\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'><p>\"this\" when arguments are passed to allow method\nchaining or the current value if no arguments are specified.</p>\n</div></li></ul></div></div></div><div id='method-cache' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-cache' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-cache' class='name expandable'>cache</a>( <span class='pre'>[val]</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the cache flag that determines if the entity's\ntexture rendering output should be stored on an off-screen...</div><div class='long'><p>Gets / sets the cache flag that determines if the entity's\ntexture rendering output should be stored on an off-screen\ncanvas instead of calling the texture.render() method each\ntick. Useful for expensive texture calls such as rendering\nfonts etc. If enabled, this will automatically disable advanced\ncomposite caching on this entity with a call to\ncompositeCache(false).</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Boolean (optional)<div class='sub-desc'><p>True to enable caching, false to\ndisable caching.</p>\n\n<h1>Enable entity caching</h1>\n\n<pre><code>entity.cache(true);\n</code></pre>\n\n<h1>Disable entity caching</h1>\n\n<pre><code>entity.cache(false);\n</code></pre>\n\n<h1>Get caching flag value</h1>\n\n<pre><code>var val = entity.cache();\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-cacheDirty' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-cacheDirty' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-cacheDirty' class='name expandable'>cacheDirty</a>( <span class='pre'>[val]</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the cache dirty flag. ...</div><div class='long'><p>Gets / sets the cache dirty flag. If set to true this will\ninstruct the entity to re-draw it's cached image from the\nassigned texture. Once that occurs the flag will automatically\nbe set back to false. This works in either standard cache mode\nor composite cache mode.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Boolean (optional)<div class='sub-desc'><p>True to force a cache update.</p>\n\n<h1>Get cache dirty flag value</h1>\n\n<pre><code>var val = entity.cacheDirty();\n</code></pre>\n\n<h1>Set cache dirty flag value</h1>\n\n<pre><code>entity.cacheDirty(true);\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-cacheSmoothing' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-cacheSmoothing' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-cacheSmoothing' class='name expandable'>cacheSmoothing</a>( <span class='pre'>[val]</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>When using the caching system, this boolean determines if the\ncache canvas should have image smoothing enabled or not. ...</div><div class='long'><p>When using the caching system, this boolean determines if the\ncache canvas should have image smoothing enabled or not. If\nnot set, the ige global smoothing setting will be used instead.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Boolean (optional)<div class='sub-desc'><p>True to enable smoothing, false to disable.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-category' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-category' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-category' class='name expandable'>category</a>( <span class='pre'>[val]</span> ) : <a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a>/String<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the arbitrary category name that the object belongs to. ...</div><div class='long'><p>Gets / sets the arbitrary category name that the object belongs to.</p>\n\n<h1>Get the category of an entity</h1>\n\n<pre><code>var entity = new IgeEntity();\nconsole.log(entity.category());\n</code></pre>\n\n<h1>Set the category of an entity</h1>\n\n<pre><code>var entity = new IgeEntity();\nentity.category('myNewCategory');\n</code></pre>\n\n<h1>Set the category of an entity via chaining</h1>\n\n<pre><code>var entity = new IgeEntity()\n    .category('myNewCategory');\n</code></pre>\n\n<h1>Get all the entities belonging to a category</h1>\n\n<pre><code>var entityArray = <a href=\"#!/api/Core.IgeEngine-method-S-S-\" rel=\"Core.IgeEngine-method-S-S-\" class=\"docClass\">ige.$$</a>('categoryName');\n</code></pre>\n\n<h1>Remove the category of an entity</h1>\n\n<pre><code>// Set category to some name\nvar entity = new IgeEntity()\n    .category('myCategory');\n\n// Will output \"myCategory\"\nconsole.log(entity.category());\n\n// Now remove the category\nentity.category('');\n\n// Will return \"\"\nconsole.log(entity.category());\n</code></pre>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : String (optional)<div class='sub-desc'>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a>/String</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-cell' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-cell' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-cell' class='name expandable'>cell</a>( <span class='pre'>[val]</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the current texture cell used when rendering the game\nobject's texture. ...</div><div class='long'><p>Gets / sets the current texture cell used when rendering the game\nobject's texture. If the texture is not cell-based, this value is\nignored.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Number (optional)<div class='sub-desc'><p>The cell index.</p>\n\n<h1>Set the entity texture as a 4x4 cell sheet and then set the cell to use</h1>\n\n<pre><code>var texture = new IgeCellSheet('path/to/some/cellSheet.png', 4, 4);\nentity.texture(texture)\n    .cell(3);\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'><p>\"this\" when arguments are passed to allow method\nchaining or the current value if no arguments are specified.</p>\n</div></li></ul></div></div></div><div id='method-cellById' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-cellById' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-cellById' class='name expandable'>cellById</a>( <span class='pre'>[val]</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the current texture cell used when rendering the game\nobject's texture. ...</div><div class='long'><p>Gets / sets the current texture cell used when rendering the game\nobject's texture. If the texture is not cell-based, this value is\nignored. This differs from cell() in that it accepts a string id\nas the cell</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Number (optional)<div class='sub-desc'><p>The cell id.</p>\n\n<h1>Set the entity texture as a sprite sheet with cell ids and then set the cell to use</h1>\n\n<pre><code>var texture = new IgeSpriteSheet('path/to/some/cellSheet.png', [\n    [0, 0, 40, 40, 'robotHead'],\n    [40, 0, 40, 40, 'humanHead'],\n]);\n\n// Assign the texture, set the cell to use and then\n// set the entity to the size of the cell automatically!\nentity.texture(texture)\n    .cellById('robotHead')\n    .dimensionsFromCell();\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'><p>\"this\" when arguments are passed to allow method\nchaining or the current value if no arguments are specified.</p>\n</div></li></ul></div></div></div><div id='method-children' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-children' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-children' class='name expandable'>children</a>( <span class='pre'></span> ) : Object[]<span class=\"signature\"></span></div><div class='description'><div class='short'>Returns the object's children as an array of objects. ...</div><div class='long'><p>Returns the object's children as an array of objects.</p>\n\n<h1>Get the child objects array</h1>\n\n<pre><code>// Create a couple of entities and give them ids\nvar entity1 = new IgeEntity().id('entity1'),\n    entity2 = new IgeEntity().id('entity2');\n\n// Mount entity2 to entity1\nentity2.mount(entity1);\n\n// Get the chilren array entity1\nvar childArray = entity1.children();\n\n// Log the child array contents (will contain entity2)\nconsole.log(childArray);\n</code></pre>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'>Object[]</span><div class='sub-desc'><p>The array of child objects.</p>\n</div></li></ul></div></div></div><div id='method-classId' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeClass' rel='Core.IgeClass' class='defined-in docClass'>Core.IgeClass</a><br/><a href='source/IgeClass.html#Core-IgeClass-method-classId' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeClass-method-classId' class='name expandable'>classId</a>( <span class='pre'></span> ) : string<span class=\"signature\"></span></div><div class='description'><div class='short'>Returns the class id. ...</div><div class='long'><p>Returns the class id. Primarily used to help identify\nwhat class an instance was instantiated with and is also\noutput during the ige.scenegraph() method's console logging\nto show what class an object belongs to.</p>\n\n<h1>Get the class id of an object</h1>\n\n<pre><code>var entity = new IgeEntity();\n\n// Will output \"IgeEntity\"\nconsole.log(entity.classId());\n</code></pre>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'>string</span><div class='sub-desc'><p>class id</p>\n</div></li></ul></div></div></div><div id='method-clone' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-clone' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-clone' class='name expandable'>clone</a>( <span class='pre'>[options]</span> ) : <a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a><span class=\"signature\"></span></div><div class='description'><div class='short'>Clones the object and all it's children and returns a new object. ...</div><div class='long'><p>Clones the object and all it's children and returns a new object.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>options</span> : Object (optional)<div class='sub-desc'>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a></span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-compositeAabb' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-compositeAabb' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-compositeAabb' class='name expandable'>compositeAabb</a>( <span class='pre'>inverse</span> ) : <a href=\"#!/api/Core.IgeRect\" rel=\"Core.IgeRect\" class=\"docClass\">IgeRect</a><span class=\"signature\"></span></div><div class='description'><div class='short'>Calculates the axis-aligned bounding box for this entity, including\nall child entity bounding boxes and returns the f...</div><div class='long'><p>Calculates the axis-aligned bounding box for this entity, including\nall child entity bounding boxes and returns the final composite\nbounds.</p>\n\n<h1>Get the composite AABB</h1>\n\n<pre><code>var entity = new IgeEntity(),\n    aabb = entity.compositeAabb();\n</code></pre>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>inverse</span> : Object<div class='sub-desc'></div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeRect\" rel=\"Core.IgeRect\" class=\"docClass\">IgeRect</a></span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-compositeCache' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-compositeCache' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-compositeCache' class='name expandable'>compositeCache</a>( <span class='pre'>[val]</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets composite caching. ...</div><div class='long'><p>Gets / sets composite caching. Composite caching draws this entity\nand all of it's children (and their children etc) to a single off\nscreen canvas so that the entity does not need to be redrawn with\nall it's children every tick. For composite entities where little\nchange occurs this will massively increase rendering performance.\nIf enabled, this will automatically disable simple caching on this\nentity with a call to cache(false).</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Boolean (optional)<div class='sub-desc'><h1>Enable entity composite caching</h1>\n\n<pre><code>entity.compositeCache(true);\n</code></pre>\n\n<h1>Disable entity composite caching</h1>\n\n<pre><code>entity.compositeCache(false);\n</code></pre>\n\n<h1>Get composite caching flag value</h1>\n\n<pre><code>var val = entity.cache();\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-compositeStream' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-compositeStream' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-compositeStream' class='name expandable'>compositeStream</a>( <span class='pre'>val</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the composite stream flag. ...</div><div class='long'><p>Gets / sets the composite stream flag. If set to true, any objects\nmounted to this one will have their streamMode() set to the same\nvalue as this entity and will also have their compositeStream flag\nset to true. This allows you to easily automatically stream any\nobjects mounted to a root object and stream them all.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Object<div class='sub-desc'>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-data' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeClass' rel='Core.IgeClass' class='defined-in docClass'>Core.IgeClass</a><br/><a href='source/IgeClass.html#Core-IgeClass-method-data' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeClass-method-data' class='name expandable'>data</a>( <span class='pre'>key, [value]</span> ) : <a href=\"#!/api/Core.IgeClass\" rel=\"Core.IgeClass\" class=\"docClass\">IgeClass</a>/Object<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets a key / value pair in the object's data object. ...</div><div class='long'><p>Gets / sets a key / value pair in the object's data object. Useful for\nstoring arbitrary game data in the object.</p>\n\n<h1>Set some arbitrary data key value pair</h1>\n\n<pre><code>var entity = new IgeEntity();\nentity.data('playerScore', 100);\nentity.data('playerName', 'iRock');\n</code></pre>\n\n<h1>Get the value of a data key</h1>\n\n<pre><code>console.log(entity.data('playerScore'));\nconsole.log(entity.data('playerName'));\n</code></pre>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>key</span> : String<div class='sub-desc'><p>The key under which the data resides.</p>\n</div></li><li><span class='pre'>value</span> : Object (optional)<div class='sub-desc'><p>The data to set under the specified key.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeClass\" rel=\"Core.IgeClass\" class=\"docClass\">IgeClass</a>/Object</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-deathTime' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-deathTime' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-deathTime' class='name expandable'>deathTime</a>( <span class='pre'>[val], [deathCallback]</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the timestamp in milliseconds that denotes the time\nthat the entity will be destroyed. ...</div><div class='long'><p>Gets / sets the timestamp in milliseconds that denotes the time\nthat the entity will be destroyed. The object checks it's own death\ntime during each tick and if the current time is greater than the\ndeath time, the object will be destroyed.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Number (optional)<div class='sub-desc'><p>The death time timestamp. This is a time relative\nto the engine's start time of zero rather than the current time that\nwould be retrieved from new Date().getTime(). It is usually easier\nto call lifeSpan() rather than setting the deathTime directly.</p>\n</div></li><li><span class='pre'>deathCallback</span> : Function (optional)<div class='sub-desc'><p>Optional callback method to call when\nthe entity is destroyed from end of lifespan.</p>\n\n<h1>Set the death time of the entity to 60 seconds after engine start</h1>\n\n<pre><code>entity.deathTime(60000);\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'><p>\"this\" when arguments are passed to allow method\nchaining or the current value if no arguments are specified.</p>\n</div></li></ul></div></div></div><div id='method-debugTransforms' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-debugTransforms' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-debugTransforms' class='name expandable'>debugTransforms</a>( <span class='pre'></span> ) : <a href=\"#!/api/Core.IgeEntity\" rel=\"Core.IgeEntity\" class=\"docClass\">IgeEntity</a><span class=\"signature\"><span class='chainable' >chainable</span></span></div><div class='description'><div class='short'>Enables tracing calls which inadvertently assign NaN values to\ntransformation properties. ...</div><div class='long'><p>Enables tracing calls which inadvertently assign NaN values to\ntransformation properties. When called on an entity this system\nwill break with a debug line when a transform property is set\nto NaN allowing you to step back through the call stack and\ndetermine where the offending value originated.</p>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeEntity\" rel=\"Core.IgeEntity\" class=\"docClass\">IgeEntity</a></span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-depth' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-depth' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-depth' class='name expandable'>depth</a>( <span class='pre'>[val]</span> ) : <a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a>/Number<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the current render depth of the object (higher depths\nare drawn over lower depths). ...</div><div class='long'><p>Gets / sets the current render depth of the object (higher depths\nare drawn over lower depths). Please note that entities are first sorted\nby their layer and then by their depth, and only entities of the same layer will be\nsorted against each other by their depth values.</p>\n\n<h1>Set an entity's depth to 1</h1>\n\n<pre><code>var entity = new IgeEntity()\n    .depth(1);\n</code></pre>\n\n<h1>Get an entity's depth value</h1>\n\n<pre><code>var entity = new IgeEntity()\nconsole.log(entity.depth());\n</code></pre>\n\n<h1>How layers and depths are handled together</h1>\n\n<pre><code>var entity1 = new IgeEntity(),\n    entity2 = new IgeEntity(),\n    entity3 = new IgeEntity();\n\n// Set entity1 to at layer zero and depth 100\nentity1.layer(0)\n    .depth(100);\n\n// Set entity2 and 3 to be at layer 1\nentity2.layer(1);\nentity3.layer(1);\n\n// Set entity3 to have a higher depth than entity2\nentity2.depth(0);\nentity3.depth(1);\n\n// The engine sorts first based on layer from lowest to highest\n// and then within each layer, by depth from lowest to highest.\n// This means that entity1 will be drawn before entity 2 and 3\n// because even though it's depth is higher, it is not on the same\n// layer as entity 2 and 3.\n\n// Based on the layers and depths we have assigned, here\n// is how the engine will sort the draw order of the entities\n// entity1\n// entity2\n// entity3\n</code></pre>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Number (optional)<div class='sub-desc'>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a>/Number</span><div class='sub-desc'><p>Returns this when setting the value or the current value if none is specified.</p>\n</div></li></ul></div></div></div><div id='method-depthSortChildren' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-depthSortChildren' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-depthSortChildren' class='name expandable'>depthSortChildren</a>( <span class='pre'></span> ) : Number<span class=\"signature\"></span></div><div class='description'><div class='short'>Sorts the _children array by the layer and then depth of each object. ...</div><div class='long'><p>Sorts the _children array by the layer and then depth of each object.</p>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'>Number</span><div class='sub-desc'><p>layer index</p>\n</div></li></ul></div></div></div><div id='method-depthSortMode' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-depthSortMode' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-depthSortMode' class='name expandable'>depthSortMode</a>( <span class='pre'>[val]</span> ) : <a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a>/Number<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the depth sort mode that is used when\ndepth sorting this object's children against each other. ...</div><div class='long'><p>Gets / sets the depth sort mode that is used when\ndepth sorting this object's children against each other. This\nmode only applies if this object's mount mode is isometric,\nas set by calling isometricMounts(true). If the mount mode is\n2d, the depth sorter will use a very fast 2d depth sort that\ndoes not use 3d bounds at all.</p>\n\n<h1>Turn off all depth sorting for this object's children</h1>\n\n<pre><code>entity.depthSortMode(-1);\n</code></pre>\n\n<h1>Use 3d bounds when sorting this object's children</h1>\n\n<pre><code>entity.depthSortMode(0);\n</code></pre>\n\n<h1>Use 3d bounds optimised for mostly cube-shaped bounds when sorting this object's children</h1>\n\n<pre><code>entity.depthSortMode(1);\n</code></pre>\n\n<h1>Use 3d bounds optimised for all cube-shaped bounds when sorting this object's children</h1>\n\n<pre><code>entity.depthSortMode(2);\n</code></pre>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Number (optional)<div class='sub-desc'><p>The mode to use when depth sorting\nthis object's children, given as an integer value.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a>/Number</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-destroy' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-destroy' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-destroy' class='name expandable'>destroy</a>( <span class='pre'></span> )<span class=\"signature\"></span></div><div class='description'><div class='short'>Destroys the entity by removing it from the scenegraph,\ncalling destroy() on any child entities and removing\nany acti...</div><div class='long'><p>Destroys the entity by removing it from the scenegraph,\ncalling destroy() on any child entities and removing\nany active event listeners for the entity. Once an entity\nhas been destroyed it's this._alive flag is also set to\nfalse.</p>\n\n<h1>Destroy the entity</h1>\n\n<pre><code>entity.destroy();\n</code></pre>\n<h3 class='pa'>Fires</h3><ul><li><a href=\"#!/api/Core.IgeEntity-event-destroyed\" rel=\"Core.IgeEntity-event-destroyed\" class=\"docClass\">destroyed</a></li></ul><p>Overrides: <a href=\"#!/api/Core.IgeObject-method-destroy\" rel=\"Core.IgeObject-method-destroy\" class=\"docClass\">Core.IgeObject.destroy</a></p></div></div></div><div id='method-destroyBehaviours' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-destroyBehaviours' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-destroyBehaviours' class='name expandable'>destroyBehaviours</a>( <span class='pre'></span> )<span class=\"signature\"></span></div><div class='description'><div class='short'>Removes all references to any behaviour methods that were added to\nthis object. ...</div><div class='long'><p>Removes all references to any behaviour methods that were added to\nthis object.</p>\n</div></div></div><div id='method-destroyChildren' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-destroyChildren' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-destroyChildren' class='name expandable'>destroyChildren</a>( <span class='pre'></span> ) : <a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a><span class=\"signature\"><span class='chainable' >chainable</span></span></div><div class='description'><div class='short'>Loops through all child objects of this object and destroys them\nby calling each child's destroy() method then clears...</div><div class='long'><p>Loops through all child objects of this object and destroys them\nby calling each child's destroy() method then clears the object's\ninternal _children array.</p>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a></span><div class='sub-desc'><p>this</p>\n</div></li></ul></div></div></div><div id='method-destroyComponents' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-destroyComponents' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-destroyComponents' class='name expandable'>destroyComponents</a>( <span class='pre'></span> ) : <a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a><span class=\"signature\"><span class='chainable' >chainable</span></span></div><div class='description'><div class='short'>Loops through all components added to this object and calls their\ndestroy() method, then removes any references to th...</div><div class='long'><p>Loops through all components added to this object and calls their\ndestroy() method, then removes any references to the components.</p>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a></span><div class='sub-desc'><p>this</p>\n</div></li></ul></div></div></div><div id='method-dimensionsFromCell' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-dimensionsFromCell' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-dimensionsFromCell' class='name expandable'>dimensionsFromCell</a>( <span class='pre'>[percent]</span> ) : *<span class=\"signature\"><span class='chainable' >chainable</span></span></div><div class='description'><div class='short'>Sets the geometry of the entity to match the width and height\nof the assigned texture cell. ...</div><div class='long'><p>Sets the geometry of the entity to match the width and height\nof the assigned texture cell. If the texture is not cell-based\nthe entire texture width / height will be used.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>percent</span> : Number (optional)<div class='sub-desc'><p>The percentage size to resize to.</p>\n\n<h1>Set the entity dimensions based on the assigned texture and cell</h1>\n\n<pre><code>var texture = new IgeSpriteSheet('path/to/some/cellSheet.png', [\n    [0, 0, 40, 40, 'robotHead'],\n    [40, 0, 40, 40, 'humanHead'],\n]);\n\n// Assign the texture, set the cell to use and then\n// set the entity to the size of the cell automatically!\nentity.texture(texture)\n    .cellById('robotHead')\n    .dimensionsFromCell();\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'><p>The object this method was called from to allow\nmethod chaining</p>\n</div></li></ul></div></div></div><div id='method-dimensionsFromTexture' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-dimensionsFromTexture' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-dimensionsFromTexture' class='name expandable'>dimensionsFromTexture</a>( <span class='pre'>[percent]</span> ) : *<span class=\"signature\"><span class='chainable' >chainable</span></span></div><div class='description'><div class='short'>Sets the geometry of the entity to match the width and height\nof the assigned texture. ...</div><div class='long'><p>Sets the geometry of the entity to match the width and height\nof the assigned texture.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>percent</span> : Number (optional)<div class='sub-desc'><p>The percentage size to resize to.</p>\n\n<h1>Set the entity dimensions based on the assigned texture</h1>\n\n<pre><code>var texture = new IgeTexture('path/to/some/texture.png');\n\n// Assign the texture, and then set the entity to the\n// size of the texture automatically!\nentity.texture(texture)\n    .dimensionsFromTexture();\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'><p>The object this method was called from to allow\nmethod chaining.</p>\n</div></li></ul></div></div></div><div id='method-disableInterpolation' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-disableInterpolation' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-disableInterpolation' class='name expandable'>disableInterpolation</a>( <span class='pre'>val</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the disable interpolation flag. ...</div><div class='long'><p>Gets / sets the disable interpolation flag. If set to true then\nstream data being received by the client will not be interpolated\nand will be instantly assigned instead. Useful if your entity's\ntransformations should not be interpolated over time.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Object<div class='sub-desc'>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-drawBounds' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-drawBounds' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-drawBounds' class='name expandable'>drawBounds</a>( <span class='pre'>val</span> ) : <a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a>/Boolean<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the boolean flag determining if this object should have\nit's bounds drawn when the bounds for all objects...</div><div class='long'><p>Gets / sets the boolean flag determining if this object should have\nit's bounds drawn when the bounds for all objects are being drawn.\nIn order for bounds to be drawn the viewport the object is being drawn\nto must also have draw bounds enabled.</p>\n\n<h1>Enable draw bounds</h1>\n\n<pre><code>var entity = new IgeEntity();\nentity.drawBounds(true);\n</code></pre>\n\n<h1>Disable draw bounds</h1>\n\n<pre><code>var entity = new IgeEntity();\nentity.drawBounds(false);\n</code></pre>\n\n<h1>Get the current flag value</h1>\n\n<pre><code>console.log(entity.drawBounds());\n</code></pre>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Boolean<div class='sub-desc'>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a>/Boolean</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-drawBoundsData' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-drawBoundsData' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-drawBoundsData' class='name expandable'>drawBoundsData</a>( <span class='pre'>val</span> ) : <a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a>/Boolean<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the boolean flag determining if this object should have\nit's bounds data drawn when the bounds for all ob...</div><div class='long'><p>Gets / sets the boolean flag determining if this object should have\nit's bounds data drawn when the bounds for all objects are being drawn.\nBounds data includes the object ID and it's current depth etc.</p>\n\n<h1>Enable draw bounds data</h1>\n\n<pre><code>var entity = new IgeEntity();\nentity.drawBoundsData(true);\n</code></pre>\n\n<h1>Disable draw bounds data</h1>\n\n<pre><code>var entity = new IgeEntity();\nentity.drawBoundsData(false);\n</code></pre>\n\n<h1>Get the current flag value</h1>\n\n<pre><code>console.log(entity.drawBoundsData());\n</code></pre>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Boolean<div class='sub-desc'>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a>/Boolean</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-drawMouse' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-drawMouse' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-drawMouse' class='name expandable'>drawMouse</a>( <span class='pre'>[val]</span> ) : <a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a>/Boolean<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the boolean flag determining if this object should have\nit's mouse position drawn, usually for debug purp...</div><div class='long'><p>Gets / sets the boolean flag determining if this object should have\nit's mouse position drawn, usually for debug purposes.</p>\n\n<h1>Enable draw mouse position data</h1>\n\n<pre><code>var entity = new IgeEntity();\nentity.drawMouse(true);\n</code></pre>\n\n<h1>Disable draw mouse position data</h1>\n\n<pre><code>var entity = new IgeEntity();\nentity.drawMouse(false);\n</code></pre>\n\n<h1>Get the current flag value</h1>\n\n<pre><code>console.log(entity.drawMouse());\n</code></pre>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Boolean (optional)<div class='sub-desc'>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a>/Boolean</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-drawMouseData' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-drawMouseData' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-drawMouseData' class='name expandable'>drawMouseData</a>( <span class='pre'>[val]</span> ) : <a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a>/Boolean<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the boolean flag determining if this object should have\nit's extra mouse data drawn for debug purposes. ...</div><div class='long'><p>Gets / sets the boolean flag determining if this object should have\nit's extra mouse data drawn for debug purposes. For instance, on tilemaps\n(IgeTileMap2d) instances, when enabled you will see the tile x and y\nco-ordinates currently being hoverered over by the mouse.</p>\n\n<h1>Enable draw mouse data</h1>\n\n<pre><code>var entity = new IgeEntity();\nentity.drawMouseData(true);\n</code></pre>\n\n<h1>Disable draw mouse data</h1>\n\n<pre><code>var entity = new IgeEntity();\nentity.drawMouseData(false);\n</code></pre>\n\n<h1>Get the current flag value</h1>\n\n<pre><code>console.log(entity.drawMouseData());\n</code></pre>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Boolean (optional)<div class='sub-desc'>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a>/Boolean</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-emit' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEventingClass' rel='Core.IgeEventingClass' class='defined-in docClass'>Core.IgeEventingClass</a><br/><a href='source/IgeEventingClass.html#Core-IgeEventingClass-method-emit' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEventingClass-method-emit' class='name expandable'>emit</a>( <span class='pre'>eventName, args</span> ) : Number<span class=\"signature\"></span></div><div class='description'><div class='short'>Emit an event by name. ...</div><div class='long'><p>Emit an event by name.</p>\n\n<h1>Emit an Event</h1>\n\n<pre><code>// Emit the event named \"hello\"\nmyEntity.emit('hello');\n</code></pre>\n\n<h1>Emit an Event With Data Object</h1>\n\n<pre><code>// Emit the event named \"hello\"\nmyEntity.emit('hello', {moo: true});\n</code></pre>\n\n<h1>Emit an Event With Multiple Data Values</h1>\n\n<pre><code>// Emit the event named \"hello\"\nmyEntity.emit('hello', [{moo: true}, 'someString']);\n</code></pre>\n\n<h1>Listen for Event Data</h1>\n\n<pre><code>// Set a listener to listen for the data (multiple values emitted\n// from an event are passed as function arguments)\nmyEntity.on('hello', function (arg1, arg2) {\n    console.log(arg1, arg2);\n}\n\n// Emit the event named \"hello\"\nmyEntity.emit('hello', ['data1', 'data2']);\n\n// The console output is:\n//    data1, data2\n</code></pre>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>eventName</span> : Object<div class='sub-desc'><p>The name of the event to emit.</p>\n</div></li><li><span class='pre'>args</span> : Object/Array<div class='sub-desc'><p>The arguments to send to any listening methods.\nIf you are sending multiple arguments, use an array containing each argument.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>Number</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-eventList' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEventingClass' rel='Core.IgeEventingClass' class='defined-in docClass'>Core.IgeEventingClass</a><br/><a href='source/IgeEventingClass.html#Core-IgeEventingClass-method-eventList' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEventingClass-method-eventList' class='name expandable'>eventList</a>( <span class='pre'></span> ) : Object<span class=\"signature\"></span></div><div class='description'><div class='short'>Returns an object containing the current event listeners. ...</div><div class='long'><p>Returns an object containing the current event listeners.</p>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'>Object</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-extend' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeClass' rel='Core.IgeClass' class='defined-in docClass'>Core.IgeClass</a><br/><a href='source/IgeClass.html#Core-IgeClass-method-extend' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeClass-method-extend' class='name expandable'>extend</a>( <span class='pre'></span> ) : Object<span class=\"signature\"></span></div><div class='description'><div class='short'>Create a new IgeClass that inherits from this class\n\nCreating a new class by extending an existing one\n\nvar NewClass ...</div><div class='long'><p>Create a new IgeClass that inherits from this class</p>\n\n<h1>Creating a new class by extending an existing one</h1>\n\n<pre><code>var NewClass = <a href=\"#!/api/Core.IgeClass-method-extend\" rel=\"Core.IgeClass-method-extend\" class=\"docClass\">IgeClass.extend</a>({\n    // Init is your constructor\n    init: function () {\n        console.log('I\\'m alive!');\n    }\n});\n</code></pre>\n\n<p>Further reading: <a href=\"http://www.isogenicengine.com/documentation/isogenic-game-engine/versions/1-1-0/manual/engine-fundamentals/classes/extending-classes/\">Extending Classes</a></p>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'>Object</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-group' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-group' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-group' class='name expandable'>group</a>( <span class='pre'></span> )<span class=\"signature\"><span class='deprecated' >deprecated</span></span></div><div class='description'><div class='short'> ...</div><div class='long'>\n        <div class='rounded-box deprecated-box deprecated-tag-box'>\n        <p>This method has been <strong>deprected</strong> </p>\n        <p>Use category() instead. A warning method to help developers move to the new groups system.</p>\n\n        </div>\n</div></div></div><div id='method-groupCount' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-groupCount' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-groupCount' class='name expandable'>groupCount</a>( <span class='pre'></span> ) : Number<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets the number of groups this entity belongs to. ...</div><div class='long'><p>Gets the number of groups this entity belongs to.</p>\n\n<h1>Get number of groups entity belongs to</h1>\n\n<pre><code>var entity = new IgeEntity();\nentity.addGroup('g1', 'g2');\n\n// This will output \"2\"\nconsole.log(entity.groupCount());\n</code></pre>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'>Number</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-groups' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-groups' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-groups' class='name expandable'>groups</a>( <span class='pre'></span> ) : String[]<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets an array of all groups this entity belongs to. ...</div><div class='long'><p>Gets an array of all groups this entity belongs to.</p>\n\n<h1>Get array of groups entity belongs to</h1>\n\n<pre><code>var entity = new IgeEntity();\nentity.addGroup('g1', 'g2');\n\n// This will output \"['g1', 'g2']\"\nconsole.log(entity.groups());\n</code></pre>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'>String[]</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-hasBehaviour' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-hasBehaviour' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-hasBehaviour' class='name expandable'>hasBehaviour</a>( <span class='pre'>id, [duringTick]</span> ) : Boolean<span class=\"signature\"></span></div><div class='description'><div class='short'>Checks if the object has the specified behaviour already added to it. ...</div><div class='long'><p>Checks if the object has the specified behaviour already added to it.</p>\n\n<h1>Check for a behaviour with the id \"myBehaviour\"</h1>\n\n<pre><code>var entity = new IgeEntity();\nentity.addBehaviour('myBehaviour', function () {\n    // Code here will execute during each engine update for\n    // this entity. I can access the entity via the \"this\"\n    // keyword such as:\n    this._somePropertyOfTheEntity = 'moo';\n});\n\n// Now check for the \"myBehaviour\" behaviour\nconsole.log(entity.hasBehaviour('myBehaviour')); // Will log \"true\"\n</code></pre>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>id</span> : String<div class='sub-desc'>\n</div></li><li><span class='pre'>duringTick</span> : Boolean (optional)<div class='sub-desc'><p>If true will look to remove the behaviour\nfrom the tick method rather than the update method.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>Boolean</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-hasParent' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-hasParent' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-hasParent' class='name expandable'>hasParent</a>( <span class='pre'>parentId, [fresh]</span> ) : Boolean<span class=\"signature\"></span></div><div class='description'><div class='short'>Determines if the object has a parent up the scenegraph whose\nid matches the one passed. ...</div><div class='long'><p>Determines if the object has a parent up the scenegraph whose\nid matches the one passed. Will traverse each parent object\nchecking if the id matches. This information will be cached when\nfirst called and can be refreshed by setting the \"fresh\" parameter\nto true.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>parentId</span> : String<div class='sub-desc'><p>The id of the parent to check for.</p>\n</div></li><li><span class='pre'>fresh</span> : Boolean (optional)<div class='sub-desc'><p>If true will force a full check instead of\nusing the cached value from an earlier check.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>Boolean</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-height' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-height' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-height' class='name expandable'>height</a>( <span class='pre'>[px]</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the geometry y value. ...</div><div class='long'><p>Gets / sets the geometry y value.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>px</span> : Number (optional)<div class='sub-desc'><p>The new y value in pixels.</p>\n\n<h1>Set the height of the entity</h1>\n\n<pre><code>entity.height(40);\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'><p>\"this\" when arguments are passed to allow method\nchaining or the current value if no arguments are specified.</p>\n</div></li></ul></div></div></div><div id='method-heightByTile' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-heightByTile' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-heightByTile' class='name expandable'>heightByTile</a>( <span class='pre'>val, [lockAspect]</span> ) : *<span class=\"signature\"><span class='chainable' >chainable</span></span></div><div class='description'><div class='short'>Set the object's height to the number of tile height's specified. ...</div><div class='long'><p>Set the object's height to the number of tile height's specified.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Number<div class='sub-desc'><p>Number of tiles.</p>\n</div></li><li><span class='pre'>lockAspect</span> : Boolean (optional)<div class='sub-desc'><p>If true, sets the width according\nto the texture aspect ratio and the new height.</p>\n\n<h1>Set the height of the entity based on the tile height of the map the entity is mounted to</h1>\n\n<pre><code>// Set the entity height to the size of 1 tile with\n// lock aspect enabled which will automatically size\n// the width as well so as to maintain the aspect\n// ratio of the entity\nentity.heightByTile(1, true);\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'><p>The object this method was called from to allow\nmethod chaining.</p>\n</div></li></ul></div></div></div><div id='method-hide' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-hide' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-hide' class='name expandable'>hide</a>( <span class='pre'></span> ) : *<span class=\"signature\"><span class='chainable' >chainable</span></span></div><div class='description'><div class='short'>Sets the entity as hidden and cannot be interacted with. ...</div><div class='long'><p>Sets the entity as hidden and cannot be interacted with.</p>\n\n<h1>Hide a visible entity</h1>\n\n<pre><code>entity.hide();\n</code></pre>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'><p>The object this method was called from to allow\nmethod chaining.</p>\n</div></li></ul></div></div></div><div id='method-highlight' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-highlight' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-highlight' class='name expandable'>highlight</a>( <span class='pre'>val</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the highlight mode. ...</div><div class='long'><p>Gets / sets the highlight mode. True is on false is off.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Boolean<div class='sub-desc'><p>The highlight mode true or false.</p>\n\n<h1>Set the entity to render highlighted</h1>\n\n<pre><code>entity.highlight(true);\n</code></pre>\n\n<h1>Get the current highlight state</h1>\n\n<pre><code>var isHighlighted = entity.highlight();\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'><p>\"this\" when arguments are passed to allow method\nchaining or the current value if no arguments are specified.</p>\n</div></li></ul></div></div></div><div id='method-id' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-id' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-id' class='name expandable'>id</a>( <span class='pre'>[id]</span> ) : <a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a>/String<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the current object id. ...</div><div class='long'><p>Gets / sets the current object id. If no id is currently assigned and no\nid is passed to the method, it will automatically generate and assign a\nnew id as a 16 character hexadecimal value typed as a string.</p>\n\n<h1>Get the id of an entity</h1>\n\n<pre><code>var entity = new IgeEntity();\nconsole.log(entity.id());\n</code></pre>\n\n<h1>Set the id of an entity</h1>\n\n<pre><code>var entity = new IgeEntity();\nentity.id('myNewId');\n</code></pre>\n\n<h1>Set the id of an entity via chaining</h1>\n\n<pre><code>var entity = new IgeEntity()\n    .id('myNewId');\n</code></pre>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>id</span> : String (optional)<div class='sub-desc'>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a>/String</span><div class='sub-desc'><p>Returns this when setting the value or the current value if none is specified.</p>\n</div></li></ul></div></div></div><div id='method-ignoreCameraComposite' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-ignoreCameraComposite' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-ignoreCameraComposite' class='name expandable'>ignoreCameraComposite</a>( <span class='pre'>val</span> )<span class=\"signature\"></span></div><div class='description'><div class='short'>Sets the _ignoreCamera internal flag to the value passed for this\nand all child entities down the scenegraph. ...</div><div class='long'><p>Sets the _ignoreCamera internal flag to the value passed for this\nand all child entities down the scenegraph.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Object<div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-implement' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeClass' rel='Core.IgeClass' class='defined-in docClass'>Core.IgeClass</a><br/><a href='source/IgeClass.html#Core-IgeClass-method-implement' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeClass-method-implement' class='name expandable'>implement</a>( <span class='pre'>classObj, overwrite</span> ) : <a href=\"#!/api/Core.IgeClass\" rel=\"Core.IgeClass\" class=\"docClass\">IgeClass</a><span class=\"signature\"></span></div><div class='description'><div class='short'>Copies all properties and methods from the classObj object\nto \"this\". ...</div><div class='long'><p>Copies all properties and methods from the classObj object\nto \"this\". If the overwrite flag is not set or set to false,\nonly properties and methods that don't already exists in\n\"this\" will be copied. If overwrite is true, they will be\ncopied regardless.</p>\n\n<h1>Implement all the methods of an object into another object</h1>\n\n<pre><code>// Create a couple of test entities with ids\nvar entity1 = new IgeEntity().id('entity1'),\n    entity2 = new IgeEntity().id('entity2');\n\n// Let's define an object with a couple of methods\nvar obj = {\n    newMethod1: function () {\n        console.log('method1 called on object: ' + this.id());\n    },\n\n    newMethod2: function () {\n        console.log('method2 called on object: ' + this.id());\n    }\n};\n\n// Now let's implement the methods on our entities\nentity1.implement(obj);\nentity2.implement(obj);\n\n// The entities now have the newMethod1 and newMethod2\n// methods as part of their instance so we can call them:\nentity1.newMethod1();\n\n// The output to the console is:\n//    method1 called on object: entity1\n\n// Now let's call newMethod2 on entity2:\nentity2.newMethod2();\n\n// The output to the console is:\n//    method2 called on object: entity2\n\n// As you can see, this is a great way to add extra modular\n// functionality to objects / entities at runtime.\n</code></pre>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>classObj</span> : Function<div class='sub-desc'>\n</div></li><li><span class='pre'>overwrite</span> : Boolean<div class='sub-desc'>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeClass\" rel=\"Core.IgeClass\" class=\"docClass\">IgeClass</a></span><div class='sub-desc'><p>this</p>\n</div></li></ul></div></div></div><div id='method-inAllGroups' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-inAllGroups' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-inAllGroups' class='name expandable'>inAllGroups</a>( <span class='pre'>groupName</span> ) : Boolean<span class=\"signature\"></span></div><div class='description'><div class='short'>Checks if the entity is in the specified group or\narray of groups. ...</div><div class='long'><p>Checks if the entity is in the specified group or\narray of groups. If multiple group names are passed,\nas an array the method will only return true if the\nentity is in ALL the passed groups.</p>\n\n<h1>Check if entity belongs to all of the passed groups</h1>\n\n<pre><code>// Add a couple of groups\nvar entity = new IgeEntity();\nentity.addGroup(['g1', 'g2']);\n\n// This will output \"false\" (entity is not part of g3)\nconsole.log(entity.inAllGroups(['g1', 'g3']));\n\n// This will output \"true\"\nconsole.log(entity.inAllGroups('g1'));\n\n// This will output \"true\"\nconsole.log(entity.inAllGroups(['g1', 'g2']));\n</code></pre>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>groupName</span> : String/String[]<div class='sub-desc'><p>The name of the group or array\nif group names to check if this entity is a member of.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>Boolean</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-inAnyGroup' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-inAnyGroup' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-inAnyGroup' class='name expandable'>inAnyGroup</a>( <span class='pre'>groupName</span> ) : Boolean<span class=\"signature\"></span></div><div class='description'><div class='short'>Checks if the entity is in the specified group or\narray of group names. ...</div><div class='long'><p>Checks if the entity is in the specified group or\narray of group names. If multiple group names are passed\nas an array, the method will return true if the entity\nis in ANY of the the passed groups.</p>\n\n<h1>Check if entity belongs to any of the passed groups</h1>\n\n<pre><code>// Add a couple of groups\nvar entity = new IgeEntity();\nentity.addGroup('g1', 'g2');\n\n// This will output \"false\"\nconsole.log(entity.inAnyGroup('g3'));\n\n// This will output \"true\"\nconsole.log(entity.inAnyGroup(['g3', 'g1']));\n</code></pre>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>groupName</span> : String/String[]<div class='sub-desc'><p>The name of the group or array of\ngroup names to check if this entity is a member of.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>Boolean</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-inGroup' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-inGroup' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-inGroup' class='name expandable'>inGroup</a>( <span class='pre'>groupName, [matchAllGroups]</span> ) : Boolean<span class=\"signature\"></span></div><div class='description'><div class='short'>Checks if the entity is in the group or array of group\nnames passed. ...</div><div class='long'><p>Checks if the entity is in the group or array of group\nnames passed.</p>\n\n<h1>Check if the entity is in a group</h1>\n\n<pre><code>var entity = new IgeEntity();\nentity.addGroup('g1', 'g2');\n\n// Will output true since entity is part of g1 group\nconsole.log(entity.inGroup('g1', false);\n\n// Will output false since entity is not part of g3 group\nconsole.log(entity.inGroup('g3', false);\n</code></pre>\n\n<h1>Check if the entity is in an array of groups using ANY and ALL options</h1>\n\n<pre><code>var entity = new IgeEntity();\nentity.addGroup('g1', 'g2');\n\n// Will output true since entity is part of g1 group\nconsole.log(entity.inGroup(['g1, 'g3'], false);\n\n// Will output false since entity is not part of g3 group\nconsole.log(entity.inGroup(['g1, 'g3'], true);\n</code></pre>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>groupName</span> : String/String[]<div class='sub-desc'><p>A group name or array of names.</p>\n</div></li><li><span class='pre'>matchAllGroups</span> : Boolean (optional)<div class='sub-desc'><p>If set to true, will cause\nthe method to check if the entity is in ALL the groups,\notherwise the method will check if the entity is in ANY group.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>Boolean</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-indestructible' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-indestructible' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-indestructible' class='name expandable'>indestructible</a>( <span class='pre'>[val]</span> ) : <a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a>/Number<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the indestructible flag. ...</div><div class='long'><p>Gets / sets the indestructible flag. If set to true, the object will\nnot be destroyed even if a call to the destroy() method is made.</p>\n\n<h1>Set an entity to indestructible</h1>\n\n<pre><code>var entity = new IgeEntity()\n    .indestructible(true);\n</code></pre>\n\n<h1>Set an entity to destructible</h1>\n\n<pre><code>var entity = new IgeEntity()\n    .indestructible(false);\n</code></pre>\n\n<h1>Get an entity's indestructible flag value</h1>\n\n<pre><code>var entity = new IgeEntity()\nconsole.log(entity.indestructible());\n</code></pre>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Number (optional)<div class='sub-desc'>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a>/Number</span><div class='sub-desc'><p>Returns this when setting the value or the current value if none is specified.</p>\n</div></li></ul></div></div></div><div id='method-interpolateValue' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-interpolateValue' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-interpolateValue' class='name expandable'>interpolateValue</a>( <span class='pre'>startValue, endValue, startTime, currentTime, endTime</span> ) : Number<span class=\"signature\"></span></div><div class='description'><div class='short'>Calculates the current value based on the time along the\nvalue range. ...</div><div class='long'><p>Calculates the current value based on the time along the\nvalue range.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>startValue</span> : Number<div class='sub-desc'><p>The value that the interpolation started from.</p>\n</div></li><li><span class='pre'>endValue</span> : Number<div class='sub-desc'><p>The target value to be interpolated to.</p>\n</div></li><li><span class='pre'>startTime</span> : Number<div class='sub-desc'><p>The time the interpolation started.</p>\n</div></li><li><span class='pre'>currentTime</span> : Number<div class='sub-desc'><p>The current time.</p>\n</div></li><li><span class='pre'>endTime</span> : Number<div class='sub-desc'><p>The time the interpolation will end.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>Number</span><div class='sub-desc'><p>The interpolated value.</p>\n</div></li></ul></div></div></div><div id='method-isBehind' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-isBehind' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-isBehind' class='name expandable'>isBehind</a>( <span class='pre'>otherObject</span> ) : Boolean<span class=\"signature\"></span></div><div class='description'><div class='short'>Compares the current entity's 3d bounds to the passed entity and\ndetermines if the current entity is \"behind\" the pas...</div><div class='long'><p>Compares the current entity's 3d bounds to the passed entity and\ndetermines if the current entity is \"behind\" the passed one. If an\nentity is behind another, it is drawn first during the scenegraph\nrender phase.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>otherObject</span> : <a href=\"#!/api/Core.IgeEntity\" rel=\"Core.IgeEntity\" class=\"docClass\">IgeEntity</a><div class='sub-desc'><p>The other entity to check this\nentity's 3d bounds against.</p>\n\n<h1>Determine if this entity is \"behind\" another entity based on the current depth-sort</h1>\n\n<pre><code>var behind = entity.isBehind(otherEntity);\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>Boolean</span><div class='sub-desc'><p>If true this entity is \"behind\" the passed entity\nor false if not.</p>\n</div></li></ul></div></div></div><div id='method-isHidden' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-isHidden' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-isHidden' class='name expandable'>isHidden</a>( <span class='pre'></span> ) : boolean<span class=\"signature\"></span></div><div class='description'><div class='short'>Checks if the entity is hidden. ...</div><div class='long'><p>Checks if the entity is hidden.</p>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'>boolean</span><div class='sub-desc'><p>True if the entity is hidden.</p>\n</div></li></ul></div></div></div><div id='method-isVisible' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-isVisible' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-isVisible' class='name expandable'>isVisible</a>( <span class='pre'></span> ) : boolean<span class=\"signature\"></span></div><div class='description'><div class='short'>Checks if the entity is visible. ...</div><div class='long'><p>Checks if the entity is visible.</p>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'>boolean</span><div class='sub-desc'><p>True if the entity is visible.</p>\n</div></li></ul></div></div></div><div id='method-isoBoundsPoly' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-isoBoundsPoly' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-isoBoundsPoly' class='name expandable'>isoBoundsPoly</a>( <span class='pre'></span> )<span class=\"signature\"><span class='deprecated' >deprecated</span></span></div><div class='description'><div class='short'> ...</div><div class='long'>\n        <div class='rounded-box deprecated-box deprecated-tag-box'>\n        <p>This method has been <strong>deprected</strong> </p>\n        <p>Use bounds3dPolygon instead</p>\n\n        </div>\n</div></div></div><div id='method-isometric' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-isometric' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-isometric' class='name expandable'>isometric</a>( <span class='pre'>val</span> ) : <a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a>/Boolean<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets if this object should be positioned isometrically\nor in 2d. ...</div><div class='long'><p>Gets / sets if this object should be positioned isometrically\nor in 2d.</p>\n\n<h1>Set the positioning mode to isometric</h1>\n\n<pre><code>var entity = new IgeEntity()\n    .isometric(true);\n</code></pre>\n\n<h1>Set the positioning mode to 2d</h1>\n\n<pre><code>var entity = new IgeEntity()\n    .isometric(false);\n</code></pre>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Boolean<div class='sub-desc'><p>Set to true to position this object in\nisometric space or false to position it in 2d space.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a>/Boolean</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-isometricMounts' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-isometricMounts' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-isometricMounts' class='name expandable'>isometricMounts</a>( <span class='pre'>[val]</span> ) : <a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a>/Boolean<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets if objects mounted to this object should be positioned\nand depth-sorted in an isometric fashion or a 2d f...</div><div class='long'><p>Gets / sets if objects mounted to this object should be positioned\nand depth-sorted in an isometric fashion or a 2d fashion.</p>\n\n<h1>Set children to be positioned and depth sorted in 2d</h1>\n\n<pre><code>var entity = new IgeEntity()\n    .isometricMounts(false);\n</code></pre>\n\n<h1>Set children to be positioned and depth sorted in isometric</h1>\n\n<pre><code>var entity = new IgeEntity()\n    .isometricMounts(true);\n</code></pre>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Boolean (optional)<div class='sub-desc'><p>Set to true to enabled isometric positioning\nand depth sorting of objects mounted to this object, or false to\nenable 2d positioning and depth-sorting of objects mounted to this\nobject.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a>/Boolean</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-layer' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-layer' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-layer' class='name expandable'>layer</a>( <span class='pre'>[val]</span> ) : <a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a>/Number<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the current entity layer. ...</div><div class='long'><p>Gets / sets the current entity layer. This affects how the entity is depth-sorted\nagainst other entities of the same parent. Please note that entities are first sorted\nby their layer and then by their depth, and only entities of the same layer will be\nsorted against each other by their depth values.</p>\n\n<h1>Set an entity's layer to 22</h1>\n\n<pre><code>var entity = new IgeEntity()\n    .layer(22);\n</code></pre>\n\n<h1>Get an entity's layer value</h1>\n\n<pre><code>var entity = new IgeEntity()\nconsole.log(entity.layer());\n</code></pre>\n\n<h1>How layers and depths are handled together</h1>\n\n<pre><code>var entity1 = new IgeEntity(),\n    entity2 = new IgeEntity(),\n    entity3 = new IgeEntity();\n\n// Set entity1 to at layer zero and depth 100\nentity1.layer(0)\n    .depth(100);\n\n// Set entity2 and 3 to be at layer 1\nentity2.layer(1);\nentity3.layer(1);\n\n// Set entity3 to have a higher depth than entity2\nentity2.depth(0);\nentity3.depth(1);\n\n// The engine sorts first based on layer from lowest to highest\n// and then within each layer, by depth from lowest to highest.\n// This means that entity1 will be drawn before entity 2 and 3\n// because even though it's depth is higher, it is not on the same\n// layer as entity 2 and 3.\n\n// Based on the layers and depths we have assigned, here\n// is how the engine will sort the draw order of the entities\n// entity1\n// entity2\n// entity3\n</code></pre>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Number (optional)<div class='sub-desc'>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a>/Number</span><div class='sub-desc'><p>Returns this when setting the value or the current value if none is specified.</p>\n</div></li></ul></div></div></div><div id='method-lifeSpan' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-lifeSpan' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-lifeSpan' class='name expandable'>lifeSpan</a>( <span class='pre'>[milliseconds], [deathCallback]</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the life span of the object in milliseconds. ...</div><div class='long'><p>Gets / sets the life span of the object in milliseconds. The life\nspan is how long the object will exist for before being automatically\ndestroyed.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>milliseconds</span> : Number (optional)<div class='sub-desc'><p>The number of milliseconds the entity\nwill live for from the current time.</p>\n</div></li><li><span class='pre'>deathCallback</span> : Function (optional)<div class='sub-desc'><p>Optional callback method to call when\nthe entity is destroyed from end of lifespan.</p>\n\n<h1>Set the lifespan of the entity to 2 seconds after which it will automatically be destroyed</h1>\n\n<pre><code>entity.lifeSpan(2000);\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'><p>\"this\" when arguments are passed to allow method\nchaining or the current value if no arguments are specified.</p>\n</div></li></ul></div></div></div><div id='method-loadGraph' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-loadGraph' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-loadGraph' class='name expandable'>loadGraph</a>( <span class='pre'>obj</span> )<span class=\"signature\"></span></div><div class='description'><div class='short'> ...</div><div class='long'>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>obj</span> : Object<div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-loadSpecialProp' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-loadSpecialProp' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-loadSpecialProp' class='name expandable'>loadSpecialProp</a>( <span class='pre'>obj, i</span> ) : Object/undefined<span class=\"signature\"></span></div><div class='description'><div class='short'> ...</div><div class='long'>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>obj</span> : Object<div class='sub-desc'>\n</div></li><li><span class='pre'>i</span> : String<div class='sub-desc'>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>Object/undefined</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-localAabb' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-localAabb' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-localAabb' class='name expandable'>localAabb</a>( <span class='pre'>[recalculate]</span> ) : <a href=\"#!/api/Core.IgeRect\" rel=\"Core.IgeRect\" class=\"docClass\">IgeRect</a><span class=\"signature\"></span></div><div class='description'><div class='short'>Calculates and returns the local axis-aligned bounding box\nfor the entity. ...</div><div class='long'><p>Calculates and returns the local axis-aligned bounding box\nfor the entity. This is the AABB relative to the entity's\ncenter point.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>recalculate</span> : Boolean (optional)<div class='sub-desc'><p>If true this will force the\nrecalculation of the local AABB instead of returning a cached\nvalue.</p>\n\n<h1>Get the entity local axis-aligned bounding box dimensions</h1>\n\n<pre><code>var aabb = entity.localAabb();\n\nconsole.log(aabb.x);\nconsole.log(aabb.y);\nconsole.log(aabb.width);\nconsole.log(aabb.height);\n</code></pre>\n\n<h1>Get the entity local axis-aligned bounding box dimensions forcing the engine to update the values first</h1>\n\n<pre><code>var aabb = entity.localAabb(true); // Call with true to force update\n\nconsole.log(aabb.x);\nconsole.log(aabb.y);\nconsole.log(aabb.width);\nconsole.log(aabb.height);\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeRect\" rel=\"Core.IgeRect\" class=\"docClass\">IgeRect</a></span><div class='sub-desc'><p>The local AABB.</p>\n</div></li></ul></div></div></div><div id='method-localIsoBoundsPoly' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-localIsoBoundsPoly' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-localIsoBoundsPoly' class='name expandable'>localIsoBoundsPoly</a>( <span class='pre'></span> )<span class=\"signature\"><span class='deprecated' >deprecated</span></span></div><div class='description'><div class='short'> ...</div><div class='long'>\n        <div class='rounded-box deprecated-box deprecated-tag-box'>\n        <p>This method has been <strong>deprected</strong> </p>\n        <p>Use bounds3dPolygon instead</p>\n\n        </div>\n</div></div></div><div id='method-localToWorld' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-localToWorld' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-localToWorld' class='name expandable'>localToWorld</a>( <span class='pre'>points</span> )<span class=\"signature\"></span></div><div class='description'><div class='short'>Converts an array of points from local space to this entity's\nworld space using it's world transform matrix. ...</div><div class='long'><p>Converts an array of points from local space to this entity's\nworld space using it's world transform matrix. This will alter\nthe points passed in the array directly.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>points</span> : Array<div class='sub-desc'><p>The array of IgePoints to convert.</p>\n</div></li></ul></div></div></div><div id='method-localToWorldPoint' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-localToWorldPoint' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-localToWorldPoint' class='name expandable'>localToWorldPoint</a>( <span class='pre'>point</span> )<span class=\"signature\"></span></div><div class='description'><div class='short'>Converts a point from local space to this entity's world space\nusing it's world transform matrix. ...</div><div class='long'><p>Converts a point from local space to this entity's world space\nusing it's world transform matrix. This will alter the point's\ndata directly.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>point</span> : <a href=\"#!/api/Core.IgePoint3d\" rel=\"Core.IgePoint3d\" class=\"docClass\">IgePoint3d</a><div class='sub-desc'><p>The IgePoint3d to convert.</p>\n</div></li></ul></div></div></div><div id='method-log' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeClass' rel='Core.IgeClass' class='defined-in docClass'>Core.IgeClass</a><br/><a href='source/IgeClass.html#Core-IgeClass-method-log' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeClass-method-log' class='name expandable'>log</a>( <span class='pre'>text, type, [obj]</span> ) : <a href=\"#!/api/Core.IgeClass\" rel=\"Core.IgeClass\" class=\"docClass\">IgeClass</a><span class=\"signature\"></span></div><div class='description'><div class='short'>Provides logging capabilities to all IgeClass instances. ...</div><div class='long'><p>Provides logging capabilities to all IgeClass instances.</p>\n\n<h1>Log a message</h1>\n\n<pre><code>var entity = new IgeEntity();\n\n// Will output:\n//     IGE *log* [IgeEntity] : hello\nentity.log('Hello');\n</code></pre>\n\n<h1>Log an info message with an optional parameter</h1>\n\n<pre><code>var entity = new IgeEntity(),\n    param = 'moo';\n\n// Will output:\n//    moo\n//    IGE *log* [IgeEntity] : hello\nentity.log('Hello', 'info', param);\n</code></pre>\n\n<h1>Log a warning message (which will cause a stack trace to be shown)</h1>\n\n<pre><code>var entity = new IgeEntity();\n\n// Will output (stack trace is just an example here, real one will be more useful):\n//    Stack: {anonymous}()@&lt;anonymous&gt;:2:8\n//    ---- Object.InjectedScript._evaluateOn (&lt;anonymous&gt;:444:39)\n//    ---- Object.InjectedScript._evaluateAndWrap (&lt;anonymous&gt;:403:52)\n//    ---- Object.InjectedScript.evaluate (&lt;anonymous&gt;:339:21)\n//    IGE *warning* [IgeEntity] : A test warning\nentity.log('A test warning', 'warning');\n</code></pre>\n\n<h1>Log an error message (which will cause an exception to be raised and a stack trace to be shown)</h1>\n\n<pre><code>var entity = new IgeEntity();\n\n// Will output (stack trace is just an example here, real one will be more useful):\n//    Stack: {anonymous}()@&lt;anonymous&gt;:2:8\n//    ---- Object.InjectedScript._evaluateOn (&lt;anonymous&gt;:444:39)\n//    ---- Object.InjectedScript._evaluateAndWrap (&lt;anonymous&gt;:403:52)\n//    ---- Object.InjectedScript.evaluate (&lt;anonymous&gt;:339:21)\n//    IGE *error* [IgeEntity] : An error message\nentity.log('An error message', 'error');\n</code></pre>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>text</span> : String<div class='sub-desc'><p>The text to log.</p>\n</div></li><li><span class='pre'>type</span> : String<div class='sub-desc'><p>The type of log to output, can be 'log',\n'info', 'warning' or 'error'.</p>\n</div></li><li><span class='pre'>obj</span> : Object (optional)<div class='sub-desc'><p>An optional object that will be output\nbefore the log text is output.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeClass\" rel=\"Core.IgeClass\" class=\"docClass\">IgeClass</a></span><div class='sub-desc'><p>this</p>\n</div></li></ul></div></div></div><div id='method-managed' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-managed' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-managed' class='name expandable'>managed</a>( <span class='pre'>[val]</span> ) : <a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a>/Number<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / set the managed mode from 0 to 2. ...</div><div class='long'><p>Gets / set the managed mode from 0 to 2. 0 = off, 1 = static, 2 = dynamic.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Number (optional)<div class='sub-desc'><p>Set to 0 to switch off managed mode, 1 to set to static\nmanaged mode or 2 to dynamic managed mode. When in a managed mode and when\nthe parent of this entity has an entity manager component enabled, the entity\nwill be checked to see if it is inside the visible area of a viewport. If it\nis deemed not to be in a visible area (via it's AABB non-intersection with\nviewport view area) then it will either be un-mounted from the parent (mode 1)\nor marked as no longer in view (mode 2). Mode 2 in view = false will cause the\nentity to no longer be depth-sorted or rendered but will still have it's\nupdate() method called each frame allowing logic processing to occur as normal.\nThe default managed mode is 1.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a>/Number</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-minimumVisibleArea' class='member  not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='Core.IgeViewport'>Core.IgeViewport</span><br/><a href='source/IgeViewport.html#Core-IgeViewport-method-minimumVisibleArea' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeViewport-method-minimumVisibleArea' class='name expandable'>minimumVisibleArea</a>( <span class='pre'>width, height</span> ) : *<span class=\"signature\"><span class='chainable' >chainable</span></span></div><div class='description'><div class='short'>Sets the minimum amount of world in pixels to display in width and height. ...</div><div class='long'><p>Sets the minimum amount of world in pixels to display in width and height.\nWhen set, if the viewport's geometry is reduced below the minimum width or\nheight, the viewport's camera is automatically scaled to ensure that the\nminimum area remains visible in the viewport.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>width</span> : Number<div class='sub-desc'><p>Width in pixels.</p>\n</div></li><li><span class='pre'>height</span> : Number<div class='sub-desc'><p>Height in pixels.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-mode' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-mode' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-mode' class='name expandable'>mode</a>( <span class='pre'>[val]</span> ) : <a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a>/Number<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the positioning mode of the entity. ...</div><div class='long'><p>Gets / sets the positioning mode of the entity.</p>\n\n<h1>Set the positioning mode to 2d</h1>\n\n<pre><code>var entity = new IgeEntity()\n    .mode(0);\n</code></pre>\n\n<h1>Set the positioning mode to isometric</h1>\n\n<pre><code>var entity = new IgeEntity()\n    .mode(1);\n</code></pre>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Number (optional)<div class='sub-desc'><p>0 = 2d, 1 = isometric</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a>/Number</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-mount' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-mount' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-mount' class='name expandable'>mount</a>( <span class='pre'>obj</span> ) : <a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a>/Boolean<span class=\"signature\"></span></div><div class='description'><div class='short'>Mounts this object to the passed object in the scenegraph. ...</div><div class='long'><p>Mounts this object to the passed object in the scenegraph.</p>\n\n<h1>Mount an entity to another entity</h1>\n\n<pre><code>// Create a couple of entities and give them ids\nvar entity1 = new IgeEntity().id('entity1'),\n    entity2 = new IgeEntity().id('entity2');\n\n// Mount entity2 to entity1\nentity2.mount(entity1);\n</code></pre>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>obj</span> : <a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a><div class='sub-desc'>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a>/Boolean</span><div class='sub-desc'><p>Returns this on success or false on failure.</p>\n</div></li></ul><h3 class='pa'>Fires</h3><ul><li><a href=\"#!/api/Core.IgeObject-event-mounted\" rel=\"Core.IgeObject-event-mounted\" class=\"docClass\">mounted</a></li></ul></div></div></div><div id='method-mouseDown' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-mouseDown' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-mouseDown' class='name expandable'>mouseDown</a>( <span class='pre'>[callback]</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the callback that is fired when a mouse\ndown event is triggered. ...</div><div class='long'><p>Gets / sets the callback that is fired when a mouse\ndown event is triggered.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>callback</span> : Function (optional)<div class='sub-desc'><h1>Hook the mouse down event and stop it propagating further down the scenegraph</h1>\n\n<pre><code>entity.mouseDown(function (event, control) {\n    // Mouse down with button\n    console.log('Mouse down button: ' + event.button);\n\n    // Stop the event propagating further down the scenegraph\n    control.stopPropagation();\n\n    // You can ALSO stop propagation without the control object\n    // reference via the global reference:\n    ige.input.stopPropagation();\n});\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-mouseDownOff' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-mouseDownOff' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-mouseDownOff' class='name expandable'>mouseDownOff</a>( <span class='pre'></span> ) : <a href=\"#!/api/Core.IgeEntity\" rel=\"Core.IgeEntity\" class=\"docClass\">Core.IgeEntity</a><span class=\"signature\"><span class='chainable' >chainable</span></span></div><div class='description'><div class='short'>Removes the callback that is fired when a mouse\ndown event is triggered if the listener was registered\nvia the mouseD...</div><div class='long'><p>Removes the callback that is fired when a mouse\ndown event is triggered if the listener was registered\nvia the mouseDown() method.</p>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeEntity\" rel=\"Core.IgeEntity\" class=\"docClass\">Core.IgeEntity</a></span><div class='sub-desc'><p>this</p>\n</div></li></ul></div></div></div><div id='method-mouseEventTrigger' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-mouseEventTrigger' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-mouseEventTrigger' class='name expandable'>mouseEventTrigger</a>( <span class='pre'>val</span> ) : *<span class=\"signature\"><span class='deprecated' >deprecated</span></span></div><div class='description'><div class='short'>Gets / sets the shape / polygon that the mouse events\nare triggered against. ...</div><div class='long'><p>Gets / sets the shape / polygon that the mouse events\nare triggered against. There are two options, 'aabb' and\n'isoBounds'. The default is 'aabb'.</p>\n        <div class='rounded-box deprecated-box deprecated-tag-box'>\n        <p>This method has been <strong>deprected</strong> </p>\n        \n\n        </div>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Object<div class='sub-desc'>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-mouseEventsActive' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-mouseEventsActive' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-mouseEventsActive' class='name expandable'>mouseEventsActive</a>( <span class='pre'>[val]</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Get / set the flag determining if this entity will respond\nto mouse interaction or not. ...</div><div class='long'><p>Get / set the flag determining if this entity will respond\nto mouse interaction or not. When you set a mouse* event e.g.\nmouseUp, mouseOver etc this flag will automatically be reset\nto true.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Boolean (optional)<div class='sub-desc'><p>The flag value true or false.</p>\n\n<h1>Set entity to ignore mouse events</h1>\n\n<pre><code>entity.mouseEventsActive(false);\n</code></pre>\n\n<h1>Set entity to receive mouse events</h1>\n\n<pre><code>entity.mouseEventsActive(true);\n</code></pre>\n\n<h1>Get current flag value</h1>\n\n<pre><code>var val = entity.mouseEventsActive();\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'><p>\"this\" when arguments are passed to allow method\nchaining or the current value if no arguments are specified.</p>\n</div></li></ul></div></div></div><div id='method-mouseInIsoBounds' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-mouseInIsoBounds' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-mouseInIsoBounds' class='name expandable'>mouseInIsoBounds</a>( <span class='pre'></span> )<span class=\"signature\"><span class='deprecated' >deprecated</span></span></div><div class='description'><div class='short'> ...</div><div class='long'>\n        <div class='rounded-box deprecated-box deprecated-tag-box'>\n        <p>This method has been <strong>deprected</strong> </p>\n        <p>Use mouseInBounds3d instead</p>\n\n        </div>\n</div></div></div><div id='method-mouseMove' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-mouseMove' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-mouseMove' class='name expandable'>mouseMove</a>( <span class='pre'>[callback]</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the callback that is fired when a mouse\nmove event is triggered. ...</div><div class='long'><p>Gets / sets the callback that is fired when a mouse\nmove event is triggered.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>callback</span> : Function (optional)<div class='sub-desc'><h1>Hook the mouse move event and stop it propagating further down the scenegraph</h1>\n\n<pre><code>entity.mouseMove(function (event, control) {\n    // Mouse moved with button\n    console.log('Mouse move button: ' + event.button);\n\n    // Stop the event propagating further down the scenegraph\n    control.stopPropagation();\n\n    // You can ALSO stop propagation without the control object\n    // reference via the global reference:\n    ige.input.stopPropagation();\n});\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-mouseMoveOff' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-mouseMoveOff' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-mouseMoveOff' class='name expandable'>mouseMoveOff</a>( <span class='pre'></span> ) : <a href=\"#!/api/Core.IgeEntity\" rel=\"Core.IgeEntity\" class=\"docClass\">Core.IgeEntity</a><span class=\"signature\"><span class='chainable' >chainable</span></span></div><div class='description'><div class='short'>Removes the callback that is fired when a mouse\nmove event is triggered. ...</div><div class='long'><p>Removes the callback that is fired when a mouse\nmove event is triggered.</p>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeEntity\" rel=\"Core.IgeEntity\" class=\"docClass\">Core.IgeEntity</a></span><div class='sub-desc'><p>this</p>\n</div></li></ul></div></div></div><div id='method-mouseOut' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-mouseOut' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-mouseOut' class='name expandable'>mouseOut</a>( <span class='pre'>[callback]</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the callback that is fired when a mouse\nout event is triggered. ...</div><div class='long'><p>Gets / sets the callback that is fired when a mouse\nout event is triggered.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>callback</span> : Function (optional)<div class='sub-desc'><h1>Hook the mouse out event and stop it propagating further down the scenegraph</h1>\n\n<pre><code>entity.mouseOut(function (event, control) {\n    // Mouse out with button\n    console.log('Mouse out button: ' + event.button);\n\n    // Stop the event propagating further down the scenegraph\n    control.stopPropagation();\n\n    // You can ALSO stop propagation without the control object\n    // reference via the global reference:\n    ige.input.stopPropagation();\n});\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-mouseOutOff' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-mouseOutOff' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-mouseOutOff' class='name expandable'>mouseOutOff</a>( <span class='pre'></span> ) : <a href=\"#!/api/Core.IgeEntity\" rel=\"Core.IgeEntity\" class=\"docClass\">Core.IgeEntity</a><span class=\"signature\"><span class='chainable' >chainable</span></span></div><div class='description'><div class='short'>Removes the callback that is fired when a mouse\nout event is triggered. ...</div><div class='long'><p>Removes the callback that is fired when a mouse\nout event is triggered.</p>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeEntity\" rel=\"Core.IgeEntity\" class=\"docClass\">Core.IgeEntity</a></span><div class='sub-desc'><p>this</p>\n</div></li></ul></div></div></div><div id='method-mouseOver' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-mouseOver' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-mouseOver' class='name expandable'>mouseOver</a>( <span class='pre'>[callback]</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the callback that is fired when a mouse\nover event is triggered. ...</div><div class='long'><p>Gets / sets the callback that is fired when a mouse\nover event is triggered.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>callback</span> : Function (optional)<div class='sub-desc'><h1>Hook the mouse over event and stop it propagating further down the scenegraph</h1>\n\n<pre><code>entity.mouseOver(function (event, control) {\n    // Mouse over with button\n    console.log('Mouse over button: ' + event.button);\n\n    // Stop the event propagating further down the scenegraph\n    control.stopPropagation();\n\n    // You can ALSO stop propagation without the control object\n    // reference via the global reference:\n    ige.input.stopPropagation();\n});\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-mouseOverOff' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-mouseOverOff' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-mouseOverOff' class='name expandable'>mouseOverOff</a>( <span class='pre'></span> ) : <a href=\"#!/api/Core.IgeEntity\" rel=\"Core.IgeEntity\" class=\"docClass\">Core.IgeEntity</a><span class=\"signature\"><span class='chainable' >chainable</span></span></div><div class='description'><div class='short'>Removes the callback that is fired when a mouse\nover event is triggered. ...</div><div class='long'><p>Removes the callback that is fired when a mouse\nover event is triggered.</p>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeEntity\" rel=\"Core.IgeEntity\" class=\"docClass\">Core.IgeEntity</a></span><div class='sub-desc'><p>this</p>\n</div></li></ul></div></div></div><div id='method-mousePos' class='member  not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='Core.IgeViewport'>Core.IgeViewport</span><br/><a href='source/IgeViewport.html#Core-IgeViewport-method-mousePos' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeViewport-method-mousePos' class='name expandable'>mousePos</a>( <span class='pre'></span> ) : <a href=\"#!/api/Core.IgePoint3d\" rel=\"Core.IgePoint3d\" class=\"docClass\">IgePoint3d</a><span class=\"signature\"></span></div><div class='description'><div class='short'>Returns the viewport's mouse position. ...</div><div class='long'><p>Returns the viewport's mouse position.</p>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgePoint3d\" rel=\"Core.IgePoint3d\" class=\"docClass\">IgePoint3d</a></span><div class='sub-desc'>\n</div></li></ul><p>Overrides: <a href=\"#!/api/Core.IgeEntity-method-mousePos\" rel=\"Core.IgeEntity-method-mousePos\" class=\"docClass\">Core.IgeEntity.mousePos</a></p></div></div></div><div id='method-mousePosAbsolute' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-mousePosAbsolute' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-mousePosAbsolute' class='name expandable'>mousePosAbsolute</a>( <span class='pre'>[viewport]</span> ) : <a href=\"#!/api/Core.IgePoint3d\" rel=\"Core.IgePoint3d\" class=\"docClass\">IgePoint3d</a><span class=\"signature\"></span></div><div class='description'><div class='short'>Gets the position of the mouse relative to this entity not\ntaking into account viewport translation. ...</div><div class='long'><p>Gets the position of the mouse relative to this entity not\ntaking into account viewport translation.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>viewport</span> : <a href=\"#!/api/Core.IgeViewport\" rel=\"Core.IgeViewport\" class=\"docClass\">IgeViewport</a> (optional)<div class='sub-desc'><p>The viewport to use as the\nbase from which the mouse position is determined. If no\nviewport is specified then the current viewport the engine\nis rendering to is used instead.</p>\n\n<h1>Get absolute mouse position</h1>\n\n<pre><code>var mousePosAbs = entity.mousePosAbsolute();\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgePoint3d\" rel=\"Core.IgePoint3d\" class=\"docClass\">IgePoint3d</a></span><div class='sub-desc'><p>The mouse point relative to the entity\ncenter.</p>\n</div></li></ul></div></div></div><div id='method-mousePosWorld' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-mousePosWorld' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-mousePosWorld' class='name expandable'>mousePosWorld</a>( <span class='pre'>[viewport]</span> ) : <a href=\"#!/api/Core.IgePoint3d\" rel=\"Core.IgePoint3d\" class=\"docClass\">IgePoint3d</a><span class=\"signature\"></span></div><div class='description'><div class='short'>Gets the position of the mouse in world co-ordinates. ...</div><div class='long'><p>Gets the position of the mouse in world co-ordinates.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>viewport</span> : <a href=\"#!/api/Core.IgeViewport\" rel=\"Core.IgeViewport\" class=\"docClass\">IgeViewport</a> (optional)<div class='sub-desc'><p>The viewport to use as the\nbase from which the mouse position is determined. If no\nviewport is specified then the current viewport the engine\nis rendering to is used instead.</p>\n\n<h1>Get mouse position in world co-ordinates</h1>\n\n<pre><code>var mousePosWorld = entity.mousePosWorld();\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgePoint3d\" rel=\"Core.IgePoint3d\" class=\"docClass\">IgePoint3d</a></span><div class='sub-desc'><p>The mouse point relative to the world\ncenter.</p>\n</div></li></ul></div></div></div><div id='method-mouseUp' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-mouseUp' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-mouseUp' class='name expandable'>mouseUp</a>( <span class='pre'>[callback]</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the callback that is fired when a mouse\nup event is triggered. ...</div><div class='long'><p>Gets / sets the callback that is fired when a mouse\nup event is triggered.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>callback</span> : Function (optional)<div class='sub-desc'><h1>Hook the mouse up event and stop it propagating further down the scenegraph</h1>\n\n<pre><code>entity.mouseUp(function (event, control) {\n    // Mouse up with button\n    console.log('Mouse up button: ' + event.button);\n\n    // Stop the event propagating further down the scenegraph\n    control.stopPropagation();\n\n    // You can ALSO stop propagation without the control object\n    // reference via the global reference:\n    ige.input.stopPropagation();\n});\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-mouseUpOff' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-mouseUpOff' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-mouseUpOff' class='name expandable'>mouseUpOff</a>( <span class='pre'></span> ) : <a href=\"#!/api/Core.IgeEntity\" rel=\"Core.IgeEntity\" class=\"docClass\">Core.IgeEntity</a><span class=\"signature\"><span class='chainable' >chainable</span></span></div><div class='description'><div class='short'>Removes the callback that is fired when a mouse\nup event is triggered. ...</div><div class='long'><p>Removes the callback that is fired when a mouse\nup event is triggered.</p>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeEntity\" rel=\"Core.IgeEntity\" class=\"docClass\">Core.IgeEntity</a></span><div class='sub-desc'><p>this</p>\n</div></li></ul></div></div></div><div id='method-mouseWheel' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-mouseWheel' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-mouseWheel' class='name expandable'>mouseWheel</a>( <span class='pre'>[callback]</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the callback that is fired when a mouse\nwheel event is triggered. ...</div><div class='long'><p>Gets / sets the callback that is fired when a mouse\nwheel event is triggered.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>callback</span> : Function (optional)<div class='sub-desc'><h1>Hook the mouse wheel event and stop it propagating further down the scenegraph</h1>\n\n<pre><code>entity.mouseWheel(function (event, control) {\n    // Mouse wheel with button\n    console.log('Mouse wheel button: ' + event.button);\n    console.log('Mouse wheel delta: ' + event.wheelDelta);\n\n    // Stop the event propagating further down the scenegraph\n    control.stopPropagation();\n\n    // You can ALSO stop propagation without the control object\n    // reference via the global reference:\n    ige.input.stopPropagation();\n});\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-mouseWheelOff' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-mouseWheelOff' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-mouseWheelOff' class='name expandable'>mouseWheelOff</a>( <span class='pre'></span> ) : <a href=\"#!/api/Core.IgeEntity\" rel=\"Core.IgeEntity\" class=\"docClass\">Core.IgeEntity</a><span class=\"signature\"><span class='chainable' >chainable</span></span></div><div class='description'><div class='short'>Removes the callback that is fired when a mouse\nwheel event is triggered. ...</div><div class='long'><p>Removes the callback that is fired when a mouse\nwheel event is triggered.</p>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeEntity\" rel=\"Core.IgeEntity\" class=\"docClass\">Core.IgeEntity</a></span><div class='sub-desc'><p>this</p>\n</div></li></ul></div></div></div><div id='method-newFrame' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-newFrame' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-newFrame' class='name expandable'>newFrame</a>( <span class='pre'></span> ) : Boolean<span class=\"signature\"></span></div><div class='description'><div class='short'>Determines if the frame alternator value for this entity\nmatches the engine's frame alternator value. ...</div><div class='long'><p>Determines if the frame alternator value for this entity\nmatches the engine's frame alternator value. The entity's\nframe alternator value will be set to match the engine's\nafter each call to the entity.tick() method so the return\nvalue of this method can be used to determine if the tick()\nmethod has already been run for this entity.</p>\n\n<p>This is useful if you have multiple viewports which will\ncause the entity tick() method to fire once for each viewport\nbut you only want to execute update code such as movement etc\non the first time the tick() method is called.</p>\n\n<h1>Determine if the entity has already had it's tick method called</h1>\n\n<pre><code>var tickAlreadyCalled = entity.newFrame();\n</code></pre>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'>Boolean</span><div class='sub-desc'><p>If false, the entity's tick method has\nnot yet been processed for this tick.</p>\n</div></li></ul></div></div></div><div id='method-noAabb' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-noAabb' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-noAabb' class='name expandable'>noAabb</a>( <span class='pre'>[val]</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the noAabb flag that determines if the entity's axis\naligned bounding box should be calculated every tick...</div><div class='long'><p>Gets / sets the noAabb flag that determines if the entity's axis\naligned bounding box should be calculated every tick or not. If\nyou don't need the AABB data (for instance if you don't need to\ndetect mouse events on this entity or you DO want the AABB to be\nupdated but want to control it manually by calling aabb(true)\nyourself as needed).</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Boolean (optional)<div class='sub-desc'><p>If set to true will turn off AABB calculation.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-objLoad' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-objLoad' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-objLoad' class='name expandable'>objLoad</a>( <span class='pre'>obj</span> )<span class=\"signature\"></span></div><div class='description'><div class='short'> ...</div><div class='long'>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>obj</span> : Object<div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-objSave' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-objSave' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-objSave' class='name expandable'>objSave</a>( <span class='pre'></span> ) : {igeClass: *, data: *}<span class=\"signature\"></span></div><div class='description'><div class='short'> ...</div><div class='long'>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'>{igeClass: *, data: *}</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-occupyTile' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-occupyTile' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-occupyTile' class='name expandable'>occupyTile</a>( <span class='pre'>[x], [y], [width], [height]</span> ) : <a href=\"#!/api/Core.IgeEntity\" rel=\"Core.IgeEntity\" class=\"docClass\">Core.IgeEntity</a><span class=\"signature\"><span class='chainable' >chainable</span></span></div><div class='description'><div class='short'>Adds the object to the tile map at the passed tile co-ordinates. ...</div><div class='long'><p>Adds the object to the tile map at the passed tile co-ordinates. If\nno tile co-ordinates are passed, will use the current tile position\nand the tileWidth() and tileHeight() values.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>x</span> : Number (optional)<div class='sub-desc'><p>X co-ordinate of the tile to occupy.</p>\n</div></li><li><span class='pre'>y</span> : Number (optional)<div class='sub-desc'><p>Y co-ordinate of the tile to occupy.</p>\n</div></li><li><span class='pre'>width</span> : Number (optional)<div class='sub-desc'><p>Number of tiles along the x-axis to occupy.</p>\n</div></li><li><span class='pre'>height</span> : Number (optional)<div class='sub-desc'><p>Number of tiles along the y-axis to occupy.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeEntity\" rel=\"Core.IgeEntity\" class=\"docClass\">Core.IgeEntity</a></span><div class='sub-desc'><p>this</p>\n</div></li></ul></div></div></div><div id='method-off' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEventingClass' rel='Core.IgeEventingClass' class='defined-in docClass'>Core.IgeEventingClass</a><br/><a href='source/IgeEventingClass.html#Core-IgeEventingClass-method-off' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEventingClass-method-off' class='name expandable'>off</a>( <span class='pre'>eventName, evtListener, callback</span> ) : Boolean<span class=\"signature\"></span></div><div class='description'><div class='short'>Remove an event listener. ...</div><div class='long'><p>Remove an event listener. If the _processing flag is true\nthen the removal will be placed in the removals array to be\nprocessed after the event loop has completed in the emit()\nmethod.</p>\n\n<h1>Switch off an Event Listener</h1>\n\n<pre><code>// Register event lister and store in \"evt\"\nvar evt = myEntity.on('mouseDown', function () { console.log('down'); });\n\n// Switch off event listener\nmyEntity.off('mouseDown', evt);\n</code></pre>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>eventName</span> : Boolean<div class='sub-desc'><p>The name of the event you originally registered to listen for.</p>\n</div></li><li><span class='pre'>evtListener</span> : Object<div class='sub-desc'><p>The event listener object to cancel. This object is the one\nreturned when calling the on() method. It is NOT the method you passed as the second argument\nto the on() method.</p>\n</div></li><li><span class='pre'>callback</span> : Function<div class='sub-desc'><p>The callback method to call when the event listener has been\nsuccessfully removed. If you attempt to remove a listener during the event firing loop\nthen the listener will not immediately be removed but will be queued for removal before\nthe next listener loop is fired. In this case you may like to be informed via callback\nwhen the listener has been fully removed in which case, provide a method for this argument.</p>\n\n<p>The callback will be passed a single boolean argument denoting if the removal was successful\n(true) or the listener did not exist to remove (false).</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>Boolean</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-on' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEventingClass' rel='Core.IgeEventingClass' class='defined-in docClass'>Core.IgeEventingClass</a><br/><a href='source/IgeEventingClass.html#Core-IgeEventingClass-method-on' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEventingClass-method-on' class='name expandable'>on</a>( <span class='pre'>eventName, call, [context], [oneShot], [sendEventName]</span> ) : Object<span class=\"signature\"></span></div><div class='description'><div class='short'>Add an event listener method for an event. ...</div><div class='long'><p>Add an event listener method for an event.</p>\n\n<h1>Add an Event Listener</h1>\n\n<pre><code>// Register event lister and store in \"evt\"\nvar evt = myEntity.on('mouseDown', function () { console.log('down'); });\n</code></pre>\n\n<h1>Listen for Event Data</h1>\n\n<pre><code>// Set a listener to listen for the data (multiple values emitted\n// from an event are passed as function arguments)\nmyEntity.on('hello', function (arg1, arg2) {\n    console.log(arg1, arg2);\n}\n\n// Emit the event named \"hello\"\nmyEntity.emit('hello', ['data1', 'data2']);\n\n// The console output is:\n//    data1, data2\n</code></pre>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>eventName</span> : String/Array<div class='sub-desc'><p>The name of the event to listen for (string), or an array of events to listen for.</p>\n</div></li><li><span class='pre'>call</span> : Function<div class='sub-desc'><p>The method to call when the event listener is triggered.</p>\n</div></li><li><span class='pre'>context</span> : Object (optional)<div class='sub-desc'><p>The context in which the call to the listening method will be made (sets the 'this' variable in the method to the object passed as this parameter).</p>\n</div></li><li><span class='pre'>oneShot</span> : Boolean (optional)<div class='sub-desc'><p>If set, will instruct the listener to only listen to the event being fired once and will not fire again.</p>\n</div></li><li><span class='pre'>sendEventName</span> : Boolean (optional)<div class='sub-desc'><p>If set, will instruct the emitter to send the event name as the argument instead of any emitted arguments.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>Object</span><div class='sub-desc'><p>The event listener object. Hold this value if you later want to turn off the event listener.</p>\n</div></li></ul></div></div></div><div id='method-opacity' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-opacity' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-opacity' class='name expandable'>opacity</a>( <span class='pre'>[val]</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the entity opacity from 0.0 to 1.0. ...</div><div class='long'><p>Gets / sets the entity opacity from 0.0 to 1.0.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Number (optional)<div class='sub-desc'><p>The opacity value.</p>\n\n<h1>Set the entity to half-visible</h1>\n\n<pre><code>entity.opacity(0.5);\n</code></pre>\n\n<h1>Set the entity to fully-visible</h1>\n\n<pre><code>entity.opacity(1.0);\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'><p>\"this\" when arguments are passed to allow method\nchaining or the current value if no arguments are specified.</p>\n</div></li></ul></div></div></div><div id='method-origin' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-origin' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-origin' class='name expandable'>origin</a>( <span class='pre'></span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets the origin accessor object. ...</div><div class='long'><p>Gets the origin accessor object.</p>\n\n<h1>Use the origin accessor object to set the origin of the entity on the x axis to 1</h1>\n\n<pre><code>entity.origin().x(1);\n</code></pre>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-originBy' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-originBy' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-originBy' class='name expandable'>originBy</a>( <span class='pre'>x, y, z</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Sets the origin of the entity by adding the passed values to\nthe current origin values. ...</div><div class='long'><p>Sets the origin of the entity by adding the passed values to\nthe current origin values.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>x</span> : Number<div class='sub-desc'><p>The x co-ordinate.</p>\n</div></li><li><span class='pre'>y</span> : Number<div class='sub-desc'><p>The y co-ordinate.</p>\n</div></li><li><span class='pre'>z</span> : Number<div class='sub-desc'><p>The z co-ordinate.</p>\n\n<h1>Add 0.5 to the origin on the x axis</h1>\n\n<pre><code>entity.originBy(0.5, 0, 0);\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-originTo' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-originTo' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-originTo' class='name expandable'>originTo</a>( <span class='pre'>x, y, z</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Set the origin of the entity to the passed values. ...</div><div class='long'><p>Set the origin of the entity to the passed values.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>x</span> : Number<div class='sub-desc'><p>The x co-ordinate.</p>\n</div></li><li><span class='pre'>y</span> : Number<div class='sub-desc'><p>The y co-ordinate.</p>\n</div></li><li><span class='pre'>z</span> : Number<div class='sub-desc'><p>The z co-ordinate.</p>\n\n<h1>Set the entity origin to 0.5 on all axes</h1>\n\n<pre><code>entity.originTo(0.5, 0.5, 0.5);\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-overTiles' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-overTiles' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-overTiles' class='name expandable'>overTiles</a>( <span class='pre'></span> ) : Array<span class=\"signature\"><span class='private' >private</span></span></div><div class='description'><div class='short'>Returns an array of tile co-ordinates that the object is currently\nover, calculated using the current world co-ordina...</div><div class='long'><p>Returns an array of tile co-ordinates that the object is currently\nover, calculated using the current world co-ordinates of the object\nas well as it's 3d geometry.</p>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'>Array</span><div class='sub-desc'><p>The array of tile co-ordinates as IgePoint3d instances.</p>\n</div></li></ul></div></div></div><div id='method-paintAabbs' class='member  not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='Core.IgeViewport'>Core.IgeViewport</span><br/><a href='source/IgeViewport.html#Core-IgeViewport-method-paintAabbs' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeViewport-method-paintAabbs' class='name expandable'>paintAabbs</a>( <span class='pre'>ctx, rootObject, index</span> )<span class=\"signature\"></span></div><div class='description'><div class='short'>Draws the bounding data for each entity in the scenegraph. ...</div><div class='long'><p>Draws the bounding data for each entity in the scenegraph.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>ctx</span> : Object<div class='sub-desc'>\n</div></li><li><span class='pre'>rootObject</span> : Object<div class='sub-desc'>\n</div></li><li><span class='pre'>index</span> : Object<div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-parent' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-parent' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-parent' class='name expandable'>parent</a>( <span class='pre'>[id]</span> ) : Object/undefined<span class=\"signature\"></span></div><div class='description'><div class='short'>Returns the object's parent object (the object that\nit is mounted to). ...</div><div class='long'><p>Returns the object's parent object (the object that\nit is mounted to).</p>\n\n<h1>Get the object parent</h1>\n\n<pre><code>// Create a couple of entities and give them ids\nvar entity1 = new IgeEntity().id('entity1'),\n    entity2 = new IgeEntity().id('entity2');\n\n// Mount entity2 to entity1\nentity2.mount(entity1);\n\n// Get the parent of entity2 (which is entity1)\nvar parent = entity2.parent();\n\n// Log the parent's id (will output \"entity1\")\nconsole.log(parent.id());\n</code></pre>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>id</span> : String (optional)<div class='sub-desc'><p>Optional, if present will scan up\nthe parent chain until a parent with the matching id is\nfound. If none is found, returns undefined.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>Object/undefined</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-removeAllGroups' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-removeAllGroups' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-removeAllGroups' class='name expandable'>removeAllGroups</a>( <span class='pre'></span> ) : <a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a><span class=\"signature\"><span class='chainable' >chainable</span></span></div><div class='description'><div class='short'>Removes the entity from all groups it is a member of. ...</div><div class='long'><p>Removes the entity from all groups it is a member of.</p>\n\n<h1>Remove entity from all groups</h1>\n\n<pre><code>var entity = new IgeEntity();\nentity.addGroup('g1', 'g3', 'g2');\n\n// This will output \"['g1', 'g3', 'g2']\"\nconsole.log(entity.groups());\n\n// Remove all the groups\nentity.removeAllGroups();\n\n// This will output \"[]\"\nconsole.log(entity.groups());\n</code></pre>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a></span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-removeBehaviour' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-removeBehaviour' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-removeBehaviour' class='name expandable'>removeBehaviour</a>( <span class='pre'>id, [duringTick]</span> ) : <a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a>/Boolean<span class=\"signature\"></span></div><div class='description'><div class='short'>Removes a behaviour to the object's active behaviour list by it's id. ...</div><div class='long'><p>Removes a behaviour to the object's active behaviour list by it's id.</p>\n\n<h1>Remove a behaviour with the id \"myBehaviour\"</h1>\n\n<pre><code>var entity = new IgeEntity();\nentity.addBehaviour('myBehaviour', function () {\n    // Code here will execute during each engine update for\n    // this entity. I can access the entity via the \"this\"\n    // keyword such as:\n    this._somePropertyOfTheEntity = 'moo';\n});\n\n// Now remove the \"myBehaviour\" behaviour\nentity.removeBehaviour('myBehaviour');\n</code></pre>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>id</span> : String<div class='sub-desc'>\n</div></li><li><span class='pre'>duringTick</span> : Boolean (optional)<div class='sub-desc'><p>If true will look to remove the behaviour\nfrom the tick method rather than the update method.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a>/Boolean</span><div class='sub-desc'><p>Returns this on success or false on failure.</p>\n</div></li></ul></div></div></div><div id='method-removeComponent' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeClass' rel='Core.IgeClass' class='defined-in docClass'>Core.IgeClass</a><br/><a href='source/IgeClass.html#Core-IgeClass-method-removeComponent' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeClass-method-removeComponent' class='name expandable'>removeComponent</a>( <span class='pre'>componentId</span> ) : <a href=\"#!/api/Core.IgeClass\" rel=\"Core.IgeClass\" class=\"docClass\">IgeClass</a><span class=\"signature\"></span></div><div class='description'><div class='short'>Removes a component by it's id. ...</div><div class='long'><p>Removes a component by it's id.</p>\n\n<h1>Remove a component by it's id (namespace)</h1>\n\n<pre><code>var entity = new IgeEntity();\n\n// Let's add the velocity component\nentity.addComponent(IgeVelocityComponent);\n\n// Now that the component is added, let's remove\n// it via it's id (\"velocity\")\nentity.removeComponent('velocity');\n</code></pre>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>componentId</span> : String<div class='sub-desc'><p>The id of the component to remove.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeClass\" rel=\"Core.IgeClass\" class=\"docClass\">IgeClass</a></span><div class='sub-desc'><p>this</p>\n</div></li></ul></div></div></div><div id='method-removeGroup' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-removeGroup' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-removeGroup' class='name expandable'>removeGroup</a>( <span class='pre'>groupName</span> ) : <a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a><span class=\"signature\"><span class='chainable' >chainable</span></span></div><div class='description'><div class='short'>Removes the entity from the group or groups passed. ...</div><div class='long'><p>Removes the entity from the group or groups passed. This\nmethod accepts multiple arguments and will remove the entity\nfrom all groups passed as arguments.</p>\n\n<h1>Remove entity from single group</h1>\n\n<pre><code>var entity = new IgeEntity();\nentity.addGroup('g1', 'g2');\n\n// This will output \"['g1', 'g2']\"\nconsole.log(entity.groups());\n\n// Remove entity from a single group\nentity.removeGroup('g1');\n\n// This will output \"['g2']\"\nconsole.log(entity.groups());\n</code></pre>\n\n<h1>Remove entity from multiple groups</h1>\n\n<pre><code>var entity = new IgeEntity();\nentity.addGroup('g1', 'g3', 'g2');\n\n// This will output \"['g1', 'g3', 'g2']\"\nconsole.log(entity.groups());\n\n// Remove entity from multiple groups\nentity.removeGroup('g1', 'g3');\n\n// This will output \"['g2']\"\nconsole.log(entity.groups());\n</code></pre>\n\n<h1>Remove entity from multiple groups via an array</h1>\n\n<pre><code>var entity = new IgeEntity();\nentity.addGroup('g1', 'g3', 'g2');\n\n// This will output \"['g1', 'g3', 'g2']\"\nconsole.log(entity.groups());\n\n// Remove entity from multiple groups\nentity.removeGroup(['g1', 'g3']);\n\n// This will output \"['g2']\"\nconsole.log(entity.groups());\n</code></pre>\n\n<h1>Remove entity from multiple groups via multiple arrays</h1>\n\n<pre><code>var entity = new IgeEntity();\nentity.addGroup('g1', 'g2', 'g3', 'g4', 'g5', 'g6', 'g7');\n\n// This will output \"['g1', 'g2', 'g3', 'g4', 'g5', 'g6', 'g7']\"\nconsole.log(entity.groups());\n\n// Remove entity from multiple groups\nentity.removeGroup(['g1', 'g3'], ['g5', 'g6', 'g7']);\n\n// This will output \"['g2', 'g4']\"\nconsole.log(entity.groups());\n</code></pre>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>groupName</span> : String/String[]<div class='sub-desc'><p>The name of the group or array of group\nnames to remove this entity as a member of.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a></span><div class='sub-desc'><p>this</p>\n</div></li></ul></div></div></div><div id='method-rotate' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-rotate' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-rotate' class='name expandable'>rotate</a>( <span class='pre'></span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets the translate accessor object. ...</div><div class='long'><p>Gets the translate accessor object.</p>\n\n<h1>Use the rotate accessor object to rotate the entity about the z axis 10 degrees</h1>\n\n<pre><code>entity.rotate().z(Math.radians(10));\n</code></pre>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-rotateBy' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-rotateBy' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-rotateBy' class='name expandable'>rotateBy</a>( <span class='pre'>x, y, z</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Rotates the entity by adding the passed values to\nthe current rotation values. ...</div><div class='long'><p>Rotates the entity by adding the passed values to\nthe current rotation values.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>x</span> : Number<div class='sub-desc'><p>The x co-ordinate.</p>\n</div></li><li><span class='pre'>y</span> : Number<div class='sub-desc'><p>The y co-ordinate.</p>\n</div></li><li><span class='pre'>z</span> : Number<div class='sub-desc'><p>The z co-ordinate.</p>\n\n<h1>Rotate the entity by 10 degrees about the z axis</h1>\n\n<pre><code>entity.rotateBy(0, 0, Math.radians(10));\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-rotateTo' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-rotateTo' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-rotateTo' class='name expandable'>rotateTo</a>( <span class='pre'>x, y, z</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Rotates the entity to the passed values. ...</div><div class='long'><p>Rotates the entity to the passed values.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>x</span> : Number<div class='sub-desc'><p>The x co-ordinate.</p>\n</div></li><li><span class='pre'>y</span> : Number<div class='sub-desc'><p>The y co-ordinate.</p>\n</div></li><li><span class='pre'>z</span> : Number<div class='sub-desc'><p>The z co-ordinate.</p>\n\n<h1>Rotate the entity to 10 degrees about the z axis</h1>\n\n<pre><code>entity.rotateTo(0, 0, Math.radians(10));\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-rotateToPoint' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-rotateToPoint' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-rotateToPoint' class='name expandable'>rotateToPoint</a>( <span class='pre'>point</span> ) : *<span class=\"signature\"><span class='chainable' >chainable</span></span></div><div class='description'><div class='short'>Rotates the entity to point at the target point around the z axis. ...</div><div class='long'><p>Rotates the entity to point at the target point around the z axis.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>point</span> : <a href=\"#!/api/Core.IgePoint3d\" rel=\"Core.IgePoint3d\" class=\"docClass\">IgePoint3d</a><div class='sub-desc'><p>The point in world co-ordinates to\npoint the entity at.</p>\n\n<h1>Point the entity at another entity</h1>\n\n<pre><code>entity.rotateToPoint(otherEntity.worldPosition());\n</code></pre>\n\n<h1>Point the entity at mouse</h1>\n\n<pre><code>entity.rotateToPoint(ige._currentViewport.mousePos());\n</code></pre>\n\n<h1>Point the entity at an arbitrary point x, y</h1>\n\n<pre><code>entity.rotateToPoint(new IgePoint3d(x, y, 0));\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-saveSpecialProp' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-saveSpecialProp' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-saveSpecialProp' class='name expandable'>saveSpecialProp</a>( <span class='pre'>obj, i</span> ) : Object/undefined<span class=\"signature\"></span></div><div class='description'><div class='short'> ...</div><div class='long'>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>obj</span> : Object<div class='sub-desc'>\n</div></li><li><span class='pre'>i</span> : String<div class='sub-desc'>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>Object/undefined</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-scale' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-scale' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-scale' class='name expandable'>scale</a>( <span class='pre'></span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets the scale accessor object. ...</div><div class='long'><p>Gets the scale accessor object.</p>\n\n<h1>Use the scale accessor object to set the scale of the entity on the x axis to 1</h1>\n\n<pre><code>entity.scale().x(1);\n</code></pre>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-scaleBy' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-scaleBy' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-scaleBy' class='name expandable'>scaleBy</a>( <span class='pre'>x, y, z</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Scales the entity by adding the passed values to\nthe current scale values. ...</div><div class='long'><p>Scales the entity by adding the passed values to\nthe current scale values.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>x</span> : Number<div class='sub-desc'><p>The x co-ordinate.</p>\n</div></li><li><span class='pre'>y</span> : Number<div class='sub-desc'><p>The y co-ordinate.</p>\n</div></li><li><span class='pre'>z</span> : Number<div class='sub-desc'><p>The z co-ordinate.</p>\n\n<h1>Scale the entity by 2 on the x axis</h1>\n\n<pre><code>entity.scaleBy(2, 0, 0);\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-scaleTo' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-scaleTo' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-scaleTo' class='name expandable'>scaleTo</a>( <span class='pre'>x, y, z</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Scale the entity to the passed values. ...</div><div class='long'><p>Scale the entity to the passed values.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>x</span> : Number<div class='sub-desc'><p>The x co-ordinate.</p>\n</div></li><li><span class='pre'>y</span> : Number<div class='sub-desc'><p>The y co-ordinate.</p>\n</div></li><li><span class='pre'>z</span> : Number<div class='sub-desc'><p>The z co-ordinate.</p>\n\n<h1>Set the entity scale to 1 on all axes</h1>\n\n<pre><code>entity.scaleTo(1, 1, 1);\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-scene' class='member  not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='Core.IgeViewport'>Core.IgeViewport</span><br/><a href='source/IgeViewport.html#Core-IgeViewport-method-scene' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeViewport-method-scene' class='name expandable'>scene</a>( <span class='pre'>scene</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the scene that the viewport will render. ...</div><div class='long'><p>Gets / sets the scene that the viewport will render.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>scene</span> : <a href=\"#!/api/Core.IgeScene2d\" rel=\"Core.IgeScene2d\" class=\"docClass\">IgeScene2d</a><div class='sub-desc'>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-screenPosition' class='member  not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='Core.IgeViewport'>Core.IgeViewport</span><br/><a href='source/IgeViewport.html#Core-IgeViewport-method-screenPosition' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeViewport-method-screenPosition' class='name expandable'>screenPosition</a>( <span class='pre'></span> ) : <a href=\"#!/api/Core.IgePoint3d\" rel=\"Core.IgePoint3d\" class=\"docClass\">IgePoint3d</a><span class=\"signature\"></span></div><div class='description'><div class='short'>Returns the screen position of the viewport as an IgePoint3d where x is the\n\"left\" and y is the \"top\", useful for pos...</div><div class='long'><p>Returns the screen position of the viewport as an IgePoint3d where x is the\n\"left\" and y is the \"top\", useful for positioning HTML elements at the\nscreen location of an IGE entity. The returned values indicate the center\nof the viewport on the screen.</p>\n\n<p>This method assumes that the top-left\nof the main canvas element is at 0, 0. If not you can adjust the values\nyourself to allow for offset.</p>\n\n<h1>Get the screen position of the entity</h1>\n\n<pre><code>var screenPos = entity.screenPosition();\n</code></pre>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgePoint3d\" rel=\"Core.IgePoint3d\" class=\"docClass\">IgePoint3d</a></span><div class='sub-desc'><p>The screen position of the entity.</p>\n</div></li></ul><p>Overrides: <a href=\"#!/api/Core.IgeEntity-method-screenPosition\" rel=\"Core.IgeEntity-method-screenPosition\" class=\"docClass\">Core.IgeEntity.screenPosition</a></p></div></div></div><div id='method-show' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-show' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-show' class='name expandable'>show</a>( <span class='pre'></span> ) : *<span class=\"signature\"><span class='chainable' >chainable</span></span></div><div class='description'><div class='short'>Sets the entity as visible and able to be interacted with. ...</div><div class='long'><p>Sets the entity as visible and able to be interacted with.</p>\n\n<h1>Show a hidden entity</h1>\n\n<pre><code>entity.show();\n</code></pre>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'><p>The object this method was called from to allow\nmethod chaining.</p>\n</div></li></ul></div></div></div><div id='method-size3d' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-size3d' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-size3d' class='name expandable'>size3d</a>( <span class='pre'>x, y, z</span> )<span class=\"signature\"><span class='deprecated' >deprecated</span></span></div><div class='description'><div class='short'> ...</div><div class='long'>\n        <div class='rounded-box deprecated-box deprecated-tag-box'>\n        <p>This method has been <strong>deprected</strong> </p>\n        <p>Use bounds3d instead</p>\n\n        </div>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>x</span> : Object<div class='sub-desc'>\n</div></li><li><span class='pre'>y</span> : Object<div class='sub-desc'>\n</div></li><li><span class='pre'>z</span> : Object<div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-streamControl' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-streamControl' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-streamControl' class='name expandable'>streamControl</a>( <span class='pre'>[method]</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the stream control callback function that will be called\neach time the entity tick method is called and s...</div><div class='long'><p>Gets / sets the stream control callback function that will be called\neach time the entity tick method is called and stream-able data is\nupdated.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>method</span> : Function (optional)<div class='sub-desc'><p>The stream control method.</p>\n\n<h1>Set the entity's stream control method to control when this entity is streamed and when it is not</h1>\n\n<pre><code>entity.streamControl(function (clientId) {\n    // Let's use an example where we only want this entity to stream\n    // to one particular client with the id 4039589434\n    if (clientId === '4039589434') {\n        // Returning true tells the network stream to send data\n        // about this entity to the client\n        return true;\n    } else {\n        // Returning false tells the network stream NOT to send\n        // data about this entity to the client\n        return false;\n    }\n});\n</code></pre>\n\n<p>Further reading: <a href=\"http://www.isogenicengine.com/documentation/isogenic-game-engine/versions/1-1-0/manual/networking-multiplayer/realtime-network-streaming/stream-modes-and-controlling-streaming/\">Controlling Streaming</a></p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'><p>\"this\" when arguments are passed to allow method\nchaining or the current value if no arguments are specified.</p>\n</div></li></ul></div></div></div><div id='method-streamCreate' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-streamCreate' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-streamCreate' class='name expandable'>streamCreate</a>( <span class='pre'>clientId</span> ) : Boolean<span class=\"signature\"></span></div><div class='description'><div class='short'>Issues a create entity command to the passed client id\nor array of ids. ...</div><div class='long'><p>Issues a create entity command to the passed client id\nor array of ids. If no id is passed it will issue the\ncommand to all connected clients. If using streamMode(1)\nthis method is called automatically.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>clientId</span> : *<div class='sub-desc'><p>The id or array of ids to send\nthe command to.</p>\n\n<h1>Send a create command for this entity to all clients</h1>\n\n<pre><code>entity.streamCreate();\n</code></pre>\n\n<h1>Send a create command for this entity to an array of client ids</h1>\n\n<pre><code>entity.streamCreate(['43245325', '326755464', '436743453']);\n</code></pre>\n\n<h1>Send a create command for this entity to a single client id</h1>\n\n<pre><code>entity.streamCreate('43245325');\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>Boolean</span><div class='sub-desc'>\n</div></li></ul><h3 class='pa'>Fires</h3><ul><li><a href=\"#!/api/Core.IgeEntity-event-streamPropChange\" rel=\"Core.IgeEntity-event-streamPropChange\" class=\"docClass\">streamPropChange</a></li></ul></div></div></div><div id='method-streamCreateData' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-streamCreateData' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-streamCreateData' class='name expandable'>streamCreateData</a>( <span class='pre'></span> )<span class=\"signature\"></span></div><div class='description'><div class='short'>Override this method if your entity should send data through to\nthe client when it is being created on the client for...</div><div class='long'><p>Override this method if your entity should send data through to\nthe client when it is being created on the client for the first\ntime through the network stream. The data will be provided as the\nfirst argument in the constructor call to the entity class so\nyou should expect to receive it as per this example:</p>\n\n<h1>Using and Receiving Stream Create Data</h1>\n\n<pre><code>var MyNewClass = <a href=\"#!/api/Core.IgeEntity-method-extend\" rel=\"Core.IgeEntity-method-extend\" class=\"docClass\">IgeEntity.extend</a>({\n    classId: 'MyNewClass',\n\n    // Define the init with the parameter to receive the\n    // data you return in the streamCreateData() method\n    init: function (myCreateData) {\n        this._myData = myCreateData;\n    },\n\n    streamCreateData: function () {\n        return this._myData;\n    }\n});\n</code></pre>\n\n<p>Valid return values must not include circular references!</p>\n</div></div></div><div id='method-streamDestroy' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-streamDestroy' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-streamDestroy' class='name expandable'>streamDestroy</a>( <span class='pre'>clientId</span> ) : Boolean<span class=\"signature\"></span></div><div class='description'><div class='short'>Issues a destroy entity command to the passed client id\nor array of ids. ...</div><div class='long'><p>Issues a destroy entity command to the passed client id\nor array of ids. If no id is passed it will issue the\ncommand to all connected clients. If using streamMode(1)\nthis method is called automatically.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>clientId</span> : *<div class='sub-desc'><p>The id or array of ids to send\nthe command to.</p>\n\n<h1>Send a destroy command for this entity to all clients</h1>\n\n<pre><code>entity.streamDestroy();\n</code></pre>\n\n<h1>Send a destroy command for this entity to an array of client ids</h1>\n\n<pre><code>entity.streamDestroy(['43245325', '326755464', '436743453']);\n</code></pre>\n\n<h1>Send a destroy command for this entity to a single client id</h1>\n\n<pre><code>entity.streamDestroy('43245325');\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>Boolean</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-streamEmitCreated' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-streamEmitCreated' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-streamEmitCreated' class='name expandable'>streamEmitCreated</a>( <span class='pre'>val</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the stream emit created flag. ...</div><div class='long'><p>Gets / sets the stream emit created flag. If set to true this entity\nemit a \"streamCreated\" event when it is created by the stream, but\nafter the id and initial transform are set.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Object<div class='sub-desc'>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-streamFloatPrecision' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-streamFloatPrecision' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-streamFloatPrecision' class='name expandable'>streamFloatPrecision</a>( <span class='pre'>[val]</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the precision by which floating-point values will\nbe encoded and sent when packaged into stream data. ...</div><div class='long'><p>Gets / sets the precision by which floating-point values will\nbe encoded and sent when packaged into stream data.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Number (optional)<div class='sub-desc'><p>The number of decimal places to preserve.</p>\n\n<h1>Set the float precision to 2</h1>\n\n<pre><code>// This will mean that any data using floating-point values\n// that gets sent across the network stream will be rounded\n// to 2 decimal places. This helps save bandwidth by not\n// having to send the entire number since precision above\n// 2 decimal places is usually not that important to the\n// simulation.\nentity.streamFloatPrecision(2);\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'><p>\"this\" when arguments are passed to allow method\nchaining or the current value if no arguments are specified.</p>\n</div></li></ul></div></div></div><div id='method-streamForceUpdate' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-streamForceUpdate' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-streamForceUpdate' class='name expandable'>streamForceUpdate</a>( <span class='pre'></span> ) : *<span class=\"signature\"><span class='chainable' >chainable</span></span></div><div class='description'><div class='short'>Forces the stream to push this entity's full stream data on the\nnext stream sync regardless of what clients have rece...</div><div class='long'><p>Forces the stream to push this entity's full stream data on the\nnext stream sync regardless of what clients have received in the\npast. This should only be used when required rather than every\ntick as it will reduce the overall efficiency of the stream if\nused every tick.</p>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-streamMode' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-streamMode' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-streamMode' class='name expandable'>streamMode</a>( <span class='pre'>[val]</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the stream mode that the stream system will use when\nhandling pushing data updates to connected clients. ...</div><div class='long'><p>Gets / sets the stream mode that the stream system will use when\nhandling pushing data updates to connected clients.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Number (optional)<div class='sub-desc'><p>A value representing the stream mode.</p>\n\n<h1>Set the entity to disable streaming</h1>\n\n<pre><code>entity.streamMode(0);\n</code></pre>\n\n<h1>Set the entity to automatic streaming</h1>\n\n<pre><code>entity.streamMode(1);\n</code></pre>\n\n<h1>Set the entity to manual (advanced mode) streaming</h1>\n\n<pre><code>entity.streamMode(2);\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'><p>\"this\" when arguments are passed to allow method\nchaining or the current value if no arguments are specified.</p>\n</div></li></ul></div></div></div><div id='method-streamProperty' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-streamProperty' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-streamProperty' class='name expandable'>streamProperty</a>( <span class='pre'>propName, [propVal]</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets a streaming property on this entity. ...</div><div class='long'><p>Gets / sets a streaming property on this entity. If set, the\nproperty's new value is streamed to clients on the next packet.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>propName</span> : String<div class='sub-desc'><p>The name of the property to get / set.</p>\n</div></li><li><span class='pre'>propVal</span> : * (optional)<div class='sub-desc'><p>Optional. If provided, the property is set\nto this value.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'><p>\"this\" when a propVal argument is passed to allow method\nchaining or the current value if no propVal argument is specified.</p>\n</div></li></ul></div></div></div><div id='method-streamSectionData' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-streamSectionData' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-streamSectionData' class='name expandable'>streamSectionData</a>( <span class='pre'>sectionId, [data], [bypassTimeStream]</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the data for the specified data section id. ...</div><div class='long'><p>Gets / sets the data for the specified data section id. This method\nis usually not called directly and instead is part of the network\nstream system. General use case is to write your own custom streamSectionData\nmethod in a class that extends IgeEntity so that you can control the\ndata that the entity will send and receive over the network stream.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>sectionId</span> : String<div class='sub-desc'><p>A string identifying the section to\nhandle data get / set for.</p>\n</div></li><li><span class='pre'>data</span> : * (optional)<div class='sub-desc'><p>If present, this is the data that has been sent\nfrom the server to the client for this entity.</p>\n</div></li><li><span class='pre'>bypassTimeStream</span> : Boolean (optional)<div class='sub-desc'><p>If true, will assign transform\ndirectly to entity instead of adding the values to the time stream.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'><p>\"this\" when a data argument is passed to allow method\nchaining or the current value if no data argument is specified.</p>\n</div></li></ul><h3 class='pa'>Fires</h3><ul><li><a href=\"#!/api/Core.IgeEntity-event-streamPropChange\" rel=\"Core.IgeEntity-event-streamPropChange\" class=\"docClass\">streamPropChange</a></li></ul></div></div></div><div id='method-streamSections' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-streamSections' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-streamSections' class='name expandable'>streamSections</a>( <span class='pre'>[sectionArray]</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the array of sections that this entity will\nencode into its stream data. ...</div><div class='long'><p>Gets / sets the array of sections that this entity will\nencode into its stream data.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>sectionArray</span> : Array (optional)<div class='sub-desc'><p>An array of strings.</p>\n\n<h1>Define the sections this entity will use in the network stream. Use the default \"transform\" section as well as a \"custom1\" section</h1>\n\n<pre><code>entity.streamSections('transform', 'custom1');\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'><p>\"this\" when arguments are passed to allow method\nchaining or the current value if no arguments are specified.</p>\n</div></li></ul></div></div></div><div id='method-streamSectionsPull' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-streamSectionsPull' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-streamSectionsPull' class='name expandable'>streamSectionsPull</a>( <span class='pre'>sectionName</span> ) : <a href=\"#!/api/Core.IgeEntity\" rel=\"Core.IgeEntity\" class=\"docClass\">Core.IgeEntity</a><span class=\"signature\"><span class='chainable' >chainable</span></span></div><div class='description'><div class='short'>Removes a section into the existing streamed sections array. ...</div><div class='long'><p>Removes a section into the existing streamed sections array.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>sectionName</span> : String<div class='sub-desc'><p>The section name to remove.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeEntity\" rel=\"Core.IgeEntity\" class=\"docClass\">Core.IgeEntity</a></span><div class='sub-desc'><p>this</p>\n</div></li></ul></div></div></div><div id='method-streamSectionsPush' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-streamSectionsPush' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-streamSectionsPush' class='name expandable'>streamSectionsPush</a>( <span class='pre'>sectionName</span> ) : <a href=\"#!/api/Core.IgeEntity\" rel=\"Core.IgeEntity\" class=\"docClass\">Core.IgeEntity</a><span class=\"signature\"><span class='chainable' >chainable</span></span></div><div class='description'><div class='short'>Adds a section into the existing streamed sections array. ...</div><div class='long'><p>Adds a section into the existing streamed sections array.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>sectionName</span> : String<div class='sub-desc'><p>The section name to add.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeEntity\" rel=\"Core.IgeEntity\" class=\"docClass\">Core.IgeEntity</a></span><div class='sub-desc'><p>this</p>\n</div></li></ul></div></div></div><div id='method-streamSync' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-streamSync' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-streamSync' class='name expandable'>streamSync</a>( <span class='pre'>clientId</span> ) : <a href=\"#!/api/Core.IgeEntity\" rel=\"Core.IgeEntity\" class=\"docClass\">IgeEntity</a><span class=\"signature\"><span class='chainable' >chainable</span></span></div><div class='description'><div class='short'>Queues stream data for this entity to be sent to the\nspecified client id or array of client ids. ...</div><div class='long'><p>Queues stream data for this entity to be sent to the\nspecified client id or array of client ids.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>clientId</span> : Array<div class='sub-desc'><p>An array of string IDs of each\nclient to send the stream data to.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeEntity\" rel=\"Core.IgeEntity\" class=\"docClass\">IgeEntity</a></span><div class='sub-desc'><p>\"this\".</p>\n</div></li></ul><h3 class='pa'>Fires</h3><ul><li><a href=\"#!/api/Core.IgeEntity-event-streamPropChange\" rel=\"Core.IgeEntity-event-streamPropChange\" class=\"docClass\">streamPropChange</a></li></ul></div></div></div><div id='method-streamSyncInterval' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-streamSyncInterval' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-streamSyncInterval' class='name expandable'>streamSyncInterval</a>( <span class='pre'>[val], [sectionId]</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the stream sync interval. ...</div><div class='long'><p>Gets / sets the stream sync interval. This value\nis in milliseconds and cannot be lower than 16. It will\ndetermine how often data from this entity is added to the\nstream queue.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Number (optional)<div class='sub-desc'><p>Number of milliseconds between adding\nstream data for this entity to the stream queue.</p>\n</div></li><li><span class='pre'>sectionId</span> : String (optional)<div class='sub-desc'><p>Optional id of the stream data\nsection you want to set the interval for. If omitted the\ninterval will be applied to all sections.</p>\n\n<h1>Set the entity's stream update (sync) interval to 1 second because this entity's data is not highly important to the simulation so save some bandwidth!</h1>\n\n<pre><code>entity.streamSyncInterval(1000);\n</code></pre>\n\n<h1>Set the entity's stream update (sync) interval to 16 milliseconds because this entity's data is very important to the simulation so send as often as possible!</h1>\n\n<pre><code>entity.streamSyncInterval(16);\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'><p>\"this\" when arguments are passed to allow method\nchaining or the current value if no arguments are specified.</p>\n</div></li></ul></div></div></div><div id='method-stringify' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-stringify' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-stringify' class='name expandable'>stringify</a>( <span class='pre'>[options]</span> ) : String<span class=\"signature\"></span></div><div class='description'><div class='short'>Returns a string containing a code fragment that when\nevaluated will reproduce this object. ...</div><div class='long'><p>Returns a string containing a code fragment that when\nevaluated will reproduce this object.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>options</span> : Object (optional)<div class='sub-desc'>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>String</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-texture' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-texture' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-texture' class='name expandable'>texture</a>( <span class='pre'>[texture]</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the texture to use when rendering the entity. ...</div><div class='long'><p>Gets / sets the texture to use when rendering the entity.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>texture</span> : <a href=\"#!/api/Core.IgeTexture\" rel=\"Core.IgeTexture\" class=\"docClass\">IgeTexture</a> (optional)<div class='sub-desc'><p>The texture object.</p>\n\n<h1>Set the entity texture (image)</h1>\n\n<pre><code>var texture = new IgeTexture('path/to/some/texture.png');\nentity.texture(texture);\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'><p>\"this\" when arguments are passed to allow method\nchaining or the current value if no arguments are specified.</p>\n</div></li></ul></div></div></div><div id='method-tick' class='member  not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='Core.IgeViewport'>Core.IgeViewport</span><br/><a href='source/IgeViewport.html#Core-IgeViewport-method-tick' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeViewport-method-tick' class='name expandable'>tick</a>( <span class='pre'>ctx, scene</span> )<span class=\"signature\"></span></div><div class='description'><div class='short'>Processes the actions required each render frame. ...</div><div class='long'><p>Processes the actions required each render frame.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>ctx</span> : Object<div class='sub-desc'></div></li><li><span class='pre'>scene</span> : Object<div class='sub-desc'></div></li></ul><p>Overrides: <a href=\"#!/api/Core.IgeEntity-method-tick\" rel=\"Core.IgeEntity-method-tick\" class=\"docClass\">Core.IgeEntity.tick</a></p></div></div></div><div id='method-translate' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-translate' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-translate' class='name expandable'>translate</a>( <span class='pre'></span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets the translate accessor object. ...</div><div class='long'><p>Gets the translate accessor object.</p>\n\n<h1>Use the translate accessor object to alter the y co-ordinate of the entity to 10</h1>\n\n<pre><code>entity.translate().y(10);\n</code></pre>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-translateBy' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-translateBy' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-translateBy' class='name expandable'>translateBy</a>( <span class='pre'>x, y, z</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Translates the entity by adding the passed values to\nthe current translation values. ...</div><div class='long'><p>Translates the entity by adding the passed values to\nthe current translation values.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>x</span> : Number<div class='sub-desc'><p>The x co-ordinate.</p>\n</div></li><li><span class='pre'>y</span> : Number<div class='sub-desc'><p>The y co-ordinate.</p>\n</div></li><li><span class='pre'>z</span> : Number<div class='sub-desc'><p>The z co-ordinate.</p>\n\n<h1>Translate the entity by 10 along the x axis</h1>\n\n<pre><code>entity.translateBy(10, 0, 0);\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-translateTo' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-translateTo' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-translateTo' class='name expandable'>translateTo</a>( <span class='pre'>x, y, z</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Translates the entity to the passed values. ...</div><div class='long'><p>Translates the entity to the passed values.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>x</span> : Number<div class='sub-desc'><p>The x co-ordinate.</p>\n</div></li><li><span class='pre'>y</span> : Number<div class='sub-desc'><p>The y co-ordinate.</p>\n</div></li><li><span class='pre'>z</span> : Number<div class='sub-desc'><p>The z co-ordinate.</p>\n\n<h1>Translate the entity to 10, 0, 0</h1>\n\n<pre><code>entity.translateTo(10, 0, 0);\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-translateToPoint' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-translateToPoint' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-translateToPoint' class='name expandable'>translateToPoint</a>( <span class='pre'>point</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Translates the entity to the passed point. ...</div><div class='long'><p>Translates the entity to the passed point.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>point</span> : <a href=\"#!/api/Core.IgePoint3d\" rel=\"Core.IgePoint3d\" class=\"docClass\">IgePoint3d</a><div class='sub-desc'><p>The point with co-ordinates.</p>\n\n<h1>Translate the entity to 10, 0, 0</h1>\n\n<pre><code>var point = new IgePoint3d(10, 0, 0),\n    entity = new IgeEntity();\n\nentity.translateToPoint(point);\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-translateToTile' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-translateToTile' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-translateToTile' class='name expandable'>translateToTile</a>( <span class='pre'>x, y, [z]</span> ) : *<span class=\"signature\"><span class='chainable' >chainable</span></span></div><div class='description'><div class='short'>Translates the object to the tile co-ordinates passed. ...</div><div class='long'><p>Translates the object to the tile co-ordinates passed.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>x</span> : Number<div class='sub-desc'><p>The x tile co-ordinate.</p>\n</div></li><li><span class='pre'>y</span> : Number<div class='sub-desc'><p>The y tile co-ordinate.</p>\n</div></li><li><span class='pre'>z</span> : Number (optional)<div class='sub-desc'><p>The z tile co-ordinate.</p>\n\n<h1>Translate entity to tile</h1>\n\n<pre><code>// Create a tile map\nvar tileMap = new IgeTileMap2d()\n    .tileWidth(40)\n    .tileHeight(40);\n\n// Mount our entity to the tile map\nentity.mount(tileMap);\n\n// Translate the entity to the tile x:10, y:12\nentity.translateToTile(10, 12, 0);\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'><p>The object this method was called from to allow\nmethod chaining.</p>\n</div></li></ul></div></div></div><div id='method-unMount' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-unMount' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-unMount' class='name expandable'>unMount</a>( <span class='pre'></span> ) : <a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a>/Boolean<span class=\"signature\"></span></div><div class='description'><div class='short'>Unmounts this object from it's parent object in the scenegraph. ...</div><div class='long'><p>Unmounts this object from it's parent object in the scenegraph.</p>\n\n<h1>Unmount an entity from another entity</h1>\n\n<pre><code>// Create a couple of entities and give them ids\nvar entity1 = new IgeEntity().id('entity1'),\n    entity2 = new IgeEntity().id('entity2');\n\n// Mount entity2 to entity1\nentity2.mount(entity1);\n\n// Now unmount entity2 from entity1\nentity2.unMount();\n</code></pre>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a>/Boolean</span><div class='sub-desc'><p>Returns this on success or false on failure.</p>\n</div></li></ul></div></div></div><div id='method-unOccupyTile' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-unOccupyTile' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-unOccupyTile' class='name expandable'>unOccupyTile</a>( <span class='pre'>[x], [y], [width], [height]</span> ) : <a href=\"#!/api/Core.IgeEntity\" rel=\"Core.IgeEntity\" class=\"docClass\">Core.IgeEntity</a><span class=\"signature\"><span class='chainable' >chainable</span><span class='private' >private</span></span></div><div class='description'><div class='short'>Removes the object from the tile map at the passed tile co-ordinates. ...</div><div class='long'><p>Removes the object from the tile map at the passed tile co-ordinates.\nIf no tile co-ordinates are passed, will use the current tile position\nand the tileWidth() and tileHeight() values.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>x</span> : Number (optional)<div class='sub-desc'><p>X co-ordinate of the tile to un-occupy.</p>\n</div></li><li><span class='pre'>y</span> : Number (optional)<div class='sub-desc'><p>Y co-ordinate of the tile to un-occupy.</p>\n</div></li><li><span class='pre'>width</span> : Number (optional)<div class='sub-desc'><p>Number of tiles along the x-axis to un-occupy.</p>\n</div></li><li><span class='pre'>height</span> : Number (optional)<div class='sub-desc'><p>Number of tiles along the y-axis to un-occupy.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeEntity\" rel=\"Core.IgeEntity\" class=\"docClass\">Core.IgeEntity</a></span><div class='sub-desc'><p>this</p>\n</div></li></ul></div></div></div><div id='method-update' class='member  not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='Core.IgeViewport'>Core.IgeViewport</span><br/><a href='source/IgeViewport.html#Core-IgeViewport-method-update' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeViewport-method-update' class='name expandable'>update</a>( <span class='pre'>ctx</span> )<span class=\"signature\"></span></div><div class='description'><div class='short'>Processes the updates before the render tick is called. ...</div><div class='long'><p>Processes the updates before the render tick is called.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>ctx</span> : Object<div class='sub-desc'>\n</div></li></ul><p>Overrides: <a href=\"#!/api/Core.IgeEntity-method-update\" rel=\"Core.IgeEntity-method-update\" class=\"docClass\">Core.IgeEntity.update</a></p></div></div></div><div id='method-updateTransform' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-updateTransform' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-updateTransform' class='name expandable'>updateTransform</a>( <span class='pre'></span> ) : <a href=\"#!/api/Core.IgeEntity\" rel=\"Core.IgeEntity\" class=\"docClass\">Core.IgeEntity</a><span class=\"signature\"><span class='chainable' >chainable</span></span></div><div class='description'><div class='short'>Checks the current transform values against the previous ones. ...</div><div class='long'><p>Checks the current transform values against the previous ones. If\nany value is different, the appropriate method is called which will\nupdate the transformation matrix accordingly.</p>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeEntity\" rel=\"Core.IgeEntity\" class=\"docClass\">Core.IgeEntity</a></span><div class='sub-desc'><p>this</p>\n</div></li></ul></div></div></div><div id='method-vanilla' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeClass' rel='Core.IgeClass' class='defined-in docClass'>Core.IgeClass</a><br/><a href='source/IgeClass.html#Core-IgeClass-method-vanilla' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeClass-method-vanilla' class='name expandable'>vanilla</a>( <span class='pre'>prop</span> ) : Function<span class=\"signature\"></span></div><div class='description'><div class='short'>Test method ...</div><div class='long'><p>Test method</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>prop</span> : Object<div class='sub-desc'>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>Function</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-viewArea' class='member  not-inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><span class='defined-in' rel='Core.IgeViewport'>Core.IgeViewport</span><br/><a href='source/IgeViewport.html#Core-IgeViewport-method-viewArea' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeViewport-method-viewArea' class='name expandable'>viewArea</a>( <span class='pre'></span> ) : <a href=\"#!/api/Core.IgeRect\" rel=\"Core.IgeRect\" class=\"docClass\">IgeRect</a><span class=\"signature\"></span></div><div class='description'><div class='short'>Gets the current rectangular area that the viewport is \"looking at\"\nin the world. ...</div><div class='long'><p>Gets the current rectangular area that the viewport is \"looking at\"\nin the world. The co-ordinates are in world space.</p>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeRect\" rel=\"Core.IgeRect\" class=\"docClass\">IgeRect</a></span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-viewCheckChildren' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-viewCheckChildren' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-viewCheckChildren' class='name expandable'>viewCheckChildren</a>( <span class='pre'></span> ) : <a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a><span class=\"signature\"><span class='chainable' >chainable</span><span class='experimental' >experimental</span></span></div><div class='description'><div class='short'>ALPHA CODE DO NOT USE YET. ...</div><div class='long'><p>ALPHA CODE DO NOT USE YET.\nWhen view checking is enabled, this method is called to\ndetermine if this object is within the bounds of an active\nviewport, essentially determining if the object is\n\"on screen\" or not.</p>\n        <div class='rounded-box experimental-box deprecated-tag-box'>\n        <p>This method is <strong>experimental</strong> </p>\n        \n\n        </div>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a></span><div class='sub-desc'><p>this</p>\n</div></li></ul></div></div></div><div id='method-viewChecking' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-method-viewChecking' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-method-viewChecking' class='name expandable'>viewChecking</a>( <span class='pre'>[val]</span> ) : <a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a>/Boolean<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the view checking flag that if set to true\nwill ask the engine to check during each tick if this\nobject i...</div><div class='long'><p>Gets / sets the view checking flag that if set to true\nwill ask the engine to check during each tick if this\nobject is actually \"on screen\" or not, and bypass it\nif it is not. The default is this flag set to false.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Boolean (optional)<div class='sub-desc'><p>The boolean flag value.</p>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgeObject\" rel=\"Core.IgeObject\" class=\"docClass\">IgeObject</a>/Boolean</span><div class='sub-desc'>\n</div></li></ul></div></div></div><div id='method-width' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-width' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-width' class='name expandable'>width</a>( <span class='pre'>[px]</span> ) : *<span class=\"signature\"></span></div><div class='description'><div class='short'>Gets / sets the geometry x value. ...</div><div class='long'><p>Gets / sets the geometry x value.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>px</span> : Number (optional)<div class='sub-desc'><p>The new x value in pixels.</p>\n\n<h1>Set the width of the entity</h1>\n\n<pre><code>entity.width(40);\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'><p>\"this\" when arguments are passed to allow method\nchaining or the current value if no arguments are specified.</p>\n</div></li></ul></div></div></div><div id='method-widthByTile' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-widthByTile' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-widthByTile' class='name expandable'>widthByTile</a>( <span class='pre'>val, [lockAspect]</span> ) : *<span class=\"signature\"><span class='chainable' >chainable</span></span></div><div class='description'><div class='short'>Set the object's width to the number of tile width's specified. ...</div><div class='long'><p>Set the object's width to the number of tile width's specified.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>val</span> : Number<div class='sub-desc'><p>Number of tiles.</p>\n</div></li><li><span class='pre'>lockAspect</span> : Boolean (optional)<div class='sub-desc'><p>If true, sets the height according\nto the texture aspect ratio and the new width.</p>\n\n<h1>Set the width of the entity based on the tile width of the map the entity is mounted to</h1>\n\n<pre><code>// Set the entity width to the size of 1 tile with\n// lock aspect enabled which will automatically size\n// the height as well so as to maintain the aspect\n// ratio of the entity\nentity.widthByTile(1, true);\n</code></pre>\n</div></li></ul><h3 class='pa'>Returns</h3><ul><li><span class='pre'>*</span><div class='sub-desc'><p>The object this method was called from to allow\nmethod chaining.</p>\n</div></li></ul></div></div></div><div id='method-worldPosition' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-worldPosition' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-worldPosition' class='name expandable'>worldPosition</a>( <span class='pre'></span> ) : <a href=\"#!/api/Core.IgePoint3d\" rel=\"Core.IgePoint3d\" class=\"docClass\">IgePoint3d</a><span class=\"signature\"></span></div><div class='description'><div class='short'>Returns the absolute world position of the entity as an\nIgePoint3d. ...</div><div class='long'><p>Returns the absolute world position of the entity as an\nIgePoint3d.</p>\n\n<h1>Get the world position of the entity</h1>\n\n<pre><code>var wordPos = entity.worldPosition();\n</code></pre>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'><a href=\"#!/api/Core.IgePoint3d\" rel=\"Core.IgePoint3d\" class=\"docClass\">IgePoint3d</a></span><div class='sub-desc'><p>The absolute world position of the\nentity.</p>\n</div></li></ul></div></div></div><div id='method-worldRotationZ' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-method-worldRotationZ' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-method-worldRotationZ' class='name expandable'>worldRotationZ</a>( <span class='pre'></span> ) : Number<span class=\"signature\"></span></div><div class='description'><div class='short'>Returns the absolute world rotation z of the entity as a\nvalue in radians. ...</div><div class='long'><p>Returns the absolute world rotation z of the entity as a\nvalue in radians.</p>\n\n<h1>Get the world rotation of the entity's z axis</h1>\n\n<pre><code>var wordRot = entity.worldRotationZ();\n</code></pre>\n<h3 class='pa'>Returns</h3><ul><li><span class='pre'>Number</span><div class='sub-desc'><p>The absolute world rotation z of the\nentity.</p>\n</div></li></ul></div></div></div></div></div><div class='members-section'><div class='definedBy'>Defined By</div><h3 class='members-title icon-event'>Events</h3><div class='subsection'><div id='event-compositeReady' class='member first-child inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-event-compositeReady' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-event-compositeReady' class='name expandable'>compositeReady</a>( <span class='pre'></span> )<span class=\"signature\"></span></div><div class='description'><div class='short'>Fires when the entity's composite cache is ready. ...</div><div class='long'><p>Fires when the entity's composite cache is ready.</p>\n</div></div></div><div id='event-destroyed' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-event-destroyed' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-event-destroyed' class='name expandable'>destroyed</a>( <span class='pre'>entity</span> )<span class=\"signature\"></span></div><div class='description'><div class='short'>Fires when the entity has been destroyed. ...</div><div class='long'><p>Fires when the entity has been destroyed.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>entity</span> : <a href=\"#!/api/Core.IgeEntity\" rel=\"Core.IgeEntity\" class=\"docClass\">IgeEntity</a><div class='sub-desc'><p>The entity that has been destroyed.</p>\n</div></li></ul></div></div></div><div id='event-interpolationLag' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-event-interpolationLag' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-event-interpolationLag' class='name expandable'>interpolationLag</a>( <span class='pre'></span> )<span class=\"signature\"></span></div><div class='description'><div class='short'>Fires when the entity interpolates against old data, usually\nthe result of slow processing on the client or too much ...</div><div class='long'><p>Fires when the entity interpolates against old data, usually\nthe result of slow processing on the client or too much data\nbeing sent from the server.</p>\n</div></div></div><div id='event-mounted' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeObject' rel='Core.IgeObject' class='defined-in docClass'>Core.IgeObject</a><br/><a href='source/IgeObject.html#Core-IgeObject-event-mounted' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeObject-event-mounted' class='name expandable'>mounted</a>( <span class='pre'>parent</span> )<span class=\"signature\"></span></div><div class='description'><div class='short'> ...</div><div class='long'>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>parent</span> : Object<div class='sub-desc'>\n</div></li></ul></div></div></div><div id='event-mouseDown' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-event-mouseDown' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-event-mouseDown' class='name expandable'>mouseDown</a>( <span class='pre'>eventData</span> )<span class=\"signature\"></span></div><div class='description'><div class='short'>Fires when a mouse down occurs on the entity. ...</div><div class='long'><p>Fires when a mouse down occurs on the entity.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>eventData</span> : Array<div class='sub-desc'>\n<ul><li><span class='pre'>event</span> : Object<div class='sub-desc'><p>The DOM event object.</p>\n</div></li><li><span class='pre'>evc</span> : Object<div class='sub-desc'><p>The IGE event control object.</p>\n</div></li><li><span class='pre'>data</span> : *<div class='sub-desc'><p>Any further event data.</p>\n</div></li></ul></div></li></ul></div></div></div><div id='event-mouseMove' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-event-mouseMove' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-event-mouseMove' class='name expandable'>mouseMove</a>( <span class='pre'>eventData</span> )<span class=\"signature\"></span></div><div class='description'><div class='short'> ...</div><div class='long'>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>eventData</span> : Array<div class='sub-desc'>\n<ul><li><span class='pre'>event</span> : Object<div class='sub-desc'><p>The DOM event object.</p>\n</div></li><li><span class='pre'>evc</span> : Object<div class='sub-desc'><p>The IGE event control object.</p>\n</div></li><li><span class='pre'>data</span> : *<div class='sub-desc'><p>Any further event data.</p>\n</div></li></ul></div></li></ul></div></div></div><div id='event-mouseOut' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-event-mouseOut' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-event-mouseOut' class='name expandable'>mouseOut</a>( <span class='pre'>eventData</span> )<span class=\"signature\"></span></div><div class='description'><div class='short'>Fires when the mouse moves away from the entity. ...</div><div class='long'><p>Fires when the mouse moves away from the entity.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>eventData</span> : Array<div class='sub-desc'>\n<ul><li><span class='pre'>event</span> : Object<div class='sub-desc'><p>The DOM event object.</p>\n</div></li><li><span class='pre'>evc</span> : Object<div class='sub-desc'><p>The IGE event control object.</p>\n</div></li><li><span class='pre'>data</span> : *<div class='sub-desc'><p>Any further event data.</p>\n</div></li></ul></div></li></ul></div></div></div><div id='event-mouseOver' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-event-mouseOver' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-event-mouseOver' class='name expandable'>mouseOver</a>( <span class='pre'>eventData</span> )<span class=\"signature\"></span></div><div class='description'><div class='short'>Fires when the mouse moves over the entity. ...</div><div class='long'><p>Fires when the mouse moves over the entity.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>eventData</span> : Array<div class='sub-desc'>\n<ul><li><span class='pre'>event</span> : Object<div class='sub-desc'><p>The DOM event object.</p>\n</div></li><li><span class='pre'>evc</span> : Object<div class='sub-desc'><p>The IGE event control object.</p>\n</div></li><li><span class='pre'>data</span> : *<div class='sub-desc'><p>Any further event data.</p>\n</div></li></ul></div></li></ul></div></div></div><div id='event-mouseUp' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-event-mouseUp' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-event-mouseUp' class='name expandable'>mouseUp</a>( <span class='pre'>eventData</span> )<span class=\"signature\"></span></div><div class='description'><div class='short'>Fires when a mouse up occurs on the entity. ...</div><div class='long'><p>Fires when a mouse up occurs on the entity.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>eventData</span> : Array<div class='sub-desc'>\n<ul><li><span class='pre'>event</span> : Object<div class='sub-desc'><p>The DOM event object.</p>\n</div></li><li><span class='pre'>evc</span> : Object<div class='sub-desc'><p>The IGE event control object.</p>\n</div></li><li><span class='pre'>data</span> : *<div class='sub-desc'><p>Any further event data.</p>\n</div></li></ul></div></li></ul></div></div></div><div id='event-mouseWheel' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-event-mouseWheel' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-event-mouseWheel' class='name expandable'>mouseWheel</a>( <span class='pre'>eventData</span> )<span class=\"signature\"></span></div><div class='description'><div class='short'>Fires when the mouse wheel is moved over the entity. ...</div><div class='long'><p>Fires when the mouse wheel is moved over the entity.</p>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>eventData</span> : Array<div class='sub-desc'>\n<ul><li><span class='pre'>event</span> : Object<div class='sub-desc'><p>The DOM event object.</p>\n</div></li><li><span class='pre'>evc</span> : Object<div class='sub-desc'><p>The IGE event control object.</p>\n</div></li><li><span class='pre'>data</span> : *<div class='sub-desc'><p>Any further event data.</p>\n</div></li></ul></div></li></ul></div></div></div><div id='event-streamPropChange' class='member  inherited'><a href='#' class='side expandable'><span>&nbsp;</span></a><div class='title'><div class='meta'><a href='#!/api/Core.IgeEntity' rel='Core.IgeEntity' class='defined-in docClass'>Core.IgeEntity</a><br/><a href='source/IgeEntity.html#Core-IgeEntity-event-streamPropChange' target='_blank' class='view-source'>view source</a></div><a href='#!/api/Core.IgeEntity-event-streamPropChange' class='name expandable'>streamPropChange</a>( <span class='pre'>eventData</span> )<span class=\"signature\"></span></div><div class='description'><div class='short'> ...</div><div class='long'>\n<h3 class=\"pa\">Parameters</h3><ul><li><span class='pre'>eventData</span> : Array<div class='sub-desc'>\n<ul><li><span class='pre'>index</span> : Number<div class='sub-desc'>\n</div></li><li><span class='pre'>prop</span> : Object<div class='sub-desc'>\n</div></li></ul></div></li></ul></div></div></div></div></div></div></div>","meta":{}});