","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1<%2 | string | Object>"}},{"identifier":"obj","optional":false,"description":"to be removed
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}}],"returns":[{"description":"the modified Array\nlet arr = [ "foo", "bar", "baz" ];\n// remove "foo" from the arr...","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1<%2 | string | Object>"}}],"extends":[],"implements":[]},{"id":"pQzoHA2J_eFhtdQLvXE7I","name":"weightedRandom","brief":"","access":"public","type":"FunctionDoc","description":"return a weighted random array element, favoring the earlier entries
","params":[{"identifier":"arr","optional":false,"description":"array to pick a element
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1<%2 | string | Object>"}}],"returns":[{"description":"random member of array
","dataType":{"tokens":[{"value":"any","kind":"canonical"}],"template":"any"}}],"extends":[],"implements":[]}]},{"id":"kuRtjkO7ZAUtYZdXHCfml","name":"file","brief":"","defaultValue":"undefined","readonly":true,"scope":"static","type":"NSDoc","description":"a collection of file utility functions
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"LatVyhs7T_U6ylt-a8bZS","name":"getBasename","brief":"","access":"public","type":"FunctionDoc","description":"return the base name of the file without path info
","params":[{"identifier":"path","optional":false,"description":"path containing the basename to extract
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"returns":[{"description":"the base name without path information.
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"extends":[],"implements":[]},{"id":"aIwYvL7X9iqyQIgZU7Ki-","name":"getExtension","brief":"","access":"public","type":"FunctionDoc","description":"return the extension of the file in the given path
","params":[{"identifier":"path","optional":false,"description":"path containing the filename and extension to extract
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"returns":[{"description":"filename extension.
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"extends":[],"implements":[]},{"id":"JTqN3VAWrcY9dEL59aVnt","name":"getPath","brief":"","access":"public","type":"FunctionDoc","description":"return the path of the file
","params":[{"identifier":"path","optional":false,"description":"the copmplete file path to extract the path from
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"returns":[{"description":"the extracted path
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"extends":[],"implements":[]}]},{"id":"-cJwCF-ynGa1n3D69RIhV","name":"function","brief":"","scope":"static","type":"NSDoc","description":"a collection of utility functions
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"2_m3HYqCLxJ96JrV-YKfO","name":"defer","brief":"","access":"public","examples":[{"caption":"","code":"// execute myFunc() when the stack is empty,\n// with the current context and [1, 2, 3] as parameter\nme.utils.function.defer(myFunc, this, 1, 2, 3);"}],"type":"FunctionDoc","description":"Executes a function as soon as the interpreter is idle (stack empty).
","params":[{"identifier":"func","optional":false,"description":"The function to be deferred.
","dataType":{"tokens":[{"value":"Function","kind":"canonical"}],"template":"Function"}},{"identifier":"thisArg","optional":false,"description":"The value to be passed as the this parameter to the target function when the deferred function is called
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}},{"identifier":"args","optional":false,"variadic":true,"description":"Optional additional arguments to carry for the function.
","dataType":{"tokens":[{"value":"unknown","kind":"canonical"}],"template":"unknown"}}],"returns":[{"description":"id that can be used to clear the deferred function using\nclearTimeout
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"g5RHB0RxB-udnPBB_DQfL","name":"throttle","brief":"","access":"public","type":"FunctionDoc","description":"returns a function that, when invoked will only be triggered at most once during a given window of time
","params":[{"identifier":"fn","optional":false,"description":"the function to be throttled.
","dataType":{"tokens":[{"value":"Function","kind":"canonical"}],"template":"Function"}},{"identifier":"delay","optional":false,"description":"The delay in ms
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"no_trailing","optional":false,"description":"disable the execution on the trailing edge
","dataType":{"tokens":[{"value":"no_trailing","kind":"canonical"},{"value":"no_trailing","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"the function that will be throttled
","dataType":{"tokens":[{"value":"Function","kind":"canonical"}],"template":"Function"}}],"extends":[],"implements":[]}]},{"id":"BHGDv546TzF5xeU5L2T2P","name":"string","brief":"","scope":"static","type":"NSDoc","description":"a collection of string utility functions
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"-vujc6E7kVB_NJz0CSWa1","name":"capitalize","brief":"","access":"public","type":"FunctionDoc","description":"converts the first character of the given string to uppercase
","params":[{"identifier":"str","optional":false,"description":"the string to be capitalized
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"returns":[{"description":"the capitalized string
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"extends":[],"implements":[]},{"id":"aapSQFp_1OHaOfverQ131","name":"isBoolean","brief":"","access":"public","type":"FunctionDoc","description":"returns true if the given string contains a true or false
","params":[{"identifier":"str","optional":false,"description":"the string to be tested
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"returns":[{"description":"true if the string is either true or false
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"JoljVmJHCI2MXZgCDqPaG","name":"isDataUrl","brief":"","access":"public","type":"FunctionDoc","description":"returns true if the given string is a data url in the data:[<mediatype>][;base64],<data> format.\n...","params":[{"identifier":"str","optional":false,"description":"
the string (url) to be tested
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"returns":[{"description":"true if the string is a data url
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"Fz2-0gbPpbjQhFN8_VSr9","name":"isNumeric","brief":"","access":"public","type":"FunctionDoc","description":"returns true if the given string contains a numeric integer or float value
","params":[{"identifier":"str","optional":false,"description":"the string to be tested
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"returns":[{"description":"true if string contains only digits
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"NM6Atx4AsgYhOxg0Jbztn","name":"toHex","brief":"","access":"public","type":"FunctionDoc","description":"convert a string to the corresponding hexadecimal value
","params":[{"identifier":"str","optional":false,"description":"the string to be converted
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"returns":[{"description":"the converted hexadecimal value
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"extends":[],"implements":[]}]},{"id":"QQ_Sr1jyrlBZvmBNaXnU3","name":"checkVersion","brief":"","access":"public","examples":[{"caption":"","code":"if (me.utils.checkVersion(\"7.0.0\") > 0) {\n console.error(\n \"melonJS is too old. Expected: 7.0.0, Got: 6.3.0\"\n );\n}"}],"type":"FunctionDoc","description":"Compare two version strings
","params":[{"identifier":"v1","optional":false,"description":"First version string to compare
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"v2","optional":false,"description":"second version string to compare
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"returns":[{"description":"Return 0 if v1 == v2, or 1 if v1 is greater, or -1 if v2 is greater
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"8Ji_lE5d2eE1Row7_XUkc","name":"getUriFragment","brief":"","access":"public","examples":[{"caption":"","code":"// http://www.example.com/index.html#debug&hitbox=true&mytag=value\nlet UriFragment = me.utils.getUriFragment();\nconsole.log(UriFragment[\"mytag\"]); //> \"value\""}],"type":"FunctionDoc","description":"parse the fragment (hash) from a URL and returns them into
","params":[{"identifier":"url","optional":true,"default":"document.location","description":"an optional params string or URL containing fragment (hash) params to be parsed
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"returns":[{"description":"an object representing the deserialized params string.
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}}],"extends":[],"implements":[],"members":[{"id":"AiPdIFrisxNyDBcVoee_g","name":"debug","brief":"","access":"public","defaultValue":"false","scope":"static","type":"PropertyDoc","description":"display the debug panel (if preloaded)
"},{"id":"URjantQi7HZucEh3oLMaV","name":"debugToggleKey","brief":"","access":"public","defaultValue":"\"s\"","scope":"static","type":"PropertyDoc","description":"show/hide the debug panel (if preloaded)
"},{"id":"u-GMNLHW8J-etWPDFTofu","name":"hitbox","brief":"","access":"public","defaultValue":"false","scope":"static","type":"PropertyDoc","description":"draw the hitbox in the debug panel (if enabled)
"},{"id":"7R22BZJoJvSxHrwx7fiFo","name":"quadtree","brief":"","access":"public","defaultValue":"false","scope":"static","type":"PropertyDoc","description":"draw the quadtree in the debug panel (if enabled)
"},{"id":"0u9GOF48yQiMgEZk98M5b","name":"velocity","brief":"","access":"public","defaultValue":"false","scope":"static","type":"PropertyDoc","description":"draw the entities velocity in the debug panel (if enabled)
"},{"id":"KjUpmomQTidWCYYQod51p","name":"webgl","brief":"","access":"public","defaultValue":"false","scope":"static","type":"PropertyDoc","description":"force the renderer to WebGL
"}]}]},{"id":"NIxJ2hBIHfEDKuG3koPzY","name":"video","brief":"","type":"NSDoc","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"AXRD7VlTPzwLYPPJYYG-G","name":"renderer","brief":"","defaultValue":"undefined","type":"PropertyDoc","description":"A reference to the active Canvas or WebGL active renderer renderer
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"vOuFHe9gUYwx3cn9E8Q3v","name":"createCanvas","brief":"","type":"FunctionDoc","description":"Create and return a new Canvas element
","params":[{"identifier":"width","optional":false,"description":"width
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"height","optional":false,"description":"height
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"returnOffscreenCanvas","optional":true,"default":"false","description":"will return an OffscreenCanvas if supported
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"a new Canvas element of the given size
","dataType":{"tokens":[{"value":"HTMLCanvasElement | OffscreenCanvas","kind":"canonical"},{"value":"HTMLCanvasElement","kind":"canonical"},{"value":"OffscreenCanvas","kind":"canonical"}],"template":"%1 | %2"}}],"extends":[],"implements":[]},{"id":"bPbwqYILumDssqqLKhpk5","name":"getParent","brief":"","type":"FunctionDoc","description":"return a reference to the parent DOM element holding the main canvas
","params":[],"returns":[{"description":"the HTML parent element
","dataType":{"tokens":[{"value":"HTMLElement","kind":"canonical"},{"value":"HTMLElement","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"WHpdkrXfi22b1dFOFcQxT","name":"init","brief":"","examples":[{"caption":"","code":"// init the video with a 640x480 canvas\nme.video.init(640, 480, {\n parent : \"screen\",\n renderer : me.video.AUTO,\n scale : \"auto\",\n scaleMethod : \"fit\"\n});"}],"type":"FunctionDoc","description":"Initialize the "video" system (create a canvas based on the given arguments, and the related renderer).
","params":[{"identifier":"width","optional":false,"description":"The width of the canvas viewport
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"height","optional":false,"description":"The height of the canvas viewport
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"options","optional":true,"description":"optional parameters for the renderer
","dataType":{"tokens":[{"value":"Application.Settings","kind":"canonical"},{"value":"Application.Settings","kind":"link"}],"template":"%1"}}],"returns":[{"description":"false if initialization failed (canvas not supported)
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]}]},{"id":"TKrCYE1X86kqug13V0aCM","name":"Application","brief":"","see":["game"],"type":"ClassDoc","description":"An Application represents a single melonJS game, and is responsible for updating (each frame) all the related object statu...","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"GWH-YOP6xE3Ok8TuSrpzQ","name":"Settings","brief":"","see":["Application"],"type":"TypedefDoc","description":"
Application & Renderer Settings definition.
","params":[{"identifier":"options.zoomX","optional":true,"default":"width","description":"The actual width of the canvas with scaling applied
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"options.zoomY","optional":true,"default":"height","description":"The actual height of the canvas with scaling applied
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"options.compositor","optional":true,"description":"a custom compositor class (WebGL only)
","dataType":{"tokens":[{"value":"Compositor","kind":"canonical"},{"value":"Compositor","kind":"link"}],"template":"%1"}},{"identifier":"option.physic","optional":true,"default":"\"builtin\"","description":"the physic system to use (default: "builtin", or "none" to disable builtin physic)
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"returns":[],"extends":[],"implements":[],"members":[{"id":"-wVd1iZXsXqah5jWfQGUu","name":"antiAlias","brief":"","access":"public","defaultValue":"false","scope":"static","type":"PropertyDoc","description":"whether to enable or not video scaling interpolation
"},{"id":"8mGGNyrOfl5csVTdd8TTr","name":"canvas","brief":"","access":"public","scope":"static","type":"PropertyDoc","description":"an existing canvas element to use as the renderer target (by default melonJS will create its own canvas based on given par..."},{"id":"XisSeGgRFp3M2fB6oK5FW","name":"consoleHeader","brief":"","access":"public","defaultValue":"true","scope":"static","type":"PropertyDoc","description":"
whether to display melonJS version and basic device information in the console
"},{"id":"wzPdrJQzB9ZbIcbQp1Co5","name":"depthTest","brief":"","access":"public","defaultValue":"\"sorting\"","scope":"static","type":"PropertyDoc","description":"~Experimental~ the default method to sort object on the z axis in WebGL
"},{"id":"I2MvIXzKZNxTH8gMxsY-U","name":"parent","brief":"","access":"public","defaultValue":"document.body","scope":"static","type":"PropertyDoc","description":"the DOM parent element to hold the canvas in the HTML file
"},{"id":"11uixo4bo5r0ErmkUs3po","name":"powerPreference","brief":"","access":"public","defaultValue":"\"default\"","scope":"static","type":"PropertyDoc","description":"a hint to the user agent indicating what configuration of GPU is suitable for the WebGL context. To be noted that Safari a..."},{"id":"AV8IyG6N585TFS_UqkGad","name":"preferWebGL1","brief":"","access":"public","defaultValue":"false","scope":"static","type":"PropertyDoc","description":"
if true the renderer will only use WebGL 1
"},{"id":"Mg1Fi-ZUqPlsZZj-vlnaR","name":"renderer","brief":"","access":"public","defaultValue":"AUTO","scope":"static","type":"PropertyDoc","description":"renderer to use (CANVAS, WEBGL, AUTO), or a custom renderer class
"},{"id":"2TkkXWO3T4RNAurg878yF","name":"scale","brief":"","access":"public","defaultValue":"1.0","scope":"static","type":"PropertyDoc","description":"enable scaling of the canvas ('auto' for automatic scaling)
"},{"id":"gBydFjGqgsEQQKakiICCx","name":"scaleMethod","brief":"","access":"public","defaultValue":"\"fit\"","scope":"static","type":"PropertyDoc","description":"screen scaling modes :
\n\nfitthe HTML Element to be used as the reference target when using automatic scaling (by default melonJS will use the parent c..."},{"id":"u1bhw7dHEtmS7ut9oZEvz","name":"transparent","brief":"","access":"public","defaultValue":"false","scope":"static","type":"PropertyDoc","description":"
whether to allow transparent pixels in the front buffer (screen).
"}]},{"id":"zLDmOhsk1yT1rVEeLcfy_","name":"isInitialized","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"true when this app instance has been initialized
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"2Sy5ZQN-kMflViDT0lNbi","name":"lastUpdate","brief":"","defaultValue":"0","scope":"instance","type":"PropertyDoc","description":"Last time the game update loop was executed.
when true, all objects will be added under the root world container.me.Container object wi...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"fcjy_FMuLcVTPq8sSaRaB","name":"parentElement","brief":"","scope":"instance","type":"PropertyDoc","description":"
the parent HTML element holding the main canvas of this application
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"1X01OLHYsFfwxxN8IyXvZ","name":"pauseOnBlur","brief":"","defaultValue":"true","examples":[{"caption":"","code":"// keep the default game instance running even when loosing focus\nme.game.pauseOnBlur = false;"}],"scope":"instance","type":"PropertyDoc","description":"Specify whether to pause this app when losing focus
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"_Dc8DTQdgPf2lBcm3HtCm","name":"renderer","brief":"","scope":"instance","type":"PropertyDoc","description":"a reference to the active Canvas or WebGL active renderer renderer
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"wIfOzNQJ8Oh9l8BdclKld","name":"resumeOnFocus","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"Specify whether to unpause this app when gaining back focus
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"M-M1YfNoZyr4Q21wTEKt0","name":"settings","brief":"","scope":"instance","type":"PropertyDoc","description":"the given settings used when creating this application
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"q_J735edkn0Pd-GDF_HbX","name":"sortOn","brief":"","scope":"instance","see":["World.sortOn"],"type":"PropertyDoc","description":"Specify the property to be used when sorting renderables for this application game world.\nAccepted values : "x",...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"_VBdq0yDyT5Xcfi87I2qq","name":"stopOnBlur","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"
Specify whether to stop this app when losing focus
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"9bLbcVbtJr4IG-H9uMM53","name":"viewport","brief":"","scope":"instance","type":"PropertyDoc","description":"the active stage "default" camera
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"uLed6SszLVbxO6mVm5Kzs","name":"world","brief":"","scope":"instance","type":"PropertyDoc","description":"a reference to the game world,
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"q2c2XT4CbJRpQDO5ARPDD","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"width","optional":false,"description":"The width of the canvas viewport
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"height","optional":false,"description":"The height of the canvas viewport
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"options","optional":true,"description":"The optional parameters for the application and default renderer
","dataType":{"tokens":[{"value":"Application.Settings","kind":"canonical"},{"value":"Application.Settings","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"tJnoCHnOr1v5RDZkk6JdK","name":"draw","brief":"draw the active scene/stage associated to this game
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"mdVQWKXYWgPH4cgIou2P5","name":"getParentElement","brief":"","scope":"instance","type":"MethodDoc","description":"Returns the parent HTML Element holding the main canvas of this application
","params":[],"returns":[{"description":"the parent HTML element
","dataType":{"tokens":[{"value":"HTMLElement","kind":"canonical"},{"value":"HTMLElement","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"DooVNUeHjOgn2Udg1js3o","name":"init","brief":"","scope":"instance","type":"MethodDoc","description":"init the game instance (create a physic world, update starting time, etc..)
","params":[{"identifier":"width","optional":false,"description":"The width of the canvas viewport
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"height","optional":false,"description":"The height of the canvas viewport
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"options","optional":true,"description":"The optional parameters for the application and default renderer
","dataType":{"tokens":[{"value":"Application.Settings","kind":"canonical"},{"value":"Application.Settings","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"eNGWNwL58cqYzcBjt1A4M","name":"onLevelLoaded","brief":"","examples":[{"caption":"","code":"// call myFunction () everytime a level is loaded\nme.game.onLevelLoaded = this.myFunction.bind(this);"}],"scope":"instance","type":"MethodDoc","description":"Fired when a level is fully loaded and all renderable instantiated.
force the redraw (not update) of all objects
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"p9FJl93H7F1uMSnzkBxgD","name":"reset","brief":"","scope":"instance","type":"MethodDoc","description":"reset the game Object manager\ndestroy all current objects
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"RepWcBFQJt2ZiceIsIDI1","name":"update","brief":"","scope":"instance","type":"MethodDoc","description":"update all objects related to this game active scene/stage
","params":[{"identifier":"time","optional":false,"description":"current timestamp as provided by the RAF callback
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"75H8pYH51z3rUWq4YEX5l","name":"updateFrameRate","brief":"","scope":"instance","see":["timer.maxfps","World.fps"],"type":"MethodDoc","description":"Update the renderer framerate using the system config variables.
","params":[],"returns":[],"extends":[],"implements":[]}]},{"id":"Xr5c4INZZ8E9JbRj-zh65","name":"BitmapText","brief":"","type":"ClassDoc","description":"a bitmap font object
","params":[],"returns":[],"extends":["Renderable"],"implements":[],"members":[{"id":"uZsAKdLlO_s4FYcJ0HyAl","name":"alpha","brief":"","defaultValue":"1.0","scope":"instance","see":["Renderable#setOpacity","Renderable#getOpacity"],"type":"PropertyDoc","description":"Define the renderable opacity
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"o0JHz8ggHh1AubgFkhGCy","name":"alwaysUpdate","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object will always update, even when outside of the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"irDCzKSqD0ggwac6fk5vV","name":"ancestor","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"a reference to the parent object that contains this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"kFm_oUW86p1knGr7XG4OR","name":"anchorPoint","brief":"","defaultValue":"<0.5,0.5>","scope":"instance","type":"PropertyDoc","description":"The anchor point is used for attachment behavior, and/or when applying transformations.
When enabled, an object container will automatically apply\nany defined transformation before calling the child draw method...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"dnYJ0S7vU7erd5sUDwAuv","name":"blendMode","brief":"","defaultValue":"\"normal\"","scope":"instance","see":["CanvasRenderer#setBlendMode","WebGLRenderer#setBlendMode"],"type":"PropertyDoc","description":"
the blend mode to be applied to this renderable (see renderer setBlendMode for available blend mode)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"1QagfVf7itUXLw8jkvBaE","name":"body","brief":"","examples":[{"caption":"","code":" // define a new Player Class\n class PlayerEntity extends me.Sprite {\n // constructor\n constructor(x, y, settings) {\n // call the parent constructor\n super(x, y , settings);\n\n // define a basic walking animation\n this.addAnimation(\"walk\", [...]);\n // define a standing animation (using the first frame)\n this.addAnimation(\"stand\", [...]);\n // set the standing animation as default\n this.setCurrentAnimation(\"stand\");\n\n // add a physic body\n this.body = new me.Body(this);\n // add a default collision shape\n this.body.addShape(new me.Rect(0, 0, this.width, this.height));\n // configure max speed, friction, and initial force to be applied\n this.body.setMaxVelocity(3, 15);\n this.body.setFriction(0.4, 0);\n this.body.force.set(3, 0);\n this.isKinematic = false;\n\n // set the display to follow our position on both axis\n me.game.viewport.follow(this.pos, me.game.viewport.AXIS.BOTH);\n }\n\n ...\n\n }"}],"scope":"instance","type":"PropertyDoc","description":"the renderable physic body
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"xZuFN_2moYJhG4PNYiy-q","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"hgweCHV-Eq1MicOSbw7_9","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"qSmL7QK4wRIv3lWJQoLn_","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"AyMw3Gq0Waju7uzw0LILw","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"3wk6RTrv5bD8OF7wfEUpk","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ZAaGpy32BdL2aTrYWTavg","name":"fillStyle","brief":"","access":"public","scope":"instance","see":["Renderable#tint"],"type":"PropertyDoc","description":"defines the color used to tint the bitmap text
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"KlRUsiTMYVxCIM3ROoVxE","name":"floating","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"If true, this renderable will be rendered using screen coordinates,\nas opposed to world coordinates. Use this, for example...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"bizTIEaZnfVuNBO2IFXQU","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"
(G)ame (U)nique (Id)entifier"
height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"LDdy7lEQBMUb9Di9njTC8","name":"inViewport","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object is visible and within the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"rmAa5bDyZiN2UxtWoGRG6","name":"isDirty","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"when true the renderable will be redrawn during the next update cycle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"mFGEBIDG5whKQ0CqPyAHu","name":"isFlippedX","brief":"","access":"public","scope":"instance","see":["Renderable#flipX"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"G5Lv-BMMul1-f38-NfulG","name":"isFlippedY","brief":"","access":"public","scope":"instance","see":["Renderable#flipY"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"tmelQhLs9NBHxsuy7YpBm","name":"isFloating","brief":"","scope":"instance","see":["Renderable#floating"],"type":"PropertyDoc","description":"Whether the renderable object is floating (i.e. used screen coordinates), or contained in a floating parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"8ef0UcDbAhxMv-RAzS0hK","name":"isKinematic","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"If true then physic collision and input events will not impact this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"SNuCfjYs2Sbg-y_Tz7b-b","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Fek30UHskJw5Xr1G2OLst","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"sYupUXZYbBEYeunvgAAYe","name":"lineHeight","brief":"","access":"public","defaultValue":"1.0","scope":"instance","type":"PropertyDoc","description":"Set the line spacing height (when displaying multi-line strings).
A mask limits rendering elements to the shape and position of the given mask object.\nSo, if the renderable is larger than ...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"_K5AtceynvL0IDje8W3U3","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"KtmBIdVnRVDTIXZtU-tCz","name":"onVisibilityChange","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"this.onVisibilityChange = function(inViewport) {\n if (inViewport === true) {\n console.log(\"object has entered the in a camera viewport!\");\n }\n};"}],"scope":"instance","type":"PropertyDoc","description":"an event handler that is called when the renderable leave or enter a camera viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"e4jX4YfHk-wpsnkGP0Bp0","name":"parentApp","brief":"","scope":"instance","type":"PropertyDoc","description":"returns the parent application (or game) to which this renderable is attached to
","params":[],"returns":[{"description":"the parent application or undefined if not attached to any container/app
","dataType":{"tokens":[{"value":"Application","kind":"canonical"},{"value":"Application","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"rESCWFDNHFuhw0FB2I8Yr","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"-D__0G9XyfLtNhFwq7s6-","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Qc7A1hmm7__k04Ix7G8ud","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"dYS8ad7J2p_Wz85XBs9ZX","name":"shader","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"(Experimental) an optional shader, to be used instead of the default built-in one, when drawing this renderable (WebGL onl...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"QBMJoulzE1BidIWVZ_09C","name":"textAlign","brief":"","access":"public","defaultValue":"\"left\"","scope":"instance","type":"PropertyDoc","description":"
Set the default text alignment (or justification),
Set the text baseline (e.g. the Y-coordinate for the draw operation),
define a tint for this renderable. a (255, 255, 255) r, g, b value will remove the tint effect.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"VwTgnaHDgq_4-rkWdJfHN","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"GvGtr-A5fy4SF5aVnGpsG","name":"type","brief":"","defaultValue":"\"Rectangle\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"qTsHr4Z13x_9EOqw6Pcmn","name":"updateWhenPaused","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether to update this object when the game is paused.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"R1shELtuqA2X51w5zgbbC","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"g56RfRpmICthl3nI6fE1S","name":"wordWrapWidth","brief":"","access":"public","defaultValue":"-1","scope":"instance","type":"PropertyDoc","description":"the maximum length in CSS pixel for a single segment of text.\n(use -1 to disable word wrapping)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"FBkqhgscChZhojRlwJEdi","name":"_text","brief":"","access":"private","scope":"instance","type":"PropertyDoc","description":"the text to be displayed
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"iPWjLv9wS_gXLU-WAZMaX","name":"fontData","brief":"","access":"private","scope":"instance","type":"PropertyDoc","description":"font data
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Ww7fPRy66BUYUsY-47EM6","name":"fontImage","brief":"","access":"private","scope":"instance","type":"PropertyDoc","description":"font image
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"5zu5hRhRyF3z9H4VbTcMG","name":"fontScale","brief":"","access":"private","scope":"instance","type":"PropertyDoc","description":"scaled font size
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"5oLv2PsUrJc6O5ifYFVES","name":"angleTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the angle to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"angle in radians
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"pJxtFUfv8n0IbyrK9id5g","name":"centerOn","brief":"","scope":"instance","type":"MethodDoc","description":"center the rectangle position around the given coordinates
","params":[{"identifier":"x","optional":false,"description":"the x coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"SACz0P9YqjRFCXQx0Vuvs","name":"clone","brief":"","scope":"instance","type":"MethodDoc","description":"clone this rectangle
","params":[],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"ouSknguuPo61LujX-bPde","name":"constructor","brief":"","examples":[{"caption":"","code":"// Use me.loader.preload or me.loader.load to load assets\nme.loader.preload([\n { name: \"arial\", type: \"binary\" src: \"data/font/arial.fnt\" },\n { name: \"arial\", type: \"image\" src: \"data/font/arial.png\" },\n])\n// Then create an instance of your bitmap font:\nlet myFont = new me.BitmapText(x, y, {font:\"arial\", text:\"Hello\"});\n// two possibilities for using \"myFont\"\n// either call the draw function from your Renderable draw function\nmyFont.draw(renderer, \"Hello!\", 0, 0);\n// or just add it to the word container\nme.game.world.addChild(myFont);"}],"scope":"instance","type":"MethodDoc","params":[{"identifier":"x","optional":false,"description":"position of the text object
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"position of the text object
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings","optional":false,"description":"the text configuration
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}},{"identifier":"settings.font","description":"a font name to identify the corresponing source image
","dataType":{"tokens":[{"value":"string | Image","kind":"canonical"},{"value":"Image","kind":"canonical"}],"template":"string | %1"}},{"identifier":"settings.fontData","optional":true,"default":"settings.font","description":"the bitmap font data corresponding name, or the bitmap font data itself
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"settings.size","optional":true,"description":"size a scaling ratio
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings.fillStyle","optional":true,"description":"a CSS color value used to tint the bitmapText (@see BitmapText.tint)
","dataType":{"tokens":[{"value":"Color | string","kind":"canonical"},{"value":"Color","kind":"link"}],"template":"%1 | string"}},{"identifier":"settings.lineWidth","optional":true,"default":"1","description":"line width, in pixels, when drawing stroke
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings.textAlign","optional":true,"default":"\"left\"","description":"horizontal text alignment
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"settings.textBaseline","optional":true,"default":"\"top\"","description":"the text baseline
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"settings.lineHeight","optional":true,"default":"1.0","description":"line spacing height
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings.anchorPoint","optional":true,"default":"{x:0.0, y:0.0}","description":"anchor point to draw the text at
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}},{"identifier":"settings.wordWrapWidth","optional":true,"description":"the maximum length in CSS pixel for a single segment of text
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings.text","optional":true,"description":"a string, or an array of strings
","dataType":{"tokens":[{"value":"string | Array","kind":"canonical"},{"value":"Array","kind":"canonical"}],"template":"string | %1"}}],"returns":[],"extends":[],"implements":[]},{"id":"YrqnSTqLvlSsSEpPGCr_x","name":"contains","brief":"","examples":[{"caption":"","code":"if (rect.contains(10, 10)) {\n // do something\n}\n// or\nif (rect.contains(myVector2d)) {\n // do something\n}\nif (rect.contains(myRect)) {\n // do something\n}"}],"scope":"instance","type":"MethodDoc","description":"Returns true if the rectangle contains the given point or rectangle
","params":[{"identifier":"x","description":"x coordinate or a vector point, or a rectangle to test
","dataType":{"tokens":[{"value":"number | Vector2d | Rect","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Rect","kind":"link"}],"template":"%1 | %2 | %3"}},{"identifier":"y","optional":true,"description":"y coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"True if the rectangle contain the given point or rectangle, otherwise false
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"R6vE0DFkgTVeUthvQdkuB","name":"copy","brief":"","scope":"instance","type":"MethodDoc","description":"copy the position and size of the given rectangle into this one
","params":[{"identifier":"rect","optional":false,"description":"Source rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"8nuIOvqIzrgMN9ziyAUSt","name":"distanceTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the distance to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"distance
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"YcUEDlRhujYwJ0JOXPne7","name":"draw","brief":"","scope":"instance","type":"MethodDoc","description":"draw the bitmap font
","params":[{"identifier":"renderer","optional":false,"description":"Reference to the destination renderer instance
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}},{"identifier":"text","optional":true,"dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"x","optional":true,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":true,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"n0KjlzOKfTPtBlzu35jmW","name":"equals","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is identical to the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if equals
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"paZV2Eo6qAxM0HY1yLvG4","name":"flipX","brief":"","scope":"instance","see":["Matrix2d#scaleX"],"type":"MethodDoc","description":"flip the renderable on the horizontal axis (around the center of the renderable)
","params":[{"identifier":"flip","optional":true,"default":"true","description":"true to flip this renderable.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"ATwGubkL2IxJQKQ7Q1oXE","name":"flipY","brief":"","scope":"instance","see":["Matrix2d#scaleY"],"type":"MethodDoc","description":"flip the renderable on the vertical axis (around the center of the renderable)
","params":[{"identifier":"flip","optional":true,"default":"true","description":"true to flip this renderable.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"uiXpCdVIcMIXm3IJkJKmJ","name":"getAbsolutePosition","brief":"","scope":"instance","type":"MethodDoc","description":"return the renderable absolute position in the game world
","params":[],"returns":[{"dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"UCPjhXVZJgjIlzIqk68XK","name":"getBounds","brief":"","scope":"instance","type":"MethodDoc","description":"returns the bounding box for this renderable
","params":[],"returns":[{"description":"bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"O2E6o9k2zbAHczTWcqTZX","name":"getIndices","brief":"","scope":"instance","type":"MethodDoc","description":"returns a list of indices for all triangles defined in this polygon
","params":[],"returns":[{"description":"an array of vertex indices for all triangles forming this polygon.
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1<%2>"}}],"extends":[],"implements":[]},{"id":"FUFJqrC83-r9t_2wPBgZ_","name":"getOpacity","brief":"","scope":"instance","type":"MethodDoc","description":"get the renderable alpha channel value
","params":[],"returns":[{"description":"current opacity value between 0 and 1
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"nYX0_sCEktIVo6kfGU7Vw","name":"isConvex","brief":"","scope":"instance","type":"MethodDoc","description":"Returns true if the vertices composing this polygon form a convex shape (vertices must be in clockwise order).
","params":[],"returns":[{"description":"true if the vertices are convex, false if not, null if not computable
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"jzTh2Db0sXbGr2Z0h7Aau","name":"isFinite","brief":"","scope":"instance","type":"MethodDoc","description":"determines whether all coordinates of this rectangle are finite numbers.
","params":[],"returns":[{"description":"false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"V8XpAURAnjuRR8QmEvHPS","name":"lookAt","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this renderable towards the given target.
","params":[{"identifier":"target","optional":false,"description":"the renderable or position to look at
","dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"XjGGM9fMPDFzVIbR5ik8c","name":"measureText","brief":"","scope":"instance","type":"MethodDoc","description":"measure the given text size in pixels
","params":[{"identifier":"text","optional":true,"dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"returns":[{"description":"a TextMetrics object with two properties: width and height, defining the output dimensions
","dataType":{"tokens":[{"value":"TextMetrics","kind":"canonical"},{"value":"TextMetrics","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"ZcQqJJpeSAoTnlLiLMXEc","name":"onCollision","brief":"","examples":[{"caption":"","code":"// colision handler\nonCollision(response) {\n if (response.b.body.collisionType === me.collision.types.ENEMY_OBJECT) {\n // makes the other object solid, by substracting the overlap vector to the current position\n this.pos.sub(response.overlapV);\n this.hurt();\n // not solid\n return false;\n }\n // Make the object solid\n return true;\n},"}],"scope":"instance","type":"MethodDoc","description":"onCollision callback, triggered in case of collision,\nwhen this renderable body is colliding with another one
","params":[{"identifier":"response","optional":false,"description":"the collision response object
","dataType":{"tokens":[{"value":"ResponseObject","kind":"canonical"},{"value":"ResponseObject","kind":"link"}],"template":"%1"}},{"identifier":"other","optional":false,"description":"the other renderable touching this one (a reference to response.a or response.b)
","dataType":{"tokens":[{"value":"Renderable | Container | Entity | Sprite | NineSliceSprite","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Container","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"NineSliceSprite","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5"}}],"returns":[{"description":"true if the object should respond to the collision (its position and velocity will be corrected)
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"rcJJX2C5CKyiBk2SYJ5l-","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"OnDestroy Notification function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"lSCAOq4bbCFNkmLaS6GAO","name":"overlaps","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is intersecting with the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if overlaps
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"JFC0fDoHTEuSag5LvGa8a","name":"postDraw","brief":"","scope":"instance","see":["Renderable#preDraw","Renderable#draw"],"type":"MethodDoc","description":"restore the rendering context after drawing (automatically called by melonJS).
","params":[{"identifier":"renderer","optional":false,"description":"a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"iNp4azgWIRhScpj3roeP4","name":"preDraw","brief":"","scope":"instance","see":["Renderable#draw","Renderable#postDraw"],"type":"MethodDoc","description":"Prepare the rendering context before drawing (automatically called by melonJS).\nThis will apply any defined transforms, an...","params":[{"identifier":"renderer","optional":false,"description":"
a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"sKMZMuHzr1dBAOxKKgBZo","name":"recalc","brief":"","scope":"instance","type":"MethodDoc","description":"Computes the calculated collision polygon.\nThis must be called if the points array, an...","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"CPQf41JLsimMb6smynVbq","name":"resize","brief":"","scope":"instance","type":"MethodDoc","description":"change the font display size
","params":[{"identifier":"scale","optional":false,"description":"ratio
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this object for chaining
","dataType":{"tokens":[{"value":"BitmapText","kind":"canonical"},{"value":"BitmapText","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"TVNKkBJR_fkFmotpPL80K","name":"rotate","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this renderable by the specified angle (in radians).
","params":[{"identifier":"angle","optional":false,"description":"The angle to rotate (in radians)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":true,"description":"an optional point to rotate around
","dataType":{"tokens":[{"value":"Vector2d | ObservableVector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"iUylnZW_4qGn5Vi02Ev7K","name":"scale","brief":"","scope":"instance","type":"MethodDoc","description":"scale the renderable around his anchor point. Scaling actually applies changes\nto the currentTransform member wich is use...","params":[{"identifier":"x","optional":false,"description":"
a number representing the abscissa of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":true,"default":"x","description":"a number representing the ordinate of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"uiHv005gtiLan0ci_p3h_","name":"scaleV","brief":"","scope":"instance","type":"MethodDoc","description":"scale the renderable around his anchor point
","params":[{"identifier":"v","optional":false,"description":"scaling vector
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"7cg3KoWAnZ-5O56QP56m4","name":"set","brief":"","scope":"instance","type":"MethodDoc","description":"change the font settings
","params":[{"identifier":"textAlign","optional":false,"description":"("left", "center", "right")
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"scale","optional":true,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this object for chaining
","dataType":{"tokens":[{"value":"BitmapText","kind":"canonical"},{"value":"BitmapText","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"lstf6DLqiS-b1tW2tnQG2","name":"setOpacity","brief":"","scope":"instance","type":"MethodDoc","description":"set the renderable alpha channel value
","params":[{"identifier":"alpha","optional":false,"description":"opacity value between 0.0 and 1.0
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"XhjBN6DorGvJLR2La8y1j","name":"setShape","brief":"","scope":"instance","type":"MethodDoc","description":"set new value to the rectangle shape
","params":[{"identifier":"x","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"w","optional":false,"description":"width of the rectangle, or an array of vector defining the rectangle
","dataType":{"tokens":[{"value":"number | Array","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %3<%2>"}},{"identifier":"h","optional":true,"description":"height of the rectangle, if a numeral width parameter is specified
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"ya2DOBFhq2QDsHwoXH6Nw","name":"setText","brief":"","scope":"instance","type":"MethodDoc","description":"change the text to be displayed
","params":[{"identifier":"value","optional":false,"default":"\"\"","description":"a string, or an array of strings
","dataType":{"tokens":[{"value":"number | string | Array","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Array","kind":"canonical"}],"template":"%1 | string | %2"}}],"returns":[{"description":"this object for chaining
","dataType":{"tokens":[{"value":"BitmapText","kind":"canonical"},{"value":"BitmapText","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"cLMMEDFNBCDSalQ4FM1dK","name":"setVertices","brief":"","scope":"instance","type":"MethodDoc","description":"set the vertices defining this Polygon
","params":[{"identifier":"vertices","optional":false,"description":"array of vector or vertice defining the Polygon
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1<%2>"}}],"returns":[{"description":"this instance for objecf chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"9sitSpmz--Uu3rRF-pfCD","name":"shift","brief":"","examples":[{"caption":"","code":"polygon.shift(10, 10);\n// or\npolygon.shift(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"Shifts the Polygon to the given position vector.
","params":[{"identifier":"x","description":"x coordinate or a vector point to shift to
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"aFy9wtiOJ0o1Od2myt7Su","name":"to2d","brief":"","scope":"instance","type":"MethodDoc","description":"apply a 2d projection to this shapen
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"iyupZgnJvMZ93vy5zeMUT","name":"toIso","brief":"","scope":"instance","type":"MethodDoc","description":"apply an isometric projection to this shape
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"UIkRLPGLjSE9sszrdnD_P","name":"toPolygon","brief":"","scope":"instance","type":"MethodDoc","description":"Returns a polygon whose edges are the same as this box.
","params":[],"returns":[{"description":"a new Polygon that represents this rectangle.
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"DnEgolRD9ZTf7FqTAghbf","name":"transform","brief":"","scope":"instance","see":["Renderable#currentTransform"],"type":"MethodDoc","description":"multiply the renderable currentTransform with the given matrix
","params":[{"identifier":"m","optional":false,"description":"the transformation matrix
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"xYTwfqUJiJs5gXtCelV4U","name":"translate","brief":"","examples":[{"caption":"","code":"polygon.translate(10, 10);\n// or\npolygon.translate(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"translate the Polygon by the specified offset
","params":[{"identifier":"x","description":"x offset or a vector point to translate by
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"description":"y offset
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"h_CubrAea3WIwlzFyjzIc","name":"union","brief":"","scope":"instance","type":"MethodDoc","description":"merge this rectangle with another one
","params":[{"identifier":"rect","optional":false,"description":"other rectangle to union with
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"the union(ed) rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"ljiWTx0WBALYMENaZAuDS","name":"update","brief":"","scope":"instance","type":"MethodDoc","description":"update function (automatically called by melonJS).
","params":[{"identifier":"dt","optional":false,"description":"time since the last update in milliseconds.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"true if the renderable is dirty
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"mFwP8cQ7pH0dap4IGYFU_","name":"updateBounds","brief":"","scope":"instance","type":"MethodDoc","description":"update the bounding box for this Bitmap Text.
","params":[{"identifier":"absolute","optional":true,"default":"true","description":"update the bounds size and position in (world) absolute coordinates
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"this Bitmap Text bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"7T6V6TlSwKSXJolcRQ9Kr","name":"onAnchorUpdate","brief":"","access":"private","scope":"instance","type":"MethodDoc","description":"called when the anchor point value is changed
","params":[{"identifier":"x","optional":false,"description":"the new X value to be set for the anchor
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the new Y value to be set for the anchor
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]}]},{"id":"4z_iy0t3mCfAuysuGM78Q","name":"Body","brief":"","see":["Renderable.body"],"type":"ClassDoc","description":"a Generic Physic Body Object with some physic properties and behavior functionality, to add as a member of a Renderable.
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"J9sYI4m9r1WxO66i7kN1E","name":"ancestor","brief":"","access":"public","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"a reference to the parent object that contains this body,\nor undefined if it has not been added to one.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"GTdx4TgZ4uHqPnCv73bIU","name":"bounce","brief":"","access":"public","defaultValue":"0","scope":"instance","type":"PropertyDoc","description":"the body bouciness level when colliding with other solid bodies :\na value of 0 will not bounce, a value of 1 will fully re...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"1akAHO7MbpYO3aK3sl44m","name":"bounds","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
The AABB bounds box reprensenting this body
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"axg_oksZ1UY_yVCKq-8LF","name":"collisionType","brief":"","access":"public","defaultValue":"collision.types.ENEMY_OBJECT","examples":[{"caption":"","code":"// set the body collision type\nbody.collisionType = me.collision.types.PLAYER_OBJECT;"}],"scope":"instance","see":["collision.types"],"type":"PropertyDoc","description":"define the collision type of the body for collision filtering
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"g1ORGHVtyH4oRUZIZWjNO","name":"falling","brief":"","access":"public","defaultValue":"false","readonly":true,"scope":"instance","type":"PropertyDoc","description":"falling state of the body
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"n_7c16RlG6veAtNcD03Zm","name":"force","brief":"","access":"public","defaultValue":"<0,0>","examples":[{"caption":"","code":" // define a default maximum acceleration, initial force and friction\n this.body.force.set(1, 0);\n this.body.friction.set(0.4, 0);\n this.body.setMaxVelocity(3, 15);\n\n // apply a postive or negative force when pressing left of right key\n update(dt) {\n if (me.input.isKeyPressed(\"left\")) {\n this.body.force.x = -this.body.maxVel.x;\n } else if (me.input.isKeyPressed(\"right\")) {\n this.body.force.x = this.body.maxVel.x;\n }\n }"}],"scope":"instance","see":["Body.setMaxVelocity"],"type":"PropertyDoc","description":"body force to apply to this the body in the current step.\n(any positive or negative force will be cancelled after every wo...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"3WtXZaxL7pF5QmzfJxMdV","name":"friction","brief":"","access":"public","defaultValue":"<0,0>","scope":"instance","type":"PropertyDoc","description":"
body friction
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"hHmehukToLmijE_WZDM-b","name":"gravityScale","brief":"","access":"public","defaultValue":"1.0","scope":"instance","see":["World.gravity"],"type":"PropertyDoc","description":"The degree to which this body is affected by the world gravity
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"YjUlU5zh8qhtY3SZhwCLD","name":"ignoreGravity","brief":"","access":"public","defaultValue":"false","scope":"instance","see":["World.gravity"],"type":"PropertyDoc","description":"If true this body won't be affected by the world gravity
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"8tV6eihT4oPGnD-j7ss4S","name":"isStatic","brief":"","access":"public","defaultValue":"false","readonly":true,"scope":"instance","type":"PropertyDoc","description":"Either this body is a static body or not.\nA static body is completely fixed and can never change position or angle.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"WUxxpikhhgCYbShAmpbQO","name":"jumping","brief":"","access":"public","defaultValue":"false","readonly":true,"scope":"instance","type":"PropertyDoc","description":"jumping state of the body
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Y4ya8KI5nWX7WrhHv-j1B","name":"mass","brief":"","access":"public","defaultValue":"1","scope":"instance","type":"PropertyDoc","description":"the body mass
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"EqlN9i7eq6407H8JiMepH","name":"maxVel","brief":"","access":"public","defaultValue":"<490,490>","scope":"instance","type":"PropertyDoc","description":"max velocity (to limit body velocity)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"DpzeuAfhbWq2t-lEsZF7o","name":"vel","brief":"","access":"public","defaultValue":"<0,0>","scope":"instance","see":["Body.force"],"type":"PropertyDoc","description":"The current velocity of the body.\nSee to apply a force if you need to modify a body velocity
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"r4x6eixamVojk7i-WiTZL","name":"addShape","brief":"","examples":[{"caption":"","code":"// add a rectangle shape\nthis.body.addShape(new me.Rect(0, 0, image.width, image.height));\n// add a shape from a JSON object\nthis.body.addShape(me.loader.getJSON(\"shapesdef\").banana);"}],"scope":"instance","type":"MethodDoc","description":"add a collision shape to this body
","params":[{"identifier":"shape","optional":false,"description":"a shape or JSON object
","dataType":{"tokens":[{"value":"Rect | Polygon | Line | Ellipse | Point | Array | Bounds | object","kind":"canonical"},{"value":"Rect","kind":"link"},{"value":"Polygon","kind":"link"},{"value":"Line","kind":"link"},{"value":"Ellipse","kind":"link"},{"value":"Point","kind":"link"},{"value":"Array","kind":"canonical"},{"value":"Point","kind":"link"},{"value":"Bounds","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5 | %6<%7> | %8 | object"}}],"returns":[{"description":"the shape array length
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"xm9QvK0joLixgPIfYz95n","name":"addVertices","brief":"","scope":"instance","type":"MethodDoc","description":"add the given vertices to the body shape
","params":[{"identifier":"vertices","optional":false,"description":"an array of me.Vector2d points defining a convex hull
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1<%2>"}},{"identifier":"index","optional":true,"default":"0","description":"the shape object for which to set the vertices
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"B59wd4iuqTtIpCxKBkSEM","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"ancestor","optional":false,"description":"the parent object this body is attached to
","dataType":{"tokens":[{"value":"Renderable | Container | Entity | Sprite | NineSliceSprite","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Container","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"NineSliceSprite","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5"}},{"identifier":"shapes","optional":true,"description":"a initial shape, list of shapes, or JSON object defining the body
","dataType":{"tokens":[{"value":"Rect | Array | Polygon | Array | Line | Array | Ellipse | Array | Point | Array | Bounds | Array | object","kind":"canonical"},{"value":"Rect","kind":"link"},{"value":"Array","kind":"canonical"},{"value":"Rect","kind":"link"},{"value":"Polygon","kind":"link"},{"value":"Array","kind":"canonical"},{"value":"Polygon","kind":"link"},{"value":"Line","kind":"link"},{"value":"Array","kind":"canonical"},{"value":"Line","kind":"link"},{"value":"Ellipse","kind":"link"},{"value":"Array","kind":"canonical"},{"value":"Ellipse","kind":"link"},{"value":"Point","kind":"link"},{"value":"Array","kind":"canonical"},{"value":"Point","kind":"link"},{"value":"Bounds","kind":"link"},{"value":"Array","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1 | %3<%2> | %4 | %5<%6> | %7 | %8<%9> | %10 | %11<%12> | %13 | %14<%15> | %16 | %17<%18> | object"}},{"identifier":"onBodyUpdate","optional":true,"description":"callback for when the body is updated (e.g. add/remove shapes)
","dataType":{"tokens":[{"value":"Function","kind":"canonical"}],"template":"Function"}}],"returns":[],"extends":[],"implements":[]},{"id":"QiSLEw5hMkt5tpBTv7k14","name":"contains","brief":"","examples":[{"caption":"","code":"if (mySprite.body.contains(10, 10)) {\n // do something\n}\n// or\nif (mySprite.body.contains(myVector2d)) {\n // do something\n}"}],"scope":"instance","type":"MethodDoc","description":"Returns true if the any of the shape composing the body contains the given point.
","params":[{"identifier":"x","optional":false,"variadic":true,"description":"x coordinate or a vector point to check
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"description":"y coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"true if contains
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"fFJpbKQsCIsaNk_Fk9TTl","name":"forEach","brief":"","examples":[{"caption":"","code":"// iterate through all shapes of the physic body\nmySprite.body.forEach((shape) => {\n shape.doSomething();\n});\nmySprite.body.forEach((shape, index) => { ... });\nmySprite.body.forEach((shape, index, array) => { ... });\nmySprite.body.forEach((shape, index, array) => { ... }, thisArg);"}],"scope":"instance","type":"MethodDoc","description":"The forEach() method executes a provided function once per body shape element.
fnction to execute on each element
","dataType":{"tokens":[{"value":"Function","kind":"canonical"}],"template":"Function"}},{"identifier":"thisArg","optional":true,"description":"value to use as this(i.e reference Object) when executing callback.
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}}],"returns":[],"extends":[],"implements":[]},{"id":"KqYZ0eS-jMMurccu6krpm","name":"fromJSON","brief":"","examples":[{"caption":"","code":"// define the body based on the banana shape\nthis.body.fromJSON(me.loader.getJSON(\"shapesdef\").banana);\n// or ...\nthis.body.fromJSON(me.loader.getJSON(\"shapesdef\"), \"banana\");"}],"scope":"instance","see":["https://www.codeandweb.com/physicseditor"],"type":"MethodDoc","description":"add collision mesh based on a JSON object\n(this will also apply any physic properties defined in the given JSON file)
","params":[{"identifier":"json","optional":false,"description":"a JSON object as exported from a Physics Editor tool
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}},{"identifier":"id","optional":true,"description":"an optional shape identifier within the given the json object
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"returns":[{"description":"how many shapes were added to the body
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"asyW9XknrDu1dzXmMsajQ","name":"getBounds","brief":"","scope":"instance","type":"MethodDoc","description":"returns the AABB bounding box for this body
","params":[],"returns":[{"description":"bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Fsuv1PEokwGWANjlq6_he","name":"getShape","brief":"","scope":"instance","type":"MethodDoc","description":"return the collision shape at the given index
","params":[{"identifier":"index","optional":true,"default":"0","description":"the shape object at the specified index
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"shape a shape object if defined
","dataType":{"tokens":[{"value":"Polygon | Line | Ellipse","kind":"canonical"},{"value":"Polygon","kind":"link"},{"value":"Line","kind":"link"},{"value":"Ellipse","kind":"link"}],"template":"%1 | %2 | %3"}}],"extends":[],"implements":[]},{"id":"Ru49q9whlAv2ixwyrMS4P","name":"removeShape","brief":"","scope":"instance","type":"MethodDoc","description":"remove the specified shape from the body shape list
","params":[{"identifier":"shape","optional":false,"description":"a shape object
","dataType":{"tokens":[{"value":"Polygon | Line | Ellipse","kind":"canonical"},{"value":"Polygon","kind":"link"},{"value":"Line","kind":"link"},{"value":"Ellipse","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"the shape array length
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"1zAFpYt5caqZcRdpnh6PJ","name":"removeShapeAt","brief":"","scope":"instance","type":"MethodDoc","description":"remove the shape at the given index from the body shape list
","params":[{"identifier":"index","optional":false,"description":"the shape object at the specified index
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"the shape array length
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"zRUIWZmyNvBH-gWprmku9","name":"respondToCollision","brief":"","scope":"instance","type":"MethodDoc","description":"the built-in function to solve the collision response
","params":[{"identifier":"response","optional":false,"description":"the collision response object (see {@link ResponseObject})
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}}],"returns":[],"extends":[],"implements":[]},{"id":"VWYzP6Fb9w38Ui63_FGFv","name":"rotate","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this body (counter-clockwise) by the specified angle (in radians).\nUnless specified the body will be rotated around...","params":[{"identifier":"angle","optional":false,"description":"
The angle to rotate (in radians)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":true,"default":"Body.getBounds().center","description":"an optional point to rotate around
","dataType":{"tokens":[{"value":"Vector2d | ObservableVector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Body","kind":"canonical"},{"value":"Body","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"VIFODA5jE05SDNY5ju3FN","name":"setCollisionMask","brief":"","examples":[{"caption":"","code":"// filter collision detection with collision shapes, enemies and collectables\nbody.setCollisionMask(me.collision.types.WORLD_SHAPE | me.collision.types.ENEMY_OBJECT | me.collision.types.COLLECTABLE_OBJECT);\n...\n// disable collision detection with all other objects\nbody.setCollisionMask(me.collision.types.NO_OBJECT);"}],"scope":"instance","see":["collision.types"],"type":"MethodDoc","description":"By default all physic bodies are able to collide with all other bodies,
the collision mask
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"J0wAvoftU9wRDwnMlux-W","name":"setCollisionType","brief":"","examples":[{"caption":"","code":"// set the body collision type\nbody.collisionType = me.collision.types.PLAYER_OBJECT;"}],"scope":"instance","see":["collision.types"],"type":"MethodDoc","description":"define the collision type of the body for collision filtering
","params":[{"identifier":"type","optional":false,"description":"the collision type
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"415KwAfhvw8Fr_OlRRLuJ","name":"setFriction","brief":"","scope":"instance","type":"MethodDoc","description":"set the body default friction
","params":[{"identifier":"x","optional":false,"default":"0","description":"horizontal friction
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"default":"0","description":"vertical friction
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"vUx_VpDbNl37Ar1GDk3dx","name":"setMaxVelocity","brief":"","scope":"instance","type":"MethodDoc","description":"cap the body velocity (body.maxVel property) to the specified value
","params":[{"identifier":"x","optional":false,"description":"max velocity on x axis
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"max velocity on y axis
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"lv4V8r1HBkLKwHmnvZmkO","name":"setStatic","brief":"","scope":"instance","type":"MethodDoc","description":"set the body as a static body\nstatic body do not move automatically and do not check againt collision with others
","params":[{"identifier":"isStatic","optional":true,"default":"true","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"Z05yQNHhg7LOZoMPwlfW4","name":"setVertices","brief":"","scope":"instance","type":"MethodDoc","description":"set the body vertices to the given one
","params":[{"identifier":"vertices","optional":false,"description":"an array of me.Vector2d points defining a convex hull
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1<%2>"}},{"identifier":"index","optional":true,"default":"0","description":"the shape object for which to set the vertices
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"clear","optional":true,"default":"true","description":"either to reset the body definition before adding the new vertices
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"-d8u8NgJFxwpTufeFhgnJ","name":"update","brief":"","access":"protected","scope":"instance","type":"MethodDoc","description":"Updates the parent's position as well as computes the new body's velocity based\non the values of force/friction. Velocity...","params":[{"identifier":"dt","optional":false,"description":"
time since the last update in milliseconds.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"true if resulting velocity is different than 0
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]}]},{"id":"EjuxxXCpo9UsJaZkR7u1S","name":"Bounds","brief":"","type":"ClassDoc","description":"a bound object contains methods for creating and manipulating axis-aligned bounding boxes (AABB).
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"NuOtbFbacNCIrFVHwUB2c","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"rAfCgPci74jzkeb13CVDT","name":"center","brief":"","scope":"instance","type":"PropertyDoc","description":"return the center position of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"1ihrkszJRAC6XLdNGwZKL","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"center position of the bound on the x axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"CuF0U0oV-pJcp4tCt4e7u","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"center position of the bound on the y axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"poIYb2L5atCymApPisiwc","name":"height","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the bounds
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"0dIBYJqQSNVyoFgnlPt5F","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"EWYcMlcLcX_ic7KG702EB","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"P5pWP2VUD9GLr1xuz0NO1","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"RPjg-KSTKXepbcggRAsRu","name":"type","brief":"","defaultValue":"\"Bounds\"","scope":"instance","type":"PropertyDoc","description":"the object type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"DxPHdKzOBeWY1yXguHYxH","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the bounds
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"iJmAbL6Bw1I0Ks0GaWdoA","name":"x","brief":"","scope":"instance","type":"PropertyDoc","description":"x position of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Gqj_cY2G9k49g-Fpw8d0c","name":"y","brief":"","scope":"instance","type":"PropertyDoc","description":"y position of the bounds
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"OylXk1VLSz19m6B9A2rvH","name":"add","brief":"","scope":"instance","type":"MethodDoc","description":"add the given vertices to the bounds definition.
","params":[{"identifier":"vertices","optional":false,"description":"an array of Vector2d or Point
","dataType":{"tokens":[{"value":"Array | Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Array","kind":"canonical"},{"value":"Point","kind":"link"}],"template":"%1<%2> | %3<%4>"}},{"identifier":"clear","optional":true,"default":"false","description":"either to reset the bounds before adding the new vertices
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"u7WBvY7nW1adC0avukLdI","name":"addBounds","brief":"","scope":"instance","type":"MethodDoc","description":"add the given bounds to the bounds definition.
","params":[{"identifier":"bounds","optional":false,"dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}},{"identifier":"clear","optional":true,"default":"false","description":"either to reset the bounds before adding the new vertices
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"MAQIjrIUMXpK_VgMsf5Hd","name":"addFrame","brief":"","scope":"instance","type":"MethodDoc","description":"add the given quad coordinates to this bound definition, multiplied by the given matrix
","params":[{"identifier":"x0","optional":false,"description":"left X coordinates of the quad
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y0","optional":false,"description":"top Y coordinates of the quad
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"x1","optional":false,"description":"right X coordinates of the quad
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y1","optional":false,"description":"bottom y coordinates of the quad
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"m","optional":true,"description":"an optional transform to apply to the given frame coordinates
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"XAspto09UAGHVagTsQRtZ","name":"addPoint","brief":"","scope":"instance","type":"MethodDoc","description":"add the given point to the bounds definition.
","params":[{"identifier":"point","optional":false,"description":"the vector or point to be added to the bounds
","dataType":{"tokens":[{"value":"Vector2d | Point","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Point","kind":"link"}],"template":"%1 | %2"}},{"identifier":"m","optional":true,"description":"an optional transform to apply to the given point (if the given point is a Vector2d)
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"Mvh0zyED7zhTOXerHcDTh","name":"centerOn","brief":"","scope":"instance","type":"MethodDoc","description":"center the bounds position around the given coordinates
","params":[{"identifier":"x","optional":false,"description":"the x coordinate around which to center this bounds
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y coordinate around which to center this bounds
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"sWRVkvK0lZjrfMUYyH_5L","name":"clear","brief":"reset the bound
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"aVFYXLbvHskahrZ_ODffp","name":"clone","brief":"","scope":"instance","type":"MethodDoc","description":"clone this bounds
","params":[],"returns":[{"dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"gqlEMmngRKhkGctaEf3Wn","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"vertices","optional":true,"description":"an array of Vector2d or Point
","dataType":{"tokens":[{"value":"Array | Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Array","kind":"canonical"},{"value":"Point","kind":"link"}],"template":"%1<%2> | %3<%4>"}}],"returns":[],"extends":[],"implements":[]},{"id":"3pSWRiikGCBZm_21IFu_D","name":"contains","brief":"","examples":[{"caption":"","code":"if (bounds.contains(10, 10)) {\n // do something\n}\n// or\nif (bounds.contains(myVector2d)) {\n // do something\n}"}],"scope":"instance","type":"MethodDoc","description":"Returns true if the bounds contains the given point.
","params":[{"identifier":"x","description":"x coordinate or a vector point to check
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"description":"y coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"True if the bounds contain the point, otherwise false
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"k_Z4zcoWh7nAu56SRhWVN","name":"isFinite","brief":"","scope":"instance","type":"MethodDoc","description":"determines whether all coordinates of this bounds are finite numbers.
","params":[],"returns":[{"description":"false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"feDg6Cbhx5TytWHJla6h7","name":"overlaps","brief":"","scope":"instance","type":"MethodDoc","description":"Returns true if the two bounds intersect.
","params":[{"identifier":"bounds","optional":false,"dataType":{"tokens":[{"value":"Bounds | Rect","kind":"canonical"},{"value":"Bounds","kind":"link"},{"value":"Rect","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"True if the bounds overlap, otherwise false
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"Stp6RhwtArET8243qiwTe","name":"setMinMax","brief":"","scope":"instance","type":"MethodDoc","description":"sets the bounds to the given min and max value
","params":[{"identifier":"minX","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"minY","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"maxX","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"maxY","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"CLsNoTnvwZkasUUheN0ry","name":"shift","brief":"","examples":[{"caption":"","code":"bounds.shift(10, 10);\n// or\nbounds.shift(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"Shifts the bounds to the given x, y position.
","params":[{"identifier":"x","description":"x coordinate or a vector point to shift to
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"evTM82jLhSKbyUtwM9uUz","name":"toPolygon","brief":"","scope":"instance","type":"MethodDoc","description":"Returns a polygon whose edges are the same as this bounds.
","params":[],"returns":[{"description":"a new Polygon that represents this bounds.
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"BZoXJ01jGdQpni0o6Piyb","name":"translate","brief":"","examples":[{"caption":"","code":"bounds.translate(10, 10);\n// or\nbounds.translate(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"Translates the bounds by the given point
","params":[{"identifier":"x","description":"x coordinate or a vector point to translate by
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"tbmICLuAZkEahZolh2JQn","name":"update","brief":"","scope":"instance","type":"MethodDoc","description":"Updates bounds using the given vertices
","params":[{"identifier":"vertices","optional":false,"description":"an array of Vector2d or Point
","dataType":{"tokens":[{"value":"Array | Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Array","kind":"canonical"},{"value":"Point","kind":"link"}],"template":"%1<%2> | %3<%4>"}}],"returns":[],"extends":[],"implements":[]}]},{"id":"Juytriw6_tz5OiEltuZDg","name":"Camera2d","brief":"","type":"ClassDoc","description":"a 2D orthographic camera
","params":[],"returns":[],"extends":["Renderable"],"implements":[],"members":[{"id":"cJmrh32Nf44ksX25EcEE1","name":"AXIS","brief":"","readonly":true,"type":"EnumDoc","description":"Axis definition
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"g3im0thPW76sIrKXqab_R","name":"BOTH","brief":"","access":"public","scope":"static","type":"PropertyDoc","description":"both axis
"},{"id":"CEQOriy4tDMPxEnBjA0G9","name":"HORIZONTAL","brief":"","access":"public","scope":"static","type":"PropertyDoc","description":"horizontal axis only
"},{"id":"xN9h06-cnC_Fzm5LBgnHp","name":"NONE","brief":"","access":"public","scope":"static","type":"PropertyDoc","description":"no axis
"},{"id":"JthtEzZ4FIY7dyMMOqfAj","name":"VERTICAL","brief":"","access":"public","scope":"static","type":"PropertyDoc","description":"vertical axis only
"}]},{"id":"_IUlm16OXsEpK0C_098sh","name":"alpha","brief":"","defaultValue":"1.0","scope":"instance","see":["Renderable#setOpacity","Renderable#getOpacity"],"type":"PropertyDoc","description":"Define the renderable opacity
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"e04Q1x5VcEcw4ynDHICqQ","name":"alwaysUpdate","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object will always update, even when outside of the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"0IGRl3dhZZ7GZFst1vNHC","name":"ancestor","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"a reference to the parent object that contains this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"uezoKJ4uwQdPz0WuD-9jy","name":"anchorPoint","brief":"","defaultValue":"<0.5,0.5>","scope":"instance","type":"PropertyDoc","description":"The anchor point is used for attachment behavior, and/or when applying transformations.
When enabled, an object container will automatically apply\nany defined transformation before calling the child draw method...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Z-EHpj9ELS-tP41IG115y","name":"blendMode","brief":"","defaultValue":"\"normal\"","scope":"instance","see":["CanvasRenderer#setBlendMode","WebGLRenderer#setBlendMode"],"type":"PropertyDoc","description":"
the blend mode to be applied to this renderable (see renderer setBlendMode for available blend mode)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"O5Hsde75nlp6w67sSJx-C","name":"body","brief":"","examples":[{"caption":"","code":" // define a new Player Class\n class PlayerEntity extends me.Sprite {\n // constructor\n constructor(x, y, settings) {\n // call the parent constructor\n super(x, y , settings);\n\n // define a basic walking animation\n this.addAnimation(\"walk\", [...]);\n // define a standing animation (using the first frame)\n this.addAnimation(\"stand\", [...]);\n // set the standing animation as default\n this.setCurrentAnimation(\"stand\");\n\n // add a physic body\n this.body = new me.Body(this);\n // add a default collision shape\n this.body.addShape(new me.Rect(0, 0, this.width, this.height));\n // configure max speed, friction, and initial force to be applied\n this.body.setMaxVelocity(3, 15);\n this.body.setFriction(0.4, 0);\n this.body.force.set(3, 0);\n this.isKinematic = false;\n\n // set the display to follow our position on both axis\n me.game.viewport.follow(this.pos, me.game.viewport.AXIS.BOTH);\n }\n\n ...\n\n }"}],"scope":"instance","type":"PropertyDoc","description":"the renderable physic body
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"-x22PpZ-Eh2YMecLzn9_y","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"B7zMUanyYwFKPakw3N2Ez","name":"bounds","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"Camera bounds
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"EiPkmNGp8pTIUHdvls2N_","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"g8lGFUBuNEtvTVA9-1TIA","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"eR-Ay7L9jeCh2dUFonCvq","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"2SZgwwtc1yDiQA84GMk5y","name":"damping","brief":"","access":"public","defaultValue":"1.0","scope":"instance","type":"PropertyDoc","description":"Camera damping for smooth transition [0 .. 1].\n1 being the maximum value and will snap the camera to the target position
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"e5vhubWytYz50tVEMOYqM","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"95csZ1oEY_eXY8cTnWIKk","name":"far","brief":"","access":"public","defaultValue":"1000","scope":"instance","type":"PropertyDoc","description":"the furthest point relative to the camera.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"875adjtxnBVBIT2vzKb1N","name":"floating","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"If true, this renderable will be rendered using screen coordinates,\nas opposed to world coordinates. Use this, for example...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"J3Oxalry6XWH9XCuY9qPg","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"
(G)ame (U)nique (Id)entifier"
height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ykdQESLMK6CCfRuQSilXw","name":"inViewport","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object is visible and within the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Sj3DInRxWCG7hBlvBUXfL","name":"isDirty","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"when true the renderable will be redrawn during the next update cycle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"vQIulbo5QoN2vCQAJ0u6e","name":"isFlippedX","brief":"","access":"public","scope":"instance","see":["Renderable#flipX"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"K-OXuwjjcGBub3coeta96","name":"isFlippedY","brief":"","access":"public","scope":"instance","see":["Renderable#flipY"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"9KIpyQ51IcG4pxWex658-","name":"isFloating","brief":"","scope":"instance","see":["Renderable#floating"],"type":"PropertyDoc","description":"Whether the renderable object is floating (i.e. used screen coordinates), or contained in a floating parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"4JOGNJnuYW4bjsEQOopWE","name":"isKinematic","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"If true then physic collision and input events will not impact this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"zC5USkt3DJ_sRzrxg9C8d","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"6QfgaqHOTKl0nsS8iL5JY","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"LbV9GIPxbLcmFEDD6Wvf8","name":"mask","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"// apply a mask in the shape of a Star\nmyNPCSprite.mask = new me.Polygon(myNPCSprite.width / 2, 0, [\n // draw a star\n {x: 0, y: 0},\n {x: 14, y: 30},\n {x: 47, y: 35},\n {x: 23, y: 57},\n {x: 44, y: 90},\n {x: 0, y: 62},\n {x: -44, y: 90},\n {x: -23, y: 57},\n {x: -47, y: 35},\n {x: -14, y: 30}\n]);"}],"scope":"instance","type":"PropertyDoc","description":"A mask limits rendering elements to the shape and position of the given mask object.\nSo, if the renderable is larger than ...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"cDYrJ7hYS5asTfgewClc-","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"s4IL7LzGKe4ynj9KWRf9G","name":"near","brief":"","access":"public","defaultValue":"-1000","scope":"instance","type":"PropertyDoc","description":"the closest point relative to the camera
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"y981_b_mj-pWDxt2Kq02C","name":"onVisibilityChange","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"this.onVisibilityChange = function(inViewport) {\n if (inViewport === true) {\n console.log(\"object has entered the in a camera viewport!\");\n }\n};"}],"scope":"instance","type":"PropertyDoc","description":"an event handler that is called when the renderable leave or enter a camera viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"RaVtn_znDOTgLeR2_42x6","name":"parentApp","brief":"","scope":"instance","type":"PropertyDoc","description":"returns the parent application (or game) to which this renderable is attached to
","params":[],"returns":[{"description":"the parent application or undefined if not attached to any container/app
","dataType":{"tokens":[{"value":"Application","kind":"canonical"},{"value":"Application","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"R6OcFazlV-GF0bjYc4cFl","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Gn72muL97WfoV71V9-h2f","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"FtIqPgRHqdc2NP4pN5QDE","name":"projectionMatrix","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"the default camera projection matrix\n(2d cameras use an orthographic projection by default).
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"QoscMYqun7kJEIZZhSzf2","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"DYHI_siSnofwsOrRSeaw4","name":"shader","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"(Experimental) an optional shader, to be used instead of the default built-in one, when drawing this renderable (WebGL onl...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"7eIG1Yiv_uRZb5EZyULgx","name":"tint","brief":"","defaultValue":"(255, 255, 255)","examples":[{"caption":"","code":"// add a red tint to this renderable\nthis.tint.setColor(255, 128, 128);\n// remove the tint\nthis.tint.setColor(255, 255, 255);"}],"scope":"instance","type":"PropertyDoc","description":"
define a tint for this renderable. a (255, 255, 255) r, g, b value will remove the tint effect.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"QCj1-UGVj_s-sHDnPPBgy","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"4_We7QXE9N6EGy8AYV3ER","name":"type","brief":"","defaultValue":"\"Rectangle\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"4JashpPwLetpmvSWV74bL","name":"updateWhenPaused","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether to update this object when the game is paused.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"tEddGKaRxIBqTCW9NKAkJ","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"9EcaO_dutIf2dP9ewg7vd","name":"smoothFollow","brief":"","access":"private","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"enable or disable damping
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"A7_4UzYshdKpuahn2bp-F","name":"angleTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the angle to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"angle in radians
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"cNh_drC2Q9GpHx4JoI_Qo","name":"centerOn","brief":"","scope":"instance","type":"MethodDoc","description":"center the rectangle position around the given coordinates
","params":[{"identifier":"x","optional":false,"description":"the x coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Rd3ydqJR2piGWXyH7V3Lq","name":"clone","brief":"","scope":"instance","type":"MethodDoc","description":"clone this rectangle
","params":[],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"T2DHTJfI1jQrG4dvy0C57","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"minX","optional":false,"description":"start x offset
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"minY","optional":false,"description":"start y offset
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"maxX","optional":false,"description":"end x offset
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"maxY","optional":false,"description":"end y offset
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"ifsCcbvmKAi48ak-bLmHc","name":"contains","brief":"","examples":[{"caption":"","code":"if (rect.contains(10, 10)) {\n // do something\n}\n// or\nif (rect.contains(myVector2d)) {\n // do something\n}\nif (rect.contains(myRect)) {\n // do something\n}"}],"scope":"instance","type":"MethodDoc","description":"Returns true if the rectangle contains the given point or rectangle
","params":[{"identifier":"x","description":"x coordinate or a vector point, or a rectangle to test
","dataType":{"tokens":[{"value":"number | Vector2d | Rect","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Rect","kind":"link"}],"template":"%1 | %2 | %3"}},{"identifier":"y","optional":true,"description":"y coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"True if the rectangle contain the given point or rectangle, otherwise false
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"2zNUq7kEk310LTtjwkzia","name":"copy","brief":"","scope":"instance","type":"MethodDoc","description":"copy the position and size of the given rectangle into this one
","params":[{"identifier":"rect","optional":false,"description":"Source rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"3bAqts25B7kwEKkX2N25H","name":"distanceTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the distance to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"distance
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"0P_sb8d3LRuTRMmxUW2_M","name":"draw","brief":"","scope":"instance","see":["Renderable#preDraw","Renderable#postDraw"],"type":"MethodDoc","description":"Draw this renderable (automatically called by melonJS).\nAll draw operations for renderable are made respectively\nto the po...","params":[{"identifier":"renderer","optional":false,"description":"
a renderer instance
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}},{"identifier":"viewport","optional":true,"description":"the viewport to (re)draw
","dataType":{"tokens":[{"value":"Camera2d","kind":"canonical"},{"value":"Camera2d","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"gD9CC0MT8C4_65eYUhTyS","name":"equals","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is identical to the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if equals
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"hDPQkTW62uFLsPqCNbL63","name":"fadeIn","brief":"","examples":[{"caption":"","code":"// flash the camera to white for 75ms\nme.game.viewport.fadeIn(\"#FFFFFF\", 75);"}],"scope":"instance","type":"MethodDoc","description":"fadeIn effect
\nfade to the specified color
","params":[{"identifier":"color","optional":false,"description":"a CSS color value
","dataType":{"tokens":[{"value":"Color | string","kind":"canonical"},{"value":"Color","kind":"link"}],"template":"%1 | string"}},{"identifier":"duration","optional":true,"default":"1000","description":"expressed in milliseconds
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"onComplete","optional":true,"description":"callback once effect is over
","dataType":{"tokens":[{"value":"Function","kind":"canonical"}],"template":"Function"}}],"returns":[],"extends":[],"implements":[]},{"id":"kkLaG_tsK7k_cXqqvcEAn","name":"fadeOut","brief":"","examples":[{"caption":"","code":"// fade the camera to white upon dying, reload the level, and then fade out back\nme.game.viewport.fadeIn(\"#fff\", 150, function() {\n me.audio.play(\"die\", false);\n me.level.reload();\n me.game.viewport.fadeOut(\"#fff\", 150);\n});"}],"scope":"instance","type":"MethodDoc","description":"fadeOut(flash) effect
\nscreen is filled with the specified color and slowly goes back to normal
","params":[{"identifier":"color","optional":false,"description":"a CSS color value
","dataType":{"tokens":[{"value":"Color | string","kind":"canonical"},{"value":"Color","kind":"link"}],"template":"%1 | string"}},{"identifier":"duration","optional":true,"default":"1000","description":"expressed in milliseconds
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"onComplete","optional":true,"description":"callback once effect is over
","dataType":{"tokens":[{"value":"Function","kind":"canonical"}],"template":"Function"}}],"returns":[],"extends":[],"implements":[]},{"id":"gSHSuLIqWkNxCLwYaA6XK","name":"flipX","brief":"","scope":"instance","see":["Matrix2d#scaleX"],"type":"MethodDoc","description":"flip the renderable on the horizontal axis (around the center of the renderable)
","params":[{"identifier":"flip","optional":true,"default":"true","description":"true to flip this renderable.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"4VpqWDRNLbrJ9u1-BvU1m","name":"flipY","brief":"","scope":"instance","see":["Matrix2d#scaleY"],"type":"MethodDoc","description":"flip the renderable on the vertical axis (around the center of the renderable)
","params":[{"identifier":"flip","optional":true,"default":"true","description":"true to flip this renderable.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"aRi2ybDNTO_oZp74FCcd8","name":"focusOn","brief":"","scope":"instance","type":"MethodDoc","description":"set the camera position around the specified object
","params":[{"identifier":"target","optional":false,"description":"the renderable to focus the camera on
","dataType":{"tokens":[{"value":"Renderable | Entity | Sprite | NineSliceSprite","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"NineSliceSprite","kind":"link"}],"template":"%1 | %2 | %3 | %4"}}],"returns":[],"extends":[],"implements":[]},{"id":"EWjXvDDaqtTpfAZ-6g6CU","name":"follow","brief":"","examples":[{"caption":"","code":"// set the camera to follow this renderable on both axis, and enable damping\nme.game.viewport.follow(this, me.game.viewport.AXIS.BOTH, 0.1);"}],"scope":"instance","type":"MethodDoc","description":"set the camera to follow the specified renderable.
","params":[{"identifier":"target","optional":false,"description":"renderable or position vector to follow
","dataType":{"tokens":[{"value":"Renderable | Vector2d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"axis","optional":true,"default":"me.game.viewport.AXIS.BOTH","description":"Which axis to follow (see {@link Camera2d.AXIS})
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"damping","optional":true,"default":"1","description":"default damping value
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"PYhMuXodRDDX821E5dsN1","name":"getAbsolutePosition","brief":"","scope":"instance","type":"MethodDoc","description":"return the renderable absolute position in the game world
","params":[],"returns":[{"dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"M17AA10p2dU9zfatV2K-p","name":"getBounds","brief":"","scope":"instance","type":"MethodDoc","description":"returns the bounding box for this renderable
","params":[],"returns":[{"description":"bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"9kCbf3wsZRfZW3Hh2Vfa7","name":"getIndices","brief":"","scope":"instance","type":"MethodDoc","description":"returns a list of indices for all triangles defined in this polygon
","params":[],"returns":[{"description":"an array of vertex indices for all triangles forming this polygon.
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1<%2>"}}],"extends":[],"implements":[]},{"id":"u1yalNmx3fJnLElRNFliS","name":"getOpacity","brief":"","scope":"instance","type":"MethodDoc","description":"get the renderable alpha channel value
","params":[],"returns":[{"description":"current opacity value between 0 and 1
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"GR5QBu8rGr55_ioFHmL6m","name":"isConvex","brief":"","scope":"instance","type":"MethodDoc","description":"Returns true if the vertices composing this polygon form a convex shape (vertices must be in clockwise order).
","params":[],"returns":[{"description":"true if the vertices are convex, false if not, null if not computable
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"N5oU4R3pznEAo9EThYRiB","name":"isFinite","brief":"","scope":"instance","type":"MethodDoc","description":"determines whether all coordinates of this rectangle are finite numbers.
","params":[],"returns":[{"description":"false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"sJCkZPAIcJXdvyn187vBC","name":"isVisible","brief":"","scope":"instance","type":"MethodDoc","description":"check if the specified renderable is in the camera
","params":[{"identifier":"obj","optional":false,"description":"to be checked against
","dataType":{"tokens":[{"value":"Renderable | Entity | Sprite | NineSliceSprite","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"NineSliceSprite","kind":"link"}],"template":"%1 | %2 | %3 | %4"}},{"identifier":"floating ","optional":true,"default":" obj.floating","description":"if visibility check should be done against screen coordinates
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"true if within the viewport
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"BgTyvMiH-MnJZgWWe35sa","name":"localToWorld","brief":"","scope":"instance","type":"MethodDoc","description":"convert the given "local" (screen) coordinates into world coordinates
","params":[{"identifier":"x","optional":false,"description":"the x coordinate of the local point to be converted
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y coordinate of the local point to be converted
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":true,"description":"an optional vector object where to set the converted value
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"yBSu2KG1vcwm0kACp9P3g","name":"lookAt","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this renderable towards the given target.
","params":[{"identifier":"target","optional":false,"description":"the renderable or position to look at
","dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"wpf8T_UuZ6Nz4Jnxw-heC","name":"move","brief":"","examples":[{"caption":"","code":"// Move the camera up by four pixels\nme.game.viewport.move(0, -4);"}],"scope":"instance","see":["Camera2d.focusOn"],"type":"MethodDoc","description":"move the camera upper-left position by the specified offset.
","params":[{"identifier":"x","optional":false,"description":"horizontal offset
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"vertical offset
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"j5zAhOPT1YJEvYNdh9Glc","name":"moveTo","brief":"","scope":"instance","see":["Camera2d.focusOn"],"type":"MethodDoc","description":"move the camera upper-left position to the specified coordinates
","params":[{"identifier":"x","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"pJreqwQwcxiVd2ynA5x2O","name":"onCollision","brief":"","examples":[{"caption":"","code":"// colision handler\nonCollision(response) {\n if (response.b.body.collisionType === me.collision.types.ENEMY_OBJECT) {\n // makes the other object solid, by substracting the overlap vector to the current position\n this.pos.sub(response.overlapV);\n this.hurt();\n // not solid\n return false;\n }\n // Make the object solid\n return true;\n},"}],"scope":"instance","type":"MethodDoc","description":"onCollision callback, triggered in case of collision,\nwhen this renderable body is colliding with another one
","params":[{"identifier":"response","optional":false,"description":"the collision response object
","dataType":{"tokens":[{"value":"ResponseObject","kind":"canonical"},{"value":"ResponseObject","kind":"link"}],"template":"%1"}},{"identifier":"other","optional":false,"description":"the other renderable touching this one (a reference to response.a or response.b)
","dataType":{"tokens":[{"value":"Renderable | Container | Entity | Sprite | NineSliceSprite","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Container","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"NineSliceSprite","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5"}}],"returns":[{"description":"true if the object should respond to the collision (its position and velocity will be corrected)
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"yAGG5a_bEePo6JI8l9im3","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"OnDestroy Notification function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"JUe7EkKl6zuAYXMobF9kA","name":"overlaps","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is intersecting with the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if overlaps
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"4qGGT_IUcNhGZu-UlNDXa","name":"postDraw","brief":"","scope":"instance","see":["Renderable#preDraw","Renderable#draw"],"type":"MethodDoc","description":"restore the rendering context after drawing (automatically called by melonJS).
","params":[{"identifier":"renderer","optional":false,"description":"a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"19f97gjkSnk0UctWP28TU","name":"preDraw","brief":"","scope":"instance","see":["Renderable#draw","Renderable#postDraw"],"type":"MethodDoc","description":"Prepare the rendering context before drawing (automatically called by melonJS).\nThis will apply any defined transforms, an...","params":[{"identifier":"renderer","optional":false,"description":"
a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"OvXR4tgCKnYsVZL0_2vgL","name":"recalc","brief":"","scope":"instance","type":"MethodDoc","description":"Computes the calculated collision polygon.\nThis must be called if the points array, an...","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"tkPXKSVDCv7v_LbO74cMq","name":"reset","brief":"","scope":"instance","type":"MethodDoc","description":"reset the camera position to specified coordinates
","params":[{"identifier":"x","optional":true,"default":"0","description":"initial position of the camera on the x axis
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":true,"default":"0","description":"initial position of the camera on the y axis
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"ARm8A7HzQOosVgk8MOLfV","name":"resize","brief":"","scope":"instance","type":"MethodDoc","description":"resize the camera
","params":[{"identifier":"w","optional":false,"description":"new width of the camera
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"h","optional":false,"description":"new height of the camera
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this camera
","dataType":{"tokens":[{"value":"Camera2d","kind":"canonical"},{"value":"Camera2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"6Xw-xKLrRwvT5xn9L_x5T","name":"rotate","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this renderable by the specified angle (in radians).
","params":[{"identifier":"angle","optional":false,"description":"The angle to rotate (in radians)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":true,"description":"an optional point to rotate around
","dataType":{"tokens":[{"value":"Vector2d | ObservableVector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"5JSJXQrjV_rq6TVyTl4Ui","name":"scale","brief":"","scope":"instance","type":"MethodDoc","description":"scale the renderable around his anchor point. Scaling actually applies changes\nto the currentTransform member wich is use...","params":[{"identifier":"x","optional":false,"description":"
a number representing the abscissa of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":true,"default":"x","description":"a number representing the ordinate of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"-8PUHzW8aQJ9k7fS9uS8w","name":"scaleV","brief":"","scope":"instance","type":"MethodDoc","description":"scale the renderable around his anchor point
","params":[{"identifier":"v","optional":false,"description":"scaling vector
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"uPujsULDbUJjHIII3jEdJ","name":"setBounds","brief":"","scope":"instance","type":"MethodDoc","description":"set the camera boundaries (set to the world limit by default).\nthe camera is bound to the given coordinates and cannot mov...","params":[{"identifier":"x","optional":false,"description":"
world left limit
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"world top limit
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"w","optional":false,"description":"world width limit
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"h","optional":false,"description":"world height limit
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"4cKrdSCrXO4VD64nj_Rt0","name":"setDeadzone","brief":"","scope":"instance","see":["Camera2d.follow"],"type":"MethodDoc","description":"change the deadzone settings.\nthe "deadzone" defines an area within the current camera in which\nthe followed ren...","params":[{"identifier":"w","optional":false,"description":"
deadzone width
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"h","optional":false,"description":"deadzone height
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"V98ry7tdkoTkLkXPS-ryT","name":"setOpacity","brief":"","scope":"instance","type":"MethodDoc","description":"set the renderable alpha channel value
","params":[{"identifier":"alpha","optional":false,"description":"opacity value between 0.0 and 1.0
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"S86CSq625IMXBKG7aJcYo","name":"setShape","brief":"","scope":"instance","type":"MethodDoc","description":"set new value to the rectangle shape
","params":[{"identifier":"x","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"w","optional":false,"description":"width of the rectangle, or an array of vector defining the rectangle
","dataType":{"tokens":[{"value":"number | Array","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %3<%2>"}},{"identifier":"h","optional":true,"description":"height of the rectangle, if a numeral width parameter is specified
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"2SE8N47zfvw5T687yHIV7","name":"setVertices","brief":"","scope":"instance","type":"MethodDoc","description":"set the vertices defining this Polygon
","params":[{"identifier":"vertices","optional":false,"description":"array of vector or vertice defining the Polygon
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1<%2>"}}],"returns":[{"description":"this instance for objecf chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"yHArDuU63nQ-QW7JiDZHQ","name":"shake","brief":"","examples":[{"caption":"","code":"// shake it baby !\nme.game.viewport.shake(10, 500, me.game.viewport.AXIS.BOTH);"}],"scope":"instance","type":"MethodDoc","description":"shake the camera
","params":[{"identifier":"intensity","optional":false,"description":"maximum offset that the screen can be moved\nwhile shaking
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"duration","optional":false,"description":"expressed in milliseconds
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"axis","optional":true,"default":"me.game.viewport.AXIS.BOTH","description":"specify on which axis to apply the shake effect (see {@link Camera2d.AXIS})
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"onComplete","optional":true,"description":"callback once shaking effect is over
","dataType":{"tokens":[{"value":"Function","kind":"canonical"}],"template":"Function"}},{"identifier":"force","optional":true,"description":"if true this will override the current effect
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"cQi2chNHgdAZWybTIdklx","name":"shift","brief":"","examples":[{"caption":"","code":"polygon.shift(10, 10);\n// or\npolygon.shift(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"Shifts the Polygon to the given position vector.
","params":[{"identifier":"x","description":"x coordinate or a vector point to shift to
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"YvJ4cUAR-DKTVg5lnK5W4","name":"to2d","brief":"","scope":"instance","type":"MethodDoc","description":"apply a 2d projection to this shapen
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"u4kqPpplZME0ozRAXi4SG","name":"toIso","brief":"","scope":"instance","type":"MethodDoc","description":"apply an isometric projection to this shape
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"W87y3PdJ8TMZjqdry2wUS","name":"toPolygon","brief":"","scope":"instance","type":"MethodDoc","description":"Returns a polygon whose edges are the same as this box.
","params":[],"returns":[{"description":"a new Polygon that represents this rectangle.
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"kaQQXUs9s-hTFlfwE2fZ0","name":"transform","brief":"","scope":"instance","see":["Renderable#currentTransform"],"type":"MethodDoc","description":"multiply the renderable currentTransform with the given matrix
","params":[{"identifier":"m","optional":false,"description":"the transformation matrix
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"ptrleClThq_2Hy5-GqFRL","name":"translate","brief":"","examples":[{"caption":"","code":"polygon.translate(10, 10);\n// or\npolygon.translate(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"translate the Polygon by the specified offset
","params":[{"identifier":"x","description":"x offset or a vector point to translate by
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"description":"y offset
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"8IhxXOARgs57JlLir29Fe","name":"unfollow","brief":"","scope":"instance","type":"MethodDoc","description":"unfollow the current target
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"fX1uvng-ipVrJnvqF5ihK","name":"union","brief":"","scope":"instance","type":"MethodDoc","description":"merge this rectangle with another one
","params":[{"identifier":"rect","optional":false,"description":"other rectangle to union with
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"the union(ed) rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"8i-jkQ5k67aSEtEkxAHkt","name":"update","brief":"","scope":"instance","type":"MethodDoc","description":"update function (automatically called by melonJS).
","params":[{"identifier":"dt","optional":false,"description":"time since the last update in milliseconds.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"true if the renderable is dirty
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"7jyXCOcqedKqzzxDAQHKF","name":"updateBounds","brief":"","scope":"instance","type":"MethodDoc","description":"update the bounding box for this shape.
","params":[{"identifier":"absolute","optional":true,"default":"true","description":"update the bounds size and position in (world) absolute coordinates
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"this shape bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"xGF5d-X7TGSKaj0ZHMyfi","name":"worldToLocal","brief":"","scope":"instance","type":"MethodDoc","description":"convert the given world coordinates into "local" (screen) coordinates
","params":[{"identifier":"x","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":true,"description":"an optional vector object where to set the converted value
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"a vector with the converted local coordinates
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"LJzYIBRIO0tcNs9PauWiz","name":"onAnchorUpdate","brief":"","access":"private","scope":"instance","type":"MethodDoc","description":"called when the anchor point value is changed
","params":[{"identifier":"x","optional":false,"description":"the new X value to be set for the anchor
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the new Y value to be set for the anchor
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]}]},{"id":"_oNeg2RQapfEEKoTpMO3n","name":"CanvasRenderer","brief":"","type":"ClassDoc","description":"a canvas renderer object
","params":[],"returns":[],"extends":["Renderer"],"implements":[],"members":[{"id":"2jr_vf8mXfAERzZPvbGtb","name":"depthTest","brief":"","defaultValue":"\"sorting\"","scope":"instance","type":"PropertyDoc","description":"the default method to sort object ("sorting", "z-buffer")
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"FbBZNDuUCrIztp1Ghhbwv","name":"designRatio","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"the requested video size ratio
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"df45EMC98HvbAD2XeqeN6","name":"height","brief":"","scope":"instance","type":"PropertyDoc","description":"return the height of the canvas which this renderer draws to
","params":[],"returns":[{"description":"height of the system Canvas
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"XJh09qfRq19sufda54Ype","name":"isContextValid","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"true if the current rendering context is valid
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"GlBSvae2E0A44oGySBz8e","name":"path2D","brief":"","scope":"instance","type":"PropertyDoc","description":"The Path2D instance used by the renderer to draw primitives
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"M12jxFHJQkY5QI9HOIi8e","name":"scaleRatio","brief":"","defaultValue":"<1,1>","scope":"instance","type":"PropertyDoc","description":"the scaling ratio to be applied to the main canvas
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"OxYEkD0rD6LQzM-qNRDN5","name":"settings","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"The given constructor options
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Q_Vo2EKp05k1FFnODxpT0","name":"type","brief":"","defaultValue":"\"Generic\"","scope":"instance","type":"PropertyDoc","description":"The renderer type : Canvas, WebGL, etc...\n(override this property with a specific value when implementing a custom rendere...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"xY6AtRuWHjROGGNPah4Xv","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"
return the width of the canvas which this renderer draws to
","params":[],"returns":[{"description":"width of the system Canvas
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"wUHEPiq1GRkwSCZWlgto7","name":"beginPath","brief":"","examples":[{"caption":"","code":"// First path\nrenderer.beginPath();\nrenderer.setColor(\"blue\");\nrenderer.moveTo(20, 20);\nrenderer.lineTo(200, 20);\nrenderer.stroke();\n// Second path\nrenderer.beginPath();\nrenderer.setColor(\"green\");\nrenderer.moveTo(20, 20);\nrenderer.lineTo(120, 120);\nrenderer.stroke();"}],"scope":"instance","type":"MethodDoc","description":"starts a new path by emptying the list of sub-paths. Call this method when you want to create a new path
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"g1SOxbEJ7_2omsRO0awoq","name":"clear","brief":"prepare the framebuffer for drawing a new frame
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"zGyGOIFV1wKl8sZ498u5f","name":"clearColor","brief":"","scope":"instance","type":"MethodDoc","description":"Clears the main framebuffer with the given color
","params":[{"identifier":"color","optional":true,"default":"\"#000000\"","description":"CSS color.
","dataType":{"tokens":[{"value":"Color | string","kind":"canonical"},{"value":"Color","kind":"link"}],"template":"%1 | string"}},{"identifier":"opaque","optional":true,"default":"false","description":"Allow transparency [default] or clear the surface completely [true]
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"eLGEwXv-oHyBv4Di3pjCJ","name":"clearMask","brief":"","scope":"instance","see":["CanvasRenderer#setMask"],"type":"MethodDoc","description":"disable (remove) the rendering mask set through setMask.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"AraZcC4JUmV1xczX6drCC","name":"clearRect","brief":"","scope":"instance","type":"MethodDoc","description":"Erase the pixels in the given rectangular area by setting them to transparent black (rgba(0,0,0,0)).
","params":[{"identifier":"x","optional":false,"description":"x axis of the coordinate for the rectangle starting point.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"y axis of the coordinate for the rectangle starting point.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"width","optional":false,"description":"The rectangle's width.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"height","optional":false,"description":"The rectangle's height.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"srKZJi9EYVNN_8UlwwoDX","name":"clearTint","brief":"","scope":"instance","see":["Renderer#setTint"],"type":"MethodDoc","description":"clear the rendering tint set through setTint.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"3u__P6fDzRrzxGOd1p5rY","name":"clipRect","brief":"","scope":"instance","type":"MethodDoc","description":"clip the given region from the original canvas. Once a region is clipped,\nall future drawing will be limited to the clippe...","params":[{"identifier":"x","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"width","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"height","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"-HMKnQraYKfqrkR9qsjD7","name":"closePath","brief":"
add a straight line from the current point to the start of the current sub-path. If the shape has already been closed or has only one point, this function does nothing
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"hjGhkvwCUCTp-f5t_0VrQ","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"options","optional":true,"description":"optional parameters for the renderer
","dataType":{"tokens":[{"value":"Application.Settings","kind":"canonical"},{"value":"Application.Settings","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"qh_G3dTr4DU8GVKsLskke","name":"createPattern","brief":"","examples":[{"caption":"","code":"let tileable = renderer.createPattern(image, \"repeat\");\nlet horizontal = renderer.createPattern(image, \"repeat-x\");\nlet vertical = renderer.createPattern(image, \"repeat-y\");\nlet basic = renderer.createPattern(image, \"no-repeat\");"}],"scope":"instance","see":["ImageLayer#repeat"],"type":"MethodDoc","description":"Create a pattern with the specified repetition
","params":[{"identifier":"image","optional":false,"description":"Source image to be used as the pattern's image
","dataType":{"tokens":[{"value":"HTMLImageElement | SVGImageElement | HTMLVideoElement | HTMLCanvasElement | ImageBitmap | OffscreenCanvas | VideoFrame","kind":"canonical"},{"value":"HTMLImageElement","kind":"canonical"},{"value":"SVGImageElement","kind":"canonical"},{"value":"HTMLVideoElement","kind":"canonical"},{"value":"HTMLCanvasElement","kind":"canonical"},{"value":"ImageBitmap","kind":"canonical"},{"value":"OffscreenCanvas","kind":"canonical"},{"value":"VideoFrame","kind":"canonical"}],"template":"%1 | %2 | %3 | %4 | %5 | %6 | %7"}},{"identifier":"repeat","optional":false,"description":"Define how the pattern should be repeated
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"returns":[{"dataType":{"tokens":[{"value":"CanvasPattern","kind":"canonical"},{"value":"CanvasPattern","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"CzWhuwKyGglVvFJRNikZr","name":"drawImage","brief":"","examples":[{"caption":"","code":"// Position the image on the canvas:\nrenderer.drawImage(image, dx, dy);\n// Position the image on the canvas, and specify width and height of the image:\nrenderer.drawImage(image, dx, dy, dWidth, dHeight);\n// Clip the image and position the clipped part on the canvas:\nrenderer.drawImage(image, sx, sy, sWidth, sHeight, dx, dy, dWidth, dHeight);"}],"scope":"instance","type":"MethodDoc","description":"Draw an image onto the main using the canvas api
","params":[{"identifier":"image","optional":false,"description":"An element to draw into the context.
","dataType":{"tokens":[{"value":"HTMLImageElement | SVGImageElement | HTMLVideoElement | HTMLCanvasElement | ImageBitmap | OffscreenCanvas | VideoFrame","kind":"canonical"},{"value":"HTMLImageElement","kind":"canonical"},{"value":"SVGImageElement","kind":"canonical"},{"value":"HTMLVideoElement","kind":"canonical"},{"value":"HTMLCanvasElement","kind":"canonical"},{"value":"ImageBitmap","kind":"canonical"},{"value":"OffscreenCanvas","kind":"canonical"},{"value":"VideoFrame","kind":"canonical"}],"template":"%1 | %2 | %3 | %4 | %5 | %6 | %7"}},{"identifier":"sx","optional":false,"description":"The X coordinate of the top left corner of the sub-rectangle of the source image to draw into the destination context.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"sy","optional":false,"description":"The Y coordinate of the top left corner of the sub-rectangle of the source image to draw into the destination context.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"sw","optional":false,"description":"The width of the sub-rectangle of the source image to draw into the destination context. If not specified, the entire rect...","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"sh","optional":false,"description":"
The height of the sub-rectangle of the source image to draw into the destination context.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"dx","optional":false,"description":"The X coordinate in the destination canvas at which to place the top-left corner of the source image.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"dy","optional":false,"description":"The Y coordinate in the destination canvas at which to place the top-left corner of the source image.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"dw","optional":false,"description":"The width to draw the image in the destination canvas. This allows scaling of the drawn image. If not specified, the image...","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"dh","optional":false,"description":"
The height to draw the image in the destination canvas. This allows scaling of the drawn image. If not specified, the imag...","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"tMJhQTB5gxpQduKWq7Iu4","name":"drawPattern","brief":"","scope":"instance","see":["CanvasRenderer#createPattern"],"type":"MethodDoc","description":"
Draw a pattern within the given rectangle.
","params":[{"identifier":"pattern","optional":false,"description":"Pattern object
","dataType":{"tokens":[{"value":"CanvasPattern","kind":"canonical"},{"value":"CanvasPattern","kind":"canonical"}],"template":"%1"}},{"identifier":"x","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"width","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"height","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"cMwA9qGT5DxRbAuCaWmo9","name":"fill","brief":"","scope":"instance","type":"MethodDoc","description":"fill the given shape or the current defined path
","params":[{"identifier":"shape","optional":true,"description":"a shape object to fill
","dataType":{"tokens":[{"value":"Rect | RoundRect | Polygon | Line | Ellipse","kind":"canonical"},{"value":"Rect","kind":"link"},{"value":"RoundRect","kind":"link"},{"value":"Polygon","kind":"link"},{"value":"Line","kind":"link"},{"value":"Ellipse","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5"}}],"returns":[],"extends":[],"implements":[]},{"id":"CuR2kaVZfOQ8moZg1K8_q","name":"fillArc","brief":"","scope":"instance","type":"MethodDoc","description":"Fill an arc at the specified coordinates with given radius, start and end points
","params":[{"identifier":"x","optional":false,"description":"arc center point x-axis
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"arc center point y-axis
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"radius","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"start","optional":false,"description":"start angle in radians
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"end","optional":false,"description":"end angle in radians
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"antiClockwise","optional":true,"default":"false","description":"draw arc anti-clockwise
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"fqIgPp9wUP9nnXQ_zFKvk","name":"fillEllipse","brief":"","scope":"instance","type":"MethodDoc","description":"Fill an ellipse at the specified coordinates with given radius
","params":[{"identifier":"x","optional":false,"description":"ellipse center point x-axis
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"ellipse center point y-axis
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"w","optional":false,"description":"horizontal radius of the ellipse
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"h","optional":false,"description":"vertical radius of the ellipse
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"3XlwIaooC3zs70c1xHDHe","name":"fillLine","brief":"","scope":"instance","type":"MethodDoc","description":"Fill a line of the given two points
","params":[{"identifier":"startX","optional":false,"description":"the start x coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"startY","optional":false,"description":"the start y coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"endX","optional":false,"description":"the end x coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"endY","optional":false,"description":"the end y coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"1D3NQYausG8PdRV1nPK3k","name":"fillPoint","brief":"","scope":"instance","type":"MethodDoc","description":"Draw a a point at the specified coordinates
","params":[{"identifier":"x","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"width","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"height","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"NtmQfVCAxqyiMGCV639w7","name":"fillPolygon","brief":"","scope":"instance","type":"MethodDoc","description":"Fill the given me.Polygon on the screen
","params":[{"identifier":"poly","optional":false,"description":"the shape to draw
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"0jYYQupIKHgh5yn_qctKY","name":"fillRect","brief":"","scope":"instance","type":"MethodDoc","description":"Draw a filled rectangle at the specified coordinates
","params":[{"identifier":"x","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"width","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"height","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"FuIiIyDRFPwbgS1a-LOZA","name":"fillRoundRect","brief":"","scope":"instance","type":"MethodDoc","description":"Draw a rounded filled rectangle at the specified coordinates
","params":[{"identifier":"x","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"width","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"height","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"radius","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"hsqwcR3BI7jppJZczI-Nb","name":"flush","brief":"render the main framebuffer on screen
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"byxr8XMfy_qVQ_lrL6sbZ","name":"getBlendMode","brief":"","scope":"instance","type":"MethodDoc","description":"returns the current blend mode for this renderer
","params":[],"returns":[{"description":"blend mode
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"extends":[],"implements":[]},{"id":"_1SlYiW0T6PxsNcPwh1Js","name":"getCanvas","brief":"","scope":"instance","type":"MethodDoc","description":"return a reference to the canvas which this renderer draws to
","params":[],"returns":[{"dataType":{"tokens":[{"value":"HTMLCanvasElement","kind":"canonical"},{"value":"HTMLCanvasElement","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"TLf5xII9VwQSifjeJ_m3r","name":"getColor","brief":"","scope":"instance","type":"MethodDoc","description":"get the current fill & stroke style color.
","params":[],"returns":[{"description":"current global color
","dataType":{"tokens":[{"value":"Color","kind":"canonical"},{"value":"Color","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Yz6odYmIxygO349zsGw9G","name":"getContext","brief":"","scope":"instance","type":"MethodDoc","description":"return a reference to this renderer canvas corresponding Context
","params":[],"returns":[{"dataType":{"tokens":[{"value":"CanvasRenderingContext2D | WebGLRenderingContext","kind":"canonical"},{"value":"CanvasRenderingContext2D","kind":"canonical"},{"value":"WebGLRenderingContext","kind":"canonical"}],"template":"%1 | %2"}}],"extends":[],"implements":[]},{"id":"LiL_Utgmaw3MgxfG7DN23","name":"getContext2d","brief":"","scope":"instance","type":"MethodDoc","description":"Returns the 2D Context object of the given Canvas
use false to disable transparency
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"dataType":{"tokens":[{"value":"CanvasRenderingContext2D","kind":"canonical"},{"value":"CanvasRenderingContext2D","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"nUy0tNjagD-sJOieMsEMr","name":"getGlobalAlpha","brief":"","scope":"instance","type":"MethodDoc","description":"Return the global alpha
","params":[],"returns":[{"description":"global alpha value
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"W9HL9gz4l_CFUtQXPXOhf","name":"getScreenCanvas","brief":"","deprecated":"since 13.1.0","scope":"instance","see":["getCanvas();"],"type":"MethodDoc","description":"return a reference to the screen canvas
","params":[],"returns":[{"dataType":{"tokens":[{"value":"HTMLCanvasElement","kind":"canonical"},{"value":"HTMLCanvasElement","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"zT2K5IZTAdAFw-qJrlpeV","name":"getScreenContext","brief":"","deprecated":"since 13.1.0","scope":"instance","see":["getContext();"],"type":"MethodDoc","description":"return a reference to the screen canvas corresponding 2d Context
return the current global alpha
","params":[],"returns":[{"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"yafVaK000fLJAVtDh1Nyi","name":"lineTo","brief":"adds a straight line to the current sub-path by connecting the sub-path's last point to the specified (x, y) coordinates.
","scope":"instance","type":"MethodDoc","params":[{"identifier":"x","optional":false},{"identifier":"y","optional":false}],"returns":[],"extends":[],"implements":[]},{"id":"C2GWoX2I_nJqhIMxKjJGP","name":"moveTo","brief":"","scope":"instance","type":"MethodDoc","description":"begins a new sub-path at the point specified by the given (x, y) coordinates.
","params":[{"identifier":"x","optional":false,"description":"The x axis of the point.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"The y axis of the point.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"KC0axu49NDl8_EAi0nW8I","name":"overlaps","brief":"","scope":"instance","type":"MethodDoc","description":"check if the given rect or bounds overlaps with the renderer screen coordinates
","params":[{"identifier":"bounds","optional":false,"dataType":{"tokens":[{"value":"Rect | Bounds","kind":"canonical"},{"value":"Rect","kind":"link"},{"value":"Bounds","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"true if overlaps
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"m7_4bL10tVl0IaoFaGN96","name":"rect","brief":"","scope":"instance","type":"MethodDoc","description":"creates a rectangular path whose starting point is at (x, y) and whose size is specified by width and height.
","params":[{"identifier":"x","optional":false,"description":"The x axis of the coordinate for the rectangle starting point.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"The y axis of the coordinate for the rectangle starting point.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"width","optional":false,"description":"The rectangle's width.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"height","optional":false,"description":"The rectangle's height.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"dD4nd-tsSu4ByhJLnCGFy","name":"reset","brief":"Reset context state
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"1KBM1iZdZI5yBO9VF_JBP","name":"resetTransform","brief":"Reset the canvas transform to identity
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"V8pY7LCSSVvy5o-pIZJ2S","name":"resize","brief":"","scope":"instance","type":"MethodDoc","description":"resizes the system canvas
","params":[{"identifier":"width","optional":false,"description":"new width of the canvas
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"height","optional":false,"description":"new height of the canvas
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"9lZnegB0TP1pJ1wdznm3S","name":"restore","brief":"","examples":[{"caption":"","code":" // Save the current state\n renderer.save();\n\n // apply a transform and draw a rect\n renderer.tranform(matrix);\n renderer.fillRect(10, 10, 100, 100);\n\n // Restore to the state saved by the most recent call to save()\n renderer.restore();"}],"scope":"instance","type":"MethodDoc","description":"restores the most recently saved renderer state by popping the top entry in the drawing state stack
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"dpbfgqJf63I3ZGDwO5EJ_","name":"rotate","brief":"","examples":[{"caption":"","code":" // Rotated rectangle\n renderer.rotate((45 * Math.PI) / 180);\n renderer.setColor(\"red\");\n renderer.fillRect(10, 10, 100, 100);\n\n // Reset transformation matrix to the identity matrix\n renderer.setTransform(1, 0, 0, 1, 0, 0);"}],"scope":"instance","type":"MethodDoc","description":"adds a rotation to the transformation matrix.
","params":[{"identifier":"angle","optional":false,"description":"the rotation angle, clockwise in radians
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"gZvMDN_27ExFSsJM0EJWY","name":"roundRect","brief":"","scope":"instance","type":"MethodDoc","description":"adds a rounded rectangle to the current path.
","params":[{"identifier":"x","optional":false,"description":"The x axis of the coordinate for the rectangle starting point.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"The y axis of the coordinate for the rectangle starting point.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"width","optional":false,"description":"The rectangle's width.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"height","optional":false,"description":"The rectangle's height.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"radius","optional":false,"description":"The corner radius.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"Z4okn4yMlf9RRP43nNpyM","name":"save","brief":"","examples":[{"caption":"","code":" // Save the current state\n renderer.save();\n\n // apply a transform and draw a rect\n renderer.tranform(matrix);\n renderer.fillRect(10, 10, 100, 100);\n\n // Restore to the state saved by the most recent call to save()\n renderer.restore();"}],"scope":"instance","type":"MethodDoc","description":"saves the entire state of the renderer by pushing the current state onto a stack.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"hQ-CNEAgHJxwyLhXYRvdJ","name":"scale","brief":"","scope":"instance","type":"MethodDoc","description":"adds a scaling transformation to the renderer units horizontally and/or vertically
","params":[{"identifier":"x","optional":false,"description":"Scaling factor in the horizontal direction. A negative value flips pixels across the vertical axis. A value of 1 results i...","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"
Scaling factor in the vertical direction. A negative value flips pixels across the horizontal axis. A value of 1 results i...","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"RSob6fqFdWHjYmF1MCtgh","name":"setAntiAlias","brief":"","scope":"instance","type":"MethodDoc","description":"
enable/disable image smoothing (scaling interpolation) for the given context
","params":[{"identifier":"context","optional":false,"dataType":{"tokens":[{"value":"CanvasRenderingContext2D","kind":"canonical"},{"value":"CanvasRenderingContext2D","kind":"canonical"}],"template":"%1"}},{"identifier":"enable","optional":true,"default":"false","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"dBWmm0worlrskq7W9hOZl","name":"setBlendMode","brief":"","scope":"instance","see":["https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/globalCompositeOperation"],"type":"MethodDoc","description":"set a blend mode for the given context.
\n\n&q...","params":[{"identifier":"mode","optional":true,"default":"\"normal\"","description":"blend mode : "normal", "multiply", "lighter, "additive", "screen"
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"context","optional":true,"dataType":{"tokens":[{"value":"CanvasRenderingContext2D","kind":"canonical"},{"value":"CanvasRenderingContext2D","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"rRFFxzpslVpJh8N21U40i","name":"setColor","brief":"","scope":"instance","type":"MethodDoc","description":"Set the current fill & stroke style color.\nBy default, or upon reset, the value is set to #000000.
","params":[{"identifier":"color","optional":false,"description":"css color value
","dataType":{"tokens":[{"value":"Color | string","kind":"canonical"},{"value":"Color","kind":"link"}],"template":"%1 | string"}}],"returns":[],"extends":[],"implements":[]},{"id":"7CRzIJJx8xlhL2a8VxaNI","name":"setGlobalAlpha","brief":"","scope":"instance","type":"MethodDoc","description":"Set the global alpha
","params":[{"identifier":"alpha","optional":false,"description":"0.0 to 1.0 values accepted.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"7nW6tN1zkXy40SJWJLRs8","name":"setLineWidth","brief":"","scope":"instance","type":"MethodDoc","description":"Set the line width on the context
","params":[{"identifier":"width","optional":false,"description":"Line width
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"-ZTiWpFtgGyImoMbKXdBu","name":"setMask","brief":"","scope":"instance","see":["CanvasRenderer#clearMask"],"type":"MethodDoc","description":"A mask limits rendering elements to the shape and position of the given mask object.\nIf the drawing or rendering area is l...","params":[{"identifier":"mask","optional":true,"description":"
the shape defining the mask to be applied
","dataType":{"tokens":[{"value":"Rect | RoundRect | Polygon | Line | Ellipse","kind":"canonical"},{"value":"Rect","kind":"link"},{"value":"RoundRect","kind":"link"},{"value":"Polygon","kind":"link"},{"value":"Line","kind":"link"},{"value":"Ellipse","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5"}},{"identifier":"invert","optional":true,"default":"false","description":"either the given shape should define what is visible (default) or the opposite
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"eXH5LoO5j-z6G6lYHzEpq","name":"setProjection","brief":"","scope":"instance","type":"MethodDoc","description":"set/change the current projection matrix (WebGL only)
","params":[{"identifier":"matrix","optional":false,"dataType":{"tokens":[{"value":"Matrix3d","kind":"canonical"},{"value":"Matrix3d","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"KuCzraHw-feL_fDx9DFCS","name":"setTint","brief":"","scope":"instance","type":"MethodDoc","description":"set a coloring tint for sprite based renderables
","params":[{"identifier":"tint","optional":false,"description":"the tint color
","dataType":{"tokens":[{"value":"Color","kind":"canonical"},{"value":"Color","kind":"link"}],"template":"%1"}},{"identifier":"alpha","optional":true,"description":"an alpha value to be applied to the tint
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"AkyQp50aKASIJtOgG1OHL","name":"setTransform","brief":"","scope":"instance","type":"MethodDoc","description":"Reset (overrides) the renderer transformation matrix to the\nidentity one, and then apply the given transformation matrix.
","params":[{"identifier":"a","optional":false,"description":"a matrix2d to transform by, or a the a component to multiply the current matrix by
","dataType":{"tokens":[{"value":"Matrix2d | number","kind":"canonical"},{"value":"Matrix2d","kind":"link"},{"value":"number","kind":"canonical"}],"template":"%1 | %2"}},{"identifier":"b","optional":false,"description":"the b component to multiply the current matrix by
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"c","optional":false,"description":"the c component to multiply the current matrix by
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"d","optional":false,"description":"the d component to multiply the current matrix by
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"e","optional":false,"description":"the e component to multiply the current matrix by
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"f","optional":false,"description":"the f component to multiply the current matrix by
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"uMM8mkWmvUZOfMq9RUpbt","name":"stroke","brief":"","scope":"instance","type":"MethodDoc","description":"stroke the given shape or the current defined path
","params":[{"identifier":"shape","optional":true,"description":"a shape object to stroke
","dataType":{"tokens":[{"value":"Rect | RoundRect | Polygon | Line | Ellipse","kind":"canonical"},{"value":"Rect","kind":"link"},{"value":"RoundRect","kind":"link"},{"value":"Polygon","kind":"link"},{"value":"Line","kind":"link"},{"value":"Ellipse","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5"}},{"identifier":"fill","optional":true,"default":"false","description":"fill the shape with the current color if true
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"0AHUGzMjswLTy32vm9AY_","name":"strokeArc","brief":"","scope":"instance","type":"MethodDoc","description":"Stroke an arc at the specified coordinates with given radius, start and end points
","params":[{"identifier":"x","optional":false,"description":"arc center point x-axis
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"arc center point y-axis
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"radius","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"start","optional":false,"description":"start angle in radians
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"end","optional":false,"description":"end angle in radians
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"antiClockwise","optional":true,"default":"false","description":"draw arc anti-clockwise
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}},{"identifier":"fill","optional":true,"default":"false","description":"also fill the shape with the current color if true
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"st1r_OWHjSY6Ao-cNUW65","name":"strokeEllipse","brief":"","scope":"instance","type":"MethodDoc","description":"Stroke an ellipse at the specified coordinates with given radius
","params":[{"identifier":"x","optional":false,"description":"ellipse center point x-axis
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"ellipse center point y-axis
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"w","optional":false,"description":"horizontal radius of the ellipse
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"h","optional":false,"description":"vertical radius of the ellipse
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"fill","optional":true,"default":"false","description":"also fill the shape with the current color if true
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"OH3vxM0azbnycyKJjj636","name":"strokeLine","brief":"","scope":"instance","type":"MethodDoc","description":"Stroke a line of the given two points
","params":[{"identifier":"startX","optional":false,"description":"the start x coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"startY","optional":false,"description":"the start y coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"endX","optional":false,"description":"the end x coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"endY","optional":false,"description":"the end y coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"fj6VFFRDESX8AJpiWbUkF","name":"strokePoint","brief":"","scope":"instance","type":"MethodDoc","description":"Stroke a Point at the specified coordinates
","params":[{"identifier":"x","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"FqVTTec8vCwFuQnFzbhFc","name":"strokePolygon","brief":"","scope":"instance","type":"MethodDoc","description":"Stroke the given me.Polygon on the screen
","params":[{"identifier":"poly","optional":false,"description":"the shape to draw
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}},{"identifier":"fill","optional":true,"default":"false","description":"also fill the shape with the current color if true
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"pzafQM66EO9-8Co6cg1R2","name":"strokeRect","brief":"","scope":"instance","type":"MethodDoc","description":"Stroke a rectangle at the specified coordinates
","params":[{"identifier":"x","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"width","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"height","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"fill","optional":true,"default":"false","description":"also fill the shape with the current color if true
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"ZAWXHJi6ls7l8P2960Vsv","name":"strokeRoundRect","brief":"","scope":"instance","type":"MethodDoc","description":"Stroke a rounded rectangle at the specified coordinates
","params":[{"identifier":"x","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"width","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"height","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"radius","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"fill","optional":true,"default":"false","description":"also fill the shape with the current color if true
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"mEFoh08o5-OzH4nGwdF_v","name":"tint","brief":"","scope":"instance","type":"MethodDoc","description":"tint the given image or canvas using the given color
","params":[{"identifier":"src","optional":false,"description":"the source image to be tinted
","dataType":{"tokens":[{"value":"HTMLImageElement | HTMLCanvasElement | OffscreenCanvas","kind":"canonical"},{"value":"HTMLImageElement","kind":"canonical"},{"value":"HTMLCanvasElement","kind":"canonical"},{"value":"OffscreenCanvas","kind":"canonical"}],"template":"%1 | %2 | %3"}},{"identifier":"color","optional":false,"description":"the color that will be used to tint the image
","dataType":{"tokens":[{"value":"Color | string","kind":"canonical"},{"value":"Color","kind":"link"}],"template":"%1 | string"}},{"identifier":"mode","optional":true,"default":"\"multiply\"","description":"the composition mode used to tint the image
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"returns":[{"description":"a new canvas element representing the tinted image
","dataType":{"tokens":[{"value":"HTMLCanvasElement | OffscreenCanvas","kind":"canonical"},{"value":"HTMLCanvasElement","kind":"canonical"},{"value":"OffscreenCanvas","kind":"canonical"}],"template":"%1 | %2"}}],"extends":[],"implements":[]},{"id":"8tzHFrFSq-Xk-d4RJZWGZ","name":"toBlob","brief":"","examples":[{"caption":"","code":"renderer.convertToBlob().then((blob) => console.log(blob));"}],"scope":"instance","type":"MethodDoc","description":"creates a Blob object representing the last rendered frame
","params":[{"identifier":"type","optional":true,"default":"\"image/png\"","description":"A string indicating the image format
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"quality","optional":true,"description":"A Number between 0 and 1 indicating the image quality to be used when creating images using file formats that support loss...","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"
A Promise returning a Blob object representing the last rendered frame
","dataType":{"tokens":[{"value":"Promise","kind":"canonical"},{"value":"Promise","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Fm2F_iDO-oiZIHetWTPlJ","name":"toDataURL","brief":"","examples":[{"caption":"","code":"renderer.toDataURL().then((dataURL) => console.log(dataURL));"}],"scope":"instance","type":"MethodDoc","description":"returns a data URL containing a representation of the last frame rendered
","params":[{"identifier":"type","optional":true,"default":"\"image/png\"","description":"A string indicating the image format
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"quality","optional":true,"description":"A Number between 0 and 1 indicating the image quality to be used when creating images using file formats that support loss...","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"
A Promise returning a string containing the requested data URL.
","dataType":{"tokens":[{"value":"Promise","kind":"canonical"},{"value":"Promise","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"uevni4pGP2y0Gp4Kjzm2T","name":"toImageBitmap","brief":"","examples":[{"caption":"","code":"renderer.transferToImageBitmap().then((image) => console.log(image));"}],"scope":"instance","type":"MethodDoc","description":"creates an ImageBitmap object of the last frame rendered\n(not supported by standard Canvas)
","params":[{"identifier":"type","optional":true,"default":"\"image/png\"","description":"A string indicating the image format
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"quality","optional":true,"description":"A Number between 0 and 1 indicating the image quality to be used when creating images using file formats that support loss...","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"
A Promise returning an ImageBitmap.
","dataType":{"tokens":[{"value":"Promise","kind":"canonical"},{"value":"Promise","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"j1_aYnEhh-QJyf07TW22F","name":"transform","brief":"","scope":"instance","see":["{@link CanvasRenderer.setTransform} which will reset the current transform matrix prior to performing the new transformation"],"type":"MethodDoc","description":"Multiply given matrix into the renderer tranformation matrix
","params":[{"identifier":"a","optional":false,"description":"a matrix2d to transform by, or a the a component to multiply the current matrix by
","dataType":{"tokens":[{"value":"Matrix2d | number","kind":"canonical"},{"value":"Matrix2d","kind":"link"},{"value":"number","kind":"canonical"}],"template":"%1 | %2"}},{"identifier":"b","optional":false,"description":"the b component to multiply the current matrix by
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"c","optional":false,"description":"the c component to multiply the current matrix by
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"d","optional":false,"description":"the d component to multiply the current matrix by
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"e","optional":false,"description":"the e component to multiply the current matrix by
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"f","optional":false,"description":"the f component to multiply the current matrix by
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"J0rD5W3TukJXrtI-u3s92","name":"translate","brief":"","scope":"instance","type":"MethodDoc","description":"adds a translation transformation to the current matrix.
","params":[{"identifier":"x","optional":false,"description":"Distance to move in the horizontal direction. Positive values are to the right, and negative to the left.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"Distance to move in the vertical direction. Positive values are down, and negative are up.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]}]},{"id":"IIuOWAKkrbp5Y35B7i7Jc","name":"CanvasTexture","brief":"","type":"ClassDoc","description":"Creates a Canvas Texture of the given size\n(when using WebGL, use invalidate to force a reupload of the corre...","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"Ovijg-hCF-PWFVDO-lZ-s","name":"canvas","brief":"","scope":"instance","type":"PropertyDoc","description":"
the canvas created for this CanvasTexture
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"IXxj3q4C8z60L03rfRncf","name":"context","brief":"","scope":"instance","type":"PropertyDoc","description":"the rendering context of this CanvasTexture
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"KUNwYXNhltu7nOmKQXIKY","name":"height","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"The height of this canvas texture in pixels
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"c1PBZJ0tPKuaaJaByfsnh","name":"width","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"The width of this canvas texture in pixels
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"AP6pTyjBONwPbp_tH8vnt","name":"clear","brief":"Clears the content of the canvas texture
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"gbbfbcJVHn0P_MzfgQj6i","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"width","optional":false,"description":"the desired width of the canvas
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"height","optional":false,"description":"the desired height of the canvas
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"attributes","optional":false,"description":"The attributes to create both the canvas and context
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}},{"identifier":"attributes.context","optional":true,"default":"\"2d\"","description":"the context type to be created ("2d", "webgl", "webgl2")
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}},{"identifier":"attributes.offscreenCanvas","optional":true,"default":"false","description":"will create an offscreenCanvas if true instead of a standard canvas
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}},{"identifier":"attributes.willReadFrequently","optional":true,"default":"false","description":"Indicates whether or not a lot of read-back operations are planned
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}},{"identifier":"attributes.antiAlias","optional":true,"default":"false","description":"Whether to enable anti-aliasing, use false (default) for a pixelated effect.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"yiAbH3F9qE9NnKMqWgQ-P","name":"getImageData","brief":"","scope":"instance","type":"MethodDoc","description":"Returns an ImageData object representing the underlying pixel data for a specified portion of this canvas texture.\n(Note: ...","params":[{"identifier":"x","optional":false,"description":"
The x-axis coordinate of the top-left corner of the rectangle from which the ImageData will be extracted
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"The y-axis coordinate of the top-left corner of the rectangle from which the ImageData will be extracted
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"width","optional":false,"description":"The width of the rectangle from which the ImageData will be extracted. Positive values are to the right, and negative to t...","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"height","optional":false,"description":"
The height of the rectangle from which the ImageData will be extracted. Positive values are down, and negative are up
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"The ImageData extracted from this CanvasTexture.
","dataType":{"tokens":[{"value":"ImageData","kind":"canonical"},{"value":"ImageData","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"-2z4w03KTtoFLvdkdQPWZ","name":"invalidate","brief":"","scope":"instance","type":"MethodDoc","description":"invalidate the current CanvasTexture, and force a reupload of the corresponding texture\n(call this if you modify the canva...","params":[{"identifier":"renderer","optional":false,"description":"
the renderer to which this canvas texture is attached
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"yObF2AHWY9JQ0HBQMV9kn","name":"resize","brief":"","scope":"instance","type":"MethodDoc","description":"Resizes the canvas texture to the given width and height.
","params":[{"identifier":"width","optional":false,"description":"the desired width
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"height","optional":false,"description":"the desired height
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"UwgsQk9Bsknzr2i3cnbZz","name":"setAntiAlias","brief":"","scope":"instance","type":"MethodDoc","description":"enable/disable image smoothing (scaling interpolation)
","params":[{"identifier":"enable","optional":true,"default":"false","description":"whether to enable or not image smoothing (scaling interpolation)
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"3YnPNONrkR4CcbhSenae1","name":"toBlob","brief":"","examples":[{"caption":"","code":"canvasTexture.convertToBlob().then((blob) => console.log(blob));"}],"scope":"instance","type":"MethodDoc","description":"creates a Blob object representing the image contained in this canvas texture
","params":[{"identifier":"type","optional":true,"default":"\"image/png\"","description":"A string indicating the image format
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"quality","optional":true,"description":"A Number between 0 and 1 indicating the image quality to be used when creating images using file formats that support loss...","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"
A Promise returning a Blob object representing the image contained in this canvas texture
","dataType":{"tokens":[{"value":"Promise","kind":"canonical"},{"value":"Promise","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"DYt9UY052LSEz-_eXEdpX","name":"toDataURL","brief":"","examples":[{"caption":"","code":"renderer.toDataURL().then((dataURL) => console.log(dataURL));"}],"scope":"instance","type":"MethodDoc","description":"returns a data URL containing a representation of the most recently rendered image of this canvas texture\n(not supported b...","params":[{"identifier":"type","optional":true,"default":"\"image/png\"","description":"
A string indicating the image format
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"quality","optional":true,"description":"A Number between 0 and 1 indicating the image quality to be used when creating images using file formats that support loss...","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"
A Promise returning a string containing the requested data URL.
","dataType":{"tokens":[{"value":"Promise","kind":"canonical"},{"value":"Promise","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"vQYGlebPfK9dKlrmYIRUh","name":"toImageBitmap","brief":"","examples":[{"caption":"","code":"canvasTexture.transferToImageBitmap().then((bitmap) => console.log(bitmap));"}],"scope":"instance","type":"MethodDoc","description":"creates an ImageBitmap object from the most recently rendered image of this canvas texture
","params":[{"identifier":"type","optional":true,"default":"\"image/png\"","description":"A string indicating the image format
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"quality","optional":true,"description":"A Number between 0 and 1 indicating the image quality to be used when creating images using file formats that support loss...","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"
A Promise returning an ImageBitmap.
","dataType":{"tokens":[{"value":"Promise","kind":"canonical"},{"value":"Promise","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]}]},{"id":"M1cyBgGiYY52DittDS3KE","name":"Collectable","brief":"","type":"ClassDoc","description":"a basic collectable helper class for immovable object (e.g. a coin)
","params":[],"returns":[],"extends":["Sprite"],"implements":[],"members":[{"id":"SJur87T8qkBZmjWn6I6Xg","name":"alpha","brief":"","defaultValue":"1.0","scope":"instance","see":["Renderable#setOpacity","Renderable#getOpacity"],"type":"PropertyDoc","description":"Define the renderable opacity
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"QZUbzkEfx6l5732GQxrcM","name":"alwaysUpdate","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object will always update, even when outside of the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"XcnegLNvj6HNz3J4fjP-D","name":"ancestor","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"a reference to the parent object that contains this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"wnBQRd75ksonF_Xh2zrPe","name":"anchorPoint","brief":"","defaultValue":"<0.5,0.5>","scope":"instance","type":"PropertyDoc","description":"The anchor point is used for attachment behavior, and/or when applying transformations.
animation cycling speed (delay between frame in ms)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"kxBZ7ns2qmGz9JaN4ptCw","name":"autoTransform","brief":"","defaultValue":"true","examples":[{"caption":"","code":"// enable \"automatic\" transformation when the object is activated\nonActivateEvent: function () {\n // reset the transformation matrix\n this.currentTransform.identity();\n // ensure the anchor point is the renderable center\n this.anchorPoint.set(0.5, 0.5);\n // enable auto transform\n this.autoTransform = true;\n ....\n}"}],"scope":"instance","type":"PropertyDoc","description":"When enabled, an object container will automatically apply\nany defined transformation before calling the child draw method...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"mqDISEF2jWTBW6RRnCxRS","name":"blendMode","brief":"","defaultValue":"\"normal\"","scope":"instance","see":["CanvasRenderer#setBlendMode","WebGLRenderer#setBlendMode"],"type":"PropertyDoc","description":"
the blend mode to be applied to this renderable (see renderer setBlendMode for available blend mode)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"DuKGvzAcbG760gbqbNp_F","name":"body","brief":"","examples":[{"caption":"","code":" // define a new Player Class\n class PlayerEntity extends me.Sprite {\n // constructor\n constructor(x, y, settings) {\n // call the parent constructor\n super(x, y , settings);\n\n // define a basic walking animation\n this.addAnimation(\"walk\", [...]);\n // define a standing animation (using the first frame)\n this.addAnimation(\"stand\", [...]);\n // set the standing animation as default\n this.setCurrentAnimation(\"stand\");\n\n // add a physic body\n this.body = new me.Body(this);\n // add a default collision shape\n this.body.addShape(new me.Rect(0, 0, this.width, this.height));\n // configure max speed, friction, and initial force to be applied\n this.body.setMaxVelocity(3, 15);\n this.body.setFriction(0.4, 0);\n this.body.force.set(3, 0);\n this.isKinematic = false;\n\n // set the display to follow our position on both axis\n me.game.viewport.follow(this.pos, me.game.viewport.AXIS.BOTH);\n }\n\n ...\n\n }"}],"scope":"instance","type":"PropertyDoc","description":"the renderable physic body
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"BEq7_Iz-mVlluZ1uYiTzc","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"dNRdH7vetVI4xwkGv0Dyi","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"x7paSDzP9J9FDFh5yvNkR","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"LFJLE0FRUhv0iIfoDOnva","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"xAo8N6BqXM5wQw_FfZEoW","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"lKTpeIReDJrKu5GCiAiDv","name":"floating","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"If true, this renderable will be rendered using screen coordinates,\nas opposed to world coordinates. Use this, for example...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"iOzukRlbna03CMY94G676","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"
(G)ame (U)nique (Id)entifier"
height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"kkFqH79kQz-lakzO0OJYg","name":"inViewport","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object is visible and within the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ZvcVjb7PU4hXlWs1D6f1_","name":"isDirty","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"when true the renderable will be redrawn during the next update cycle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"skb0df6pnUQ4Bbh7c4LgL","name":"isFlippedX","brief":"","access":"public","scope":"instance","see":["Renderable#flipX"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Hol8pQv8Da8R5KRdC0Gvx","name":"isFlippedY","brief":"","access":"public","scope":"instance","see":["Renderable#flipY"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"zFi_cnyaNo0DcqUIQiGfy","name":"isFloating","brief":"","scope":"instance","see":["Renderable#floating"],"type":"PropertyDoc","description":"Whether the renderable object is floating (i.e. used screen coordinates), or contained in a floating parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ben8x-YyJpZqsRSPwLPrC","name":"isKinematic","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"If true then physic collision and input events will not impact this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"UAcz9qowj9olydpfhiLx-","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"qnxkH9GfJR6g6044XeFsb","name":"isVideo","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"true if this is a video sprite (e.g. a HTMLVideoElement was passed as as source)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"SOcIUDcoSmRtCbnhX4A_G","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"dnrCDgTQPDIdLBimVl-RQ","name":"mask","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"// apply a mask in the shape of a Star\nmyNPCSprite.mask = new me.Polygon(myNPCSprite.width / 2, 0, [\n // draw a star\n {x: 0, y: 0},\n {x: 14, y: 30},\n {x: 47, y: 35},\n {x: 23, y: 57},\n {x: 44, y: 90},\n {x: 0, y: 62},\n {x: -44, y: 90},\n {x: -23, y: 57},\n {x: -47, y: 35},\n {x: -14, y: 30}\n]);"}],"scope":"instance","type":"PropertyDoc","description":"A mask limits rendering elements to the shape and position of the given mask object.\nSo, if the renderable is larger than ...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Yx2N84rISR6Mg9s5mpxA5","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"7VA6xqPhJFlH2caHw0hZ7","name":"offset","brief":"","defaultValue":"<0.0,0.0>","scope":"instance","type":"PropertyDoc","description":"global offset for the position to draw from on the source image.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"D9gfTEnfsVkpWh3sSFexT","name":"onVisibilityChange","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"this.onVisibilityChange = function(inViewport) {\n if (inViewport === true) {\n console.log(\"object has entered the in a camera viewport!\");\n }\n};"}],"scope":"instance","type":"PropertyDoc","description":"an event handler that is called when the renderable leave or enter a camera viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"fc721C1qxzkH38e1GAfL3","name":"parentApp","brief":"","scope":"instance","type":"PropertyDoc","description":"returns the parent application (or game) to which this renderable is attached to
","params":[],"returns":[{"description":"the parent application or undefined if not attached to any container/app
","dataType":{"tokens":[{"value":"Application","kind":"canonical"},{"value":"Application","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"zFlSP04Djs8pOFXa70pAs","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"kKzQ-VBm4fqwLLLK8cgQo","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"lvrmKZ6HEqwz9Jdbm28FG","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"G7A709VYYQh2Wb0OZqaWq","name":"shader","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"(Experimental) an optional shader, to be used instead of the default built-in one, when drawing this renderable (WebGL onl...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"kLXK7QqucpaYYkPsxCdR1","name":"source","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"
The source texture object this sprite object is using
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"-LY4msbcyBY5Hjr91Vra_","name":"tint","brief":"","defaultValue":"(255, 255, 255)","examples":[{"caption":"","code":"// add a red tint to this renderable\nthis.tint.setColor(255, 128, 128);\n// remove the tint\nthis.tint.setColor(255, 255, 255);"}],"scope":"instance","type":"PropertyDoc","description":"define a tint for this renderable. a (255, 255, 255) r, g, b value will remove the tint effect.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"m2dV-6Gyd2azdmd2Imv6G","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"zfoiAi0b4VvuTNUAG4qiS","name":"type","brief":"","defaultValue":"\"Rectangle\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"esva6nL7Jy73aXAbvhjgc","name":"updateWhenPaused","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether to update this object when the game is paused.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"TSHyKCwsU0zT6XPWtSMfX","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"z9sgjLi2x1EtKsHCh9L2l","name":"addAnimation","brief":"","examples":[{"caption":"","code":"// walking animation\nthis.addAnimation(\"walk\", [ 0, 1, 2, 3, 4, 5 ]);\n// standing animation\nthis.addAnimation(\"stand\", [ 11, 12 ]);\n// eating animation\nthis.addAnimation(\"eat\", [ 6, 6 ]);\n// rolling animation\nthis.addAnimation(\"roll\", [ 7, 8, 9, 10 ]);\n// slower animation\nthis.addAnimation(\"roll\", [ 7, 8, 9, 10 ], 200);\n// or get more specific with delay for each frame. Good solution instead of repeating:\nthis.addAnimation(\"turn\", [{ name: 0, delay: 200 }, { name: 1, delay: 100 }])\n// can do this with atlas values as well:\nthis.addAnimation(\"turn\", [{ name: \"turnone\", delay: 200 }, { name: \"turntwo\", delay: 100 }])\n// define an dying animation that stop on the last frame\nthis.addAnimation(\"die\", [{ name: 3, delay: 200 }, { name: 4, delay: 100 }, { name: 5, delay: Infinity }])\n// set the standing animation as default\nthis.setCurrentAnimation(\"stand\");"}],"scope":"instance","see":["Sprite#animationspeed"],"type":"MethodDoc","description":"add an animation
animation id
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"index","optional":false,"description":"list of sprite index or name defining the animation. Can also use objects to specify delay for each frame, see below
","dataType":{"tokens":[{"value":"Array | Array | Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"}],"template":"%1<%2> | %3 | %4"}},{"identifier":"animationspeed","optional":true,"description":"cycling speed for animation in ms
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"frame amount of frame added to the animation (delay between each frame).
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"7Y1fVZsJm8pmmWZA8YHqz","name":"angleTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the angle to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"angle in radians
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"upq2aXlIM-XJgpWKPXyPm","name":"centerOn","brief":"","scope":"instance","type":"MethodDoc","description":"center the rectangle position around the given coordinates
","params":[{"identifier":"x","optional":false,"description":"the x coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"79g4uLqDQzwjGWcUEB3ML","name":"clone","brief":"","scope":"instance","type":"MethodDoc","description":"clone this rectangle
","params":[],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"OlhFH6hUzsFbASu5X9Y0r","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"x","optional":false,"description":"the x coordinates of the collectable
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y coordinates of the collectable
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings","optional":false,"description":"See {@link Sprite}
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}}],"returns":[],"extends":[],"implements":[]},{"id":"sfsOndnVpAfp1KGNvtL6g","name":"contains","brief":"","examples":[{"caption":"","code":"if (rect.contains(10, 10)) {\n // do something\n}\n// or\nif (rect.contains(myVector2d)) {\n // do something\n}\nif (rect.contains(myRect)) {\n // do something\n}"}],"scope":"instance","type":"MethodDoc","description":"Returns true if the rectangle contains the given point or rectangle
","params":[{"identifier":"x","description":"x coordinate or a vector point, or a rectangle to test
","dataType":{"tokens":[{"value":"number | Vector2d | Rect","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Rect","kind":"link"}],"template":"%1 | %2 | %3"}},{"identifier":"y","optional":true,"description":"y coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"True if the rectangle contain the given point or rectangle, otherwise false
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"Xjw7NlRsD34hNgJVDdCAU","name":"copy","brief":"","scope":"instance","type":"MethodDoc","description":"copy the position and size of the given rectangle into this one
","params":[{"identifier":"rect","optional":false,"description":"Source rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"cMWMZH3ANozbuX9sZIQPX","name":"distanceTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the distance to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"distance
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"znzH1MElWFAwy1h32oAOz","name":"equals","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is identical to the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if equals
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"U-s22sxiPCDev7knbvAHP","name":"flicker","brief":"","examples":[{"caption":"","code":"// make the object flicker for 1 second\n// and then remove it\nthis.flicker(1000, function () {\n world.removeChild(this);\n});"}],"scope":"instance","type":"MethodDoc","description":"make the object flicker
","params":[{"identifier":"duration","optional":false,"description":"expressed in milliseconds
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"callback","optional":false,"description":"Function to call when flickering ends
","dataType":{"tokens":[{"value":"Function","kind":"canonical"}],"template":"Function"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Sprite","kind":"canonical"},{"value":"Sprite","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"t38jZ7clNm9pWLIuad0sf","name":"flipX","brief":"","scope":"instance","see":["Matrix2d#scaleX"],"type":"MethodDoc","description":"flip the renderable on the horizontal axis (around the center of the renderable)
","params":[{"identifier":"flip","optional":true,"default":"true","description":"true to flip this renderable.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"6kdyBHrVXJxhzyNlf8adN","name":"flipY","brief":"","scope":"instance","see":["Matrix2d#scaleY"],"type":"MethodDoc","description":"flip the renderable on the vertical axis (around the center of the renderable)
","params":[{"identifier":"flip","optional":true,"default":"true","description":"true to flip this renderable.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"46BdifImxdHEsIl1-cTUr","name":"getAbsolutePosition","brief":"","scope":"instance","type":"MethodDoc","description":"return the renderable absolute position in the game world
","params":[],"returns":[{"dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"7FQHBwhvHlzhZ1lJCY-v2","name":"getBounds","brief":"","scope":"instance","type":"MethodDoc","description":"returns the bounding box for this renderable
","params":[],"returns":[{"description":"bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"5Kf_dbK0ODru9gjTpYl_q","name":"getCurrentAnimationFrame","brief":"","scope":"instance","type":"MethodDoc","description":"return the current animation frame index.
","params":[],"returns":[{"description":"current animation frame index
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"OEpEza3ZdWFgmMzTorcWh","name":"getIndices","brief":"","scope":"instance","type":"MethodDoc","description":"returns a list of indices for all triangles defined in this polygon
","params":[],"returns":[{"description":"an array of vertex indices for all triangles forming this polygon.
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1<%2>"}}],"extends":[],"implements":[]},{"id":"sAip7hOTHI3TLWrdE1ERm","name":"getOpacity","brief":"","scope":"instance","type":"MethodDoc","description":"get the renderable alpha channel value
","params":[],"returns":[{"description":"current opacity value between 0 and 1
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"qFZLvPA4sdOAuCCctQ-k_","name":"isConvex","brief":"","scope":"instance","type":"MethodDoc","description":"Returns true if the vertices composing this polygon form a convex shape (vertices must be in clockwise order).
","params":[],"returns":[{"description":"true if the vertices are convex, false if not, null if not computable
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"SpPUd05IeO5DHp1qC-DI2","name":"isCurrentAnimation","brief":"","examples":[{"caption":"","code":"if (!this.isCurrentAnimation(\"walk\")) {\n // do something funny...\n}"}],"scope":"instance","type":"MethodDoc","description":"return true if the specified animation is the current one.
","params":[{"identifier":"name","optional":false,"description":"animation id
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"returns":[{"dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"rpqubhV-sMWXtyd34En2V","name":"isFinite","brief":"","scope":"instance","type":"MethodDoc","description":"determines whether all coordinates of this rectangle are finite numbers.
","params":[],"returns":[{"description":"false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"I6MB9075zY7QCFAW3XZlG","name":"isFlickering","brief":"","scope":"instance","type":"MethodDoc","description":"return the flickering state of the object
","params":[],"returns":[{"dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"J3lA41JQ30XlhQFZvf126","name":"lookAt","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this renderable towards the given target.
","params":[{"identifier":"target","optional":false,"description":"the renderable or position to look at
","dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Uv05AqC7xe4gdHHEmZAZ8","name":"onCollision","brief":"","examples":[{"caption":"","code":"// colision handler\nonCollision(response) {\n if (response.b.body.collisionType === me.collision.types.ENEMY_OBJECT) {\n // makes the other object solid, by substracting the overlap vector to the current position\n this.pos.sub(response.overlapV);\n this.hurt();\n // not solid\n return false;\n }\n // Make the object solid\n return true;\n},"}],"scope":"instance","type":"MethodDoc","description":"onCollision callback, triggered in case of collision,\nwhen this renderable body is colliding with another one
","params":[{"identifier":"response","optional":false,"description":"the collision response object
","dataType":{"tokens":[{"value":"ResponseObject","kind":"canonical"},{"value":"ResponseObject","kind":"link"}],"template":"%1"}},{"identifier":"other","optional":false,"description":"the other renderable touching this one (a reference to response.a or response.b)
","dataType":{"tokens":[{"value":"Renderable | Container | Entity | Sprite | NineSliceSprite","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Container","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"NineSliceSprite","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5"}}],"returns":[{"description":"true if the object should respond to the collision (its position and velocity will be corrected)
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"1AsTFKL4Bv0DFMJAHN9PS","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"OnDestroy Notification function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"7G7YglkxwayxXnp-UvBcU","name":"overlaps","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is intersecting with the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if overlaps
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"iEKtRbLTu0xJL260tV_px","name":"pause","brief":"play or resume the current animation or video
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"hVVVZSSxsTa2KAlo-pA1I","name":"play","brief":"play or resume the current animation or video
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"fiQm5m4tqXasrXOtLFSg6","name":"postDraw","brief":"","scope":"instance","see":["Renderable#preDraw","Renderable#draw"],"type":"MethodDoc","description":"restore the rendering context after drawing (automatically called by melonJS).
","params":[{"identifier":"renderer","optional":false,"description":"a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"c4I5fsU8MXzl3b5O-9coa","name":"preDraw","brief":"","scope":"instance","see":["Renderable#draw","Renderable#postDraw"],"type":"MethodDoc","description":"Prepare the rendering context before drawing (automatically called by melonJS).\nThis will apply any defined transforms, an...","params":[{"identifier":"renderer","optional":false,"description":"
a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"Ls1RrBsirxZgXohknygqI","name":"recalc","brief":"","scope":"instance","type":"MethodDoc","description":"Computes the calculated collision polygon.\nThis must be called if the points array, an...","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"FYx5hPpn6qAbO-Nv53Z2D","name":"resize","brief":"","scope":"instance","type":"MethodDoc","description":"resize the rectangle
","params":[{"identifier":"w","optional":false,"description":"new width of the rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"h","optional":false,"description":"new height of the rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"6UtRIo7XYYXF4B5xDPdLV","name":"reverseAnimation","brief":"","scope":"instance","see":["Sprite#animationspeed"],"type":"MethodDoc","description":"reverse the given or current animation if none is specified
","params":[{"identifier":"name","optional":true,"description":"animation id
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Sprite","kind":"canonical"},{"value":"Sprite","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"v68n3dsNUlrSf51-wdQaL","name":"rotate","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this renderable by the specified angle (in radians).
","params":[{"identifier":"angle","optional":false,"description":"The angle to rotate (in radians)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":true,"description":"an optional point to rotate around
","dataType":{"tokens":[{"value":"Vector2d | ObservableVector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"4k8yWTHtOVuKTIxCd3DkW","name":"scale","brief":"","scope":"instance","type":"MethodDoc","description":"scale the renderable around his anchor point. Scaling actually applies changes\nto the currentTransform member wich is use...","params":[{"identifier":"x","optional":false,"description":"
a number representing the abscissa of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":true,"default":"x","description":"a number representing the ordinate of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"O9kURtVdlr8c42UIgMA2K","name":"scaleV","brief":"","scope":"instance","type":"MethodDoc","description":"scale the renderable around his anchor point
","params":[{"identifier":"v","optional":false,"description":"scaling vector
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Z74fVSuNmcy1i1kW916gr","name":"setAnimationFrame","brief":"","examples":[{"caption":"","code":"// reset the current animation to the first frame\nthis.setAnimationFrame();"}],"scope":"instance","type":"MethodDoc","description":"force the current animation frame index.
","params":[{"identifier":"index","optional":true,"default":"0","description":"animation frame index
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Sprite","kind":"canonical"},{"value":"Sprite","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"zAlrZXWrsTfewruuO6cr2","name":"setCurrentAnimation","brief":"","examples":[{"caption":"","code":" // set \"walk\" animation\n this.setCurrentAnimation(\"walk\");\n\n // set \"walk\" animation if it is not the current animation\n if (this.isCurrentAnimation(\"walk\")) {\n this.setCurrentAnimation(\"walk\");\n }\n\n // set \"eat\" animation, and switch to \"walk\" when complete\n this.setCurrentAnimation(\"eat\", \"walk\");\n\n // set \"die\" animation, and remove the object when finished\n this.setCurrentAnimation(\"die\", () => {\n world.removeChild(this);\n return false; // do not reset to first frame\n });\n\n // set \"attack\" animation, and pause for a short duration\n this.setCurrentAnimation(\"die\", () => {\n this.animationpause = true;\n\n // back to \"standing\" animation after 1 second\n setTimeout(function () {\n this.setCurrentAnimation(\"standing\");\n }, 1000);\n\n return false; // do not reset to first frame\n });"}],"scope":"instance","type":"MethodDoc","description":"set the current animation\nthis will always change the animation & set the frame to zero
","params":[{"identifier":"name","optional":false,"description":"animation id
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"resetAnim","optional":true,"description":"animation id to switch to when complete, or callback
","dataType":{"tokens":[{"value":"string | Function","kind":"canonical"}],"template":"string | Function"}},{"identifier":"preserve_dt","optional":true,"default":"false","description":"if false will reset the elapsed time counter since last frame
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Sprite","kind":"canonical"},{"value":"Sprite","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"x3DUriZgkU8EgfcCHL3aQ","name":"setOpacity","brief":"","scope":"instance","type":"MethodDoc","description":"set the renderable alpha channel value
","params":[{"identifier":"alpha","optional":false,"description":"opacity value between 0.0 and 1.0
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"HJcld4o6G-2l0TTgME3t8","name":"setRegion","brief":"","examples":[{"caption":"","code":"// change the sprite to \"shadedDark13.png\";\nmySprite.setRegion(mytexture.getRegion(\"shadedDark13.png\"));"}],"scope":"instance","see":["Texture.getRegion"],"type":"MethodDoc","description":"change the current texture atlas region for this sprite
","params":[{"identifier":"region","optional":false,"description":"typically returned through me.Texture.getRegion()
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Sprite","kind":"canonical"},{"value":"Sprite","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Ttw7S69sA-bIclwCDb4J3","name":"setShape","brief":"","scope":"instance","type":"MethodDoc","description":"set new value to the rectangle shape
","params":[{"identifier":"x","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"w","optional":false,"description":"width of the rectangle, or an array of vector defining the rectangle
","dataType":{"tokens":[{"value":"number | Array","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %3<%2>"}},{"identifier":"h","optional":true,"description":"height of the rectangle, if a numeral width parameter is specified
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"CnQ1EPawKHhjReieDuj3p","name":"setVertices","brief":"","scope":"instance","type":"MethodDoc","description":"set the vertices defining this Polygon
","params":[{"identifier":"vertices","optional":false,"description":"array of vector or vertice defining the Polygon
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1<%2>"}}],"returns":[{"description":"this instance for objecf chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"6_L-pEADnw0l6HSfOKSmv","name":"shift","brief":"","examples":[{"caption":"","code":"polygon.shift(10, 10);\n// or\npolygon.shift(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"Shifts the Polygon to the given position vector.
","params":[{"identifier":"x","description":"x coordinate or a vector point to shift to
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"Nw2UMBTeFQ_CtbG2ytbCv","name":"to2d","brief":"","scope":"instance","type":"MethodDoc","description":"apply a 2d projection to this shapen
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"LPnVSlVA4Gr-rljHTVDH4","name":"toIso","brief":"","scope":"instance","type":"MethodDoc","description":"apply an isometric projection to this shape
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"6p4yOCD6sTQ1jk_PqNPZn","name":"toPolygon","brief":"","scope":"instance","type":"MethodDoc","description":"Returns a polygon whose edges are the same as this box.
","params":[],"returns":[{"description":"a new Polygon that represents this rectangle.
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"RT0b2qmAd0R6ja1aF4Ppc","name":"transform","brief":"","scope":"instance","see":["Renderable#currentTransform"],"type":"MethodDoc","description":"multiply the renderable currentTransform with the given matrix
","params":[{"identifier":"m","optional":false,"description":"the transformation matrix
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"SQIRdRWxT2gKI_RfRsTDZ","name":"translate","brief":"","examples":[{"caption":"","code":"polygon.translate(10, 10);\n// or\npolygon.translate(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"translate the Polygon by the specified offset
","params":[{"identifier":"x","description":"x offset or a vector point to translate by
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"description":"y offset
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"3FgZMlF28LYez0MsfZrfC","name":"union","brief":"","scope":"instance","type":"MethodDoc","description":"merge this rectangle with another one
","params":[{"identifier":"rect","optional":false,"description":"other rectangle to union with
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"the union(ed) rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"FQZJkhvl1-tGUfaAR7mei","name":"updateBounds","brief":"","scope":"instance","type":"MethodDoc","description":"update the bounding box for this shape.
","params":[{"identifier":"absolute","optional":true,"default":"true","description":"update the bounds size and position in (world) absolute coordinates
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"this shape bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"uhxY64uKlqwUxYp7Mbz7w","name":"draw","brief":"","access":"protected","scope":"instance","type":"MethodDoc","description":"draw this srite (automatically called by melonJS)
","params":[{"identifier":"renderer","optional":false,"description":"a renderer instance
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}},{"identifier":"viewport","optional":true,"description":"the viewport to (re)draw
","dataType":{"tokens":[{"value":"Camera2d","kind":"canonical"},{"value":"Camera2d","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"Od-6hJfiU1-IwCngPC0ph","name":"update","brief":"","access":"protected","scope":"instance","type":"MethodDoc","description":"update function.
","params":[{"identifier":"dt","optional":false,"description":"time since the last update in milliseconds.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"true if the Sprite is dirty
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"7eP1XFdIHACdmEdO3boaj","name":"onAnchorUpdate","brief":"","access":"private","scope":"instance","type":"MethodDoc","description":"called when the anchor point value is changed
","params":[{"identifier":"x","optional":false,"description":"the new X value to be set for the anchor
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the new Y value to be set for the anchor
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]}]},{"id":"o3QiuezWV2FixfXvGr6An","name":"Color","brief":"","type":"ClassDoc","description":"A color manipulation object.
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"SxkBck4iPwwEkp-vMbs6-","name":"alpha","brief":"","scope":"instance","type":"PropertyDoc","description":"Color Alpha Component [0.0 .. 1.0]
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Y-rGYOKjPa-Wm88FYcaDX","name":"b","brief":"","scope":"instance","type":"PropertyDoc","description":"Color Blue Component [0 .. 255]
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"yD-Iagy6PAKRrRL29TWpk","name":"g","brief":"","scope":"instance","type":"PropertyDoc","description":"Color Green Component [0 .. 255]
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"YvrUdpRSUZto-M79DYy-y","name":"r","brief":"","scope":"instance","type":"PropertyDoc","description":"Color Red Component [0 .. 255]
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"YpDDnoppaf1jKQ5PrwIY3","name":"add","brief":"","scope":"instance","type":"MethodDoc","description":"Blend this color with the given one using addition.
","params":[{"identifier":"color","optional":false,"dataType":{"tokens":[{"value":"Color","kind":"canonical"},{"value":"Color","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Color","kind":"canonical"},{"value":"Color","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"CQYY6xUVPpSr-1TYWG6xj","name":"clone","brief":"","scope":"instance","type":"MethodDoc","description":"Create a new copy of this color object.
","params":[],"returns":[{"description":"Reference to the newly cloned object
","dataType":{"tokens":[{"value":"Color","kind":"canonical"},{"value":"Color","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"uCVJ8KgpUczum-B9JsYLE","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"r","optional":true,"default":"0","description":"red component [0 .. 255]
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"g","optional":true,"default":"0","description":"green component [0 .. 255]
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"b","optional":true,"default":"0","description":"blue component [0 .. 255]
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"alpha","optional":true,"default":"1.0","description":"alpha value [0.0 .. 1.0]
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"xPn9auaT_NSJCTQasxUdu","name":"copy","brief":"","scope":"instance","type":"MethodDoc","description":"Copy a color object or CSS color into this one.
","params":[{"identifier":"color","optional":false,"dataType":{"tokens":[{"value":"Color | string","kind":"canonical"},{"value":"Color","kind":"link"}],"template":"%1 | string"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Color","kind":"canonical"},{"value":"Color","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"OV9x9ibnYnnO9YJ_xQuzG","name":"darken","brief":"","scope":"instance","type":"MethodDoc","description":"Darken this color value by 0..1
","params":[{"identifier":"scale","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Color","kind":"canonical"},{"value":"Color","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"M3QMzkqUrOiQm7FV8wcsy","name":"equals","brief":"","scope":"instance","type":"MethodDoc","description":"Return true if the r,g,b,a values of this color are equal with the\ngiven one.
","params":[{"identifier":"color","optional":false,"dataType":{"tokens":[{"value":"Color","kind":"canonical"},{"value":"Color","kind":"link"}],"template":"%1"}}],"returns":[{"dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"72xQriXpXmNDoUm1IuuWv","name":"lerp","brief":"","scope":"instance","type":"MethodDoc","description":"Linearly interpolate between this color and the given one.
","params":[{"identifier":"color","optional":false,"dataType":{"tokens":[{"value":"Color","kind":"canonical"},{"value":"Color","kind":"link"}],"template":"%1"}},{"identifier":"alpha","optional":false,"description":"with alpha = 0 being this color, and alpha = 1 being the given one.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Color","kind":"canonical"},{"value":"Color","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"2HlkZ26pU81cTGR0dkKAq","name":"lighten","brief":"","scope":"instance","type":"MethodDoc","description":"Lighten this color value by 0..1
","params":[{"identifier":"scale","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Color","kind":"canonical"},{"value":"Color","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"00J3aCaclPiFveowvCFHC","name":"parseCSS","brief":"","scope":"instance","type":"MethodDoc","description":"Parse a CSS color string and set this color to the corresponding\nr,g,b values
","params":[{"identifier":"cssColor","optional":false,"dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Color","kind":"canonical"},{"value":"Color","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"8WQ-jKYU08PBCEyJDScsw","name":"parseHex","brief":"","scope":"instance","type":"MethodDoc","description":"Parse a Hex color ("#RGB", "#RGBA" or "#RRGGBB", "#RRGGBBAA" format) and set this ...","params":[{"identifier":"hexColor","optional":false,"dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"argb ","optional":true,"default":" false","description":"
true if format is #ARGB, or #AARRGGBB (as opposed to #RGBA or #RGGBBAA)
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Color","kind":"canonical"},{"value":"Color","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"NxprQFvWuuL8dXmZ2orkO","name":"parseRGB","brief":"","scope":"instance","type":"MethodDoc","description":"Parse an RGB or RGBA CSS color string
","params":[{"identifier":"rgbColor","optional":false,"dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Color","kind":"canonical"},{"value":"Color","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"gSh2aGcUBEVaDI_wMhZcw","name":"random","brief":"","scope":"instance","type":"MethodDoc","description":"Generate random r,g,b values for this color object
","params":[{"identifier":"min","optional":true,"default":"0","description":"minimum value for the random range
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"max","optional":true,"default":"255","description":"maxmium value for the random range
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Color","kind":"canonical"},{"value":"Color","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"4vC_k4uQNk9JrFm45bQfm","name":"setColor","brief":"","scope":"instance","type":"MethodDoc","description":"Set this color to the specified value.
","params":[{"identifier":"r","optional":false,"description":"red component [0 .. 255]
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"g","optional":false,"description":"green component [0 .. 255]
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"b","optional":false,"description":"blue component [0 .. 255]
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"alpha","optional":true,"default":"1.0","description":"alpha value [0.0 .. 1.0]
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Color","kind":"canonical"},{"value":"Color","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"L7NLRNP1AWdtf2Y2fgDn1","name":"setFloat","brief":"","scope":"instance","type":"MethodDoc","description":"set this color to the specified normalized float values
","params":[{"identifier":"r","optional":false,"description":"red component [0.0 .. 1.0]
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"g","optional":false,"description":"green component [0.0 .. 1.0]
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"b","optional":false,"description":"blue component [0.0 .. 1.0]
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"alpha","optional":true,"default":"1.0","description":"alpha value [0.0 .. 1.0]
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Color","kind":"canonical"},{"value":"Color","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"BKLp7Nv5DQE-GYkdv24t1","name":"setHSL","brief":"","scope":"instance","type":"MethodDoc","description":"set this color to the specified HSL value
","params":[{"identifier":"h","optional":false,"description":"hue (a value from 0 to 1)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"s","optional":false,"description":"saturation (a value from 0 to 1)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"l","optional":false,"description":"lightness (a value from 0 to 1)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Color","kind":"canonical"},{"value":"Color","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"6iDk1zLa_YLMosAUZ43JI","name":"setHSV","brief":"","scope":"instance","type":"MethodDoc","description":"set this color to the specified HSV value
","params":[{"identifier":"h","optional":false,"description":"hue (a value from 0 to 1)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"s","optional":false,"description":"saturation (a value from 0 to 1)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":false,"description":"value (a value from 0 to 1)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Color","kind":"canonical"},{"value":"Color","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"VikodG1dv6cyO5JlzcXEu","name":"toArray","brief":"","scope":"instance","type":"MethodDoc","description":"return an Float Array representation of this object
","params":[],"returns":[{"dataType":{"tokens":[{"value":"Float32Array","kind":"canonical"},{"value":"Float32Array","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"PKgk9CVN4Z23ooRCMetuO","name":"toHex","brief":"","scope":"instance","type":"MethodDoc","description":"return the color in "#RRGGBB" format
","params":[],"returns":[{"dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"extends":[],"implements":[]},{"id":"D0CAuqfXDTUrvszt9gfvd","name":"toHex8","brief":"","scope":"instance","type":"MethodDoc","description":"Get the color in "#RRGGBBAA" format
","params":[{"identifier":"alpha","optional":false}],"returns":[{"dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"extends":[],"implements":[]},{"id":"pjpotqi_9FC3ADbR-TZFB","name":"toRGB","brief":"","scope":"instance","type":"MethodDoc","description":"Get the color in "rgb(R,G,B)" format
","params":[],"returns":[{"dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"extends":[],"implements":[]},{"id":"yQu8a9qF6H6TNZtkwhBtE","name":"toRGBA","brief":"","scope":"instance","type":"MethodDoc","description":"Get the color in "rgba(R,G,B,A)" format
","params":[{"identifier":"alpha","optional":true,"default":"1.0","description":"alpha value [0.0 .. 1.0]
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"extends":[],"implements":[]},{"id":"CSuzKXLkI5xreJ0lxnQ0B","name":"toUint32","brief":"","scope":"instance","type":"MethodDoc","description":"Pack this color RGB components into a Uint32 ARGB representation
","params":[{"identifier":"alpha","optional":true,"default":"1.0","description":"alpha value [0.0 .. 1.0]
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]}]},{"id":"nHgth83fkHeo0TCXlWCYc","name":"ColorLayer","brief":"","type":"ClassDoc","description":"a generic Color Layer Object. Fills the entire Canvas with the color not just the container the object belongs to.
","params":[],"returns":[],"extends":["Renderable"],"implements":[],"members":[{"id":"m4rWnSAjA2cnTrzcdO7tt","name":"alpha","brief":"","defaultValue":"1.0","scope":"instance","see":["Renderable#setOpacity","Renderable#getOpacity"],"type":"PropertyDoc","description":"Define the renderable opacity
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"1m5ykqWEvD8SzZy6KpB08","name":"alwaysUpdate","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object will always update, even when outside of the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Qc7HSm0WTKQjsiyIRMGAQ","name":"ancestor","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"a reference to the parent object that contains this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"UtuM76fpuKdhbkN3WEoFv","name":"anchorPoint","brief":"","defaultValue":"<0.5,0.5>","scope":"instance","type":"PropertyDoc","description":"The anchor point is used for attachment behavior, and/or when applying transformations.
When enabled, an object container will automatically apply\nany defined transformation before calling the child draw method...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"VnbExLs4_mZ57_PaBqY_Y","name":"blendMode","brief":"","defaultValue":"\"normal\"","scope":"instance","see":["CanvasRenderer#setBlendMode","WebGLRenderer#setBlendMode"],"type":"PropertyDoc","description":"
the blend mode to be applied to this renderable (see renderer setBlendMode for available blend mode)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"7bAMqlq61vHQRBdVwabzH","name":"body","brief":"","examples":[{"caption":"","code":" // define a new Player Class\n class PlayerEntity extends me.Sprite {\n // constructor\n constructor(x, y, settings) {\n // call the parent constructor\n super(x, y , settings);\n\n // define a basic walking animation\n this.addAnimation(\"walk\", [...]);\n // define a standing animation (using the first frame)\n this.addAnimation(\"stand\", [...]);\n // set the standing animation as default\n this.setCurrentAnimation(\"stand\");\n\n // add a physic body\n this.body = new me.Body(this);\n // add a default collision shape\n this.body.addShape(new me.Rect(0, 0, this.width, this.height));\n // configure max speed, friction, and initial force to be applied\n this.body.setMaxVelocity(3, 15);\n this.body.setFriction(0.4, 0);\n this.body.force.set(3, 0);\n this.isKinematic = false;\n\n // set the display to follow our position on both axis\n me.game.viewport.follow(this.pos, me.game.viewport.AXIS.BOTH);\n }\n\n ...\n\n }"}],"scope":"instance","type":"PropertyDoc","description":"the renderable physic body
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"s2TnE6Jw_XXENyQ55Jf0q","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"wZRheMG0w-Ib50rwTv9f0","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"WnVTsSZHl9VbW0-VSZW4m","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"LTARbOGllHaI_Q9D9hTqN","name":"color","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"the layer color component
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"WpaPE_hhcm0QoW8XMrQey","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"azAwWTS9fWsek04nok0b5","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"F12cOs56A5ZmzHS8UTuZ7","name":"floating","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"If true, this renderable will be rendered using screen coordinates,\nas opposed to world coordinates. Use this, for example...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Sy04NQceIe53OjQ0qfNJC","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"
(G)ame (U)nique (Id)entifier"
height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"hne4HAONCkxu4jzDYxbyX","name":"inViewport","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object is visible and within the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"iQRGKTDjoUMQWw2216miH","name":"isDirty","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"when true the renderable will be redrawn during the next update cycle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"-Iwk98znrWML90E5KA09Z","name":"isFlippedX","brief":"","access":"public","scope":"instance","see":["Renderable#flipX"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"QTWabJo8FQz4doG08Kw1D","name":"isFlippedY","brief":"","access":"public","scope":"instance","see":["Renderable#flipY"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"cotMwBHZuPoVKSkDu0QWq","name":"isFloating","brief":"","scope":"instance","see":["Renderable#floating"],"type":"PropertyDoc","description":"Whether the renderable object is floating (i.e. used screen coordinates), or contained in a floating parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"dHIpQrkVZRqKCf4pbZWmm","name":"isKinematic","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"If true then physic collision and input events will not impact this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"echol9zt0tck6TCfjFSiQ","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"8u2TVaHQFuHalRJ3FU55o","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"o0d3FjDR4w89rTBJGwZYH","name":"mask","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"// apply a mask in the shape of a Star\nmyNPCSprite.mask = new me.Polygon(myNPCSprite.width / 2, 0, [\n // draw a star\n {x: 0, y: 0},\n {x: 14, y: 30},\n {x: 47, y: 35},\n {x: 23, y: 57},\n {x: 44, y: 90},\n {x: 0, y: 62},\n {x: -44, y: 90},\n {x: -23, y: 57},\n {x: -47, y: 35},\n {x: -14, y: 30}\n]);"}],"scope":"instance","type":"PropertyDoc","description":"A mask limits rendering elements to the shape and position of the given mask object.\nSo, if the renderable is larger than ...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"lF0CkVAf6GvR3UHrqdSZ_","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"9FELwyVpdGL6eYRucAIfR","name":"onVisibilityChange","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"this.onVisibilityChange = function(inViewport) {\n if (inViewport === true) {\n console.log(\"object has entered the in a camera viewport!\");\n }\n};"}],"scope":"instance","type":"PropertyDoc","description":"an event handler that is called when the renderable leave or enter a camera viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"47FDb_MO9ZfmtXrDeZKyu","name":"parentApp","brief":"","scope":"instance","type":"PropertyDoc","description":"returns the parent application (or game) to which this renderable is attached to
","params":[],"returns":[{"description":"the parent application or undefined if not attached to any container/app
","dataType":{"tokens":[{"value":"Application","kind":"canonical"},{"value":"Application","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"fsCf1JYBX1lIjMt8K6-9e","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"yNMicH2vXycUmHea_h_ip","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"7rWCo85vuWfwuxHFCdzqp","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Uou8MDgdw4IabXUftOWfN","name":"shader","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"(Experimental) an optional shader, to be used instead of the default built-in one, when drawing this renderable (WebGL onl...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"49vv-1Z7Nr_-aTxaNI9X0","name":"tint","brief":"","defaultValue":"(255, 255, 255)","examples":[{"caption":"","code":"// add a red tint to this renderable\nthis.tint.setColor(255, 128, 128);\n// remove the tint\nthis.tint.setColor(255, 255, 255);"}],"scope":"instance","type":"PropertyDoc","description":"
define a tint for this renderable. a (255, 255, 255) r, g, b value will remove the tint effect.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"d6QtGW7CXgodFiQoJCOl1","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ZNGylIq2hrfNNUPlYn_mp","name":"type","brief":"","defaultValue":"\"Rectangle\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Cfk9KH6xv5lCryYQBYlmZ","name":"updateWhenPaused","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether to update this object when the game is paused.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"qGi7d2sLJ15ZLnRg7fHHN","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"wk7ycTwAcnbX-obzvCdra","name":"angleTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the angle to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"angle in radians
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"XJKo59aBCbHboxLV3YVTH","name":"centerOn","brief":"","scope":"instance","type":"MethodDoc","description":"center the rectangle position around the given coordinates
","params":[{"identifier":"x","optional":false,"description":"the x coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"lrfPoYLN3GHrMliKSgY_W","name":"clone","brief":"","scope":"instance","type":"MethodDoc","description":"clone this rectangle
","params":[],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"W5Ysqnnv5f8iQ2XaQJV61","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"name","optional":false,"description":"Layer name
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"color","optional":false,"description":"CSS color
","dataType":{"tokens":[{"value":"Color | string","kind":"canonical"},{"value":"Color","kind":"link"}],"template":"%1 | string"}},{"identifier":"z ","optional":true,"default":" 0","description":"z-index position
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"7S74fVqY-5q_CtiP3Omsn","name":"contains","brief":"","examples":[{"caption":"","code":"if (rect.contains(10, 10)) {\n // do something\n}\n// or\nif (rect.contains(myVector2d)) {\n // do something\n}\nif (rect.contains(myRect)) {\n // do something\n}"}],"scope":"instance","type":"MethodDoc","description":"Returns true if the rectangle contains the given point or rectangle
","params":[{"identifier":"x","description":"x coordinate or a vector point, or a rectangle to test
","dataType":{"tokens":[{"value":"number | Vector2d | Rect","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Rect","kind":"link"}],"template":"%1 | %2 | %3"}},{"identifier":"y","optional":true,"description":"y coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"True if the rectangle contain the given point or rectangle, otherwise false
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"6q9-yXEh52HUKdHzsjDAZ","name":"copy","brief":"","scope":"instance","type":"MethodDoc","description":"copy the position and size of the given rectangle into this one
","params":[{"identifier":"rect","optional":false,"description":"Source rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"US4VFQ363TqgC7npiUfR-","name":"distanceTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the distance to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"distance
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"OTJR_fhK-WZDSY4D7CeDH","name":"equals","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is identical to the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if equals
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"HGOK8Ebu9n4Q_ad25gZeH","name":"flipX","brief":"","scope":"instance","see":["Matrix2d#scaleX"],"type":"MethodDoc","description":"flip the renderable on the horizontal axis (around the center of the renderable)
","params":[{"identifier":"flip","optional":true,"default":"true","description":"true to flip this renderable.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"sL-lMHBmN9_K9Pk3Z6g4Q","name":"flipY","brief":"","scope":"instance","see":["Matrix2d#scaleY"],"type":"MethodDoc","description":"flip the renderable on the vertical axis (around the center of the renderable)
","params":[{"identifier":"flip","optional":true,"default":"true","description":"true to flip this renderable.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"fz3P1g-7RN6AxqVeCjWWH","name":"getAbsolutePosition","brief":"","scope":"instance","type":"MethodDoc","description":"return the renderable absolute position in the game world
","params":[],"returns":[{"dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"skfDEA5r6dhc6DSH3wtV2","name":"getBounds","brief":"","scope":"instance","type":"MethodDoc","description":"returns the bounding box for this renderable
","params":[],"returns":[{"description":"bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"uh4fLaus1PEI8tm2u9Y9t","name":"getIndices","brief":"","scope":"instance","type":"MethodDoc","description":"returns a list of indices for all triangles defined in this polygon
","params":[],"returns":[{"description":"an array of vertex indices for all triangles forming this polygon.
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1<%2>"}}],"extends":[],"implements":[]},{"id":"jOpN9x_cWF10XQrUw85dR","name":"getOpacity","brief":"","scope":"instance","type":"MethodDoc","description":"get the renderable alpha channel value
","params":[],"returns":[{"description":"current opacity value between 0 and 1
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"-BVdTHr3eEgBQQAeeNaV3","name":"isConvex","brief":"","scope":"instance","type":"MethodDoc","description":"Returns true if the vertices composing this polygon form a convex shape (vertices must be in clockwise order).
","params":[],"returns":[{"description":"true if the vertices are convex, false if not, null if not computable
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"Ns3Y6Rpgm-4s28warPblg","name":"isFinite","brief":"","scope":"instance","type":"MethodDoc","description":"determines whether all coordinates of this rectangle are finite numbers.
","params":[],"returns":[{"description":"false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"7NywE_kktstsFeEm1_ddr","name":"lookAt","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this renderable towards the given target.
","params":[{"identifier":"target","optional":false,"description":"the renderable or position to look at
","dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"zsvn64AKlwCR-K78U5DXR","name":"onCollision","brief":"","examples":[{"caption":"","code":"// colision handler\nonCollision(response) {\n if (response.b.body.collisionType === me.collision.types.ENEMY_OBJECT) {\n // makes the other object solid, by substracting the overlap vector to the current position\n this.pos.sub(response.overlapV);\n this.hurt();\n // not solid\n return false;\n }\n // Make the object solid\n return true;\n},"}],"scope":"instance","type":"MethodDoc","description":"onCollision callback, triggered in case of collision,\nwhen this renderable body is colliding with another one
","params":[{"identifier":"response","optional":false,"description":"the collision response object
","dataType":{"tokens":[{"value":"ResponseObject","kind":"canonical"},{"value":"ResponseObject","kind":"link"}],"template":"%1"}},{"identifier":"other","optional":false,"description":"the other renderable touching this one (a reference to response.a or response.b)
","dataType":{"tokens":[{"value":"Renderable | Container | Entity | Sprite | NineSliceSprite","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Container","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"NineSliceSprite","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5"}}],"returns":[{"description":"true if the object should respond to the collision (its position and velocity will be corrected)
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"kmsu1GlpCNz8pTOgR7w_D","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"OnDestroy Notification function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"cxGyMjJ8U4rlDfowR6Snm","name":"overlaps","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is intersecting with the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if overlaps
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"Aw_j0355hXkWMMeFHhPWD","name":"postDraw","brief":"","scope":"instance","see":["Renderable#preDraw","Renderable#draw"],"type":"MethodDoc","description":"restore the rendering context after drawing (automatically called by melonJS).
","params":[{"identifier":"renderer","optional":false,"description":"a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"axFYYUd57CVx2aV_OlRSB","name":"preDraw","brief":"","scope":"instance","see":["Renderable#draw","Renderable#postDraw"],"type":"MethodDoc","description":"Prepare the rendering context before drawing (automatically called by melonJS).\nThis will apply any defined transforms, an...","params":[{"identifier":"renderer","optional":false,"description":"
a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"jRjEsRkIjFm2giELVsdoT","name":"recalc","brief":"","scope":"instance","type":"MethodDoc","description":"Computes the calculated collision polygon.\nThis must be called if the points array, an...","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"vNqBRN6VU4sMLhdu_Krrq","name":"resize","brief":"","scope":"instance","type":"MethodDoc","description":"resize the rectangle
","params":[{"identifier":"w","optional":false,"description":"new width of the rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"h","optional":false,"description":"new height of the rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"06Xnu1eDP80WMhXjI4GIX","name":"rotate","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this renderable by the specified angle (in radians).
","params":[{"identifier":"angle","optional":false,"description":"The angle to rotate (in radians)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":true,"description":"an optional point to rotate around
","dataType":{"tokens":[{"value":"Vector2d | ObservableVector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"gi6v5MTfeXw2opy5SQx22","name":"scale","brief":"","scope":"instance","type":"MethodDoc","description":"scale the renderable around his anchor point. Scaling actually applies changes\nto the currentTransform member wich is use...","params":[{"identifier":"x","optional":false,"description":"
a number representing the abscissa of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":true,"default":"x","description":"a number representing the ordinate of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"OqKm-YNuKb6QlRQSJGctp","name":"scaleV","brief":"","scope":"instance","type":"MethodDoc","description":"scale the renderable around his anchor point
","params":[{"identifier":"v","optional":false,"description":"scaling vector
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"OTYhI3_nj2sfhew3Fn_z-","name":"setOpacity","brief":"","scope":"instance","type":"MethodDoc","description":"set the renderable alpha channel value
","params":[{"identifier":"alpha","optional":false,"description":"opacity value between 0.0 and 1.0
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"lwAn9kN2M62ugcMjFuKdQ","name":"setShape","brief":"","scope":"instance","type":"MethodDoc","description":"set new value to the rectangle shape
","params":[{"identifier":"x","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"w","optional":false,"description":"width of the rectangle, or an array of vector defining the rectangle
","dataType":{"tokens":[{"value":"number | Array","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %3<%2>"}},{"identifier":"h","optional":true,"description":"height of the rectangle, if a numeral width parameter is specified
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"MsajdZrR-oYk-5cvYI9EI","name":"setVertices","brief":"","scope":"instance","type":"MethodDoc","description":"set the vertices defining this Polygon
","params":[{"identifier":"vertices","optional":false,"description":"array of vector or vertice defining the Polygon
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1<%2>"}}],"returns":[{"description":"this instance for objecf chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"SMvTqtwTY2iGnII9_V3nS","name":"shift","brief":"","examples":[{"caption":"","code":"polygon.shift(10, 10);\n// or\npolygon.shift(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"Shifts the Polygon to the given position vector.
","params":[{"identifier":"x","description":"x coordinate or a vector point to shift to
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"XFS07X_2hOmdhwaknzrHs","name":"to2d","brief":"","scope":"instance","type":"MethodDoc","description":"apply a 2d projection to this shapen
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"srq9D1N4jdIDB6AXPPObi","name":"toIso","brief":"","scope":"instance","type":"MethodDoc","description":"apply an isometric projection to this shape
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"GXDgYWQaEsGrlr3kPUpDv","name":"toPolygon","brief":"","scope":"instance","type":"MethodDoc","description":"Returns a polygon whose edges are the same as this box.
","params":[],"returns":[{"description":"a new Polygon that represents this rectangle.
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"rHXiCYqd1ZWC3OVwKKZkL","name":"transform","brief":"","scope":"instance","see":["Renderable#currentTransform"],"type":"MethodDoc","description":"multiply the renderable currentTransform with the given matrix
","params":[{"identifier":"m","optional":false,"description":"the transformation matrix
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"l-TwkmYPJTlfBXlidpa-k","name":"translate","brief":"","examples":[{"caption":"","code":"polygon.translate(10, 10);\n// or\npolygon.translate(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"translate the Polygon by the specified offset
","params":[{"identifier":"x","description":"x offset or a vector point to translate by
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"description":"y offset
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"mZjBJHJdobc1cxqFCxH4Q","name":"union","brief":"","scope":"instance","type":"MethodDoc","description":"merge this rectangle with another one
","params":[{"identifier":"rect","optional":false,"description":"other rectangle to union with
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"the union(ed) rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"pgq6cZ9yrrEItsfY6XzgO","name":"update","brief":"","scope":"instance","type":"MethodDoc","description":"update function (automatically called by melonJS).
","params":[{"identifier":"dt","optional":false,"description":"time since the last update in milliseconds.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"true if the renderable is dirty
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"eoZc9dBbGtmTiUAy0egq_","name":"updateBounds","brief":"","scope":"instance","type":"MethodDoc","description":"update the bounding box for this shape.
","params":[{"identifier":"absolute","optional":true,"default":"true","description":"update the bounds size and position in (world) absolute coordinates
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"this shape bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"jD8X3PAzWTZojnvHjZgcA","name":"draw","brief":"","access":"protected","scope":"instance","type":"MethodDoc","description":"draw this color layer (automatically called by melonJS)
","params":[{"identifier":"renderer","optional":false,"description":"a renderer instance
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}},{"identifier":"viewport","optional":true,"description":"the viewport to (re)draw
","dataType":{"tokens":[{"value":"Camera2d","kind":"canonical"},{"value":"Camera2d","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"-9jx6Da75vlXd3PaVsJ9e","name":"onAnchorUpdate","brief":"","access":"private","scope":"instance","type":"MethodDoc","description":"called when the anchor point value is changed
","params":[{"identifier":"x","optional":false,"description":"the new X value to be set for the anchor
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the new Y value to be set for the anchor
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]}]},{"id":"czzquiTVO8HE-dPoVPxT4","name":"Compositor","brief":"","type":"ClassDoc","description":"A base Compositor object.
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"8qNTDAgPyo2B7WubRb8EO","name":"attributes","brief":"","scope":"instance","see":["WebGLCompositor.addAttribute"],"type":"PropertyDoc","description":"an array of vertex attribute properties
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"5c7cJayPIsuvtbLtcQtvT","name":"currentShader","brief":"","scope":"instance","type":"PropertyDoc","description":"the shader currently used by this compositor
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"oLtp0UGMgj4lTYpbwY990","name":"defaultShader","brief":"","scope":"instance","type":"PropertyDoc","description":"the default shader created by this compositor
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"MZPrr6oqh5oeZzZcNMqyp","name":"mode","brief":"","defaultValue":"gl.TRIANGLES","scope":"instance","type":"PropertyDoc","description":"primitive type to render (gl.POINTS, gl.LINE_STRIP, gl.LINE_LOOP, gl.LINES, gl.TRIANGLE_STRIP, gl.TRIANGLE_FAN, gl.TRIANGL...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"TKzgPUxeTvgFFWrkPpBy5","name":"vertexByteSize","brief":"","defaultValue":"0","scope":"instance","see":["WebGLCompositor.addAttribute"],"type":"PropertyDoc","description":"
the size of a single vertex in bytes\n(will automatically be calculated as attributes definitions are added)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"OI05akuoXS0wZoRSbik3O","name":"vertexData","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"the vertex data buffer used by this compositor
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"MeM3UNRqQZ2EOZtnV1rlF","name":"vertexSize","brief":"","defaultValue":"0","scope":"instance","see":["WebGLCompositor.addAttribute"],"type":"PropertyDoc","description":"the size of a single vertex in floats\n(will automatically be calculated as attributes definitions are added)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"iuneDpq-ZMQMg1Z6m4jmc","name":"addAttribute","brief":"","scope":"instance","type":"MethodDoc","description":"add vertex attribute property definition to the compositor
","params":[{"identifier":"name","optional":false,"description":"name of the attribute in the vertex shader
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"size","optional":false,"description":"number of components per vertex attribute. Must be 1, 2, 3, or 4.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"type","optional":false,"description":"data type of each component in the array
","dataType":{"tokens":[{"value":"GLenum","kind":"canonical"},{"value":"GLenum","kind":"canonical"}],"template":"%1"}},{"identifier":"normalized","optional":false,"description":"whether integer data values should be normalized into a certain range when being cast to a float
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}},{"identifier":"offset","optional":false,"description":"offset in bytes of the first component in the vertex attribute array
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"5VbFXjxs0Y-HkCvAmcJho","name":"bind","brief":"called by the WebGL renderer when a compositor become the current one
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"VlvTJE9ptwGsKaJf33bgc","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"renderer","optional":false,"description":"the current WebGL renderer session
","dataType":{"tokens":[{"value":"WebGLRenderer","kind":"canonical"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1"}},{"identifier":"settings","optional":false,"description":"additional settings to initialize this compositors
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}},{"identifier":"settings.attribute","description":"an array of attributes definition
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"}],"template":"%1"}},{"identifier":"settings.attribute.name","description":"name of the attribute in the vertex shader
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"settings.attribute.size","description":"number of components per vertex attribute. Must be 1, 2, 3, or 4.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings.attribute.type","description":"data type of each component in the array
","dataType":{"tokens":[{"value":"GLenum","kind":"canonical"},{"value":"GLenum","kind":"canonical"}],"template":"%1"}},{"identifier":"settings.attribute.normalized","description":"whether integer data values should be normalized into a certain range when being cast to a float
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}},{"identifier":"settings.attribute.offset","description":"offset in bytes of the first component in the vertex attribute array
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings.shader","description":"an array of attributes definition
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}},{"identifier":"settings.shader.vertex","description":"a string containing the GLSL source code to set
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"settings.shader.fragment","description":"a string containing the GLSL source code to set
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"returns":[],"extends":[],"implements":[]},{"id":"RaGOL9vjrR3pcrOSZch5x","name":"flush","brief":"","scope":"instance","type":"MethodDoc","description":"Flush batched vertex data to the GPU
","params":[{"identifier":"mode","optional":true,"default":"gl.TRIANGLES","description":"the GL drawing mode
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"JQBW33Ig-Mw_1SnPkkwSd","name":"setProjection","brief":"","scope":"instance","type":"MethodDoc","description":"set/change the current projection matrix
","params":[{"identifier":"matrix","optional":false,"description":"the new projection matrix
","dataType":{"tokens":[{"value":"Matrix3d","kind":"canonical"},{"value":"Matrix3d","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"_yBHrsU1e4XRkqocXDeML","name":"useShader","brief":"","scope":"instance","see":["GLShader"],"type":"MethodDoc","description":"Select the shader to use for compositing
","params":[{"identifier":"shader","optional":false,"description":"a reference to a GLShader instance
","dataType":{"tokens":[{"value":"GLShader","kind":"canonical"},{"value":"GLShader","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]}]},{"id":"LiUBRng4tQsCgyz7cN7af","name":"Container","brief":"","type":"ClassDoc","description":"Container represents a collection of child objects
","params":[],"returns":[],"extends":["Renderable"],"implements":[],"members":[{"id":"zK76YiN4x6RW9YfVDsd_H","name":"alpha","brief":"","defaultValue":"1.0","scope":"instance","see":["Renderable#setOpacity","Renderable#getOpacity"],"type":"PropertyDoc","description":"Define the renderable opacity
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"p7QrSo7reUtXSu82xIXXd","name":"alwaysUpdate","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object will always update, even when outside of the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"otMDPVpvVdKvPwr7ILorF","name":"ancestor","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"a reference to the parent object that contains this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"YZedX63chgC9nj44ISJdV","name":"anchorPoint","brief":"","defaultValue":"<0.5,0.5>","scope":"instance","type":"PropertyDoc","description":"The anchor point is used for attachment behavior, and/or when applying transformations.
Specify if the children z index should automatically be managed by the parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Si72VRFp7f1fM4r5IBR1_","name":"autoSort","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"Specify if the children list should be automatically sorted when adding a new child
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Rw3dft9ZaFJ8MJC-bhfCC","name":"autoTransform","brief":"","defaultValue":"true","examples":[{"caption":"","code":"// enable \"automatic\" transformation when the object is activated\nonActivateEvent: function () {\n // reset the transformation matrix\n this.currentTransform.identity();\n // ensure the anchor point is the renderable center\n this.anchorPoint.set(0.5, 0.5);\n // enable auto transform\n this.autoTransform = true;\n ....\n}"}],"scope":"instance","type":"PropertyDoc","description":"When enabled, an object container will automatically apply\nany defined transformation before calling the child draw method...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"05ymFWqHV1S_2At3IK6l1","name":"backgroundColor","brief":"","defaultValue":"(0, 0, 0, 0.0)","examples":[{"caption":"","code":"// add a red background color to this container\nthis.backgroundColor.setColor(255, 0, 0);"}],"scope":"instance","type":"PropertyDoc","description":"
define a background color for this container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"QPW2tvocZVKBPblSj4oWw","name":"blendMode","brief":"","defaultValue":"\"normal\"","scope":"instance","see":["CanvasRenderer#setBlendMode","WebGLRenderer#setBlendMode"],"type":"PropertyDoc","description":"the blend mode to be applied to this renderable (see renderer setBlendMode for available blend mode)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"KxyFXC00ih6K-B0plGfIB","name":"body","brief":"","examples":[{"caption":"","code":" // define a new Player Class\n class PlayerEntity extends me.Sprite {\n // constructor\n constructor(x, y, settings) {\n // call the parent constructor\n super(x, y , settings);\n\n // define a basic walking animation\n this.addAnimation(\"walk\", [...]);\n // define a standing animation (using the first frame)\n this.addAnimation(\"stand\", [...]);\n // set the standing animation as default\n this.setCurrentAnimation(\"stand\");\n\n // add a physic body\n this.body = new me.Body(this);\n // add a default collision shape\n this.body.addShape(new me.Rect(0, 0, this.width, this.height));\n // configure max speed, friction, and initial force to be applied\n this.body.setMaxVelocity(3, 15);\n this.body.setFriction(0.4, 0);\n this.body.force.set(3, 0);\n this.isKinematic = false;\n\n // set the display to follow our position on both axis\n me.game.viewport.follow(this.pos, me.game.viewport.AXIS.BOTH);\n }\n\n ...\n\n }"}],"scope":"instance","type":"PropertyDoc","description":"the renderable physic body
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"zwuWLpmRlV9kWEZRLiVPc","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"W2CRs-lUfdKVNHmXc_lnV","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"TQIedJiJq13OrH0CpPR3k","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"-4IDmm5ob8xmBtOgsPDda","name":"clipping","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Specify if the container draw operation should clip his children to its own bounds
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"OZMf2IM0CK5pNWVKIlvF8","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ig9X4QFnWvL2M_2h8SOoz","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Pw3bMJfvJnsMClYyg1nOt","name":"enableChildBoundsUpdate","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Specify if the container bounds should automatically take in account\nall child bounds when updated (this is expensive and ...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"uGIHbIlwu4aqmM7MRFPpm","name":"floating","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"
If true, this renderable will be rendered using screen coordinates,\nas opposed to world coordinates. Use this, for example...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"SZ9BZNVcfO2K8cvpqlZ0X","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"
(G)ame (U)nique (Id)entifier"
height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"a8PoDu03W11wP9_DElw8p","name":"inViewport","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object is visible and within the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Zn9joscVtk3cnHxK_vSlT","name":"isDirty","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"when true the renderable will be redrawn during the next update cycle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"C7zzvRe2oIP3EREeh_si0","name":"isFlippedX","brief":"","access":"public","scope":"instance","see":["Renderable#flipX"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"aixaH-SVMfzfYKnRZQxOj","name":"isFlippedY","brief":"","access":"public","scope":"instance","see":["Renderable#flipY"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"j4PMdKjNy0rk_1zT82KQm","name":"isFloating","brief":"","scope":"instance","see":["Renderable#floating"],"type":"PropertyDoc","description":"Whether the renderable object is floating (i.e. used screen coordinates), or contained in a floating parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"LYR89utyTeOyHmLidUGeW","name":"isKinematic","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"If true then physic collision and input events will not impact this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"vMMXGogXok1md93QxLS3o","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"xjPz8Nlt2u3dixDo2sYDA","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"wdHNKGI3bI_QkjmogW7SJ","name":"mask","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"// apply a mask in the shape of a Star\nmyNPCSprite.mask = new me.Polygon(myNPCSprite.width / 2, 0, [\n // draw a star\n {x: 0, y: 0},\n {x: 14, y: 30},\n {x: 47, y: 35},\n {x: 23, y: 57},\n {x: 44, y: 90},\n {x: 0, y: 62},\n {x: -44, y: 90},\n {x: -23, y: 57},\n {x: -47, y: 35},\n {x: -14, y: 30}\n]);"}],"scope":"instance","type":"PropertyDoc","description":"A mask limits rendering elements to the shape and position of the given mask object.\nSo, if the renderable is larger than ...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"wyZZS_M_8uVLgybk6MHXe","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ni7kUJJ0nEI39dKEW_1mC","name":"onVisibilityChange","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"this.onVisibilityChange = function(inViewport) {\n if (inViewport === true) {\n console.log(\"object has entered the in a camera viewport!\");\n }\n};"}],"scope":"instance","type":"PropertyDoc","description":"an event handler that is called when the renderable leave or enter a camera viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"mSE_MlialCr-loduJByLu","name":"parentApp","brief":"","scope":"instance","type":"PropertyDoc","description":"returns the parent application (or game) to which this renderable is attached to
","params":[],"returns":[{"description":"the parent application or undefined if not attached to any container/app
","dataType":{"tokens":[{"value":"Application","kind":"canonical"},{"value":"Application","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"-SyrTqMdtd6k3C2bvxIE1","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"xHiPaJ47vwZIwSvhYrUm_","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"K3ec9a0jGP9diTPU5-cZW","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"nE6GtHlsxTM8de6IoQjLl","name":"root","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"whether the container is the root of the scene
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"hzvEkM1OGKaqNFsTuAcCQ","name":"shader","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"(Experimental) an optional shader, to be used instead of the default built-in one, when drawing this renderable (WebGL onl...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"2zM6FsUS5V0eZS_LKez9z","name":"sortOn","brief":"","defaultValue":"\"z\"","scope":"instance","type":"PropertyDoc","description":"
The property of the child object that should be used to sort on this container\nvalue : "x", "y", "...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"bpAvGoAWxxFzBzkzsyrvi","name":"tint","brief":"","defaultValue":"(255, 255, 255)","examples":[{"caption":"","code":"// add a red tint to this renderable\nthis.tint.setColor(255, 128, 128);\n// remove the tint\nthis.tint.setColor(255, 255, 255);"}],"scope":"instance","type":"PropertyDoc","description":"
define a tint for this renderable. a (255, 255, 255) r, g, b value will remove the tint effect.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"wO6JHPy_rlkGV1wzFP76t","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"V188KTVz8HlDaIICeQPue","name":"type","brief":"","defaultValue":"\"Rectangle\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"-yIzmvfrkp_DT6MI4xLGo","name":"updateWhenPaused","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether to update this object when the game is paused.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"fqBH0s0HRhgcGZ7sR1aNL","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"gBdkUSw9iF8sOrs9GChQy","name":"addChild","brief":"","scope":"instance","type":"MethodDoc","description":"Add a child to the container
Child to be added
","dataType":{"tokens":[{"value":"Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"Collectable","kind":"link"},{"value":"Trigger","kind":"link"},{"value":"Draggable","kind":"link"},{"value":"DropTarget","kind":"link"},{"value":"NineSliceSprite","kind":"link"},{"value":"ImageLayer","kind":"link"},{"value":"ColorLayer","kind":"link"},{"value":"Light2d","kind":"link"},{"value":"UIBaseElement","kind":"link"},{"value":"UISpriteElement","kind":"link"},{"value":"UITextButton","kind":"link"},{"value":"Text","kind":"link"},{"value":"BitmapText","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5 | %6 | %7 | %8 | %9 | %10 | %11 | %12 | %13 | %14 | %15 | %16"}},{"identifier":"z","optional":true,"description":"forces the z index of the child to the specified value
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"the added child
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"d09p83PRjRPGyjHcHnakt","name":"addChildAt","brief":"","scope":"instance","type":"MethodDoc","description":"Add a child to the container at the specified index
","params":[{"identifier":"child","optional":false,"description":"Child to be added
","dataType":{"tokens":[{"value":"Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"Collectable","kind":"link"},{"value":"Trigger","kind":"link"},{"value":"Draggable","kind":"link"},{"value":"DropTarget","kind":"link"},{"value":"NineSliceSprite","kind":"link"},{"value":"ImageLayer","kind":"link"},{"value":"ColorLayer","kind":"link"},{"value":"Light2d","kind":"link"},{"value":"UIBaseElement","kind":"link"},{"value":"UISpriteElement","kind":"link"},{"value":"UITextButton","kind":"link"},{"value":"Text","kind":"link"},{"value":"BitmapText","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5 | %6 | %7 | %8 | %9 | %10 | %11 | %12 | %13 | %14 | %15 | %16"}},{"identifier":"index","optional":false,"description":"The index at which to insert the child
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"the added child
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"zlLnUzYNLeCAq3MsWI-0e","name":"angleTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the angle to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"angle in radians
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Fp5q71opyprec4hPbKrJT","name":"centerOn","brief":"","scope":"instance","type":"MethodDoc","description":"center the rectangle position around the given coordinates
","params":[{"identifier":"x","optional":false,"description":"the x coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"_tyHREZHqM4w2YZNso3lQ","name":"clone","brief":"","scope":"instance","type":"MethodDoc","description":"clone this rectangle
","params":[],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"JxWkITmDz4UywqCzv1ymu","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"x","optional":true,"default":"0","description":"position of the container (accessible via the inherited pos.x property)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":true,"default":"0","description":"position of the container (accessible via the inherited pos.y property)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"width","optional":true,"default":"game.viewport.width","description":"width of the container
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"height","optional":true,"default":"game.viewport.height","description":"height of the container
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"TVgUUrnLOM1lnnBDSN5Sm","name":"contains","brief":"","examples":[{"caption":"","code":"if (rect.contains(10, 10)) {\n // do something\n}\n// or\nif (rect.contains(myVector2d)) {\n // do something\n}\nif (rect.contains(myRect)) {\n // do something\n}"}],"scope":"instance","type":"MethodDoc","description":"Returns true if the rectangle contains the given point or rectangle
","params":[{"identifier":"x","description":"x coordinate or a vector point, or a rectangle to test
","dataType":{"tokens":[{"value":"number | Vector2d | Rect","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Rect","kind":"link"}],"template":"%1 | %2 | %3"}},{"identifier":"y","optional":true,"description":"y coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"True if the rectangle contain the given point or rectangle, otherwise false
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"wPxlbUTOqKWHAEbQy3fII","name":"copy","brief":"","scope":"instance","type":"MethodDoc","description":"copy the position and size of the given rectangle into this one
","params":[{"identifier":"rect","optional":false,"description":"Source rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"2LCxFg8LLtSA0eXq2Y4Iu","name":"distanceTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the distance to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"distance
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"p5RuBTMHLbJFA0nIC-7Xf","name":"equals","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is identical to the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if equals
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"u2t-ZdTUPnv9hlgkAv510","name":"flipX","brief":"","scope":"instance","see":["Matrix2d#scaleX"],"type":"MethodDoc","description":"flip the renderable on the horizontal axis (around the center of the renderable)
","params":[{"identifier":"flip","optional":true,"default":"true","description":"true to flip this renderable.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"0VZo7DhWtFs1anWfZNMsx","name":"flipY","brief":"","scope":"instance","see":["Matrix2d#scaleY"],"type":"MethodDoc","description":"flip the renderable on the vertical axis (around the center of the renderable)
","params":[{"identifier":"flip","optional":true,"default":"true","description":"true to flip this renderable.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"k75JN6a3GeEQ0b5NKJLNK","name":"forEach","brief":"","examples":[{"caption":"","code":"// iterate through all children of this container\ncontainer.forEach((child) => {\n // do something with the child\n child.doSomething();\n});\ncontainer.forEach((child, index) => { ... });\ncontainer.forEach((child, index, array) => { ... });\ncontainer.forEach((child, index, array) => { ... }, thisArg);"}],"scope":"instance","type":"MethodDoc","description":"The forEach() method executes a provided function once per child element.
fnction to execute on each element
","dataType":{"tokens":[{"value":"Function","kind":"canonical"}],"template":"Function"}},{"identifier":"thisArg","optional":true,"description":"value to use as this(i.e reference Object) when executing callback.
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}}],"returns":[],"extends":[],"implements":[]},{"id":"d3qdje5YYEINUyoGM2EFz","name":"getAbsolutePosition","brief":"","scope":"instance","type":"MethodDoc","description":"return the renderable absolute position in the game world
","params":[],"returns":[{"dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"t22pbRKw3fHEO4iFGeYMD","name":"getBounds","brief":"","scope":"instance","type":"MethodDoc","description":"returns the bounding box for this renderable
","params":[],"returns":[{"description":"bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"DX9roA9zWuCiJxGkJjnjT","name":"getChildAt","brief":"","scope":"instance","type":"MethodDoc","description":"Returns the Child at the specified index
","params":[{"identifier":"index","optional":false,"description":"The index of the child
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"the child at the specified index
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"zoZD5qPPGg50PfHFpgRRR","name":"getChildByGUID","brief":"","scope":"instance","type":"MethodDoc","description":"return the child corresponding to the specified GUID
child GUID
","dataType":{"tokens":[{"value":"string | RegExp | number | boolean","kind":"canonical"},{"value":"RegExp","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"string | %1 | %2 | boolean"}}],"returns":[{"description":"corresponding child or null
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"wJ8wD-SOfGnR0A6fxoggq","name":"getChildByName","brief":"","scope":"instance","type":"MethodDoc","description":"returns the list of childs with the specified name
child name
","dataType":{"tokens":[{"value":"string | RegExp | number | boolean","kind":"canonical"},{"value":"RegExp","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"string | %1 | %2 | boolean"}}],"returns":[{"description":"Array of children
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1<%2>"}}],"extends":[],"implements":[]},{"id":"rMdCFWCOgC45Kqb8z8iPh","name":"getChildByProp","brief":"","examples":[{"caption":"","code":" // get the first child object called \"mainPlayer\" in a specific container :\n let ent = myContainer.getChildByProp(\"name\", \"mainPlayer\");\n\n // or query the whole world :\n let ent = container.getChildByProp(\"name\", \"mainPlayer\");\n\n // partial property matches are also allowed by using a RegExp.\n // the following matches \"redCOIN\", \"bluecoin\", \"bagOfCoins\", etc :\n let allCoins = container.getChildByProp(\"name\", /coin/i);\n\n // searching for numbers or other data types :\n let zIndex10 = container.getChildByProp(\"z\", 10);\n let inViewport = container.getChildByProp(\"inViewport\", true);"}],"scope":"instance","type":"MethodDoc","description":"return the child corresponding to the given property and value.
Property name
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"value","optional":false,"description":"Value of the property
","dataType":{"tokens":[{"value":"string | RegExp | number | boolean","kind":"canonical"},{"value":"RegExp","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"string | %1 | %2 | boolean"}}],"returns":[{"description":"Array of childs
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1<%2>"}}],"extends":[],"implements":[]},{"id":"B5mi9sMT-mVu8lzGNLJ5X","name":"getChildByType","brief":"","scope":"instance","type":"MethodDoc","description":"returns the list of childs with the specified class type
","params":[{"identifier":"classType","optional":false,"description":"Class type
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}}],"returns":[{"description":"Array of children
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1<%2>"}}],"extends":[],"implements":[]},{"id":"EEqWJ9MN4mhky5BrJaEVg","name":"getChildIndex","brief":"","scope":"instance","type":"MethodDoc","description":"Returns the index of the given Child
","params":[{"identifier":"child","optional":false,"description":"The child object
","dataType":{"tokens":[{"value":"Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"Collectable","kind":"link"},{"value":"Trigger","kind":"link"},{"value":"Draggable","kind":"link"},{"value":"DropTarget","kind":"link"},{"value":"NineSliceSprite","kind":"link"},{"value":"ImageLayer","kind":"link"},{"value":"ColorLayer","kind":"link"},{"value":"Light2d","kind":"link"},{"value":"UIBaseElement","kind":"link"},{"value":"UISpriteElement","kind":"link"},{"value":"UITextButton","kind":"link"},{"value":"Text","kind":"link"},{"value":"BitmapText","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5 | %6 | %7 | %8 | %9 | %10 | %11 | %12 | %13 | %14 | %15 | %16"}}],"returns":[{"description":"index
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"tOVyYLz8SedPj9UWSPVcJ","name":"getChildren","brief":"","scope":"instance","type":"MethodDoc","description":"return all child in this container
","params":[],"returns":[{"description":"an array of renderable object
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1<%2>"}}],"extends":[],"implements":[]},{"id":"TKXwFAIeQRSs70SVCl75L","name":"getIndices","brief":"","scope":"instance","type":"MethodDoc","description":"returns a list of indices for all triangles defined in this polygon
","params":[],"returns":[{"description":"an array of vertex indices for all triangles forming this polygon.
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1<%2>"}}],"extends":[],"implements":[]},{"id":"G5oD0mju6evOg7PezCOq1","name":"getNextChild","brief":"","scope":"instance","type":"MethodDoc","description":"Returns the next child within the container or undefined if none
","params":[{"identifier":"child","optional":false,"description":"The child object
","dataType":{"tokens":[{"value":"Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"Collectable","kind":"link"},{"value":"Trigger","kind":"link"},{"value":"Draggable","kind":"link"},{"value":"DropTarget","kind":"link"},{"value":"NineSliceSprite","kind":"link"},{"value":"ImageLayer","kind":"link"},{"value":"ColorLayer","kind":"link"},{"value":"Light2d","kind":"link"},{"value":"UIBaseElement","kind":"link"},{"value":"UISpriteElement","kind":"link"},{"value":"UITextButton","kind":"link"},{"value":"Text","kind":"link"},{"value":"BitmapText","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5 | %6 | %7 | %8 | %9 | %10 | %11 | %12 | %13 | %14 | %15 | %16"}}],"returns":[{"description":"child
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"JuhlB-D_HwAFFExRWOLIT","name":"getOpacity","brief":"","scope":"instance","type":"MethodDoc","description":"get the renderable alpha channel value
","params":[],"returns":[{"description":"current opacity value between 0 and 1
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"CbjHBLzN2eVj-s_rlTZNT","name":"getRootAncestor","brief":"","scope":"instance","type":"MethodDoc","description":"Returns the instance of the root container (i.e. the current application World container).
","params":[],"returns":[{"description":"root container
","dataType":{"tokens":[{"value":"Container","kind":"canonical"},{"value":"Container","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"d_BHDiKEEQSYbcXG_U2Id","name":"hasChild","brief":"","scope":"instance","type":"MethodDoc","description":"Returns true if contains the specified Child
","params":[{"identifier":"child","optional":false,"description":"The child object
","dataType":{"tokens":[{"value":"Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"Collectable","kind":"link"},{"value":"Trigger","kind":"link"},{"value":"Draggable","kind":"link"},{"value":"DropTarget","kind":"link"},{"value":"NineSliceSprite","kind":"link"},{"value":"ImageLayer","kind":"link"},{"value":"ColorLayer","kind":"link"},{"value":"Light2d","kind":"link"},{"value":"UIBaseElement","kind":"link"},{"value":"UISpriteElement","kind":"link"},{"value":"UITextButton","kind":"link"},{"value":"Text","kind":"link"},{"value":"BitmapText","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5 | %6 | %7 | %8 | %9 | %10 | %11 | %12 | %13 | %14 | %15 | %16"}}],"returns":[{"dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"Eb70-saoGDkcN8h5bvSdO","name":"isAttachedToRoot","brief":"","scope":"instance","type":"MethodDoc","description":"Checks if this container is root or if it's attached to the root container.
","params":[],"returns":[{"description":"true if this container is root or if it's attached to the root container
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"9wdY9Jn1KVxpHLfr6pcQD","name":"isConvex","brief":"","scope":"instance","type":"MethodDoc","description":"Returns true if the vertices composing this polygon form a convex shape (vertices must be in clockwise order).
","params":[],"returns":[{"description":"true if the vertices are convex, false if not, null if not computable
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"7bAEcvBz9y3YE9D5dnN6r","name":"isFinite","brief":"","scope":"instance","type":"MethodDoc","description":"determines whether all coordinates of this rectangle are finite numbers.
","params":[],"returns":[{"description":"false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"9kTjpT6z72kXwTtxSeyDj","name":"lookAt","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this renderable towards the given target.
","params":[{"identifier":"target","optional":false,"description":"the renderable or position to look at
","dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"1OCyCvoOh9ETQpeN6j8FO","name":"moveDown","brief":"","scope":"instance","type":"MethodDoc","description":"Move the child in the group one step backward (z depth).
","params":[{"identifier":"child","optional":false,"description":"Child to be moved
","dataType":{"tokens":[{"value":"Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"Collectable","kind":"link"},{"value":"Trigger","kind":"link"},{"value":"Draggable","kind":"link"},{"value":"DropTarget","kind":"link"},{"value":"NineSliceSprite","kind":"link"},{"value":"ImageLayer","kind":"link"},{"value":"ColorLayer","kind":"link"},{"value":"Light2d","kind":"link"},{"value":"UIBaseElement","kind":"link"},{"value":"UISpriteElement","kind":"link"},{"value":"UITextButton","kind":"link"},{"value":"Text","kind":"link"},{"value":"BitmapText","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5 | %6 | %7 | %8 | %9 | %10 | %11 | %12 | %13 | %14 | %15 | %16"}}],"returns":[],"extends":[],"implements":[]},{"id":"WXG4WTgHQ29ouwiyNVCSf","name":"moveToBottom","brief":"","scope":"instance","type":"MethodDoc","description":"Move the specified child the bottom (z depth).
","params":[{"identifier":"child","optional":false,"description":"Child to be moved
","dataType":{"tokens":[{"value":"Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"Collectable","kind":"link"},{"value":"Trigger","kind":"link"},{"value":"Draggable","kind":"link"},{"value":"DropTarget","kind":"link"},{"value":"NineSliceSprite","kind":"link"},{"value":"ImageLayer","kind":"link"},{"value":"ColorLayer","kind":"link"},{"value":"Light2d","kind":"link"},{"value":"UIBaseElement","kind":"link"},{"value":"UISpriteElement","kind":"link"},{"value":"UITextButton","kind":"link"},{"value":"Text","kind":"link"},{"value":"BitmapText","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5 | %6 | %7 | %8 | %9 | %10 | %11 | %12 | %13 | %14 | %15 | %16"}}],"returns":[],"extends":[],"implements":[]},{"id":"WjnzMlxZGAEd8rDKM6Ktb","name":"moveToTop","brief":"","scope":"instance","type":"MethodDoc","description":"Move the specified child to the top(z depth).
","params":[{"identifier":"child","optional":false,"description":"Child to be moved
","dataType":{"tokens":[{"value":"Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"Collectable","kind":"link"},{"value":"Trigger","kind":"link"},{"value":"Draggable","kind":"link"},{"value":"DropTarget","kind":"link"},{"value":"NineSliceSprite","kind":"link"},{"value":"ImageLayer","kind":"link"},{"value":"ColorLayer","kind":"link"},{"value":"Light2d","kind":"link"},{"value":"UIBaseElement","kind":"link"},{"value":"UISpriteElement","kind":"link"},{"value":"UITextButton","kind":"link"},{"value":"Text","kind":"link"},{"value":"BitmapText","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5 | %6 | %7 | %8 | %9 | %10 | %11 | %12 | %13 | %14 | %15 | %16"}}],"returns":[],"extends":[],"implements":[]},{"id":"FMYYLzJy-a3_4M910IEsV","name":"moveUp","brief":"","scope":"instance","type":"MethodDoc","description":"Move the child in the group one step forward (z depth).
","params":[{"identifier":"child","optional":false,"description":"Child to be moved
","dataType":{"tokens":[{"value":"Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"Collectable","kind":"link"},{"value":"Trigger","kind":"link"},{"value":"Draggable","kind":"link"},{"value":"DropTarget","kind":"link"},{"value":"NineSliceSprite","kind":"link"},{"value":"ImageLayer","kind":"link"},{"value":"ColorLayer","kind":"link"},{"value":"Light2d","kind":"link"},{"value":"UIBaseElement","kind":"link"},{"value":"UISpriteElement","kind":"link"},{"value":"UITextButton","kind":"link"},{"value":"Text","kind":"link"},{"value":"BitmapText","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5 | %6 | %7 | %8 | %9 | %10 | %11 | %12 | %13 | %14 | %15 | %16"}}],"returns":[],"extends":[],"implements":[]},{"id":"5cejbDGclAmCI7Wb5kgU1","name":"onChildChange","brief":"","scope":"instance","type":"MethodDoc","description":"a callback to be extended, triggered after a child has been added or removed
","params":[{"identifier":"index","optional":false,"description":"added or removed child index
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"hstxF-_Re-IVRMNp3RKqr","name":"onCollision","brief":"","examples":[{"caption":"","code":"// colision handler\nonCollision(response) {\n if (response.b.body.collisionType === me.collision.types.ENEMY_OBJECT) {\n // makes the other object solid, by substracting the overlap vector to the current position\n this.pos.sub(response.overlapV);\n this.hurt();\n // not solid\n return false;\n }\n // Make the object solid\n return true;\n},"}],"scope":"instance","type":"MethodDoc","description":"onCollision callback, triggered in case of collision,\nwhen this renderable body is colliding with another one
","params":[{"identifier":"response","optional":false,"description":"the collision response object
","dataType":{"tokens":[{"value":"ResponseObject","kind":"canonical"},{"value":"ResponseObject","kind":"link"}],"template":"%1"}},{"identifier":"other","optional":false,"description":"the other renderable touching this one (a reference to response.a or response.b)
","dataType":{"tokens":[{"value":"Renderable | Container | Entity | Sprite | NineSliceSprite","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Container","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"NineSliceSprite","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5"}}],"returns":[{"description":"true if the object should respond to the collision (its position and velocity will be corrected)
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"_THZIZs02ShkU9JPxqIyl","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"OnDestroy Notification function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"jBXRMg-LFV19P9G1FYgZy","name":"overlaps","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is intersecting with the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if overlaps
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"fKhCTxZE7zVolBXgIG8oT","name":"postDraw","brief":"","scope":"instance","see":["Renderable#preDraw","Renderable#draw"],"type":"MethodDoc","description":"restore the rendering context after drawing (automatically called by melonJS).
","params":[{"identifier":"renderer","optional":false,"description":"a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"D7qL1nFkou1wmrqFSB6PO","name":"preDraw","brief":"","scope":"instance","see":["Renderable#draw","Renderable#postDraw"],"type":"MethodDoc","description":"Prepare the rendering context before drawing (automatically called by melonJS).\nThis will apply any defined transforms, an...","params":[{"identifier":"renderer","optional":false,"description":"
a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"7d4VuJmIDLXZFNiQZUz48","name":"recalc","brief":"","scope":"instance","type":"MethodDoc","description":"Computes the calculated collision polygon.\nThis must be called if the points array, an...","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"xsqT_TqX2Etn9leB1ge7O","name":"removeChild","brief":"","scope":"instance","type":"MethodDoc","description":"Invokes the removeChildNow in a defer, to ensure the child is removed safely after the update & draw stack has complet...","params":[{"identifier":"child","optional":false,"description":"
Child to be removed
","dataType":{"tokens":[{"value":"RendRenderable | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapTexterable","kind":"canonical"},{"value":"RendRenderable","kind":"canonical"},{"value":"Sprite","kind":"link"},{"value":"Collectable","kind":"link"},{"value":"Trigger","kind":"link"},{"value":"Draggable","kind":"link"},{"value":"DropTarget","kind":"link"},{"value":"NineSliceSprite","kind":"link"},{"value":"ImageLayer","kind":"link"},{"value":"ColorLayer","kind":"link"},{"value":"Light2d","kind":"link"},{"value":"UIBaseElement","kind":"link"},{"value":"UISpriteElement","kind":"link"},{"value":"UITextButton","kind":"link"},{"value":"Text","kind":"link"},{"value":"BitmapTexterable","kind":"canonical"}],"template":"%1 | %2 | %3 | %4 | %5 | %6 | %7 | %8 | %9 | %10 | %11 | %12 | %13 | %14 | %15"}},{"identifier":"keepalive","optional":true,"default":"false","description":"true to prevent calling child.destroy()
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"Xns5V_vHnGN_nk-bVjCMM","name":"removeChildNow","brief":"","scope":"instance","type":"MethodDoc","description":"Removes (and optionally destroys) a child from the container.
Child to be removed
","dataType":{"tokens":[{"value":"Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"Collectable","kind":"link"},{"value":"Trigger","kind":"link"},{"value":"Draggable","kind":"link"},{"value":"DropTarget","kind":"link"},{"value":"NineSliceSprite","kind":"link"},{"value":"ImageLayer","kind":"link"},{"value":"ColorLayer","kind":"link"},{"value":"Light2d","kind":"link"},{"value":"UIBaseElement","kind":"link"},{"value":"UISpriteElement","kind":"link"},{"value":"UITextButton","kind":"link"},{"value":"Text","kind":"link"},{"value":"BitmapText","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5 | %6 | %7 | %8 | %9 | %10 | %11 | %12 | %13 | %14 | %15 | %16"}},{"identifier":"keepalive","optional":true,"default":"False","description":"True to prevent calling child.destroy()
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"YmGfg099leAlH8WCU0L-1","name":"reset","brief":"reset the container, removing all childrens, and reseting transforms.
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"0F3FUjbj1KPDIxxsdQg3Q","name":"resize","brief":"","scope":"instance","type":"MethodDoc","description":"resize the rectangle
","params":[{"identifier":"w","optional":false,"description":"new width of the rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"h","optional":false,"description":"new height of the rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"AEbULxLG1wxOgNB6N_k36","name":"rotate","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this renderable by the specified angle (in radians).
","params":[{"identifier":"angle","optional":false,"description":"The angle to rotate (in radians)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":true,"description":"an optional point to rotate around
","dataType":{"tokens":[{"value":"Vector2d | ObservableVector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"4ANgzSVX2oxomLRquYMOf","name":"scale","brief":"","scope":"instance","type":"MethodDoc","description":"scale the renderable around his anchor point. Scaling actually applies changes\nto the currentTransform member wich is use...","params":[{"identifier":"x","optional":false,"description":"
a number representing the abscissa of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":true,"default":"x","description":"a number representing the ordinate of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"9pyskZXvT_QkbYyLRMSvM","name":"scaleV","brief":"","scope":"instance","type":"MethodDoc","description":"scale the renderable around his anchor point
","params":[{"identifier":"v","optional":false,"description":"scaling vector
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"mxE7-FEPsl1fOFAQClnOA","name":"setChildsProperty","brief":"","scope":"instance","type":"MethodDoc","description":"Automatically set the specified property of all childs to the given value
","params":[{"identifier":"prop","optional":false,"description":"property name
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"value","optional":false,"description":"property value
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}},{"identifier":"recursive","optional":true,"default":"false","description":"recursively apply the value to child containers if true
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"6Kj3ThksfU5mdilQHLLso","name":"setOpacity","brief":"","scope":"instance","type":"MethodDoc","description":"set the renderable alpha channel value
","params":[{"identifier":"alpha","optional":false,"description":"opacity value between 0.0 and 1.0
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"fsAyxwdWUYL_sJjrrAAoi","name":"setShape","brief":"","scope":"instance","type":"MethodDoc","description":"set new value to the rectangle shape
","params":[{"identifier":"x","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"w","optional":false,"description":"width of the rectangle, or an array of vector defining the rectangle
","dataType":{"tokens":[{"value":"number | Array","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %3<%2>"}},{"identifier":"h","optional":true,"description":"height of the rectangle, if a numeral width parameter is specified
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"bhJI--QXGCsNhzYe7IbAc","name":"setVertices","brief":"","scope":"instance","type":"MethodDoc","description":"set the vertices defining this Polygon
","params":[{"identifier":"vertices","optional":false,"description":"array of vector or vertice defining the Polygon
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1<%2>"}}],"returns":[{"description":"this instance for objecf chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"yqOA7ZEYvFaFBIuTx7RbP","name":"shift","brief":"","examples":[{"caption":"","code":"polygon.shift(10, 10);\n// or\npolygon.shift(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"Shifts the Polygon to the given position vector.
","params":[{"identifier":"x","description":"x coordinate or a vector point to shift to
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"KhOtLsybLeFluBBKFHh9C","name":"sort","brief":"","scope":"instance","type":"MethodDoc","description":"Manually trigger the sort of all the childs in the container
","params":[{"identifier":"recursive","optional":true,"default":"false","description":"recursively sort all containers if true
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"G4WqFwen1MAq2IonGOA9c","name":"swapChildren","brief":"","scope":"instance","type":"MethodDoc","description":"Swaps the position (z-index) of 2 children
","params":[{"identifier":"child","optional":false,"description":"Child to be added
","dataType":{"tokens":[{"value":"Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"Collectable","kind":"link"},{"value":"Trigger","kind":"link"},{"value":"Draggable","kind":"link"},{"value":"DropTarget","kind":"link"},{"value":"NineSliceSprite","kind":"link"},{"value":"ImageLayer","kind":"link"},{"value":"ColorLayer","kind":"link"},{"value":"Light2d","kind":"link"},{"value":"UIBaseElement","kind":"link"},{"value":"UISpriteElement","kind":"link"},{"value":"UITextButton","kind":"link"},{"value":"Text","kind":"link"},{"value":"BitmapText","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5 | %6 | %7 | %8 | %9 | %10 | %11 | %12 | %13 | %14 | %15 | %16"}},{"identifier":"child2","optional":false,"description":"Child to be added
","dataType":{"tokens":[{"value":"Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"Collectable","kind":"link"},{"value":"Trigger","kind":"link"},{"value":"Draggable","kind":"link"},{"value":"DropTarget","kind":"link"},{"value":"NineSliceSprite","kind":"link"},{"value":"ImageLayer","kind":"link"},{"value":"ColorLayer","kind":"link"},{"value":"Light2d","kind":"link"},{"value":"UIBaseElement","kind":"link"},{"value":"UISpriteElement","kind":"link"},{"value":"UITextButton","kind":"link"},{"value":"Text","kind":"link"},{"value":"BitmapText","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5 | %6 | %7 | %8 | %9 | %10 | %11 | %12 | %13 | %14 | %15 | %16"}}],"returns":[],"extends":[],"implements":[]},{"id":"cbn15Y07gFxE6mNL4Iz2v","name":"to2d","brief":"","scope":"instance","type":"MethodDoc","description":"apply a 2d projection to this shapen
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"UhWJYuvmv7Z49P7DK4HNd","name":"toIso","brief":"","scope":"instance","type":"MethodDoc","description":"apply an isometric projection to this shape
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"ui-G3yox8YVKp5EWHwsSD","name":"toPolygon","brief":"","scope":"instance","type":"MethodDoc","description":"Returns a polygon whose edges are the same as this box.
","params":[],"returns":[{"description":"a new Polygon that represents this rectangle.
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"rF1nE2t0UwXDusGVLKFKN","name":"transform","brief":"","scope":"instance","see":["Renderable#currentTransform"],"type":"MethodDoc","description":"multiply the renderable currentTransform with the given matrix
","params":[{"identifier":"m","optional":false,"description":"the transformation matrix
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Y61ry20noPEcfwLfKpDxe","name":"translate","brief":"","examples":[{"caption":"","code":"polygon.translate(10, 10);\n// or\npolygon.translate(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"translate the Polygon by the specified offset
","params":[{"identifier":"x","description":"x offset or a vector point to translate by
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"description":"y offset
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"tF1BtKYVamFUz0vnLsRMf","name":"union","brief":"","scope":"instance","type":"MethodDoc","description":"merge this rectangle with another one
","params":[{"identifier":"rect","optional":false,"description":"other rectangle to union with
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"the union(ed) rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"TYlP1pS2WE-Eg_Qr6-p27","name":"updateBounds","brief":"","scope":"instance","type":"MethodDoc","description":"update the bounding box for this container.
","params":[{"identifier":"absolute","optional":true,"default":"true","description":"update the bounds size and position in (world) absolute coordinates
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"this container bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"MTsJ8Se8ygAOQa0zpbNgF","name":"draw","brief":"","access":"protected","scope":"instance","type":"MethodDoc","description":"draw this renderable (automatically called by melonJS)
","params":[{"identifier":"renderer","optional":false,"description":"a renderer instance
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}},{"identifier":"viewport","optional":true,"description":"the viewport to (re)draw
","dataType":{"tokens":[{"value":"Camera2d","kind":"canonical"},{"value":"Camera2d","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"K6rURJp1dZGMCrb3KofIi","name":"update","brief":"","access":"protected","scope":"instance","type":"MethodDoc","description":"container update function.
","params":[{"identifier":"dt","optional":false,"description":"time since the last update in milliseconds.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"true if the Container is dirty
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"wmMRbAsz2fasdjSYlwHZm","name":"onAnchorUpdate","brief":"","access":"private","scope":"instance","type":"MethodDoc","description":"called when the anchor point value is changed
","params":[{"identifier":"x","optional":false,"description":"the new X value to be set for the anchor
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the new Y value to be set for the anchor
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]}]},{"id":"LfWR2KeJwDYFZuRodVK1B","name":"Detector","brief":"the Detector class contains methods for detecting collisions between bodies using a broadphase algorithm.
","type":"ClassDoc","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"5deTGnoqlzNfNoHlmsw65","name":"response","brief":"","scope":"instance","type":"PropertyDoc","description":"the default response object used for collisions\n(will be automatically populated by the collides functions)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"1NsaQOuR_8jsiMqUCU9Dk","name":"collides","brief":"","scope":"instance","type":"MethodDoc","description":"detect collision between two bodies.
","params":[{"identifier":"bodyA","optional":false,"description":"a reference to body A.
","dataType":{"tokens":[{"value":"Body","kind":"canonical"},{"value":"Body","kind":"link"}],"template":"%1"}},{"identifier":"bodyB","optional":false,"description":"a reference to body B.
","dataType":{"tokens":[{"value":"Body","kind":"canonical"},{"value":"Body","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if colliding
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"c-H44EB06j80bgyAu-NJm","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"world","optional":false,"description":"the physic world this detector is bind to
","dataType":{"tokens":[{"value":"Container","kind":"canonical"},{"value":"Container","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"mTVp1crUKmZfxX8CMYfy4","name":"shouldCollide","brief":"","scope":"instance","type":"MethodDoc","description":"determine if two objects should collide (based on both respective objects body collision mask and type).
a reference to the object A.
","dataType":{"tokens":[{"value":"Renderable | Container | Entity | Sprite | NineSliceSprite","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Container","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"NineSliceSprite","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5"}},{"identifier":"b","optional":false,"description":"a reference to the object B.
","dataType":{"tokens":[{"value":"Renderable | Container | Entity | Sprite | NineSliceSprite","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Container","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"NineSliceSprite","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5"}}],"returns":[{"description":"true if they should collide, false otherwise
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]}]},{"id":"o6Ex3fTR7Y7RwQoQowcex","name":"Draggable","brief":"","see":["DropTarget"],"type":"ClassDoc","description":"A Draggable base object
","params":[],"returns":[],"extends":["Renderable"],"implements":[],"members":[{"id":"INkAnPQiTy8J3zOHkH03k","name":"alpha","brief":"","defaultValue":"1.0","scope":"instance","see":["Renderable#setOpacity","Renderable#getOpacity"],"type":"PropertyDoc","description":"Define the renderable opacity
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"2jdvVPqUOgedOu0bB-m6t","name":"alwaysUpdate","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object will always update, even when outside of the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"OR3gMnWheUSthCCKcFSQU","name":"ancestor","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"a reference to the parent object that contains this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"fVjbTViB8RywfMICfmgdC","name":"anchorPoint","brief":"","defaultValue":"<0.5,0.5>","scope":"instance","type":"PropertyDoc","description":"The anchor point is used for attachment behavior, and/or when applying transformations.
When enabled, an object container will automatically apply\nany defined transformation before calling the child draw method...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"NDBd6SiDQXQueYZTr2n2l","name":"blendMode","brief":"","defaultValue":"\"normal\"","scope":"instance","see":["CanvasRenderer#setBlendMode","WebGLRenderer#setBlendMode"],"type":"PropertyDoc","description":"
the blend mode to be applied to this renderable (see renderer setBlendMode for available blend mode)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"L68X4M_IxborN_RxH4Jur","name":"body","brief":"","examples":[{"caption":"","code":" // define a new Player Class\n class PlayerEntity extends me.Sprite {\n // constructor\n constructor(x, y, settings) {\n // call the parent constructor\n super(x, y , settings);\n\n // define a basic walking animation\n this.addAnimation(\"walk\", [...]);\n // define a standing animation (using the first frame)\n this.addAnimation(\"stand\", [...]);\n // set the standing animation as default\n this.setCurrentAnimation(\"stand\");\n\n // add a physic body\n this.body = new me.Body(this);\n // add a default collision shape\n this.body.addShape(new me.Rect(0, 0, this.width, this.height));\n // configure max speed, friction, and initial force to be applied\n this.body.setMaxVelocity(3, 15);\n this.body.setFriction(0.4, 0);\n this.body.force.set(3, 0);\n this.isKinematic = false;\n\n // set the display to follow our position on both axis\n me.game.viewport.follow(this.pos, me.game.viewport.AXIS.BOTH);\n }\n\n ...\n\n }"}],"scope":"instance","type":"PropertyDoc","description":"the renderable physic body
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"hydXw-UiGLkNCcHvPx33z","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"rbORM2FgyXdK79d_JpjhG","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"AGvUZYSNljMRPOwOZq-Tc","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"wlJE4cwvusjBuw0-nY1Dq","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"pSz3Eg8lbvvn3AtuWyqhC","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"f2394sZOchD-9DjlDkXJa","name":"floating","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"If true, this renderable will be rendered using screen coordinates,\nas opposed to world coordinates. Use this, for example...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"MP-xjs32hOtamKjvElXts","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"
(G)ame (U)nique (Id)entifier"
height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ByCdap3et48YdfmVfibzG","name":"inViewport","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object is visible and within the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"O-gHFVa3bIm_FKQatkEGj","name":"isDirty","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"when true the renderable will be redrawn during the next update cycle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"dtvf--y7ulz9iBZEXtMTQ","name":"isFlippedX","brief":"","access":"public","scope":"instance","see":["Renderable#flipX"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"XwVBD2XdULDtyUFI1uXiP","name":"isFlippedY","brief":"","access":"public","scope":"instance","see":["Renderable#flipY"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"9TxWPtq7cJmcjZa8TNwBw","name":"isFloating","brief":"","scope":"instance","see":["Renderable#floating"],"type":"PropertyDoc","description":"Whether the renderable object is floating (i.e. used screen coordinates), or contained in a floating parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"LhQ7PZglQBFDuQFR3P801","name":"isKinematic","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"If true then physic collision and input events will not impact this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"tdWM_Q8BVuEVQoZB4Ldp-","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"4w840h9Rj5KjgERz0XM2Z","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"A4w1WNbmPCCxymd9zCcqE","name":"mask","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"// apply a mask in the shape of a Star\nmyNPCSprite.mask = new me.Polygon(myNPCSprite.width / 2, 0, [\n // draw a star\n {x: 0, y: 0},\n {x: 14, y: 30},\n {x: 47, y: 35},\n {x: 23, y: 57},\n {x: 44, y: 90},\n {x: 0, y: 62},\n {x: -44, y: 90},\n {x: -23, y: 57},\n {x: -47, y: 35},\n {x: -14, y: 30}\n]);"}],"scope":"instance","type":"PropertyDoc","description":"A mask limits rendering elements to the shape and position of the given mask object.\nSo, if the renderable is larger than ...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"oGU9kMcPfUTX9lbuGvKPh","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"IZ0hdKG70fEZcsi9YlNEO","name":"onVisibilityChange","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"this.onVisibilityChange = function(inViewport) {\n if (inViewport === true) {\n console.log(\"object has entered the in a camera viewport!\");\n }\n};"}],"scope":"instance","type":"PropertyDoc","description":"an event handler that is called when the renderable leave or enter a camera viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"vJ-keTDF3VxYWotxtyfdD","name":"parentApp","brief":"","scope":"instance","type":"PropertyDoc","description":"returns the parent application (or game) to which this renderable is attached to
","params":[],"returns":[{"description":"the parent application or undefined if not attached to any container/app
","dataType":{"tokens":[{"value":"Application","kind":"canonical"},{"value":"Application","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"xOFes1AjZKrZfnodBnJ1A","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"AetkgjP14uml84cSOEKbl","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"_zfWdQJ3IyMAMvFdQeoxs","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"hFxPxFyMmcdYzZrVouUcr","name":"shader","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"(Experimental) an optional shader, to be used instead of the default built-in one, when drawing this renderable (WebGL onl...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"he76huPzIBkTEUxCzn24P","name":"tint","brief":"","defaultValue":"(255, 255, 255)","examples":[{"caption":"","code":"// add a red tint to this renderable\nthis.tint.setColor(255, 128, 128);\n// remove the tint\nthis.tint.setColor(255, 255, 255);"}],"scope":"instance","type":"PropertyDoc","description":"
define a tint for this renderable. a (255, 255, 255) r, g, b value will remove the tint effect.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"k47sLmZIUpn14BrRCxu6_","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"mFpR0ONvVmWre1mGB0MSP","name":"type","brief":"","defaultValue":"\"Rectangle\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"qFeR396JK5GWDWCtdf8gq","name":"updateWhenPaused","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether to update this object when the game is paused.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"iONFzudkZdvk84FX-I6ov","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Ek5Gj7qIUS94-_XDZT7t4","name":"angleTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the angle to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"angle in radians
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"P0gdhfZhfbiwYaQXvkuTm","name":"centerOn","brief":"","scope":"instance","type":"MethodDoc","description":"center the rectangle position around the given coordinates
","params":[{"identifier":"x","optional":false,"description":"the x coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"-C_c0dDbWWjHtlVNuitnx","name":"clone","brief":"","scope":"instance","type":"MethodDoc","description":"clone this rectangle
","params":[],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"o4xOFuFmzwfG0EYLiJTom","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"x","optional":false,"description":"the x coordinates of the draggable object
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y coordinates of the draggable object
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"width","optional":false,"description":"draggable object width
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"height","optional":false,"description":"draggable object height
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"KkSWLSEyV4PvG-BGzSEja","name":"contains","brief":"","examples":[{"caption":"","code":"if (rect.contains(10, 10)) {\n // do something\n}\n// or\nif (rect.contains(myVector2d)) {\n // do something\n}\nif (rect.contains(myRect)) {\n // do something\n}"}],"scope":"instance","type":"MethodDoc","description":"Returns true if the rectangle contains the given point or rectangle
","params":[{"identifier":"x","description":"x coordinate or a vector point, or a rectangle to test
","dataType":{"tokens":[{"value":"number | Vector2d | Rect","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Rect","kind":"link"}],"template":"%1 | %2 | %3"}},{"identifier":"y","optional":true,"description":"y coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"True if the rectangle contain the given point or rectangle, otherwise false
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"F4xVYXr3Har9HeCiWTHj6","name":"copy","brief":"","scope":"instance","type":"MethodDoc","description":"copy the position and size of the given rectangle into this one
","params":[{"identifier":"rect","optional":false,"description":"Source rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"uyb3UL0i8rz1xtlNYloAC","name":"distanceTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the distance to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"distance
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Md4Et6azHM9OYK-LXFHQ_","name":"dragEnd","brief":"","scope":"instance","type":"MethodDoc","description":"Gets called when the user stops dragging the entity
","params":[],"returns":[{"description":"false if the object stopped being dragged
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"Giep2gq-i_z-JpMm1UXC_","name":"dragMove","brief":"","scope":"instance","type":"MethodDoc","description":"Gets called when the user drags this entity around
","params":[{"identifier":"e","optional":false,"description":"the pointer event
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}}],"returns":[],"extends":[],"implements":[]},{"id":"SV-W3V4NXGkQUVwTLARJK","name":"dragStart","brief":"","scope":"instance","type":"MethodDoc","description":"Gets called when the user starts dragging the entity
","params":[{"identifier":"e","optional":false,"description":"the pointer event
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}}],"returns":[{"description":"false if the object is being dragged
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"49k7e9B5eBbcd59_4cCBG","name":"draw","brief":"","scope":"instance","see":["Renderable#preDraw","Renderable#postDraw"],"type":"MethodDoc","description":"Draw this renderable (automatically called by melonJS).\nAll draw operations for renderable are made respectively\nto the po...","params":[{"identifier":"renderer","optional":false,"description":"
a renderer instance
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}},{"identifier":"viewport","optional":true,"description":"the viewport to (re)draw
","dataType":{"tokens":[{"value":"Camera2d","kind":"canonical"},{"value":"Camera2d","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"3bHYD6P2qmiUVadmgMRjm","name":"equals","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is identical to the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if equals
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"7r-xYbxx5SRauSN7_M1Zi","name":"flipX","brief":"","scope":"instance","see":["Matrix2d#scaleX"],"type":"MethodDoc","description":"flip the renderable on the horizontal axis (around the center of the renderable)
","params":[{"identifier":"flip","optional":true,"default":"true","description":"true to flip this renderable.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"BtaB3SW3gCqK69-pzaq3Z","name":"flipY","brief":"","scope":"instance","see":["Matrix2d#scaleY"],"type":"MethodDoc","description":"flip the renderable on the vertical axis (around the center of the renderable)
","params":[{"identifier":"flip","optional":true,"default":"true","description":"true to flip this renderable.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"5mgh0z-ls9b-aJJ9rd47T","name":"getAbsolutePosition","brief":"","scope":"instance","type":"MethodDoc","description":"return the renderable absolute position in the game world
","params":[],"returns":[{"dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"6HVzYDZ-lzd69AKXZkdMb","name":"getBounds","brief":"","scope":"instance","type":"MethodDoc","description":"returns the bounding box for this renderable
","params":[],"returns":[{"description":"bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Ud0v4uhH7uDooSGJ9dydH","name":"getIndices","brief":"","scope":"instance","type":"MethodDoc","description":"returns a list of indices for all triangles defined in this polygon
","params":[],"returns":[{"description":"an array of vertex indices for all triangles forming this polygon.
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1<%2>"}}],"extends":[],"implements":[]},{"id":"vqdnvWdtjVTbwdB4HFQBj","name":"getOpacity","brief":"","scope":"instance","type":"MethodDoc","description":"get the renderable alpha channel value
","params":[],"returns":[{"description":"current opacity value between 0 and 1
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"x2G92HlUotGvQW0z-i0IO","name":"isConvex","brief":"","scope":"instance","type":"MethodDoc","description":"Returns true if the vertices composing this polygon form a convex shape (vertices must be in clockwise order).
","params":[],"returns":[{"description":"true if the vertices are convex, false if not, null if not computable
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"NWKESFAZTVYeI9NfawZjY","name":"isFinite","brief":"","scope":"instance","type":"MethodDoc","description":"determines whether all coordinates of this rectangle are finite numbers.
","params":[],"returns":[{"description":"false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"PHwVXDIX_rYATULP8oQxZ","name":"lookAt","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this renderable towards the given target.
","params":[{"identifier":"target","optional":false,"description":"the renderable or position to look at
","dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"yzMe1aGM-419JRt79TDx8","name":"onCollision","brief":"","examples":[{"caption":"","code":"// colision handler\nonCollision(response) {\n if (response.b.body.collisionType === me.collision.types.ENEMY_OBJECT) {\n // makes the other object solid, by substracting the overlap vector to the current position\n this.pos.sub(response.overlapV);\n this.hurt();\n // not solid\n return false;\n }\n // Make the object solid\n return true;\n},"}],"scope":"instance","type":"MethodDoc","description":"onCollision callback, triggered in case of collision,\nwhen this renderable body is colliding with another one
","params":[{"identifier":"response","optional":false,"description":"the collision response object
","dataType":{"tokens":[{"value":"ResponseObject","kind":"canonical"},{"value":"ResponseObject","kind":"link"}],"template":"%1"}},{"identifier":"other","optional":false,"description":"the other renderable touching this one (a reference to response.a or response.b)
","dataType":{"tokens":[{"value":"Renderable | Container | Entity | Sprite | NineSliceSprite","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Container","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"NineSliceSprite","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5"}}],"returns":[{"description":"true if the object should respond to the collision (its position and velocity will be corrected)
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"MG10__qQfjayYF0SOTNHo","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"OnDestroy Notification function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"xxNBmgcU5Kio2txlm2kkm","name":"overlaps","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is intersecting with the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if overlaps
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"vn0DMiF5vhjhvJV957EhA","name":"postDraw","brief":"","scope":"instance","see":["Renderable#preDraw","Renderable#draw"],"type":"MethodDoc","description":"restore the rendering context after drawing (automatically called by melonJS).
","params":[{"identifier":"renderer","optional":false,"description":"a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"BNS71S1FGprcdCiAgbgoz","name":"preDraw","brief":"","scope":"instance","see":["Renderable#draw","Renderable#postDraw"],"type":"MethodDoc","description":"Prepare the rendering context before drawing (automatically called by melonJS).\nThis will apply any defined transforms, an...","params":[{"identifier":"renderer","optional":false,"description":"
a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"Oh2usAaNmfDgm4jLy1znw","name":"recalc","brief":"","scope":"instance","type":"MethodDoc","description":"Computes the calculated collision polygon.\nThis must be called if the points array, an...","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"HauJktN1pzFOzXVe9oY4u","name":"resize","brief":"","scope":"instance","type":"MethodDoc","description":"resize the rectangle
","params":[{"identifier":"w","optional":false,"description":"new width of the rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"h","optional":false,"description":"new height of the rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"6cSzM032UV-7wpmhTdHcN","name":"rotate","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this renderable by the specified angle (in radians).
","params":[{"identifier":"angle","optional":false,"description":"The angle to rotate (in radians)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":true,"description":"an optional point to rotate around
","dataType":{"tokens":[{"value":"Vector2d | ObservableVector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"2K09KyooIkNVR0k0LWRCl","name":"scale","brief":"","scope":"instance","type":"MethodDoc","description":"scale the renderable around his anchor point. Scaling actually applies changes\nto the currentTransform member wich is use...","params":[{"identifier":"x","optional":false,"description":"
a number representing the abscissa of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":true,"default":"x","description":"a number representing the ordinate of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"eQDf55HifeQKYpkan6WOk","name":"scaleV","brief":"","scope":"instance","type":"MethodDoc","description":"scale the renderable around his anchor point
","params":[{"identifier":"v","optional":false,"description":"scaling vector
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"dIcaf8f-q4yfpF2A8hb0z","name":"setOpacity","brief":"","scope":"instance","type":"MethodDoc","description":"set the renderable alpha channel value
","params":[{"identifier":"alpha","optional":false,"description":"opacity value between 0.0 and 1.0
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"dTYZEJp50FtHLmNXCidH7","name":"setShape","brief":"","scope":"instance","type":"MethodDoc","description":"set new value to the rectangle shape
","params":[{"identifier":"x","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"w","optional":false,"description":"width of the rectangle, or an array of vector defining the rectangle
","dataType":{"tokens":[{"value":"number | Array","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %3<%2>"}},{"identifier":"h","optional":true,"description":"height of the rectangle, if a numeral width parameter is specified
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"7SAVG_ogUSnUQQRyR1eIv","name":"setVertices","brief":"","scope":"instance","type":"MethodDoc","description":"set the vertices defining this Polygon
","params":[{"identifier":"vertices","optional":false,"description":"array of vector or vertice defining the Polygon
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1<%2>"}}],"returns":[{"description":"this instance for objecf chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"p8nSrulaW0yH2b8M1w6ue","name":"shift","brief":"","examples":[{"caption":"","code":"polygon.shift(10, 10);\n// or\npolygon.shift(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"Shifts the Polygon to the given position vector.
","params":[{"identifier":"x","description":"x coordinate or a vector point to shift to
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"7DBnG5eFa76SxvSPGS0sO","name":"to2d","brief":"","scope":"instance","type":"MethodDoc","description":"apply a 2d projection to this shapen
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"aZc5DK_CX5zwkMe4IZhV8","name":"toIso","brief":"","scope":"instance","type":"MethodDoc","description":"apply an isometric projection to this shape
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"hNDOWvSXZ9DP7OpHcfD4r","name":"toPolygon","brief":"","scope":"instance","type":"MethodDoc","description":"Returns a polygon whose edges are the same as this box.
","params":[],"returns":[{"description":"a new Polygon that represents this rectangle.
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"XdqFOvsqKbNbDKiEQjw-b","name":"transform","brief":"","scope":"instance","see":["Renderable#currentTransform"],"type":"MethodDoc","description":"multiply the renderable currentTransform with the given matrix
","params":[{"identifier":"m","optional":false,"description":"the transformation matrix
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"xhbGPuM195lBiTauspYPK","name":"translate","brief":"","examples":[{"caption":"","code":"polygon.translate(10, 10);\n// or\npolygon.translate(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"translate the Polygon by the specified offset
","params":[{"identifier":"x","description":"x offset or a vector point to translate by
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"description":"y offset
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"K9WL9pySNQeZJQS0ubIVO","name":"union","brief":"","scope":"instance","type":"MethodDoc","description":"merge this rectangle with another one
","params":[{"identifier":"rect","optional":false,"description":"other rectangle to union with
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"the union(ed) rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"DoX76z1pRlaoICFv4GLlr","name":"update","brief":"","scope":"instance","type":"MethodDoc","description":"update function (automatically called by melonJS).
","params":[{"identifier":"dt","optional":false,"description":"time since the last update in milliseconds.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"true if the renderable is dirty
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"B5QBghCELjzxOM5Eh3Qdn","name":"updateBounds","brief":"","scope":"instance","type":"MethodDoc","description":"update the bounding box for this shape.
","params":[{"identifier":"absolute","optional":true,"default":"true","description":"update the bounds size and position in (world) absolute coordinates
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"this shape bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"k76zFkkWwa8bj9NMmpUPP","name":"initEvents","brief":"","access":"private","scope":"instance","type":"MethodDoc","description":"Initializes the events the modules needs to listen to\nIt translates the pointer events to me.events\nin order to make them ...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"dfuUSHTbC0qLNZ-_21Jy8","name":"onAnchorUpdate","brief":"","access":"private","scope":"instance","type":"MethodDoc","description":"
called when the anchor point value is changed
","params":[{"identifier":"x","optional":false,"description":"the new X value to be set for the anchor
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the new Y value to be set for the anchor
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]}]},{"id":"2kshQ-FZtY6qcCWLoq9Jv","name":"DraggableEntity","brief":"","deprecated":"since 10.5.0","see":["Draggable"],"type":"ClassDoc","description":"Used to make a game entity draggable
","params":[],"returns":[],"extends":["Entity"],"implements":[],"members":[{"id":"m39QwUbFvb0EaV7X5XS2w","name":"alive","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"dead/living state of the entity
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"5blVdaPWp6JOfJsaRwF4n","name":"alpha","brief":"","defaultValue":"1.0","scope":"instance","see":["Renderable#setOpacity","Renderable#getOpacity"],"type":"PropertyDoc","description":"Define the renderable opacity
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"EYIa3EPwPOEH4pe6qN7o7","name":"alwaysUpdate","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object will always update, even when outside of the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"9v0COKsZhUEasdGyn7pgV","name":"ancestor","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"a reference to the parent object that contains this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"8t55vANosyEQ1t-K5-lI9","name":"anchorPoint","brief":"","defaultValue":"<0.5,0.5>","scope":"instance","type":"PropertyDoc","description":"The anchor point is used for attachment behavior, and/or when applying transformations.
When enabled, an object container will automatically apply\nany defined transformation before calling the child draw method...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"KbvPuf0mquZC_YDlG7pN5","name":"blendMode","brief":"","defaultValue":"\"normal\"","scope":"instance","see":["CanvasRenderer#setBlendMode","WebGLRenderer#setBlendMode"],"type":"PropertyDoc","description":"
the blend mode to be applied to this renderable (see renderer setBlendMode for available blend mode)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"VFuUncVEvsUxDI20uPdeS","name":"body","brief":"","scope":"instance","type":"PropertyDoc","description":"the entity body object
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"k1kVN_IIiKel65gadSf-P","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ULIDjXCH1dQzeHKOUVqEb","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"8gm115Fs9vbLW9aIgwqAz","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"5HypS1aeRK5K87d2PrPhz","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Al81XuazBBkJFuc7dVtbI","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"G_DZqIfd4LhgxEMq1_dvp","name":"floating","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"If true, this renderable will be rendered using screen coordinates,\nas opposed to world coordinates. Use this, for example...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Oi7vtjR7raGYFwN853Be1","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"
(G)ame (U)nique (Id)entifier"
height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"h-ck3tkr8gnCbwcCJGv1i","name":"id","brief":"","scope":"instance","type":"PropertyDoc","description":"object unique ID (as defined in Tiled)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"bRzUJO_xDuhgX0qIbyfqa","name":"inViewport","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object is visible and within the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"SJ4rdoa4TROxFGQRqU08z","name":"isDirty","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"when true the renderable will be redrawn during the next update cycle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"kZlBWeHgjnGKF8KHGo4Ou","name":"isFlippedX","brief":"","access":"public","scope":"instance","see":["Renderable#flipX"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"oWbQXNaDHw8FfBbf_pmgY","name":"isFlippedY","brief":"","access":"public","scope":"instance","see":["Renderable#flipY"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"olkpupHWBU8pBXkrgR6H8","name":"isFloating","brief":"","scope":"instance","see":["Renderable#floating"],"type":"PropertyDoc","description":"Whether the renderable object is floating (i.e. used screen coordinates), or contained in a floating parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"7Esz00Z9tEkWmRSlPxMQh","name":"isKinematic","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"If true then physic collision and input events will not impact this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"xZ1iFGPvtXEutuSF483MT","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"DWfhVeZeMc_wXbfqTEQc8","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"vDOEvwxIWS9eSpw783Wzk","name":"mask","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"// apply a mask in the shape of a Star\nmyNPCSprite.mask = new me.Polygon(myNPCSprite.width / 2, 0, [\n // draw a star\n {x: 0, y: 0},\n {x: 14, y: 30},\n {x: 47, y: 35},\n {x: 23, y: 57},\n {x: 44, y: 90},\n {x: 0, y: 62},\n {x: -44, y: 90},\n {x: -23, y: 57},\n {x: -47, y: 35},\n {x: -14, y: 30}\n]);"}],"scope":"instance","type":"PropertyDoc","description":"A mask limits rendering elements to the shape and position of the given mask object.\nSo, if the renderable is larger than ...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"97OuLHgdpmNicVHZWnMeT","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"FPPyjLqyvAtqpqzZwK4Lw","name":"onVisibilityChange","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"this.onVisibilityChange = function(inViewport) {\n if (inViewport === true) {\n console.log(\"object has entered the in a camera viewport!\");\n }\n};"}],"scope":"instance","type":"PropertyDoc","description":"an event handler that is called when the renderable leave or enter a camera viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"RHveapNG-dsxJWVEohReU","name":"parentApp","brief":"","scope":"instance","type":"PropertyDoc","description":"returns the parent application (or game) to which this renderable is attached to
","params":[],"returns":[{"description":"the parent application or undefined if not attached to any container/app
","dataType":{"tokens":[{"value":"Application","kind":"canonical"},{"value":"Application","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"m-FLItQiipGIHJk8B0pA2","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"rGS0OfsKO-YUbl1NtRYHe","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"pmcDEGZXs_CFPmgehzZRU","name":"renderable","brief":"","scope":"instance","type":"PropertyDoc","description":"The entity renderable component (can be any objects deriving from me.Renderable, like me.Sprite for example)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"jagfZuEtr9CIt8IxTPFxA","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"tpJLOphxC4ffSbxypBpha","name":"shader","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"(Experimental) an optional shader, to be used instead of the default built-in one, when drawing this renderable (WebGL onl...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"_qe3DzMNhrs5kdWUOTNkl","name":"tint","brief":"","defaultValue":"(255, 255, 255)","examples":[{"caption":"","code":"// add a red tint to this renderable\nthis.tint.setColor(255, 128, 128);\n// remove the tint\nthis.tint.setColor(255, 255, 255);"}],"scope":"instance","type":"PropertyDoc","description":"
define a tint for this renderable. a (255, 255, 255) r, g, b value will remove the tint effect.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"JVQCf9hE-eMScHraU21RG","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"uYMv0_Rg2DHBFqIexjpgS","name":"type","brief":"","scope":"instance","type":"PropertyDoc","description":"object type (as defined in Tiled)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"5m3KfLXZQkvSssSxihOcj","name":"updateWhenPaused","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether to update this object when the game is paused.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Brt72O3rq4fl_MNz51KG2","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"FYuaqIAXP2bGQsfqEZi_T","name":"angleTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the angle to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"angle in radians
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"X5kwi6sUabXihfTCAKquD","name":"centerOn","brief":"","scope":"instance","type":"MethodDoc","description":"center the rectangle position around the given coordinates
","params":[{"identifier":"x","optional":false,"description":"the x coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"W4kds1g3A8jGqpRaQ6tFs","name":"clone","brief":"","scope":"instance","type":"MethodDoc","description":"clone this rectangle
","params":[],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"lIOJotEQpfe4IJ74H4650","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"x","optional":false,"description":"the x coordinates of the draggable object
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y coordinates of the draggable object
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings","optional":false,"description":"Entity properties (see {@link Entity})
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}}],"returns":[],"extends":[],"implements":[]},{"id":"c2mj1J9_GCHSzGwqN5G7J","name":"contains","brief":"","examples":[{"caption":"","code":"if (rect.contains(10, 10)) {\n // do something\n}\n// or\nif (rect.contains(myVector2d)) {\n // do something\n}\nif (rect.contains(myRect)) {\n // do something\n}"}],"scope":"instance","type":"MethodDoc","description":"Returns true if the rectangle contains the given point or rectangle
","params":[{"identifier":"x","description":"x coordinate or a vector point, or a rectangle to test
","dataType":{"tokens":[{"value":"number | Vector2d | Rect","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Rect","kind":"link"}],"template":"%1 | %2 | %3"}},{"identifier":"y","optional":true,"description":"y coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"True if the rectangle contain the given point or rectangle, otherwise false
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"FzJU9IXHi92QHGH8oa7qD","name":"copy","brief":"","scope":"instance","type":"MethodDoc","description":"copy the position and size of the given rectangle into this one
","params":[{"identifier":"rect","optional":false,"description":"Source rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"1XKZj-YUlpY6bAU2RmLb6","name":"distanceTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the distance to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"distance
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"2OUtDEJkKbC4dCTOj-_4j","name":"equals","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is identical to the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if equals
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"ChH8FZB-HbM6HJXtyabIH","name":"flipX","brief":"","scope":"instance","see":["Matrix2d#scaleX"],"type":"MethodDoc","description":"flip the renderable on the horizontal axis (around the center of the renderable)
","params":[{"identifier":"flip","optional":true,"default":"true","description":"true to flip this renderable.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"RPxKtM8_98NoZzwLGRx8R","name":"flipY","brief":"","scope":"instance","see":["Matrix2d#scaleY"],"type":"MethodDoc","description":"flip the renderable on the vertical axis (around the center of the renderable)
","params":[{"identifier":"flip","optional":true,"default":"true","description":"true to flip this renderable.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"np7-UZg06KELMhUVkGzYu","name":"getAbsolutePosition","brief":"","scope":"instance","type":"MethodDoc","description":"return the renderable absolute position in the game world
","params":[],"returns":[{"dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"UB0RBI86CpMggpTmll8uF","name":"getBounds","brief":"","scope":"instance","type":"MethodDoc","description":"returns the bounding box for this renderable
","params":[],"returns":[{"description":"bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"KbVZysYUyUe65nQ0f2IeS","name":"getIndices","brief":"","scope":"instance","type":"MethodDoc","description":"returns a list of indices for all triangles defined in this polygon
","params":[],"returns":[{"description":"an array of vertex indices for all triangles forming this polygon.
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1<%2>"}}],"extends":[],"implements":[]},{"id":"6HQengxq4ZM4YhoUQgvdQ","name":"getOpacity","brief":"","scope":"instance","type":"MethodDoc","description":"get the renderable alpha channel value
","params":[],"returns":[{"description":"current opacity value between 0 and 1
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"bZ6akHSf53ICfRmB2zFlx","name":"isConvex","brief":"","scope":"instance","type":"MethodDoc","description":"Returns true if the vertices composing this polygon form a convex shape (vertices must be in clockwise order).
","params":[],"returns":[{"description":"true if the vertices are convex, false if not, null if not computable
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"iQS6GxM1nqXPWGF4Eme8l","name":"isFinite","brief":"","scope":"instance","type":"MethodDoc","description":"determines whether all coordinates of this rectangle are finite numbers.
","params":[],"returns":[{"description":"false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"9b-UMPS8zoeotGZ7zTVAA","name":"lookAt","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this renderable towards the given target.
","params":[{"identifier":"target","optional":false,"description":"the renderable or position to look at
","dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"clwxJFl-pM_e1rGr6CWDl","name":"onBodyUpdate","brief":"update the bounds when the body is modified
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"8RARTrr0WYYY5shonWDaw","name":"onCollision","brief":"","examples":[{"caption":"","code":"// colision handler\nonCollision(response) {\n if (response.b.body.collisionType === me.collision.types.ENEMY_OBJECT) {\n // makes the other object solid, by substracting the overlap vector to the current position\n this.pos.sub(response.overlapV);\n this.hurt();\n // not solid\n return false;\n }\n // Make the object solid\n return true;\n},"}],"scope":"instance","type":"MethodDoc","description":"onCollision callback, triggered in case of collision,\nwhen this renderable body is colliding with another one
","params":[{"identifier":"response","optional":false,"description":"the collision response object
","dataType":{"tokens":[{"value":"ResponseObject","kind":"canonical"},{"value":"ResponseObject","kind":"link"}],"template":"%1"}},{"identifier":"other","optional":false,"description":"the other renderable touching this one (a reference to response.a or response.b)
","dataType":{"tokens":[{"value":"Renderable | Container | Entity | Sprite | NineSliceSprite","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Container","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"NineSliceSprite","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5"}}],"returns":[{"description":"true if the object should respond to the collision (its position and velocity will be corrected)
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"eKrDXo2FgxoyboVYEuKVp","name":"onDeactivateEvent","brief":"onDeactivateEvent Notification function
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Wiqghp42GgAcfc1gcd8Lp","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"OnDestroy Notification function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"2NAfBjTTFcWKSfsJp_cIY","name":"overlaps","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is intersecting with the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if overlaps
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"zN7g97NFixCdKriMw9sQk","name":"postDraw","brief":"","scope":"instance","see":["Renderable#preDraw","Renderable#draw"],"type":"MethodDoc","description":"restore the rendering context after drawing (automatically called by melonJS).
","params":[{"identifier":"renderer","optional":false,"description":"a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"GDmiAimzXK-wIR0LID7HD","name":"preDraw","brief":"","scope":"instance","see":["Renderable#draw","Renderable#postDraw"],"type":"MethodDoc","description":"Prepare the rendering context before drawing (automatically called by melonJS).\nThis will apply any defined transforms, an...","params":[{"identifier":"renderer","optional":false,"description":"
a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"Zf58XEIHcwVcOhpaYxNK0","name":"recalc","brief":"","scope":"instance","type":"MethodDoc","description":"Computes the calculated collision polygon.\nThis must be called if the points array, an...","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"_Ceq4gwDyYdM-JwUpDyfa","name":"resize","brief":"","scope":"instance","type":"MethodDoc","description":"resize the rectangle
","params":[{"identifier":"w","optional":false,"description":"new width of the rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"h","optional":false,"description":"new height of the rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"lJw_fNC-op2a36y_GiZba","name":"rotate","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this renderable by the specified angle (in radians).
","params":[{"identifier":"angle","optional":false,"description":"The angle to rotate (in radians)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":true,"description":"an optional point to rotate around
","dataType":{"tokens":[{"value":"Vector2d | ObservableVector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"pptvVBwQvXpZzsueM0WWn","name":"scale","brief":"","scope":"instance","type":"MethodDoc","description":"scale the renderable around his anchor point. Scaling actually applies changes\nto the currentTransform member wich is use...","params":[{"identifier":"x","optional":false,"description":"
a number representing the abscissa of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":true,"default":"x","description":"a number representing the ordinate of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"NrwxNLIsfYURmgGNtmonT","name":"scaleV","brief":"","scope":"instance","type":"MethodDoc","description":"scale the renderable around his anchor point
","params":[{"identifier":"v","optional":false,"description":"scaling vector
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Jb4grXlCTCw2srquNRy6O","name":"setOpacity","brief":"","scope":"instance","type":"MethodDoc","description":"set the renderable alpha channel value
","params":[{"identifier":"alpha","optional":false,"description":"opacity value between 0.0 and 1.0
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"oYFSP-ZjruKgwsyzrNn9_","name":"setShape","brief":"","scope":"instance","type":"MethodDoc","description":"set new value to the rectangle shape
","params":[{"identifier":"x","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"w","optional":false,"description":"width of the rectangle, or an array of vector defining the rectangle
","dataType":{"tokens":[{"value":"number | Array","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %3<%2>"}},{"identifier":"h","optional":true,"description":"height of the rectangle, if a numeral width parameter is specified
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"o0DuX3-3MT_r1txv9n6-l","name":"setVertices","brief":"","scope":"instance","type":"MethodDoc","description":"set the vertices defining this Polygon
","params":[{"identifier":"vertices","optional":false,"description":"array of vector or vertice defining the Polygon
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1<%2>"}}],"returns":[{"description":"this instance for objecf chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Zkew9HAFix9DHQ7O74LXF","name":"shift","brief":"","examples":[{"caption":"","code":"polygon.shift(10, 10);\n// or\npolygon.shift(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"Shifts the Polygon to the given position vector.
","params":[{"identifier":"x","description":"x coordinate or a vector point to shift to
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"P6Uoa8dRBc-qGJfChui4E","name":"to2d","brief":"","scope":"instance","type":"MethodDoc","description":"apply a 2d projection to this shapen
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"2vvFXSQhQtBded6YZL20i","name":"toIso","brief":"","scope":"instance","type":"MethodDoc","description":"apply an isometric projection to this shape
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"z3k0F0aLII0M_h7rzDVNt","name":"toPolygon","brief":"","scope":"instance","type":"MethodDoc","description":"Returns a polygon whose edges are the same as this box.
","params":[],"returns":[{"description":"a new Polygon that represents this rectangle.
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Ejj-MM2XgY5nn4LkP29Xv","name":"transform","brief":"","scope":"instance","see":["Renderable#currentTransform"],"type":"MethodDoc","description":"multiply the renderable currentTransform with the given matrix
","params":[{"identifier":"m","optional":false,"description":"the transformation matrix
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"JuRcPU8HbrOs5gwilmI_f","name":"translate","brief":"","examples":[{"caption":"","code":"polygon.translate(10, 10);\n// or\npolygon.translate(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"translate the Polygon by the specified offset
","params":[{"identifier":"x","description":"x offset or a vector point to translate by
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"description":"y offset
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"VtAzdE7O0w_DjSah4gmgB","name":"union","brief":"","scope":"instance","type":"MethodDoc","description":"merge this rectangle with another one
","params":[{"identifier":"rect","optional":false,"description":"other rectangle to union with
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"the union(ed) rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"EHp4LEww3_5oFEOQk0waV","name":"update","brief":"","scope":"instance","type":"MethodDoc","description":"update function (automatically called by melonJS).
","params":[{"identifier":"dt","optional":false,"description":"time since the last update in milliseconds.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"true if the renderable is dirty
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"IFGOt7rfjQx08IY8pXZQL","name":"updateBounds","brief":"","scope":"instance","type":"MethodDoc","description":"update the bounding box for this entity.
","params":[{"identifier":"absolute","optional":true,"default":"true","description":"update the bounds size and position in (world) absolute coordinates
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"this entity bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"JtSRl98OB-GpY5zwuoNu2","name":"draw","brief":"","access":"protected","scope":"instance","type":"MethodDoc","description":"draw this entity (automatically called by melonJS)
","params":[{"identifier":"renderer","optional":false,"description":"a renderer instance
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}},{"identifier":"viewport","optional":true,"description":"the viewport to (re)draw
","dataType":{"tokens":[{"value":"Camera2d","kind":"canonical"},{"value":"Camera2d","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"_xAmE2FoE87QXn6g7rUN5","name":"onAnchorUpdate","brief":"","access":"private","scope":"instance","type":"MethodDoc","description":"called when the anchor point value is changed
","params":[{"identifier":"x","optional":false,"description":"the new X value to be set for the anchor
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the new Y value to be set for the anchor
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]}]},{"id":"2bKlSM-hVXm99JEef9ZZG","name":"DropTarget","brief":"","see":["Draggable"],"type":"ClassDoc","description":"a base drop target object
","params":[],"returns":[],"extends":["Renderable"],"implements":[],"members":[{"id":"w_DQ4HqVVcIULGxe6swnq","name":"alpha","brief":"","defaultValue":"1.0","scope":"instance","see":["Renderable#setOpacity","Renderable#getOpacity"],"type":"PropertyDoc","description":"Define the renderable opacity
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"fdDbDcnUTw8Am9XCeuGYE","name":"alwaysUpdate","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object will always update, even when outside of the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"WIHp5Gg-IG2LTr3RBuXub","name":"ancestor","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"a reference to the parent object that contains this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"l7MJdjtPyNpm4Tv28hO9u","name":"anchorPoint","brief":"","defaultValue":"<0.5,0.5>","scope":"instance","type":"PropertyDoc","description":"The anchor point is used for attachment behavior, and/or when applying transformations.
When enabled, an object container will automatically apply\nany defined transformation before calling the child draw method...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"RR_GJICgpTFta_onRc9RF","name":"blendMode","brief":"","defaultValue":"\"normal\"","scope":"instance","see":["CanvasRenderer#setBlendMode","WebGLRenderer#setBlendMode"],"type":"PropertyDoc","description":"
the blend mode to be applied to this renderable (see renderer setBlendMode for available blend mode)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"fmerLAv5pMogx8aK1-UPi","name":"body","brief":"","examples":[{"caption":"","code":" // define a new Player Class\n class PlayerEntity extends me.Sprite {\n // constructor\n constructor(x, y, settings) {\n // call the parent constructor\n super(x, y , settings);\n\n // define a basic walking animation\n this.addAnimation(\"walk\", [...]);\n // define a standing animation (using the first frame)\n this.addAnimation(\"stand\", [...]);\n // set the standing animation as default\n this.setCurrentAnimation(\"stand\");\n\n // add a physic body\n this.body = new me.Body(this);\n // add a default collision shape\n this.body.addShape(new me.Rect(0, 0, this.width, this.height));\n // configure max speed, friction, and initial force to be applied\n this.body.setMaxVelocity(3, 15);\n this.body.setFriction(0.4, 0);\n this.body.force.set(3, 0);\n this.isKinematic = false;\n\n // set the display to follow our position on both axis\n me.game.viewport.follow(this.pos, me.game.viewport.AXIS.BOTH);\n }\n\n ...\n\n }"}],"scope":"instance","type":"PropertyDoc","description":"the renderable physic body
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"TNlLMcqeujKnE56PgmVjE","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"mxQz16ZiTeo-ze1i4soCs","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"mQcfM_FUe3qexWWS9ttM7","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"VwGJbMXTJlksVWhqLhKq0","name":"checkMethod","brief":"","access":"public","defaultValue":"\"overlaps\"","scope":"instance","type":"PropertyDoc","description":"the checkmethod we want to use
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"P-rmNqGcbjKVh50l67A3c","name":"CHECKMETHOD_CONTAINS","brief":"","access":"public","defaultValue":"\"contains\"","scope":"instance","type":"PropertyDoc","description":"constant for the contains method
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"cusrrttFDtzhYFenAVIwS","name":"CHECKMETHOD_OVERLAP","brief":"","access":"public","defaultValue":"\"overlaps\"","scope":"instance","type":"PropertyDoc","description":"constant for the overlaps method
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"IOmal1ODit_tvSPnL1M4I","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"GFRzhBhXb3eDNj9a4nPPD","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"9oDcoLF4tm9ivJ6uNlQdR","name":"floating","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"If true, this renderable will be rendered using screen coordinates,\nas opposed to world coordinates. Use this, for example...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"LiTGXWjZ48QCeaS1SMydo","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"
(G)ame (U)nique (Id)entifier"
height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"NZtrZ78O1DP5jqPWbK5wv","name":"inViewport","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object is visible and within the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"a9FtjBDX0F8WnE42o16I2","name":"isDirty","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"when true the renderable will be redrawn during the next update cycle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"VCoJOPecWokyegnRr0uAW","name":"isFlippedX","brief":"","access":"public","scope":"instance","see":["Renderable#flipX"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"dz5UQYTAMou-Y-dHk_mzB","name":"isFlippedY","brief":"","access":"public","scope":"instance","see":["Renderable#flipY"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"7wjlGqSDjZL7TsoMHTocZ","name":"isFloating","brief":"","scope":"instance","see":["Renderable#floating"],"type":"PropertyDoc","description":"Whether the renderable object is floating (i.e. used screen coordinates), or contained in a floating parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"J9sKsLMZU--1B0bHMbrB1","name":"isKinematic","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"If true then physic collision and input events will not impact this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"O2v55EihYLP3ORBlJk8WF","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"bz8hOxTwc10owcqt9XyKF","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"O9xGt7FXzSTWbbCsCAmHn","name":"mask","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"// apply a mask in the shape of a Star\nmyNPCSprite.mask = new me.Polygon(myNPCSprite.width / 2, 0, [\n // draw a star\n {x: 0, y: 0},\n {x: 14, y: 30},\n {x: 47, y: 35},\n {x: 23, y: 57},\n {x: 44, y: 90},\n {x: 0, y: 62},\n {x: -44, y: 90},\n {x: -23, y: 57},\n {x: -47, y: 35},\n {x: -14, y: 30}\n]);"}],"scope":"instance","type":"PropertyDoc","description":"A mask limits rendering elements to the shape and position of the given mask object.\nSo, if the renderable is larger than ...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"4DQCANrAyJ5pOR5D2dxfY","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Ky4KrBeRfPFM2oHtaMRRb","name":"onVisibilityChange","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"this.onVisibilityChange = function(inViewport) {\n if (inViewport === true) {\n console.log(\"object has entered the in a camera viewport!\");\n }\n};"}],"scope":"instance","type":"PropertyDoc","description":"an event handler that is called when the renderable leave or enter a camera viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ywZUzXVJ0fpu9H0QzOSat","name":"parentApp","brief":"","scope":"instance","type":"PropertyDoc","description":"returns the parent application (or game) to which this renderable is attached to
","params":[],"returns":[{"description":"the parent application or undefined if not attached to any container/app
","dataType":{"tokens":[{"value":"Application","kind":"canonical"},{"value":"Application","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"en_iGlOXDXdjWW8wWL5DR","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"oSSgAvzs2AN7Ss5gKOePK","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"b1pSUfno4ysOY0oMEx2mo","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"PRYKH3sRrcycn3fVwtJ_C","name":"shader","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"(Experimental) an optional shader, to be used instead of the default built-in one, when drawing this renderable (WebGL onl...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"5qp4Lu3BKBex68vNcVlMF","name":"tint","brief":"","defaultValue":"(255, 255, 255)","examples":[{"caption":"","code":"// add a red tint to this renderable\nthis.tint.setColor(255, 128, 128);\n// remove the tint\nthis.tint.setColor(255, 255, 255);"}],"scope":"instance","type":"PropertyDoc","description":"
define a tint for this renderable. a (255, 255, 255) r, g, b value will remove the tint effect.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"dffN9IeTHjOYT2nL0w_cT","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"powNMVxMOBlYP8jwrRHuS","name":"type","brief":"","defaultValue":"\"Rectangle\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"hvm8-ZQTZUIupoDOHqV4k","name":"updateWhenPaused","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether to update this object when the game is paused.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Q2l4QkIkocSanLcYhQsH5","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"6WT6KIr6J3jW9TQaEhN-A","name":"angleTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the angle to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"angle in radians
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"JGtHM4PsbVQR8taR2OCzl","name":"centerOn","brief":"","scope":"instance","type":"MethodDoc","description":"center the rectangle position around the given coordinates
","params":[{"identifier":"x","optional":false,"description":"the x coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"3vYW404IzJ3SfAIRngCPc","name":"checkOnMe","brief":"","scope":"instance","type":"MethodDoc","description":"Checks if a dropped entity is dropped on the current entity
","params":[{"identifier":"e","optional":false,"description":"the triggering event
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}},{"identifier":"draggable","optional":false,"description":"the draggable object that is dropped
","dataType":{"tokens":[{"value":"Draggable","kind":"canonical"},{"value":"Draggable","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"7F4UMm2AegkUf8LFy3bdA","name":"clone","brief":"","scope":"instance","type":"MethodDoc","description":"clone this rectangle
","params":[],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"uIAY6kwpoy7CUxJE_vJ9g","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"x","optional":false,"description":"the x coordinates of the drop target
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y coordinates of the drop target
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"width","optional":false,"description":"drop target width
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"height","optional":false,"description":"drop target height
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"Vr54s7_YjhWn2SOe0zHiX","name":"contains","brief":"","examples":[{"caption":"","code":"if (rect.contains(10, 10)) {\n // do something\n}\n// or\nif (rect.contains(myVector2d)) {\n // do something\n}\nif (rect.contains(myRect)) {\n // do something\n}"}],"scope":"instance","type":"MethodDoc","description":"Returns true if the rectangle contains the given point or rectangle
","params":[{"identifier":"x","description":"x coordinate or a vector point, or a rectangle to test
","dataType":{"tokens":[{"value":"number | Vector2d | Rect","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Rect","kind":"link"}],"template":"%1 | %2 | %3"}},{"identifier":"y","optional":true,"description":"y coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"True if the rectangle contain the given point or rectangle, otherwise false
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"3sUqEhRW9eOA0mw-qZbII","name":"copy","brief":"","scope":"instance","type":"MethodDoc","description":"copy the position and size of the given rectangle into this one
","params":[{"identifier":"rect","optional":false,"description":"Source rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"evG3YbbiO3izfegCatiGW","name":"distanceTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the distance to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"distance
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"JNmEo51PxrY3bqcg24FXl","name":"draw","brief":"","scope":"instance","see":["Renderable#preDraw","Renderable#postDraw"],"type":"MethodDoc","description":"Draw this renderable (automatically called by melonJS).\nAll draw operations for renderable are made respectively\nto the po...","params":[{"identifier":"renderer","optional":false,"description":"
a renderer instance
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}},{"identifier":"viewport","optional":true,"description":"the viewport to (re)draw
","dataType":{"tokens":[{"value":"Camera2d","kind":"canonical"},{"value":"Camera2d","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"fuN8O57S3TC2Dq6ptxdbn","name":"drop","brief":"","scope":"instance","type":"MethodDoc","description":"Gets called when a draggable entity is dropped on the current entity
","params":[{"identifier":"draggable","optional":false,"description":"the draggable object that is dropped
","dataType":{"tokens":[{"value":"Draggable","kind":"canonical"},{"value":"Draggable","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"ohTz9RVkTBayGBeW9KG8t","name":"equals","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is identical to the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if equals
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"8b_B-xFbX-bFn0QzuXLdC","name":"flipX","brief":"","scope":"instance","see":["Matrix2d#scaleX"],"type":"MethodDoc","description":"flip the renderable on the horizontal axis (around the center of the renderable)
","params":[{"identifier":"flip","optional":true,"default":"true","description":"true to flip this renderable.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"cxK9lpaIibYWiwzPpg1gl","name":"flipY","brief":"","scope":"instance","see":["Matrix2d#scaleY"],"type":"MethodDoc","description":"flip the renderable on the vertical axis (around the center of the renderable)
","params":[{"identifier":"flip","optional":true,"default":"true","description":"true to flip this renderable.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"fmxxclwnx8GZ5jY9IQ3S_","name":"getAbsolutePosition","brief":"","scope":"instance","type":"MethodDoc","description":"return the renderable absolute position in the game world
","params":[],"returns":[{"dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"0Jh01xDGdxJ_tylQoe6bN","name":"getBounds","brief":"","scope":"instance","type":"MethodDoc","description":"returns the bounding box for this renderable
","params":[],"returns":[{"description":"bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"qeAK90TwHn8C4Oer__3z8","name":"getIndices","brief":"","scope":"instance","type":"MethodDoc","description":"returns a list of indices for all triangles defined in this polygon
","params":[],"returns":[{"description":"an array of vertex indices for all triangles forming this polygon.
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1<%2>"}}],"extends":[],"implements":[]},{"id":"LnbNKRXf8anmo337OLLpf","name":"getOpacity","brief":"","scope":"instance","type":"MethodDoc","description":"get the renderable alpha channel value
","params":[],"returns":[{"description":"current opacity value between 0 and 1
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"gQyTgydlfAlX_OG6zkz7N","name":"isConvex","brief":"","scope":"instance","type":"MethodDoc","description":"Returns true if the vertices composing this polygon form a convex shape (vertices must be in clockwise order).
","params":[],"returns":[{"description":"true if the vertices are convex, false if not, null if not computable
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"Jiq4IYOKQPAYVQIt6jyqD","name":"isFinite","brief":"","scope":"instance","type":"MethodDoc","description":"determines whether all coordinates of this rectangle are finite numbers.
","params":[],"returns":[{"description":"false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"ERRmYTRcGA-B4IZQCMCDi","name":"lookAt","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this renderable towards the given target.
","params":[{"identifier":"target","optional":false,"description":"the renderable or position to look at
","dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"UiT6UMwJwwY-7Re3_Tjpn","name":"onCollision","brief":"","examples":[{"caption":"","code":"// colision handler\nonCollision(response) {\n if (response.b.body.collisionType === me.collision.types.ENEMY_OBJECT) {\n // makes the other object solid, by substracting the overlap vector to the current position\n this.pos.sub(response.overlapV);\n this.hurt();\n // not solid\n return false;\n }\n // Make the object solid\n return true;\n},"}],"scope":"instance","type":"MethodDoc","description":"onCollision callback, triggered in case of collision,\nwhen this renderable body is colliding with another one
","params":[{"identifier":"response","optional":false,"description":"the collision response object
","dataType":{"tokens":[{"value":"ResponseObject","kind":"canonical"},{"value":"ResponseObject","kind":"link"}],"template":"%1"}},{"identifier":"other","optional":false,"description":"the other renderable touching this one (a reference to response.a or response.b)
","dataType":{"tokens":[{"value":"Renderable | Container | Entity | Sprite | NineSliceSprite","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Container","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"NineSliceSprite","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5"}}],"returns":[{"description":"true if the object should respond to the collision (its position and velocity will be corrected)
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"duAwtQ8s-jdO5bNZEFhAu","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"OnDestroy Notification function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"uXwlNYY3lofE_ZiiOHZ_D","name":"overlaps","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is intersecting with the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if overlaps
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"Y3UWGq73-gXIVLLG5UwT7","name":"postDraw","brief":"","scope":"instance","see":["Renderable#preDraw","Renderable#draw"],"type":"MethodDoc","description":"restore the rendering context after drawing (automatically called by melonJS).
","params":[{"identifier":"renderer","optional":false,"description":"a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"EyhKlrNgxY2_HqUUv6kPf","name":"preDraw","brief":"","scope":"instance","see":["Renderable#draw","Renderable#postDraw"],"type":"MethodDoc","description":"Prepare the rendering context before drawing (automatically called by melonJS).\nThis will apply any defined transforms, an...","params":[{"identifier":"renderer","optional":false,"description":"
a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"8Pnv0ngN1OnBVT3SGE0Rx","name":"recalc","brief":"","scope":"instance","type":"MethodDoc","description":"Computes the calculated collision polygon.\nThis must be called if the points array, an...","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"hMUkCpock_A682L5DZy-U","name":"resize","brief":"","scope":"instance","type":"MethodDoc","description":"resize the rectangle
","params":[{"identifier":"w","optional":false,"description":"new width of the rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"h","optional":false,"description":"new height of the rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Ngxm8TvGQCR_XpN4UZ9OM","name":"rotate","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this renderable by the specified angle (in radians).
","params":[{"identifier":"angle","optional":false,"description":"The angle to rotate (in radians)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":true,"description":"an optional point to rotate around
","dataType":{"tokens":[{"value":"Vector2d | ObservableVector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"1_Z2Z9dkYedpWk3nQbnxE","name":"scale","brief":"","scope":"instance","type":"MethodDoc","description":"scale the renderable around his anchor point. Scaling actually applies changes\nto the currentTransform member wich is use...","params":[{"identifier":"x","optional":false,"description":"
a number representing the abscissa of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":true,"default":"x","description":"a number representing the ordinate of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"vUVwVehFH7D5oz6kOXOJL","name":"scaleV","brief":"","scope":"instance","type":"MethodDoc","description":"scale the renderable around his anchor point
","params":[{"identifier":"v","optional":false,"description":"scaling vector
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"hmv1GRTFnKcL-FIFd9MUD","name":"setCheckMethod","brief":"","scope":"instance","type":"MethodDoc","description":"Sets the collision method which is going to be used to check a valid drop
","params":[{"identifier":"checkMethod","optional":false,"description":"the checkmethod (defaults to CHECKMETHOD_OVERLAP)
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"returns":[],"extends":[],"implements":[]},{"id":"RFowX0gSMr7nWBxanGHbA","name":"setOpacity","brief":"","scope":"instance","type":"MethodDoc","description":"set the renderable alpha channel value
","params":[{"identifier":"alpha","optional":false,"description":"opacity value between 0.0 and 1.0
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"Js5LXk_qVz_KJ1NrfnMJB","name":"setShape","brief":"","scope":"instance","type":"MethodDoc","description":"set new value to the rectangle shape
","params":[{"identifier":"x","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"w","optional":false,"description":"width of the rectangle, or an array of vector defining the rectangle
","dataType":{"tokens":[{"value":"number | Array","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %3<%2>"}},{"identifier":"h","optional":true,"description":"height of the rectangle, if a numeral width parameter is specified
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"32DbuZRBgO0FFp-ClABnv","name":"setVertices","brief":"","scope":"instance","type":"MethodDoc","description":"set the vertices defining this Polygon
","params":[{"identifier":"vertices","optional":false,"description":"array of vector or vertice defining the Polygon
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1<%2>"}}],"returns":[{"description":"this instance for objecf chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"83a_o8l6kZPqCx_XGyKHs","name":"shift","brief":"","examples":[{"caption":"","code":"polygon.shift(10, 10);\n// or\npolygon.shift(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"Shifts the Polygon to the given position vector.
","params":[{"identifier":"x","description":"x coordinate or a vector point to shift to
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"c5KolXdONGS_6LMQstg9a","name":"to2d","brief":"","scope":"instance","type":"MethodDoc","description":"apply a 2d projection to this shapen
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"gLD45D4brLZTMlrP2368B","name":"toIso","brief":"","scope":"instance","type":"MethodDoc","description":"apply an isometric projection to this shape
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Wb10RKsaNwB8779wPkKXp","name":"toPolygon","brief":"","scope":"instance","type":"MethodDoc","description":"Returns a polygon whose edges are the same as this box.
","params":[],"returns":[{"description":"a new Polygon that represents this rectangle.
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"uHZ1ycsv4uShLkyJ2GnEm","name":"transform","brief":"","scope":"instance","see":["Renderable#currentTransform"],"type":"MethodDoc","description":"multiply the renderable currentTransform with the given matrix
","params":[{"identifier":"m","optional":false,"description":"the transformation matrix
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"YrRhZIuQH7FzP3rbATJaQ","name":"translate","brief":"","examples":[{"caption":"","code":"polygon.translate(10, 10);\n// or\npolygon.translate(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"translate the Polygon by the specified offset
","params":[{"identifier":"x","description":"x offset or a vector point to translate by
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"description":"y offset
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"BZZGtJTTffa1B7KjMiI-r","name":"union","brief":"","scope":"instance","type":"MethodDoc","description":"merge this rectangle with another one
","params":[{"identifier":"rect","optional":false,"description":"other rectangle to union with
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"the union(ed) rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"wS1sBNbJ24xufDNq3lfd6","name":"update","brief":"","scope":"instance","type":"MethodDoc","description":"update function (automatically called by melonJS).
","params":[{"identifier":"dt","optional":false,"description":"time since the last update in milliseconds.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"true if the renderable is dirty
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"KIprLKnxBPl2vmkk43Nge","name":"updateBounds","brief":"","scope":"instance","type":"MethodDoc","description":"update the bounding box for this shape.
","params":[{"identifier":"absolute","optional":true,"default":"true","description":"update the bounds size and position in (world) absolute coordinates
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"this shape bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"P_yxgf3PUWt2xYOxwDIrV","name":"onAnchorUpdate","brief":"","access":"private","scope":"instance","type":"MethodDoc","description":"called when the anchor point value is changed
","params":[{"identifier":"x","optional":false,"description":"the new X value to be set for the anchor
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the new Y value to be set for the anchor
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]}]},{"id":"hK5X9KV3dup7lOPHDOfJd","name":"DroptargetEntity","brief":"","deprecated":"since 10.5.0","see":["DropTarget"],"type":"ClassDoc","description":"Used to make a game entity a droptarget
","params":[],"returns":[],"extends":["Entity"],"implements":[],"members":[{"id":"CH1485KYlTfsUpOTOweIi","name":"alive","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"dead/living state of the entity
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ZFSz4jy_mAkoWilsmaRfV","name":"alpha","brief":"","defaultValue":"1.0","scope":"instance","see":["Renderable#setOpacity","Renderable#getOpacity"],"type":"PropertyDoc","description":"Define the renderable opacity
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"zXzfioBR7wgzAs-qpJo8-","name":"alwaysUpdate","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object will always update, even when outside of the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"6e191uDP62wMu_73pfiR6","name":"ancestor","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"a reference to the parent object that contains this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"sDQkFACE6jS1pVHhU1AUT","name":"anchorPoint","brief":"","defaultValue":"<0.5,0.5>","scope":"instance","type":"PropertyDoc","description":"The anchor point is used for attachment behavior, and/or when applying transformations.
When enabled, an object container will automatically apply\nany defined transformation before calling the child draw method...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"lpFR2ck4stOdAxMlGd1Zs","name":"blendMode","brief":"","defaultValue":"\"normal\"","scope":"instance","see":["CanvasRenderer#setBlendMode","WebGLRenderer#setBlendMode"],"type":"PropertyDoc","description":"
the blend mode to be applied to this renderable (see renderer setBlendMode for available blend mode)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"WPUYET3uv6qqJ_X5rxWxY","name":"body","brief":"","scope":"instance","type":"PropertyDoc","description":"the entity body object
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"51XJ4l-tsjVFY1rZYiBxQ","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"PAkc7gjpLgbHKXGJqVkQ4","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"z84oDVDdI_D7ljoIvK-pF","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"74blVp6pBGk_RRXzGOlbB","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"IOCD9DzfgfAHLXcESH1Q0","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"9OdXDdtnoduCmlRKfap05","name":"floating","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"If true, this renderable will be rendered using screen coordinates,\nas opposed to world coordinates. Use this, for example...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Q93wl5Zx6LAn_FVQBR2SZ","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"
(G)ame (U)nique (Id)entifier"
height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"0r8zDQNMO1rHvOqGMC4Dq","name":"id","brief":"","scope":"instance","type":"PropertyDoc","description":"object unique ID (as defined in Tiled)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"6G05LXIipB6pv_7jy3wRM","name":"inViewport","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object is visible and within the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"_HMXuiGBfBA2kdSIo208t","name":"isDirty","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"when true the renderable will be redrawn during the next update cycle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"0ITiQj591Jcsc2xYCf5aC","name":"isFlippedX","brief":"","access":"public","scope":"instance","see":["Renderable#flipX"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"63AOnhZ0T9YYjhNzMbrTN","name":"isFlippedY","brief":"","access":"public","scope":"instance","see":["Renderable#flipY"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"fBlvgJqkcX-wkigOJFDwk","name":"isFloating","brief":"","scope":"instance","see":["Renderable#floating"],"type":"PropertyDoc","description":"Whether the renderable object is floating (i.e. used screen coordinates), or contained in a floating parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"mIS58thYsf-L9y-jDQpzc","name":"isKinematic","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"If true then physic collision and input events will not impact this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Uvxfd8LiI68-HPR8nlgDi","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"bNgX7syltvSnK1lZ6sYKE","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"CEssnt2rVp45CtnVelvuZ","name":"mask","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"// apply a mask in the shape of a Star\nmyNPCSprite.mask = new me.Polygon(myNPCSprite.width / 2, 0, [\n // draw a star\n {x: 0, y: 0},\n {x: 14, y: 30},\n {x: 47, y: 35},\n {x: 23, y: 57},\n {x: 44, y: 90},\n {x: 0, y: 62},\n {x: -44, y: 90},\n {x: -23, y: 57},\n {x: -47, y: 35},\n {x: -14, y: 30}\n]);"}],"scope":"instance","type":"PropertyDoc","description":"A mask limits rendering elements to the shape and position of the given mask object.\nSo, if the renderable is larger than ...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"s_QHSzNbo-Bm54z3Tk5cy","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"G7dWzqVETVY249_xB1dtd","name":"onVisibilityChange","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"this.onVisibilityChange = function(inViewport) {\n if (inViewport === true) {\n console.log(\"object has entered the in a camera viewport!\");\n }\n};"}],"scope":"instance","type":"PropertyDoc","description":"an event handler that is called when the renderable leave or enter a camera viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"5g74L0-4l7TJ9cSNvesGG","name":"parentApp","brief":"","scope":"instance","type":"PropertyDoc","description":"returns the parent application (or game) to which this renderable is attached to
","params":[],"returns":[{"description":"the parent application or undefined if not attached to any container/app
","dataType":{"tokens":[{"value":"Application","kind":"canonical"},{"value":"Application","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"f2wwEKwNfnGSLlrdq8VgE","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"oJg9chr9oA3SewDM_kkyR","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"okRUSOtAHzwkkGPFy-nPa","name":"renderable","brief":"","scope":"instance","type":"PropertyDoc","description":"The entity renderable component (can be any objects deriving from me.Renderable, like me.Sprite for example)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"8bQ_fSqvAzcL7NM2pLNvJ","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"W9UfRUD0a-Lozw2K-MVHp","name":"shader","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"(Experimental) an optional shader, to be used instead of the default built-in one, when drawing this renderable (WebGL onl...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"2U4x4Y3eAIH8nCoWZlWDz","name":"tint","brief":"","defaultValue":"(255, 255, 255)","examples":[{"caption":"","code":"// add a red tint to this renderable\nthis.tint.setColor(255, 128, 128);\n// remove the tint\nthis.tint.setColor(255, 255, 255);"}],"scope":"instance","type":"PropertyDoc","description":"
define a tint for this renderable. a (255, 255, 255) r, g, b value will remove the tint effect.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Cej5F0LY7DjuRxS8pxLb1","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"MkI0AFNR4flA_Jp885x4f","name":"type","brief":"","scope":"instance","type":"PropertyDoc","description":"object type (as defined in Tiled)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"sKZ2tXUv67Qn6sgFlM0Hj","name":"updateWhenPaused","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether to update this object when the game is paused.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"iXrf5X0RaiRraADWXDP1S","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ov-8mHF7FVAzR-Z3mPX_T","name":"angleTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the angle to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"angle in radians
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"kSWr7Y_Gq1LPTr_Bn7D5Y","name":"centerOn","brief":"","scope":"instance","type":"MethodDoc","description":"center the rectangle position around the given coordinates
","params":[{"identifier":"x","optional":false,"description":"the x coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"fwpJQoWGCk91AT05YcWwg","name":"clone","brief":"","scope":"instance","type":"MethodDoc","description":"clone this rectangle
","params":[],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"d2Uq8bz6zUIuSxwK8sK9j","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"x","optional":false,"description":"the x coordinates of the draggable object
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y coordinates of the draggable object
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings","optional":false,"description":"Entity properties (see {@link Entity})
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}}],"returns":[],"extends":[],"implements":[]},{"id":"5sWHF3tUsWR_ahG8VRbqF","name":"contains","brief":"","examples":[{"caption":"","code":"if (rect.contains(10, 10)) {\n // do something\n}\n// or\nif (rect.contains(myVector2d)) {\n // do something\n}\nif (rect.contains(myRect)) {\n // do something\n}"}],"scope":"instance","type":"MethodDoc","description":"Returns true if the rectangle contains the given point or rectangle
","params":[{"identifier":"x","description":"x coordinate or a vector point, or a rectangle to test
","dataType":{"tokens":[{"value":"number | Vector2d | Rect","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Rect","kind":"link"}],"template":"%1 | %2 | %3"}},{"identifier":"y","optional":true,"description":"y coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"True if the rectangle contain the given point or rectangle, otherwise false
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"cQkui1HVbeIapZu9plDw9","name":"copy","brief":"","scope":"instance","type":"MethodDoc","description":"copy the position and size of the given rectangle into this one
","params":[{"identifier":"rect","optional":false,"description":"Source rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"xP6Bh2FRXn-2bwcxuymDp","name":"distanceTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the distance to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"distance
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"mzLbOHH_QH38mUHbNJvhq","name":"equals","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is identical to the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if equals
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"9sSoJr1zh642k7cfBj2qc","name":"flipX","brief":"","scope":"instance","see":["Matrix2d#scaleX"],"type":"MethodDoc","description":"flip the renderable on the horizontal axis (around the center of the renderable)
","params":[{"identifier":"flip","optional":true,"default":"true","description":"true to flip this renderable.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"dHSxBZL4sVEHu2ojgNTpw","name":"flipY","brief":"","scope":"instance","see":["Matrix2d#scaleY"],"type":"MethodDoc","description":"flip the renderable on the vertical axis (around the center of the renderable)
","params":[{"identifier":"flip","optional":true,"default":"true","description":"true to flip this renderable.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"1xsKXXEIhEIUgqOlir0fA","name":"getAbsolutePosition","brief":"","scope":"instance","type":"MethodDoc","description":"return the renderable absolute position in the game world
","params":[],"returns":[{"dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"UUmoKFIjGze0SOXrClgvK","name":"getBounds","brief":"","scope":"instance","type":"MethodDoc","description":"returns the bounding box for this renderable
","params":[],"returns":[{"description":"bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"6ZPNSFpiUMUOr6mvoqzEL","name":"getIndices","brief":"","scope":"instance","type":"MethodDoc","description":"returns a list of indices for all triangles defined in this polygon
","params":[],"returns":[{"description":"an array of vertex indices for all triangles forming this polygon.
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1<%2>"}}],"extends":[],"implements":[]},{"id":"AxAmW9D_fgTvhjQFLndrX","name":"getOpacity","brief":"","scope":"instance","type":"MethodDoc","description":"get the renderable alpha channel value
","params":[],"returns":[{"description":"current opacity value between 0 and 1
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"SL6PDz9Jf5uX2DDU9qbkJ","name":"isConvex","brief":"","scope":"instance","type":"MethodDoc","description":"Returns true if the vertices composing this polygon form a convex shape (vertices must be in clockwise order).
","params":[],"returns":[{"description":"true if the vertices are convex, false if not, null if not computable
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"2qUVYVjP4NvP-ukJYKOJE","name":"isFinite","brief":"","scope":"instance","type":"MethodDoc","description":"determines whether all coordinates of this rectangle are finite numbers.
","params":[],"returns":[{"description":"false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"r2DfCVyihWRhPSWvOmCzt","name":"lookAt","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this renderable towards the given target.
","params":[{"identifier":"target","optional":false,"description":"the renderable or position to look at
","dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"sHw9RMUgeZzMg0sG5_CX1","name":"onBodyUpdate","brief":"update the bounds when the body is modified
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Dc_AEK4HUHYtTFaHRCaiT","name":"onCollision","brief":"","examples":[{"caption":"","code":"// colision handler\nonCollision(response) {\n if (response.b.body.collisionType === me.collision.types.ENEMY_OBJECT) {\n // makes the other object solid, by substracting the overlap vector to the current position\n this.pos.sub(response.overlapV);\n this.hurt();\n // not solid\n return false;\n }\n // Make the object solid\n return true;\n},"}],"scope":"instance","type":"MethodDoc","description":"onCollision callback, triggered in case of collision,\nwhen this renderable body is colliding with another one
","params":[{"identifier":"response","optional":false,"description":"the collision response object
","dataType":{"tokens":[{"value":"ResponseObject","kind":"canonical"},{"value":"ResponseObject","kind":"link"}],"template":"%1"}},{"identifier":"other","optional":false,"description":"the other renderable touching this one (a reference to response.a or response.b)
","dataType":{"tokens":[{"value":"Renderable | Container | Entity | Sprite | NineSliceSprite","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Container","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"NineSliceSprite","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5"}}],"returns":[{"description":"true if the object should respond to the collision (its position and velocity will be corrected)
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"0W15GZJDAx4sL4NqJLM0D","name":"onDeactivateEvent","brief":"onDeactivateEvent Notification function
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"QfOP2EEHUC0hnIXVL8AY6","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"OnDestroy Notification function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"TEfkRKYiK60Avg9d-HWF5","name":"overlaps","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is intersecting with the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if overlaps
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"mV-V2LsFdfL9Qz1-vJ5nN","name":"postDraw","brief":"","scope":"instance","see":["Renderable#preDraw","Renderable#draw"],"type":"MethodDoc","description":"restore the rendering context after drawing (automatically called by melonJS).
","params":[{"identifier":"renderer","optional":false,"description":"a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"iInUI2fekE8NF0JaHXJ4y","name":"preDraw","brief":"","scope":"instance","see":["Renderable#draw","Renderable#postDraw"],"type":"MethodDoc","description":"Prepare the rendering context before drawing (automatically called by melonJS).\nThis will apply any defined transforms, an...","params":[{"identifier":"renderer","optional":false,"description":"
a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"CS3QM3QqpOgbmL0ZZwtBo","name":"recalc","brief":"","scope":"instance","type":"MethodDoc","description":"Computes the calculated collision polygon.\nThis must be called if the points array, an...","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"J6gowNs5r8nvq0Y1noob8","name":"resize","brief":"","scope":"instance","type":"MethodDoc","description":"resize the rectangle
","params":[{"identifier":"w","optional":false,"description":"new width of the rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"h","optional":false,"description":"new height of the rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"QZpYiTMRWdCGyMT3sriBK","name":"rotate","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this renderable by the specified angle (in radians).
","params":[{"identifier":"angle","optional":false,"description":"The angle to rotate (in radians)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":true,"description":"an optional point to rotate around
","dataType":{"tokens":[{"value":"Vector2d | ObservableVector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"HJkgPHO3tNAFfQPzs12ZA","name":"scale","brief":"","scope":"instance","type":"MethodDoc","description":"scale the renderable around his anchor point. Scaling actually applies changes\nto the currentTransform member wich is use...","params":[{"identifier":"x","optional":false,"description":"
a number representing the abscissa of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":true,"default":"x","description":"a number representing the ordinate of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"CBsi05byYq-xR3VliQoTy","name":"scaleV","brief":"","scope":"instance","type":"MethodDoc","description":"scale the renderable around his anchor point
","params":[{"identifier":"v","optional":false,"description":"scaling vector
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"EYid4E1GuJCKwF_v63nwY","name":"setOpacity","brief":"","scope":"instance","type":"MethodDoc","description":"set the renderable alpha channel value
","params":[{"identifier":"alpha","optional":false,"description":"opacity value between 0.0 and 1.0
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"CZggDmLks13u5q8O3EmkG","name":"setShape","brief":"","scope":"instance","type":"MethodDoc","description":"set new value to the rectangle shape
","params":[{"identifier":"x","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"w","optional":false,"description":"width of the rectangle, or an array of vector defining the rectangle
","dataType":{"tokens":[{"value":"number | Array","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %3<%2>"}},{"identifier":"h","optional":true,"description":"height of the rectangle, if a numeral width parameter is specified
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"vHwsbl6jcsaXVV1OsCiuV","name":"setVertices","brief":"","scope":"instance","type":"MethodDoc","description":"set the vertices defining this Polygon
","params":[{"identifier":"vertices","optional":false,"description":"array of vector or vertice defining the Polygon
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1<%2>"}}],"returns":[{"description":"this instance for objecf chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"ec-eAgkL0LkrVba6Kb0U_","name":"shift","brief":"","examples":[{"caption":"","code":"polygon.shift(10, 10);\n// or\npolygon.shift(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"Shifts the Polygon to the given position vector.
","params":[{"identifier":"x","description":"x coordinate or a vector point to shift to
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"nmtUkwi3Ud--j4CD2-A_J","name":"to2d","brief":"","scope":"instance","type":"MethodDoc","description":"apply a 2d projection to this shapen
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"bVH5QfKDbYucXZ44y1-8T","name":"toIso","brief":"","scope":"instance","type":"MethodDoc","description":"apply an isometric projection to this shape
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"VqkwMrNJ_n8AJkjwFISp3","name":"toPolygon","brief":"","scope":"instance","type":"MethodDoc","description":"Returns a polygon whose edges are the same as this box.
","params":[],"returns":[{"description":"a new Polygon that represents this rectangle.
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"rom0uZ1H1z3hBkYX13Kl7","name":"transform","brief":"","scope":"instance","see":["Renderable#currentTransform"],"type":"MethodDoc","description":"multiply the renderable currentTransform with the given matrix
","params":[{"identifier":"m","optional":false,"description":"the transformation matrix
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"kBtRPVJ6gInlvCV_APJlz","name":"translate","brief":"","examples":[{"caption":"","code":"polygon.translate(10, 10);\n// or\npolygon.translate(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"translate the Polygon by the specified offset
","params":[{"identifier":"x","description":"x offset or a vector point to translate by
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"description":"y offset
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"waxtV7YbKk5nuXAG7za8h","name":"union","brief":"","scope":"instance","type":"MethodDoc","description":"merge this rectangle with another one
","params":[{"identifier":"rect","optional":false,"description":"other rectangle to union with
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"the union(ed) rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"TIxvSyI9UzZnD9GiRCgzq","name":"update","brief":"","scope":"instance","type":"MethodDoc","description":"update function (automatically called by melonJS).
","params":[{"identifier":"dt","optional":false,"description":"time since the last update in milliseconds.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"true if the renderable is dirty
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"AZ78NWzQrKyO35pCtbkfK","name":"updateBounds","brief":"","scope":"instance","type":"MethodDoc","description":"update the bounding box for this entity.
","params":[{"identifier":"absolute","optional":true,"default":"true","description":"update the bounds size and position in (world) absolute coordinates
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"this entity bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"atK8hRdiyqxpu8mux0Wo4","name":"draw","brief":"","access":"protected","scope":"instance","type":"MethodDoc","description":"draw this entity (automatically called by melonJS)
","params":[{"identifier":"renderer","optional":false,"description":"a renderer instance
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}},{"identifier":"viewport","optional":true,"description":"the viewport to (re)draw
","dataType":{"tokens":[{"value":"Camera2d","kind":"canonical"},{"value":"Camera2d","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"ETokBQDbSo-PR6HEDX8pt","name":"onAnchorUpdate","brief":"","access":"private","scope":"instance","type":"MethodDoc","description":"called when the anchor point value is changed
","params":[{"identifier":"x","optional":false,"description":"the new X value to be set for the anchor
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the new Y value to be set for the anchor
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]}]},{"id":"D309rxpauEGOD4Qed_EHA","name":"Ellipse","brief":"","type":"ClassDoc","description":"an ellipse Object
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"3c6Zz003WinOk4qRJmUZh","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"the center coordinates of the ellipse
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"r_fxYact3eSRylEMMPQLm","name":"radius","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"Maximum radius of the ellipse
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ChNxfM7wHcVPANhrL9WJT","name":"radiusSq","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"Radius squared, for pythagorean theorom
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"r8OJJBou_DFV5tTkJA1mw","name":"radiusV","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"Pre-scaled radius vector for ellipse
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Ei8lXGrdGeGsI8bsKfEwS","name":"ratio","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"x/y scaling ratio for ellipse
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"c-5acVuPaGsf0ymGq9_Tb","name":"type","brief":"","defaultValue":"\"Ellipse\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"sRncJj9tcpz-JbUu4jYi1","name":"_bounds","brief":"","access":"private","scope":"instance","type":"PropertyDoc","description":"The bounding rectangle for this shape
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"QuYGRJaj9bV9XX3WGmDWq","name":"clone","brief":"","scope":"instance","type":"MethodDoc","description":"clone this Ellipse
","params":[],"returns":[{"description":"new Ellipse
","dataType":{"tokens":[{"value":"Ellipse","kind":"canonical"},{"value":"Ellipse","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"e43sK8rI6Lo2_gRHmbKgF","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"x","optional":false,"description":"the center x coordinate of the ellipse
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the center y coordinate of the ellipse
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"w","optional":false,"description":"width (diameter) of the ellipse
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"h","optional":false,"description":"height (diameter) of the ellipse
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"wVNiwPbF_PN-8SRr0gpsi","name":"contains","brief":"","examples":[{"caption":"","code":"if (circle.contains(10, 10)) {\n // do something\n}\n// or\nif (circle.contains(myVector2d)) {\n // do something\n}"}],"scope":"instance","type":"MethodDoc","description":"check if this circle/ellipse contains the specified point
","params":[{"identifier":"x","optional":false,"variadic":true,"description":"x coordinate or a vector point to check
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"description":"y coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"true if contains
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"JIxYLZ2XyY0Ixus2sdkcL","name":"getBounds","brief":"","scope":"instance","type":"MethodDoc","description":"returns the bounding box for this shape, the smallest Rectangle object completely containing this shape.
","params":[],"returns":[{"description":"this shape bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"BBfwMWE_DnN14W2nELaw8","name":"rotate","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this Ellipse (counter-clockwise) by the specified angle (in radians).
","params":[{"identifier":"angle","optional":false,"description":"The angle to rotate (in radians)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":true,"description":"an optional point to rotate around
","dataType":{"tokens":[{"value":"Vector2d | ObservableVector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Ellipse","kind":"canonical"},{"value":"Ellipse","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"bl6HfXe1Sj2VmPYLQf2Tg","name":"scale","brief":"","scope":"instance","type":"MethodDoc","description":"Scale this Ellipse by the specified scalar.
","params":[{"identifier":"x","optional":false,"description":"the scale factor along the x-axis
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":true,"default":"x","description":"the scale factor along the y-axis
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Ellipse","kind":"canonical"},{"value":"Ellipse","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"SktcxB3w7EwKGWPM_Kkya","name":"scaleV","brief":"","scope":"instance","type":"MethodDoc","description":"Scale this Ellipse by the specified vector.
","params":[{"identifier":"v","optional":false,"dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Ellipse","kind":"canonical"},{"value":"Ellipse","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"5lTx7R2YQhAvO49W03XVx","name":"setShape","brief":"","scope":"instance","type":"MethodDoc","description":"set new value to the Ellipse shape
","params":[{"identifier":"x","optional":false,"description":"the center x coordinate of the ellipse
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the center y coordinate of the ellipse
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"w","optional":false,"description":"width (diameter) of the ellipse
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"h","optional":false,"description":"height (diameter) of the ellipse
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this instance for objecf chaining
","dataType":{"tokens":[{"value":"Ellipse","kind":"canonical"},{"value":"Ellipse","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"oCjVQzH47jgoRPtj5ipdt","name":"transform","brief":"","scope":"instance","type":"MethodDoc","description":"apply the given transformation matrix to this ellipse
","params":[{"identifier":"matrix","optional":false,"description":"the transformation matrix
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"XNSLYGfOvJw6Jcb8r2him","name":"translate","brief":"","examples":[{"caption":"","code":"ellipse.translate(10, 10);\n// or\nellipse.translate(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"translate the circle/ellipse by the specified offset
","params":[{"identifier":"x","description":"x coordinate or a vector point to translate by
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"description":"y offset
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this ellipse
","dataType":{"tokens":[{"value":"Ellipse","kind":"canonical"},{"value":"Ellipse","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]}]},{"id":"Me_bQY9OAQfKiXyHEz_92","name":"Entity","brief":"","type":"ClassDoc","description":"a Generic Object Entity
","params":[],"returns":[],"extends":["Renderable"],"implements":[],"members":[{"id":"jxN57Vs9zluNJjq388blc","name":"alive","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"dead/living state of the entity
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"c3lNHKoyA3FEaBoY8RpHh","name":"alpha","brief":"","defaultValue":"1.0","scope":"instance","see":["Renderable#setOpacity","Renderable#getOpacity"],"type":"PropertyDoc","description":"Define the renderable opacity
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"jtyQcjnAGX2kDqXUpMatc","name":"alwaysUpdate","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object will always update, even when outside of the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"u2WW5Ju3HFz15XumcSZdq","name":"ancestor","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"a reference to the parent object that contains this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"jGEa9-A4ze1gMhmyuwl7o","name":"anchorPoint","brief":"","defaultValue":"<0.5,0.5>","scope":"instance","type":"PropertyDoc","description":"The anchor point is used for attachment behavior, and/or when applying transformations.
When enabled, an object container will automatically apply\nany defined transformation before calling the child draw method...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"l-2yqJWVKbVzLWnq5p-dL","name":"blendMode","brief":"","defaultValue":"\"normal\"","scope":"instance","see":["CanvasRenderer#setBlendMode","WebGLRenderer#setBlendMode"],"type":"PropertyDoc","description":"
the blend mode to be applied to this renderable (see renderer setBlendMode for available blend mode)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"n4vKYSm1UPf-hYsZztnYw","name":"body","brief":"","scope":"instance","type":"PropertyDoc","description":"the entity body object
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Vg_gfWL4fnYnCEfqV9YIb","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"gwXRHFh9PUK1iV4Fsbbc5","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"O8sL5P1KLdXeVG07kzBKg","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Ws475DwvEtNRgkkhV0myW","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"sfz19MjA9j0ER1YyqdfBN","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"rRlpRWDbo26CS5wfLwm26","name":"floating","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"If true, this renderable will be rendered using screen coordinates,\nas opposed to world coordinates. Use this, for example...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"aC7fRkPuT92BxU_eE0YFe","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"
(G)ame (U)nique (Id)entifier"
height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"wvn5i-16buUan_JJqGpLH","name":"id","brief":"","scope":"instance","type":"PropertyDoc","description":"object unique ID (as defined in Tiled)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Bdqm81ktO-57mE-x-132r","name":"inViewport","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object is visible and within the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"wljyyMsFILD5-jFg0f6_-","name":"isDirty","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"when true the renderable will be redrawn during the next update cycle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"hdXY0pIdlQ9bDJ47kZYr0","name":"isFlippedX","brief":"","access":"public","scope":"instance","see":["Renderable#flipX"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Ch4K6-Wa2m1tlu0awBpfI","name":"isFlippedY","brief":"","access":"public","scope":"instance","see":["Renderable#flipY"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"U3bLfyacrDTQ7t99hMq6M","name":"isFloating","brief":"","scope":"instance","see":["Renderable#floating"],"type":"PropertyDoc","description":"Whether the renderable object is floating (i.e. used screen coordinates), or contained in a floating parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"AcaB-enlJsr4AVaxTc9L8","name":"isKinematic","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"If true then physic collision and input events will not impact this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"p3gZ58hNY0CcK7ofAPlQ1","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"C-IMyi-XgviQBhAioqiAb","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"LwdoFe-1FXPoq-v7b0zyA","name":"mask","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"// apply a mask in the shape of a Star\nmyNPCSprite.mask = new me.Polygon(myNPCSprite.width / 2, 0, [\n // draw a star\n {x: 0, y: 0},\n {x: 14, y: 30},\n {x: 47, y: 35},\n {x: 23, y: 57},\n {x: 44, y: 90},\n {x: 0, y: 62},\n {x: -44, y: 90},\n {x: -23, y: 57},\n {x: -47, y: 35},\n {x: -14, y: 30}\n]);"}],"scope":"instance","type":"PropertyDoc","description":"A mask limits rendering elements to the shape and position of the given mask object.\nSo, if the renderable is larger than ...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"I0Abm7qZGSE9f6sqZ4sn6","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"_7fm-BOZ8Og5E85EfsXwK","name":"onVisibilityChange","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"this.onVisibilityChange = function(inViewport) {\n if (inViewport === true) {\n console.log(\"object has entered the in a camera viewport!\");\n }\n};"}],"scope":"instance","type":"PropertyDoc","description":"an event handler that is called when the renderable leave or enter a camera viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"d67Iqy4ULjGh2hufk_O4c","name":"parentApp","brief":"","scope":"instance","type":"PropertyDoc","description":"returns the parent application (or game) to which this renderable is attached to
","params":[],"returns":[{"description":"the parent application or undefined if not attached to any container/app
","dataType":{"tokens":[{"value":"Application","kind":"canonical"},{"value":"Application","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"tOrmdRIprdhINGiR8p7Bn","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"XXOs0rl_XW-M9dMkZJB7L","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"WRfqBqXGgpq2ekD_iwldX","name":"renderable","brief":"","scope":"instance","type":"PropertyDoc","description":"The entity renderable component (can be any objects deriving from me.Renderable, like me.Sprite for example)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"AeKbFl0wNAaOG4sdOgn4v","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"73hBz6ddxZnVBVMpm1wTK","name":"shader","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"(Experimental) an optional shader, to be used instead of the default built-in one, when drawing this renderable (WebGL onl...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"hHxsW4jLUf2khkva9fzb9","name":"tint","brief":"","defaultValue":"(255, 255, 255)","examples":[{"caption":"","code":"// add a red tint to this renderable\nthis.tint.setColor(255, 128, 128);\n// remove the tint\nthis.tint.setColor(255, 255, 255);"}],"scope":"instance","type":"PropertyDoc","description":"
define a tint for this renderable. a (255, 255, 255) r, g, b value will remove the tint effect.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"r0ksrEbcXb8WRD5EcZYIT","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"VqtxycxGuRdMWSMPEj5C6","name":"type","brief":"","scope":"instance","type":"PropertyDoc","description":"object type (as defined in Tiled)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"JWMXqTLMaOxDbD1Tt7jTc","name":"updateWhenPaused","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether to update this object when the game is paused.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"k65VO3_YmTtC2RF486GRp","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"3bkU4IL1Xdts_jEWKpaT3","name":"angleTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the angle to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"angle in radians
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"GMwqtDnuBQm7LKpvVOGaF","name":"centerOn","brief":"","scope":"instance","type":"MethodDoc","description":"center the rectangle position around the given coordinates
","params":[{"identifier":"x","optional":false,"description":"the x coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"WptVUcQrNNcfX7B1zDyT8","name":"clone","brief":"","scope":"instance","type":"MethodDoc","description":"clone this rectangle
","params":[],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"ga2jsuPnjOoD04lm7PmFH","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"x","optional":false,"description":"the x coordinates of the entity object
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y coordinates of the entity object
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings","optional":false,"description":"Entity properties, to be defined through Tiled or when calling the entity constructor\n
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings.height","description":"the physical height the entity takes up in game
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings.name","optional":true,"description":"object entity name
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"settings.id","optional":true,"description":"object unique IDs
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"settings.image","optional":true,"description":"resource name of a spritesheet to use for the entity renderable component
","dataType":{"tokens":[{"value":"Image | string","kind":"canonical"},{"value":"Image","kind":"canonical"}],"template":"%1 | string"}},{"identifier":"settings.anchorPoint","optional":true,"default":"0.0","description":"Entity anchor point
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}},{"identifier":"settings.framewidth","optional":true,"default":"settings.width","description":"width of a single frame in the given spritesheet
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings.frameheight","optional":true,"default":"settings.width","description":"height of a single frame in the given spritesheet
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings.type","optional":true,"description":"object type
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"settings.collisionMask","optional":true,"description":"Mask collision detection for this object
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings.shapes","optional":true,"description":"the initial list of collision shapes (usually populated through Tiled)
","dataType":{"tokens":[{"value":"Array | Array | Array | Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Rect","kind":"link"},{"value":"Array","kind":"canonical"},{"value":"Polygon","kind":"link"},{"value":"Array","kind":"canonical"},{"value":"Line","kind":"link"},{"value":"Array","kind":"canonical"},{"value":"Ellipse","kind":"link"}],"template":"%1<%2> | %3<%4> | %5<%6> | %7<%8>"}}],"returns":[],"extends":[],"implements":[]},{"id":"NkzpUuhOcZOtE2p4oTwVg","name":"contains","brief":"","examples":[{"caption":"","code":"if (rect.contains(10, 10)) {\n // do something\n}\n// or\nif (rect.contains(myVector2d)) {\n // do something\n}\nif (rect.contains(myRect)) {\n // do something\n}"}],"scope":"instance","type":"MethodDoc","description":"Returns true if the rectangle contains the given point or rectangle
","params":[{"identifier":"x","description":"x coordinate or a vector point, or a rectangle to test
","dataType":{"tokens":[{"value":"number | Vector2d | Rect","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Rect","kind":"link"}],"template":"%1 | %2 | %3"}},{"identifier":"y","optional":true,"description":"y coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"True if the rectangle contain the given point or rectangle, otherwise false
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"QdCsWfnB1WU9oDGrFL2fQ","name":"copy","brief":"","scope":"instance","type":"MethodDoc","description":"copy the position and size of the given rectangle into this one
","params":[{"identifier":"rect","optional":false,"description":"Source rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"JrvjKG3wgjWVAH7057F3Y","name":"distanceTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the distance to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"distance
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"1d_qHQiqYEAiD9rzcAqdM","name":"equals","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is identical to the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if equals
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"Jvg-EXwQNZqkAL-u05W8k","name":"flipX","brief":"","scope":"instance","see":["Matrix2d#scaleX"],"type":"MethodDoc","description":"flip the renderable on the horizontal axis (around the center of the renderable)
","params":[{"identifier":"flip","optional":true,"default":"true","description":"true to flip this renderable.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"TQ82bUHJ8_Iu30FhU8_P8","name":"flipY","brief":"","scope":"instance","see":["Matrix2d#scaleY"],"type":"MethodDoc","description":"flip the renderable on the vertical axis (around the center of the renderable)
","params":[{"identifier":"flip","optional":true,"default":"true","description":"true to flip this renderable.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"9U4w8xhztdve0XUUoGxeD","name":"getAbsolutePosition","brief":"","scope":"instance","type":"MethodDoc","description":"return the renderable absolute position in the game world
","params":[],"returns":[{"dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"RhlRqJJw3XmFIrX7CP04u","name":"getBounds","brief":"","scope":"instance","type":"MethodDoc","description":"returns the bounding box for this renderable
","params":[],"returns":[{"description":"bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"pVFbEA8XjVEfKySRnrqQN","name":"getIndices","brief":"","scope":"instance","type":"MethodDoc","description":"returns a list of indices for all triangles defined in this polygon
","params":[],"returns":[{"description":"an array of vertex indices for all triangles forming this polygon.
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1<%2>"}}],"extends":[],"implements":[]},{"id":"wINN-WE4cz1euVp4GXJZV","name":"getOpacity","brief":"","scope":"instance","type":"MethodDoc","description":"get the renderable alpha channel value
","params":[],"returns":[{"description":"current opacity value between 0 and 1
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"EzvNK_WNd4E1W5Dsyiy9f","name":"isConvex","brief":"","scope":"instance","type":"MethodDoc","description":"Returns true if the vertices composing this polygon form a convex shape (vertices must be in clockwise order).
","params":[],"returns":[{"description":"true if the vertices are convex, false if not, null if not computable
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"Sfiq3RP6Ihsgvzw6eFBd_","name":"isFinite","brief":"","scope":"instance","type":"MethodDoc","description":"determines whether all coordinates of this rectangle are finite numbers.
","params":[],"returns":[{"description":"false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"-PvKkml5VALkfAMipGO-E","name":"lookAt","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this renderable towards the given target.
","params":[{"identifier":"target","optional":false,"description":"the renderable or position to look at
","dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"IGWFbX_2our65U3q2AIrd","name":"onBodyUpdate","brief":"update the bounds when the body is modified
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"fvCTt8zWq1TYh5Wl1xu2j","name":"onCollision","brief":"","examples":[{"caption":"","code":"// colision handler\nonCollision(response) {\n if (response.b.body.collisionType === me.collision.types.ENEMY_OBJECT) {\n // makes the other object solid, by substracting the overlap vector to the current position\n this.pos.sub(response.overlapV);\n this.hurt();\n // not solid\n return false;\n }\n // Make the object solid\n return true;\n},"}],"scope":"instance","type":"MethodDoc","description":"onCollision callback, triggered in case of collision,\nwhen this renderable body is colliding with another one
","params":[{"identifier":"response","optional":false,"description":"the collision response object
","dataType":{"tokens":[{"value":"ResponseObject","kind":"canonical"},{"value":"ResponseObject","kind":"link"}],"template":"%1"}},{"identifier":"other","optional":false,"description":"the other renderable touching this one (a reference to response.a or response.b)
","dataType":{"tokens":[{"value":"Renderable | Container | Entity | Sprite | NineSliceSprite","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Container","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"NineSliceSprite","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5"}}],"returns":[{"description":"true if the object should respond to the collision (its position and velocity will be corrected)
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"Vj9qYmgCtB6gTRb9P7AV5","name":"onDeactivateEvent","brief":"onDeactivateEvent Notification function
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"-8xBUfqc5v0lrDMwU353l","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"OnDestroy Notification function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"EOcAPDG_ND1X4CZIKZfLy","name":"overlaps","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is intersecting with the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if overlaps
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"2KQoCYNk_4hiRuttoYBWG","name":"postDraw","brief":"","scope":"instance","see":["Renderable#preDraw","Renderable#draw"],"type":"MethodDoc","description":"restore the rendering context after drawing (automatically called by melonJS).
","params":[{"identifier":"renderer","optional":false,"description":"a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"yaEBkRawlSSYFJkG32dPQ","name":"preDraw","brief":"","scope":"instance","see":["Renderable#draw","Renderable#postDraw"],"type":"MethodDoc","description":"Prepare the rendering context before drawing (automatically called by melonJS).\nThis will apply any defined transforms, an...","params":[{"identifier":"renderer","optional":false,"description":"
a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"vifruBSxxjaUeJesut4EN","name":"recalc","brief":"","scope":"instance","type":"MethodDoc","description":"Computes the calculated collision polygon.\nThis must be called if the points array, an...","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"w_ICL1qEacnssjMQbaqDX","name":"resize","brief":"","scope":"instance","type":"MethodDoc","description":"resize the rectangle
","params":[{"identifier":"w","optional":false,"description":"new width of the rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"h","optional":false,"description":"new height of the rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"JZZXRiBp0GHqmAHmr1iip","name":"rotate","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this renderable by the specified angle (in radians).
","params":[{"identifier":"angle","optional":false,"description":"The angle to rotate (in radians)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":true,"description":"an optional point to rotate around
","dataType":{"tokens":[{"value":"Vector2d | ObservableVector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"9vQjr8rfpms0MCmNI_Shv","name":"scale","brief":"","scope":"instance","type":"MethodDoc","description":"scale the renderable around his anchor point. Scaling actually applies changes\nto the currentTransform member wich is use...","params":[{"identifier":"x","optional":false,"description":"
a number representing the abscissa of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":true,"default":"x","description":"a number representing the ordinate of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"N2nvitcXs7zW7aYvjXS32","name":"scaleV","brief":"","scope":"instance","type":"MethodDoc","description":"scale the renderable around his anchor point
","params":[{"identifier":"v","optional":false,"description":"scaling vector
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"wWlBtOsf1MQGi2hgyREaz","name":"setOpacity","brief":"","scope":"instance","type":"MethodDoc","description":"set the renderable alpha channel value
","params":[{"identifier":"alpha","optional":false,"description":"opacity value between 0.0 and 1.0
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"Oaxhn2SelUjpysUUxgF_C","name":"setShape","brief":"","scope":"instance","type":"MethodDoc","description":"set new value to the rectangle shape
","params":[{"identifier":"x","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"w","optional":false,"description":"width of the rectangle, or an array of vector defining the rectangle
","dataType":{"tokens":[{"value":"number | Array","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %3<%2>"}},{"identifier":"h","optional":true,"description":"height of the rectangle, if a numeral width parameter is specified
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"VaZuNLx4ayjCBxWFxHoKT","name":"setVertices","brief":"","scope":"instance","type":"MethodDoc","description":"set the vertices defining this Polygon
","params":[{"identifier":"vertices","optional":false,"description":"array of vector or vertice defining the Polygon
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1<%2>"}}],"returns":[{"description":"this instance for objecf chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"lOlWjjoFgy0Gga2Pod8EW","name":"shift","brief":"","examples":[{"caption":"","code":"polygon.shift(10, 10);\n// or\npolygon.shift(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"Shifts the Polygon to the given position vector.
","params":[{"identifier":"x","description":"x coordinate or a vector point to shift to
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"lElP2gzEK11m-teMl0jv5","name":"to2d","brief":"","scope":"instance","type":"MethodDoc","description":"apply a 2d projection to this shapen
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"74vAx9rIIK41Bd4bjvPzv","name":"toIso","brief":"","scope":"instance","type":"MethodDoc","description":"apply an isometric projection to this shape
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"3XaBYGe7kRwNaZpyg19nd","name":"toPolygon","brief":"","scope":"instance","type":"MethodDoc","description":"Returns a polygon whose edges are the same as this box.
","params":[],"returns":[{"description":"a new Polygon that represents this rectangle.
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"XYtfE3e2f6Xj1SEi6udzQ","name":"transform","brief":"","scope":"instance","see":["Renderable#currentTransform"],"type":"MethodDoc","description":"multiply the renderable currentTransform with the given matrix
","params":[{"identifier":"m","optional":false,"description":"the transformation matrix
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"nbijjYBxgVpafyJdpvscS","name":"translate","brief":"","examples":[{"caption":"","code":"polygon.translate(10, 10);\n// or\npolygon.translate(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"translate the Polygon by the specified offset
","params":[{"identifier":"x","description":"x offset or a vector point to translate by
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"description":"y offset
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"nGFcIG1FpUPEgt6qTg2Eh","name":"union","brief":"","scope":"instance","type":"MethodDoc","description":"merge this rectangle with another one
","params":[{"identifier":"rect","optional":false,"description":"other rectangle to union with
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"the union(ed) rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"StiZhIhawaISrHBvFVec-","name":"update","brief":"","scope":"instance","type":"MethodDoc","description":"update function (automatically called by melonJS).
","params":[{"identifier":"dt","optional":false,"description":"time since the last update in milliseconds.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"true if the renderable is dirty
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"EwvdKVNZst70tBido8O9B","name":"updateBounds","brief":"","scope":"instance","type":"MethodDoc","description":"update the bounding box for this entity.
","params":[{"identifier":"absolute","optional":true,"default":"true","description":"update the bounds size and position in (world) absolute coordinates
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"this entity bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"bO6L_W39pyFebTXfxg_pT","name":"draw","brief":"","access":"protected","scope":"instance","type":"MethodDoc","description":"draw this entity (automatically called by melonJS)
","params":[{"identifier":"renderer","optional":false,"description":"a renderer instance
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}},{"identifier":"viewport","optional":true,"description":"the viewport to (re)draw
","dataType":{"tokens":[{"value":"Camera2d","kind":"canonical"},{"value":"Camera2d","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"ZERlWKR5V7liSChtzdjTW","name":"onAnchorUpdate","brief":"","access":"private","scope":"instance","type":"MethodDoc","description":"called when the anchor point value is changed
","params":[{"identifier":"x","optional":false,"description":"the new X value to be set for the anchor
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the new Y value to be set for the anchor
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]}]},{"id":"ZMbVNthz4oRYiwfFbYoJm","name":"GLShader","brief":"","type":"ClassDoc","description":"a base GL Shader object
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"yapffkV2x2-sI76RBpPuh","name":"attributes","brief":"","scope":"instance","type":"PropertyDoc","description":"the location attributes of the shader
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"HAYD_aZCXKKE6llPI8G2X","name":"fragment","brief":"","scope":"instance","type":"PropertyDoc","description":"the fragment shader source code
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"1Ekxfzagxk8lm0R4uiBPY","name":"gl","brief":"","scope":"instance","type":"PropertyDoc","description":"the active gl rendering context
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"7YKFIvelp3myrv9eXGCv_","name":"program","brief":"","scope":"instance","type":"PropertyDoc","description":"a reference to the shader program (once compiled)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"OJ-jd19SUeaHOQ9vF_d-d","name":"uniforms","brief":"","scope":"instance","type":"PropertyDoc","description":"the uniforms of the shader
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"3rIYFcenYqfYkqrMldoL4","name":"vertex","brief":"","scope":"instance","type":"PropertyDoc","description":"the vertex shader source code
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"dHWyf0WHZYO0qNLOMo_wI","name":"bind","brief":"Installs this shader program as part of current rendering state
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"LjHkOr_5w7zsP_YIS97Jg","name":"constructor","brief":"","examples":[{"caption":"","code":"// create a basic shader\nlet myShader = new me.GLShader(\n // WebGL rendering context\n gl,\n // vertex shader\n [\n \"void main() {\",\n \" gl_Position = doMathToMakeClipspaceCoordinates;\",\n \"}\"\n ].join(\"\\n\"),\n // fragment shader\n [\n \"void main() {\",\n \" gl_FragColor = doMathToMakeAColor;\",\n \"}\"\n ].join(\"\\n\")\n )\n// use the shader\nmyShader.bind();"}],"scope":"instance","see":["https://developer.mozilla.org/en-US/docs/Games/Techniques/3D_on_the_web/GLSL_Shaders"],"type":"MethodDoc","params":[{"identifier":"gl","optional":false,"description":"the current WebGL rendering context
","dataType":{"tokens":[{"value":"WebGLRenderingContext","kind":"canonical"},{"value":"WebGLRenderingContext","kind":"canonical"}],"template":"%1"}},{"identifier":"vertex","optional":false,"description":"a string containing the GLSL source code to set
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"fragment","optional":false,"description":"a string containing the GLSL source code to set
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"precision","optional":true,"default":"auto detected","description":"float precision ('lowp', 'mediump' or 'highp').
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"returns":[],"extends":[],"implements":[]},{"id":"yM7wif_g9pSvLatLTHuWk","name":"destroy","brief":"destroy this shader objects resources (program, attributes, uniforms)
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"O6ORcYs-6N3y5UY-4yH6X","name":"getAttribLocation","brief":"","scope":"instance","type":"MethodDoc","description":"returns the location of an attribute variable in this shader program
","params":[{"identifier":"name","optional":false,"description":"the name of the attribute variable whose location to get.
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"returns":[{"description":"number indicating the location of the variable name if found. Returns -1 otherwise
","dataType":{"tokens":[{"value":"GLint","kind":"canonical"},{"value":"GLint","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"y73wrJp6IwBsTd-0cOFdP","name":"setUniform","brief":"","examples":[{"caption":"","code":"myShader.setUniform(\"uProjectionMatrix\", this.projectionMatrix);"}],"scope":"instance","type":"MethodDoc","description":"Set the uniform to the given value
","params":[{"identifier":"name","optional":false,"description":"the uniform name
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"value","optional":false,"description":"the value to assign to that uniform
","dataType":{"tokens":[{"value":"object | Float32Array","kind":"canonical"},{"value":"Float32Array","kind":"canonical"}],"template":"object | %1"}}],"returns":[],"extends":[],"implements":[]},{"id":"5-SlOc5UqChZpiNcXttPX","name":"setVertexAttributes","brief":"","scope":"instance","type":"MethodDoc","description":"activate the given vertex attribute for this shader
","params":[{"identifier":"gl","optional":false,"description":"the current WebGL rendering context
","dataType":{"tokens":[{"value":"WebGLRenderingContext","kind":"canonical"},{"value":"WebGLRenderingContext","kind":"canonical"}],"template":"%1"}},{"identifier":"attributes","optional":false,"description":"an array of vertex attributes
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"}],"template":"%1"}},{"identifier":"vertexByteSize","optional":false,"description":"the size of a single vertex in bytes
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]}]},{"id":"OHQgWznkcH5OKXWcPkYTG","name":"GUI_Object","brief":"","deprecated":"since 14.0.0","see":["UISpriteElement"],"type":"ClassDoc","description":"A very basic object to manage GUI elements
","params":[],"returns":[],"extends":["Sprite"],"implements":[],"members":[{"id":"GxLzd4ZoxHoGlIsEZ2p1y","name":"alpha","brief":"","defaultValue":"1.0","scope":"instance","see":["Renderable#setOpacity","Renderable#getOpacity"],"type":"PropertyDoc","description":"Define the renderable opacity
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"zbjp3qijulKTcU09VyeH6","name":"alwaysUpdate","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object will always update, even when outside of the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"IlLkO8j1c762wIXGbpbag","name":"ancestor","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"a reference to the parent object that contains this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"K8ohMspEqUp2JqIyYw_GY","name":"anchorPoint","brief":"","defaultValue":"<0.5,0.5>","scope":"instance","type":"PropertyDoc","description":"The anchor point is used for attachment behavior, and/or when applying transformations.
animation cycling speed (delay between frame in ms)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"BPNAPltrn4tFac2OaIBv9","name":"autoTransform","brief":"","defaultValue":"true","examples":[{"caption":"","code":"// enable \"automatic\" transformation when the object is activated\nonActivateEvent: function () {\n // reset the transformation matrix\n this.currentTransform.identity();\n // ensure the anchor point is the renderable center\n this.anchorPoint.set(0.5, 0.5);\n // enable auto transform\n this.autoTransform = true;\n ....\n}"}],"scope":"instance","type":"PropertyDoc","description":"When enabled, an object container will automatically apply\nany defined transformation before calling the child draw method...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"R-qCRDTnAjsHivl_2-dku","name":"blendMode","brief":"","defaultValue":"\"normal\"","scope":"instance","see":["CanvasRenderer#setBlendMode","WebGLRenderer#setBlendMode"],"type":"PropertyDoc","description":"
the blend mode to be applied to this renderable (see renderer setBlendMode for available blend mode)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"mAaEL1tkNh60QvcLaGTZG","name":"body","brief":"","examples":[{"caption":"","code":" // define a new Player Class\n class PlayerEntity extends me.Sprite {\n // constructor\n constructor(x, y, settings) {\n // call the parent constructor\n super(x, y , settings);\n\n // define a basic walking animation\n this.addAnimation(\"walk\", [...]);\n // define a standing animation (using the first frame)\n this.addAnimation(\"stand\", [...]);\n // set the standing animation as default\n this.setCurrentAnimation(\"stand\");\n\n // add a physic body\n this.body = new me.Body(this);\n // add a default collision shape\n this.body.addShape(new me.Rect(0, 0, this.width, this.height));\n // configure max speed, friction, and initial force to be applied\n this.body.setMaxVelocity(3, 15);\n this.body.setFriction(0.4, 0);\n this.body.force.set(3, 0);\n this.isKinematic = false;\n\n // set the display to follow our position on both axis\n me.game.viewport.follow(this.pos, me.game.viewport.AXIS.BOTH);\n }\n\n ...\n\n }"}],"scope":"instance","type":"PropertyDoc","description":"the renderable physic body
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"qnWB3DkV36wAMsU40Us9o","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"fLgeD_EosA5f6S1-3o0JG","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"au0e5rCwEmKoMa2Gv__AF","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"saSIFgWsujaxnp92LtXNL","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"b7iXptd72eUnwHtBLIU-N","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"7vkMby-u_S8EG_ab2oz2e","name":"floating","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"If true, this renderable will be rendered using screen coordinates,\nas opposed to world coordinates. Use this, for example...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"m6RQcAtYLHxUHyDAwEQue","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"
(G)ame (U)nique (Id)entifier"
height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"rKP5EI9twul4KLxaIiYE4","name":"inViewport","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object is visible and within the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"LglLycAXv2N3XxD1EQDlO","name":"isDirty","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"when true the renderable will be redrawn during the next update cycle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"TsbzWrqvgVMvZL0WHbV-r","name":"isFlippedX","brief":"","access":"public","scope":"instance","see":["Renderable#flipX"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"QWeaBGD-BNePdGzX0a9jL","name":"isFlippedY","brief":"","access":"public","scope":"instance","see":["Renderable#flipY"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"yF7JZxdq8DREdr37nWVj1","name":"isFloating","brief":"","scope":"instance","see":["Renderable#floating"],"type":"PropertyDoc","description":"Whether the renderable object is floating (i.e. used screen coordinates), or contained in a floating parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"nIeqR6HVKQGVvdmj7tJ1Q","name":"isKinematic","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"If true then physic collision and input events will not impact this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"-XEwmN_nNbSYd1tQhjAdP","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Pp-E1dGpU0spkDEH8vqye","name":"isVideo","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"true if this is a video sprite (e.g. a HTMLVideoElement was passed as as source)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"NVI0ZUXAdfFnRzNXYvEka","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"gy7b8P0trtYUqGE7pnAY8","name":"mask","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"// apply a mask in the shape of a Star\nmyNPCSprite.mask = new me.Polygon(myNPCSprite.width / 2, 0, [\n // draw a star\n {x: 0, y: 0},\n {x: 14, y: 30},\n {x: 47, y: 35},\n {x: 23, y: 57},\n {x: 44, y: 90},\n {x: 0, y: 62},\n {x: -44, y: 90},\n {x: -23, y: 57},\n {x: -47, y: 35},\n {x: -14, y: 30}\n]);"}],"scope":"instance","type":"PropertyDoc","description":"A mask limits rendering elements to the shape and position of the given mask object.\nSo, if the renderable is larger than ...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"_lO3dcupCStxMV42CDEuJ","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Mi1OHTXyYyPFBIyV0-I2m","name":"offset","brief":"","defaultValue":"<0.0,0.0>","scope":"instance","type":"PropertyDoc","description":"global offset for the position to draw from on the source image.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"4Yq5Ul_D0Exr0wUB0hhB-","name":"onVisibilityChange","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"this.onVisibilityChange = function(inViewport) {\n if (inViewport === true) {\n console.log(\"object has entered the in a camera viewport!\");\n }\n};"}],"scope":"instance","type":"PropertyDoc","description":"an event handler that is called when the renderable leave or enter a camera viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"RhYnsmTAm5e1qc76V3qAc","name":"parentApp","brief":"","scope":"instance","type":"PropertyDoc","description":"returns the parent application (or game) to which this renderable is attached to
","params":[],"returns":[{"description":"the parent application or undefined if not attached to any container/app
","dataType":{"tokens":[{"value":"Application","kind":"canonical"},{"value":"Application","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"O5embZ9rIg5TIhjgTp7Td","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"1TbtFCtVmueFPCuNmz6yu","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"s76cP3b8aJKHZkt8Eoih7","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ywzco3cIYQ1g4pijvtaRM","name":"shader","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"(Experimental) an optional shader, to be used instead of the default built-in one, when drawing this renderable (WebGL onl...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Bw1Hj0Gk_dtNAVkvZ5cmJ","name":"source","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"
The source texture object this sprite object is using
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"5Bpdc82ZygthoC61qW9Ir","name":"tint","brief":"","defaultValue":"(255, 255, 255)","examples":[{"caption":"","code":"// add a red tint to this renderable\nthis.tint.setColor(255, 128, 128);\n// remove the tint\nthis.tint.setColor(255, 255, 255);"}],"scope":"instance","type":"PropertyDoc","description":"define a tint for this renderable. a (255, 255, 255) r, g, b value will remove the tint effect.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"l-YdQo8mpP5ENmy7aOqiK","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ACYe3AyZUwjB6VQj3KXVA","name":"type","brief":"","defaultValue":"\"Rectangle\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"jPuYOlbYJwe7JYI_4OnGc","name":"updateWhenPaused","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether to update this object when the game is paused.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"rzPVa7M0aQK6OVoa1sAbR","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"jM8Bf6emzAK1y_ugIk2tc","name":"addAnimation","brief":"","examples":[{"caption":"","code":"// walking animation\nthis.addAnimation(\"walk\", [ 0, 1, 2, 3, 4, 5 ]);\n// standing animation\nthis.addAnimation(\"stand\", [ 11, 12 ]);\n// eating animation\nthis.addAnimation(\"eat\", [ 6, 6 ]);\n// rolling animation\nthis.addAnimation(\"roll\", [ 7, 8, 9, 10 ]);\n// slower animation\nthis.addAnimation(\"roll\", [ 7, 8, 9, 10 ], 200);\n// or get more specific with delay for each frame. Good solution instead of repeating:\nthis.addAnimation(\"turn\", [{ name: 0, delay: 200 }, { name: 1, delay: 100 }])\n// can do this with atlas values as well:\nthis.addAnimation(\"turn\", [{ name: \"turnone\", delay: 200 }, { name: \"turntwo\", delay: 100 }])\n// define an dying animation that stop on the last frame\nthis.addAnimation(\"die\", [{ name: 3, delay: 200 }, { name: 4, delay: 100 }, { name: 5, delay: Infinity }])\n// set the standing animation as default\nthis.setCurrentAnimation(\"stand\");"}],"scope":"instance","see":["Sprite#animationspeed"],"type":"MethodDoc","description":"add an animation
animation id
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"index","optional":false,"description":"list of sprite index or name defining the animation. Can also use objects to specify delay for each frame, see below
","dataType":{"tokens":[{"value":"Array | Array | Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"}],"template":"%1<%2> | %3 | %4"}},{"identifier":"animationspeed","optional":true,"description":"cycling speed for animation in ms
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"frame amount of frame added to the animation (delay between each frame).
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"hB2W9FCO_Kp_sfhwBtRBm","name":"angleTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the angle to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"angle in radians
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"h6UEvyN1Zl0ojroYbqQgg","name":"centerOn","brief":"","scope":"instance","type":"MethodDoc","description":"center the rectangle position around the given coordinates
","params":[{"identifier":"x","optional":false,"description":"the x coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"6Xt13-9YyKK9OYPizJs-t","name":"clone","brief":"","scope":"instance","type":"MethodDoc","description":"clone this rectangle
","params":[],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"QEQGjPCPyEoyaXSTZm0K-","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"x","optional":false,"description":"the x coordinate of the GUI Object
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y coordinate of the GUI Object
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings","optional":false,"description":"See {@link Sprite}
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}}],"returns":[],"extends":[],"implements":[]},{"id":"bRojoOS0KB9KttqgeI9vX","name":"contains","brief":"","examples":[{"caption":"","code":"if (rect.contains(10, 10)) {\n // do something\n}\n// or\nif (rect.contains(myVector2d)) {\n // do something\n}\nif (rect.contains(myRect)) {\n // do something\n}"}],"scope":"instance","type":"MethodDoc","description":"Returns true if the rectangle contains the given point or rectangle
","params":[{"identifier":"x","description":"x coordinate or a vector point, or a rectangle to test
","dataType":{"tokens":[{"value":"number | Vector2d | Rect","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Rect","kind":"link"}],"template":"%1 | %2 | %3"}},{"identifier":"y","optional":true,"description":"y coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"True if the rectangle contain the given point or rectangle, otherwise false
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"ca_P2ddPOAuTX6dG9S3-t","name":"copy","brief":"","scope":"instance","type":"MethodDoc","description":"copy the position and size of the given rectangle into this one
","params":[{"identifier":"rect","optional":false,"description":"Source rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"NWryVDp2uSV0rnKx-Kc1u","name":"distanceTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the distance to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"distance
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"gf6EGj7ToDLiMtonyKI3Z","name":"equals","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is identical to the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if equals
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"SFuueIYp8-03ZO3tBMh9x","name":"flicker","brief":"","examples":[{"caption":"","code":"// make the object flicker for 1 second\n// and then remove it\nthis.flicker(1000, function () {\n world.removeChild(this);\n});"}],"scope":"instance","type":"MethodDoc","description":"make the object flicker
","params":[{"identifier":"duration","optional":false,"description":"expressed in milliseconds
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"callback","optional":false,"description":"Function to call when flickering ends
","dataType":{"tokens":[{"value":"Function","kind":"canonical"}],"template":"Function"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Sprite","kind":"canonical"},{"value":"Sprite","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"5A-UIv2EmOkiWtFWLTrf7","name":"flipX","brief":"","scope":"instance","see":["Matrix2d#scaleX"],"type":"MethodDoc","description":"flip the renderable on the horizontal axis (around the center of the renderable)
","params":[{"identifier":"flip","optional":true,"default":"true","description":"true to flip this renderable.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"WHA7ObviJAjR5t4hXVHSM","name":"flipY","brief":"","scope":"instance","see":["Matrix2d#scaleY"],"type":"MethodDoc","description":"flip the renderable on the vertical axis (around the center of the renderable)
","params":[{"identifier":"flip","optional":true,"default":"true","description":"true to flip this renderable.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"BRJYPewwW_5CLaW9qOZpJ","name":"getAbsolutePosition","brief":"","scope":"instance","type":"MethodDoc","description":"return the renderable absolute position in the game world
","params":[],"returns":[{"dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"J_vg0z-zqaZA2iDADVeMX","name":"getBounds","brief":"","scope":"instance","type":"MethodDoc","description":"returns the bounding box for this renderable
","params":[],"returns":[{"description":"bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"W701bbKuLXuguMAQSx_8J","name":"getCurrentAnimationFrame","brief":"","scope":"instance","type":"MethodDoc","description":"return the current animation frame index.
","params":[],"returns":[{"description":"current animation frame index
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"r5eFMddU7G3sOf6usanPD","name":"getIndices","brief":"","scope":"instance","type":"MethodDoc","description":"returns a list of indices for all triangles defined in this polygon
","params":[],"returns":[{"description":"an array of vertex indices for all triangles forming this polygon.
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1<%2>"}}],"extends":[],"implements":[]},{"id":"eikayvNzhJsPgvJxeJ5iE","name":"getOpacity","brief":"","scope":"instance","type":"MethodDoc","description":"get the renderable alpha channel value
","params":[],"returns":[{"description":"current opacity value between 0 and 1
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"4EJhdD2LQkKtBNO4BNSQk","name":"isConvex","brief":"","scope":"instance","type":"MethodDoc","description":"Returns true if the vertices composing this polygon form a convex shape (vertices must be in clockwise order).
","params":[],"returns":[{"description":"true if the vertices are convex, false if not, null if not computable
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"YTBjxQaQOd7K4KKi75C1x","name":"isCurrentAnimation","brief":"","examples":[{"caption":"","code":"if (!this.isCurrentAnimation(\"walk\")) {\n // do something funny...\n}"}],"scope":"instance","type":"MethodDoc","description":"return true if the specified animation is the current one.
","params":[{"identifier":"name","optional":false,"description":"animation id
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"returns":[{"dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"i0N3IEsK2nPxYJnRwLNCj","name":"isFinite","brief":"","scope":"instance","type":"MethodDoc","description":"determines whether all coordinates of this rectangle are finite numbers.
","params":[],"returns":[{"description":"false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"7PHXwdM2ButjwbVhB5zMQ","name":"isFlickering","brief":"","scope":"instance","type":"MethodDoc","description":"return the flickering state of the object
","params":[],"returns":[{"dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"9VxmYb5wvspQsV4Hg5mQs","name":"lookAt","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this renderable towards the given target.
","params":[{"identifier":"target","optional":false,"description":"the renderable or position to look at
","dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"c5nCMz1M-0wo6DG5e0HxF","name":"onCollision","brief":"","examples":[{"caption":"","code":"// colision handler\nonCollision(response) {\n if (response.b.body.collisionType === me.collision.types.ENEMY_OBJECT) {\n // makes the other object solid, by substracting the overlap vector to the current position\n this.pos.sub(response.overlapV);\n this.hurt();\n // not solid\n return false;\n }\n // Make the object solid\n return true;\n},"}],"scope":"instance","type":"MethodDoc","description":"onCollision callback, triggered in case of collision,\nwhen this renderable body is colliding with another one
","params":[{"identifier":"response","optional":false,"description":"the collision response object
","dataType":{"tokens":[{"value":"ResponseObject","kind":"canonical"},{"value":"ResponseObject","kind":"link"}],"template":"%1"}},{"identifier":"other","optional":false,"description":"the other renderable touching this one (a reference to response.a or response.b)
","dataType":{"tokens":[{"value":"Renderable | Container | Entity | Sprite | NineSliceSprite","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Container","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"NineSliceSprite","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5"}}],"returns":[{"description":"true if the object should respond to the collision (its position and velocity will be corrected)
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"FRskaTijN2gdIeRHfBA4K","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"OnDestroy Notification function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"aD5UPfpIw3K5Imo7xxLLy","name":"overlaps","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is intersecting with the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if overlaps
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"svuZ3J2QCe84vHbjeosB5","name":"pause","brief":"play or resume the current animation or video
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"BdwtBRC5whAldGEwrvVZt","name":"play","brief":"play or resume the current animation or video
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"OsxaSx8xZyWrJdHxaqSXo","name":"postDraw","brief":"","scope":"instance","see":["Renderable#preDraw","Renderable#draw"],"type":"MethodDoc","description":"restore the rendering context after drawing (automatically called by melonJS).
","params":[{"identifier":"renderer","optional":false,"description":"a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"eDZMK2OE3o7FnPmo25Unu","name":"preDraw","brief":"","scope":"instance","see":["Renderable#draw","Renderable#postDraw"],"type":"MethodDoc","description":"Prepare the rendering context before drawing (automatically called by melonJS).\nThis will apply any defined transforms, an...","params":[{"identifier":"renderer","optional":false,"description":"
a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"DwIPRYkwfQ3SdOqXPSu2C","name":"recalc","brief":"","scope":"instance","type":"MethodDoc","description":"Computes the calculated collision polygon.\nThis must be called if the points array, an...","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"2A3yXaxwv6hxyhHsWQ4GU","name":"resize","brief":"","scope":"instance","type":"MethodDoc","description":"resize the rectangle
","params":[{"identifier":"w","optional":false,"description":"new width of the rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"h","optional":false,"description":"new height of the rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"DAsa4sVhlCUwjUoHJXRYS","name":"reverseAnimation","brief":"","scope":"instance","see":["Sprite#animationspeed"],"type":"MethodDoc","description":"reverse the given or current animation if none is specified
","params":[{"identifier":"name","optional":true,"description":"animation id
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Sprite","kind":"canonical"},{"value":"Sprite","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"tm0vt8AdNGJY_fBhJs6AW","name":"rotate","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this renderable by the specified angle (in radians).
","params":[{"identifier":"angle","optional":false,"description":"The angle to rotate (in radians)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":true,"description":"an optional point to rotate around
","dataType":{"tokens":[{"value":"Vector2d | ObservableVector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"CCdKYTnbLNDZQnXIjVycU","name":"scale","brief":"","scope":"instance","type":"MethodDoc","description":"scale the renderable around his anchor point. Scaling actually applies changes\nto the currentTransform member wich is use...","params":[{"identifier":"x","optional":false,"description":"
a number representing the abscissa of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":true,"default":"x","description":"a number representing the ordinate of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"MTvWI9YeUhuc6PwAHJHCi","name":"scaleV","brief":"","scope":"instance","type":"MethodDoc","description":"scale the renderable around his anchor point
","params":[{"identifier":"v","optional":false,"description":"scaling vector
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"rl7L3rHVxoR1tYN4e0yJV","name":"setAnimationFrame","brief":"","examples":[{"caption":"","code":"// reset the current animation to the first frame\nthis.setAnimationFrame();"}],"scope":"instance","type":"MethodDoc","description":"force the current animation frame index.
","params":[{"identifier":"index","optional":true,"default":"0","description":"animation frame index
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Sprite","kind":"canonical"},{"value":"Sprite","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"K0ZhgtcZJscyKtCrXk6a8","name":"setCurrentAnimation","brief":"","examples":[{"caption":"","code":" // set \"walk\" animation\n this.setCurrentAnimation(\"walk\");\n\n // set \"walk\" animation if it is not the current animation\n if (this.isCurrentAnimation(\"walk\")) {\n this.setCurrentAnimation(\"walk\");\n }\n\n // set \"eat\" animation, and switch to \"walk\" when complete\n this.setCurrentAnimation(\"eat\", \"walk\");\n\n // set \"die\" animation, and remove the object when finished\n this.setCurrentAnimation(\"die\", () => {\n world.removeChild(this);\n return false; // do not reset to first frame\n });\n\n // set \"attack\" animation, and pause for a short duration\n this.setCurrentAnimation(\"die\", () => {\n this.animationpause = true;\n\n // back to \"standing\" animation after 1 second\n setTimeout(function () {\n this.setCurrentAnimation(\"standing\");\n }, 1000);\n\n return false; // do not reset to first frame\n });"}],"scope":"instance","type":"MethodDoc","description":"set the current animation\nthis will always change the animation & set the frame to zero
","params":[{"identifier":"name","optional":false,"description":"animation id
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"resetAnim","optional":true,"description":"animation id to switch to when complete, or callback
","dataType":{"tokens":[{"value":"string | Function","kind":"canonical"}],"template":"string | Function"}},{"identifier":"preserve_dt","optional":true,"default":"false","description":"if false will reset the elapsed time counter since last frame
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Sprite","kind":"canonical"},{"value":"Sprite","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"qr0oPQEnB-1tUSv2l_htJ","name":"setOpacity","brief":"","scope":"instance","type":"MethodDoc","description":"set the renderable alpha channel value
","params":[{"identifier":"alpha","optional":false,"description":"opacity value between 0.0 and 1.0
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"cjIe4u5m4YR5GTyCCLOxv","name":"setRegion","brief":"","examples":[{"caption":"","code":"// change the sprite to \"shadedDark13.png\";\nmySprite.setRegion(mytexture.getRegion(\"shadedDark13.png\"));"}],"scope":"instance","see":["Texture.getRegion"],"type":"MethodDoc","description":"change the current texture atlas region for this sprite
","params":[{"identifier":"region","optional":false,"description":"typically returned through me.Texture.getRegion()
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Sprite","kind":"canonical"},{"value":"Sprite","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"7G2_Z2LDwHvpZgUq7c5eU","name":"setShape","brief":"","scope":"instance","type":"MethodDoc","description":"set new value to the rectangle shape
","params":[{"identifier":"x","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"w","optional":false,"description":"width of the rectangle, or an array of vector defining the rectangle
","dataType":{"tokens":[{"value":"number | Array","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %3<%2>"}},{"identifier":"h","optional":true,"description":"height of the rectangle, if a numeral width parameter is specified
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"zbP0Xns6eLrSo8gml80q9","name":"setVertices","brief":"","scope":"instance","type":"MethodDoc","description":"set the vertices defining this Polygon
","params":[{"identifier":"vertices","optional":false,"description":"array of vector or vertice defining the Polygon
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1<%2>"}}],"returns":[{"description":"this instance for objecf chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"sUS-gusfElufNZ6yzOluu","name":"shift","brief":"","examples":[{"caption":"","code":"polygon.shift(10, 10);\n// or\npolygon.shift(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"Shifts the Polygon to the given position vector.
","params":[{"identifier":"x","description":"x coordinate or a vector point to shift to
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"5j4QV1D81z-jWv8Ela7x8","name":"to2d","brief":"","scope":"instance","type":"MethodDoc","description":"apply a 2d projection to this shapen
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"k3bTsBvYM1s5QpSvI0Fmg","name":"toIso","brief":"","scope":"instance","type":"MethodDoc","description":"apply an isometric projection to this shape
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"WN6LEjDCfmAQdtNwVgw_w","name":"toPolygon","brief":"","scope":"instance","type":"MethodDoc","description":"Returns a polygon whose edges are the same as this box.
","params":[],"returns":[{"description":"a new Polygon that represents this rectangle.
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"QlwenEfSwoq6JrVSyqiC2","name":"transform","brief":"","scope":"instance","see":["Renderable#currentTransform"],"type":"MethodDoc","description":"multiply the renderable currentTransform with the given matrix
","params":[{"identifier":"m","optional":false,"description":"the transformation matrix
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"xkCh8xEcKTOwIPyE6BHlz","name":"translate","brief":"","examples":[{"caption":"","code":"polygon.translate(10, 10);\n// or\npolygon.translate(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"translate the Polygon by the specified offset
","params":[{"identifier":"x","description":"x offset or a vector point to translate by
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"description":"y offset
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"v3yeeYdo1or3JJqDW2fL-","name":"union","brief":"","scope":"instance","type":"MethodDoc","description":"merge this rectangle with another one
","params":[{"identifier":"rect","optional":false,"description":"other rectangle to union with
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"the union(ed) rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"XSFA1pJXfJ-aFSQcBTd1s","name":"updateBounds","brief":"","scope":"instance","type":"MethodDoc","description":"update the bounding box for this shape.
","params":[{"identifier":"absolute","optional":true,"default":"true","description":"update the bounds size and position in (world) absolute coordinates
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"this shape bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"hDo6rH_D7B1bsYw7k0L-R","name":"draw","brief":"","access":"protected","scope":"instance","type":"MethodDoc","description":"draw this srite (automatically called by melonJS)
","params":[{"identifier":"renderer","optional":false,"description":"a renderer instance
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}},{"identifier":"viewport","optional":true,"description":"the viewport to (re)draw
","dataType":{"tokens":[{"value":"Camera2d","kind":"canonical"},{"value":"Camera2d","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"uCCnF7rnSQJ1ZJNKis_MJ","name":"update","brief":"","access":"protected","scope":"instance","type":"MethodDoc","description":"update function.
","params":[{"identifier":"dt","optional":false,"description":"time since the last update in milliseconds.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"true if the Sprite is dirty
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"P-0XFItOpxNVH9HSLUudL","name":"onAnchorUpdate","brief":"","access":"private","scope":"instance","type":"MethodDoc","description":"called when the anchor point value is changed
","params":[{"identifier":"x","optional":false,"description":"the new X value to be set for the anchor
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the new Y value to be set for the anchor
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]}]},{"id":"h4iy5jPFhtyF4-O4YDzVN","name":"ImageLayer","brief":"","type":"ClassDoc","description":"a generic Image Layer Object
","params":[],"returns":[],"extends":["Sprite"],"implements":[],"members":[{"id":"H4Am1EOSQnQoyBVJpMRal","name":"alpha","brief":"","defaultValue":"1.0","scope":"instance","see":["Renderable#setOpacity","Renderable#getOpacity"],"type":"PropertyDoc","description":"Define the renderable opacity
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"nkZPxvIo3vqrhyZJuBpyC","name":"alwaysUpdate","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object will always update, even when outside of the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"rySugttn3d_Pf103bu5l9","name":"ancestor","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"a reference to the parent object that contains this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"bWyoixXhfLgTduWyzSgsr","name":"anchorPoint","brief":"","defaultValue":"<0.5,0.5>","scope":"instance","type":"PropertyDoc","description":"The anchor point is used for attachment behavior, and/or when applying transformations.
animation cycling speed (delay between frame in ms)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"PX3Z6Xyk3mtrpDOaV-K7J","name":"autoTransform","brief":"","defaultValue":"true","examples":[{"caption":"","code":"// enable \"automatic\" transformation when the object is activated\nonActivateEvent: function () {\n // reset the transformation matrix\n this.currentTransform.identity();\n // ensure the anchor point is the renderable center\n this.anchorPoint.set(0.5, 0.5);\n // enable auto transform\n this.autoTransform = true;\n ....\n}"}],"scope":"instance","type":"PropertyDoc","description":"When enabled, an object container will automatically apply\nany defined transformation before calling the child draw method...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Vovy5bGTtohQ9YNheuciW","name":"blendMode","brief":"","defaultValue":"\"normal\"","scope":"instance","see":["CanvasRenderer#setBlendMode","WebGLRenderer#setBlendMode"],"type":"PropertyDoc","description":"
the blend mode to be applied to this renderable (see renderer setBlendMode for available blend mode)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"E8tza10kOYz1OV9xMO6DN","name":"body","brief":"","examples":[{"caption":"","code":" // define a new Player Class\n class PlayerEntity extends me.Sprite {\n // constructor\n constructor(x, y, settings) {\n // call the parent constructor\n super(x, y , settings);\n\n // define a basic walking animation\n this.addAnimation(\"walk\", [...]);\n // define a standing animation (using the first frame)\n this.addAnimation(\"stand\", [...]);\n // set the standing animation as default\n this.setCurrentAnimation(\"stand\");\n\n // add a physic body\n this.body = new me.Body(this);\n // add a default collision shape\n this.body.addShape(new me.Rect(0, 0, this.width, this.height));\n // configure max speed, friction, and initial force to be applied\n this.body.setMaxVelocity(3, 15);\n this.body.setFriction(0.4, 0);\n this.body.force.set(3, 0);\n this.isKinematic = false;\n\n // set the display to follow our position on both axis\n me.game.viewport.follow(this.pos, me.game.viewport.AXIS.BOTH);\n }\n\n ...\n\n }"}],"scope":"instance","type":"PropertyDoc","description":"the renderable physic body
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"A2qkZcHDkxmtR0DuAVsZX","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"7kxU25xPUnTITAVdRAP6d","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"lUFYkDfKCeyv4-vt8A1UQ","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"iK2LJ512mUeqsBGZt8Kqx","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"9Hv3YP_BQ_0dHvQ2bGdI_","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"P-4Dss1Tpi1pqtGoxvtFE","name":"floating","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"If true, this renderable will be rendered using screen coordinates,\nas opposed to world coordinates. Use this, for example...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"K4LsoLdmSUYvG1Yjxpf7y","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"
(G)ame (U)nique (Id)entifier"
height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"j5GmR4vfk5K4WCrONmRKi","name":"inViewport","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object is visible and within the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"mKDlux5x9VEVUAVvbuReL","name":"isDirty","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"when true the renderable will be redrawn during the next update cycle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"UvHv7Q82URY7Cao9dKgH7","name":"isFlippedX","brief":"","access":"public","scope":"instance","see":["Renderable#flipX"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"7ngvAhYggX45Wh8UF6qMn","name":"isFlippedY","brief":"","access":"public","scope":"instance","see":["Renderable#flipY"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"uVW5DHWKF50NPmG1r0Dg-","name":"isFloating","brief":"","scope":"instance","see":["Renderable#floating"],"type":"PropertyDoc","description":"Whether the renderable object is floating (i.e. used screen coordinates), or contained in a floating parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"P2OOsDZ4ppvua-1IBqbZ6","name":"isKinematic","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"If true then physic collision and input events will not impact this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Mo7P4itsp5wYLkKB7smyu","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"n08XeBZYxZdDjHrZcOT5e","name":"isVideo","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"true if this is a video sprite (e.g. a HTMLVideoElement was passed as as source)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"eOpzHgr68Tqhgp0cc_h2u","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"8wRkblsoT8F3LB0wv0aZ5","name":"mask","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"// apply a mask in the shape of a Star\nmyNPCSprite.mask = new me.Polygon(myNPCSprite.width / 2, 0, [\n // draw a star\n {x: 0, y: 0},\n {x: 14, y: 30},\n {x: 47, y: 35},\n {x: 23, y: 57},\n {x: 44, y: 90},\n {x: 0, y: 62},\n {x: -44, y: 90},\n {x: -23, y: 57},\n {x: -47, y: 35},\n {x: -14, y: 30}\n]);"}],"scope":"instance","type":"PropertyDoc","description":"A mask limits rendering elements to the shape and position of the given mask object.\nSo, if the renderable is larger than ...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"jHMiGXWu3gNQs02Dm0qJc","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"OYSDS72HlQ4EGzd7oJy2U","name":"offset","brief":"","defaultValue":"<0.0,0.0>","scope":"instance","type":"PropertyDoc","description":"global offset for the position to draw from on the source image.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"e_3yOMsSjY0kHdvM3ed_b","name":"onVisibilityChange","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"this.onVisibilityChange = function(inViewport) {\n if (inViewport === true) {\n console.log(\"object has entered the in a camera viewport!\");\n }\n};"}],"scope":"instance","type":"PropertyDoc","description":"an event handler that is called when the renderable leave or enter a camera viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"LmdRehXFoTZGX6vNjO963","name":"parentApp","brief":"","scope":"instance","type":"PropertyDoc","description":"returns the parent application (or game) to which this renderable is attached to
","params":[],"returns":[{"description":"the parent application or undefined if not attached to any container/app
","dataType":{"tokens":[{"value":"Application","kind":"canonical"},{"value":"Application","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"cGlk3jZDocwcEI2qJwgHD","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"um2wFv7Ob98WD2qrNANpl","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"tyIj4vXahOIvvCUlafC4l","name":"ratio","brief":"","defaultValue":"<1.0,1.0>","scope":"instance","type":"PropertyDoc","description":"Define the image scrolling ratio
Define if and how an Image Layer should be repeated.
right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"f3hAILFKXIPkJeT3PtqAY","name":"shader","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"(Experimental) an optional shader, to be used instead of the default built-in one, when drawing this renderable (WebGL onl...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"bk73ymlLRzgza810BELls","name":"source","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"
The source texture object this sprite object is using
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"1cLF5aoDF0uQp1cRAgC4l","name":"tint","brief":"","defaultValue":"(255, 255, 255)","examples":[{"caption":"","code":"// add a red tint to this renderable\nthis.tint.setColor(255, 128, 128);\n// remove the tint\nthis.tint.setColor(255, 255, 255);"}],"scope":"instance","type":"PropertyDoc","description":"define a tint for this renderable. a (255, 255, 255) r, g, b value will remove the tint effect.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"BNgOPvAjELMpNmX2uSjB9","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"sbRwTXsDn7C3EsyGnFfoA","name":"type","brief":"","defaultValue":"\"Rectangle\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"bDZW71g4yqBhIOZiOaiaA","name":"updateWhenPaused","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether to update this object when the game is paused.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"bQx4Gy5Qb2eQs4KrvztoX","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"t-GM7ZDTopDMkCA-C-WOo","name":"addAnimation","brief":"","examples":[{"caption":"","code":"// walking animation\nthis.addAnimation(\"walk\", [ 0, 1, 2, 3, 4, 5 ]);\n// standing animation\nthis.addAnimation(\"stand\", [ 11, 12 ]);\n// eating animation\nthis.addAnimation(\"eat\", [ 6, 6 ]);\n// rolling animation\nthis.addAnimation(\"roll\", [ 7, 8, 9, 10 ]);\n// slower animation\nthis.addAnimation(\"roll\", [ 7, 8, 9, 10 ], 200);\n// or get more specific with delay for each frame. Good solution instead of repeating:\nthis.addAnimation(\"turn\", [{ name: 0, delay: 200 }, { name: 1, delay: 100 }])\n// can do this with atlas values as well:\nthis.addAnimation(\"turn\", [{ name: \"turnone\", delay: 200 }, { name: \"turntwo\", delay: 100 }])\n// define an dying animation that stop on the last frame\nthis.addAnimation(\"die\", [{ name: 3, delay: 200 }, { name: 4, delay: 100 }, { name: 5, delay: Infinity }])\n// set the standing animation as default\nthis.setCurrentAnimation(\"stand\");"}],"scope":"instance","see":["Sprite#animationspeed"],"type":"MethodDoc","description":"add an animation
animation id
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"index","optional":false,"description":"list of sprite index or name defining the animation. Can also use objects to specify delay for each frame, see below
","dataType":{"tokens":[{"value":"Array | Array | Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"}],"template":"%1<%2> | %3 | %4"}},{"identifier":"animationspeed","optional":true,"description":"cycling speed for animation in ms
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"frame amount of frame added to the animation (delay between each frame).
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"NwCoM8U3Ri-39Ke8UK1aK","name":"angleTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the angle to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"angle in radians
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"ihailjV-Kc7Oh543Ay-AV","name":"centerOn","brief":"","scope":"instance","type":"MethodDoc","description":"center the rectangle position around the given coordinates
","params":[{"identifier":"x","optional":false,"description":"the x coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"GWe7a-gPxqUA3d5vnEYAh","name":"clone","brief":"","scope":"instance","type":"MethodDoc","description":"clone this rectangle
","params":[],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"rALcqO6LNy4lAPocdOCPf","name":"constructor","brief":"","examples":[{"caption":"","code":"// create a repetitive background pattern on the X axis using the citycloud image asset\nme.game.world.addChild(new me.ImageLayer(0, 0, {\n image:\"citycloud\",\n repeat :\"repeat-x\"\n}), 1);"}],"scope":"instance","type":"MethodDoc","params":[{"identifier":"x","optional":false,"description":"x coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"y coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings","optional":false,"description":"ImageLayer properties
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}},{"identifier":"settings.image","description":"Image reference. See {@link loader.getImage}
","dataType":{"tokens":[{"value":"HTMLImageElement | HTMLCanvasElement | string","kind":"canonical"},{"value":"HTMLImageElement","kind":"canonical"},{"value":"HTMLCanvasElement","kind":"canonical"}],"template":"%1 | %2 | string"}},{"identifier":"settings.name","optional":true,"default":"\"me.ImageLayer\"","description":"layer name
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"settings.z","optional":true,"default":"0","description":"z-index position
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings.ratio","optional":true,"default":"1.0","description":"Scrolling ratio to be applied. See {@link ImageLayer#ratio}
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"settings.repeat","optional":true,"default":"\"repeat\"","description":"define if and how an Image Layer should be repeated. See {@link ImageLayer#repeat}
","dataType":{"tokens":[{"value":"\"repeat\" | \"repeat-x\" | \"repeat-y\" | \"no-repeat\"","kind":"canonical"},{"value":"\"repeat\"","kind":"canonical"},{"value":"\"repeat-x\"","kind":"canonical"},{"value":"\"repeat-y\"","kind":"canonical"},{"value":"\"no-repeat\"","kind":"canonical"}],"template":"%1 | %2 | %3 | %4"}},{"identifier":"settings.anchorPoint","optional":true,"default":"<0.0,0.0>","description":"Define how the image is anchored to the viewport bound. By default, its upper-left corner is anchored to the viewport boun...","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"5z2CwF9y_Y2uSQvLNlQxz","name":"contains","brief":"","examples":[{"caption":"","code":"if (rect.contains(10, 10)) {\n // do something\n}\n// or\nif (rect.contains(myVector2d)) {\n // do something\n}\nif (rect.contains(myRect)) {\n // do something\n}"}],"scope":"instance","type":"MethodDoc","description":"
Returns true if the rectangle contains the given point or rectangle
","params":[{"identifier":"x","description":"x coordinate or a vector point, or a rectangle to test
","dataType":{"tokens":[{"value":"number | Vector2d | Rect","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Rect","kind":"link"}],"template":"%1 | %2 | %3"}},{"identifier":"y","optional":true,"description":"y coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"True if the rectangle contain the given point or rectangle, otherwise false
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"chu_HJbsP_nf_WKEXLDeZ","name":"copy","brief":"","scope":"instance","type":"MethodDoc","description":"copy the position and size of the given rectangle into this one
","params":[{"identifier":"rect","optional":false,"description":"Source rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"OPnQ0GE76iG8gNWnPFxcg","name":"distanceTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the distance to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"distance
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"E0FV4H13TLyWg8YK_cGSc","name":"equals","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is identical to the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if equals
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"K684OTuFuZLgbZ9mrcG1E","name":"flicker","brief":"","examples":[{"caption":"","code":"// make the object flicker for 1 second\n// and then remove it\nthis.flicker(1000, function () {\n world.removeChild(this);\n});"}],"scope":"instance","type":"MethodDoc","description":"make the object flicker
","params":[{"identifier":"duration","optional":false,"description":"expressed in milliseconds
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"callback","optional":false,"description":"Function to call when flickering ends
","dataType":{"tokens":[{"value":"Function","kind":"canonical"}],"template":"Function"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Sprite","kind":"canonical"},{"value":"Sprite","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"MuXmlC-d_tCr2gMXu1GUt","name":"flipX","brief":"","scope":"instance","see":["Matrix2d#scaleX"],"type":"MethodDoc","description":"flip the renderable on the horizontal axis (around the center of the renderable)
","params":[{"identifier":"flip","optional":true,"default":"true","description":"true to flip this renderable.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"EmrpxfoAPsaKVUM8iYXtD","name":"flipY","brief":"","scope":"instance","see":["Matrix2d#scaleY"],"type":"MethodDoc","description":"flip the renderable on the vertical axis (around the center of the renderable)
","params":[{"identifier":"flip","optional":true,"default":"true","description":"true to flip this renderable.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"8t_bo3SMhqTRUd_knrc_p","name":"getAbsolutePosition","brief":"","scope":"instance","type":"MethodDoc","description":"return the renderable absolute position in the game world
","params":[],"returns":[{"dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"QcZkRo1ru16Mb-_YDgLdJ","name":"getBounds","brief":"","scope":"instance","type":"MethodDoc","description":"returns the bounding box for this renderable
","params":[],"returns":[{"description":"bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"nT_ipD6rC-I0B9Xk5YIED","name":"getCurrentAnimationFrame","brief":"","scope":"instance","type":"MethodDoc","description":"return the current animation frame index.
","params":[],"returns":[{"description":"current animation frame index
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"hkCRnhKJ3DWc-zXFAs_tu","name":"getIndices","brief":"","scope":"instance","type":"MethodDoc","description":"returns a list of indices for all triangles defined in this polygon
","params":[],"returns":[{"description":"an array of vertex indices for all triangles forming this polygon.
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1<%2>"}}],"extends":[],"implements":[]},{"id":"LVCoRxZ-hayxpPntUszaB","name":"getOpacity","brief":"","scope":"instance","type":"MethodDoc","description":"get the renderable alpha channel value
","params":[],"returns":[{"description":"current opacity value between 0 and 1
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"JFX-Jg09vsTChx2dYJPlw","name":"isConvex","brief":"","scope":"instance","type":"MethodDoc","description":"Returns true if the vertices composing this polygon form a convex shape (vertices must be in clockwise order).
","params":[],"returns":[{"description":"true if the vertices are convex, false if not, null if not computable
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"qh8jGVRwTT__-aZq1Bx0E","name":"isCurrentAnimation","brief":"","examples":[{"caption":"","code":"if (!this.isCurrentAnimation(\"walk\")) {\n // do something funny...\n}"}],"scope":"instance","type":"MethodDoc","description":"return true if the specified animation is the current one.
","params":[{"identifier":"name","optional":false,"description":"animation id
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"returns":[{"dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"E5EzMfJtfV9qbRWtCjdIY","name":"isFinite","brief":"","scope":"instance","type":"MethodDoc","description":"determines whether all coordinates of this rectangle are finite numbers.
","params":[],"returns":[{"description":"false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"oZ5DCCps7Su02Pz8QHY58","name":"isFlickering","brief":"","scope":"instance","type":"MethodDoc","description":"return the flickering state of the object
","params":[],"returns":[{"dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"pXOkzYT2NNdyE9cuVzYFq","name":"lookAt","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this renderable towards the given target.
","params":[{"identifier":"target","optional":false,"description":"the renderable or position to look at
","dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"UM7MkJy1hr6-60SfK-K1i","name":"onCollision","brief":"","examples":[{"caption":"","code":"// colision handler\nonCollision(response) {\n if (response.b.body.collisionType === me.collision.types.ENEMY_OBJECT) {\n // makes the other object solid, by substracting the overlap vector to the current position\n this.pos.sub(response.overlapV);\n this.hurt();\n // not solid\n return false;\n }\n // Make the object solid\n return true;\n},"}],"scope":"instance","type":"MethodDoc","description":"onCollision callback, triggered in case of collision,\nwhen this renderable body is colliding with another one
","params":[{"identifier":"response","optional":false,"description":"the collision response object
","dataType":{"tokens":[{"value":"ResponseObject","kind":"canonical"},{"value":"ResponseObject","kind":"link"}],"template":"%1"}},{"identifier":"other","optional":false,"description":"the other renderable touching this one (a reference to response.a or response.b)
","dataType":{"tokens":[{"value":"Renderable | Container | Entity | Sprite | NineSliceSprite","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Container","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"NineSliceSprite","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5"}}],"returns":[{"description":"true if the object should respond to the collision (its position and velocity will be corrected)
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"Nz-H9QFj91MGkVGnuRvz-","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"OnDestroy Notification function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ayBYpU5JQQHqaTdbn-RSA","name":"overlaps","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is intersecting with the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if overlaps
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"KRjN6UVS-HB9DPcvqDyCS","name":"pause","brief":"play or resume the current animation or video
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Qfzx_qnMpnt23N9U684UL","name":"play","brief":"play or resume the current animation or video
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"2AAT4Q00dkk4mF9AKXZyU","name":"postDraw","brief":"","scope":"instance","see":["Renderable#preDraw","Renderable#draw"],"type":"MethodDoc","description":"restore the rendering context after drawing (automatically called by melonJS).
","params":[{"identifier":"renderer","optional":false,"description":"a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"TfFRozAnb-dl8Px_CUy13","name":"preDraw","brief":"","scope":"instance","see":["Renderable#draw","Renderable#postDraw"],"type":"MethodDoc","description":"Prepare the rendering context before drawing (automatically called by melonJS).\nThis will apply any defined transforms, an...","params":[{"identifier":"renderer","optional":false,"description":"
a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"U89QgcCYFJ0WG2M7yFes7","name":"recalc","brief":"","scope":"instance","type":"MethodDoc","description":"Computes the calculated collision polygon.\nThis must be called if the points array, an...","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"HGmMpzrJTSHV75JkMCb_h","name":"resize","brief":"","scope":"instance","type":"MethodDoc","description":"resize the Image Layer to match the given size
","params":[{"identifier":"w","optional":false,"description":"new width
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"h","optional":false,"description":"new height
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"kQR4kP3Mu5bQcVMliSH9n","name":"reverseAnimation","brief":"","scope":"instance","see":["Sprite#animationspeed"],"type":"MethodDoc","description":"reverse the given or current animation if none is specified
","params":[{"identifier":"name","optional":true,"description":"animation id
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Sprite","kind":"canonical"},{"value":"Sprite","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"cm944n31xDEIzJqDW36v7","name":"rotate","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this renderable by the specified angle (in radians).
","params":[{"identifier":"angle","optional":false,"description":"The angle to rotate (in radians)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":true,"description":"an optional point to rotate around
","dataType":{"tokens":[{"value":"Vector2d | ObservableVector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"_TeFIPuqMUdTA1ZvWhw2r","name":"scale","brief":"","scope":"instance","type":"MethodDoc","description":"scale the renderable around his anchor point. Scaling actually applies changes\nto the currentTransform member wich is use...","params":[{"identifier":"x","optional":false,"description":"
a number representing the abscissa of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":true,"default":"x","description":"a number representing the ordinate of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"uqL4O-XTHkkypBy7PG6FN","name":"scaleV","brief":"","scope":"instance","type":"MethodDoc","description":"scale the renderable around his anchor point
","params":[{"identifier":"v","optional":false,"description":"scaling vector
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Z-o3LfdZYDE8LMx5juJ3X","name":"setAnimationFrame","brief":"","examples":[{"caption":"","code":"// reset the current animation to the first frame\nthis.setAnimationFrame();"}],"scope":"instance","type":"MethodDoc","description":"force the current animation frame index.
","params":[{"identifier":"index","optional":true,"default":"0","description":"animation frame index
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Sprite","kind":"canonical"},{"value":"Sprite","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"5OWipgKco_rothEjRBDyG","name":"setCurrentAnimation","brief":"","examples":[{"caption":"","code":" // set \"walk\" animation\n this.setCurrentAnimation(\"walk\");\n\n // set \"walk\" animation if it is not the current animation\n if (this.isCurrentAnimation(\"walk\")) {\n this.setCurrentAnimation(\"walk\");\n }\n\n // set \"eat\" animation, and switch to \"walk\" when complete\n this.setCurrentAnimation(\"eat\", \"walk\");\n\n // set \"die\" animation, and remove the object when finished\n this.setCurrentAnimation(\"die\", () => {\n world.removeChild(this);\n return false; // do not reset to first frame\n });\n\n // set \"attack\" animation, and pause for a short duration\n this.setCurrentAnimation(\"die\", () => {\n this.animationpause = true;\n\n // back to \"standing\" animation after 1 second\n setTimeout(function () {\n this.setCurrentAnimation(\"standing\");\n }, 1000);\n\n return false; // do not reset to first frame\n });"}],"scope":"instance","type":"MethodDoc","description":"set the current animation\nthis will always change the animation & set the frame to zero
","params":[{"identifier":"name","optional":false,"description":"animation id
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"resetAnim","optional":true,"description":"animation id to switch to when complete, or callback
","dataType":{"tokens":[{"value":"string | Function","kind":"canonical"}],"template":"string | Function"}},{"identifier":"preserve_dt","optional":true,"default":"false","description":"if false will reset the elapsed time counter since last frame
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Sprite","kind":"canonical"},{"value":"Sprite","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"o9ZqHjVPKXzUGmUXapMEa","name":"setOpacity","brief":"","scope":"instance","type":"MethodDoc","description":"set the renderable alpha channel value
","params":[{"identifier":"alpha","optional":false,"description":"opacity value between 0.0 and 1.0
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"HbztqdU-lqiQU-IN4Uo6N","name":"setRegion","brief":"","examples":[{"caption":"","code":"// change the sprite to \"shadedDark13.png\";\nmySprite.setRegion(mytexture.getRegion(\"shadedDark13.png\"));"}],"scope":"instance","see":["Texture.getRegion"],"type":"MethodDoc","description":"change the current texture atlas region for this sprite
","params":[{"identifier":"region","optional":false,"description":"typically returned through me.Texture.getRegion()
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Sprite","kind":"canonical"},{"value":"Sprite","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"LHIlNKPQajkU6rxGMn5JC","name":"setShape","brief":"","scope":"instance","type":"MethodDoc","description":"set new value to the rectangle shape
","params":[{"identifier":"x","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"w","optional":false,"description":"width of the rectangle, or an array of vector defining the rectangle
","dataType":{"tokens":[{"value":"number | Array","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %3<%2>"}},{"identifier":"h","optional":true,"description":"height of the rectangle, if a numeral width parameter is specified
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"zzfULi-sEfHnXRLbWDtGu","name":"setVertices","brief":"","scope":"instance","type":"MethodDoc","description":"set the vertices defining this Polygon
","params":[{"identifier":"vertices","optional":false,"description":"array of vector or vertice defining the Polygon
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1<%2>"}}],"returns":[{"description":"this instance for objecf chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"x6OYCC-5_wE0_gB2SkVqO","name":"shift","brief":"","examples":[{"caption":"","code":"polygon.shift(10, 10);\n// or\npolygon.shift(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"Shifts the Polygon to the given position vector.
","params":[{"identifier":"x","description":"x coordinate or a vector point to shift to
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"WRekmaLZQ64BjXbZGoUm1","name":"to2d","brief":"","scope":"instance","type":"MethodDoc","description":"apply a 2d projection to this shapen
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"qP95gwdiUPP4LoFUcFMtZ","name":"toIso","brief":"","scope":"instance","type":"MethodDoc","description":"apply an isometric projection to this shape
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"13IFn_xapbe9nM7nS2A_P","name":"toPolygon","brief":"","scope":"instance","type":"MethodDoc","description":"Returns a polygon whose edges are the same as this box.
","params":[],"returns":[{"description":"a new Polygon that represents this rectangle.
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"LI5lRQhMc0B_rbscI6fG8","name":"transform","brief":"","scope":"instance","see":["Renderable#currentTransform"],"type":"MethodDoc","description":"multiply the renderable currentTransform with the given matrix
","params":[{"identifier":"m","optional":false,"description":"the transformation matrix
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"l09rNoMoVdQ4wc3u7oV-t","name":"translate","brief":"","examples":[{"caption":"","code":"polygon.translate(10, 10);\n// or\npolygon.translate(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"translate the Polygon by the specified offset
","params":[{"identifier":"x","description":"x offset or a vector point to translate by
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"description":"y offset
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"dVOVwwrXTi6Sv0Lv6hfF0","name":"union","brief":"","scope":"instance","type":"MethodDoc","description":"merge this rectangle with another one
","params":[{"identifier":"rect","optional":false,"description":"other rectangle to union with
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"the union(ed) rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"oZnUgiA7dkcGzwWZFuzdy","name":"updateBounds","brief":"","scope":"instance","type":"MethodDoc","description":"update the bounding box for this shape.
","params":[{"identifier":"absolute","optional":true,"default":"true","description":"update the bounds size and position in (world) absolute coordinates
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"this shape bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Y5CoJKQR7FObAw_pllb9j","name":"draw","brief":"","access":"protected","scope":"instance","type":"MethodDoc","description":"draw this ImageLayer (automatically called by melonJS)
","params":[{"identifier":"renderer","optional":false,"description":"a renderer instance
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}},{"identifier":"viewport","optional":true,"description":"the viewport to (re)draw
","dataType":{"tokens":[{"value":"Camera2d","kind":"canonical"},{"value":"Camera2d","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"Ix4R3tqLxjVkvUo3o5O9N","name":"update","brief":"","access":"protected","scope":"instance","type":"MethodDoc","description":"update function.
","params":[{"identifier":"dt","optional":false,"description":"time since the last update in milliseconds.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"true if the Sprite is dirty
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"dAGgJ5Tj28fQRaGuLESzg","name":"onAnchorUpdate","brief":"","access":"private","scope":"instance","type":"MethodDoc","description":"called when the anchor point value is changed
","params":[{"identifier":"x","optional":false,"description":"the new X value to be set for the anchor
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the new Y value to be set for the anchor
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]}]},{"id":"8R40b2yYCRuW6qksf9_S4","name":"Light2d","brief":"","see":["stage.lights"],"type":"ClassDoc","description":"A 2D point light.\nNote: this is a very experimental and work in progress feature, that provides a simple spot light effect...","params":[],"returns":[],"extends":["Renderable"],"implements":[],"members":[{"id":"3zNCEGI-Sr8C2FWf3hefC","name":"alpha","brief":"","defaultValue":"1.0","scope":"instance","see":["Renderable#setOpacity","Renderable#getOpacity"],"type":"PropertyDoc","description":"
Define the renderable opacity
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"4N4oda5NZ7d7WZTlWgayd","name":"alwaysUpdate","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object will always update, even when outside of the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"B4DV_6cS7qxHVXrJIULEm","name":"ancestor","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"a reference to the parent object that contains this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"SGm1V8hd96tVCl5x8A6Qw","name":"anchorPoint","brief":"","defaultValue":"<0.5,0.5>","scope":"instance","type":"PropertyDoc","description":"The anchor point is used for attachment behavior, and/or when applying transformations.
When enabled, an object container will automatically apply\nany defined transformation before calling the child draw method...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"-iQceN5zoMgFOjD8BtgDa","name":"blendMode","brief":"","defaultValue":"\"lighter\"","scope":"instance","see":["CanvasRenderer#setBlendMode","WebGLRenderer#setBlendMode"],"type":"PropertyDoc","description":"
the default blend mode to be applied when rendering this light
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"U19wGwrEjjObS8nyI9Y5l","name":"body","brief":"","examples":[{"caption":"","code":" // define a new Player Class\n class PlayerEntity extends me.Sprite {\n // constructor\n constructor(x, y, settings) {\n // call the parent constructor\n super(x, y , settings);\n\n // define a basic walking animation\n this.addAnimation(\"walk\", [...]);\n // define a standing animation (using the first frame)\n this.addAnimation(\"stand\", [...]);\n // set the standing animation as default\n this.setCurrentAnimation(\"stand\");\n\n // add a physic body\n this.body = new me.Body(this);\n // add a default collision shape\n this.body.addShape(new me.Rect(0, 0, this.width, this.height));\n // configure max speed, friction, and initial force to be applied\n this.body.setMaxVelocity(3, 15);\n this.body.setFriction(0.4, 0);\n this.body.force.set(3, 0);\n this.isKinematic = false;\n\n // set the display to follow our position on both axis\n me.game.viewport.follow(this.pos, me.game.viewport.AXIS.BOTH);\n }\n\n ...\n\n }"}],"scope":"instance","type":"PropertyDoc","description":"the renderable physic body
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"uf4CsKvZYi-Mq1pxehKM2","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"le7BbPXSzCR925Cnii0MQ","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"d3H7wKh235Ay_lIXQ-1To","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"jaxEdRzzJcGSRgghuHsvZ","name":"color","brief":"","defaultValue":"\"#FFF\"","scope":"instance","type":"PropertyDoc","description":"the color of the light
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"EHDo-HTm_J6TjZJwzbaAz","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"e71JCelbushMEXT3I2YAf","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"9mrn2REjAeJd3lg-1ojh4","name":"floating","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"If true, this renderable will be rendered using screen coordinates,\nas opposed to world coordinates. Use this, for example...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"d_XjhzoTF7Fe_oQmoa76U","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"
(G)ame (U)nique (Id)entifier"
height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"UrLSQOfhAryfeOKu0UV6N","name":"intensity","brief":"","defaultValue":"0.7","scope":"instance","type":"PropertyDoc","description":"The intensity of the light
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"3CufCZLkiwiwiO-8iSbBZ","name":"inViewport","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object is visible and within the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"4VS-cGA2-X9D4niK7fZJy","name":"isDirty","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"when true the renderable will be redrawn during the next update cycle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"yhHrgYzvHZicBay_V1xoM","name":"isFlippedX","brief":"","access":"public","scope":"instance","see":["Renderable#flipX"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"glJZvlKyNBZZy-9zaSUbd","name":"isFlippedY","brief":"","access":"public","scope":"instance","see":["Renderable#flipY"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"KiHbO0BiwxHv8lyQozc0a","name":"isFloating","brief":"","scope":"instance","see":["Renderable#floating"],"type":"PropertyDoc","description":"Whether the renderable object is floating (i.e. used screen coordinates), or contained in a floating parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"RcJYlWisWn1MDGn9S2N4u","name":"isKinematic","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"If true then physic collision and input events will not impact this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"RRLHY1QOij9G09AQnLO4t","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"zrad3n8MHtS3fVOQl47b7","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"rUqLkdhd7_I-NH_hlFzj0","name":"mask","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"// apply a mask in the shape of a Star\nmyNPCSprite.mask = new me.Polygon(myNPCSprite.width / 2, 0, [\n // draw a star\n {x: 0, y: 0},\n {x: 14, y: 30},\n {x: 47, y: 35},\n {x: 23, y: 57},\n {x: 44, y: 90},\n {x: 0, y: 62},\n {x: -44, y: 90},\n {x: -23, y: 57},\n {x: -47, y: 35},\n {x: -14, y: 30}\n]);"}],"scope":"instance","type":"PropertyDoc","description":"A mask limits rendering elements to the shape and position of the given mask object.\nSo, if the renderable is larger than ...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"IXSvQcoETUTLfn7FWvP30","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"1-KFxgHutySda7TbXiiXD","name":"onVisibilityChange","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"this.onVisibilityChange = function(inViewport) {\n if (inViewport === true) {\n console.log(\"object has entered the in a camera viewport!\");\n }\n};"}],"scope":"instance","type":"PropertyDoc","description":"an event handler that is called when the renderable leave or enter a camera viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"aId7Zj-JNvhlftcEa_PqN","name":"parentApp","brief":"","scope":"instance","type":"PropertyDoc","description":"returns the parent application (or game) to which this renderable is attached to
","params":[],"returns":[{"description":"the parent application or undefined if not attached to any container/app
","dataType":{"tokens":[{"value":"Application","kind":"canonical"},{"value":"Application","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"tVrVek1ZjkZrAHTCvurjq","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"joEfMDKjdTOEsh7P__9lF","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"gfV9ADZlGE0xsPuz2MfaC","name":"radiusX","brief":"","scope":"instance","type":"PropertyDoc","description":"The horizontal radius of the light
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"7FX0YRnoi8XyN2n38ZWN2","name":"radiusY","brief":"","scope":"instance","type":"PropertyDoc","description":"The vertical radius of the light
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"3ucTmm6DIcdtKwmlhDCtp","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"oxz3qlXAJrkDxsBNjsNYV","name":"shader","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"(Experimental) an optional shader, to be used instead of the default built-in one, when drawing this renderable (WebGL onl...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"SbPRZ-riGGTMxu2qepW3h","name":"tint","brief":"","defaultValue":"(255, 255, 255)","examples":[{"caption":"","code":"// add a red tint to this renderable\nthis.tint.setColor(255, 128, 128);\n// remove the tint\nthis.tint.setColor(255, 255, 255);"}],"scope":"instance","type":"PropertyDoc","description":"
define a tint for this renderable. a (255, 255, 255) r, g, b value will remove the tint effect.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"820-udXek9HYKG4cf_eiW","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"RJ0_ug2-O4finBlw7i9lm","name":"type","brief":"","defaultValue":"\"Rectangle\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"7MMTE8GT1TZFhIRGyi08x","name":"updateWhenPaused","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether to update this object when the game is paused.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"gtQgNiszi8CTHi3aELcBH","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"O4PRz4cH-7ir8Vo_hwT8Q","name":"angleTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the angle to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"angle in radians
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"RIw_-TUtWsxg50CQ4zMhN","name":"centerOn","brief":"","scope":"instance","type":"MethodDoc","description":"center the rectangle position around the given coordinates
","params":[{"identifier":"x","optional":false,"description":"the x coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"wW1fTotwnapuHDqelg8j1","name":"clone","brief":"","scope":"instance","type":"MethodDoc","description":"clone this rectangle
","params":[],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"2KpHOMUUszFqKqyh1eAnH","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"x","optional":false,"description":"The horizontal position of the light.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"The vertical position of the light.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"radiusX","optional":false,"description":"The horizontal radius of the light.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"radiusY","optional":true,"default":"radiusX","description":"The vertical radius of the light.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"color","optional":true,"default":"\"#FFF\"","description":"the color of the light
","dataType":{"tokens":[{"value":"Color | string","kind":"canonical"},{"value":"Color","kind":"link"}],"template":"%1 | string"}},{"identifier":"intensity","optional":true,"default":"0.7","description":"The intensity of the light.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"CJMd0bas2uElGIazF2UdT","name":"contains","brief":"","examples":[{"caption":"","code":"if (rect.contains(10, 10)) {\n // do something\n}\n// or\nif (rect.contains(myVector2d)) {\n // do something\n}\nif (rect.contains(myRect)) {\n // do something\n}"}],"scope":"instance","type":"MethodDoc","description":"Returns true if the rectangle contains the given point or rectangle
","params":[{"identifier":"x","description":"x coordinate or a vector point, or a rectangle to test
","dataType":{"tokens":[{"value":"number | Vector2d | Rect","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Rect","kind":"link"}],"template":"%1 | %2 | %3"}},{"identifier":"y","optional":true,"description":"y coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"True if the rectangle contain the given point or rectangle, otherwise false
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"5biGhn7U56LTfGT16RdsP","name":"copy","brief":"","scope":"instance","type":"MethodDoc","description":"copy the position and size of the given rectangle into this one
","params":[{"identifier":"rect","optional":false,"description":"Source rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"zuFm1bPgk_1zFY4DK7Vu-","name":"distanceTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the distance to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"distance
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"NXvVHgg1b2NSQiShgW_Qg","name":"equals","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is identical to the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if equals
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"os3Uj5VXfHKBOhpk5u49i","name":"flipX","brief":"","scope":"instance","see":["Matrix2d#scaleX"],"type":"MethodDoc","description":"flip the renderable on the horizontal axis (around the center of the renderable)
","params":[{"identifier":"flip","optional":true,"default":"true","description":"true to flip this renderable.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"blvQ9lZvCuJueDo4yH7O5","name":"flipY","brief":"","scope":"instance","see":["Matrix2d#scaleY"],"type":"MethodDoc","description":"flip the renderable on the vertical axis (around the center of the renderable)
","params":[{"identifier":"flip","optional":true,"default":"true","description":"true to flip this renderable.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"RHfMe79kmAlByrD_uxwoq","name":"getAbsolutePosition","brief":"","scope":"instance","type":"MethodDoc","description":"return the renderable absolute position in the game world
","params":[],"returns":[{"dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"HXyMkZAEn509jDA0DJ03y","name":"getBounds","brief":"","scope":"instance","type":"MethodDoc","description":"returns the bounding box for this renderable
","params":[],"returns":[{"description":"bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"-C0gyD_p1RRMH8jx5ln_L","name":"getIndices","brief":"","scope":"instance","type":"MethodDoc","description":"returns a list of indices for all triangles defined in this polygon
","params":[],"returns":[{"description":"an array of vertex indices for all triangles forming this polygon.
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1<%2>"}}],"extends":[],"implements":[]},{"id":"2EpVgNRChfC2u97FpRKYi","name":"getOpacity","brief":"","scope":"instance","type":"MethodDoc","description":"get the renderable alpha channel value
","params":[],"returns":[{"description":"current opacity value between 0 and 1
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"aXRxKpPxP7fz5orP1ZUsg","name":"getVisibleArea","brief":"","scope":"instance","type":"MethodDoc","description":"returns a geometry representing the visible area of this light
","params":[],"returns":[{"description":"the light visible mask
","dataType":{"tokens":[{"value":"Ellipse","kind":"canonical"},{"value":"Ellipse","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"O8GVvuPlc1qOvMP0IEwQE","name":"isConvex","brief":"","scope":"instance","type":"MethodDoc","description":"Returns true if the vertices composing this polygon form a convex shape (vertices must be in clockwise order).
","params":[],"returns":[{"description":"true if the vertices are convex, false if not, null if not computable
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"jScPLCAE6O4JYaC7QMq3t","name":"isFinite","brief":"","scope":"instance","type":"MethodDoc","description":"determines whether all coordinates of this rectangle are finite numbers.
","params":[],"returns":[{"description":"false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"aYDQyVUXUQuSxICia71Ov","name":"lookAt","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this renderable towards the given target.
","params":[{"identifier":"target","optional":false,"description":"the renderable or position to look at
","dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"wHL1dPR2ZP_Es--2XjIx4","name":"onCollision","brief":"","examples":[{"caption":"","code":"// colision handler\nonCollision(response) {\n if (response.b.body.collisionType === me.collision.types.ENEMY_OBJECT) {\n // makes the other object solid, by substracting the overlap vector to the current position\n this.pos.sub(response.overlapV);\n this.hurt();\n // not solid\n return false;\n }\n // Make the object solid\n return true;\n},"}],"scope":"instance","type":"MethodDoc","description":"onCollision callback, triggered in case of collision,\nwhen this renderable body is colliding with another one
","params":[{"identifier":"response","optional":false,"description":"the collision response object
","dataType":{"tokens":[{"value":"ResponseObject","kind":"canonical"},{"value":"ResponseObject","kind":"link"}],"template":"%1"}},{"identifier":"other","optional":false,"description":"the other renderable touching this one (a reference to response.a or response.b)
","dataType":{"tokens":[{"value":"Renderable | Container | Entity | Sprite | NineSliceSprite","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Container","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"NineSliceSprite","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5"}}],"returns":[{"description":"true if the object should respond to the collision (its position and velocity will be corrected)
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"M0R-tfcQT6wBkIwfwones","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"OnDestroy Notification function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"k2KapbvjmX4skzS_bfF6t","name":"overlaps","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is intersecting with the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if overlaps
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"JkPWr9Ds-B-C-8rIzJdm_","name":"postDraw","brief":"","scope":"instance","see":["Renderable#preDraw","Renderable#draw"],"type":"MethodDoc","description":"restore the rendering context after drawing (automatically called by melonJS).
","params":[{"identifier":"renderer","optional":false,"description":"a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"LaZuxgdjjwP1ys6F9g8HR","name":"preDraw","brief":"","scope":"instance","see":["Renderable#draw","Renderable#postDraw"],"type":"MethodDoc","description":"Prepare the rendering context before drawing (automatically called by melonJS).\nThis will apply any defined transforms, an...","params":[{"identifier":"renderer","optional":false,"description":"
a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"aB2-YeU6lfWpetI8oGxaf","name":"recalc","brief":"","scope":"instance","type":"MethodDoc","description":"Computes the calculated collision polygon.\nThis must be called if the points array, an...","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Hc5TcM779V-KEoXHbL5Ux","name":"resize","brief":"","scope":"instance","type":"MethodDoc","description":"resize the rectangle
","params":[{"identifier":"w","optional":false,"description":"new width of the rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"h","optional":false,"description":"new height of the rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"5GAFetuuMgTl0KvnS6ARm","name":"rotate","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this renderable by the specified angle (in radians).
","params":[{"identifier":"angle","optional":false,"description":"The angle to rotate (in radians)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":true,"description":"an optional point to rotate around
","dataType":{"tokens":[{"value":"Vector2d | ObservableVector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"hpAWW0xDdOpewUfKml8kn","name":"scale","brief":"","scope":"instance","type":"MethodDoc","description":"scale the renderable around his anchor point. Scaling actually applies changes\nto the currentTransform member wich is use...","params":[{"identifier":"x","optional":false,"description":"
a number representing the abscissa of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":true,"default":"x","description":"a number representing the ordinate of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"hkUzJJNelksO1B_mWX2rL","name":"scaleV","brief":"","scope":"instance","type":"MethodDoc","description":"scale the renderable around his anchor point
","params":[{"identifier":"v","optional":false,"description":"scaling vector
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"1bnLNgeMMoFV_H5EONaWh","name":"setOpacity","brief":"","scope":"instance","type":"MethodDoc","description":"set the renderable alpha channel value
","params":[{"identifier":"alpha","optional":false,"description":"opacity value between 0.0 and 1.0
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"G41SuwecABH7eKRv4HVzg","name":"setShape","brief":"","scope":"instance","type":"MethodDoc","description":"set new value to the rectangle shape
","params":[{"identifier":"x","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"w","optional":false,"description":"width of the rectangle, or an array of vector defining the rectangle
","dataType":{"tokens":[{"value":"number | Array","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %3<%2>"}},{"identifier":"h","optional":true,"description":"height of the rectangle, if a numeral width parameter is specified
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"T3kfNT9MWu3m0iOPCEJau","name":"setVertices","brief":"","scope":"instance","type":"MethodDoc","description":"set the vertices defining this Polygon
","params":[{"identifier":"vertices","optional":false,"description":"array of vector or vertice defining the Polygon
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1<%2>"}}],"returns":[{"description":"this instance for objecf chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"EdNYa4aLzQFKOaynR4GSR","name":"shift","brief":"","examples":[{"caption":"","code":"polygon.shift(10, 10);\n// or\npolygon.shift(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"Shifts the Polygon to the given position vector.
","params":[{"identifier":"x","description":"x coordinate or a vector point to shift to
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"NzXOlrUKmMtLJlFa4SiBD","name":"to2d","brief":"","scope":"instance","type":"MethodDoc","description":"apply a 2d projection to this shapen
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"th8xm7IeaLyUxrzGaXVEd","name":"toIso","brief":"","scope":"instance","type":"MethodDoc","description":"apply an isometric projection to this shape
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"sm6FxKP8an9MBwa_qK0BV","name":"toPolygon","brief":"","scope":"instance","type":"MethodDoc","description":"Returns a polygon whose edges are the same as this box.
","params":[],"returns":[{"description":"a new Polygon that represents this rectangle.
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"x0E_rV5oCM8pcf7dGqQGG","name":"transform","brief":"","scope":"instance","see":["Renderable#currentTransform"],"type":"MethodDoc","description":"multiply the renderable currentTransform with the given matrix
","params":[{"identifier":"m","optional":false,"description":"the transformation matrix
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"hmgXiMoZL1b10m61JF4MK","name":"translate","brief":"","examples":[{"caption":"","code":"polygon.translate(10, 10);\n// or\npolygon.translate(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"translate the Polygon by the specified offset
","params":[{"identifier":"x","description":"x offset or a vector point to translate by
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"description":"y offset
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"u6t-yg731a_SWHJdNgrT2","name":"union","brief":"","scope":"instance","type":"MethodDoc","description":"merge this rectangle with another one
","params":[{"identifier":"rect","optional":false,"description":"other rectangle to union with
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"the union(ed) rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Aa50DFCGQtnuvhOxr3NTf","name":"update","brief":"","scope":"instance","type":"MethodDoc","description":"update function
","params":[{"identifier":"dt","optional":false,"description":"time since the last update in milliseconds.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"true if dirty
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"3o47XXDkOj_xGuFTYrXnK","name":"updateBounds","brief":"","scope":"instance","type":"MethodDoc","description":"update the bounding box for this shape.
","params":[{"identifier":"absolute","optional":true,"default":"true","description":"update the bounds size and position in (world) absolute coordinates
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"this shape bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"u3ndLgXCXkZbilpULam1s","name":"draw","brief":"","access":"protected","scope":"instance","type":"MethodDoc","description":"draw this Light2d (automatically called by melonJS)
","params":[{"identifier":"renderer","optional":false,"description":"a renderer instance
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}},{"identifier":"viewport","optional":true,"description":"the viewport to (re)draw
","dataType":{"tokens":[{"value":"Camera2d","kind":"canonical"},{"value":"Camera2d","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"pipONLeuhQe5vBWZvbwZJ","name":"onAnchorUpdate","brief":"","access":"private","scope":"instance","type":"MethodDoc","description":"called when the anchor point value is changed
","params":[{"identifier":"x","optional":false,"description":"the new X value to be set for the anchor
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the new Y value to be set for the anchor
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]}]},{"id":"xrOYWaNI5-CU79jcWY0MC","name":"Line","type":"ClassDoc","description":"a line segment Object
","params":[{"identifier":"x","description":"origin point of the Line
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","description":"origin point of the Line
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"points","description":"array of vectors defining the Line
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1<%2>"}}],"returns":[],"extends":["Polygon"],"implements":[],"members":[{"id":"GXUzgCPWr5aKsIcZbI0MA","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"XBvGWJ7x1bs9S852rAqxt","name":"pos","brief":"","scope":"instance","type":"PropertyDoc","description":"
origin point of the Polygon
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"UuTBi0GJMrx9rqWjg4MiI","name":"type","brief":"","defaultValue":"\"Polygon\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"JcfFgl0VIEgU3-8-Fp-Lr","name":"clone","brief":"","scope":"instance","type":"MethodDoc","description":"clone this line segment
","params":[],"returns":[{"description":"new Line
","dataType":{"tokens":[{"value":"Line","kind":"canonical"},{"value":"Line","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"mA5YVQ4sD-Pvxf-4f9l8Z","name":"constructor","brief":"","access":"public","scope":"instance","type":"MethodDoc","params":[{"identifier":"x","description":"origin point of the Line
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","description":"origin point of the Line
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"points","description":"array of vectors defining the Line
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1<%2>"}}],"returns":[]},{"id":"xfMdEAbYVJh2R_Owu9WKi","name":"contains","brief":"","examples":[{"caption":"","code":"if (line.contains(10, 10)) {\n // do something\n}\n// or\nif (line.contains(myVector2d)) {\n // do something\n}"}],"scope":"instance","type":"MethodDoc","description":"Returns true if the Line contains the given point
","params":[{"identifier":"x","description":"x coordinate or a vector point to check
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"description":"y coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"true if contains
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"3j_qc-CFdwwLyqQ9maswJ","name":"getBounds","brief":"","scope":"instance","type":"MethodDoc","description":"returns the bounding box for this shape, the smallest Rectangle object completely containing this shape.
","params":[],"returns":[{"description":"this shape bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"g-iayfg4DhiQFfWSEYsCd","name":"getIndices","brief":"","scope":"instance","type":"MethodDoc","description":"returns a list of indices for all triangles defined in this polygon
","params":[],"returns":[{"description":"an array of vertex indices for all triangles forming this polygon.
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1<%2>"}}],"extends":[],"implements":[]},{"id":"E-xbx2Umh6WSK23jx4LRc","name":"isConvex","brief":"","scope":"instance","type":"MethodDoc","description":"Returns true if the vertices composing this polygon form a convex shape (vertices must be in clockwise order).
","params":[],"returns":[{"description":"true if the vertices are convex, false if not, null if not computable
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"7hwvpp_LLB30acZOeggP_","name":"recalc","brief":"","scope":"instance","type":"MethodDoc","description":"Computes the calculated collision edges and normals.\nThis must be called if the points array...","params":[],"returns":[{"description":"
this instance for objecf chaining
","dataType":{"tokens":[{"value":"Line","kind":"canonical"},{"value":"Line","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"TA5dRZCDVs2msZ5Yz6iL3","name":"rotate","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this Polygon (counter-clockwise) by the specified angle (in radians).
","params":[{"identifier":"angle","optional":false,"description":"The angle to rotate (in radians)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":true,"description":"an optional point to rotate around
","dataType":{"tokens":[{"value":"Vector2d | ObservableVector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"nH-ykLTVYH3t3jLcDU5rg","name":"scale","brief":"","scope":"instance","type":"MethodDoc","description":"Scale this Polygon by the given scalar.
","params":[{"identifier":"x","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":true,"default":"x","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"SGfo_bDt3sj7nYDmuMJ0Y","name":"scaleV","brief":"","scope":"instance","type":"MethodDoc","description":"Scale this Polygon by the given vector
","params":[{"identifier":"v","optional":false,"dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"qsRamsXmujL_PZwbEIc5j","name":"setShape","brief":"","scope":"instance","type":"MethodDoc","description":"set new value to the Polygon
","params":[{"identifier":"x","optional":false,"description":"position of the Polygon
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"position of the Polygon
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"points","optional":false,"description":"array of vector or vertice defining the Polygon
","dataType":{"tokens":[{"value":"Array | Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Array","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1<%2> | %3<%4>"}}],"returns":[{"description":"this instance for objecf chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"chbr6MVN-bl80JAPJ6ji4","name":"setVertices","brief":"","scope":"instance","type":"MethodDoc","description":"set the vertices defining this Polygon
","params":[{"identifier":"vertices","optional":false,"description":"array of vector or vertice defining the Polygon
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1<%2>"}}],"returns":[{"description":"this instance for objecf chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"xRFSXMyXVkF213kQIpFRn","name":"shift","brief":"","examples":[{"caption":"","code":"polygon.shift(10, 10);\n// or\npolygon.shift(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"Shifts the Polygon to the given position vector.
","params":[{"identifier":"x","description":"x coordinate or a vector point to shift to
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"JxjYQ1E1X6rfrb-z3BUyC","name":"to2d","brief":"","scope":"instance","type":"MethodDoc","description":"apply a 2d projection to this shapen
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"lGYyBeKGBTQ4T88nGSRN8","name":"toIso","brief":"","scope":"instance","type":"MethodDoc","description":"apply an isometric projection to this shape
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"UNfHBqIQF_oYwxfDMl4Zg","name":"transform","brief":"","scope":"instance","type":"MethodDoc","description":"apply the given transformation matrix to this Polygon
","params":[{"identifier":"m","optional":false,"description":"the transformation matrix
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"B3D4CSg1Vpiewk3zbag7y","name":"translate","brief":"","examples":[{"caption":"","code":"polygon.translate(10, 10);\n// or\npolygon.translate(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"translate the Polygon by the specified offset
","params":[{"identifier":"x","description":"x offset or a vector point to translate by
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"description":"y offset
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"XeVkJHNu6ZUWw-o3MNjye","name":"updateBounds","brief":"","scope":"instance","type":"MethodDoc","description":"update the bounding box for this shape.
","params":[],"returns":[{"description":"this shape bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]}]},{"id":"6j_iitSu4J9lgkUbE00vs","name":"Matrix2d","brief":"","type":"ClassDoc","description":"a Matrix2d Object.
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"2HIBrrAu5cPuD9re7QFBy","name":"tx","brief":"","scope":"instance","see":["Matrix2d.translate"],"type":"PropertyDoc","description":"tx component of the matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"AYzgmJNKom4PvmT_MKaTy","name":"ty","brief":"","scope":"instance","see":["Matrix2d.translate"],"type":"PropertyDoc","description":"ty component of the matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"cDguGF1NhP12XCsmYfV9r","name":"apply","brief":"","scope":"instance","type":"MethodDoc","description":"apply the current transform to the given 2d or 3d vector
","params":[{"identifier":"v","optional":false,"description":"the vector object to be transformed
","dataType":{"tokens":[{"value":"Vector2d | Vector3d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"result vector object.
","dataType":{"tokens":[{"value":"Vector2d | Vector3d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2"}}],"extends":[],"implements":[]},{"id":"ITaZzrAQ3Gw8GtUA0_hEE","name":"applyInverse","brief":"","scope":"instance","type":"MethodDoc","description":"apply the inverted current transform to the given 2d vector
","params":[{"identifier":"v","optional":false,"description":"the vector object to be transformed
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"result vector object.
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"0vqILeXxD6ju2yMRoLX6-","name":"clone","brief":"","scope":"instance","type":"MethodDoc","description":"Clone the Matrix
","params":[],"returns":[{"dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"u3eUbSp4dvX_1lSgNFCzB","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"args","optional":false,"variadic":true,"description":"an instance of me.Matrix2d or me.Matrix3d to copy from, or individual matrix components (See {@link Matrix2d.setTransform}...","dataType":{"tokens":[{"value":"Matrix2d | Matrix3d | number","kind":"canonical"},{"value":"Matrix2d","kind":"link"},{"value":"Matrix3d","kind":"link"},{"value":"number","kind":"canonical"}],"template":"%1 | %2 | %3"}}],"returns":[],"extends":[],"implements":[]},{"id":"sA9AiBwzYsINR9VDPP14N","name":"copy","brief":"","scope":"instance","type":"MethodDoc","description":"
Copies over the values from another me.Matrix2d.
","params":[{"identifier":"m","optional":false,"description":"the matrix object to copy from
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"tzKV7jn2JBbKClK-s6fHF","name":"equals","brief":"","scope":"instance","type":"MethodDoc","description":"return true if the two matrices are identical
","params":[{"identifier":"m","optional":false,"description":"the other matrix
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if both are equals
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"cY--p6arLai1deRElqKNO","name":"fromMat3d","brief":"","scope":"instance","type":"MethodDoc","description":"Copies over the upper-left 3x3 values from the given me.Matrix3d
","params":[{"identifier":"m","optional":false,"description":"the matrix object to copy from
","dataType":{"tokens":[{"value":"Matrix3d","kind":"canonical"},{"value":"Matrix3d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Z1HU2Wbj8pjBovPeoMRo1","name":"identity","brief":"","scope":"instance","type":"MethodDoc","description":"reset the transformation matrix to the identity matrix (no transformation).
Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"gP6CPBQECv0gGDUQSy8-p","name":"invert","brief":"","scope":"instance","type":"MethodDoc","description":"invert this matrix, causing it to apply the opposite transformation.
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"5j5CYbuiX-lne3YdDUPVF","name":"isIdentity","brief":"","scope":"instance","type":"MethodDoc","description":"returns true if the matrix is an identity matrix.
","params":[],"returns":[{"dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"8Z4SWcOl802oS89gjXubg","name":"multiply","brief":"","scope":"instance","type":"MethodDoc","description":"multiply both matrix
","params":[{"identifier":"m","optional":false,"description":"the other matrix
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"xXNJff8XF9x_10foCzbF8","name":"rotate","brief":"","scope":"instance","type":"MethodDoc","description":"rotate the matrix (counter-clockwise) by the specified angle (in radians).
","params":[{"identifier":"angle","optional":false,"description":"Rotation angle in radians.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"jl6XRZzl-3PGWyAhEyzGK","name":"scale","brief":"","scope":"instance","type":"MethodDoc","description":"scale the matrix
","params":[{"identifier":"x","optional":false,"description":"a number representing the abscissa of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":true,"default":"x","description":"a number representing the ordinate of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"d70qLRWbuCs-qrwe1MMZB","name":"scaleV","brief":"","scope":"instance","type":"MethodDoc","description":"adds a 2D scaling transformation.
","params":[{"identifier":"v","optional":false,"description":"scaling vector
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"cdl7Rym3BrdaQ179sdkxs","name":"scaleX","brief":"","scope":"instance","type":"MethodDoc","description":"specifies a 2D scale operation using the [sx, 1] scaling vector
","params":[{"identifier":"x","optional":false,"description":"x scaling vector
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"oub-fjyxlZWctCkLtmjYu","name":"scaleY","brief":"","scope":"instance","type":"MethodDoc","description":"specifies a 2D scale operation using the [1,sy] scaling vector
","params":[{"identifier":"y","optional":false,"description":"y scaling vector
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"dCI0DQBV_Ax4XDDP9-Rf1","name":"setTransform","brief":"","scope":"instance","type":"MethodDoc","description":"set the matrix to the specified value
","params":[{"identifier":"a","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"b","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"c","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"d","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"e","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"f","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"g","optional":true,"default":"0","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"h","optional":true,"default":"0","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"i","optional":true,"default":"1","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"0Sc3AgbNZd3Bw6CyyI7uw","name":"toArray","brief":"","scope":"instance","type":"MethodDoc","description":"return an array representation of this Matrix
","params":[],"returns":[{"dataType":{"tokens":[{"value":"Float32Array","kind":"canonical"},{"value":"Float32Array","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"ZPlQQlMYlWmoYIx24C6Da","name":"toString","brief":"","scope":"instance","type":"MethodDoc","description":"convert the object to a string representation
","params":[],"returns":[{"dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"extends":[],"implements":[]},{"id":"xFwvAGOjFCGu3i-dJkjp6","name":"transform","brief":"","scope":"instance","type":"MethodDoc","description":"Multiplies the current transformation with the matrix described by the arguments of this method
","params":[{"identifier":"a","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"b","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"c","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"d","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"e","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"f","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"itiRwwA_iGFuhoaNOI1fX","name":"translate","brief":"","scope":"instance","type":"MethodDoc","description":"translate the matrix position on the horizontal and vertical axis
","params":[{"identifier":"x","description":"the x coordindates or a vector to translate the matrix by
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"description":"the y coordindates to translate the matrix by
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"z5ynIDXlN5Dof-Ey-zCIO","name":"transpose","brief":"","scope":"instance","type":"MethodDoc","description":"Transpose the value of this matrix.
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]}]},{"id":"VNe6Nu3ajpnmbn3uyII2d","name":"Matrix3d","brief":"","type":"ClassDoc","description":"a 4x4 Matrix3d Object
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"6f988eqCB7MNsCW9YaGc4","name":"tx","brief":"","scope":"instance","type":"PropertyDoc","description":"tx component of the matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"kqrwV5jufPFFFOQa-8L0W","name":"ty","brief":"","scope":"instance","type":"PropertyDoc","description":"ty component of the matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"4hCrl3m-HJ9_znUvPohOP","name":"tz","brief":"","scope":"instance","type":"PropertyDoc","description":"ty component of the matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ndEeV96mt0n80W1loqETL","name":"apply","brief":"","scope":"instance","type":"MethodDoc","description":"apply the current transform to the given 2d or 3d vector
","params":[{"identifier":"v","optional":false,"description":"the vector object to be transformed
","dataType":{"tokens":[{"value":"Vector2d | Vector3d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"result vector object.
","dataType":{"tokens":[{"value":"Vector2d | Vector3d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2"}}],"extends":[],"implements":[]},{"id":"tklsSaIOZCMZxQs8cODvU","name":"applyInverse","brief":"","scope":"instance","type":"MethodDoc","description":"apply the inverted current transform to the given 2d or 3d vector
","params":[{"identifier":"v","optional":false,"description":"the vector object to be transformed
","dataType":{"tokens":[{"value":"Vector2d | Vector3d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"result vector object.
","dataType":{"tokens":[{"value":"Vector2d | Vector3d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2"}}],"extends":[],"implements":[]},{"id":"L247deqMIalJRL9ewit31","name":"clone","brief":"","scope":"instance","type":"MethodDoc","description":"Clone the Matrix
","params":[],"returns":[{"dataType":{"tokens":[{"value":"Matrix3d","kind":"canonical"},{"value":"Matrix3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"pKrK_k8EsqwLVloQoid1l","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"args","optional":false,"variadic":true,"description":"An instance of me.Matrix3d to copy from, or individual Matrix components (See {@link Matrix3d.setTransform}). If not argum...","dataType":{"tokens":[{"value":"Matrix3d | number","kind":"canonical"},{"value":"Matrix3d","kind":"link"},{"value":"number","kind":"canonical"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"zSXtm0E2VbcTasxTlBcID","name":"copy","brief":"","scope":"instance","type":"MethodDoc","description":"
Copies over the values from another me.Matrix3d.
","params":[{"identifier":"m","optional":false,"description":"the matrix object to copy from
","dataType":{"tokens":[{"value":"Matrix3d","kind":"canonical"},{"value":"Matrix3d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Matrix3d","kind":"canonical"},{"value":"Matrix3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"knVTo_XUyqlRaPxC-ewQv","name":"equals","brief":"","scope":"instance","type":"MethodDoc","description":"return true if the two matrices are identical
","params":[{"identifier":"m","optional":false,"description":"the other matrix
","dataType":{"tokens":[{"value":"Matrix3d","kind":"canonical"},{"value":"Matrix3d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if both are equals
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"L-9yBQMdeG1tWCDZYJSb3","name":"fromMat2d","brief":"","scope":"instance","type":"MethodDoc","description":"Copies over the upper-left 2x2 values from the given me.Matrix2d
","params":[{"identifier":"m","optional":false,"description":"the matrix object to copy from
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"0U0sELdwrcJDq_HIrq1dq","name":"identity","brief":"","scope":"instance","type":"MethodDoc","description":"reset the transformation matrix to the identity matrix (no transformation).
Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Matrix3d","kind":"canonical"},{"value":"Matrix3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"v9JD7Vt8GlZVY9odC5L4J","name":"invert","brief":"","scope":"instance","type":"MethodDoc","description":"invert this matrix, causing it to apply the opposite transformation.
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Matrix3d","kind":"canonical"},{"value":"Matrix3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"NmHuOPmQ2Kebl5NjjHU-v","name":"isIdentity","brief":"","scope":"instance","type":"MethodDoc","description":"returns true if the matrix is an identity matrix.
","params":[],"returns":[{"dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"HjJKdHv4j1eR-ASb9SYjR","name":"multiply","brief":"","scope":"instance","type":"MethodDoc","description":"multiply both matrix
","params":[{"identifier":"m","optional":false,"description":"Other matrix
","dataType":{"tokens":[{"value":"Matrix3d","kind":"canonical"},{"value":"Matrix3d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Matrix3d","kind":"canonical"},{"value":"Matrix3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"eHhu64daRVjCcuM57L7aG","name":"ortho","brief":"","scope":"instance","type":"MethodDoc","description":"generate an orthogonal projection matrix, with the result replacing the current matrix\n
farthest left on the x-axis
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"right","optional":false,"description":"farthest right on the x-axis
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"bottom","optional":false,"description":"farthest down on the y-axis
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"top","optional":false,"description":"farthest up on the y-axis
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"near","optional":false,"description":"distance to the near clipping plane along the -Z axis
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"far","optional":false,"description":"distance to the far clipping plane along the -Z axis
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Matrix3d","kind":"canonical"},{"value":"Matrix3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"pZD5uAuu8TCVOhxL1jKYK","name":"rotate","brief":"","scope":"instance","type":"MethodDoc","description":"rotate this matrix (counter-clockwise) by the specified angle (in radians).
","params":[{"identifier":"angle","optional":false,"description":"Rotation angle in radians.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":false,"description":"the axis to rotate around
","dataType":{"tokens":[{"value":"Vector3d","kind":"canonical"},{"value":"Vector3d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Matrix3d","kind":"canonical"},{"value":"Matrix3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"8DueID40PoAfXl14iSSE9","name":"scale","brief":"","scope":"instance","type":"MethodDoc","description":"scale the matrix
","params":[{"identifier":"x","optional":false,"description":"a number representing the abscissa of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":true,"default":"x","description":"a number representing the ordinate of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"z","optional":true,"default":"0","description":"a number representing the depth vector
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Matrix3d","kind":"canonical"},{"value":"Matrix3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"sg-KHR4EwzPfws2OfPd3z","name":"scaleV","brief":"","scope":"instance","type":"MethodDoc","description":"adds a 2D scaling transformation.
","params":[{"identifier":"v","optional":false,"description":"scaling vector
","dataType":{"tokens":[{"value":"Vector2d | Vector3d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Matrix3d","kind":"canonical"},{"value":"Matrix3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Cvvsux_Uyx7dP9-v0X2l-","name":"scaleX","brief":"","scope":"instance","type":"MethodDoc","description":"specifies a 2D scale operation using the [sx, 1] scaling vector
","params":[{"identifier":"x","optional":false,"description":"x scaling vector
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Matrix3d","kind":"canonical"},{"value":"Matrix3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"lCpnaU-qSqpVVqAn89V8J","name":"scaleY","brief":"","scope":"instance","type":"MethodDoc","description":"specifies a 2D scale operation using the [1,sy] scaling vector
","params":[{"identifier":"y","optional":false,"description":"y scaling vector
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Matrix3d","kind":"canonical"},{"value":"Matrix3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"kyQ5SsxxSdhuKPL4P6jVf","name":"setTransform","brief":"","scope":"instance","type":"MethodDoc","description":"set the matrix to the specified value
","params":[{"identifier":"m00","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"m01","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"m02","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"m03","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"m10","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"m11","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"m12","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"m13","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"m20","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"m21","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"m22","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"m23","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"m30","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"m31","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"m32","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"m33","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Matrix3d","kind":"canonical"},{"value":"Matrix3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"OnVNLtvQgp2Hca91mWZOQ","name":"toArray","brief":"","scope":"instance","type":"MethodDoc","description":"return an array representation of this Matrix
","params":[],"returns":[{"dataType":{"tokens":[{"value":"Float32Array","kind":"canonical"},{"value":"Float32Array","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"PSg4Q2c6gwnfKiik5gwOR","name":"toString","brief":"","scope":"instance","type":"MethodDoc","description":"convert the object to a string representation
","params":[],"returns":[{"dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"extends":[],"implements":[]},{"id":"2OD6FqfcmubZepzun7TB_","name":"translate","brief":"","scope":"instance","type":"MethodDoc","description":"translate the matrix position using the given vector
","params":[{"identifier":"x","description":"a number representing the abscissa of the vector, or a vector object
","dataType":{"tokens":[{"value":"number | Vector2d | Vector3d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}},{"identifier":"y","optional":true,"description":"a number representing the ordinate of the vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"z","optional":true,"default":"0","description":"a number representing the depth of the vector
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Matrix3d","kind":"canonical"},{"value":"Matrix3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"KLQop5bDT-wuTKqXXJhzv","name":"transpose","brief":"","scope":"instance","type":"MethodDoc","description":"Transpose the value of this matrix.
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Matrix3d","kind":"canonical"},{"value":"Matrix3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]}]},{"id":"M_6zNU6dGQ-mP5N1wYixr","name":"NineSliceSprite","brief":"","see":["https://en.wikipedia.org/wiki/9-slice_scaling"],"type":"ClassDoc","description":"A NineSliceSprite is similar to a Sprite, but it uses 9-slice scaling to strech its inner area to fit the size of the Rend...","params":[],"returns":[],"extends":["Sprite"],"implements":[],"members":[{"id":"MZDv14liRVLI3DCtmn2UK","name":"alpha","brief":"","defaultValue":"1.0","scope":"instance","see":["Renderable#setOpacity","Renderable#getOpacity"],"type":"PropertyDoc","description":"
Define the renderable opacity
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"YlzHzeSQ_ogP5UfcT8XTe","name":"alwaysUpdate","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object will always update, even when outside of the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"DJq5v5OjqiNJl_FU_YFhj","name":"ancestor","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"a reference to the parent object that contains this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ncXUOO2RojcNeLtWl2O_c","name":"anchorPoint","brief":"","defaultValue":"<0.5,0.5>","scope":"instance","type":"PropertyDoc","description":"The anchor point is used for attachment behavior, and/or when applying transformations.
animation cycling speed (delay between frame in ms)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"2AlX6Q1fUO-QrAFLq63v9","name":"autoTransform","brief":"","defaultValue":"true","examples":[{"caption":"","code":"// enable \"automatic\" transformation when the object is activated\nonActivateEvent: function () {\n // reset the transformation matrix\n this.currentTransform.identity();\n // ensure the anchor point is the renderable center\n this.anchorPoint.set(0.5, 0.5);\n // enable auto transform\n this.autoTransform = true;\n ....\n}"}],"scope":"instance","type":"PropertyDoc","description":"When enabled, an object container will automatically apply\nany defined transformation before calling the child draw method...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"FUTLK6lgaDXF4O3SEjpRL","name":"blendMode","brief":"","defaultValue":"\"normal\"","scope":"instance","see":["CanvasRenderer#setBlendMode","WebGLRenderer#setBlendMode"],"type":"PropertyDoc","description":"
the blend mode to be applied to this renderable (see renderer setBlendMode for available blend mode)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"wkPS5PNbR57Bmd8tImuqs","name":"body","brief":"","examples":[{"caption":"","code":" // define a new Player Class\n class PlayerEntity extends me.Sprite {\n // constructor\n constructor(x, y, settings) {\n // call the parent constructor\n super(x, y , settings);\n\n // define a basic walking animation\n this.addAnimation(\"walk\", [...]);\n // define a standing animation (using the first frame)\n this.addAnimation(\"stand\", [...]);\n // set the standing animation as default\n this.setCurrentAnimation(\"stand\");\n\n // add a physic body\n this.body = new me.Body(this);\n // add a default collision shape\n this.body.addShape(new me.Rect(0, 0, this.width, this.height));\n // configure max speed, friction, and initial force to be applied\n this.body.setMaxVelocity(3, 15);\n this.body.setFriction(0.4, 0);\n this.body.force.set(3, 0);\n this.isKinematic = false;\n\n // set the display to follow our position on both axis\n me.game.viewport.follow(this.pos, me.game.viewport.AXIS.BOTH);\n }\n\n ...\n\n }"}],"scope":"instance","type":"PropertyDoc","description":"the renderable physic body
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"d79h80im-MrLPBwV5gclQ","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"zq1Lv25L3kBmxZZ42o0-a","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"3NAM370w4KPvfzJGHMFIK","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"HhW4YExHjP-07G91RddjV","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"JI44O2aaUKGjjEZ3DBz_B","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"TTilivnOvb7_VmpUdSFeE","name":"floating","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"If true, this renderable will be rendered using screen coordinates,\nas opposed to world coordinates. Use this, for example...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"sgKynIltAEoLnoYBT20SW","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"
(G)ame (U)nique (Id)entifier"
height of the NineSliceSprite
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"e_iR5kXqXZMS_s37Hr1H4","name":"inViewport","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object is visible and within the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"zW5ULfNbRijUg7lOZXGV_","name":"isDirty","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"when true the renderable will be redrawn during the next update cycle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"KiZmnDYZFspt5qE4WsjzL","name":"isFlippedX","brief":"","access":"public","scope":"instance","see":["Renderable#flipX"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"oeQ4Rh3Vps9ZZBVz9ESrJ","name":"isFlippedY","brief":"","access":"public","scope":"instance","see":["Renderable#flipY"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"jyBHR2zbXotg8IIR6SJGJ","name":"isFloating","brief":"","scope":"instance","see":["Renderable#floating"],"type":"PropertyDoc","description":"Whether the renderable object is floating (i.e. used screen coordinates), or contained in a floating parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"IBJafrQ0koe96oD0Ep50Z","name":"isKinematic","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"If true then physic collision and input events will not impact this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"LC4SFKLOWBe9fCfrrIGUw","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"yplYOdUJPkblYicFt5SpG","name":"isVideo","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"true if this is a video sprite (e.g. a HTMLVideoElement was passed as as source)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"dQU98fpoR9jy-BIMqxE3F","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ZkyDfXRbwGbT2ZjGwVXi7","name":"mask","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"// apply a mask in the shape of a Star\nmyNPCSprite.mask = new me.Polygon(myNPCSprite.width / 2, 0, [\n // draw a star\n {x: 0, y: 0},\n {x: 14, y: 30},\n {x: 47, y: 35},\n {x: 23, y: 57},\n {x: 44, y: 90},\n {x: 0, y: 62},\n {x: -44, y: 90},\n {x: -23, y: 57},\n {x: -47, y: 35},\n {x: -14, y: 30}\n]);"}],"scope":"instance","type":"PropertyDoc","description":"A mask limits rendering elements to the shape and position of the given mask object.\nSo, if the renderable is larger than ...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"X-9Q06lS2EFU9EE4kJ0J6","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"PXMidUQWB-MJzrl8KIOxz","name":"offset","brief":"","defaultValue":"<0.0,0.0>","scope":"instance","type":"PropertyDoc","description":"global offset for the position to draw from on the source image.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"e43dDZaZF_Ywv8tGpsz-K","name":"onVisibilityChange","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"this.onVisibilityChange = function(inViewport) {\n if (inViewport === true) {\n console.log(\"object has entered the in a camera viewport!\");\n }\n};"}],"scope":"instance","type":"PropertyDoc","description":"an event handler that is called when the renderable leave or enter a camera viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"kwcAeKfpeOzk4x9Twmsu0","name":"parentApp","brief":"","scope":"instance","type":"PropertyDoc","description":"returns the parent application (or game) to which this renderable is attached to
","params":[],"returns":[{"description":"the parent application or undefined if not attached to any container/app
","dataType":{"tokens":[{"value":"Application","kind":"canonical"},{"value":"Application","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"WCMF_AqzENTM9KlKM-D6E","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ZMddgm5AOR7OELbTZHujf","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"yK_PDHJQB6YAZxn4hyPJK","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"eAc1o1kfbsErgMjQn17Gx","name":"shader","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"(Experimental) an optional shader, to be used instead of the default built-in one, when drawing this renderable (WebGL onl...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"aWN7D2L4shZvvvXZyzFSN","name":"source","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"
The source texture object this sprite object is using
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"8qKzQe1i1_EjtypsAQqiu","name":"tint","brief":"","defaultValue":"(255, 255, 255)","examples":[{"caption":"","code":"// add a red tint to this renderable\nthis.tint.setColor(255, 128, 128);\n// remove the tint\nthis.tint.setColor(255, 255, 255);"}],"scope":"instance","type":"PropertyDoc","description":"define a tint for this renderable. a (255, 255, 255) r, g, b value will remove the tint effect.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"4KJlcgv9sPsFCUJo5Qifb","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"j3uttYgPjc5pSWoZ_qtyq","name":"type","brief":"","defaultValue":"\"Rectangle\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"4H1_C_lvN_bsASkBuGioI","name":"updateWhenPaused","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether to update this object when the game is paused.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"-AVGSZjBgZ3Dy2DUOEaw_","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the NineSliceSprite
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"DNwZPveFKEx2FdByXoH2N","name":"addAnimation","brief":"","examples":[{"caption":"","code":"// walking animation\nthis.addAnimation(\"walk\", [ 0, 1, 2, 3, 4, 5 ]);\n// standing animation\nthis.addAnimation(\"stand\", [ 11, 12 ]);\n// eating animation\nthis.addAnimation(\"eat\", [ 6, 6 ]);\n// rolling animation\nthis.addAnimation(\"roll\", [ 7, 8, 9, 10 ]);\n// slower animation\nthis.addAnimation(\"roll\", [ 7, 8, 9, 10 ], 200);\n// or get more specific with delay for each frame. Good solution instead of repeating:\nthis.addAnimation(\"turn\", [{ name: 0, delay: 200 }, { name: 1, delay: 100 }])\n// can do this with atlas values as well:\nthis.addAnimation(\"turn\", [{ name: \"turnone\", delay: 200 }, { name: \"turntwo\", delay: 100 }])\n// define an dying animation that stop on the last frame\nthis.addAnimation(\"die\", [{ name: 3, delay: 200 }, { name: 4, delay: 100 }, { name: 5, delay: Infinity }])\n// set the standing animation as default\nthis.setCurrentAnimation(\"stand\");"}],"scope":"instance","see":["Sprite#animationspeed"],"type":"MethodDoc","description":"add an animation
animation id
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"index","optional":false,"description":"list of sprite index or name defining the animation. Can also use objects to specify delay for each frame, see below
","dataType":{"tokens":[{"value":"Array | Array | Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"}],"template":"%1<%2> | %3 | %4"}},{"identifier":"animationspeed","optional":true,"description":"cycling speed for animation in ms
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"frame amount of frame added to the animation (delay between each frame).
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"kT4vWXXWLubmiMwSejay-","name":"angleTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the angle to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"angle in radians
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"NZ_901cmo0QHC4HyVPqDz","name":"centerOn","brief":"","scope":"instance","type":"MethodDoc","description":"center the rectangle position around the given coordinates
","params":[{"identifier":"x","optional":false,"description":"the x coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"80CXDAF21oAFvi9h0Upfe","name":"clone","brief":"","scope":"instance","type":"MethodDoc","description":"clone this rectangle
","params":[],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"8olAk7vd1bGEMlMm5sKPp","name":"constructor","brief":"","examples":[{"caption":"","code":"this.panelSprite = new me.NineSliceSprite(0, 0, {\n image : game.texture,\n region : \"grey_panel\",\n width : this.width,\n height : this.height\n});"}],"scope":"instance","type":"MethodDoc","params":[{"identifier":"x","optional":false,"description":"the x coordinates of the sprite object
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y coordinates of the sprite object
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings","optional":false,"description":"Configuration parameters for the Sprite object
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}},{"identifier":"settings.width","description":"the width of the Renderable over which the sprite needs to be stretched
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings.height","description":"the height of the Renderable over which the sprite needs to be stretched
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings.insetx","optional":true,"description":"the width of a corner over which the sprite is unscaled (default is a quarter of the sprite width)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings.insety","optional":true,"description":"the height of a corner over which the sprite is unscaled (default is a quarter of the sprite height)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings.image","description":"reference to spritesheet image, a texture atlas or to a texture atlas
","dataType":{"tokens":[{"value":"HTMLImageElement | HTMLCanvasElement | TextureAtlas | string","kind":"canonical"},{"value":"HTMLImageElement","kind":"canonical"},{"value":"HTMLCanvasElement","kind":"canonical"},{"value":"TextureAtlas","kind":"link"}],"template":"%1 | %2 | %3 | string"}},{"identifier":"settings.name","optional":true,"default":"\"\"","description":"name of this object
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"settings.region","optional":true,"description":"region name of a specific region to use when using a texture atlas, see {@link TextureAtlas}
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"settings.framewidth","optional":true,"description":"Width of a single frame within the spritesheet
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings.frameheight","optional":true,"description":"Height of a single frame within the spritesheet
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings.tint","optional":true,"description":"a tint to be applied to this sprite
","dataType":{"tokens":[{"value":"string | Color","kind":"canonical"},{"value":"Color","kind":"link"}],"template":"string | %1"}},{"identifier":"settings.flipX","optional":true,"description":"flip the sprite on the horizontal axis
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings.flipY","optional":true,"description":"flip the sprite on the vertical axis
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings.anchorPoint","optional":true,"default":"{x:0.5, y:0.5}","description":"Anchor point to draw the frame at (defaults to the center of the frame).
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"vo15y1fR98DvjVOPG0eMT","name":"contains","brief":"","examples":[{"caption":"","code":"if (rect.contains(10, 10)) {\n // do something\n}\n// or\nif (rect.contains(myVector2d)) {\n // do something\n}\nif (rect.contains(myRect)) {\n // do something\n}"}],"scope":"instance","type":"MethodDoc","description":"Returns true if the rectangle contains the given point or rectangle
","params":[{"identifier":"x","description":"x coordinate or a vector point, or a rectangle to test
","dataType":{"tokens":[{"value":"number | Vector2d | Rect","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Rect","kind":"link"}],"template":"%1 | %2 | %3"}},{"identifier":"y","optional":true,"description":"y coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"True if the rectangle contain the given point or rectangle, otherwise false
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"cojnTrCqCrC7QSDyybBDQ","name":"copy","brief":"","scope":"instance","type":"MethodDoc","description":"copy the position and size of the given rectangle into this one
","params":[{"identifier":"rect","optional":false,"description":"Source rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"fogPXmiX4M-gKNvgF5kWC","name":"distanceTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the distance to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"distance
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"uFCL6wSUEubfKk7Jl56tJ","name":"equals","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is identical to the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if equals
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"oqqPG6nMaysr-QMLI4wRf","name":"flicker","brief":"","examples":[{"caption":"","code":"// make the object flicker for 1 second\n// and then remove it\nthis.flicker(1000, function () {\n world.removeChild(this);\n});"}],"scope":"instance","type":"MethodDoc","description":"make the object flicker
","params":[{"identifier":"duration","optional":false,"description":"expressed in milliseconds
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"callback","optional":false,"description":"Function to call when flickering ends
","dataType":{"tokens":[{"value":"Function","kind":"canonical"}],"template":"Function"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Sprite","kind":"canonical"},{"value":"Sprite","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"mV-JCJ3JZ9q9uOsH4QOMb","name":"flipX","brief":"","scope":"instance","see":["Matrix2d#scaleX"],"type":"MethodDoc","description":"flip the renderable on the horizontal axis (around the center of the renderable)
","params":[{"identifier":"flip","optional":true,"default":"true","description":"true to flip this renderable.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"iIfQQr8Upru17QmDvw0wY","name":"flipY","brief":"","scope":"instance","see":["Matrix2d#scaleY"],"type":"MethodDoc","description":"flip the renderable on the vertical axis (around the center of the renderable)
","params":[{"identifier":"flip","optional":true,"default":"true","description":"true to flip this renderable.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"jHfxdDh0lp9sGL-cIOIRo","name":"getAbsolutePosition","brief":"","scope":"instance","type":"MethodDoc","description":"return the renderable absolute position in the game world
","params":[],"returns":[{"dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"maCgvf0LUYiD3sx9YuZeD","name":"getBounds","brief":"","scope":"instance","type":"MethodDoc","description":"returns the bounding box for this renderable
","params":[],"returns":[{"description":"bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"VVP7B1haZmEAfPWHW5RmP","name":"getCurrentAnimationFrame","brief":"","scope":"instance","type":"MethodDoc","description":"return the current animation frame index.
","params":[],"returns":[{"description":"current animation frame index
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"7KbNUuchhjxYARF8JImwy","name":"getIndices","brief":"","scope":"instance","type":"MethodDoc","description":"returns a list of indices for all triangles defined in this polygon
","params":[],"returns":[{"description":"an array of vertex indices for all triangles forming this polygon.
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1<%2>"}}],"extends":[],"implements":[]},{"id":"U0aOC93Vlu4Dzg0rWsHOA","name":"getOpacity","brief":"","scope":"instance","type":"MethodDoc","description":"get the renderable alpha channel value
","params":[],"returns":[{"description":"current opacity value between 0 and 1
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"U8zlLFO7kXBDVSqmECpc4","name":"isConvex","brief":"","scope":"instance","type":"MethodDoc","description":"Returns true if the vertices composing this polygon form a convex shape (vertices must be in clockwise order).
","params":[],"returns":[{"description":"true if the vertices are convex, false if not, null if not computable
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"aOqDeiaIVtPZXq6y-PxTy","name":"isCurrentAnimation","brief":"","examples":[{"caption":"","code":"if (!this.isCurrentAnimation(\"walk\")) {\n // do something funny...\n}"}],"scope":"instance","type":"MethodDoc","description":"return true if the specified animation is the current one.
","params":[{"identifier":"name","optional":false,"description":"animation id
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"returns":[{"dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"F4Hq_86wc5A6rgLZ313kM","name":"isFinite","brief":"","scope":"instance","type":"MethodDoc","description":"determines whether all coordinates of this rectangle are finite numbers.
","params":[],"returns":[{"description":"false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"YR6RIOZnc7LTbCVxm06qT","name":"isFlickering","brief":"","scope":"instance","type":"MethodDoc","description":"return the flickering state of the object
","params":[],"returns":[{"dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"gJMeimzijY7Dc3DJ1fO78","name":"lookAt","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this renderable towards the given target.
","params":[{"identifier":"target","optional":false,"description":"the renderable or position to look at
","dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"I--WnvMOJCGekzNMRFeXe","name":"onCollision","brief":"","examples":[{"caption":"","code":"// colision handler\nonCollision(response) {\n if (response.b.body.collisionType === me.collision.types.ENEMY_OBJECT) {\n // makes the other object solid, by substracting the overlap vector to the current position\n this.pos.sub(response.overlapV);\n this.hurt();\n // not solid\n return false;\n }\n // Make the object solid\n return true;\n},"}],"scope":"instance","type":"MethodDoc","description":"onCollision callback, triggered in case of collision,\nwhen this renderable body is colliding with another one
","params":[{"identifier":"response","optional":false,"description":"the collision response object
","dataType":{"tokens":[{"value":"ResponseObject","kind":"canonical"},{"value":"ResponseObject","kind":"link"}],"template":"%1"}},{"identifier":"other","optional":false,"description":"the other renderable touching this one (a reference to response.a or response.b)
","dataType":{"tokens":[{"value":"Renderable | Container | Entity | Sprite | NineSliceSprite","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Container","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"NineSliceSprite","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5"}}],"returns":[{"description":"true if the object should respond to the collision (its position and velocity will be corrected)
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"hUymlN8smT0ygGecKTUZk","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"OnDestroy Notification function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"qiR3WzRTbGsWcA8taw-Fq","name":"overlaps","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is intersecting with the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if overlaps
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"ffAbphKqZSm3VGXcWF4K5","name":"pause","brief":"play or resume the current animation or video
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"WdPYCyvbMVPi9_7tF14UU","name":"play","brief":"play or resume the current animation or video
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"kgPRmD-FaiLGxv8sobHQ5","name":"postDraw","brief":"","scope":"instance","see":["Renderable#preDraw","Renderable#draw"],"type":"MethodDoc","description":"restore the rendering context after drawing (automatically called by melonJS).
","params":[{"identifier":"renderer","optional":false,"description":"a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"i8bIvf_BdVq5IEtF-Kf-s","name":"preDraw","brief":"","scope":"instance","see":["Renderable#draw","Renderable#postDraw"],"type":"MethodDoc","description":"Prepare the rendering context before drawing (automatically called by melonJS).\nThis will apply any defined transforms, an...","params":[{"identifier":"renderer","optional":false,"description":"
a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"WNwGJTYw4pyHhRaLNP3Di","name":"recalc","brief":"","scope":"instance","type":"MethodDoc","description":"Computes the calculated collision polygon.\nThis must be called if the points array, an...","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"OgcChdkepf1fG8Wp3CRwc","name":"resize","brief":"","scope":"instance","type":"MethodDoc","description":"resize the rectangle
","params":[{"identifier":"w","optional":false,"description":"new width of the rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"h","optional":false,"description":"new height of the rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"2CBeJdJjuCEwHCoU_QESF","name":"reverseAnimation","brief":"","scope":"instance","see":["Sprite#animationspeed"],"type":"MethodDoc","description":"reverse the given or current animation if none is specified
","params":[{"identifier":"name","optional":true,"description":"animation id
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Sprite","kind":"canonical"},{"value":"Sprite","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Z0jK0micuLhOIR9MSdLuD","name":"rotate","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this renderable by the specified angle (in radians).
","params":[{"identifier":"angle","optional":false,"description":"The angle to rotate (in radians)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":true,"description":"an optional point to rotate around
","dataType":{"tokens":[{"value":"Vector2d | ObservableVector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"2ER9GXsTPQcXc-cODARpf","name":"scale","brief":"","scope":"instance","type":"MethodDoc","description":"scale the renderable around his anchor point. Scaling actually applies changes\nto the currentTransform member wich is use...","params":[{"identifier":"x","optional":false,"description":"
a number representing the abscissa of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":true,"default":"x","description":"a number representing the ordinate of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"E2H8IVqIU8q1jtmHDES96","name":"scaleV","brief":"","scope":"instance","type":"MethodDoc","description":"scale the renderable around his anchor point
","params":[{"identifier":"v","optional":false,"description":"scaling vector
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"o9unqVhxrkhfPjvAzd_mJ","name":"setAnimationFrame","brief":"","examples":[{"caption":"","code":"// reset the current animation to the first frame\nthis.setAnimationFrame();"}],"scope":"instance","type":"MethodDoc","description":"force the current animation frame index.
","params":[{"identifier":"index","optional":true,"default":"0","description":"animation frame index
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Sprite","kind":"canonical"},{"value":"Sprite","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"grh-dUu-hV4FamTiMM90d","name":"setCurrentAnimation","brief":"","examples":[{"caption":"","code":" // set \"walk\" animation\n this.setCurrentAnimation(\"walk\");\n\n // set \"walk\" animation if it is not the current animation\n if (this.isCurrentAnimation(\"walk\")) {\n this.setCurrentAnimation(\"walk\");\n }\n\n // set \"eat\" animation, and switch to \"walk\" when complete\n this.setCurrentAnimation(\"eat\", \"walk\");\n\n // set \"die\" animation, and remove the object when finished\n this.setCurrentAnimation(\"die\", () => {\n world.removeChild(this);\n return false; // do not reset to first frame\n });\n\n // set \"attack\" animation, and pause for a short duration\n this.setCurrentAnimation(\"die\", () => {\n this.animationpause = true;\n\n // back to \"standing\" animation after 1 second\n setTimeout(function () {\n this.setCurrentAnimation(\"standing\");\n }, 1000);\n\n return false; // do not reset to first frame\n });"}],"scope":"instance","type":"MethodDoc","description":"set the current animation\nthis will always change the animation & set the frame to zero
","params":[{"identifier":"name","optional":false,"description":"animation id
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"resetAnim","optional":true,"description":"animation id to switch to when complete, or callback
","dataType":{"tokens":[{"value":"string | Function","kind":"canonical"}],"template":"string | Function"}},{"identifier":"preserve_dt","optional":true,"default":"false","description":"if false will reset the elapsed time counter since last frame
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Sprite","kind":"canonical"},{"value":"Sprite","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Uhnpc9CnF7jaXcnLTk2Pr","name":"setOpacity","brief":"","scope":"instance","type":"MethodDoc","description":"set the renderable alpha channel value
","params":[{"identifier":"alpha","optional":false,"description":"opacity value between 0.0 and 1.0
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"GXyF82DcdcKMqCxfQAgbD","name":"setRegion","brief":"","examples":[{"caption":"","code":"// change the sprite to \"shadedDark13.png\";\nmySprite.setRegion(mytexture.getRegion(\"shadedDark13.png\"));"}],"scope":"instance","see":["Texture.getRegion"],"type":"MethodDoc","description":"change the current texture atlas region for this sprite
","params":[{"identifier":"region","optional":false,"description":"typically returned through me.Texture.getRegion()
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Sprite","kind":"canonical"},{"value":"Sprite","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"mHTpzdhligYrJfjYxn5e6","name":"setShape","brief":"","scope":"instance","type":"MethodDoc","description":"set new value to the rectangle shape
","params":[{"identifier":"x","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"w","optional":false,"description":"width of the rectangle, or an array of vector defining the rectangle
","dataType":{"tokens":[{"value":"number | Array","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %3<%2>"}},{"identifier":"h","optional":true,"description":"height of the rectangle, if a numeral width parameter is specified
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"wRkZ0F1QdRTsNsHI1qfpv","name":"setVertices","brief":"","scope":"instance","type":"MethodDoc","description":"set the vertices defining this Polygon
","params":[{"identifier":"vertices","optional":false,"description":"array of vector or vertice defining the Polygon
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1<%2>"}}],"returns":[{"description":"this instance for objecf chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Sr3JlP1smI7_CxI4n0HfO","name":"shift","brief":"","examples":[{"caption":"","code":"polygon.shift(10, 10);\n// or\npolygon.shift(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"Shifts the Polygon to the given position vector.
","params":[{"identifier":"x","description":"x coordinate or a vector point to shift to
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"dwTcdcawDEF77RxlQ5FDl","name":"to2d","brief":"","scope":"instance","type":"MethodDoc","description":"apply a 2d projection to this shapen
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"0fuUOVV6uob3oLa1ivvb_","name":"toIso","brief":"","scope":"instance","type":"MethodDoc","description":"apply an isometric projection to this shape
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"aIHl7vN1C8YEdMohoocyL","name":"toPolygon","brief":"","scope":"instance","type":"MethodDoc","description":"Returns a polygon whose edges are the same as this box.
","params":[],"returns":[{"description":"a new Polygon that represents this rectangle.
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"pZq6v4xa1Mw65Laxf_dMZ","name":"transform","brief":"","scope":"instance","see":["Renderable#currentTransform"],"type":"MethodDoc","description":"multiply the renderable currentTransform with the given matrix
","params":[{"identifier":"m","optional":false,"description":"the transformation matrix
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"C5tVWWksPDlIcpgrwfD_9","name":"translate","brief":"","examples":[{"caption":"","code":"polygon.translate(10, 10);\n// or\npolygon.translate(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"translate the Polygon by the specified offset
","params":[{"identifier":"x","description":"x offset or a vector point to translate by
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"description":"y offset
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"GaLsXRrRz3fbcVbebuu7S","name":"union","brief":"","scope":"instance","type":"MethodDoc","description":"merge this rectangle with another one
","params":[{"identifier":"rect","optional":false,"description":"other rectangle to union with
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"the union(ed) rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"z3TNes2e9PqBnLE0xklQu","name":"updateBounds","brief":"","scope":"instance","type":"MethodDoc","description":"update the bounding box for this shape.
","params":[{"identifier":"absolute","optional":true,"default":"true","description":"update the bounds size and position in (world) absolute coordinates
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"this shape bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"oWtZjCMC0itQaHZYuktbW","name":"draw","brief":"","access":"protected","scope":"instance","type":"MethodDoc","description":"draw this srite (automatically called by melonJS)
","params":[{"identifier":"renderer","optional":false,"description":"a renderer instance
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}},{"identifier":"viewport","optional":true,"description":"the viewport to (re)draw
","dataType":{"tokens":[{"value":"Camera2d","kind":"canonical"},{"value":"Camera2d","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"qD2xLfq9CcNsJRWTN_v_D","name":"update","brief":"","access":"protected","scope":"instance","type":"MethodDoc","description":"update function.
","params":[{"identifier":"dt","optional":false,"description":"time since the last update in milliseconds.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"true if the Sprite is dirty
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"gM3fnYNwKOUG6p_WAoyJ3","name":"onAnchorUpdate","brief":"","access":"private","scope":"instance","type":"MethodDoc","description":"called when the anchor point value is changed
","params":[{"identifier":"x","optional":false,"description":"the new X value to be set for the anchor
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the new Y value to be set for the anchor
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]}]},{"id":"e5k8JsvEUCj08JbGebLgm","name":"ObjectPool","brief":"","see":["{@link pool} the default global instance of ObjectPool"],"type":"ClassDoc","description":"Object pooling - a technique that might speed up your game if used properly.
Check if an object with the provided name is registered
","params":[{"identifier":"name","optional":false,"description":"of the registered object class
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"returns":[{"description":"true if the classname is registered
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"l0aXMprKpldfQjhQb236r","name":"getInstanceCount","brief":"","scope":"instance","type":"MethodDoc","description":"returns the amount of object instance currently in the pool
","params":[],"returns":[{"description":"amount of object instance
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"pQDUDvfcOaENG5-kG7-gt","name":"poolable","brief":"","examples":[{"caption":"","code":"if (!me.pool.poolable(myCherryEntity)) {\n // object was not properly registered\n}"}],"scope":"instance","see":["register"],"type":"MethodDoc","description":"Check if an object is poolable\n(was properly registered with the recycling feature enable)
","params":[{"identifier":"obj","optional":false,"description":"object to be checked
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}}],"returns":[{"description":"true if the object is poolable
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"iYB7QVjPtwxPPwNT4ZcSD","name":"pull","brief":"","examples":[{"caption":"","code":"me.pool.register(\"bullet\", BulletEntity, true);\nme.pool.register(\"enemy\", EnemyEntity, true);\n// ...\n// when we need to manually create a new bullet:\nlet bullet = me.pool.pull(\"bullet\", x, y, direction);\n// ...\n// params aren't a fixed number\n// when we need new enemy we can add more params, that the object construct requires:\nlet enemy = me.pool.pull(\"enemy\", x, y, direction, speed, power, life);\n// ...\n// when we want to destroy existing object, the remove\n// function will ensure the object can then be reallocated later\nme.game.world.removeChild(enemy);\nme.game.world.removeChild(bullet);"}],"scope":"instance","type":"MethodDoc","description":"Pull a new instance of the requested object (if added into the object pool)
","params":[{"identifier":"name","optional":false,"description":"as used in {@link pool.register}
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"...arguments","optional":true,"variadic":true,"description":"arguments to be passed when instantiating/reinitializing the object
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}}],"returns":[{"description":"the instance of the requested object
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}}],"extends":[],"implements":[]},{"id":"w_9DMROgXKHZ4htInBteg","name":"purge","brief":"","scope":"instance","type":"MethodDoc","description":"purge the object pool from any inactive object
Push back an object instance into the object pool
instance to be recycled
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}},{"identifier":"throwOnError","optional":true,"default":"true","description":"throw an exception if the object cannot be recycled
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"true if the object was successfully recycled in the object pool
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"QC15EFbAHfTXugOpJHYWK","name":"register","brief":"","examples":[{"caption":"","code":"// implement CherryEntity\nclass Cherry extends Sprite {\n onResetEvent() {\n // reset object mutable properties\n this.lifeBar = 100;\n }\n};\n// add our users defined entities in the object pool and enable object recycling\nme.pool.register(\"cherrysprite\", Cherry, true);"}],"scope":"instance","type":"MethodDoc","description":"register an object to the pool.
as defined in the Name field of the Object Properties (in Tiled)
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"classObj","optional":false,"description":"corresponding Class to be instantiated
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}},{"identifier":"recycling","optional":true,"default":"false","description":"enables object recycling for the specified class
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]}]},{"id":"vlGgkSKIztDRsFngEcrSR","name":"ObservableVector2d","brief":"","type":"ClassDoc","description":"A Vector2d object that provide notification by executing the given callback when the vector is changed.
","params":[],"returns":[],"extends":["Vector2d"],"implements":[],"members":[{"id":"DJUIk8cnV9wSiepAdHmRr","name":"x","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"x value of the vector
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"BOCylQqcOGhXryOOjpLzI","name":"y","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"y value of the vector
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"4pcY066VeE-xCPJPxwPD9","name":"abs","brief":"","scope":"instance","type":"MethodDoc","description":"Update this vector values to absolute values
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"ObservableVector2d","kind":"canonical"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"wosAQZXKkMI-jl4uYUHmU","name":"add","brief":"","scope":"instance","type":"MethodDoc","description":"Add the passed vector to this vector
","params":[{"identifier":"v","optional":false,"dataType":{"tokens":[{"value":"ObservableVector2d","kind":"canonical"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"ObservableVector2d","kind":"canonical"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"6Ra4FF3BhyGas_r1WlPqQ","name":"angle","brief":"","scope":"instance","type":"MethodDoc","description":"return the angle between this vector and the passed one
","params":[{"identifier":"v","optional":false,"dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"angle in radians
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Pehh23Z5x_AugLTfp-fOW","name":"ceil","brief":"","scope":"instance","type":"MethodDoc","description":"Ceil the vector values
","params":[],"returns":[{"description":"new me.ObservableVector2d
","dataType":{"tokens":[{"value":"ObservableVector2d","kind":"canonical"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"o4MwFirTmLraymiQmrzlh","name":"ceilSelf","brief":"","scope":"instance","type":"MethodDoc","description":"Ceil this vector values
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"ObservableVector2d","kind":"canonical"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"4UosmqwlpqQL-gFgRWMgF","name":"clamp","brief":"","scope":"instance","type":"MethodDoc","description":"Clamp the vector value within the specified value range
","params":[{"identifier":"low","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"high","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"new me.ObservableVector2d
","dataType":{"tokens":[{"value":"ObservableVector2d","kind":"canonical"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"CGoLbXsa8WWkvRuj80WO4","name":"clampSelf","brief":"","scope":"instance","type":"MethodDoc","description":"Clamp this vector value within the specified value range
","params":[{"identifier":"low","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"high","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"ObservableVector2d","kind":"canonical"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"OiI5MBTnkMIcLghsEoGrQ","name":"clone","brief":"","scope":"instance","type":"MethodDoc","description":"return a clone copy of this vector
","params":[],"returns":[{"description":"new me.ObservableVector2d
","dataType":{"tokens":[{"value":"ObservableVector2d","kind":"canonical"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"m1uLdUh9U_OzmjIB6Ik6i","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"x","optional":false,"default":"0","description":"x value of the vector
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"default":"0","description":"y value of the vector
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings","optional":false,"description":"additional required parameters
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}},{"identifier":"settings.onUpdate","description":"the callback to be executed when the vector is changed
","dataType":{"tokens":[{"value":"Function","kind":"canonical"}],"template":"Function"}},{"identifier":"settings.scope","optional":true,"description":"the value to use as this when calling onUpdate
","dataType":{"tokens":[{"value":"Function","kind":"canonical"}],"template":"Function"}}],"returns":[],"extends":[],"implements":[]},{"id":"Gj1KOvB4Ze4YZfG61kbms","name":"copy","brief":"","scope":"instance","type":"MethodDoc","description":"Copy the x,y values of the passed vector to this one
","params":[{"identifier":"v","optional":false,"dataType":{"tokens":[{"value":"ObservableVector2d","kind":"canonical"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"ObservableVector2d","kind":"canonical"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"5W9ltokXgZ4csuHUMyG84","name":"cross","brief":"","scope":"instance","type":"MethodDoc","description":"return the cross product of this vector and the passed one
","params":[{"identifier":"v","optional":false,"dataType":{"tokens":[{"value":"Vector2d | ObservableVector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"The cross product.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"t59cBWqYZJVc9CHhAATVt","name":"distance","brief":"","scope":"instance","type":"MethodDoc","description":"return the distance between this vector and the passed one
","params":[{"identifier":"v","optional":false,"dataType":{"tokens":[{"value":"ObservableVector2d","kind":"canonical"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1"}}],"returns":[{"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"kzI9kxlg65pGVxY-xwPfq","name":"div","brief":"","scope":"instance","type":"MethodDoc","description":"Divide this vector values by the passed value
","params":[{"identifier":"n","optional":false,"description":"the value to divide the vector by
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"ObservableVector2d","kind":"canonical"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"zYiBorbx1LOYzg06ff4BM","name":"dot","brief":"","scope":"instance","type":"MethodDoc","description":"return the dot product of this vector and the passed one
","params":[{"identifier":"v","optional":false,"dataType":{"tokens":[{"value":"Vector2d | ObservableVector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"The dot product.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"LbMXmIN0SxMhhl-_Pimg-","name":"equals","brief":"","scope":"instance","type":"MethodDoc","description":"return true if the two vectors are the same
","params":[{"identifier":"v","optional":false,"dataType":{"tokens":[{"value":"ObservableVector2d","kind":"canonical"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1"}}],"returns":[{"dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"Ui4f7ZcO00O8l6BStGMYM","name":"floor","brief":"","scope":"instance","type":"MethodDoc","description":"Floor the vector values
","params":[],"returns":[{"description":"new me.ObservableVector2d
","dataType":{"tokens":[{"value":"ObservableVector2d","kind":"canonical"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"k1gAFb_JwQCBcvZ2RPdYY","name":"floorSelf","brief":"","scope":"instance","type":"MethodDoc","description":"Floor this vector values
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"ObservableVector2d","kind":"canonical"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"andYFY7SONI3tsAlqk9oh","name":"length","brief":"","scope":"instance","type":"MethodDoc","description":"return the length (magnitude) of this vector
","params":[],"returns":[{"description":"the length of this vector
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"RS4iwVe5l1IzjfOW0CQZn","name":"length2","brief":"","scope":"instance","type":"MethodDoc","description":"return the square length of this vector
","params":[],"returns":[{"description":"The length^2 of this vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"KkMMTAcFboUOsNWiXzlpg","name":"lerp","brief":"","scope":"instance","type":"MethodDoc","description":"Linearly interpolate between this vector and the given one.
","params":[{"identifier":"v","optional":false,"dataType":{"tokens":[{"value":"Vector2d | ObservableVector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"alpha","optional":false,"description":"distance along the line (alpha = 0 will be this vector, and alpha = 1 will be the given one).
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"ObservableVector2d","kind":"canonical"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"CThCL7mr66Jy4YyTXeuJ4","name":"maxV","brief":"","scope":"instance","type":"MethodDoc","description":"Update this vector with the maximum value between this and the passed vector
","params":[{"identifier":"v","optional":false,"dataType":{"tokens":[{"value":"ObservableVector2d","kind":"canonical"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"ObservableVector2d","kind":"canonical"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"2YeF1cdskDCY2330I_-hK","name":"minV","brief":"","scope":"instance","type":"MethodDoc","description":"Update this vector with the minimum value between this and the passed vector
","params":[{"identifier":"v","optional":false,"dataType":{"tokens":[{"value":"ObservableVector2d","kind":"canonical"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"ObservableVector2d","kind":"canonical"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"KC9-k0zjtkoXxOddB_sck","name":"moveTowards","brief":"","scope":"instance","type":"MethodDoc","description":"interpolate the position of this vector towards the given one while nsure that the distance never exceeds the given step.
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Vector2d | ObservableVector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"step","optional":false,"description":"the maximum step per iteration (Negative values will push the vector away from the target)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"ObservableVector2d","kind":"canonical"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"P1CcNWUKgHALgd8pZeHb5","name":"negate","brief":"","scope":"instance","type":"MethodDoc","description":"Negate the vector values
","params":[],"returns":[{"description":"new me.ObservableVector2d
","dataType":{"tokens":[{"value":"ObservableVector2d","kind":"canonical"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Pnm2J9db4kuqpKjyhQo16","name":"negateSelf","brief":"","scope":"instance","type":"MethodDoc","description":"Negate this vector values
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"ObservableVector2d","kind":"canonical"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"u3gUBfd0WOdxYYvcjKd8F","name":"normalize","brief":"","scope":"instance","type":"MethodDoc","description":"normalize this vector (scale the vector so that its magnitude is 1)
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"wfPZ2hQ9PXD718Bju8lH2","name":"perp","brief":"","scope":"instance","type":"MethodDoc","description":"change this vector to be perpendicular to what it was before.
Reference to this object for method chaining
","dataType":{"tokens":[{"value":"ObservableVector2d","kind":"canonical"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"FzSJIvOCWhsEd-cbJPAyh","name":"project","brief":"","scope":"instance","type":"MethodDoc","description":"project this vector on to another vector.
","params":[{"identifier":"v","optional":false,"description":"The vector to project onto.
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"B03ewXAKeAX9Esyi26byv","name":"projectN","brief":"","scope":"instance","type":"MethodDoc","description":"Project this vector onto a vector of unit length.project when deali...","params":[{"identifier":"v","optional":false,"description":"
The unit vector to project onto.
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"FILLPHq5HdeCN7_Zr5UsP","name":"rotate","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this vector (counter-clockwise) by the specified angle (in radians).
","params":[{"identifier":"angle","optional":false,"description":"The angle to rotate (in radians)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":true,"description":"an optional point to rotate around
","dataType":{"tokens":[{"value":"Vector2d | ObservableVector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"ObservableVector2d","kind":"canonical"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"SPUTfGsY0XZp1S6_a_dCq","name":"scale","brief":"","scope":"instance","type":"MethodDoc","description":"Multiply this vector values by the given scalar
","params":[{"identifier":"x","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":true,"default":"x","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"ObservableVector2d","kind":"canonical"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"1Au2_PnQ364bnK2fchA16","name":"scaleV","brief":"","scope":"instance","type":"MethodDoc","description":"Multiply this vector values by the passed vector
","params":[{"identifier":"v","optional":false,"dataType":{"tokens":[{"value":"ObservableVector2d","kind":"canonical"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"ObservableVector2d","kind":"canonical"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Pk3riNdqbjfvFt58othQ9","name":"set","brief":"","scope":"instance","type":"MethodDoc","description":"set the Vector x and y properties to the given values
","params":[{"identifier":"x","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"tzF15Vb4FSSZtfEeqI1Vj","name":"setCallback","brief":"","scope":"instance","type":"MethodDoc","description":"set the callback to be executed when the vector is changed
","params":[{"identifier":"fn","optional":false,"description":"callback
","dataType":{"tokens":[{"value":"Function","kind":"canonical"}],"template":"Function"}},{"identifier":"scope","optional":true,"default":"null","description":"scope
","dataType":{"tokens":[{"value":"Function","kind":"canonical"}],"template":"Function"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"ObservableVector2d","kind":"canonical"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"WWq4HO9xGs0x1S_nP8Vg1","name":"setMuted","brief":"","scope":"instance","type":"MethodDoc","description":"set the vector value without triggering the callback
","params":[{"identifier":"x","optional":false,"description":"x value of the vector
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"y value of the vector
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"ObservableVector2d","kind":"canonical"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"biGhyszRvuX73FpORGIfg","name":"setV","brief":"","scope":"instance","type":"MethodDoc","description":"set the Vector x and y properties using the passed vector
","params":[{"identifier":"v","optional":false,"dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"ZwLFHuSZtm5Zi1_CqRcOZ","name":"setZero","brief":"","scope":"instance","type":"MethodDoc","description":"set the Vector x and y properties to 0
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"qmAYcoHvuBGRYhA7bUjf4","name":"sub","brief":"","scope":"instance","type":"MethodDoc","description":"Substract the passed vector to this vector
","params":[{"identifier":"v","optional":false,"dataType":{"tokens":[{"value":"ObservableVector2d","kind":"canonical"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"ObservableVector2d","kind":"canonical"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"JibOK0cl3gwrH4Io9lCRv","name":"to2d","brief":"","scope":"instance","type":"MethodDoc","description":"Convert this vector into 2d coordinate space
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"EwSfjUyyL9Ji6aMv2Cg9v","name":"toIso","brief":"","scope":"instance","type":"MethodDoc","description":"Convert this vector into isometric coordinate space
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"MeW5lixKfSXS6MiPUmV1L","name":"toString","brief":"","scope":"instance","type":"MethodDoc","description":"convert the object to a string representation
","params":[],"returns":[{"dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"extends":[],"implements":[]},{"id":"ruv4ngQDWxTZKb31FWspb","name":"toVector2d","brief":"","scope":"instance","type":"MethodDoc","description":"return a me.Vector2d copy of this me.ObservableVector2d object
","params":[],"returns":[{"description":"new me.Vector2d
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]}]},{"id":"UasLX_GAoSyUa_IfAYzYr","name":"ObservableVector3d","brief":"","type":"ClassDoc","description":"A Vector3d object that provide notification by executing the given callback when the vector is changed.
","params":[],"returns":[],"extends":["Vector3d"],"implements":[],"members":[{"id":"62vgQIDNFKfK6CfEld5Mj","name":"x","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"x value of the vector
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"OeBstCkMCbuc12sqqcYq3","name":"y","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"y value of the vector
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Wpkmd8zdJ1yZ0ppbblDOo","name":"z","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"z value of the vector
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"xbla14G8LQ1lSsIFPKZeM","name":"abs","brief":"","scope":"instance","type":"MethodDoc","description":"Update this vector values to absolute values
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"ObservableVector3d","kind":"canonical"},{"value":"ObservableVector3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"jZG8UCs64DQZ_PO_xUuSc","name":"add","brief":"","scope":"instance","type":"MethodDoc","description":"Add the passed vector to this vector
","params":[{"identifier":"v","optional":false,"dataType":{"tokens":[{"value":"Vector2d | Vector3d | ObservableVector2d | ObservableVector3d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"},{"value":"ObservableVector2d","kind":"link"},{"value":"ObservableVector3d","kind":"link"}],"template":"%1 | %2 | %3 | %4"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"ObservableVector3d","kind":"canonical"},{"value":"ObservableVector3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Y3-Jz7g9fLTEWLM8Onej5","name":"angle","brief":"","scope":"instance","type":"MethodDoc","description":"return the angle between this vector and the passed one
","params":[{"identifier":"v","optional":false,"dataType":{"tokens":[{"value":"Vector2d | Vector3d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"angle in radians
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"PEbhQEIC4czjGfbEVAo05","name":"ceil","brief":"","scope":"instance","type":"MethodDoc","description":"Ceil the vector values
","params":[],"returns":[{"description":"new me.ObservableVector3d
","dataType":{"tokens":[{"value":"ObservableVector3d","kind":"canonical"},{"value":"ObservableVector3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"RCjb-9wHA9mUuHvtwbZ4x","name":"ceilSelf","brief":"","scope":"instance","type":"MethodDoc","description":"Ceil this vector values
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"ObservableVector3d","kind":"canonical"},{"value":"ObservableVector3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"9VkBsh769Kuo__sGXmuwp","name":"clamp","brief":"","scope":"instance","type":"MethodDoc","description":"Clamp the vector value within the specified value range
","params":[{"identifier":"low","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"high","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"new me.ObservableVector3d
","dataType":{"tokens":[{"value":"ObservableVector3d","kind":"canonical"},{"value":"ObservableVector3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"B715GtECqUz3gaJXoMYXP","name":"clampSelf","brief":"","scope":"instance","type":"MethodDoc","description":"Clamp this vector value within the specified value range
","params":[{"identifier":"low","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"high","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"ObservableVector3d","kind":"canonical"},{"value":"ObservableVector3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"BjD2ciC6Fa-sJ38sC_l0J","name":"clone","brief":"","scope":"instance","type":"MethodDoc","description":"return a clone copy of this vector
","params":[],"returns":[{"description":"new me.ObservableVector3d
","dataType":{"tokens":[{"value":"ObservableVector3d","kind":"canonical"},{"value":"ObservableVector3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"H3-2YamT8zT2PW9ZpbU1e","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"x","optional":false,"default":"0","description":"x value of the vector
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"default":"0","description":"y value of the vector
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"z","optional":false,"default":"0","description":"z value of the vector
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings","optional":false,"description":"additional required parameters
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}},{"identifier":"settings.onUpdate","description":"the callback to be executed when the vector is changed
","dataType":{"tokens":[{"value":"Function","kind":"canonical"}],"template":"Function"}},{"identifier":"settings.scope","optional":true,"description":"the value to use as this when calling onUpdate
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}}],"returns":[],"extends":[],"implements":[]},{"id":"7en9DnPAfCIUddGDROGMQ","name":"copy","brief":"","scope":"instance","type":"MethodDoc","description":"Copy the components of the given vector into this one
","params":[{"identifier":"v","optional":false,"dataType":{"tokens":[{"value":"Vector2d | Vector3d | ObservableVector2d | ObservableVector3d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"},{"value":"ObservableVector2d","kind":"link"},{"value":"ObservableVector3d","kind":"link"}],"template":"%1 | %2 | %3 | %4"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"ObservableVector3d","kind":"canonical"},{"value":"ObservableVector3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"jzty4yjPAZHGIt_81AWUY","name":"cross","brief":"","scope":"instance","type":"MethodDoc","description":"calculate the cross product of this vector and the passed one
","params":[{"identifier":"v","optional":false,"dataType":{"tokens":[{"value":"Vector3d | ObservableVector3d","kind":"canonical"},{"value":"Vector3d","kind":"link"},{"value":"ObservableVector3d","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"ObservableVector3d","kind":"canonical"},{"value":"ObservableVector3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"rf2fwtaVNygu6pIK-mVQn","name":"distance","brief":"","scope":"instance","type":"MethodDoc","description":"return the distance between this vector and the passed one
","params":[{"identifier":"v","optional":false,"dataType":{"tokens":[{"value":"Vector2d | Vector3d | ObservableVector2d | ObservableVector3d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"},{"value":"ObservableVector2d","kind":"link"},{"value":"ObservableVector3d","kind":"link"}],"template":"%1 | %2 | %3 | %4"}}],"returns":[{"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"xOVpTSYmwMlc99LLUCVzY","name":"div","brief":"","scope":"instance","type":"MethodDoc","description":"Divide this vector values by the passed value
","params":[{"identifier":"n","optional":false,"description":"the value to divide the vector by
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"ObservableVector3d","kind":"canonical"},{"value":"ObservableVector3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"CHj0hAvzTNHF0UsegdR6Y","name":"dot","brief":"","scope":"instance","type":"MethodDoc","description":"return the dot product of this vector and the passed one
","params":[{"identifier":"v","optional":false,"dataType":{"tokens":[{"value":"Vector2d | Vector3d | ObservableVector2d | ObservableVector3d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"},{"value":"ObservableVector2d","kind":"link"},{"value":"ObservableVector3d","kind":"link"}],"template":"%1 | %2 | %3 | %4"}}],"returns":[{"description":"The dot product.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"s7PgOusTzOdfBrkM0DSxb","name":"equals","brief":"","scope":"instance","type":"MethodDoc","description":"return true if the two vectors are the same
","params":[{"identifier":"v","optional":false,"dataType":{"tokens":[{"value":"Vector2d | Vector3d | ObservableVector2d | ObservableVector3d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"},{"value":"ObservableVector2d","kind":"link"},{"value":"ObservableVector3d","kind":"link"}],"template":"%1 | %2 | %3 | %4"}}],"returns":[{"dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"i9_wPx4Vrg-yuhM2wdxxI","name":"floor","brief":"","scope":"instance","type":"MethodDoc","description":"Floor the vector values
","params":[],"returns":[{"description":"new me.ObservableVector3d
","dataType":{"tokens":[{"value":"ObservableVector3d","kind":"canonical"},{"value":"ObservableVector3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"uCwRP_FBdSJccQPHJw3fW","name":"floorSelf","brief":"","scope":"instance","type":"MethodDoc","description":"Floor this vector values
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"ObservableVector3d","kind":"canonical"},{"value":"ObservableVector3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"YJaZWVTnWSZj_Itr9gLE8","name":"length","brief":"","scope":"instance","type":"MethodDoc","description":"return the length (magnitude) of this vector
","params":[],"returns":[{"description":"the length of this vector
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"mU8lJz7a88MhHA0KXdF_H","name":"length2","brief":"","scope":"instance","type":"MethodDoc","description":"return the square length of this vector
","params":[],"returns":[{"description":"The length^2 of this vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Z2oSP7sWVTho7EXReFUDO","name":"lerp","brief":"","scope":"instance","type":"MethodDoc","description":"Linearly interpolate between this vector and the given one.
","params":[{"identifier":"v","optional":false,"dataType":{"tokens":[{"value":"Vector3d | ObservableVector3d","kind":"canonical"},{"value":"Vector3d","kind":"link"},{"value":"ObservableVector3d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"alpha","optional":false,"description":"distance along the line (alpha = 0 will be this vector, and alpha = 1 will be the given one).
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"ObservableVector3d","kind":"canonical"},{"value":"ObservableVector3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"y4lhIaNEfOWosTASpDkUL","name":"maxV","brief":"","scope":"instance","type":"MethodDoc","description":"Update this vector with the maximum value between this and the passed vector
","params":[{"identifier":"v","optional":false,"dataType":{"tokens":[{"value":"Vector2d | Vector3d | ObservableVector2d | ObservableVector3d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"},{"value":"ObservableVector2d","kind":"link"},{"value":"ObservableVector3d","kind":"link"}],"template":"%1 | %2 | %3 | %4"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"ObservableVector3d","kind":"canonical"},{"value":"ObservableVector3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"wEm3m_BvRkUpGgu-QYKFn","name":"minV","brief":"","scope":"instance","type":"MethodDoc","description":"Update this vector with the minimum value between this and the passed vector
","params":[{"identifier":"v","optional":false,"dataType":{"tokens":[{"value":"Vector2d | Vector3d | ObservableVector2d | ObservableVector3d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"},{"value":"ObservableVector2d","kind":"link"},{"value":"ObservableVector3d","kind":"link"}],"template":"%1 | %2 | %3 | %4"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"ObservableVector3d","kind":"canonical"},{"value":"ObservableVector3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"mUQ0yy7SRLj-rKwc3-dt_","name":"moveTowards","brief":"","scope":"instance","type":"MethodDoc","description":"interpolate the position of this vector on the x and y axis towards the given one while ensure that the distance never exc...","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Vector2d | ObservableVector2d | Vector3d | ObservableVector3d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"ObservableVector2d","kind":"link"},{"value":"Vector3d","kind":"link"},{"value":"ObservableVector3d","kind":"link"}],"template":"%1 | %2 | %3 | %4"}},{"identifier":"step","optional":false,"description":"
the maximum step per iteration (Negative values will push the vector away from the target)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"ObservableVector3d","kind":"canonical"},{"value":"ObservableVector3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"GzV-ffF5yawThdoro_RbN","name":"negate","brief":"","scope":"instance","type":"MethodDoc","description":"Negate the vector values
","params":[],"returns":[{"description":"new me.ObservableVector3d
","dataType":{"tokens":[{"value":"ObservableVector3d","kind":"canonical"},{"value":"ObservableVector3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Luo3Og3sblyyTiubtinwm","name":"negateSelf","brief":"","scope":"instance","type":"MethodDoc","description":"Negate this vector values
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"ObservableVector3d","kind":"canonical"},{"value":"ObservableVector3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"c9xfujxGx45RFAFwBo7kF","name":"normalize","brief":"","scope":"instance","type":"MethodDoc","description":"normalize this vector (scale the vector so that its magnitude is 1)
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Vector3d","kind":"canonical"},{"value":"Vector3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"yAErUW0xPeujhbNC_ve-R","name":"perp","brief":"","scope":"instance","type":"MethodDoc","description":"change this vector to be perpendicular to what it was before.
Reference to this object for method chaining
","dataType":{"tokens":[{"value":"ObservableVector3d","kind":"canonical"},{"value":"ObservableVector3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"oXV84T6waApNj4mRzA-Zh","name":"project","brief":"","scope":"instance","type":"MethodDoc","description":"project this vector on to another vector.
","params":[{"identifier":"v","optional":false,"description":"The vector to project onto.
","dataType":{"tokens":[{"value":"Vector2d | Vector3d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Vector3d","kind":"canonical"},{"value":"Vector3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"mxTncgs6PbXRW82uVmN90","name":"projectN","brief":"","scope":"instance","type":"MethodDoc","description":"Project this vector onto a vector of unit length.project when deali...","params":[{"identifier":"v","optional":false,"description":"
The unit vector to project onto.
","dataType":{"tokens":[{"value":"Vector2d | Vector3d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Vector3d","kind":"canonical"},{"value":"Vector3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"oBj9ZI7UZx6j7b28FgezS","name":"rotate","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this vector (counter-clockwise) by the specified angle (in radians).
","params":[{"identifier":"angle","optional":false,"description":"The angle to rotate (in radians)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":true,"description":"an optional point to rotate around (on the same z axis)
","dataType":{"tokens":[{"value":"Vector2d | ObservableVector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"ObservableVector3d","kind":"canonical"},{"value":"ObservableVector3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"RM58N7BUMjKDScA0bL7-M","name":"scale","brief":"","scope":"instance","type":"MethodDoc","description":"Multiply this vector values by the given scalar
","params":[{"identifier":"x","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":true,"default":"x","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"z","optional":true,"default":"1","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"ObservableVector3d","kind":"canonical"},{"value":"ObservableVector3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"nUE8LThbAm80qr_uDv2uU","name":"scaleV","brief":"","scope":"instance","type":"MethodDoc","description":"Multiply this vector values by the passed vector
","params":[{"identifier":"v","optional":false,"dataType":{"tokens":[{"value":"Vector2d | Vector3d | ObservableVector2d | ObservableVector3d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"},{"value":"ObservableVector2d","kind":"link"},{"value":"ObservableVector3d","kind":"link"}],"template":"%1 | %2 | %3 | %4"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"ObservableVector3d","kind":"canonical"},{"value":"ObservableVector3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"YLMTWX7C_p08jW-acB91S","name":"set","brief":"","scope":"instance","type":"MethodDoc","description":"set the Vector x and y properties to the given values
","params":[{"identifier":"x","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"z","optional":true,"default":"0","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Vector3d","kind":"canonical"},{"value":"Vector3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"R3lM0o5ghOO4-OkQTiwlH","name":"setCallback","brief":"","scope":"instance","type":"MethodDoc","description":"set the callback to be executed when the vector is changed
","params":[{"identifier":"fn","optional":false,"description":"callback
","dataType":{"tokens":[{"value":"Function","kind":"canonical"}],"template":"Function"}},{"identifier":"scope","optional":true,"default":"null","description":"scope
","dataType":{"tokens":[{"value":"Function","kind":"canonical"}],"template":"Function"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"ObservableVector3d","kind":"canonical"},{"value":"ObservableVector3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"d-TlQeLj5-KTsi7JbdUs5","name":"setMuted","brief":"","scope":"instance","type":"MethodDoc","description":"set the vector value without triggering the callback
","params":[{"identifier":"x","optional":false,"description":"x value of the vector
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"y value of the vector
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"z","optional":true,"default":"0","description":"z value of the vector
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"ObservableVector3d","kind":"canonical"},{"value":"ObservableVector3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"yRTePQo69MsGFirYL0oTD","name":"setV","brief":"","scope":"instance","type":"MethodDoc","description":"set the Vector x and y properties using the passed vector
","params":[{"identifier":"v","optional":false,"dataType":{"tokens":[{"value":"Vector2d | Vector3d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Vector3d","kind":"canonical"},{"value":"Vector3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"dU0vYI_DVAybhPPywTxNl","name":"setZero","brief":"","scope":"instance","type":"MethodDoc","description":"set the Vector x and y properties to 0
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Vector3d","kind":"canonical"},{"value":"Vector3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"veowk8lN-nIrvtsme3F0p","name":"sub","brief":"","scope":"instance","type":"MethodDoc","description":"Substract the passed vector to this vector
","params":[{"identifier":"v","optional":false,"dataType":{"tokens":[{"value":"Vector2d | Vector3d | ObservableVector2d | ObservableVector3d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"},{"value":"ObservableVector2d","kind":"link"},{"value":"ObservableVector3d","kind":"link"}],"template":"%1 | %2 | %3 | %4"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"ObservableVector3d","kind":"canonical"},{"value":"ObservableVector3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"nKXgyws0L158DkV9gBt8J","name":"to2d","brief":"","scope":"instance","type":"MethodDoc","description":"Convert this vector into 2d coordinate space
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Vector3d","kind":"canonical"},{"value":"Vector3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"wJo-McCdWzk7IdrC4v0ej","name":"toIso","brief":"","scope":"instance","type":"MethodDoc","description":"Convert this vector into isometric coordinate space
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Vector3d","kind":"canonical"},{"value":"Vector3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"vsU0HsFJMWFJ1SQzu6aRE","name":"toString","brief":"","scope":"instance","type":"MethodDoc","description":"convert the object to a string representation
","params":[],"returns":[{"dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"extends":[],"implements":[]},{"id":"IqZXTHOf5wyAe81cizHel","name":"toVector3d","brief":"","scope":"instance","type":"MethodDoc","description":"return a me.Vector3d copy of this me.ObservableVector3d object
","params":[],"returns":[{"description":"new me.Vector3d
","dataType":{"tokens":[{"value":"Vector3d","kind":"canonical"},{"value":"Vector3d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]}]},{"id":"qWjyM-dbCj7s7ZutUNqlt","name":"Particle","brief":"","type":"ClassDoc","description":"Single Particle Object.
","params":[],"returns":[],"extends":["Renderable"],"implements":[],"members":[{"id":"J5rW7FGIWFWg-oMR0damv","name":"alpha","brief":"","defaultValue":"1.0","scope":"instance","see":["Renderable#setOpacity","Renderable#getOpacity"],"type":"PropertyDoc","description":"Define the renderable opacity
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ktAQobn7eT9FJrEe9yjn5","name":"alwaysUpdate","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object will always update, even when outside of the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"71Gh3NKX9UxHAfd7-sgPb","name":"ancestor","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"a reference to the parent object that contains this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ydsHTz1Ql1BbRwEMXN4CD","name":"anchorPoint","brief":"","defaultValue":"<0.5,0.5>","scope":"instance","type":"PropertyDoc","description":"The anchor point is used for attachment behavior, and/or when applying transformations.
When enabled, an object container will automatically apply\nany defined transformation before calling the child draw method...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ENd48omp4vEf6XWedN9zj","name":"blendMode","brief":"","defaultValue":"\"normal\"","scope":"instance","see":["CanvasRenderer#setBlendMode","WebGLRenderer#setBlendMode"],"type":"PropertyDoc","description":"
the blend mode to be applied to this renderable (see renderer setBlendMode for available blend mode)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"iUuxUHg-PPFMfqoOPJPI0","name":"body","brief":"","examples":[{"caption":"","code":" // define a new Player Class\n class PlayerEntity extends me.Sprite {\n // constructor\n constructor(x, y, settings) {\n // call the parent constructor\n super(x, y , settings);\n\n // define a basic walking animation\n this.addAnimation(\"walk\", [...]);\n // define a standing animation (using the first frame)\n this.addAnimation(\"stand\", [...]);\n // set the standing animation as default\n this.setCurrentAnimation(\"stand\");\n\n // add a physic body\n this.body = new me.Body(this);\n // add a default collision shape\n this.body.addShape(new me.Rect(0, 0, this.width, this.height));\n // configure max speed, friction, and initial force to be applied\n this.body.setMaxVelocity(3, 15);\n this.body.setFriction(0.4, 0);\n this.body.force.set(3, 0);\n this.isKinematic = false;\n\n // set the display to follow our position on both axis\n me.game.viewport.follow(this.pos, me.game.viewport.AXIS.BOTH);\n }\n\n ...\n\n }"}],"scope":"instance","type":"PropertyDoc","description":"the renderable physic body
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"4shb4sgKOfYHlo4MIw8GV","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"lKLN_6RK1er3m0lqjDFEm","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ZLpAYMOcj-415Ftpoi56w","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"XwUrhySGJzHIPuhnvbaEV","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Wq1_9ghmzVcBYgTJ6rGST","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"91s30bb2He625h9ESgMxE","name":"floating","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"If true, this renderable will be rendered using screen coordinates,\nas opposed to world coordinates. Use this, for example...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"jvyGA4zPV_oM9VmN2gS-S","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"
(G)ame (U)nique (Id)entifier"
height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"b9Ojx0C_Pkausr66vguh3","name":"inViewport","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object is visible and within the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"oJ3grnFHh_JIRbNKl8XYl","name":"isDirty","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"when true the renderable will be redrawn during the next update cycle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ovJhT7xrWuadl7aktBaVI","name":"isFlippedX","brief":"","access":"public","scope":"instance","see":["Renderable#flipX"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"TK4--yDFAeqZ1fhi-c4Kr","name":"isFlippedY","brief":"","access":"public","scope":"instance","see":["Renderable#flipY"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"OfWqQyeegK7K3NMjv5CeJ","name":"isFloating","brief":"","scope":"instance","see":["Renderable#floating"],"type":"PropertyDoc","description":"Whether the renderable object is floating (i.e. used screen coordinates), or contained in a floating parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"A5LaIEvE71AnHRVtsAo6-","name":"isKinematic","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"If true then physic collision and input events will not impact this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"7_gKpVBQ6l-OL_pHkJY5C","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"OgBvYK7sf3X1asexyGCf-","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"CqmldmmYpONPPSQM0Ygqh","name":"mask","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"// apply a mask in the shape of a Star\nmyNPCSprite.mask = new me.Polygon(myNPCSprite.width / 2, 0, [\n // draw a star\n {x: 0, y: 0},\n {x: 14, y: 30},\n {x: 47, y: 35},\n {x: 23, y: 57},\n {x: 44, y: 90},\n {x: 0, y: 62},\n {x: -44, y: 90},\n {x: -23, y: 57},\n {x: -47, y: 35},\n {x: -14, y: 30}\n]);"}],"scope":"instance","type":"PropertyDoc","description":"A mask limits rendering elements to the shape and position of the given mask object.\nSo, if the renderable is larger than ...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"_guATLmwso6Cp7-cOkGNK","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"AtDYEW4Ga9oN_-904tCuL","name":"onVisibilityChange","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"this.onVisibilityChange = function(inViewport) {\n if (inViewport === true) {\n console.log(\"object has entered the in a camera viewport!\");\n }\n};"}],"scope":"instance","type":"PropertyDoc","description":"an event handler that is called when the renderable leave or enter a camera viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"L79FYsjM7g2MHJQTXjspe","name":"parentApp","brief":"","scope":"instance","type":"PropertyDoc","description":"returns the parent application (or game) to which this renderable is attached to
","params":[],"returns":[{"description":"the parent application or undefined if not attached to any container/app
","dataType":{"tokens":[{"value":"Application","kind":"canonical"},{"value":"Application","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"x_OnOjmHr0R5v0E5YxhSw","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Ysw1BkrmF6iG6gHWW4Lg5","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"m6XRgFkA76a5ugYQ0mbiu","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"wqzmRRFz3AZYTQcIL4cDv","name":"shader","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"(Experimental) an optional shader, to be used instead of the default built-in one, when drawing this renderable (WebGL onl...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"YUGCyttBfGxkrCwUubT8L","name":"tint","brief":"","defaultValue":"(255, 255, 255)","examples":[{"caption":"","code":"// add a red tint to this renderable\nthis.tint.setColor(255, 128, 128);\n// remove the tint\nthis.tint.setColor(255, 255, 255);"}],"scope":"instance","type":"PropertyDoc","description":"
define a tint for this renderable. a (255, 255, 255) r, g, b value will remove the tint effect.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Ah_mihErdFwwDpGlROAC8","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"af_iMkhnUyOiVWHIsbEG5","name":"type","brief":"","defaultValue":"\"Rectangle\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"6CqypZ2Y9OUac0jUG8qEb","name":"updateWhenPaused","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether to update this object when the game is paused.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"kVN6WxQSu-72qWVXzCc_v","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"OJn-J7wx19UcORq-tWrew","name":"angleTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the angle to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"angle in radians
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"915zPql2DY5ugwfPmmD33","name":"centerOn","brief":"","scope":"instance","type":"MethodDoc","description":"center the rectangle position around the given coordinates
","params":[{"identifier":"x","optional":false,"description":"the x coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"U_BOVrq5TV9n21ZEQnIbf","name":"clone","brief":"","scope":"instance","type":"MethodDoc","description":"clone this rectangle
","params":[],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"0tEU8iyqwPQtItzX4_weR","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"emitter","optional":false,"description":"the particle emitter
","dataType":{"tokens":[{"value":"ParticleEmitter","kind":"canonical"},{"value":"ParticleEmitter","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"jlwAbSNfRf_Lpywz93yPx","name":"contains","brief":"","examples":[{"caption":"","code":"if (rect.contains(10, 10)) {\n // do something\n}\n// or\nif (rect.contains(myVector2d)) {\n // do something\n}\nif (rect.contains(myRect)) {\n // do something\n}"}],"scope":"instance","type":"MethodDoc","description":"Returns true if the rectangle contains the given point or rectangle
","params":[{"identifier":"x","description":"x coordinate or a vector point, or a rectangle to test
","dataType":{"tokens":[{"value":"number | Vector2d | Rect","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Rect","kind":"link"}],"template":"%1 | %2 | %3"}},{"identifier":"y","optional":true,"description":"y coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"True if the rectangle contain the given point or rectangle, otherwise false
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"3uVpPbn9Ka5RaNqnxtfcY","name":"copy","brief":"","scope":"instance","type":"MethodDoc","description":"copy the position and size of the given rectangle into this one
","params":[{"identifier":"rect","optional":false,"description":"Source rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"ICq_xCSNBtlc3v9aa8xyt","name":"distanceTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the distance to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"distance
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"DCw3ylht7RYMjoQ-vIOHA","name":"draw","brief":"","scope":"instance","see":["Renderable#preDraw","Renderable#postDraw"],"type":"MethodDoc","description":"Draw this renderable (automatically called by melonJS).\nAll draw operations for renderable are made respectively\nto the po...","params":[{"identifier":"renderer","optional":false,"description":"
a renderer instance
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}},{"identifier":"viewport","optional":true,"description":"the viewport to (re)draw
","dataType":{"tokens":[{"value":"Camera2d","kind":"canonical"},{"value":"Camera2d","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"htH5mfi69kXxp9iGYRquk","name":"equals","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is identical to the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if equals
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"SPDYxPvEka2TZuECrdEiN","name":"flipX","brief":"","scope":"instance","see":["Matrix2d#scaleX"],"type":"MethodDoc","description":"flip the renderable on the horizontal axis (around the center of the renderable)
","params":[{"identifier":"flip","optional":true,"default":"true","description":"true to flip this renderable.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"GrFihhJ6j0Mn0Z6XhO1Q4","name":"flipY","brief":"","scope":"instance","see":["Matrix2d#scaleY"],"type":"MethodDoc","description":"flip the renderable on the vertical axis (around the center of the renderable)
","params":[{"identifier":"flip","optional":true,"default":"true","description":"true to flip this renderable.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"iIceEj519v-wnQ1pkB_VZ","name":"getAbsolutePosition","brief":"","scope":"instance","type":"MethodDoc","description":"return the renderable absolute position in the game world
","params":[],"returns":[{"dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Pm7Nth4nSpElLgqXfqsuO","name":"getBounds","brief":"","scope":"instance","type":"MethodDoc","description":"returns the bounding box for this renderable
","params":[],"returns":[{"description":"bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"WeuGYSq5VFqsKqZWI4m1S","name":"getIndices","brief":"","scope":"instance","type":"MethodDoc","description":"returns a list of indices for all triangles defined in this polygon
","params":[],"returns":[{"description":"an array of vertex indices for all triangles forming this polygon.
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1<%2>"}}],"extends":[],"implements":[]},{"id":"3-U-zyDarPvKrVFFQ1H1m","name":"getOpacity","brief":"","scope":"instance","type":"MethodDoc","description":"get the renderable alpha channel value
","params":[],"returns":[{"description":"current opacity value between 0 and 1
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"iSoUbfxdMF2zZ0Ly2LXNQ","name":"isConvex","brief":"","scope":"instance","type":"MethodDoc","description":"Returns true if the vertices composing this polygon form a convex shape (vertices must be in clockwise order).
","params":[],"returns":[{"description":"true if the vertices are convex, false if not, null if not computable
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"nqm6xRLAAm_11hix5M5NA","name":"isFinite","brief":"","scope":"instance","type":"MethodDoc","description":"determines whether all coordinates of this rectangle are finite numbers.
","params":[],"returns":[{"description":"false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"2ANrv50U-J-VH5Ss438Dz","name":"lookAt","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this renderable towards the given target.
","params":[{"identifier":"target","optional":false,"description":"the renderable or position to look at
","dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Cvbp0Yv9voj7OAhm8-4Z4","name":"onCollision","brief":"","examples":[{"caption":"","code":"// colision handler\nonCollision(response) {\n if (response.b.body.collisionType === me.collision.types.ENEMY_OBJECT) {\n // makes the other object solid, by substracting the overlap vector to the current position\n this.pos.sub(response.overlapV);\n this.hurt();\n // not solid\n return false;\n }\n // Make the object solid\n return true;\n},"}],"scope":"instance","type":"MethodDoc","description":"onCollision callback, triggered in case of collision,\nwhen this renderable body is colliding with another one
","params":[{"identifier":"response","optional":false,"description":"the collision response object
","dataType":{"tokens":[{"value":"ResponseObject","kind":"canonical"},{"value":"ResponseObject","kind":"link"}],"template":"%1"}},{"identifier":"other","optional":false,"description":"the other renderable touching this one (a reference to response.a or response.b)
","dataType":{"tokens":[{"value":"Renderable | Container | Entity | Sprite | NineSliceSprite","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Container","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"NineSliceSprite","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5"}}],"returns":[{"description":"true if the object should respond to the collision (its position and velocity will be corrected)
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"WrGFy_pLPLqP-P4c66RFQ","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"OnDestroy Notification function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"8VHGO69H5d1ezlQPhwLcW","name":"overlaps","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is intersecting with the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if overlaps
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"jQX8R2UN87M-VTMwE4l36","name":"postDraw","brief":"","scope":"instance","see":["Renderable#preDraw","Renderable#draw"],"type":"MethodDoc","description":"restore the rendering context after drawing (automatically called by melonJS).
","params":[{"identifier":"renderer","optional":false,"description":"a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"YEpo5r3gXjDqB7tJ8JExK","name":"preDraw","brief":"","scope":"instance","see":["Renderable#draw","Renderable#postDraw"],"type":"MethodDoc","description":"Prepare the rendering context before drawing (automatically called by melonJS).\nThis will apply any defined transforms, an...","params":[{"identifier":"renderer","optional":false,"description":"
a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"xNPyu_BrgMZ8iJFsiHWk6","name":"recalc","brief":"","scope":"instance","type":"MethodDoc","description":"Computes the calculated collision polygon.\nThis must be called if the points array, an...","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"aLPP6YxSrFbuXOCmQ74ST","name":"resize","brief":"","scope":"instance","type":"MethodDoc","description":"resize the rectangle
","params":[{"identifier":"w","optional":false,"description":"new width of the rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"h","optional":false,"description":"new height of the rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"2TPLKZOO5TZ17_b97mRlL","name":"rotate","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this renderable by the specified angle (in radians).
","params":[{"identifier":"angle","optional":false,"description":"The angle to rotate (in radians)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":true,"description":"an optional point to rotate around
","dataType":{"tokens":[{"value":"Vector2d | ObservableVector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"pIitYp5JvCRJMnkHkigHc","name":"scale","brief":"","scope":"instance","type":"MethodDoc","description":"scale the renderable around his anchor point. Scaling actually applies changes\nto the currentTransform member wich is use...","params":[{"identifier":"x","optional":false,"description":"
a number representing the abscissa of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":true,"default":"x","description":"a number representing the ordinate of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Sdhtut_kMPP0yUV_LOGGj","name":"scaleV","brief":"","scope":"instance","type":"MethodDoc","description":"scale the renderable around his anchor point
","params":[{"identifier":"v","optional":false,"description":"scaling vector
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"b7PGTNOyWbUXQHmSKObdp","name":"setOpacity","brief":"","scope":"instance","type":"MethodDoc","description":"set the renderable alpha channel value
","params":[{"identifier":"alpha","optional":false,"description":"opacity value between 0.0 and 1.0
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"sxozwP6dzbXMobBpluEfG","name":"setShape","brief":"","scope":"instance","type":"MethodDoc","description":"set new value to the rectangle shape
","params":[{"identifier":"x","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"w","optional":false,"description":"width of the rectangle, or an array of vector defining the rectangle
","dataType":{"tokens":[{"value":"number | Array","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %3<%2>"}},{"identifier":"h","optional":true,"description":"height of the rectangle, if a numeral width parameter is specified
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"bFdU2fPWW7aav2gBCK38V","name":"setVertices","brief":"","scope":"instance","type":"MethodDoc","description":"set the vertices defining this Polygon
","params":[{"identifier":"vertices","optional":false,"description":"array of vector or vertice defining the Polygon
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1<%2>"}}],"returns":[{"description":"this instance for objecf chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"o8S5OQBMm12uHIjSIY083","name":"shift","brief":"","examples":[{"caption":"","code":"polygon.shift(10, 10);\n// or\npolygon.shift(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"Shifts the Polygon to the given position vector.
","params":[{"identifier":"x","description":"x coordinate or a vector point to shift to
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"fomp4t9XJAfNSs8WeHhJx","name":"to2d","brief":"","scope":"instance","type":"MethodDoc","description":"apply a 2d projection to this shapen
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"0eBrDejkhrTu-5pRq5jLy","name":"toIso","brief":"","scope":"instance","type":"MethodDoc","description":"apply an isometric projection to this shape
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"iKpto-zursDCI-pTABI0t","name":"toPolygon","brief":"","scope":"instance","type":"MethodDoc","description":"Returns a polygon whose edges are the same as this box.
","params":[],"returns":[{"description":"a new Polygon that represents this rectangle.
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"KCFDIvpTlkq48CJk3vA2i","name":"transform","brief":"","scope":"instance","see":["Renderable#currentTransform"],"type":"MethodDoc","description":"multiply the renderable currentTransform with the given matrix
","params":[{"identifier":"m","optional":false,"description":"the transformation matrix
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"gi3HDCfoZ1e-gcQrafVoL","name":"translate","brief":"","examples":[{"caption":"","code":"polygon.translate(10, 10);\n// or\npolygon.translate(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"translate the Polygon by the specified offset
","params":[{"identifier":"x","description":"x offset or a vector point to translate by
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"description":"y offset
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"dDAnp3IG3qNoCVClWyCV5","name":"union","brief":"","scope":"instance","type":"MethodDoc","description":"merge this rectangle with another one
","params":[{"identifier":"rect","optional":false,"description":"other rectangle to union with
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"the union(ed) rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"8IDHGqDnNrnLBT8LS18Hi","name":"update","brief":"","scope":"instance","type":"MethodDoc","description":"update function (automatically called by melonJS).
","params":[{"identifier":"dt","optional":false,"description":"time since the last update in milliseconds.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"true if the renderable is dirty
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"Qgy_TYZ1Kc-6tMoaToEql","name":"updateBounds","brief":"","scope":"instance","type":"MethodDoc","description":"update the bounding box for this shape.
","params":[{"identifier":"absolute","optional":true,"default":"true","description":"update the bounds size and position in (world) absolute coordinates
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"this shape bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Tk1y8UUO4mOGM-5yVjFUT","name":"onAnchorUpdate","brief":"","access":"private","scope":"instance","type":"MethodDoc","description":"called when the anchor point value is changed
","params":[{"identifier":"x","optional":false,"description":"the new X value to be set for the anchor
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the new Y value to be set for the anchor
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]}]},{"id":"lRuNcDJAvPqumRNaXturq","name":"ParticleEmitter","brief":"","type":"ClassDoc","description":"Particle Emitter Object.
","params":[],"returns":[],"extends":["Container"],"implements":[],"members":[{"id":"Zs9waEOktmZwoz1XzpQj6","name":"alpha","brief":"","defaultValue":"1.0","scope":"instance","see":["Renderable#setOpacity","Renderable#getOpacity"],"type":"PropertyDoc","description":"Define the renderable opacity
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"VXO_Hxe_wflw0nIE6STdP","name":"alwaysUpdate","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object will always update, even when outside of the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"nOKUmxkf87mf0VvNtJ6SN","name":"ancestor","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"a reference to the parent object that contains this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"-MMW7Sz_8vf13pta0Jzfk","name":"anchorPoint","brief":"","defaultValue":"<0.5,0.5>","scope":"instance","type":"PropertyDoc","description":"The anchor point is used for attachment behavior, and/or when applying transformations.
Specify if the children z index should automatically be managed by the parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"FDM-ZOwTkSmYCq2MaedSk","name":"autoSort","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"Specify if the children list should be automatically sorted when adding a new child
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"xF9BMU8YyeXbZIoOuTRCf","name":"autoTransform","brief":"","defaultValue":"true","examples":[{"caption":"","code":"// enable \"automatic\" transformation when the object is activated\nonActivateEvent: function () {\n // reset the transformation matrix\n this.currentTransform.identity();\n // ensure the anchor point is the renderable center\n this.anchorPoint.set(0.5, 0.5);\n // enable auto transform\n this.autoTransform = true;\n ....\n}"}],"scope":"instance","type":"PropertyDoc","description":"When enabled, an object container will automatically apply\nany defined transformation before calling the child draw method...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"8ymgTtMaQ3xtFd1p2TIjA","name":"backgroundColor","brief":"","defaultValue":"(0, 0, 0, 0.0)","examples":[{"caption":"","code":"// add a red background color to this container\nthis.backgroundColor.setColor(255, 0, 0);"}],"scope":"instance","type":"PropertyDoc","description":"
define a background color for this container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"wimMOL3TKDmfHLUgSsOKr","name":"blendMode","brief":"","defaultValue":"\"normal\"","scope":"instance","see":["CanvasRenderer#setBlendMode","WebGLRenderer#setBlendMode"],"type":"PropertyDoc","description":"the blend mode to be applied to this renderable (see renderer setBlendMode for available blend mode)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"zHA_O1gOjGRqkjGgGKy-l","name":"body","brief":"","examples":[{"caption":"","code":" // define a new Player Class\n class PlayerEntity extends me.Sprite {\n // constructor\n constructor(x, y, settings) {\n // call the parent constructor\n super(x, y , settings);\n\n // define a basic walking animation\n this.addAnimation(\"walk\", [...]);\n // define a standing animation (using the first frame)\n this.addAnimation(\"stand\", [...]);\n // set the standing animation as default\n this.setCurrentAnimation(\"stand\");\n\n // add a physic body\n this.body = new me.Body(this);\n // add a default collision shape\n this.body.addShape(new me.Rect(0, 0, this.width, this.height));\n // configure max speed, friction, and initial force to be applied\n this.body.setMaxVelocity(3, 15);\n this.body.setFriction(0.4, 0);\n this.body.force.set(3, 0);\n this.isKinematic = false;\n\n // set the display to follow our position on both axis\n me.game.viewport.follow(this.pos, me.game.viewport.AXIS.BOTH);\n }\n\n ...\n\n }"}],"scope":"instance","type":"PropertyDoc","description":"the renderable physic body
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"w281burWwDW4kIHWnxOnZ","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"GkdXwzE2Vm21ntzKeuBND","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"RAVTM5bulaN5SYq1535ws","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"xNOK7R0XiQ6k891JiJcg7","name":"clipping","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Specify if the container draw operation should clip his children to its own bounds
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"VwmU4Exl4rsd7iiqz2bc-","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"-jqfaHa7YcoYv4_PIsYRp","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"XnswJbDXkcIm65HPE9snq","name":"enableChildBoundsUpdate","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Specify if the container bounds should automatically take in account\nall child bounds when updated (this is expensive and ...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"PaX6Ie5GS2y0ezSBBp1Nd","name":"floating","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"
If true, this renderable will be rendered using screen coordinates,\nas opposed to world coordinates. Use this, for example...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"-9YeDihvP8lOXGsYZ_st_","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"
(G)ame (U)nique (Id)entifier"
height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"xrb6UkEH4NoDN_DeiZ2Sk","name":"inViewport","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object is visible and within the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"m2RTsTC_oIckYtlL9v8aG","name":"isDirty","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"when true the renderable will be redrawn during the next update cycle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"dQkoXU4JvnUSr7s21i7Aa","name":"isFlippedX","brief":"","access":"public","scope":"instance","see":["Renderable#flipX"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"M2Wp0L-cNgza89EzEW5jm","name":"isFlippedY","brief":"","access":"public","scope":"instance","see":["Renderable#flipY"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"-xGyaW5Tn3TrVKXSXRrda","name":"isFloating","brief":"","scope":"instance","see":["Renderable#floating"],"type":"PropertyDoc","description":"Whether the renderable object is floating (i.e. used screen coordinates), or contained in a floating parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"I-4GfT_h47O7lVi4GCT_3","name":"isKinematic","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"If true then physic collision and input events will not impact this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"FVNL3ngfeJtuPE_IRTmmJ","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"5NZOTQrVdN6FpLRi7ewYR","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"MvQPUm03-nqE6tmMi2cdr","name":"mask","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"// apply a mask in the shape of a Star\nmyNPCSprite.mask = new me.Polygon(myNPCSprite.width / 2, 0, [\n // draw a star\n {x: 0, y: 0},\n {x: 14, y: 30},\n {x: 47, y: 35},\n {x: 23, y: 57},\n {x: 44, y: 90},\n {x: 0, y: 62},\n {x: -44, y: 90},\n {x: -23, y: 57},\n {x: -47, y: 35},\n {x: -14, y: 30}\n]);"}],"scope":"instance","type":"PropertyDoc","description":"A mask limits rendering elements to the shape and position of the given mask object.\nSo, if the renderable is larger than ...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"vBOGm1JoBfoNalZmaiWB6","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"AswxzFc2JI3Crho7E9sCD","name":"onVisibilityChange","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"this.onVisibilityChange = function(inViewport) {\n if (inViewport === true) {\n console.log(\"object has entered the in a camera viewport!\");\n }\n};"}],"scope":"instance","type":"PropertyDoc","description":"an event handler that is called when the renderable leave or enter a camera viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"qUnhVcQURKXLxGHqyAvjE","name":"parentApp","brief":"","scope":"instance","type":"PropertyDoc","description":"returns the parent application (or game) to which this renderable is attached to
","params":[],"returns":[{"description":"the parent application or undefined if not attached to any container/app
","dataType":{"tokens":[{"value":"Application","kind":"canonical"},{"value":"Application","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"C0ZWJoNlVL87VW7Rji2rc","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"0UeEA1Hq1BSCkQY0X5rzx","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"v_FUtj7eXwc7lJgvkalfh","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"iYBcofZFFtdLRpj2O_mxG","name":"root","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"whether the container is the root of the scene
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"L5n-bZ2KbLeFC5KPxSJtR","name":"settings","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"the current (active) emitter settings
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"c_rPAU4soWt4vuhUvwopU","name":"shader","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"(Experimental) an optional shader, to be used instead of the default built-in one, when drawing this renderable (WebGL onl...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"I_J0Vxgl_qDPjG8CAAqV0","name":"sortOn","brief":"","defaultValue":"\"z\"","scope":"instance","type":"PropertyDoc","description":"
The property of the child object that should be used to sort on this container\nvalue : "x", "y", "...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"-E9S7PgIwdNHp12GIb3-M","name":"tint","brief":"","defaultValue":"(255, 255, 255)","examples":[{"caption":"","code":"// add a red tint to this renderable\nthis.tint.setColor(255, 128, 128);\n// remove the tint\nthis.tint.setColor(255, 255, 255);"}],"scope":"instance","type":"PropertyDoc","description":"
define a tint for this renderable. a (255, 255, 255) r, g, b value will remove the tint effect.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"tKcio0LqQLo9PUbAgv3Sw","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"HZrav1EmEBqNEVrKAY-yI","name":"type","brief":"","defaultValue":"\"Rectangle\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"CWrokQ1zqJ2SiUngvPrRW","name":"updateWhenPaused","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether to update this object when the game is paused.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"FJaDUTt075hLnQtCqj-4v","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"1i3RkjsrHRf9kF0wl8DrV","name":"addChild","brief":"","scope":"instance","type":"MethodDoc","description":"Add a child to the container
Child to be added
","dataType":{"tokens":[{"value":"Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"Collectable","kind":"link"},{"value":"Trigger","kind":"link"},{"value":"Draggable","kind":"link"},{"value":"DropTarget","kind":"link"},{"value":"NineSliceSprite","kind":"link"},{"value":"ImageLayer","kind":"link"},{"value":"ColorLayer","kind":"link"},{"value":"Light2d","kind":"link"},{"value":"UIBaseElement","kind":"link"},{"value":"UISpriteElement","kind":"link"},{"value":"UITextButton","kind":"link"},{"value":"Text","kind":"link"},{"value":"BitmapText","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5 | %6 | %7 | %8 | %9 | %10 | %11 | %12 | %13 | %14 | %15 | %16"}},{"identifier":"z","optional":true,"description":"forces the z index of the child to the specified value
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"the added child
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"TFrV4q_H5CFZPvxwXMcm3","name":"addChildAt","brief":"","scope":"instance","type":"MethodDoc","description":"Add a child to the container at the specified index
","params":[{"identifier":"child","optional":false,"description":"Child to be added
","dataType":{"tokens":[{"value":"Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"Collectable","kind":"link"},{"value":"Trigger","kind":"link"},{"value":"Draggable","kind":"link"},{"value":"DropTarget","kind":"link"},{"value":"NineSliceSprite","kind":"link"},{"value":"ImageLayer","kind":"link"},{"value":"ColorLayer","kind":"link"},{"value":"Light2d","kind":"link"},{"value":"UIBaseElement","kind":"link"},{"value":"UISpriteElement","kind":"link"},{"value":"UITextButton","kind":"link"},{"value":"Text","kind":"link"},{"value":"BitmapText","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5 | %6 | %7 | %8 | %9 | %10 | %11 | %12 | %13 | %14 | %15 | %16"}},{"identifier":"index","optional":false,"description":"The index at which to insert the child
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"the added child
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"YWFjqjPebSrFWZzAn21ft","name":"angleTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the angle to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"angle in radians
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"op_SWD7IX5lvX8scBbTa_","name":"burstParticles","brief":"","scope":"instance","type":"MethodDoc","description":"Launch all particles from emitter and stop (e.g. for explosion)
","params":[{"identifier":"total","optional":true,"description":"number of particles to launch
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"IcjqeruY77RGWXEjR8V9t","name":"centerOn","brief":"","scope":"instance","type":"MethodDoc","description":"center the rectangle position around the given coordinates
","params":[{"identifier":"x","optional":false,"description":"the x coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"a80tyvVFyuxKw1VG_5s_N","name":"clone","brief":"","scope":"instance","type":"MethodDoc","description":"clone this rectangle
","params":[],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"aWRUUbf4O-oLcguxd8IoF","name":"constructor","brief":"","examples":[{"caption":"","code":" // Create a particle emitter at position 100, 100\n let emitter = new ParticleEmitter(100, 100, {\n width: 16,\n height : 16,\n tint: \"#f00\",\n totalParticles: 32,\n angle: 0,\n angleVariation: 6.283185307179586,\n maxLife: 5,\n speed: 3\n });\n\n // Add the emitter to the game world\n me.game.world.addChild(emitter);\n\n // Launch all particles one time and stop, like a explosion\n emitter.burstParticles();\n\n // Launch constantly the particles, like a fountain\n emitter.streamParticles();\n\n // At the end, remove emitter from the game world\n // call this in onDestroyEvent function\n me.game.world.removeChild(emitter);"}],"scope":"instance","type":"MethodDoc","params":[{"identifier":"x","optional":false,"description":"x position of the particle emitter
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"y position of the particle emitter
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings","optional":true,"default":"ParticleEmitterSettings","description":"the settings for the particle emitter.
","dataType":{"tokens":[{"value":"ParticleEmitterSettings","kind":"canonical"},{"value":"ParticleEmitterSettings","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"du41fDBQDj5NzOuqBnsRq","name":"contains","brief":"","examples":[{"caption":"","code":"if (rect.contains(10, 10)) {\n // do something\n}\n// or\nif (rect.contains(myVector2d)) {\n // do something\n}\nif (rect.contains(myRect)) {\n // do something\n}"}],"scope":"instance","type":"MethodDoc","description":"Returns true if the rectangle contains the given point or rectangle
","params":[{"identifier":"x","description":"x coordinate or a vector point, or a rectangle to test
","dataType":{"tokens":[{"value":"number | Vector2d | Rect","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Rect","kind":"link"}],"template":"%1 | %2 | %3"}},{"identifier":"y","optional":true,"description":"y coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"True if the rectangle contain the given point or rectangle, otherwise false
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"NthWCE7EHrl2CTQz9x-gM","name":"copy","brief":"","scope":"instance","type":"MethodDoc","description":"copy the position and size of the given rectangle into this one
","params":[{"identifier":"rect","optional":false,"description":"Source rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"hD9pO4B-bu_2fu4Jbc_M2","name":"distanceTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the distance to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"distance
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"EUhaYAhtT9j7Qt84jLjLi","name":"equals","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is identical to the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if equals
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"BBOZrP9QuQIqWk7uZQ3Bt","name":"flipX","brief":"","scope":"instance","see":["Matrix2d#scaleX"],"type":"MethodDoc","description":"flip the renderable on the horizontal axis (around the center of the renderable)
","params":[{"identifier":"flip","optional":true,"default":"true","description":"true to flip this renderable.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"xhL41Fxo7io7HuUXAJL0g","name":"flipY","brief":"","scope":"instance","see":["Matrix2d#scaleY"],"type":"MethodDoc","description":"flip the renderable on the vertical axis (around the center of the renderable)
","params":[{"identifier":"flip","optional":true,"default":"true","description":"true to flip this renderable.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"1GbP4t78dy9qkEaS_WFXt","name":"forEach","brief":"","examples":[{"caption":"","code":"// iterate through all children of this container\ncontainer.forEach((child) => {\n // do something with the child\n child.doSomething();\n});\ncontainer.forEach((child, index) => { ... });\ncontainer.forEach((child, index, array) => { ... });\ncontainer.forEach((child, index, array) => { ... }, thisArg);"}],"scope":"instance","type":"MethodDoc","description":"The forEach() method executes a provided function once per child element.
fnction to execute on each element
","dataType":{"tokens":[{"value":"Function","kind":"canonical"}],"template":"Function"}},{"identifier":"thisArg","optional":true,"description":"value to use as this(i.e reference Object) when executing callback.
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}}],"returns":[],"extends":[],"implements":[]},{"id":"z-4I6TrcnSHZf9sA9qVux","name":"getAbsolutePosition","brief":"","scope":"instance","type":"MethodDoc","description":"return the renderable absolute position in the game world
","params":[],"returns":[{"dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"ccwJc9UOgR-7x-kd_Rdon","name":"getBounds","brief":"","scope":"instance","type":"MethodDoc","description":"returns the bounding box for this renderable
","params":[],"returns":[{"description":"bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"-sedRlB_aiWhN3Fe3jo2k","name":"getChildAt","brief":"","scope":"instance","type":"MethodDoc","description":"Returns the Child at the specified index
","params":[{"identifier":"index","optional":false,"description":"The index of the child
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"the child at the specified index
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"tdboL60xTw6ayv4TPAl3G","name":"getChildByGUID","brief":"","scope":"instance","type":"MethodDoc","description":"return the child corresponding to the specified GUID
child GUID
","dataType":{"tokens":[{"value":"string | RegExp | number | boolean","kind":"canonical"},{"value":"RegExp","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"string | %1 | %2 | boolean"}}],"returns":[{"description":"corresponding child or null
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"LzUDRAgW1GwX1cTAh9qMy","name":"getChildByName","brief":"","scope":"instance","type":"MethodDoc","description":"returns the list of childs with the specified name
child name
","dataType":{"tokens":[{"value":"string | RegExp | number | boolean","kind":"canonical"},{"value":"RegExp","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"string | %1 | %2 | boolean"}}],"returns":[{"description":"Array of children
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1<%2>"}}],"extends":[],"implements":[]},{"id":"IsImaLDakh2NsO0g1hy8P","name":"getChildByProp","brief":"","examples":[{"caption":"","code":" // get the first child object called \"mainPlayer\" in a specific container :\n let ent = myContainer.getChildByProp(\"name\", \"mainPlayer\");\n\n // or query the whole world :\n let ent = container.getChildByProp(\"name\", \"mainPlayer\");\n\n // partial property matches are also allowed by using a RegExp.\n // the following matches \"redCOIN\", \"bluecoin\", \"bagOfCoins\", etc :\n let allCoins = container.getChildByProp(\"name\", /coin/i);\n\n // searching for numbers or other data types :\n let zIndex10 = container.getChildByProp(\"z\", 10);\n let inViewport = container.getChildByProp(\"inViewport\", true);"}],"scope":"instance","type":"MethodDoc","description":"return the child corresponding to the given property and value.
Property name
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"value","optional":false,"description":"Value of the property
","dataType":{"tokens":[{"value":"string | RegExp | number | boolean","kind":"canonical"},{"value":"RegExp","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"string | %1 | %2 | boolean"}}],"returns":[{"description":"Array of childs
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1<%2>"}}],"extends":[],"implements":[]},{"id":"7jSnmfgl3NEC4ZoiZSJmx","name":"getChildByType","brief":"","scope":"instance","type":"MethodDoc","description":"returns the list of childs with the specified class type
","params":[{"identifier":"classType","optional":false,"description":"Class type
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}}],"returns":[{"description":"Array of children
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1<%2>"}}],"extends":[],"implements":[]},{"id":"xD4KDDeNNcxF5elPZWTAX","name":"getChildIndex","brief":"","scope":"instance","type":"MethodDoc","description":"Returns the index of the given Child
","params":[{"identifier":"child","optional":false,"description":"The child object
","dataType":{"tokens":[{"value":"Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"Collectable","kind":"link"},{"value":"Trigger","kind":"link"},{"value":"Draggable","kind":"link"},{"value":"DropTarget","kind":"link"},{"value":"NineSliceSprite","kind":"link"},{"value":"ImageLayer","kind":"link"},{"value":"ColorLayer","kind":"link"},{"value":"Light2d","kind":"link"},{"value":"UIBaseElement","kind":"link"},{"value":"UISpriteElement","kind":"link"},{"value":"UITextButton","kind":"link"},{"value":"Text","kind":"link"},{"value":"BitmapText","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5 | %6 | %7 | %8 | %9 | %10 | %11 | %12 | %13 | %14 | %15 | %16"}}],"returns":[{"description":"index
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"-1fPSnvBW62iSdMvhSTUt","name":"getChildren","brief":"","scope":"instance","type":"MethodDoc","description":"return all child in this container
","params":[],"returns":[{"description":"an array of renderable object
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1<%2>"}}],"extends":[],"implements":[]},{"id":"f6qiQ7OKT3TIJ5amHICTv","name":"getIndices","brief":"","scope":"instance","type":"MethodDoc","description":"returns a list of indices for all triangles defined in this polygon
","params":[],"returns":[{"description":"an array of vertex indices for all triangles forming this polygon.
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1<%2>"}}],"extends":[],"implements":[]},{"id":"4SuONFIX-15zlfIU7csNJ","name":"getNextChild","brief":"","scope":"instance","type":"MethodDoc","description":"Returns the next child within the container or undefined if none
","params":[{"identifier":"child","optional":false,"description":"The child object
","dataType":{"tokens":[{"value":"Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"Collectable","kind":"link"},{"value":"Trigger","kind":"link"},{"value":"Draggable","kind":"link"},{"value":"DropTarget","kind":"link"},{"value":"NineSliceSprite","kind":"link"},{"value":"ImageLayer","kind":"link"},{"value":"ColorLayer","kind":"link"},{"value":"Light2d","kind":"link"},{"value":"UIBaseElement","kind":"link"},{"value":"UISpriteElement","kind":"link"},{"value":"UITextButton","kind":"link"},{"value":"Text","kind":"link"},{"value":"BitmapText","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5 | %6 | %7 | %8 | %9 | %10 | %11 | %12 | %13 | %14 | %15 | %16"}}],"returns":[{"description":"child
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"jfG4gbF_nYKqBVPAk1sKj","name":"getOpacity","brief":"","scope":"instance","type":"MethodDoc","description":"get the renderable alpha channel value
","params":[],"returns":[{"description":"current opacity value between 0 and 1
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"hHWSl94JY3wZK9uPRYJV2","name":"getRandomPointX","brief":"","scope":"instance","type":"MethodDoc","description":"returns a random point on the x axis within the bounds of this emitter
","params":[],"returns":[{"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"e_7tHqYAkDszHRUfHsvpq","name":"getRandomPointY","brief":"","scope":"instance","type":"MethodDoc","description":"returns a random point on the y axis within the bounds this emitter
","params":[],"returns":[{"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"F9KRNlBPWpwZXWMxgJ6Zz","name":"getRootAncestor","brief":"","scope":"instance","type":"MethodDoc","description":"Returns the instance of the root container (i.e. the current application World container).
","params":[],"returns":[{"description":"root container
","dataType":{"tokens":[{"value":"Container","kind":"canonical"},{"value":"Container","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"TTu1RKQgZhwRPJKpdzFuQ","name":"hasChild","brief":"","scope":"instance","type":"MethodDoc","description":"Returns true if contains the specified Child
","params":[{"identifier":"child","optional":false,"description":"The child object
","dataType":{"tokens":[{"value":"Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"Collectable","kind":"link"},{"value":"Trigger","kind":"link"},{"value":"Draggable","kind":"link"},{"value":"DropTarget","kind":"link"},{"value":"NineSliceSprite","kind":"link"},{"value":"ImageLayer","kind":"link"},{"value":"ColorLayer","kind":"link"},{"value":"Light2d","kind":"link"},{"value":"UIBaseElement","kind":"link"},{"value":"UISpriteElement","kind":"link"},{"value":"UITextButton","kind":"link"},{"value":"Text","kind":"link"},{"value":"BitmapText","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5 | %6 | %7 | %8 | %9 | %10 | %11 | %12 | %13 | %14 | %15 | %16"}}],"returns":[{"dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"5wrXTbLrPMJhDtGl-o4M7","name":"isAttachedToRoot","brief":"","scope":"instance","type":"MethodDoc","description":"Checks if this container is root or if it's attached to the root container.
","params":[],"returns":[{"description":"true if this container is root or if it's attached to the root container
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"_kJ4zkQ6zIXu6-0bpre6a","name":"isConvex","brief":"","scope":"instance","type":"MethodDoc","description":"Returns true if the vertices composing this polygon form a convex shape (vertices must be in clockwise order).
","params":[],"returns":[{"description":"true if the vertices are convex, false if not, null if not computable
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"QMdod9owC9h56xdplT2MQ","name":"isFinite","brief":"","scope":"instance","type":"MethodDoc","description":"determines whether all coordinates of this rectangle are finite numbers.
","params":[],"returns":[{"description":"false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"ju-7IHQttg1VDN31DgZQH","name":"isRunning","brief":"","scope":"instance","type":"MethodDoc","description":"Emitter is of type stream and is launching particles
","params":[],"returns":[{"description":"Emitter is Stream and is launching particles
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"RwgzeS1ZwTWBmQ2gzzY75","name":"lookAt","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this renderable towards the given target.
","params":[{"identifier":"target","optional":false,"description":"the renderable or position to look at
","dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"SrAMFT_FbyiB2F-Qbjyou","name":"moveDown","brief":"","scope":"instance","type":"MethodDoc","description":"Move the child in the group one step backward (z depth).
","params":[{"identifier":"child","optional":false,"description":"Child to be moved
","dataType":{"tokens":[{"value":"Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"Collectable","kind":"link"},{"value":"Trigger","kind":"link"},{"value":"Draggable","kind":"link"},{"value":"DropTarget","kind":"link"},{"value":"NineSliceSprite","kind":"link"},{"value":"ImageLayer","kind":"link"},{"value":"ColorLayer","kind":"link"},{"value":"Light2d","kind":"link"},{"value":"UIBaseElement","kind":"link"},{"value":"UISpriteElement","kind":"link"},{"value":"UITextButton","kind":"link"},{"value":"Text","kind":"link"},{"value":"BitmapText","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5 | %6 | %7 | %8 | %9 | %10 | %11 | %12 | %13 | %14 | %15 | %16"}}],"returns":[],"extends":[],"implements":[]},{"id":"tjHPcHld_CTNH96WwGv_D","name":"moveToBottom","brief":"","scope":"instance","type":"MethodDoc","description":"Move the specified child the bottom (z depth).
","params":[{"identifier":"child","optional":false,"description":"Child to be moved
","dataType":{"tokens":[{"value":"Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"Collectable","kind":"link"},{"value":"Trigger","kind":"link"},{"value":"Draggable","kind":"link"},{"value":"DropTarget","kind":"link"},{"value":"NineSliceSprite","kind":"link"},{"value":"ImageLayer","kind":"link"},{"value":"ColorLayer","kind":"link"},{"value":"Light2d","kind":"link"},{"value":"UIBaseElement","kind":"link"},{"value":"UISpriteElement","kind":"link"},{"value":"UITextButton","kind":"link"},{"value":"Text","kind":"link"},{"value":"BitmapText","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5 | %6 | %7 | %8 | %9 | %10 | %11 | %12 | %13 | %14 | %15 | %16"}}],"returns":[],"extends":[],"implements":[]},{"id":"S_HN81PzXw6sSs-umLlXM","name":"moveToTop","brief":"","scope":"instance","type":"MethodDoc","description":"Move the specified child to the top(z depth).
","params":[{"identifier":"child","optional":false,"description":"Child to be moved
","dataType":{"tokens":[{"value":"Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"Collectable","kind":"link"},{"value":"Trigger","kind":"link"},{"value":"Draggable","kind":"link"},{"value":"DropTarget","kind":"link"},{"value":"NineSliceSprite","kind":"link"},{"value":"ImageLayer","kind":"link"},{"value":"ColorLayer","kind":"link"},{"value":"Light2d","kind":"link"},{"value":"UIBaseElement","kind":"link"},{"value":"UISpriteElement","kind":"link"},{"value":"UITextButton","kind":"link"},{"value":"Text","kind":"link"},{"value":"BitmapText","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5 | %6 | %7 | %8 | %9 | %10 | %11 | %12 | %13 | %14 | %15 | %16"}}],"returns":[],"extends":[],"implements":[]},{"id":"EqX-X_jr3tMlEb4nSTYGv","name":"moveUp","brief":"","scope":"instance","type":"MethodDoc","description":"Move the child in the group one step forward (z depth).
","params":[{"identifier":"child","optional":false,"description":"Child to be moved
","dataType":{"tokens":[{"value":"Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"Collectable","kind":"link"},{"value":"Trigger","kind":"link"},{"value":"Draggable","kind":"link"},{"value":"DropTarget","kind":"link"},{"value":"NineSliceSprite","kind":"link"},{"value":"ImageLayer","kind":"link"},{"value":"ColorLayer","kind":"link"},{"value":"Light2d","kind":"link"},{"value":"UIBaseElement","kind":"link"},{"value":"UISpriteElement","kind":"link"},{"value":"UITextButton","kind":"link"},{"value":"Text","kind":"link"},{"value":"BitmapText","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5 | %6 | %7 | %8 | %9 | %10 | %11 | %12 | %13 | %14 | %15 | %16"}}],"returns":[],"extends":[],"implements":[]},{"id":"y5tIU9d737aVgcbqxDohC","name":"onChildChange","brief":"","scope":"instance","type":"MethodDoc","description":"a callback to be extended, triggered after a child has been added or removed
","params":[{"identifier":"index","optional":false,"description":"added or removed child index
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"WCtzAa6MDyHJiTeDPs8h_","name":"onCollision","brief":"","examples":[{"caption":"","code":"// colision handler\nonCollision(response) {\n if (response.b.body.collisionType === me.collision.types.ENEMY_OBJECT) {\n // makes the other object solid, by substracting the overlap vector to the current position\n this.pos.sub(response.overlapV);\n this.hurt();\n // not solid\n return false;\n }\n // Make the object solid\n return true;\n},"}],"scope":"instance","type":"MethodDoc","description":"onCollision callback, triggered in case of collision,\nwhen this renderable body is colliding with another one
","params":[{"identifier":"response","optional":false,"description":"the collision response object
","dataType":{"tokens":[{"value":"ResponseObject","kind":"canonical"},{"value":"ResponseObject","kind":"link"}],"template":"%1"}},{"identifier":"other","optional":false,"description":"the other renderable touching this one (a reference to response.a or response.b)
","dataType":{"tokens":[{"value":"Renderable | Container | Entity | Sprite | NineSliceSprite","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Container","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"NineSliceSprite","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5"}}],"returns":[{"description":"true if the object should respond to the collision (its position and velocity will be corrected)
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"xMlM8akuLzCQ3HJPm5KtU","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"OnDestroy Notification function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"SEIIKnwyGYZUs_0739hlq","name":"overlaps","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is intersecting with the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if overlaps
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"oJ8a8e_yjxKIQfeFfmIVU","name":"postDraw","brief":"","scope":"instance","see":["Renderable#preDraw","Renderable#draw"],"type":"MethodDoc","description":"restore the rendering context after drawing (automatically called by melonJS).
","params":[{"identifier":"renderer","optional":false,"description":"a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"Nb-5J9kKg-3AOJQHvNJO9","name":"preDraw","brief":"","scope":"instance","see":["Renderable#draw","Renderable#postDraw"],"type":"MethodDoc","description":"Prepare the rendering context before drawing (automatically called by melonJS).\nThis will apply any defined transforms, an...","params":[{"identifier":"renderer","optional":false,"description":"
a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"kCSP9g9x7amiy8zBP9nqa","name":"recalc","brief":"","scope":"instance","type":"MethodDoc","description":"Computes the calculated collision polygon.\nThis must be called if the points array, an...","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"7u2DXHBNm8Sn8nir17NY7","name":"removeChild","brief":"","scope":"instance","type":"MethodDoc","description":"Invokes the removeChildNow in a defer, to ensure the child is removed safely after the update & draw stack has complet...","params":[{"identifier":"child","optional":false,"description":"
Child to be removed
","dataType":{"tokens":[{"value":"RendRenderable | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapTexterable","kind":"canonical"},{"value":"RendRenderable","kind":"canonical"},{"value":"Sprite","kind":"link"},{"value":"Collectable","kind":"link"},{"value":"Trigger","kind":"link"},{"value":"Draggable","kind":"link"},{"value":"DropTarget","kind":"link"},{"value":"NineSliceSprite","kind":"link"},{"value":"ImageLayer","kind":"link"},{"value":"ColorLayer","kind":"link"},{"value":"Light2d","kind":"link"},{"value":"UIBaseElement","kind":"link"},{"value":"UISpriteElement","kind":"link"},{"value":"UITextButton","kind":"link"},{"value":"Text","kind":"link"},{"value":"BitmapTexterable","kind":"canonical"}],"template":"%1 | %2 | %3 | %4 | %5 | %6 | %7 | %8 | %9 | %10 | %11 | %12 | %13 | %14 | %15"}},{"identifier":"keepalive","optional":true,"default":"false","description":"true to prevent calling child.destroy()
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"P0VP955R4Mfbe_Id494Fe","name":"removeChildNow","brief":"","scope":"instance","type":"MethodDoc","description":"Removes (and optionally destroys) a child from the container.
Child to be removed
","dataType":{"tokens":[{"value":"Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"Collectable","kind":"link"},{"value":"Trigger","kind":"link"},{"value":"Draggable","kind":"link"},{"value":"DropTarget","kind":"link"},{"value":"NineSliceSprite","kind":"link"},{"value":"ImageLayer","kind":"link"},{"value":"ColorLayer","kind":"link"},{"value":"Light2d","kind":"link"},{"value":"UIBaseElement","kind":"link"},{"value":"UISpriteElement","kind":"link"},{"value":"UITextButton","kind":"link"},{"value":"Text","kind":"link"},{"value":"BitmapText","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5 | %6 | %7 | %8 | %9 | %10 | %11 | %12 | %13 | %14 | %15 | %16"}},{"identifier":"keepalive","optional":true,"default":"False","description":"True to prevent calling child.destroy()
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"7HgbIrRDzVzEtmlu4JFEz","name":"reset","brief":"","scope":"instance","type":"MethodDoc","description":"Reset the emitter with particle emitter settings.
","params":[{"identifier":"settings","optional":false,"description":"[optional] object with emitter settings. See {@link ParticleEmitterSettings}
","dataType":{"tokens":[{"value":"ParticleEmitterSettings","kind":"canonical"},{"value":"ParticleEmitterSettings","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"wFyO1VAJhF8N255QfC6nV","name":"resize","brief":"","scope":"instance","type":"MethodDoc","description":"resize the rectangle
","params":[{"identifier":"w","optional":false,"description":"new width of the rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"h","optional":false,"description":"new height of the rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"lmUHOLVfsnaBP-o35m8O9","name":"rotate","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this renderable by the specified angle (in radians).
","params":[{"identifier":"angle","optional":false,"description":"The angle to rotate (in radians)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":true,"description":"an optional point to rotate around
","dataType":{"tokens":[{"value":"Vector2d | ObservableVector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"l2jKmZUa_8Zu1F1kGER2B","name":"scale","brief":"","scope":"instance","type":"MethodDoc","description":"scale the renderable around his anchor point. Scaling actually applies changes\nto the currentTransform member wich is use...","params":[{"identifier":"x","optional":false,"description":"
a number representing the abscissa of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":true,"default":"x","description":"a number representing the ordinate of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"JGIBt_XPJq4Oas68_D0hW","name":"scaleV","brief":"","scope":"instance","type":"MethodDoc","description":"scale the renderable around his anchor point
","params":[{"identifier":"v","optional":false,"description":"scaling vector
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"lmvQB3-uLY8hNhTPefFdC","name":"setChildsProperty","brief":"","scope":"instance","type":"MethodDoc","description":"Automatically set the specified property of all childs to the given value
","params":[{"identifier":"prop","optional":false,"description":"property name
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"value","optional":false,"description":"property value
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}},{"identifier":"recursive","optional":true,"default":"false","description":"recursively apply the value to child containers if true
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"oWY-tOvvf0iYpDtkuPee5","name":"setOpacity","brief":"","scope":"instance","type":"MethodDoc","description":"set the renderable alpha channel value
","params":[{"identifier":"alpha","optional":false,"description":"opacity value between 0.0 and 1.0
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"a5WI4RCqYn6HBGMF4aJdZ","name":"setShape","brief":"","scope":"instance","type":"MethodDoc","description":"set new value to the rectangle shape
","params":[{"identifier":"x","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"w","optional":false,"description":"width of the rectangle, or an array of vector defining the rectangle
","dataType":{"tokens":[{"value":"number | Array","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %3<%2>"}},{"identifier":"h","optional":true,"description":"height of the rectangle, if a numeral width parameter is specified
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"ezSysu4O8KL1fjjHyDgJ0","name":"setVertices","brief":"","scope":"instance","type":"MethodDoc","description":"set the vertices defining this Polygon
","params":[{"identifier":"vertices","optional":false,"description":"array of vector or vertice defining the Polygon
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1<%2>"}}],"returns":[{"description":"this instance for objecf chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"KXrlnKHCCS2JYvRFRHqQ7","name":"shift","brief":"","examples":[{"caption":"","code":"polygon.shift(10, 10);\n// or\npolygon.shift(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"Shifts the Polygon to the given position vector.
","params":[{"identifier":"x","description":"x coordinate or a vector point to shift to
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"3aqyYQxqlwmTh9M03tYB5","name":"sort","brief":"","scope":"instance","type":"MethodDoc","description":"Manually trigger the sort of all the childs in the container
","params":[{"identifier":"recursive","optional":true,"default":"false","description":"recursively sort all containers if true
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"lEYdYTYERIwJcjKxYkBYa","name":"stopStream","brief":"Stop the emitter from generating new particles (used only if emitter is Stream)
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"7Ao663n44JKhV3vISyvFV","name":"streamParticles","brief":"","scope":"instance","type":"MethodDoc","description":"Launch particles from emitter constantly (e.g. for stream)
","params":[{"identifier":"duration","optional":true,"description":"time that the emitter releases particles in ms
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"nF91JUDJM6hgvdALacrwB","name":"swapChildren","brief":"","scope":"instance","type":"MethodDoc","description":"Swaps the position (z-index) of 2 children
","params":[{"identifier":"child","optional":false,"description":"Child to be added
","dataType":{"tokens":[{"value":"Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"Collectable","kind":"link"},{"value":"Trigger","kind":"link"},{"value":"Draggable","kind":"link"},{"value":"DropTarget","kind":"link"},{"value":"NineSliceSprite","kind":"link"},{"value":"ImageLayer","kind":"link"},{"value":"ColorLayer","kind":"link"},{"value":"Light2d","kind":"link"},{"value":"UIBaseElement","kind":"link"},{"value":"UISpriteElement","kind":"link"},{"value":"UITextButton","kind":"link"},{"value":"Text","kind":"link"},{"value":"BitmapText","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5 | %6 | %7 | %8 | %9 | %10 | %11 | %12 | %13 | %14 | %15 | %16"}},{"identifier":"child2","optional":false,"description":"Child to be added
","dataType":{"tokens":[{"value":"Renderable | Entity | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"Collectable","kind":"link"},{"value":"Trigger","kind":"link"},{"value":"Draggable","kind":"link"},{"value":"DropTarget","kind":"link"},{"value":"NineSliceSprite","kind":"link"},{"value":"ImageLayer","kind":"link"},{"value":"ColorLayer","kind":"link"},{"value":"Light2d","kind":"link"},{"value":"UIBaseElement","kind":"link"},{"value":"UISpriteElement","kind":"link"},{"value":"UITextButton","kind":"link"},{"value":"Text","kind":"link"},{"value":"BitmapText","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5 | %6 | %7 | %8 | %9 | %10 | %11 | %12 | %13 | %14 | %15 | %16"}}],"returns":[],"extends":[],"implements":[]},{"id":"-Rv6JnwJHyi2ey11xyq8P","name":"to2d","brief":"","scope":"instance","type":"MethodDoc","description":"apply a 2d projection to this shapen
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"clKNIWwHXcmtOVlNqaBJc","name":"toIso","brief":"","scope":"instance","type":"MethodDoc","description":"apply an isometric projection to this shape
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"6y1G83neAzmalcPntTTsV","name":"toPolygon","brief":"","scope":"instance","type":"MethodDoc","description":"Returns a polygon whose edges are the same as this box.
","params":[],"returns":[{"description":"a new Polygon that represents this rectangle.
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"1HkA4m05bJHYOtN5T-yj1","name":"transform","brief":"","scope":"instance","see":["Renderable#currentTransform"],"type":"MethodDoc","description":"multiply the renderable currentTransform with the given matrix
","params":[{"identifier":"m","optional":false,"description":"the transformation matrix
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"-hZ_Lw2zVzOIgFJa9kMkc","name":"translate","brief":"","examples":[{"caption":"","code":"polygon.translate(10, 10);\n// or\npolygon.translate(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"translate the Polygon by the specified offset
","params":[{"identifier":"x","description":"x offset or a vector point to translate by
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"description":"y offset
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"nTGJXPog56ihIoaRdppLh","name":"union","brief":"","scope":"instance","type":"MethodDoc","description":"merge this rectangle with another one
","params":[{"identifier":"rect","optional":false,"description":"other rectangle to union with
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"the union(ed) rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"hAxjJVsFT8mW4g-Z8yBXy","name":"updateBounds","brief":"","scope":"instance","type":"MethodDoc","description":"update the bounding box for this container.
","params":[{"identifier":"absolute","optional":true,"default":"true","description":"update the bounds size and position in (world) absolute coordinates
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"this container bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"7PGTYqW3Hr_2UqH2Il5vd","name":"draw","brief":"","access":"protected","scope":"instance","type":"MethodDoc","description":"draw this renderable (automatically called by melonJS)
","params":[{"identifier":"renderer","optional":false,"description":"a renderer instance
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}},{"identifier":"viewport","optional":true,"description":"the viewport to (re)draw
","dataType":{"tokens":[{"value":"Camera2d","kind":"canonical"},{"value":"Camera2d","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"_4G8tmE7rsckgax8aoaJn","name":"update","brief":"","access":"protected","scope":"instance","type":"MethodDoc","description":"container update function.
","params":[{"identifier":"dt","optional":false,"description":"time since the last update in milliseconds.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"true if the Container is dirty
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"mmUo8w9Nx4LK4JKhBlC82","name":"onAnchorUpdate","brief":"","access":"private","scope":"instance","type":"MethodDoc","description":"called when the anchor point value is changed
","params":[{"identifier":"x","optional":false,"description":"the new X value to be set for the anchor
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the new Y value to be set for the anchor
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]}]},{"id":"JX3vlFGd1jsxSd79Utvcu","name":"Path2D","brief":"","type":"ClassDoc","description":"a simplified path2d implementation, supporting only one path
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"qyVfBttRFhADw2Hww8oOO","name":"arcResolution","brief":"","defaultValue":"5","scope":"instance","type":"PropertyDoc","description":"space between interpolated points for quadratic and bezier curve approx. in pixels.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"nzY9st9Beu6zwXqEN8rel","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"the points defining the current path
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"i13cGlxe-lPRjO3A8CDyQ","name":"arc","brief":"","scope":"instance","type":"MethodDoc","description":"adds an arc to the current path which is centered at (x, y) position with the given radius,\nstarting at startAngle and end...","params":[{"identifier":"x","optional":false,"description":"
the horizontal coordinate of the arc's center.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the vertical coordinate of the arc's center.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"radius","optional":false,"description":"the arc's radius. Must be positive.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"startAngle","optional":false,"description":"the angle at which the arc starts in radians, measured from the positive x-axis.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"endAngle","optional":false,"description":"the angle at which the arc ends in radians, measured from the positive x-axis.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"anticlockwise","optional":true,"default":"false","description":"an optional boolean value. If true, draws the arc counter-clockwise between the start and end angles.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"CG14xx2FFh2f4JZEfIebY","name":"arcTo","brief":"","scope":"instance","type":"MethodDoc","description":"adds a circular arc to the path with the given control points and radius, connected to the previous point by a straight li...","params":[{"identifier":"x1","optional":false,"description":"
the x-axis coordinate of the first control point.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y1","optional":false,"description":"the y-axis coordinate of the first control point.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"x2","optional":false,"description":"the x-axis coordinate of the second control point.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y2","optional":false,"description":"the y-axis coordinate of the second control point.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"radius","optional":false,"description":"the arc's radius. Must be positive.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"AgKPHdEpfBkbTfmMolx-p","name":"beginPath","brief":"begin a new path
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ugfJYaRYwETrOlcS-d6dp","name":"bezierCurveTo","brief":"","scope":"instance","type":"MethodDoc","description":"Adds a cubic Bézier curve to the path.
","params":[{"identifier":"cp1X","optional":false,"description":"The x-coordinate of the first control point.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"cp1Y","optional":false,"description":"The y-coordinate of the first control point.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"cp2X","optional":false,"description":"The x-coordinate of the second control point.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"cp2Y","optional":false,"description":"The y-coordinate of the second control point.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"x","optional":false,"description":"The x-coordinate of the end point of the curve.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"The y-coordinate of the end point of the curve.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"r5MfGZTRBfUgDi1Ug3SG9","name":"closePath","brief":"","scope":"instance","type":"MethodDoc","description":"causes the point of the pen to move back to the start of the current path.\nIt tries to draw a straight line from the curre...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"i9x3Wzc23ca3b-nBsbzXf","name":"ellipse","brief":"","scope":"instance","type":"MethodDoc","description":"
adds an elliptical arc to the path which is centered at (x, y) position with the radii radiusX and radiusY\nstarting at sta...","params":[{"identifier":"x","optional":false,"description":"
the x-axis (horizontal) coordinate of the ellipse's center.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y-axis (vertical) coordinate of the ellipse's center.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"radiusX","optional":false,"description":"the ellipse's major-axis radius. Must be non-negative.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"radiusY","optional":false,"description":"the ellipse's minor-axis radius. Must be non-negative.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"rotation","optional":false,"description":"the rotation of the ellipse, expressed in radians.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"startAngle","optional":false,"description":"the angle at which the ellipse starts, measured clockwise from the positive x-axis and expressed in radians.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"endAngle","optional":false,"description":"the angle at which the ellipse ends, measured clockwise from the positive x-axis and expressed in radians.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"anticlockwise","optional":true,"default":"false","description":"an optional boolean value which, if true, draws the ellipse counterclockwise (anticlockwise).
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"NFh3ARd5j1XoHzrB0Gr1M","name":"lineTo","brief":"","scope":"instance","type":"MethodDoc","description":"connects the last point in the current path to the (x, y) coordinates with a straight line.
","params":[{"identifier":"x","optional":false,"description":"the x-axis coordinate of the line's end point.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y-axis coordinate of the line's end point.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"rsNrokdR4IXMJetMvg5Kn","name":"moveTo","brief":"","scope":"instance","type":"MethodDoc","description":"moves the starting point of the current path to the (x, y) coordinates.
","params":[{"identifier":"x","optional":false,"description":"the x-axis (horizontal) coordinate of the point.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y-axis (vertical) coordinate of the point.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"IjB6Ckn_0QwSwI6aTwAwg","name":"parseSVGPath","brief":"","scope":"instance","type":"MethodDoc","description":"Parses an SVG path string and adds the points to the current path.
","params":[{"identifier":"svgPath","optional":false,"description":"The SVG path string to parse.
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"returns":[],"extends":[],"implements":[]},{"id":"AKcV9j83v30426Xb5aQEU","name":"quadraticCurveTo","brief":"","scope":"instance","type":"MethodDoc","description":"Adds a quadratic Bézier curve to the path.
","params":[{"identifier":"cpX","optional":false,"description":"The x-coordinate of the control point.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"cpY","optional":false,"description":"The y-coordinate of the control point.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"x","optional":false,"description":"The x-coordinate of the end point of the curve.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"The y-coordinate of the end point of the curve.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"7-iI_2wx9ght-T8X0TfpX","name":"rect","brief":"","scope":"instance","type":"MethodDoc","description":"creates a path for a rectangle at position (x, y) with a size that is determined by width and height.
","params":[{"identifier":"x","optional":false,"description":"the x-axis coordinate of the rectangle's starting point.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y-axis coordinate of the rectangle's starting point.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"width","optional":false,"description":"the rectangle's width. Positive values are to the right, and negative to the left.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"height","optional":false,"description":"the rectangle's height. Positive values are down, and negative are up.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"iRGBjYYdx_BLWbQPsBPKO","name":"roundRect","brief":"","scope":"instance","type":"MethodDoc","description":"adds an rounded rectangle to the current path.
","params":[{"identifier":"x","optional":false,"description":"the x-axis coordinate of the rectangle's starting point.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y-axis coordinate of the rectangle's starting point.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"width","optional":false,"description":"the rectangle's width. Positive values are to the right, and negative to the left.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"height","optional":false,"description":"the rectangle's height. Positive values are down, and negative are up.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"radius","optional":false,"description":"the arc's radius to draw the borders. Must be positive.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"IfXtegGLmCNX46LzU4FxD","name":"triangulatePath","brief":"","scope":"instance","type":"MethodDoc","description":"triangulate the shape defined by this path into an array of triangles
","params":[],"returns":[{"description":"an array of vertices representing the triangulated path or shape
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Point","kind":"link"}],"template":"%1<%2>"}}],"extends":[],"implements":[]}]},{"id":"OlLEckpSIlNsFVnhJiOah","name":"Point","brief":"","type":"ClassDoc","description":"represents a point in a 2d space
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"KhI6E9dCdfgt-2LHgU5B_","name":"type","brief":"","defaultValue":"\"Point\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ejK1VoHwe8HyIeBc74tl-","name":"x","brief":"","defaultValue":"0","scope":"instance","type":"PropertyDoc","description":"the position of the point on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"hdfKTXxqRybhhId51Koti","name":"y","brief":"","defaultValue":"0","scope":"instance","type":"PropertyDoc","description":"the position of the point on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"FlAIrGRjtZOdvLgV61gva","name":"clone","brief":"","scope":"instance","type":"MethodDoc","description":"clone this Point
","params":[],"returns":[{"description":"new Point
","dataType":{"tokens":[{"value":"Point","kind":"canonical"},{"value":"Point","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"19TITuZKsV2J9jEyuzdSV","name":"equals","brief":"","scope":"instance","type":"MethodDoc","description":"return true if this point is equal to the given point
","params":[{"identifier":"x","optional":false,"variadic":true,"dataType":{"tokens":[{"value":"number | Point | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Point","kind":"link"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2 | %3"}},{"identifier":"y","optional":true,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"QeCDbJ1WeVFEixam-KP_Q","name":"set","brief":"","scope":"instance","type":"MethodDoc","description":"set the Point x and y properties to the given values
","params":[{"identifier":"x","optional":false,"default":"0","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"default":"0","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Point","kind":"canonical"},{"value":"Point","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]}]},{"id":"GWnWMoaskISEuruMalXh2","name":"Pointer","brief":"","type":"ClassDoc","description":"a pointer object, representing a single finger on a touch enabled device.
","params":[],"returns":[],"extends":["Bounds"],"implements":[],"members":[{"id":"5pPy-VH1cGx1_3OAUWvOJ","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"zR__wHbOowrge7UfMt3zd","name":"button","brief":"","access":"public","defaultValue":"0","scope":"instance","see":["https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/button"],"type":"PropertyDoc","description":"the button property indicates which button was pressed on the mouse to trigger the event.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"MzI4rfn73sakRUg31S3LX","name":"center","brief":"","scope":"instance","type":"PropertyDoc","description":"return the center position of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"XufHYN0cRhP9uuy-HK-6S","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"center position of the bound on the x axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"lEtT_Bq3y0atwDWPi2m5D","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"center position of the bound on the y axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"-c4W0hLwiPsAeuiRFQeYE","name":"clientX","brief":"","access":"public","defaultValue":"0","scope":"instance","see":["https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/clientX"],"type":"PropertyDoc","description":"the horizontal coordinate within the application's client area at which the event occurred
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"YH_fUVqoXsOrYaQJ64DBU","name":"clientY","brief":"","access":"public","defaultValue":"0","scope":"instance","see":["https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/clientY"],"type":"PropertyDoc","description":"the vertical coordinate within the application's client area at which the event occurred
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"bdC3e_8f0Yjty3vMBmG3J","name":"deltaMode","brief":"","access":"public","defaultValue":"0","scope":"instance","see":["https://developer.mozilla.org/en-US/docs/Web/API/WheelEvent/deltaMode"],"type":"PropertyDoc","description":"an unsigned long representing the unit of the delta values scroll amount
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"RBZDK75DPKwRAHrvddozS","name":"deltaX","brief":"","access":"public","defaultValue":"0","scope":"instance","see":["https://developer.mozilla.org/en-US/docs/Web/API/WheelEvent/deltaX"],"type":"PropertyDoc","description":"a double representing the horizontal scroll amount in the Wheel Event deltaMode unit.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"WlG65rfO2D-ytgDy8nqee","name":"deltaY","brief":"","access":"public","defaultValue":"0","scope":"instance","see":["https://developer.mozilla.org/en-US/docs/Web/API/WheelEvent/deltaY"],"type":"PropertyDoc","description":"a double representing the vertical scroll amount in the Wheel Event deltaMode unit.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"vNfDydjSy0sCpio8Jlu_A","name":"deltaZ","brief":"","access":"public","defaultValue":"0","scope":"instance","see":["https://developer.mozilla.org/en-US/docs/Web/API/WheelEvent/deltaZ"],"type":"PropertyDoc","description":"a double representing the scroll amount in the z-axis, in the Wheel Event deltaMode unit.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"8DDFnutMT57c9kPiMCLL8","name":"event","brief":"","access":"public","scope":"instance","see":["https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent","https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent","https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent"],"type":"PropertyDoc","description":"the originating Event Object
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"a4Ohd2qD3y6--fbsjw4oZ","name":"gameLocalX","brief":"","access":"public","defaultValue":"0","scope":"instance","type":"PropertyDoc","description":"Event X coordinate relative to the holding container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"-ttqjXspj8FzVDJ15C4AR","name":"gameLocalY","brief":"","access":"public","defaultValue":"0","scope":"instance","type":"PropertyDoc","description":"Event Y coordinate relative to the holding container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Jz0PM-OxWHwWH-fapMNdk","name":"gameScreenX","brief":"","access":"public","defaultValue":"0","scope":"instance","type":"PropertyDoc","description":"Event X coordinate relative to the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"vMbUFQRnb_y6tZvMHwZdn","name":"gameScreenY","brief":"","access":"public","defaultValue":"0","scope":"instance","type":"PropertyDoc","description":"Event Y coordinate relative to the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"nyuzKpEHD_EQPHp7wF784","name":"gameWorldX","brief":"","access":"public","defaultValue":"0","scope":"instance","type":"PropertyDoc","description":"Event X coordinate relative to the map
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"o8Fs6QH_DgMGzivt0wC_A","name":"gameWorldY","brief":"","access":"public","defaultValue":"0","scope":"instance","type":"PropertyDoc","description":"Event Y coordinate relative to the map
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"jUJ3i7ANdeeE5anWz6DU6","name":"gameX","brief":"","access":"public","defaultValue":"0","scope":"instance","type":"PropertyDoc","description":"Event normalized X coordinate within the game canvas itself
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"_F0A-kI5TVhK8SYE5if41","name":"gameY","brief":"","access":"public","defaultValue":"0","scope":"instance","type":"PropertyDoc","description":"Event normalized Y coordinate within the game canvas itself
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"enNMG68hNS5yuPZxgl8SN","name":"height","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the bounds
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"6_3KqLK3HWbvm1XlUA_y_","name":"isNormalized","brief":"","access":"public","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"true if not originally a pointer event
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Q4cKRex354QmzcpYD8p5G","name":"isPrimary","brief":"","access":"public","defaultValue":"false","scope":"instance","see":["https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent/isPrimary"],"type":"PropertyDoc","description":"indicates whether or not the pointer device that created the event is the primary pointer.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"i7trJK4CqnHxJFd0G9AXL","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"D3x_xqCJlIczJ9b2drrY0","name":"LEFT","brief":"","access":"public","defaultValue":"0","scope":"instance","type":"PropertyDoc","description":"constant for left button
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"wpc3185ujbuKrExUQizut","name":"locked","brief":"","access":"public","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"true if the pointer is currently locked
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Pxuaz9vbZ2RxjTbcQYLdB","name":"MIDDLE","brief":"","access":"public","defaultValue":"1","scope":"instance","type":"PropertyDoc","description":"constant for middle button
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"lvwgy0ILLCEKWEapXvL_Q","name":"movementX","brief":"","access":"public","defaultValue":"0","scope":"instance","see":["https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/movementX"],"type":"PropertyDoc","description":"the difference in the X coordinate of the pointer since the previous move event
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"A2yFoPZotvKtZYUEAPR8s","name":"movementY","brief":"","access":"public","defaultValue":"0","scope":"instance","see":["https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/movementY"],"type":"PropertyDoc","description":"the difference in the Y coordinate of the pointer since the previous move event
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"_PGv2-72x27CjwPxq3xyM","name":"pageX","brief":"","access":"public","defaultValue":"0","scope":"instance","see":["https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/pageX"],"type":"PropertyDoc","description":"the horizontal coordinate at which the event occurred, relative to the left edge of the entire document.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"MGIpLdQmCSPkrBisjCNEG","name":"pageY","brief":"","access":"public","defaultValue":"0","scope":"instance","see":["https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/pageY"],"type":"PropertyDoc","description":"the vertical coordinate at which the event occurred, relative to the left edge of the entire document.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"su-45U3Yx1ItYT9z_K8Yg","name":"pointerId","brief":"","access":"public","scope":"instance","see":["https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent/pointerId"],"type":"PropertyDoc","description":"The unique identifier of the contact for a touch, mouse or pen
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"cN2Yv3HhEHitleYzgdXA6","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Mc9cRkpiSCJBkJ4mv2Csz","name":"RIGHT","brief":"","access":"public","defaultValue":"2","scope":"instance","type":"PropertyDoc","description":"constant for right button
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"45hmX64BFnr4IIv7Phscn","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"M4BXt3U0HsG26Yg4-oiU2","name":"type","brief":"","access":"public","scope":"instance","see":["https://developer.mozilla.org/en-US/docs/Web/API/Event/type"],"type":"PropertyDoc","description":"a string containing the event's type.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Z1vJYWDNZEsWSTqs1eka8","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the bounds
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"QTB7KLOPRbmy_t4sTb82i","name":"x","brief":"","scope":"instance","type":"PropertyDoc","description":"x position of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"JH2tBPTKjX6hzGE_1cyp1","name":"y","brief":"","scope":"instance","type":"PropertyDoc","description":"y position of the bounds
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"hmkLYscYwnmIKYna2ZIJr","name":"add","brief":"","scope":"instance","type":"MethodDoc","description":"add the given vertices to the bounds definition.
","params":[{"identifier":"vertices","optional":false,"description":"an array of Vector2d or Point
","dataType":{"tokens":[{"value":"Array | Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Array","kind":"canonical"},{"value":"Point","kind":"link"}],"template":"%1<%2> | %3<%4>"}},{"identifier":"clear","optional":true,"default":"false","description":"either to reset the bounds before adding the new vertices
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"cKIGM0x2vIi0a1SxNeJln","name":"addBounds","brief":"","scope":"instance","type":"MethodDoc","description":"add the given bounds to the bounds definition.
","params":[{"identifier":"bounds","optional":false,"dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}},{"identifier":"clear","optional":true,"default":"false","description":"either to reset the bounds before adding the new vertices
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"f7On_YPk8ml34oL0j1yym","name":"addFrame","brief":"","scope":"instance","type":"MethodDoc","description":"add the given quad coordinates to this bound definition, multiplied by the given matrix
","params":[{"identifier":"x0","optional":false,"description":"left X coordinates of the quad
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y0","optional":false,"description":"top Y coordinates of the quad
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"x1","optional":false,"description":"right X coordinates of the quad
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y1","optional":false,"description":"bottom y coordinates of the quad
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"m","optional":true,"description":"an optional transform to apply to the given frame coordinates
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"RC3cpxdQplDIhiJF4BNKi","name":"addPoint","brief":"","scope":"instance","type":"MethodDoc","description":"add the given point to the bounds definition.
","params":[{"identifier":"point","optional":false,"description":"the vector or point to be added to the bounds
","dataType":{"tokens":[{"value":"Vector2d | Point","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Point","kind":"link"}],"template":"%1 | %2"}},{"identifier":"m","optional":true,"description":"an optional transform to apply to the given point (if the given point is a Vector2d)
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"RIwT1WRTbv1IgAYBC5nTF","name":"centerOn","brief":"","scope":"instance","type":"MethodDoc","description":"center the bounds position around the given coordinates
","params":[{"identifier":"x","optional":false,"description":"the x coordinate around which to center this bounds
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y coordinate around which to center this bounds
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"iOehP43tVKgvahPwCkH5G","name":"clear","brief":"reset the bound
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"TXseynqCHmP4tUIOsHVIB","name":"clone","brief":"","scope":"instance","type":"MethodDoc","description":"clone this bounds
","params":[],"returns":[{"dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"0WRJ1hQLbPqkhyF5gBGcp","name":"contains","brief":"","examples":[{"caption":"","code":"if (bounds.contains(10, 10)) {\n // do something\n}\n// or\nif (bounds.contains(myVector2d)) {\n // do something\n}"}],"scope":"instance","type":"MethodDoc","description":"Returns true if the bounds contains the given point.
","params":[{"identifier":"x","description":"x coordinate or a vector point to check
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"description":"y coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"True if the bounds contain the point, otherwise false
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"iVgtzKcd3TZJHht7OXJvn","name":"isFinite","brief":"","scope":"instance","type":"MethodDoc","description":"determines whether all coordinates of this bounds are finite numbers.
","params":[],"returns":[{"description":"false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"0QkEVUOLKIWigXnCXj_nu","name":"overlaps","brief":"","scope":"instance","type":"MethodDoc","description":"Returns true if the two bounds intersect.
","params":[{"identifier":"bounds","optional":false,"dataType":{"tokens":[{"value":"Bounds | Rect","kind":"canonical"},{"value":"Bounds","kind":"link"},{"value":"Rect","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"True if the bounds overlap, otherwise false
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"K9Ohd18b1km4SpG7esLHx","name":"setMinMax","brief":"","scope":"instance","type":"MethodDoc","description":"sets the bounds to the given min and max value
","params":[{"identifier":"minX","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"minY","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"maxX","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"maxY","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"93iKFVXuBTNgsqO4m3CJR","name":"shift","brief":"","examples":[{"caption":"","code":"bounds.shift(10, 10);\n// or\nbounds.shift(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"Shifts the bounds to the given x, y position.
","params":[{"identifier":"x","description":"x coordinate or a vector point to shift to
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"YbH95SOUV5GmhoIc3V7td","name":"toPolygon","brief":"","scope":"instance","type":"MethodDoc","description":"Returns a polygon whose edges are the same as this bounds.
","params":[],"returns":[{"description":"a new Polygon that represents this bounds.
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"3VRS3Yjcwpd-OHhvJIcze","name":"translate","brief":"","examples":[{"caption":"","code":"bounds.translate(10, 10);\n// or\nbounds.translate(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"Translates the bounds by the given point
","params":[{"identifier":"x","description":"x coordinate or a vector point to translate by
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"NGdvSi2VfDjsiCVQBxLK_","name":"update","brief":"","scope":"instance","type":"MethodDoc","description":"Updates bounds using the given vertices
","params":[{"identifier":"vertices","optional":false,"description":"an array of Vector2d or Point
","dataType":{"tokens":[{"value":"Array | Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Array","kind":"canonical"},{"value":"Point","kind":"link"}],"template":"%1<%2> | %3<%4>"}}],"returns":[],"extends":[],"implements":[]},{"id":"aIByt9AxrRQAI3HA1F1gF","name":"set","brief":"","access":"private","scope":"instance","type":"MethodDoc","description":"initialize the Pointer object using the given Event Object
","params":[{"identifier":"event","optional":false,"description":"the original Event object
","dataType":{"tokens":[{"value":"Event","kind":"canonical"},{"value":"Event","kind":"canonical"}],"template":"%1"}},{"identifier":"pageX","optional":true,"default":"0","description":"the horizontal coordinate at which the event occurred, relative to the left edge of the entire document
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"pageY","optional":true,"default":"0","description":"the vertical coordinate at which the event occurred, relative to the left edge of the entire document
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"clientX","optional":true,"default":"0","description":"the horizontal coordinate within the application's client area at which the event occurred
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"clientY","optional":true,"default":"0","description":"the vertical coordinate within the application's client area at which the event occurred
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"pointerId","optional":true,"default":"1","description":"the Pointer, Touch or Mouse event Id (1)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]}]},{"id":"6LagkvEYPcX1vquzEiLbH","name":"Polygon","brief":"","type":"ClassDoc","description":"a polygon Object.
Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"U777WlVjlYHOH_pKG_GK9","name":"pos","brief":"","scope":"instance","type":"PropertyDoc","description":"
origin point of the Polygon
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"IShVP2l3wWrDHFt7bUPCI","name":"type","brief":"","defaultValue":"\"Polygon\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"pdk0qzj07iv1f1CRUFJOb","name":"clone","brief":"","scope":"instance","type":"MethodDoc","description":"clone this Polygon
","params":[],"returns":[{"description":"new Polygon
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"oGA3d61xw7IxPt1gNvi-f","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"x","optional":true,"default":"0","description":"origin point of the Polygon
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":true,"default":"0","description":"origin point of the Polygon
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"points","optional":false,"description":"array of vector defining the Polygon
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1<%2>"}}],"returns":[],"extends":[],"implements":[]},{"id":"DkJfjMN_7Vq3NfwyEOGET","name":"contains","brief":"","examples":[{"caption":"","code":"if (polygon.contains(10, 10)) {\n // do something\n}\n// or\nif (polygon.contains(myVector2d)) {\n // do something\n}"}],"scope":"instance","type":"MethodDoc","description":"Returns true if the polygon contains the given point.
x coordinate or a vector point to check
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"description":"y coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"True if the polygon contain the point, otherwise false
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"tojOrXiCwPFcAQDh0bpiq","name":"getBounds","brief":"","scope":"instance","type":"MethodDoc","description":"returns the bounding box for this shape, the smallest Rectangle object completely containing this shape.
","params":[],"returns":[{"description":"this shape bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"XtTvHsrD77ExAdxgJBDOp","name":"getIndices","brief":"","scope":"instance","type":"MethodDoc","description":"returns a list of indices for all triangles defined in this polygon
","params":[],"returns":[{"description":"an array of vertex indices for all triangles forming this polygon.
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1<%2>"}}],"extends":[],"implements":[]},{"id":"b7_WnnPb26nIpJeMUZk2Q","name":"isConvex","brief":"","scope":"instance","type":"MethodDoc","description":"Returns true if the vertices composing this polygon form a convex shape (vertices must be in clockwise order).
","params":[],"returns":[{"description":"true if the vertices are convex, false if not, null if not computable
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"XdP-g5K80sgJTEDUQXU2H","name":"recalc","brief":"","scope":"instance","type":"MethodDoc","description":"Computes the calculated collision polygon.\nThis must be called if the points array, an...","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"L5dv62_VLYX-Np3N_iwz8","name":"rotate","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this Polygon (counter-clockwise) by the specified angle (in radians).
","params":[{"identifier":"angle","optional":false,"description":"The angle to rotate (in radians)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":true,"description":"an optional point to rotate around
","dataType":{"tokens":[{"value":"Vector2d | ObservableVector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"DFu5gmEiz9PsFvoRICTi_","name":"scale","brief":"","scope":"instance","type":"MethodDoc","description":"Scale this Polygon by the given scalar.
","params":[{"identifier":"x","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":true,"default":"x","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"v7Eg0Od1YpZ1zcjVkMZ72","name":"scaleV","brief":"","scope":"instance","type":"MethodDoc","description":"Scale this Polygon by the given vector
","params":[{"identifier":"v","optional":false,"dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"HcLp0f3Y9ZI1LVrHCzi5k","name":"setShape","brief":"","scope":"instance","type":"MethodDoc","description":"set new value to the Polygon
","params":[{"identifier":"x","optional":false,"description":"position of the Polygon
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"position of the Polygon
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"points","optional":false,"description":"array of vector or vertice defining the Polygon
","dataType":{"tokens":[{"value":"Array | Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Array","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1<%2> | %3<%4>"}}],"returns":[{"description":"this instance for objecf chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"lxbBkUTnr4FNbf4CPx9S_","name":"setVertices","brief":"","scope":"instance","type":"MethodDoc","description":"set the vertices defining this Polygon
","params":[{"identifier":"vertices","optional":false,"description":"array of vector or vertice defining the Polygon
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1<%2>"}}],"returns":[{"description":"this instance for objecf chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"n0Dj_rjfHyndAvLhEfD1x","name":"shift","brief":"","examples":[{"caption":"","code":"polygon.shift(10, 10);\n// or\npolygon.shift(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"Shifts the Polygon to the given position vector.
","params":[{"identifier":"x","description":"x coordinate or a vector point to shift to
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"d42YNi6rCN4__HrYN1jA8","name":"to2d","brief":"","scope":"instance","type":"MethodDoc","description":"apply a 2d projection to this shapen
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"QvuOV29s2p2epp8aTz4tS","name":"toIso","brief":"","scope":"instance","type":"MethodDoc","description":"apply an isometric projection to this shape
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"g_1t7W9SMtHXrQEVZVxsY","name":"transform","brief":"","scope":"instance","type":"MethodDoc","description":"apply the given transformation matrix to this Polygon
","params":[{"identifier":"m","optional":false,"description":"the transformation matrix
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"3LwaMPU-66aNTnIjPPg41","name":"translate","brief":"","examples":[{"caption":"","code":"polygon.translate(10, 10);\n// or\npolygon.translate(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"translate the Polygon by the specified offset
","params":[{"identifier":"x","description":"x offset or a vector point to translate by
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"description":"y offset
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"yxQ_eAdMw5XdL-q75Pp-M","name":"updateBounds","brief":"","scope":"instance","type":"MethodDoc","description":"update the bounding box for this shape.
","params":[],"returns":[{"description":"this shape bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]}]},{"id":"w3q9-jiW5Fg4mTP38WiyO","name":"PrimitiveCompositor","type":"ClassDoc","description":"A WebGL Compositor object. This class handles all of the WebGL state
an array of vertex attribute properties
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"n_DXbCJgtHU0rmsu4cydz","name":"currentShader","brief":"","scope":"instance","type":"PropertyDoc","description":"the shader currently used by this compositor
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"uB3v04-Avx4F5WzbNI8T6","name":"defaultShader","brief":"","scope":"instance","type":"PropertyDoc","description":"the default shader created by this compositor
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"y3-RuzTvVCQFJEPz7a1-m","name":"mode","brief":"","defaultValue":"gl.TRIANGLES","scope":"instance","type":"PropertyDoc","description":"primitive type to render (gl.POINTS, gl.LINE_STRIP, gl.LINE_LOOP, gl.LINES, gl.TRIANGLE_STRIP, gl.TRIANGLE_FAN, gl.TRIANGL...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"BiqcpomCdqdC7XCT5sfVc","name":"vertexByteSize","brief":"","defaultValue":"0","scope":"instance","see":["WebGLCompositor.addAttribute"],"type":"PropertyDoc","description":"
the size of a single vertex in bytes\n(will automatically be calculated as attributes definitions are added)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"6VTdJ0SWWUwDyGz7hTKhh","name":"vertexData","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"the vertex data buffer used by this compositor
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"aKfHb3obfBDg4kIpKohEZ","name":"vertexSize","brief":"","defaultValue":"0","scope":"instance","see":["WebGLCompositor.addAttribute"],"type":"PropertyDoc","description":"the size of a single vertex in floats\n(will automatically be calculated as attributes definitions are added)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"E2mM7fL5Jmi18AJoGU3ZE","name":"addAttribute","brief":"","scope":"instance","type":"MethodDoc","description":"add vertex attribute property definition to the compositor
","params":[{"identifier":"name","optional":false,"description":"name of the attribute in the vertex shader
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"size","optional":false,"description":"number of components per vertex attribute. Must be 1, 2, 3, or 4.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"type","optional":false,"description":"data type of each component in the array
","dataType":{"tokens":[{"value":"GLenum","kind":"canonical"},{"value":"GLenum","kind":"canonical"}],"template":"%1"}},{"identifier":"normalized","optional":false,"description":"whether integer data values should be normalized into a certain range when being cast to a float
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}},{"identifier":"offset","optional":false,"description":"offset in bytes of the first component in the vertex attribute array
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"zXg6vV0w1iQtfSQ5feeLE","name":"bind","brief":"called by the WebGL renderer when a compositor become the current one
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"XVoficedFRO64sVBezrL6","name":"constructor","brief":"","access":"public","scope":"instance","type":"MethodDoc","params":[],"returns":[]},{"id":"7CvVYWxAU_DQQryrF0Mdh","name":"drawVertices","brief":"","scope":"instance","type":"MethodDoc","description":"Draw an array of vertices
","params":[{"identifier":"mode","optional":false,"description":"primitive type to render (gl.POINTS, gl.LINE_STRIP, gl.LINE_LOOP, gl.LINES, gl.TRIANGLE_STRIP, gl.TRIANGLE_FAN, gl.TRIANGL...","dataType":{"tokens":[{"value":"GLenum","kind":"canonical"},{"value":"GLenum","kind":"canonical"}],"template":"%1"}},{"identifier":"verts","optional":false,"description":"
an array of vertices
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Point","kind":"link"}],"template":"%1<%2>"}},{"identifier":"vertexCount","optional":true,"default":"verts.length","description":"amount of points defined in the points array
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"Ho_M8wmgyOeF5rpZpEgO1","name":"flush","brief":"","scope":"instance","type":"MethodDoc","description":"Flush batched vertex data to the GPU
","params":[{"identifier":"mode","optional":true,"default":"gl.TRIANGLES","description":"the GL drawing mode
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"FvZggS63kjcdwBZoblGO-","name":"setProjection","brief":"","scope":"instance","type":"MethodDoc","description":"set/change the current projection matrix
","params":[{"identifier":"matrix","optional":false,"description":"the new projection matrix
","dataType":{"tokens":[{"value":"Matrix3d","kind":"canonical"},{"value":"Matrix3d","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"5b-Ld4GCJun6-DC8nHb3_","name":"useShader","brief":"","scope":"instance","see":["GLShader"],"type":"MethodDoc","description":"Select the shader to use for compositing
","params":[{"identifier":"shader","optional":false,"description":"a reference to a GLShader instance
","dataType":{"tokens":[{"value":"GLShader","kind":"canonical"},{"value":"GLShader","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]}]},{"id":"h1o6-RuWDsuKgzQ0PU6nz","name":"QuadCompositor","type":"ClassDoc","description":"A WebGL Compositor object. This class handles all of the WebGL state
an array of vertex attribute properties
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"z0GNXGeqBGdhks2Wt0FVK","name":"currentShader","brief":"","scope":"instance","type":"PropertyDoc","description":"the shader currently used by this compositor
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"gn5pOKlHTIFQj0IU8WZD2","name":"defaultShader","brief":"","scope":"instance","type":"PropertyDoc","description":"the default shader created by this compositor
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"H_NYh66yB7PgJRe5A54eO","name":"mode","brief":"","defaultValue":"gl.TRIANGLES","scope":"instance","type":"PropertyDoc","description":"primitive type to render (gl.POINTS, gl.LINE_STRIP, gl.LINE_LOOP, gl.LINES, gl.TRIANGLE_STRIP, gl.TRIANGLE_FAN, gl.TRIANGL...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"fvmHCwJ1nMVVOF2El_dAg","name":"vertexByteSize","brief":"","defaultValue":"0","scope":"instance","see":["WebGLCompositor.addAttribute"],"type":"PropertyDoc","description":"
the size of a single vertex in bytes\n(will automatically be calculated as attributes definitions are added)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"-_ug9zmw2baXWewTr5rc1","name":"vertexData","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"the vertex data buffer used by this compositor
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"YsACSy7j70UXZgltvIDLD","name":"vertexSize","brief":"","defaultValue":"0","scope":"instance","see":["WebGLCompositor.addAttribute"],"type":"PropertyDoc","description":"the size of a single vertex in floats\n(will automatically be calculated as attributes definitions are added)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"J4sRRDJRn7-2SF2txgy4d","name":"addAttribute","brief":"","scope":"instance","type":"MethodDoc","description":"add vertex attribute property definition to the compositor
","params":[{"identifier":"name","optional":false,"description":"name of the attribute in the vertex shader
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"size","optional":false,"description":"number of components per vertex attribute. Must be 1, 2, 3, or 4.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"type","optional":false,"description":"data type of each component in the array
","dataType":{"tokens":[{"value":"GLenum","kind":"canonical"},{"value":"GLenum","kind":"canonical"}],"template":"%1"}},{"identifier":"normalized","optional":false,"description":"whether integer data values should be normalized into a certain range when being cast to a float
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}},{"identifier":"offset","optional":false,"description":"offset in bytes of the first component in the vertex attribute array
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"2g48eWivF_U4YK87CTcKz","name":"addQuad","brief":"","scope":"instance","type":"MethodDoc","description":"Add a textured quad
","params":[{"identifier":"texture","optional":false,"description":"Source texture atlas
","dataType":{"tokens":[{"value":"TextureAtlas","kind":"canonical"},{"value":"TextureAtlas","kind":"link"}],"template":"%1"}},{"identifier":"x","optional":false,"description":"Destination x-coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"Destination y-coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"w","optional":false,"description":"Destination width
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"h","optional":false,"description":"Destination height
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"u0","optional":false,"description":"Texture UV (u0) value.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v0","optional":false,"description":"Texture UV (v0) value.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"u1","optional":false,"description":"Texture UV (u1) value.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v1","optional":false,"description":"Texture UV (v1) value.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"tint","optional":false,"description":"tint color to be applied to the texture in UINT32 (argb) format
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"reupload","optional":false,"default":"false","description":"Force the texture to be reuploaded even if already bound
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"pz2O8dFe6Ct-dJfrLI329","name":"bind","brief":"called by the WebGL renderer when a compositor become the current one
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"e2aH8p2rzrX8ljRdpcoS4","name":"bindTexture2D","brief":"","scope":"instance","type":"MethodDoc","description":"assign the given WebGL texture to the current batch
","params":[{"identifier":"texture","optional":false,"description":"a WebGL texture
","dataType":{"tokens":[{"value":"WebGLTexture","kind":"canonical"},{"value":"WebGLTexture","kind":"canonical"}],"template":"%1"}},{"identifier":"unit","optional":false,"description":"Texture unit to which the given texture is bound
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"8OdK9N9x7b9aS6Z7fzEpi","name":"constructor","brief":"","access":"public","scope":"instance","type":"MethodDoc","params":[],"returns":[]},{"id":"Gu3RBmCN7BXDsXCyurrxP","name":"createTexture2D","brief":"","scope":"instance","type":"MethodDoc","description":"Create a WebGL texture from an image
","params":[{"identifier":"unit","optional":false,"description":"Destination texture unit
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"pixels","optional":true,"default":"null","description":"Source image
","dataType":{"tokens":[{"value":"Image | HTMLCanvasElement | ImageData | Array | Array","kind":"canonical"},{"value":"Image","kind":"canonical"},{"value":"HTMLCanvasElement","kind":"canonical"},{"value":"ImageData","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Uint8Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Float32Array","kind":"canonical"}],"template":"%1 | %2 | %3 | %4<%5> | %6<%7>"}},{"identifier":"filter","optional":false,"description":"gl.LINEAR or gl.NEAREST
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"repeat","optional":true,"default":"\"no-repeat\"","description":"Image repeat behavior (see {@link ImageLayer#repeat})
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"w","optional":true,"default":"pixels.width","description":"Source image width (Only use with UInt8Array[] or Float32Array[] source image)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"h","optional":true,"default":"pixels.height","description":"Source image height (Only use with UInt8Array[] or Float32Array[] source image)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"premultipliedAlpha","optional":true,"default":"true","description":"Multiplies the alpha channel into the other color channels
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}},{"identifier":"mipmap","optional":true,"default":"true","description":"Whether mipmap levels should be generated for this texture
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"a WebGL texture
","dataType":{"tokens":[{"value":"WebGLTexture","kind":"canonical"},{"value":"WebGLTexture","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"ZBzgw_2WTmLlWpeX9E9pL","name":"deleteTexture2D","brief":"","scope":"instance","type":"MethodDoc","description":"delete the given WebGL texture
","params":[{"identifier":"texture","optional":true,"description":"a WebGL texture to delete
","dataType":{"tokens":[{"value":"WebGLTexture","kind":"canonical"},{"value":"WebGLTexture","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"xFsCvL4tlC7f4sMBiK_be","name":"flush","brief":"","scope":"instance","type":"MethodDoc","description":"Flush batched vertex data to the GPU
","params":[{"identifier":"mode","optional":true,"default":"gl.TRIANGLES","description":"the GL drawing mode
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"7MeNqIecCYVD3Yb921Zk7","name":"getTexture2D","brief":"","scope":"instance","type":"MethodDoc","description":"returns the WebGL texture associated to the given texture unit
","params":[{"identifier":"unit","optional":false,"description":"Texture unit to which a texture is bound
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"texture a WebGL texture
","dataType":{"tokens":[{"value":"WebGLTexture","kind":"canonical"},{"value":"WebGLTexture","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"_5F-WKiCVcVd2BJoaymmu","name":"setProjection","brief":"","scope":"instance","type":"MethodDoc","description":"set/change the current projection matrix
","params":[{"identifier":"matrix","optional":false,"description":"the new projection matrix
","dataType":{"tokens":[{"value":"Matrix3d","kind":"canonical"},{"value":"Matrix3d","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"UFUHTm_4txN92iRpjpa3F","name":"unbindTexture2D","brief":"","scope":"instance","type":"MethodDoc","description":"unbind the given WebGL texture, forcing it to be reuploaded
","params":[{"identifier":"texture","optional":true,"description":"a WebGL texture
","dataType":{"tokens":[{"value":"WebGLTexture","kind":"canonical"},{"value":"WebGLTexture","kind":"canonical"}],"template":"%1"}},{"identifier":"unit","optional":true,"description":"a WebGL texture
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"unit the unit number that was associated with the given texture
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Jj0jclNliD6bkHl_3SR98","name":"useShader","brief":"","scope":"instance","see":["GLShader"],"type":"MethodDoc","description":"Select the shader to use for compositing
","params":[{"identifier":"shader","optional":false,"description":"a reference to a GLShader instance
","dataType":{"tokens":[{"value":"GLShader","kind":"canonical"},{"value":"GLShader","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]}]},{"id":"cfRbxIKx9jSHimEeFWeh8","name":"QuadTree","brief":"","see":["game.world.broadphase"],"type":"ClassDoc","description":"a QuadTree implementation in JavaScript, a 2d spatial subdivision algorithm.
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"82M5VvaUsrgYCh9TFzNqB","name":"clear","brief":"","scope":"instance","type":"MethodDoc","description":"clear the quadtree
","params":[{"identifier":"bounds","optional":true,"default":"this.bounds","description":"the bounds to be cleared
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"k46o1HQZg1i-K4DuO1PCi","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"world","optional":false,"description":"the physic world this QuadTree belongs to
","dataType":{"tokens":[{"value":"World","kind":"canonical"},{"value":"World","kind":"link"}],"template":"%1"}},{"identifier":"bounds","optional":false,"description":"bounds of the node
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}},{"identifier":"max_objects","optional":true,"default":"4","description":"max objects a node can hold before splitting into 4 subnodes
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"max_levels","optional":true,"default":"4","description":"total max levels inside root Quadtree
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"level","optional":true,"default":"0","description":"deepth level, required for subnodes
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"whmdWS9asdV_kbdHNZqtg","name":"hasChildren","brief":"","scope":"instance","type":"MethodDoc","description":"return true if the node has any children
","params":[],"returns":[{"description":"true if the node has any children
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"KqnoKFkDPiRrNb7D_KqWd","name":"insert","brief":"","scope":"instance","type":"MethodDoc","description":"Insert the given object into the node. If the node\nexceeds the capacity, it will split and add all\nobjects to their corres...","params":[{"identifier":"item","optional":false,"description":"
object to be added
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}}],"returns":[],"extends":[],"implements":[]},{"id":"_DXfOKLQ7VWhnOvn4jJHJ","name":"insertContainer","brief":"","scope":"instance","type":"MethodDoc","description":"Insert the given object container into the node.
","params":[{"identifier":"container","optional":false,"description":"group of objects to be added
","dataType":{"tokens":[{"value":"Container","kind":"canonical"},{"value":"Container","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"hGFQmm2AzxLVEbjrVYVSV","name":"isPrunable","brief":"","scope":"instance","type":"MethodDoc","description":"return true if the node is prunable
","params":[],"returns":[{"description":"true if the node is prunable
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"SusW00BMripLSnjc9WYnr","name":"remove","brief":"","scope":"instance","type":"MethodDoc","description":"Remove the given item from the quadtree.\n(this function won't recalculate the impacted node)
","params":[{"identifier":"item","optional":false,"description":"object to be removed
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}}],"returns":[{"description":"true if the item was found and removed.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"-WhfpS0jMxZ6HO1py2lMr","name":"retrieve","brief":"","scope":"instance","type":"MethodDoc","description":"Return all objects that could collide with the given object
","params":[{"identifier":"item","optional":false,"description":"object to be checked against
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}},{"identifier":"fn","optional":true,"description":"a sorting function for the returned array
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}}],"returns":[{"description":"array with all detected objects
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]}]},{"id":"DGJVNS7UGSQqltjAeJbH2","name":"Rect","brief":"","type":"ClassDoc","description":"a rectangle Object
","params":[],"returns":[],"extends":["Polygon"],"implements":[],"members":[{"id":"N7QOFSfatW4qQR1zW7gz0","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"1ciPf_9PGVo3I5wl9VwOj","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"LBsKioWUGtC4ptzTCzS1d","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"9IiHyOS_qJTDtS53UNWET","name":"height","brief":"","scope":"instance","type":"PropertyDoc","description":"height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ytvPfvtt-lFC4TetVEgns","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"6-CoBg2t6urmrEZcWL2Qu","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"VjZTntMEHXRGermjtxg9p","name":"pos","brief":"","scope":"instance","type":"PropertyDoc","description":"
origin point of the Polygon
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"KxICQ78ty3HvHoSZ17dzA","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"jdfVOGjX0dHChqPMeTBg5","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"wZp80lUUv-OGlmrySPzVv","name":"type","brief":"","defaultValue":"\"Rectangle\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"OrVYSqFpWyMQfUpV4uO5s","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Tt_FY-j4rqSjmGCChJN1K","name":"centerOn","brief":"","scope":"instance","type":"MethodDoc","description":"center the rectangle position around the given coordinates
","params":[{"identifier":"x","optional":false,"description":"the x coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"yEUkBxTNG_GhTfL02rsg9","name":"clone","brief":"","scope":"instance","type":"MethodDoc","description":"clone this rectangle
","params":[],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"iLFoQmX6EyooRe91p6VHZ","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"x","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"w","optional":false,"description":"width of the rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"h","optional":false,"description":"height of the rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"78DOBeuYTLilw2VusT9ER","name":"contains","brief":"","examples":[{"caption":"","code":"if (rect.contains(10, 10)) {\n // do something\n}\n// or\nif (rect.contains(myVector2d)) {\n // do something\n}\nif (rect.contains(myRect)) {\n // do something\n}"}],"scope":"instance","type":"MethodDoc","description":"Returns true if the rectangle contains the given point or rectangle
","params":[{"identifier":"x","description":"x coordinate or a vector point, or a rectangle to test
","dataType":{"tokens":[{"value":"number | Vector2d | Rect","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Rect","kind":"link"}],"template":"%1 | %2 | %3"}},{"identifier":"y","optional":true,"description":"y coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"True if the rectangle contain the given point or rectangle, otherwise false
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"D0u0TFctPSFL4ZUPCdiwP","name":"copy","brief":"","scope":"instance","type":"MethodDoc","description":"copy the position and size of the given rectangle into this one
","params":[{"identifier":"rect","optional":false,"description":"Source rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"ripmA3f7dmfMu1MCo-n9F","name":"equals","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is identical to the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if equals
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"gy74Rtd2DEBUfAOO67t82","name":"getBounds","brief":"","scope":"instance","type":"MethodDoc","description":"returns the bounding box for this shape, the smallest Rectangle object completely containing this shape.
","params":[],"returns":[{"description":"this shape bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Lgxz1gSFepm99te3FhaRZ","name":"getIndices","brief":"","scope":"instance","type":"MethodDoc","description":"returns a list of indices for all triangles defined in this polygon
","params":[],"returns":[{"description":"an array of vertex indices for all triangles forming this polygon.
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1<%2>"}}],"extends":[],"implements":[]},{"id":"mnsdtdNmmZnMa-RmouiWY","name":"isConvex","brief":"","scope":"instance","type":"MethodDoc","description":"Returns true if the vertices composing this polygon form a convex shape (vertices must be in clockwise order).
","params":[],"returns":[{"description":"true if the vertices are convex, false if not, null if not computable
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"akSYbWarp_raPQooy7shG","name":"isFinite","brief":"","scope":"instance","type":"MethodDoc","description":"determines whether all coordinates of this rectangle are finite numbers.
","params":[],"returns":[{"description":"false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"Otg3tw8CT4IsDIPuw5lc9","name":"overlaps","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is intersecting with the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if overlaps
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"MTUuvj6C7BIWJBaWHYnlP","name":"recalc","brief":"","scope":"instance","type":"MethodDoc","description":"Computes the calculated collision polygon.\nThis must be called if the points array, an...","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"w3HlxWL8Tb3-1Iv-AvqM8","name":"resize","brief":"","scope":"instance","type":"MethodDoc","description":"resize the rectangle
","params":[{"identifier":"w","optional":false,"description":"new width of the rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"h","optional":false,"description":"new height of the rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"ObSxdvgLVY7NrPa6TkTXA","name":"rotate","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this Polygon (counter-clockwise) by the specified angle (in radians).
","params":[{"identifier":"angle","optional":false,"description":"The angle to rotate (in radians)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":true,"description":"an optional point to rotate around
","dataType":{"tokens":[{"value":"Vector2d | ObservableVector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"U1ttHT_Aw4-jX3mKZ11lD","name":"scale","brief":"","scope":"instance","type":"MethodDoc","description":"scale the rectangle
","params":[{"identifier":"x","optional":false,"description":"a number representing the abscissa of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":true,"default":"x","description":"a number representing the ordinate of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"NeORKEvO7KpGOo79i32CB","name":"scaleV","brief":"","scope":"instance","type":"MethodDoc","description":"Scale this Polygon by the given vector
","params":[{"identifier":"v","optional":false,"dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"tQS_qN-w-k_DEq2oXcuFj","name":"setShape","brief":"","scope":"instance","type":"MethodDoc","description":"set new value to the rectangle shape
","params":[{"identifier":"x","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"w","optional":false,"description":"width of the rectangle, or an array of vector defining the rectangle
","dataType":{"tokens":[{"value":"number | Array","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %3<%2>"}},{"identifier":"h","optional":true,"description":"height of the rectangle, if a numeral width parameter is specified
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"VitThQkGpgklRtJLcvzZx","name":"setVertices","brief":"","scope":"instance","type":"MethodDoc","description":"set the vertices defining this Polygon
","params":[{"identifier":"vertices","optional":false,"description":"array of vector or vertice defining the Polygon
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1<%2>"}}],"returns":[{"description":"this instance for objecf chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"dBz2ShVXYz7zMBO2Qu8Db","name":"shift","brief":"","examples":[{"caption":"","code":"polygon.shift(10, 10);\n// or\npolygon.shift(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"Shifts the Polygon to the given position vector.
","params":[{"identifier":"x","description":"x coordinate or a vector point to shift to
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"tq88RlhWCsljw9OMN76Xa","name":"to2d","brief":"","scope":"instance","type":"MethodDoc","description":"apply a 2d projection to this shapen
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Jg0HSWt9vVni8O8ES27kL","name":"toIso","brief":"","scope":"instance","type":"MethodDoc","description":"apply an isometric projection to this shape
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"F_wODEI3b6cItSNa289A3","name":"toPolygon","brief":"","scope":"instance","type":"MethodDoc","description":"Returns a polygon whose edges are the same as this box.
","params":[],"returns":[{"description":"a new Polygon that represents this rectangle.
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"EqbbVbya-1Swe54GuDekv","name":"transform","brief":"","scope":"instance","type":"MethodDoc","description":"apply the given transformation matrix to this Polygon
","params":[{"identifier":"m","optional":false,"description":"the transformation matrix
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"q_VUpBi3SACoGJNL29q0G","name":"translate","brief":"","examples":[{"caption":"","code":"polygon.translate(10, 10);\n// or\npolygon.translate(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"translate the Polygon by the specified offset
","params":[{"identifier":"x","description":"x offset or a vector point to translate by
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"description":"y offset
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"ALOJOtmwAaEJOdO-EpLot","name":"union","brief":"","scope":"instance","type":"MethodDoc","description":"merge this rectangle with another one
","params":[{"identifier":"rect","optional":false,"description":"other rectangle to union with
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"the union(ed) rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"amneVKESsLIUdTarmh14t","name":"updateBounds","brief":"","scope":"instance","type":"MethodDoc","description":"update the bounding box for this shape.
","params":[],"returns":[{"description":"this shape bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]}]},{"id":"WVhSEy0oQNUNBsbtGDY6k","name":"Renderable","brief":"","type":"ClassDoc","description":"A base class for renderable objects.
","params":[],"returns":[],"extends":["Rect"],"implements":[],"members":[{"id":"mGTxDyJINiOOLLxGaT1KE","name":"alpha","brief":"","defaultValue":"1.0","scope":"instance","see":["Renderable#setOpacity","Renderable#getOpacity"],"type":"PropertyDoc","description":"Define the renderable opacity
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Qzhi0zI2LOzI1B6djh4OS","name":"alwaysUpdate","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object will always update, even when outside of the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"bobjXV8BTnJv6cZzEV7KP","name":"ancestor","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"a reference to the parent object that contains this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"5-xa6OnC_G4mMxpBOJFIB","name":"anchorPoint","brief":"","defaultValue":"<0.5,0.5>","scope":"instance","type":"PropertyDoc","description":"The anchor point is used for attachment behavior, and/or when applying transformations.
When enabled, an object container will automatically apply\nany defined transformation before calling the child draw method...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"zs6qz3WxyusBglOAGZm4C","name":"blendMode","brief":"","defaultValue":"\"normal\"","scope":"instance","see":["CanvasRenderer#setBlendMode","WebGLRenderer#setBlendMode"],"type":"PropertyDoc","description":"
the blend mode to be applied to this renderable (see renderer setBlendMode for available blend mode)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"pHGChkuOlq3b10YKNnJkN","name":"body","brief":"","examples":[{"caption":"","code":" // define a new Player Class\n class PlayerEntity extends me.Sprite {\n // constructor\n constructor(x, y, settings) {\n // call the parent constructor\n super(x, y , settings);\n\n // define a basic walking animation\n this.addAnimation(\"walk\", [...]);\n // define a standing animation (using the first frame)\n this.addAnimation(\"stand\", [...]);\n // set the standing animation as default\n this.setCurrentAnimation(\"stand\");\n\n // add a physic body\n this.body = new me.Body(this);\n // add a default collision shape\n this.body.addShape(new me.Rect(0, 0, this.width, this.height));\n // configure max speed, friction, and initial force to be applied\n this.body.setMaxVelocity(3, 15);\n this.body.setFriction(0.4, 0);\n this.body.force.set(3, 0);\n this.isKinematic = false;\n\n // set the display to follow our position on both axis\n me.game.viewport.follow(this.pos, me.game.viewport.AXIS.BOTH);\n }\n\n ...\n\n }"}],"scope":"instance","type":"PropertyDoc","description":"the renderable physic body
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"xFs7NKHZORrUhw5mROnzL","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ZRqzb_BL2_pvu-jsWi9r2","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"NuNF8EmhfFVIWgy02uuW7","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"GgFTuNFzq9RJqk276-R3I","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ybYyeFCzrkSqk1Ngasjvp","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"oiEg82nqEO09EB5p3Serb","name":"floating","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"If true, this renderable will be rendered using screen coordinates,\nas opposed to world coordinates. Use this, for example...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"zPibV0VDBvB1Z9o_PcAv2","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"
(G)ame (U)nique (Id)entifier"
height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"GdJ5Hz9ylJx_2xRqJeV-M","name":"inViewport","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object is visible and within the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"TTAXb2wePppcyAhqIrWly","name":"isDirty","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"when true the renderable will be redrawn during the next update cycle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"wvxE-Zi94WX7tJYFNH67_","name":"isFlippedX","brief":"","access":"public","scope":"instance","see":["Renderable#flipX"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"uPqgDvFF3S4VKqNJBaGv8","name":"isFlippedY","brief":"","access":"public","scope":"instance","see":["Renderable#flipY"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"aHFvjG7vjeV_MjzWF29ca","name":"isFloating","brief":"","scope":"instance","see":["Renderable#floating"],"type":"PropertyDoc","description":"Whether the renderable object is floating (i.e. used screen coordinates), or contained in a floating parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"n4C-1EvXcRAGGdB6bYoo9","name":"isKinematic","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"If true then physic collision and input events will not impact this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"6v3vboasVKO7Dit5ebxE3","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Tsb_lMfWTYjAPWwyiGZIa","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Dg62dixxk6BA11fghBTpr","name":"mask","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"// apply a mask in the shape of a Star\nmyNPCSprite.mask = new me.Polygon(myNPCSprite.width / 2, 0, [\n // draw a star\n {x: 0, y: 0},\n {x: 14, y: 30},\n {x: 47, y: 35},\n {x: 23, y: 57},\n {x: 44, y: 90},\n {x: 0, y: 62},\n {x: -44, y: 90},\n {x: -23, y: 57},\n {x: -47, y: 35},\n {x: -14, y: 30}\n]);"}],"scope":"instance","type":"PropertyDoc","description":"A mask limits rendering elements to the shape and position of the given mask object.\nSo, if the renderable is larger than ...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"vkBlnsz5OuhBvnrdJ-SNp","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"-KbMaRDQDrPGVBtxfSXpU","name":"onVisibilityChange","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"this.onVisibilityChange = function(inViewport) {\n if (inViewport === true) {\n console.log(\"object has entered the in a camera viewport!\");\n }\n};"}],"scope":"instance","type":"PropertyDoc","description":"an event handler that is called when the renderable leave or enter a camera viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Dp_a9_obvRmdV5977FGrF","name":"parentApp","brief":"","scope":"instance","type":"PropertyDoc","description":"returns the parent application (or game) to which this renderable is attached to
","params":[],"returns":[{"description":"the parent application or undefined if not attached to any container/app
","dataType":{"tokens":[{"value":"Application","kind":"canonical"},{"value":"Application","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"dcbPXgMjY9wb9vc6wL3rG","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"NmoAOzbLvwdfaQr_72KGa","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"t-UfUKkNJ3SORYd8pr7bF","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"4OuAmuHV1TQkPm3vCrNKh","name":"shader","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"(Experimental) an optional shader, to be used instead of the default built-in one, when drawing this renderable (WebGL onl...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"s8yxzZD4himtUipBeakYI","name":"tint","brief":"","defaultValue":"(255, 255, 255)","examples":[{"caption":"","code":"// add a red tint to this renderable\nthis.tint.setColor(255, 128, 128);\n// remove the tint\nthis.tint.setColor(255, 255, 255);"}],"scope":"instance","type":"PropertyDoc","description":"
define a tint for this renderable. a (255, 255, 255) r, g, b value will remove the tint effect.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"zT1K4YUsWRHmB1HBpJurZ","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"dsDtS-7WpnkPl5hV8XPb3","name":"type","brief":"","defaultValue":"\"Rectangle\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"jOL8gHcR08i6VAapIAUdk","name":"updateWhenPaused","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether to update this object when the game is paused.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"t4ek1e5dT3ybtgxDH6hG_","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ivRaeE2QqF4lYowQs6PRy","name":"angleTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the angle to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"angle in radians
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"eCTUQ_p-USP4MFSzI9-BU","name":"centerOn","brief":"","scope":"instance","type":"MethodDoc","description":"center the rectangle position around the given coordinates
","params":[{"identifier":"x","optional":false,"description":"the x coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"lEh0-iMEgHPBvstEHZikp","name":"clone","brief":"","scope":"instance","type":"MethodDoc","description":"clone this rectangle
","params":[],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"KxdfQLKIOQ2-s7My_ODC6","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"x","optional":false,"description":"position of the renderable object (accessible through inherited pos.x property)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"position of the renderable object (accessible through inherited pos.y property)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"width","optional":false,"description":"object width
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"height","optional":false,"description":"object height
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"Mof6HO_BKH2Ybi48oZmg4","name":"contains","brief":"","examples":[{"caption":"","code":"if (rect.contains(10, 10)) {\n // do something\n}\n// or\nif (rect.contains(myVector2d)) {\n // do something\n}\nif (rect.contains(myRect)) {\n // do something\n}"}],"scope":"instance","type":"MethodDoc","description":"Returns true if the rectangle contains the given point or rectangle
","params":[{"identifier":"x","description":"x coordinate or a vector point, or a rectangle to test
","dataType":{"tokens":[{"value":"number | Vector2d | Rect","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Rect","kind":"link"}],"template":"%1 | %2 | %3"}},{"identifier":"y","optional":true,"description":"y coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"True if the rectangle contain the given point or rectangle, otherwise false
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"KoKrYk4bW58Vq_33hmCnc","name":"copy","brief":"","scope":"instance","type":"MethodDoc","description":"copy the position and size of the given rectangle into this one
","params":[{"identifier":"rect","optional":false,"description":"Source rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"ZxEw5HnZsk5LOt3MNNIzP","name":"distanceTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the distance to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"distance
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"6czxKNmjoCSnswFP2kVj3","name":"draw","brief":"","scope":"instance","see":["Renderable#preDraw","Renderable#postDraw"],"type":"MethodDoc","description":"Draw this renderable (automatically called by melonJS).\nAll draw operations for renderable are made respectively\nto the po...","params":[{"identifier":"renderer","optional":false,"description":"
a renderer instance
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}},{"identifier":"viewport","optional":true,"description":"the viewport to (re)draw
","dataType":{"tokens":[{"value":"Camera2d","kind":"canonical"},{"value":"Camera2d","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"PizcUGBjJCrFfxFfj0W0p","name":"equals","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is identical to the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if equals
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"Ps_G_ufn_-SgXG1A0xJtP","name":"flipX","brief":"","scope":"instance","see":["Matrix2d#scaleX"],"type":"MethodDoc","description":"flip the renderable on the horizontal axis (around the center of the renderable)
","params":[{"identifier":"flip","optional":true,"default":"true","description":"true to flip this renderable.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"nuFGsC_tCYKPET8tgw3Be","name":"flipY","brief":"","scope":"instance","see":["Matrix2d#scaleY"],"type":"MethodDoc","description":"flip the renderable on the vertical axis (around the center of the renderable)
","params":[{"identifier":"flip","optional":true,"default":"true","description":"true to flip this renderable.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"gYJcaa8wwFpHp_GtUH0S1","name":"getAbsolutePosition","brief":"","scope":"instance","type":"MethodDoc","description":"return the renderable absolute position in the game world
","params":[],"returns":[{"dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"7UxH5o-OiRy5IqpyqenD-","name":"getBounds","brief":"","scope":"instance","type":"MethodDoc","description":"returns the bounding box for this renderable
","params":[],"returns":[{"description":"bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"U1tjXe4atzZS49STOdwxz","name":"getIndices","brief":"","scope":"instance","type":"MethodDoc","description":"returns a list of indices for all triangles defined in this polygon
","params":[],"returns":[{"description":"an array of vertex indices for all triangles forming this polygon.
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1<%2>"}}],"extends":[],"implements":[]},{"id":"0yXQEwMJ-z35SDgIaTfxV","name":"getOpacity","brief":"","scope":"instance","type":"MethodDoc","description":"get the renderable alpha channel value
","params":[],"returns":[{"description":"current opacity value between 0 and 1
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"4OCqZuRMnO652KGxpTCxH","name":"isConvex","brief":"","scope":"instance","type":"MethodDoc","description":"Returns true if the vertices composing this polygon form a convex shape (vertices must be in clockwise order).
","params":[],"returns":[{"description":"true if the vertices are convex, false if not, null if not computable
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"nigL_Pl3wu2Q0U234UXTp","name":"isFinite","brief":"","scope":"instance","type":"MethodDoc","description":"determines whether all coordinates of this rectangle are finite numbers.
","params":[],"returns":[{"description":"false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"raGkFy3pDlM-ToO_kC3Mq","name":"lookAt","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this renderable towards the given target.
","params":[{"identifier":"target","optional":false,"description":"the renderable or position to look at
","dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"bh0-Nw6tn1RajSkjTFkdI","name":"onCollision","brief":"","examples":[{"caption":"","code":"// colision handler\nonCollision(response) {\n if (response.b.body.collisionType === me.collision.types.ENEMY_OBJECT) {\n // makes the other object solid, by substracting the overlap vector to the current position\n this.pos.sub(response.overlapV);\n this.hurt();\n // not solid\n return false;\n }\n // Make the object solid\n return true;\n},"}],"scope":"instance","type":"MethodDoc","description":"onCollision callback, triggered in case of collision,\nwhen this renderable body is colliding with another one
","params":[{"identifier":"response","optional":false,"description":"the collision response object
","dataType":{"tokens":[{"value":"ResponseObject","kind":"canonical"},{"value":"ResponseObject","kind":"link"}],"template":"%1"}},{"identifier":"other","optional":false,"description":"the other renderable touching this one (a reference to response.a or response.b)
","dataType":{"tokens":[{"value":"Renderable | Container | Entity | Sprite | NineSliceSprite","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Container","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"NineSliceSprite","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5"}}],"returns":[{"description":"true if the object should respond to the collision (its position and velocity will be corrected)
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"GKO9ZKYmEfWGQP0Kr87TV","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"OnDestroy Notification function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"NucVEgcbtTFVzUlfkE8nU","name":"overlaps","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is intersecting with the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if overlaps
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"Ve43mxk8Bzz_IhwjfkEBT","name":"postDraw","brief":"","scope":"instance","see":["Renderable#preDraw","Renderable#draw"],"type":"MethodDoc","description":"restore the rendering context after drawing (automatically called by melonJS).
","params":[{"identifier":"renderer","optional":false,"description":"a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"Naodu6tR9B9jWaXxqHj8_","name":"preDraw","brief":"","scope":"instance","see":["Renderable#draw","Renderable#postDraw"],"type":"MethodDoc","description":"Prepare the rendering context before drawing (automatically called by melonJS).\nThis will apply any defined transforms, an...","params":[{"identifier":"renderer","optional":false,"description":"
a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"PAKrSLVobWkDPNr7bppBg","name":"recalc","brief":"","scope":"instance","type":"MethodDoc","description":"Computes the calculated collision polygon.\nThis must be called if the points array, an...","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"APJiuEkivs0O5YUHSOUNU","name":"resize","brief":"","scope":"instance","type":"MethodDoc","description":"resize the rectangle
","params":[{"identifier":"w","optional":false,"description":"new width of the rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"h","optional":false,"description":"new height of the rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"dpx7P6ZcauHJQCBpQscVW","name":"rotate","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this renderable by the specified angle (in radians).
","params":[{"identifier":"angle","optional":false,"description":"The angle to rotate (in radians)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":true,"description":"an optional point to rotate around
","dataType":{"tokens":[{"value":"Vector2d | ObservableVector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"ZkOEoHO39DusECHziwVpN","name":"scale","brief":"","scope":"instance","type":"MethodDoc","description":"scale the renderable around his anchor point. Scaling actually applies changes\nto the currentTransform member wich is use...","params":[{"identifier":"x","optional":false,"description":"
a number representing the abscissa of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":true,"default":"x","description":"a number representing the ordinate of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"ALC1CaW9-Mb_a3bhkblZo","name":"scaleV","brief":"","scope":"instance","type":"MethodDoc","description":"scale the renderable around his anchor point
","params":[{"identifier":"v","optional":false,"description":"scaling vector
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"J8Ow-svh_JKgUhnUct5X9","name":"setOpacity","brief":"","scope":"instance","type":"MethodDoc","description":"set the renderable alpha channel value
","params":[{"identifier":"alpha","optional":false,"description":"opacity value between 0.0 and 1.0
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"txiguyX6l2I_C53zjpUVU","name":"setShape","brief":"","scope":"instance","type":"MethodDoc","description":"set new value to the rectangle shape
","params":[{"identifier":"x","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"w","optional":false,"description":"width of the rectangle, or an array of vector defining the rectangle
","dataType":{"tokens":[{"value":"number | Array","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %3<%2>"}},{"identifier":"h","optional":true,"description":"height of the rectangle, if a numeral width parameter is specified
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"2_THUokGil8-IHM1Ig7qR","name":"setVertices","brief":"","scope":"instance","type":"MethodDoc","description":"set the vertices defining this Polygon
","params":[{"identifier":"vertices","optional":false,"description":"array of vector or vertice defining the Polygon
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1<%2>"}}],"returns":[{"description":"this instance for objecf chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"acva9kkZGFr6BzbeophKW","name":"shift","brief":"","examples":[{"caption":"","code":"polygon.shift(10, 10);\n// or\npolygon.shift(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"Shifts the Polygon to the given position vector.
","params":[{"identifier":"x","description":"x coordinate or a vector point to shift to
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"uAf3wzhgI239i_izv0MdN","name":"to2d","brief":"","scope":"instance","type":"MethodDoc","description":"apply a 2d projection to this shapen
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"CRiELLtpWmF5hB3X0dLem","name":"toIso","brief":"","scope":"instance","type":"MethodDoc","description":"apply an isometric projection to this shape
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"tXrN5lMhzh3pj54qnZArW","name":"toPolygon","brief":"","scope":"instance","type":"MethodDoc","description":"Returns a polygon whose edges are the same as this box.
","params":[],"returns":[{"description":"a new Polygon that represents this rectangle.
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"p35dLZu_DO5bBHGDtJtTp","name":"transform","brief":"","scope":"instance","see":["Renderable#currentTransform"],"type":"MethodDoc","description":"multiply the renderable currentTransform with the given matrix
","params":[{"identifier":"m","optional":false,"description":"the transformation matrix
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"emxPZ9RUt4yIjhsiCbFBE","name":"translate","brief":"","examples":[{"caption":"","code":"polygon.translate(10, 10);\n// or\npolygon.translate(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"translate the Polygon by the specified offset
","params":[{"identifier":"x","description":"x offset or a vector point to translate by
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"description":"y offset
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"MAstcwecEpTOWP3pUQDVd","name":"union","brief":"","scope":"instance","type":"MethodDoc","description":"merge this rectangle with another one
","params":[{"identifier":"rect","optional":false,"description":"other rectangle to union with
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"the union(ed) rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"8JFkTsy2UmYUeproyrQu9","name":"update","brief":"","scope":"instance","type":"MethodDoc","description":"update function (automatically called by melonJS).
","params":[{"identifier":"dt","optional":false,"description":"time since the last update in milliseconds.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"true if the renderable is dirty
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"BaeyleVA6UQYNGsVdOvU3","name":"updateBounds","brief":"","scope":"instance","type":"MethodDoc","description":"update the bounding box for this shape.
","params":[{"identifier":"absolute","optional":true,"default":"true","description":"update the bounds size and position in (world) absolute coordinates
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"this shape bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"vWH1d9YEJU0B4oT6NA7hB","name":"onAnchorUpdate","brief":"","access":"private","scope":"instance","type":"MethodDoc","description":"called when the anchor point value is changed
","params":[{"identifier":"x","optional":false,"description":"the new X value to be set for the anchor
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the new Y value to be set for the anchor
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]}]},{"id":"71BdreFv4D5HWG5efNA3t","name":"Renderer","brief":"","type":"ClassDoc","description":"a base renderer object
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"Cpa6vS8I18l4JQMrV8Hmp","name":"getHeight","brief":"","access":"public","deprecated":"since 15.12.0","see":["height"],"type":"ClassDoc","description":"return the height of the system Canvas
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"Fa71sIvTkp9bGN_f9e2a5","name":"constructor","brief":"","access":"public","scope":"instance","type":"MethodDoc","params":[],"returns":[]}]},{"id":"bVubupOSDIl3cMaVFcwFB","name":"getWidth","brief":"","access":"public","deprecated":"since 15.12.0","see":["width"],"type":"ClassDoc","description":"return the width of the system Canvas
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"TgstikiRz2yQdL-5xAIFa","name":"constructor","brief":"","access":"public","scope":"instance","type":"MethodDoc","params":[],"returns":[]}]},{"id":"JjB0qQHMbCnw7Eezc1785","name":"Texture","brief":"","access":"public","deprecated":"since 10.4.0","see":["TextureAtlas"],"type":"ClassDoc","description":"Alias of {@link TextureAtlas}
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"hWeQ3PBt520oHkok8V61N","name":"constructor","brief":"","access":"public","scope":"instance","type":"MethodDoc","params":[],"returns":[]}]},{"id":"uFA40tnIL5VqTdOSAHlSq","name":"depthTest","brief":"","defaultValue":"\"sorting\"","scope":"instance","type":"PropertyDoc","description":"the default method to sort object ("sorting", "z-buffer")
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"cSiUCZgAwZMSWtiggPOyN","name":"designRatio","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"the requested video size ratio
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"TFZoz-GFRaeT0mno0wsIv","name":"height","brief":"","scope":"instance","type":"PropertyDoc","description":"return the height of the canvas which this renderer draws to
","params":[],"returns":[{"description":"height of the system Canvas
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"gr-2SKh2Il2y54pkh2xMb","name":"isContextValid","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"true if the current rendering context is valid
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"EwDygQAkYoIcKTKzfcGY0","name":"path2D","brief":"","scope":"instance","type":"PropertyDoc","description":"The Path2D instance used by the renderer to draw primitives
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Eku4xpc3Ihvn7R1lEKWyJ","name":"scaleRatio","brief":"","defaultValue":"<1,1>","scope":"instance","type":"PropertyDoc","description":"the scaling ratio to be applied to the main canvas
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"7UGg7tPT2rWDGOz9SWpny","name":"settings","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"The given constructor options
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"whpjZMBY8YWCzxBTn4mB1","name":"type","brief":"","defaultValue":"\"Generic\"","scope":"instance","type":"PropertyDoc","description":"The renderer type : Canvas, WebGL, etc...\n(override this property with a specific value when implementing a custom rendere...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"rWsAh1NyHUQs9VaWuUXEX","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"
return the width of the canvas which this renderer draws to
","params":[],"returns":[{"description":"width of the system Canvas
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"-YXZPuhm68UT3f-zS9Au3","name":"clear","brief":"prepare the framebuffer for drawing a new frame
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"KH3LxkSTdQUPRZFMwkro3","name":"clearMask","brief":"","scope":"instance","see":["Renderer#setMask"],"type":"MethodDoc","description":"disable (remove) the rendering mask set through setMask.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ux-V3IfgR_aIVQ4G5J7q8","name":"clearTint","brief":"","scope":"instance","see":["Renderer#setTint"],"type":"MethodDoc","description":"clear the rendering tint set through setTint.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"8mczDnUvCNLhsIS8oYzrc","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"options","optional":true,"description":"optional parameters for the renderer
","dataType":{"tokens":[{"value":"Application.Settings","kind":"canonical"},{"value":"Application.Settings","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"94rprlZkwSN7wUbxlOq9j","name":"fill","brief":"","scope":"instance","type":"MethodDoc","description":"fill the given shape
","params":[{"identifier":"shape","optional":false,"description":"a shape object to fill
","dataType":{"tokens":[{"value":"Rect | RoundRect | Polygon | Line | Ellipse","kind":"canonical"},{"value":"Rect","kind":"link"},{"value":"RoundRect","kind":"link"},{"value":"Polygon","kind":"link"},{"value":"Line","kind":"link"},{"value":"Ellipse","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5"}}],"returns":[],"extends":[],"implements":[]},{"id":"lJT82_d9A2P9wequR-1DV","name":"flush","brief":"render the main framebuffer on screen
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Diyy-j4d68Eaa8X0cyygx","name":"getBlendMode","brief":"","scope":"instance","type":"MethodDoc","description":"returns the current blend mode for this renderer
","params":[],"returns":[{"description":"blend mode
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"extends":[],"implements":[]},{"id":"fKm6ds4S473qmycmyAKJU","name":"getCanvas","brief":"","scope":"instance","type":"MethodDoc","description":"return a reference to the canvas which this renderer draws to
","params":[],"returns":[{"dataType":{"tokens":[{"value":"HTMLCanvasElement","kind":"canonical"},{"value":"HTMLCanvasElement","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"wzfdPTo2dpj6AcGaJ_Wra","name":"getColor","brief":"","scope":"instance","type":"MethodDoc","description":"get the current fill & stroke style color.
","params":[],"returns":[{"description":"current global color
","dataType":{"tokens":[{"value":"Color","kind":"canonical"},{"value":"Color","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"ezJnuVDlc-zFJAavwspZa","name":"getContext","brief":"","scope":"instance","type":"MethodDoc","description":"return a reference to this renderer canvas corresponding Context
","params":[],"returns":[{"dataType":{"tokens":[{"value":"CanvasRenderingContext2D | WebGLRenderingContext","kind":"canonical"},{"value":"CanvasRenderingContext2D","kind":"canonical"},{"value":"WebGLRenderingContext","kind":"canonical"}],"template":"%1 | %2"}}],"extends":[],"implements":[]},{"id":"IzWUoalR-izce6ygvNTWP","name":"getContext2d","brief":"","scope":"instance","type":"MethodDoc","description":"Returns the 2D Context object of the given Canvas
use false to disable transparency
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"dataType":{"tokens":[{"value":"CanvasRenderingContext2D","kind":"canonical"},{"value":"CanvasRenderingContext2D","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"dJu86ITI0lz6wRZ3x1r3c","name":"getScreenCanvas","brief":"","deprecated":"since 13.1.0","scope":"instance","see":["getCanvas();"],"type":"MethodDoc","description":"return a reference to the screen canvas
","params":[],"returns":[{"dataType":{"tokens":[{"value":"HTMLCanvasElement","kind":"canonical"},{"value":"HTMLCanvasElement","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"eiqkU-78iNs7tlcSgiAFS","name":"getScreenContext","brief":"","deprecated":"since 13.1.0","scope":"instance","see":["getContext();"],"type":"MethodDoc","description":"return a reference to the screen canvas corresponding 2d Context
return the current global alpha
","params":[],"returns":[{"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"9Y9sKPIj0NnecXBjDieX2","name":"overlaps","brief":"","scope":"instance","type":"MethodDoc","description":"check if the given rect or bounds overlaps with the renderer screen coordinates
","params":[{"identifier":"bounds","optional":false,"dataType":{"tokens":[{"value":"Rect | Bounds","kind":"canonical"},{"value":"Rect","kind":"link"},{"value":"Bounds","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"true if overlaps
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"l_EmdgCY18i4Za52mRbmK","name":"reset","brief":"Reset context state
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"6EfRx3DVuJPfCQ8_IxjNd","name":"resize","brief":"","scope":"instance","type":"MethodDoc","description":"resizes the system canvas
","params":[{"identifier":"width","optional":false,"description":"new width of the canvas
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"height","optional":false,"description":"new height of the canvas
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"JKUvrXYxGsK3FVZiP82zj","name":"setAntiAlias","brief":"","scope":"instance","type":"MethodDoc","description":"enable/disable image smoothing (scaling interpolation) for the given context
","params":[{"identifier":"context","optional":false,"dataType":{"tokens":[{"value":"CanvasRenderingContext2D","kind":"canonical"},{"value":"CanvasRenderingContext2D","kind":"canonical"}],"template":"%1"}},{"identifier":"enable","optional":true,"default":"false","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"Wa6sQLLUogApsWK07Nvin","name":"setMask","brief":"","scope":"instance","type":"MethodDoc","description":"A mask limits rendering elements to the shape and position of the given mask object.\nSo, if the renderable is larger than ...","params":[{"identifier":"mask","optional":true,"description":"
the shape defining the mask to be applied
","dataType":{"tokens":[{"value":"Rect | RoundRect | Polygon | Line | Ellipse","kind":"canonical"},{"value":"Rect","kind":"link"},{"value":"RoundRect","kind":"link"},{"value":"Polygon","kind":"link"},{"value":"Line","kind":"link"},{"value":"Ellipse","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5"}},{"identifier":"invert","optional":true,"default":"false","description":"either the given shape should define what is visible (default) or the opposite
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"SKOoSojxEfd1l0G0ncnwB","name":"setProjection","brief":"","scope":"instance","type":"MethodDoc","description":"set/change the current projection matrix (WebGL only)
","params":[{"identifier":"matrix","optional":false,"dataType":{"tokens":[{"value":"Matrix3d","kind":"canonical"},{"value":"Matrix3d","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"CUhd2nMYEMvSAbOe_Dvfc","name":"setTint","brief":"","scope":"instance","type":"MethodDoc","description":"set a coloring tint for sprite based renderables
","params":[{"identifier":"tint","optional":false,"description":"the tint color
","dataType":{"tokens":[{"value":"Color","kind":"canonical"},{"value":"Color","kind":"link"}],"template":"%1"}},{"identifier":"alpha","optional":true,"description":"an alpha value to be applied to the tint
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"HgwiUjRlGQLl92Jqo2t6h","name":"stroke","brief":"","scope":"instance","type":"MethodDoc","description":"stroke the given shape
","params":[{"identifier":"shape","optional":false,"description":"a shape object to stroke
","dataType":{"tokens":[{"value":"Rect | RoundRect | Polygon | Line | Ellipse","kind":"canonical"},{"value":"Rect","kind":"link"},{"value":"RoundRect","kind":"link"},{"value":"Polygon","kind":"link"},{"value":"Line","kind":"link"},{"value":"Ellipse","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5"}},{"identifier":"fill","optional":true,"default":"false","description":"fill the shape with the current color if true
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"UNS3oQFmzg3Q_TrJIDBMH","name":"tint","brief":"","scope":"instance","type":"MethodDoc","description":"tint the given image or canvas using the given color
","params":[{"identifier":"src","optional":false,"description":"the source image to be tinted
","dataType":{"tokens":[{"value":"HTMLImageElement | HTMLCanvasElement | OffscreenCanvas","kind":"canonical"},{"value":"HTMLImageElement","kind":"canonical"},{"value":"HTMLCanvasElement","kind":"canonical"},{"value":"OffscreenCanvas","kind":"canonical"}],"template":"%1 | %2 | %3"}},{"identifier":"color","optional":false,"description":"the color that will be used to tint the image
","dataType":{"tokens":[{"value":"Color | string","kind":"canonical"},{"value":"Color","kind":"link"}],"template":"%1 | string"}},{"identifier":"mode","optional":true,"default":"\"multiply\"","description":"the composition mode used to tint the image
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"returns":[{"description":"a new canvas element representing the tinted image
","dataType":{"tokens":[{"value":"HTMLCanvasElement | OffscreenCanvas","kind":"canonical"},{"value":"HTMLCanvasElement","kind":"canonical"},{"value":"OffscreenCanvas","kind":"canonical"}],"template":"%1 | %2"}}],"extends":[],"implements":[]},{"id":"IkiSfI2qqb_e4d4kFAhjN","name":"toBlob","brief":"","examples":[{"caption":"","code":"renderer.convertToBlob().then((blob) => console.log(blob));"}],"scope":"instance","type":"MethodDoc","description":"creates a Blob object representing the last rendered frame
","params":[{"identifier":"type","optional":true,"default":"\"image/png\"","description":"A string indicating the image format
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"quality","optional":true,"description":"A Number between 0 and 1 indicating the image quality to be used when creating images using file formats that support loss...","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"
A Promise returning a Blob object representing the last rendered frame
","dataType":{"tokens":[{"value":"Promise","kind":"canonical"},{"value":"Promise","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"L5L0fy0EcVJbZ5Y2RfMU7","name":"toDataURL","brief":"","examples":[{"caption":"","code":"renderer.toDataURL().then((dataURL) => console.log(dataURL));"}],"scope":"instance","type":"MethodDoc","description":"returns a data URL containing a representation of the last frame rendered
","params":[{"identifier":"type","optional":true,"default":"\"image/png\"","description":"A string indicating the image format
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"quality","optional":true,"description":"A Number between 0 and 1 indicating the image quality to be used when creating images using file formats that support loss...","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"
A Promise returning a string containing the requested data URL.
","dataType":{"tokens":[{"value":"Promise","kind":"canonical"},{"value":"Promise","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"2sOq5C_PPdJ0I5DmGUZzx","name":"toImageBitmap","brief":"","examples":[{"caption":"","code":"renderer.transferToImageBitmap().then((image) => console.log(image));"}],"scope":"instance","type":"MethodDoc","description":"creates an ImageBitmap object of the last frame rendered\n(not supported by standard Canvas)
","params":[{"identifier":"type","optional":true,"default":"\"image/png\"","description":"A string indicating the image format
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"quality","optional":true,"description":"A Number between 0 and 1 indicating the image quality to be used when creating images using file formats that support loss...","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"
A Promise returning an ImageBitmap.
","dataType":{"tokens":[{"value":"Promise","kind":"canonical"},{"value":"Promise","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]}]},{"id":"D_XZs1bRugnLr2Ln3gqDz","name":"ResponseObject","brief":"","access":"public","type":"ClassDoc","description":"An object representing the result of an intersection.
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"Ag3L-P5OhGC81lGZ7q7Wc","name":"a","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"The first object participating in the intersection
"},{"id":"r5VRpw4CouxXsKEm8DTts","name":"aInB","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"Whether the first object is entirely inside the second
"},{"id":"Vi4Zsxc1UzItVEnHtJPOb","name":"b","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"The second object participating in the intersection
"},{"id":"fVmROA6ZIm3iVOTzv3VNm","name":"bInA","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"Whether the second object is entirely inside the first
"},{"id":"urXdzht7h15gzDmsdaIGf","name":"indexShapeA","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"The index of the colliding shape for the object a body
"},{"id":"AVPdL2SNyalGg0Lu8ziDB","name":"indexShapeB","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"The index of the colliding shape for the object b body
"},{"id":"_QYrQluOfg9zTDKzvFQxD","name":"overlap","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"Magnitude of the overlap on the shortest colliding axis
"},{"id":"FJ_Wh9w7oWw215BmWE0KH","name":"overlapN","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"The shortest colliding axis (unit-vector)
"},{"id":"lH7zPWvGccme5DSnY5h70","name":"overlapV","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"The overlap vector (i.e. overlapN.scale(overlap, overlap)). If this vector is subtracted from the position of..."},{"id":"LWl0YpoyIzjYQVzOP3zGC","name":"clear","brief":"","access":"public","scope":"instance","type":"MethodDoc","description":"
Set some values of the response back to their defaults. this object for chaining
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}}],"extends":[],"implements":[]}]},{"id":"imBZdkWYmMcPwN7q0LdVG","name":"RoundRect","brief":"","type":"ClassDoc","description":"a rectangle object with rounded corners
","params":[],"returns":[],"extends":["Rect"],"implements":[],"members":[{"id":"nN1A5BAs3E6eUpyZcoehW","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"vLv310tHjUPfOSKQ1s73b","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"IFr9lFOe1mdY0ruzrxUXr","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"gWWwlk5cLgo1BtiMAdHo6","name":"height","brief":"","scope":"instance","type":"PropertyDoc","description":"height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"w7xL-5mInEk_fAIV1O2Eq","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"yVPMo7jTDomijgf9o8dZr","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"riG_knBqnr0COe3zMQ-9p","name":"pos","brief":"","scope":"instance","type":"PropertyDoc","description":"
origin point of the Polygon
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"hTVry9su4YpG3aBFWGVgC","name":"radius","brief":"","defaultValue":"20","scope":"instance","type":"PropertyDoc","description":"the radius of the rounded corner
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"IzUIKqVIPgDGgzQpY9qM7","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"gd38g5fQtcm2w5ObGXgld","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"yNCczrOKrXe6HszqRoliP","name":"type","brief":"","defaultValue":"\"RoundRect\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"6fIDL0WdxefMYk70tVqAK","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"RMTg1RUa7KjIsozIwPwvz","name":"centerOn","brief":"","scope":"instance","type":"MethodDoc","description":"center the rectangle position around the given coordinates
","params":[{"identifier":"x","optional":false,"description":"the x coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"2hz0NWfIOpucIhVxh8U5D","name":"clone","brief":"","scope":"instance","type":"MethodDoc","description":"clone this RoundRect
","params":[],"returns":[{"description":"new RoundRect
","dataType":{"tokens":[{"value":"RoundRect","kind":"canonical"},{"value":"RoundRect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"WMZ3izqyX3xwbdM5GjSF4","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"x","optional":false,"description":"position of the rounded rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"position of the rounded rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"width","optional":false,"description":"the rectangle width
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"height","optional":false,"description":"the rectangle height
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"radius","optional":true,"default":"20","description":"the radius of the rounded corner
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"vyUq9xis1j304PO_nEAHn","name":"contains","brief":"","examples":[{"caption":"","code":"if (rect.contains(10, 10)) {\n // do something\n}\n// or\nif (rect.contains(myVector2d)) {\n // do something\n}\nif (rect.contains(myRect)) {\n // do something\n}"}],"scope":"instance","type":"MethodDoc","description":"Returns true if the rounded rectangle contains the given point or rectangle
","params":[{"identifier":"x","description":"x coordinate or a vector point, or a Rect to test
","dataType":{"tokens":[{"value":"number | Vector2d | Rect","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Rect","kind":"link"}],"template":"%1 | %2 | %3"}},{"identifier":"y","optional":true,"description":"y coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"True if the rounded rectangle contain the given point or rectangle, otherwise false
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"wXE78r7B4VTJt45wwkiuc","name":"copy","brief":"","scope":"instance","type":"MethodDoc","description":"copy the position, size and radius of the given rounded rectangle into this one
","params":[{"identifier":"rrect","optional":false,"description":"source rounded rectangle
","dataType":{"tokens":[{"value":"RoundRect","kind":"canonical"},{"value":"RoundRect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"RoundRect","kind":"canonical"},{"value":"RoundRect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"R1uM4NqcBp6MTAyXkpiqM","name":"equals","brief":"","scope":"instance","type":"MethodDoc","description":"check if this RoundRect is identical to the specified one
","params":[{"identifier":"rrect","optional":false,"dataType":{"tokens":[{"value":"RoundRect","kind":"canonical"},{"value":"RoundRect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if equals
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"D7C9KdyRWU54EY3C0GnRI","name":"getBounds","brief":"","scope":"instance","type":"MethodDoc","description":"returns the bounding box for this shape, the smallest Rectangle object completely containing this shape.
","params":[],"returns":[{"description":"this shape bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"-Biv4SD4BJNnEii7Dk2Cv","name":"getIndices","brief":"","scope":"instance","type":"MethodDoc","description":"returns a list of indices for all triangles defined in this polygon
","params":[],"returns":[{"description":"an array of vertex indices for all triangles forming this polygon.
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1<%2>"}}],"extends":[],"implements":[]},{"id":"wtaLmNRTwOiAIl3av8g6v","name":"isConvex","brief":"","scope":"instance","type":"MethodDoc","description":"Returns true if the vertices composing this polygon form a convex shape (vertices must be in clockwise order).
","params":[],"returns":[{"description":"true if the vertices are convex, false if not, null if not computable
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"svJUMysLOCdyoDERylkgW","name":"isFinite","brief":"","scope":"instance","type":"MethodDoc","description":"determines whether all coordinates of this rectangle are finite numbers.
","params":[],"returns":[{"description":"false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"e975FYJAO-uzyE31QNAXT","name":"overlaps","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is intersecting with the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if overlaps
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"fZb8cQtAKAAmvu1APkHBd","name":"recalc","brief":"","scope":"instance","type":"MethodDoc","description":"Computes the calculated collision polygon.\nThis must be called if the points array, an...","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"YmEOpRk3RBOY7jU1QWHT2","name":"resize","brief":"","scope":"instance","type":"MethodDoc","description":"resize the rectangle
","params":[{"identifier":"w","optional":false,"description":"new width of the rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"h","optional":false,"description":"new height of the rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"DRA9GtKm1b-YL0kujMfWb","name":"rotate","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this Polygon (counter-clockwise) by the specified angle (in radians).
","params":[{"identifier":"angle","optional":false,"description":"The angle to rotate (in radians)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":true,"description":"an optional point to rotate around
","dataType":{"tokens":[{"value":"Vector2d | ObservableVector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"f5hFZ0f94yj4QGj_eFQsI","name":"scale","brief":"","scope":"instance","type":"MethodDoc","description":"scale the rectangle
","params":[{"identifier":"x","optional":false,"description":"a number representing the abscissa of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":true,"default":"x","description":"a number representing the ordinate of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"3EuGH227lmp44fYX_r8xH","name":"scaleV","brief":"","scope":"instance","type":"MethodDoc","description":"Scale this Polygon by the given vector
","params":[{"identifier":"v","optional":false,"dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"v6pTDZVlv3HaoqoZ-eLcb","name":"setShape","brief":"","scope":"instance","type":"MethodDoc","description":"set new value to the rectangle shape
","params":[{"identifier":"x","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"w","optional":false,"description":"width of the rectangle, or an array of vector defining the rectangle
","dataType":{"tokens":[{"value":"number | Array","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %3<%2>"}},{"identifier":"h","optional":true,"description":"height of the rectangle, if a numeral width parameter is specified
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"ZuU6cjBWqo4IRCNHTSqSr","name":"setVertices","brief":"","scope":"instance","type":"MethodDoc","description":"set the vertices defining this Polygon
","params":[{"identifier":"vertices","optional":false,"description":"array of vector or vertice defining the Polygon
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1<%2>"}}],"returns":[{"description":"this instance for objecf chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"mjLdfwW4OWUZsxDtmNTA6","name":"shift","brief":"","examples":[{"caption":"","code":"polygon.shift(10, 10);\n// or\npolygon.shift(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"Shifts the Polygon to the given position vector.
","params":[{"identifier":"x","description":"x coordinate or a vector point to shift to
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"kdp_qyaXwJXtP0YNWWxYS","name":"to2d","brief":"","scope":"instance","type":"MethodDoc","description":"apply a 2d projection to this shapen
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"YLEgNiUENf3BUQfKWFotf","name":"toIso","brief":"","scope":"instance","type":"MethodDoc","description":"apply an isometric projection to this shape
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"L2cnDMEsvBrcUUP0GpD9F","name":"toPolygon","brief":"","scope":"instance","type":"MethodDoc","description":"Returns a polygon whose edges are the same as this box.
","params":[],"returns":[{"description":"a new Polygon that represents this rectangle.
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"PV0PcmAe_78BhKOVj18n4","name":"transform","brief":"","scope":"instance","type":"MethodDoc","description":"apply the given transformation matrix to this Polygon
","params":[{"identifier":"m","optional":false,"description":"the transformation matrix
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"2D1Osb8S9k4_tmyVESZcF","name":"translate","brief":"","examples":[{"caption":"","code":"polygon.translate(10, 10);\n// or\npolygon.translate(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"translate the Polygon by the specified offset
","params":[{"identifier":"x","description":"x offset or a vector point to translate by
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"description":"y offset
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"4AxGQSu0Oy-VWuXCg6qs6","name":"union","brief":"","scope":"instance","type":"MethodDoc","description":"merge this rectangle with another one
","params":[{"identifier":"rect","optional":false,"description":"other rectangle to union with
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"the union(ed) rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"dNjkh3dXTXOBu0gs7PjxU","name":"updateBounds","brief":"","scope":"instance","type":"MethodDoc","description":"update the bounding box for this shape.
","params":[],"returns":[{"description":"this shape bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]}]},{"id":"HM_U1RR9i85ASRDmRDDZy","name":"Sprite","brief":"","type":"ClassDoc","description":"An object to display a fixed or animated sprite on screen.
","params":[],"returns":[],"extends":["Renderable"],"implements":[],"members":[{"id":"BQLZGfhQPK4RtaF510aZX","name":"alpha","brief":"","defaultValue":"1.0","scope":"instance","see":["Renderable#setOpacity","Renderable#getOpacity"],"type":"PropertyDoc","description":"Define the renderable opacity
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"JDcLCXzwXw85anVS7di6c","name":"alwaysUpdate","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object will always update, even when outside of the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"sTAAEAlxBHEoJLC-VEUN5","name":"ancestor","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"a reference to the parent object that contains this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"iI3twztwriK2qwjGWOYEY","name":"anchorPoint","brief":"","defaultValue":"<0.5,0.5>","scope":"instance","type":"PropertyDoc","description":"The anchor point is used for attachment behavior, and/or when applying transformations.
animation cycling speed (delay between frame in ms)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"5HoVDEE6e5iRX4Rt2g4p_","name":"autoTransform","brief":"","defaultValue":"true","examples":[{"caption":"","code":"// enable \"automatic\" transformation when the object is activated\nonActivateEvent: function () {\n // reset the transformation matrix\n this.currentTransform.identity();\n // ensure the anchor point is the renderable center\n this.anchorPoint.set(0.5, 0.5);\n // enable auto transform\n this.autoTransform = true;\n ....\n}"}],"scope":"instance","type":"PropertyDoc","description":"When enabled, an object container will automatically apply\nany defined transformation before calling the child draw method...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"XOj58qwwvA-vkt8X4rP6J","name":"blendMode","brief":"","defaultValue":"\"normal\"","scope":"instance","see":["CanvasRenderer#setBlendMode","WebGLRenderer#setBlendMode"],"type":"PropertyDoc","description":"
the blend mode to be applied to this renderable (see renderer setBlendMode for available blend mode)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"UL4Veovz8557SmxX5E-s8","name":"body","brief":"","examples":[{"caption":"","code":" // define a new Player Class\n class PlayerEntity extends me.Sprite {\n // constructor\n constructor(x, y, settings) {\n // call the parent constructor\n super(x, y , settings);\n\n // define a basic walking animation\n this.addAnimation(\"walk\", [...]);\n // define a standing animation (using the first frame)\n this.addAnimation(\"stand\", [...]);\n // set the standing animation as default\n this.setCurrentAnimation(\"stand\");\n\n // add a physic body\n this.body = new me.Body(this);\n // add a default collision shape\n this.body.addShape(new me.Rect(0, 0, this.width, this.height));\n // configure max speed, friction, and initial force to be applied\n this.body.setMaxVelocity(3, 15);\n this.body.setFriction(0.4, 0);\n this.body.force.set(3, 0);\n this.isKinematic = false;\n\n // set the display to follow our position on both axis\n me.game.viewport.follow(this.pos, me.game.viewport.AXIS.BOTH);\n }\n\n ...\n\n }"}],"scope":"instance","type":"PropertyDoc","description":"the renderable physic body
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"wv86HnCe392uNCrxNcOHG","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"AmkGbotHAJCcxnQbEpeiI","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"wOxZqCWi_d0_Bk7Zm2BKI","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"KkHLA-cNLgWT6tmIAIGw3","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"JNF4A5azDbRWPVOJ7KjtU","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"C3wrb1uZj77xQLM4aqSZA","name":"floating","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"If true, this renderable will be rendered using screen coordinates,\nas opposed to world coordinates. Use this, for example...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ZkNKYVJzNvC1IeM1x3H8o","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"
(G)ame (U)nique (Id)entifier"
height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"fZbAlib2l9JWRa9Gknzwq","name":"inViewport","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object is visible and within the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"rGcp2QSCwCFmUTqPAr5fJ","name":"isDirty","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"when true the renderable will be redrawn during the next update cycle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"cwMm5665yMU6lNruCkaTr","name":"isFlippedX","brief":"","access":"public","scope":"instance","see":["Renderable#flipX"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"9C_lPGyYfzPvzo4NHqp8Z","name":"isFlippedY","brief":"","access":"public","scope":"instance","see":["Renderable#flipY"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"F6rWYhvaUhYTWL6Zcb5L8","name":"isFloating","brief":"","scope":"instance","see":["Renderable#floating"],"type":"PropertyDoc","description":"Whether the renderable object is floating (i.e. used screen coordinates), or contained in a floating parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"FgUBTrhJeKrkLK0ltyAa7","name":"isKinematic","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"If true then physic collision and input events will not impact this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"rSk0mr7mRtYn22iOFE9iP","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"gZb5SBwj8hMijB8cft--Z","name":"isVideo","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"true if this is a video sprite (e.g. a HTMLVideoElement was passed as as source)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"0snf7s2tIhqLUSV83Qy8w","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"nzGelo0hDZWWK-nGsl5PO","name":"mask","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"// apply a mask in the shape of a Star\nmyNPCSprite.mask = new me.Polygon(myNPCSprite.width / 2, 0, [\n // draw a star\n {x: 0, y: 0},\n {x: 14, y: 30},\n {x: 47, y: 35},\n {x: 23, y: 57},\n {x: 44, y: 90},\n {x: 0, y: 62},\n {x: -44, y: 90},\n {x: -23, y: 57},\n {x: -47, y: 35},\n {x: -14, y: 30}\n]);"}],"scope":"instance","type":"PropertyDoc","description":"A mask limits rendering elements to the shape and position of the given mask object.\nSo, if the renderable is larger than ...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"0XPG966YQ0j_MWhqGBwi1","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"T_frXBmGLPQDnx2CxZ3S_","name":"offset","brief":"","defaultValue":"<0.0,0.0>","scope":"instance","type":"PropertyDoc","description":"global offset for the position to draw from on the source image.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"pVjStDi7j7H1Al26A5sjV","name":"onVisibilityChange","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"this.onVisibilityChange = function(inViewport) {\n if (inViewport === true) {\n console.log(\"object has entered the in a camera viewport!\");\n }\n};"}],"scope":"instance","type":"PropertyDoc","description":"an event handler that is called when the renderable leave or enter a camera viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"DlcpXvzx68jkchsx0b9GP","name":"parentApp","brief":"","scope":"instance","type":"PropertyDoc","description":"returns the parent application (or game) to which this renderable is attached to
","params":[],"returns":[{"description":"the parent application or undefined if not attached to any container/app
","dataType":{"tokens":[{"value":"Application","kind":"canonical"},{"value":"Application","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"v2neRSCcArUKr8LOdj5ZR","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ftOJfQp_jMjOFdFtbFNoK","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ntiN9t8hduXSrcXVU3w2d","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"oeryyr11C1ZCm6K8118sG","name":"shader","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"(Experimental) an optional shader, to be used instead of the default built-in one, when drawing this renderable (WebGL onl...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"yQ_phXIkHnB-jq8jb-FfX","name":"source","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"
The source texture object this sprite object is using
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"-f7Cr-uVlAyaq_EbvRvQr","name":"tint","brief":"","defaultValue":"(255, 255, 255)","examples":[{"caption":"","code":"// add a red tint to this renderable\nthis.tint.setColor(255, 128, 128);\n// remove the tint\nthis.tint.setColor(255, 255, 255);"}],"scope":"instance","type":"PropertyDoc","description":"define a tint for this renderable. a (255, 255, 255) r, g, b value will remove the tint effect.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"mqdmFtrUf1sqO_kx8uRN2","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"E4Ek2mjnskI6WMBVYDzeh","name":"type","brief":"","defaultValue":"\"Rectangle\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"1IpPHcjUxEFLN6Atz46CY","name":"updateWhenPaused","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether to update this object when the game is paused.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"upcQBm84R44FeeH7NULXI","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"XYCGJRawcBwvhn0K_L8S7","name":"addAnimation","brief":"","examples":[{"caption":"","code":"// walking animation\nthis.addAnimation(\"walk\", [ 0, 1, 2, 3, 4, 5 ]);\n// standing animation\nthis.addAnimation(\"stand\", [ 11, 12 ]);\n// eating animation\nthis.addAnimation(\"eat\", [ 6, 6 ]);\n// rolling animation\nthis.addAnimation(\"roll\", [ 7, 8, 9, 10 ]);\n// slower animation\nthis.addAnimation(\"roll\", [ 7, 8, 9, 10 ], 200);\n// or get more specific with delay for each frame. Good solution instead of repeating:\nthis.addAnimation(\"turn\", [{ name: 0, delay: 200 }, { name: 1, delay: 100 }])\n// can do this with atlas values as well:\nthis.addAnimation(\"turn\", [{ name: \"turnone\", delay: 200 }, { name: \"turntwo\", delay: 100 }])\n// define an dying animation that stop on the last frame\nthis.addAnimation(\"die\", [{ name: 3, delay: 200 }, { name: 4, delay: 100 }, { name: 5, delay: Infinity }])\n// set the standing animation as default\nthis.setCurrentAnimation(\"stand\");"}],"scope":"instance","see":["Sprite#animationspeed"],"type":"MethodDoc","description":"add an animation
animation id
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"index","optional":false,"description":"list of sprite index or name defining the animation. Can also use objects to specify delay for each frame, see below
","dataType":{"tokens":[{"value":"Array | Array | Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"}],"template":"%1<%2> | %3 | %4"}},{"identifier":"animationspeed","optional":true,"description":"cycling speed for animation in ms
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"frame amount of frame added to the animation (delay between each frame).
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"L5Qh0M4x5uyxcGpt3oCL1","name":"angleTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the angle to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"angle in radians
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"5I1N_pEBSLy8W39yB4N8a","name":"centerOn","brief":"","scope":"instance","type":"MethodDoc","description":"center the rectangle position around the given coordinates
","params":[{"identifier":"x","optional":false,"description":"the x coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"-N8KwqCQ_j_-zH_D1hlib","name":"clone","brief":"","scope":"instance","type":"MethodDoc","description":"clone this rectangle
","params":[],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"34BFxF_1RT8kuelV4-aFP","name":"constructor","brief":"","examples":[{"caption":"","code":" // create a single sprite from a standalone image, with anchor in the center\n let sprite = new me.Sprite(0, 0, {\n image : \"PlayerTexture\",\n framewidth : 64,\n frameheight : 64,\n anchorPoint : new me.Vector2d(0.5, 0.5)\n });\n\n // create a single sprite from a packed texture\n mytexture = new me.TextureAtlas(\n me.loader.getJSON(\"texture\"),\n me.loader.getImage(\"texture\")\n );\n let sprite = new me.Sprite(0, 0, {\n image : mytexture,\n region : \"npc2.png\",\n });\n\n // create a video sprite\n let videoSprite = new me.Sprite(0, 0, {\n image : me.loader.getVideo(\"bigbunny\"),\n anchorPoint : new me.Vector2d(0.5, 0.5)\n });\n // scale the video sprite\n videoSprite.currentTransform.scale(2);\n // start playing the video (if video is preloaded with `autoplay` set to false)\n videoSprite.play();"}],"scope":"instance","type":"MethodDoc","params":[{"identifier":"x","optional":false,"description":"the x coordinates of the sprite object
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y coordinates of the sprite object
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings","optional":false,"description":"Configuration parameters for the Sprite object
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}},{"identifier":"settings.image","description":"reference to spritesheet image, a texture atlas, a video element, or to a texture atlas
","dataType":{"tokens":[{"value":"HTMLImageElement | HTMLCanvasElement | HTMLVideoElement | TextureAtlas | string","kind":"canonical"},{"value":"HTMLImageElement","kind":"canonical"},{"value":"HTMLCanvasElement","kind":"canonical"},{"value":"HTMLVideoElement","kind":"canonical"},{"value":"TextureAtlas","kind":"link"}],"template":"%1 | %2 | %3 | %4 | string"}},{"identifier":"settings.name","optional":true,"default":"\"\"","description":"name of this object
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"settings.region","optional":true,"description":"region name of a specific region to use when using a texture atlas, see {@link TextureAtlas}
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"settings.framewidth","optional":true,"description":"Width of a single frame within the spritesheet
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings.frameheight","optional":true,"description":"Height of a single frame within the spritesheet
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings.tint","optional":true,"description":"a tint to be applied to this sprite
","dataType":{"tokens":[{"value":"string | Color","kind":"canonical"},{"value":"Color","kind":"link"}],"template":"string | %1"}},{"identifier":"settings.flipX","optional":true,"description":"flip the sprite on the horizontal axis
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings.flipY","optional":true,"description":"flip the sprite on the vertical axis
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings.anchorPoint","optional":true,"default":"{x:0.5, y:0.5}","description":"Anchor point to draw the frame at (defaults to the center of the frame).
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"M8SXbNnzBEhxeVXkCHPzA","name":"contains","brief":"","examples":[{"caption":"","code":"if (rect.contains(10, 10)) {\n // do something\n}\n// or\nif (rect.contains(myVector2d)) {\n // do something\n}\nif (rect.contains(myRect)) {\n // do something\n}"}],"scope":"instance","type":"MethodDoc","description":"Returns true if the rectangle contains the given point or rectangle
","params":[{"identifier":"x","description":"x coordinate or a vector point, or a rectangle to test
","dataType":{"tokens":[{"value":"number | Vector2d | Rect","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Rect","kind":"link"}],"template":"%1 | %2 | %3"}},{"identifier":"y","optional":true,"description":"y coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"True if the rectangle contain the given point or rectangle, otherwise false
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"sVaycgutN1Ios2QmGbPK_","name":"copy","brief":"","scope":"instance","type":"MethodDoc","description":"copy the position and size of the given rectangle into this one
","params":[{"identifier":"rect","optional":false,"description":"Source rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Cn5uqwetRBU7_6rQRRvyU","name":"distanceTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the distance to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"distance
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"6aw8p5wjAXwjRBVRFeTWz","name":"equals","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is identical to the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if equals
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"bfH4lPedhY0Pho_iR3lq0","name":"flicker","brief":"","examples":[{"caption":"","code":"// make the object flicker for 1 second\n// and then remove it\nthis.flicker(1000, function () {\n world.removeChild(this);\n});"}],"scope":"instance","type":"MethodDoc","description":"make the object flicker
","params":[{"identifier":"duration","optional":false,"description":"expressed in milliseconds
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"callback","optional":false,"description":"Function to call when flickering ends
","dataType":{"tokens":[{"value":"Function","kind":"canonical"}],"template":"Function"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Sprite","kind":"canonical"},{"value":"Sprite","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"2OXJp9Qy8yhQxSqWyco_q","name":"flipX","brief":"","scope":"instance","see":["Matrix2d#scaleX"],"type":"MethodDoc","description":"flip the renderable on the horizontal axis (around the center of the renderable)
","params":[{"identifier":"flip","optional":true,"default":"true","description":"true to flip this renderable.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"TnWChFM9DwwKiYQDwV17s","name":"flipY","brief":"","scope":"instance","see":["Matrix2d#scaleY"],"type":"MethodDoc","description":"flip the renderable on the vertical axis (around the center of the renderable)
","params":[{"identifier":"flip","optional":true,"default":"true","description":"true to flip this renderable.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"SXI2ovLGhW36zl_Dj91Lf","name":"getAbsolutePosition","brief":"","scope":"instance","type":"MethodDoc","description":"return the renderable absolute position in the game world
","params":[],"returns":[{"dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"39z3NT-O4lWsrUKpb-CfX","name":"getBounds","brief":"","scope":"instance","type":"MethodDoc","description":"returns the bounding box for this renderable
","params":[],"returns":[{"description":"bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"h7_-jDYG_KpyG-ncQbPbl","name":"getCurrentAnimationFrame","brief":"","scope":"instance","type":"MethodDoc","description":"return the current animation frame index.
","params":[],"returns":[{"description":"current animation frame index
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Hi-5sC_OBs3INM06Y3BFb","name":"getIndices","brief":"","scope":"instance","type":"MethodDoc","description":"returns a list of indices for all triangles defined in this polygon
","params":[],"returns":[{"description":"an array of vertex indices for all triangles forming this polygon.
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1<%2>"}}],"extends":[],"implements":[]},{"id":"Unew-qSHx47INQ4MUJZLz","name":"getOpacity","brief":"","scope":"instance","type":"MethodDoc","description":"get the renderable alpha channel value
","params":[],"returns":[{"description":"current opacity value between 0 and 1
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"tXHKOA0LLUq977hYlg73v","name":"isConvex","brief":"","scope":"instance","type":"MethodDoc","description":"Returns true if the vertices composing this polygon form a convex shape (vertices must be in clockwise order).
","params":[],"returns":[{"description":"true if the vertices are convex, false if not, null if not computable
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"BSA_4q6cZEJsHjmxKZx36","name":"isCurrentAnimation","brief":"","examples":[{"caption":"","code":"if (!this.isCurrentAnimation(\"walk\")) {\n // do something funny...\n}"}],"scope":"instance","type":"MethodDoc","description":"return true if the specified animation is the current one.
","params":[{"identifier":"name","optional":false,"description":"animation id
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"returns":[{"dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"L8GXSx_T5W1e1DU4zlsTW","name":"isFinite","brief":"","scope":"instance","type":"MethodDoc","description":"determines whether all coordinates of this rectangle are finite numbers.
","params":[],"returns":[{"description":"false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"rrVx025-05-ccJz6uPPgS","name":"isFlickering","brief":"","scope":"instance","type":"MethodDoc","description":"return the flickering state of the object
","params":[],"returns":[{"dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"QXyDl9KymJx0BGAVsTHtI","name":"lookAt","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this renderable towards the given target.
","params":[{"identifier":"target","optional":false,"description":"the renderable or position to look at
","dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"MT9dQj8iJF6d4xE4Vpn5X","name":"onCollision","brief":"","examples":[{"caption":"","code":"// colision handler\nonCollision(response) {\n if (response.b.body.collisionType === me.collision.types.ENEMY_OBJECT) {\n // makes the other object solid, by substracting the overlap vector to the current position\n this.pos.sub(response.overlapV);\n this.hurt();\n // not solid\n return false;\n }\n // Make the object solid\n return true;\n},"}],"scope":"instance","type":"MethodDoc","description":"onCollision callback, triggered in case of collision,\nwhen this renderable body is colliding with another one
","params":[{"identifier":"response","optional":false,"description":"the collision response object
","dataType":{"tokens":[{"value":"ResponseObject","kind":"canonical"},{"value":"ResponseObject","kind":"link"}],"template":"%1"}},{"identifier":"other","optional":false,"description":"the other renderable touching this one (a reference to response.a or response.b)
","dataType":{"tokens":[{"value":"Renderable | Container | Entity | Sprite | NineSliceSprite","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Container","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"NineSliceSprite","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5"}}],"returns":[{"description":"true if the object should respond to the collision (its position and velocity will be corrected)
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"VqcbcH6Y2GToIUMuHdR2l","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"OnDestroy Notification function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"dmx4ggH5TBOQe6noY-5WH","name":"overlaps","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is intersecting with the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if overlaps
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"4jLYcdVZ1H2hjRLmQDl5l","name":"pause","brief":"play or resume the current animation or video
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"xp652y0ZP8FDNvQheanYE","name":"play","brief":"play or resume the current animation or video
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"0NgsDlS6fXq8an73LcuDO","name":"postDraw","brief":"","scope":"instance","see":["Renderable#preDraw","Renderable#draw"],"type":"MethodDoc","description":"restore the rendering context after drawing (automatically called by melonJS).
","params":[{"identifier":"renderer","optional":false,"description":"a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"EQDAIu6a0nhyGzlJ8Gl8Y","name":"preDraw","brief":"","scope":"instance","see":["Renderable#draw","Renderable#postDraw"],"type":"MethodDoc","description":"Prepare the rendering context before drawing (automatically called by melonJS).\nThis will apply any defined transforms, an...","params":[{"identifier":"renderer","optional":false,"description":"
a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"z56Zu3TfCZJV8rb1jSGl5","name":"recalc","brief":"","scope":"instance","type":"MethodDoc","description":"Computes the calculated collision polygon.\nThis must be called if the points array, an...","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"HbCgaySt4WXsgkWGtqKJE","name":"resize","brief":"","scope":"instance","type":"MethodDoc","description":"resize the rectangle
","params":[{"identifier":"w","optional":false,"description":"new width of the rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"h","optional":false,"description":"new height of the rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"rEhrbrndgjTe3G6_9mnzf","name":"reverseAnimation","brief":"","scope":"instance","see":["Sprite#animationspeed"],"type":"MethodDoc","description":"reverse the given or current animation if none is specified
","params":[{"identifier":"name","optional":true,"description":"animation id
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Sprite","kind":"canonical"},{"value":"Sprite","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"UENehBGBe3I8RBHbTFZWJ","name":"rotate","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this renderable by the specified angle (in radians).
","params":[{"identifier":"angle","optional":false,"description":"The angle to rotate (in radians)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":true,"description":"an optional point to rotate around
","dataType":{"tokens":[{"value":"Vector2d | ObservableVector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"m9VYIjX5cx--YjOVletdp","name":"scale","brief":"","scope":"instance","type":"MethodDoc","description":"scale the renderable around his anchor point. Scaling actually applies changes\nto the currentTransform member wich is use...","params":[{"identifier":"x","optional":false,"description":"
a number representing the abscissa of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":true,"default":"x","description":"a number representing the ordinate of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"5VZOzsOA-UdJ5SVLNUWHD","name":"scaleV","brief":"","scope":"instance","type":"MethodDoc","description":"scale the renderable around his anchor point
","params":[{"identifier":"v","optional":false,"description":"scaling vector
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"VhX5ZpffCCwy7t5e4rDZx","name":"setAnimationFrame","brief":"","examples":[{"caption":"","code":"// reset the current animation to the first frame\nthis.setAnimationFrame();"}],"scope":"instance","type":"MethodDoc","description":"force the current animation frame index.
","params":[{"identifier":"index","optional":true,"default":"0","description":"animation frame index
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Sprite","kind":"canonical"},{"value":"Sprite","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"9uacSbItmMip58DmoasCg","name":"setCurrentAnimation","brief":"","examples":[{"caption":"","code":" // set \"walk\" animation\n this.setCurrentAnimation(\"walk\");\n\n // set \"walk\" animation if it is not the current animation\n if (this.isCurrentAnimation(\"walk\")) {\n this.setCurrentAnimation(\"walk\");\n }\n\n // set \"eat\" animation, and switch to \"walk\" when complete\n this.setCurrentAnimation(\"eat\", \"walk\");\n\n // set \"die\" animation, and remove the object when finished\n this.setCurrentAnimation(\"die\", () => {\n world.removeChild(this);\n return false; // do not reset to first frame\n });\n\n // set \"attack\" animation, and pause for a short duration\n this.setCurrentAnimation(\"die\", () => {\n this.animationpause = true;\n\n // back to \"standing\" animation after 1 second\n setTimeout(function () {\n this.setCurrentAnimation(\"standing\");\n }, 1000);\n\n return false; // do not reset to first frame\n });"}],"scope":"instance","type":"MethodDoc","description":"set the current animation\nthis will always change the animation & set the frame to zero
","params":[{"identifier":"name","optional":false,"description":"animation id
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"resetAnim","optional":true,"description":"animation id to switch to when complete, or callback
","dataType":{"tokens":[{"value":"string | Function","kind":"canonical"}],"template":"string | Function"}},{"identifier":"preserve_dt","optional":true,"default":"false","description":"if false will reset the elapsed time counter since last frame
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Sprite","kind":"canonical"},{"value":"Sprite","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"G0FNIaz7_gFyiXNJZFeQj","name":"setOpacity","brief":"","scope":"instance","type":"MethodDoc","description":"set the renderable alpha channel value
","params":[{"identifier":"alpha","optional":false,"description":"opacity value between 0.0 and 1.0
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"yq1n2w7PIhhJZjEGk8QPF","name":"setRegion","brief":"","examples":[{"caption":"","code":"// change the sprite to \"shadedDark13.png\";\nmySprite.setRegion(mytexture.getRegion(\"shadedDark13.png\"));"}],"scope":"instance","see":["Texture.getRegion"],"type":"MethodDoc","description":"change the current texture atlas region for this sprite
","params":[{"identifier":"region","optional":false,"description":"typically returned through me.Texture.getRegion()
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Sprite","kind":"canonical"},{"value":"Sprite","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"1zOqBYMuDEkuVbZxXV1lw","name":"setShape","brief":"","scope":"instance","type":"MethodDoc","description":"set new value to the rectangle shape
","params":[{"identifier":"x","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"w","optional":false,"description":"width of the rectangle, or an array of vector defining the rectangle
","dataType":{"tokens":[{"value":"number | Array","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %3<%2>"}},{"identifier":"h","optional":true,"description":"height of the rectangle, if a numeral width parameter is specified
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"K2G5D50nE9x5lFJvSyqDd","name":"setVertices","brief":"","scope":"instance","type":"MethodDoc","description":"set the vertices defining this Polygon
","params":[{"identifier":"vertices","optional":false,"description":"array of vector or vertice defining the Polygon
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1<%2>"}}],"returns":[{"description":"this instance for objecf chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"lt_tluYTOz6dpqXC2kuA-","name":"shift","brief":"","examples":[{"caption":"","code":"polygon.shift(10, 10);\n// or\npolygon.shift(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"Shifts the Polygon to the given position vector.
","params":[{"identifier":"x","description":"x coordinate or a vector point to shift to
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"wmT-I98SY-K8Kc63Nqoao","name":"to2d","brief":"","scope":"instance","type":"MethodDoc","description":"apply a 2d projection to this shapen
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"AGy4UyoKDrQ7Z_YUTTdwI","name":"toIso","brief":"","scope":"instance","type":"MethodDoc","description":"apply an isometric projection to this shape
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"NbfWV-iJHOeG3FXAhetTe","name":"toPolygon","brief":"","scope":"instance","type":"MethodDoc","description":"Returns a polygon whose edges are the same as this box.
","params":[],"returns":[{"description":"a new Polygon that represents this rectangle.
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"AL0C_WwWA0ed_kr4_PwkF","name":"transform","brief":"","scope":"instance","see":["Renderable#currentTransform"],"type":"MethodDoc","description":"multiply the renderable currentTransform with the given matrix
","params":[{"identifier":"m","optional":false,"description":"the transformation matrix
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Xsb4LBwcB2L6TXrr8bsMc","name":"translate","brief":"","examples":[{"caption":"","code":"polygon.translate(10, 10);\n// or\npolygon.translate(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"translate the Polygon by the specified offset
","params":[{"identifier":"x","description":"x offset or a vector point to translate by
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"description":"y offset
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"WxR99LhmO2fDTJs4kdLYI","name":"union","brief":"","scope":"instance","type":"MethodDoc","description":"merge this rectangle with another one
","params":[{"identifier":"rect","optional":false,"description":"other rectangle to union with
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"the union(ed) rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"dT6Gv2UNIoHL52jwuK087","name":"updateBounds","brief":"","scope":"instance","type":"MethodDoc","description":"update the bounding box for this shape.
","params":[{"identifier":"absolute","optional":true,"default":"true","description":"update the bounds size and position in (world) absolute coordinates
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"this shape bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"r3GCNs5FadspbejEZ-OSy","name":"draw","brief":"","access":"protected","scope":"instance","type":"MethodDoc","description":"draw this srite (automatically called by melonJS)
","params":[{"identifier":"renderer","optional":false,"description":"a renderer instance
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}},{"identifier":"viewport","optional":true,"description":"the viewport to (re)draw
","dataType":{"tokens":[{"value":"Camera2d","kind":"canonical"},{"value":"Camera2d","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"nGASix7YaQwy4-YsAOjRS","name":"update","brief":"","access":"protected","scope":"instance","type":"MethodDoc","description":"update function.
","params":[{"identifier":"dt","optional":false,"description":"time since the last update in milliseconds.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"true if the Sprite is dirty
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"orQ3Vl5Zl92oZKblSwK6I","name":"onAnchorUpdate","brief":"","access":"private","scope":"instance","type":"MethodDoc","description":"called when the anchor point value is changed
","params":[{"identifier":"x","optional":false,"description":"the new X value to be set for the anchor
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the new Y value to be set for the anchor
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]}]},{"id":"A4bes5sNUhfOqwNWifRh_","name":"Stage","brief":"","see":["state"],"type":"ClassDoc","description":"a default "Stage" object.\nevery "stage" object (title screen, credits, ingame, etc...) to be managed\nt...","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"FffdfW99wTaJutu337T1C","name":"ambientLight","brief":"","access":"public","defaultValue":"\"#000000\"","scope":"instance","see":["Light2d"],"type":"PropertyDoc","description":"
an ambient light that will be added to the stage rendering
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"oWJRWYvVbgj75_eLEtkgF","name":"cameras","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"The list of active cameras in this stage.\nCameras will be renderered based on this order defined in this list.\nOnly the &q...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"eUwOrSm_PTVZ4pryeaufT","name":"lights","brief":"","access":"public","examples":[{"caption":"","code":"// create a white spot light\nlet whiteLight = new me.Light2d(0, 0, 140, \"#fff\", 0.7);\n// and add the light to this current stage\nthis.lights.set(\"whiteLight\", whiteLight);\n// set a dark ambient light\nthis.ambientLight.parseCSS(\"#1117\");\n// make the light follow the mouse\nme.input.registerPointerEvent(\"pointermove\", me.game.viewport, (event) => {\n whiteLight.centerOn(event.gameX, event.gameY);\n});"}],"scope":"instance","see":["Light2d","Stage.ambientLight"],"type":"PropertyDoc","description":"
The list of active lights in this stage.\n(Note: Canvas Renderering mode will only properly support one light per stage)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"u39yUS-qnOTxhG-yT7q4l","name":"settings","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"The given constructor options
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"qcetWMUxV66h9VAJIOhaT","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"settings","optional":true,"description":"The stage` parameters
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}},{"identifier":"settings.cameras","optional":true,"default":"[new me.Camera2d()]","description":"a list of cameras (experimental)
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Camera2d","kind":"link"}],"template":"%1<%2>"}},{"identifier":"settings.onResetEvent","optional":true,"description":"called by the state manager when reseting the object
","dataType":{"tokens":[{"value":"Function","kind":"canonical"}],"template":"Function"}},{"identifier":"settings.onDestroyEvent","optional":true,"description":"called by the state manager before switching to another state
","dataType":{"tokens":[{"value":"Function","kind":"canonical"}],"template":"Function"}}],"returns":[],"extends":[],"implements":[]},{"id":"-q75_iSgeeyokcaWVzbeP","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"onDestroyEvent function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"HCZJSIFtD2Fpb7Bg3PFtK","name":"onResetEvent","brief":"","scope":"instance","see":["state#change"],"type":"MethodDoc","description":"onResetEvent function
optional arguments passed when switching state
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}}],"returns":[],"extends":[],"implements":[]}]},{"id":"nkJaBxlL0M1Mw22auSpBk","name":"Text","brief":"","type":"ClassDoc","description":"a generic system font object.
","params":[],"returns":[],"extends":["Renderable"],"implements":[],"members":[{"id":"ybL0y0wbDZqMhNHPaemCR","name":"alpha","brief":"","defaultValue":"1.0","scope":"instance","see":["Renderable#setOpacity","Renderable#getOpacity"],"type":"PropertyDoc","description":"Define the renderable opacity
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ow2HRSREo7Lz3hK_W7-IJ","name":"alwaysUpdate","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object will always update, even when outside of the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"wLYPi0FIX1NojKiDvxOAd","name":"ancestor","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"a reference to the parent object that contains this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"xxb897znmH0zzh5iuIHTZ","name":"anchorPoint","brief":"","defaultValue":"<0.5,0.5>","scope":"instance","type":"PropertyDoc","description":"The anchor point is used for attachment behavior, and/or when applying transformations.
When enabled, an object container will automatically apply\nany defined transformation before calling the child draw method...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"H-ZtWAio8TXZLV47HwZEl","name":"blendMode","brief":"","defaultValue":"\"normal\"","scope":"instance","see":["CanvasRenderer#setBlendMode","WebGLRenderer#setBlendMode"],"type":"PropertyDoc","description":"
the blend mode to be applied to this renderable (see renderer setBlendMode for available blend mode)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"8XDGOL0JbPblqd5javq-d","name":"body","brief":"","examples":[{"caption":"","code":" // define a new Player Class\n class PlayerEntity extends me.Sprite {\n // constructor\n constructor(x, y, settings) {\n // call the parent constructor\n super(x, y , settings);\n\n // define a basic walking animation\n this.addAnimation(\"walk\", [...]);\n // define a standing animation (using the first frame)\n this.addAnimation(\"stand\", [...]);\n // set the standing animation as default\n this.setCurrentAnimation(\"stand\");\n\n // add a physic body\n this.body = new me.Body(this);\n // add a default collision shape\n this.body.addShape(new me.Rect(0, 0, this.width, this.height));\n // configure max speed, friction, and initial force to be applied\n this.body.setMaxVelocity(3, 15);\n this.body.setFriction(0.4, 0);\n this.body.force.set(3, 0);\n this.isKinematic = false;\n\n // set the display to follow our position on both axis\n me.game.viewport.follow(this.pos, me.game.viewport.AXIS.BOTH);\n }\n\n ...\n\n }"}],"scope":"instance","type":"PropertyDoc","description":"the renderable physic body
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"DkJKo2ktGDP9XfTVHBeYA","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ClBFMPtTDnGyflBMCzBap","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"1zGdZnh3SNOoX2i3OQYCM","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"jI5Zaup-QDgpE4D73QdS3","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"9boT8B0jN82Cj55z306JG","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"yvdUCA4_kAK_FaBNU3dgQ","name":"fillStyle","brief":"","defaultValue":"black","scope":"instance","type":"PropertyDoc","description":"defines the color used to draw the font.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"zVKh6mV54liX489CbY9-T","name":"floating","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"If true, this renderable will be rendered using screen coordinates,\nas opposed to world coordinates. Use this, for example...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"NuPqw7-vz18lAvp-YiF4C","name":"fontSize","brief":"","defaultValue":"10","scope":"instance","type":"PropertyDoc","description":"
the font size (in px)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"l20LTBSJX__wrKbSsa9pn","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"(G)ame (U)nique (Id)entifier"
height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"iOxdkhFVuK4qMJoh_qvjy","name":"inViewport","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object is visible and within the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"0tWdZU8m3NghzbB4uUIjj","name":"isDirty","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"when true the renderable will be redrawn during the next update cycle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"WnHQ_6Ncdz7-UMzr05kOb","name":"isFlippedX","brief":"","access":"public","scope":"instance","see":["Renderable#flipX"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"4-hcLwN_Brv0_I8bsvBCE","name":"isFlippedY","brief":"","access":"public","scope":"instance","see":["Renderable#flipY"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Z0gu43GSHjlHfSH79H-q3","name":"isFloating","brief":"","scope":"instance","see":["Renderable#floating"],"type":"PropertyDoc","description":"Whether the renderable object is floating (i.e. used screen coordinates), or contained in a floating parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"zHElEuJliWm7IeJ1QZai7","name":"isKinematic","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"If true then physic collision and input events will not impact this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Uotwug39i_PKwP4eouXUu","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ZbAekoWk9I6XmUWkMi_P1","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"iYu8Bye7SwQHT2dhNpDVD","name":"lineHeight","brief":"","defaultValue":"1.0","scope":"instance","type":"PropertyDoc","description":"Set the line spacing height (when displaying multi-line strings).
sets the current line width, in pixels, when drawing stroke
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"BHDQDP9W4rq_4yoCjc2bi","name":"mask","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"// apply a mask in the shape of a Star\nmyNPCSprite.mask = new me.Polygon(myNPCSprite.width / 2, 0, [\n // draw a star\n {x: 0, y: 0},\n {x: 14, y: 30},\n {x: 47, y: 35},\n {x: 23, y: 57},\n {x: 44, y: 90},\n {x: 0, y: 62},\n {x: -44, y: 90},\n {x: -23, y: 57},\n {x: -47, y: 35},\n {x: -14, y: 30}\n]);"}],"scope":"instance","type":"PropertyDoc","description":"A mask limits rendering elements to the shape and position of the given mask object.\nSo, if the renderable is larger than ...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"si8d8qlJe1qGJcUOGC66X","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"aEFPicoeSQblXMuNCo7ep","name":"onVisibilityChange","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"this.onVisibilityChange = function(inViewport) {\n if (inViewport === true) {\n console.log(\"object has entered the in a camera viewport!\");\n }\n};"}],"scope":"instance","type":"PropertyDoc","description":"an event handler that is called when the renderable leave or enter a camera viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"iEu-NiMCPp-5cnp1Kf0-I","name":"parentApp","brief":"","scope":"instance","type":"PropertyDoc","description":"returns the parent application (or game) to which this renderable is attached to
","params":[],"returns":[{"description":"the parent application or undefined if not attached to any container/app
","dataType":{"tokens":[{"value":"Application","kind":"canonical"},{"value":"Application","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"6l7iJqkupQiqORwpeEKyx","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"kjs-D-v20QW2sD2oeh0rT","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"wee-Nr6yRxp7DFBbGj8dY","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"_iuveRJqB1yrGTfdHeWFt","name":"shader","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"(Experimental) an optional shader, to be used instead of the default built-in one, when drawing this renderable (WebGL onl...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"JZ1WIh1YZDBj_dCaawGdg","name":"strokeStyle","brief":"","defaultValue":"black","scope":"instance","type":"PropertyDoc","description":"
defines the color used to draw the font stroke.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"FBDCXEiFE2qB1v4xVPSsF","name":"textAlign","brief":"","defaultValue":"\"left\"","scope":"instance","type":"PropertyDoc","description":"Set the default text alignment (or justification),
Set the text baseline (e.g. the Y-coordinate for the draw operation),
define a tint for this renderable. a (255, 255, 255) r, g, b value will remove the tint effect.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"MeLB2YcTnl8wg98Ar5yBA","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"eW2VTm-3nWD6kwjT7loHV","name":"type","brief":"","defaultValue":"\"Rectangle\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Nd7Pr7MwlFk7K8JptiK7c","name":"updateWhenPaused","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether to update this object when the game is paused.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"0Hi2FTiVzl09lkJPXpphG","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"czpeLpzFU9oT2vxISzIfO","name":"wordWrapWidth","brief":"","defaultValue":"-1","scope":"instance","type":"PropertyDoc","description":"the maximum length in CSS pixel for a single segment of text.\n(use -1 to disable word wrapping)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Uoo6Pfsd4HPIjgpwZqUlS","name":"_text","brief":"","access":"private","scope":"instance","type":"PropertyDoc","description":"the text to be displayed
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"XCePZHEb53Pn0PogkZwVE","name":"angleTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the angle to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"angle in radians
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"3akaIxZk6wxCSh5-9h8NN","name":"bold","brief":"","scope":"instance","type":"MethodDoc","description":"make the font bold
","params":[],"returns":[{"description":"this object for chaining
","dataType":{"tokens":[{"value":"Text","kind":"canonical"},{"value":"Text","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"clYm1xtxalYv1NurgQPID","name":"centerOn","brief":"","scope":"instance","type":"MethodDoc","description":"center the rectangle position around the given coordinates
","params":[{"identifier":"x","optional":false,"description":"the x coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"BBWGfgGaolRmANJpk5eRv","name":"clone","brief":"","scope":"instance","type":"MethodDoc","description":"clone this rectangle
","params":[],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"XfihHEZqY3COyE0N06qlC","name":"constructor","brief":"","examples":[{"caption":"","code":"let font = new me.Text(0, 0, {font: \"Arial\", size: 8, fillStyle: this.color});"}],"scope":"instance","type":"MethodDoc","params":[{"identifier":"x","optional":false,"description":"position of the text object
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"position of the text object
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings","optional":false,"description":"the text configuration
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}},{"identifier":"settings.font","description":"a CSS family font name
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"settings.size","description":"size, or size + suffix (px, em, pt)
","dataType":{"tokens":[{"value":"number | string","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1 | string"}},{"identifier":"settings.fillStyle","optional":true,"default":"\"#000000\"","description":"a CSS color value
","dataType":{"tokens":[{"value":"Color | string","kind":"canonical"},{"value":"Color","kind":"link"}],"template":"%1 | string"}},{"identifier":"settings.strokeStyle","optional":true,"default":"\"#000000\"","description":"a CSS color value
","dataType":{"tokens":[{"value":"Color | string","kind":"canonical"},{"value":"Color","kind":"link"}],"template":"%1 | string"}},{"identifier":"settings.lineWidth","optional":true,"default":"0","description":"line width, in pixels, when drawing stroke
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings.textAlign","optional":true,"default":"\"left\"","description":"horizontal text alignment
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"settings.textBaseline","optional":true,"default":"\"top\"","description":"the text baseline
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"settings.lineHeight","optional":true,"default":"1.0","description":"line spacing height
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings.anchorPoint","optional":true,"default":"{x:0.0, y:0.0}","description":"anchor point to draw the text at
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}},{"identifier":"settings.wordWrapWidth","optional":true,"description":"the maximum length in CSS pixel for a single segment of text
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings.text","optional":true,"default":"\"\"","description":"a string, or an array of strings
","dataType":{"tokens":[{"value":"string | Array","kind":"canonical"},{"value":"Array","kind":"canonical"}],"template":"string | %1"}}],"returns":[],"extends":[],"implements":[]},{"id":"MN9x2PbTpy_ZuFvShXVdr","name":"contains","brief":"","examples":[{"caption":"","code":"if (rect.contains(10, 10)) {\n // do something\n}\n// or\nif (rect.contains(myVector2d)) {\n // do something\n}\nif (rect.contains(myRect)) {\n // do something\n}"}],"scope":"instance","type":"MethodDoc","description":"Returns true if the rectangle contains the given point or rectangle
","params":[{"identifier":"x","description":"x coordinate or a vector point, or a rectangle to test
","dataType":{"tokens":[{"value":"number | Vector2d | Rect","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Rect","kind":"link"}],"template":"%1 | %2 | %3"}},{"identifier":"y","optional":true,"description":"y coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"True if the rectangle contain the given point or rectangle, otherwise false
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"V1OekvNDXTHGxDyeq617v","name":"copy","brief":"","scope":"instance","type":"MethodDoc","description":"copy the position and size of the given rectangle into this one
","params":[{"identifier":"rect","optional":false,"description":"Source rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"1zNJMmpGGyi7met3P3-ZG","name":"distanceTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the distance to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"distance
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"RXCjMf0t3It9eeBVEnDZ1","name":"draw","brief":"","scope":"instance","type":"MethodDoc","description":"draw a text at the specified coord
","params":[{"identifier":"renderer","optional":false,"description":"Reference to the destination renderer instance
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}},{"identifier":"text","optional":true,"dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"x","optional":true,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":true,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"Tf9n-KRQlYgQQ9uFCop8A","name":"drawStroke","brief":"","deprecated":"since 15.0.0","scope":"instance","type":"MethodDoc","description":"draw a stroke text at the specified coord, as defined by the lineWidth and fillStroke properties...","params":[{"identifier":"renderer","optional":false,"description":"
Reference to the destination renderer instance
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}},{"identifier":"text","optional":false,"dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"x","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"e2QdcgO6tVS66W4dJnT-_","name":"equals","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is identical to the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if equals
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"qkdpUdkUTT2PQpQU0FIz0","name":"flipX","brief":"","scope":"instance","see":["Matrix2d#scaleX"],"type":"MethodDoc","description":"flip the renderable on the horizontal axis (around the center of the renderable)
","params":[{"identifier":"flip","optional":true,"default":"true","description":"true to flip this renderable.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"ZlYt4s4-2Cpn3sY9-zpUR","name":"flipY","brief":"","scope":"instance","see":["Matrix2d#scaleY"],"type":"MethodDoc","description":"flip the renderable on the vertical axis (around the center of the renderable)
","params":[{"identifier":"flip","optional":true,"default":"true","description":"true to flip this renderable.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"GOJMvp-rYNQxgL6uNVVEg","name":"getAbsolutePosition","brief":"","scope":"instance","type":"MethodDoc","description":"return the renderable absolute position in the game world
","params":[],"returns":[{"dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"R5mf4rsCG3dR4tHzQ2app","name":"getBounds","brief":"","scope":"instance","type":"MethodDoc","description":"returns the bounding box for this renderable
","params":[],"returns":[{"description":"bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"cH8WH4lS1mJUFz19HxL6I","name":"getIndices","brief":"","scope":"instance","type":"MethodDoc","description":"returns a list of indices for all triangles defined in this polygon
","params":[],"returns":[{"description":"an array of vertex indices for all triangles forming this polygon.
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1<%2>"}}],"extends":[],"implements":[]},{"id":"90qe9Q-q7SMl3UjnAQuGK","name":"getOpacity","brief":"","scope":"instance","type":"MethodDoc","description":"get the renderable alpha channel value
","params":[],"returns":[{"description":"current opacity value between 0 and 1
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"H0OPckr75pncy69Rk5R_K","name":"isConvex","brief":"","scope":"instance","type":"MethodDoc","description":"Returns true if the vertices composing this polygon form a convex shape (vertices must be in clockwise order).
","params":[],"returns":[{"description":"true if the vertices are convex, false if not, null if not computable
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"UOswRBw3TmbymCVPKE4pQ","name":"isFinite","brief":"","scope":"instance","type":"MethodDoc","description":"determines whether all coordinates of this rectangle are finite numbers.
","params":[],"returns":[{"description":"false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"gzQA4iL9erQgfDXIAOds3","name":"italic","brief":"","scope":"instance","type":"MethodDoc","description":"make the font italic
","params":[],"returns":[{"description":"this object for chaining
","dataType":{"tokens":[{"value":"Text","kind":"canonical"},{"value":"Text","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"kb74acwcXlNWHSHl8UINJ","name":"lookAt","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this renderable towards the given target.
","params":[{"identifier":"target","optional":false,"description":"the renderable or position to look at
","dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Zlv31HIND9tujAbVJ4Kv1","name":"measureText","brief":"","scope":"instance","type":"MethodDoc","description":"measure the given text size in pixels
","params":[{"identifier":"renderer","optional":false,"description":"reference to the active renderer
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}},{"identifier":"text","optional":true,"description":"the text to be measured
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"returns":[{"description":"a TextMetrics object defining the dimensions of the given piece of text
","dataType":{"tokens":[{"value":"TextMetrics","kind":"canonical"},{"value":"TextMetrics","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"SvUunDWw9DP8fvn-5_v4z","name":"onCollision","brief":"","examples":[{"caption":"","code":"// colision handler\nonCollision(response) {\n if (response.b.body.collisionType === me.collision.types.ENEMY_OBJECT) {\n // makes the other object solid, by substracting the overlap vector to the current position\n this.pos.sub(response.overlapV);\n this.hurt();\n // not solid\n return false;\n }\n // Make the object solid\n return true;\n},"}],"scope":"instance","type":"MethodDoc","description":"onCollision callback, triggered in case of collision,\nwhen this renderable body is colliding with another one
","params":[{"identifier":"response","optional":false,"description":"the collision response object
","dataType":{"tokens":[{"value":"ResponseObject","kind":"canonical"},{"value":"ResponseObject","kind":"link"}],"template":"%1"}},{"identifier":"other","optional":false,"description":"the other renderable touching this one (a reference to response.a or response.b)
","dataType":{"tokens":[{"value":"Renderable | Container | Entity | Sprite | NineSliceSprite","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Container","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"NineSliceSprite","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5"}}],"returns":[{"description":"true if the object should respond to the collision (its position and velocity will be corrected)
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"fyHUZCrqb-WsVwyqvsjtl","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"OnDestroy Notification function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"OminhhLmU9Aicw-FxVhPB","name":"overlaps","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is intersecting with the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if overlaps
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"OGQmDKUmF62YsuqhiCPK5","name":"postDraw","brief":"","scope":"instance","see":["Renderable#preDraw","Renderable#draw"],"type":"MethodDoc","description":"restore the rendering context after drawing (automatically called by melonJS).
","params":[{"identifier":"renderer","optional":false,"description":"a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"sVrdBu0IHRjcov23gnpxk","name":"preDraw","brief":"","scope":"instance","see":["Renderable#draw","Renderable#postDraw"],"type":"MethodDoc","description":"Prepare the rendering context before drawing (automatically called by melonJS).\nThis will apply any defined transforms, an...","params":[{"identifier":"renderer","optional":false,"description":"
a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"1dVUqVFoAnq2rUTWWJxo6","name":"recalc","brief":"","scope":"instance","type":"MethodDoc","description":"Computes the calculated collision polygon.\nThis must be called if the points array, an...","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Uby0yxFQkILcqEl5-A6u0","name":"resize","brief":"","scope":"instance","type":"MethodDoc","description":"resize the rectangle
","params":[{"identifier":"w","optional":false,"description":"new width of the rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"h","optional":false,"description":"new height of the rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"9Fq_gz13iCWoHsHHW3GaA","name":"rotate","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this renderable by the specified angle (in radians).
","params":[{"identifier":"angle","optional":false,"description":"The angle to rotate (in radians)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":true,"description":"an optional point to rotate around
","dataType":{"tokens":[{"value":"Vector2d | ObservableVector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"7c3Md5au3RY4KTvkI5p8h","name":"scale","brief":"","scope":"instance","type":"MethodDoc","description":"scale the renderable around his anchor point. Scaling actually applies changes\nto the currentTransform member wich is use...","params":[{"identifier":"x","optional":false,"description":"
a number representing the abscissa of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":true,"default":"x","description":"a number representing the ordinate of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"ekxFim4vib-LbONL5d1PO","name":"scaleV","brief":"","scope":"instance","type":"MethodDoc","description":"scale the renderable around his anchor point
","params":[{"identifier":"v","optional":false,"description":"scaling vector
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"OLZFHwr1v_p2ChKs8W2jM","name":"setFont","brief":"","examples":[{"caption":"","code":"font.setFont(\"Arial\", 20);\nfont.setFont(\"Arial\", \"1.5em\");"}],"scope":"instance","type":"MethodDoc","description":"set the font family and size
","params":[{"identifier":"font","optional":false,"description":"a CSS font name
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"size","optional":true,"default":"10","description":"size in px, or size + suffix (px, em, pt)
","dataType":{"tokens":[{"value":"number | string","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1 | string"}}],"returns":[{"description":"this object for chaining
","dataType":{"tokens":[{"value":"Text","kind":"canonical"},{"value":"Text","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"CGcVWVi_C-djT9htbzWdW","name":"setOpacity","brief":"","scope":"instance","type":"MethodDoc","description":"set the renderable alpha channel value
","params":[{"identifier":"alpha","optional":false,"description":"opacity value between 0.0 and 1.0
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"39C7TiC6hf0BEjpDvYeLj","name":"setShape","brief":"","scope":"instance","type":"MethodDoc","description":"set new value to the rectangle shape
","params":[{"identifier":"x","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"w","optional":false,"description":"width of the rectangle, or an array of vector defining the rectangle
","dataType":{"tokens":[{"value":"number | Array","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %3<%2>"}},{"identifier":"h","optional":true,"description":"height of the rectangle, if a numeral width parameter is specified
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"CfEDoINA5BvMBEzI-F2Iz","name":"setText","brief":"","scope":"instance","type":"MethodDoc","description":"change the text to be displayed
","params":[{"identifier":"value","optional":false,"default":"\"\"","description":"a string, or an array of strings
","dataType":{"tokens":[{"value":"number | string | Array","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Array","kind":"canonical"}],"template":"%1 | string | %2"}}],"returns":[{"description":"this object for chaining
","dataType":{"tokens":[{"value":"Text","kind":"canonical"},{"value":"Text","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"5wkQQUD4tOqlq1iXIXz8y","name":"setVertices","brief":"","scope":"instance","type":"MethodDoc","description":"set the vertices defining this Polygon
","params":[{"identifier":"vertices","optional":false,"description":"array of vector or vertice defining the Polygon
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1<%2>"}}],"returns":[{"description":"this instance for objecf chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"TDYFY9BeF0A8wkWxaOx9q","name":"shift","brief":"","examples":[{"caption":"","code":"polygon.shift(10, 10);\n// or\npolygon.shift(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"Shifts the Polygon to the given position vector.
","params":[{"identifier":"x","description":"x coordinate or a vector point to shift to
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"0fjszxJ-qpLlVZMK7ppGB","name":"to2d","brief":"","scope":"instance","type":"MethodDoc","description":"apply a 2d projection to this shapen
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"gqdSIeFmRB44Ccc2EU6r_","name":"toIso","brief":"","scope":"instance","type":"MethodDoc","description":"apply an isometric projection to this shape
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"EUfmMSiuluFDd9rSznnAb","name":"toPolygon","brief":"","scope":"instance","type":"MethodDoc","description":"Returns a polygon whose edges are the same as this box.
","params":[],"returns":[{"description":"a new Polygon that represents this rectangle.
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"YJ2w1PLxom7hpCdXpj3Lx","name":"transform","brief":"","scope":"instance","see":["Renderable#currentTransform"],"type":"MethodDoc","description":"multiply the renderable currentTransform with the given matrix
","params":[{"identifier":"m","optional":false,"description":"the transformation matrix
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"lKgu0C7O7q9Yo2TlpR1oI","name":"translate","brief":"","examples":[{"caption":"","code":"polygon.translate(10, 10);\n// or\npolygon.translate(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"translate the Polygon by the specified offset
","params":[{"identifier":"x","description":"x offset or a vector point to translate by
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"description":"y offset
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"63sr9ZucIGnhro1vqHTcj","name":"union","brief":"","scope":"instance","type":"MethodDoc","description":"merge this rectangle with another one
","params":[{"identifier":"rect","optional":false,"description":"other rectangle to union with
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"the union(ed) rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"EJ-sRMkTM_n4b3pyr19LL","name":"update","brief":"","scope":"instance","type":"MethodDoc","description":"update function (automatically called by melonJS).
","params":[{"identifier":"dt","optional":false,"description":"time since the last update in milliseconds.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"true if the renderable is dirty
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"-KvsbDauAZRmI5ylQu6tu","name":"updateBounds","brief":"","scope":"instance","type":"MethodDoc","description":"update the bounding box for this shape.
","params":[{"identifier":"absolute","optional":true,"default":"true","description":"update the bounds size and position in (world) absolute coordinates
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"this shape bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"iJHN29GGPsqr6-HnuaFK4","name":"onAnchorUpdate","brief":"","access":"private","scope":"instance","type":"MethodDoc","description":"called when the anchor point value is changed
","params":[{"identifier":"x","optional":false,"description":"the new X value to be set for the anchor
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the new Y value to be set for the anchor
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]}]},{"id":"hl8wXUQE98hH7AxRtRWyL","name":"TextMetrics","brief":"","type":"ClassDoc","description":"a Text Metrics object that contains helper for text manipulation
","params":[],"returns":[],"extends":["Bounds"],"implements":[],"members":[{"id":"is_Xo-WOrhepCAXUTJPpY","name":"ancestor","brief":"","access":"public","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"a reference to the parent object that contains this TextMetrics object
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"7OPmoHYRATzBo-9jgCnMg","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"6ozAyQUozw7coJibNUd5V","name":"center","brief":"","scope":"instance","type":"PropertyDoc","description":"return the center position of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"CZ2NOybdWQ95BRURCbL4z","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"center position of the bound on the x axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"D-I7MHHgxoEsGwKNqRfOo","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"center position of the bound on the y axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"_JxaKETJPoUVuVJSGOvpt","name":"height","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the bounds
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"XpGQXlTcpC5Y-dcP_D4FO","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"qJKx7VjsgF6-RS6tjfKEl","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"foX4hqrlrbw_4uZhk3ogt","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"GMyBKeulhoALGKL5owRMQ","name":"type","brief":"","defaultValue":"\"Bounds\"","scope":"instance","type":"PropertyDoc","description":"the object type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"TV-v3R9KgiyJKbtqLzQQH","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the bounds
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"55xmZH0pzn9uBHHY-Rtrp","name":"x","brief":"","scope":"instance","type":"PropertyDoc","description":"x position of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"_5Dunw8NhxtfTc_U4NH6N","name":"y","brief":"","scope":"instance","type":"PropertyDoc","description":"y position of the bounds
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"md7DqW8ummfw6Niwa5Rk6","name":"add","brief":"","scope":"instance","type":"MethodDoc","description":"add the given vertices to the bounds definition.
","params":[{"identifier":"vertices","optional":false,"description":"an array of Vector2d or Point
","dataType":{"tokens":[{"value":"Array | Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Array","kind":"canonical"},{"value":"Point","kind":"link"}],"template":"%1<%2> | %3<%4>"}},{"identifier":"clear","optional":true,"default":"false","description":"either to reset the bounds before adding the new vertices
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"Zlf2tNoCmJAIEC_8GjhqK","name":"addBounds","brief":"","scope":"instance","type":"MethodDoc","description":"add the given bounds to the bounds definition.
","params":[{"identifier":"bounds","optional":false,"dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}},{"identifier":"clear","optional":true,"default":"false","description":"either to reset the bounds before adding the new vertices
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"tBGoN8-OKJ4oqti53YvDp","name":"addFrame","brief":"","scope":"instance","type":"MethodDoc","description":"add the given quad coordinates to this bound definition, multiplied by the given matrix
","params":[{"identifier":"x0","optional":false,"description":"left X coordinates of the quad
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y0","optional":false,"description":"top Y coordinates of the quad
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"x1","optional":false,"description":"right X coordinates of the quad
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y1","optional":false,"description":"bottom y coordinates of the quad
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"m","optional":true,"description":"an optional transform to apply to the given frame coordinates
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"sZjbeAFV3rMqk41DFmj7S","name":"addPoint","brief":"","scope":"instance","type":"MethodDoc","description":"add the given point to the bounds definition.
","params":[{"identifier":"point","optional":false,"description":"the vector or point to be added to the bounds
","dataType":{"tokens":[{"value":"Vector2d | Point","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Point","kind":"link"}],"template":"%1 | %2"}},{"identifier":"m","optional":true,"description":"an optional transform to apply to the given point (if the given point is a Vector2d)
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"o-udjcpL7Rvo73ax7zcm5","name":"centerOn","brief":"","scope":"instance","type":"MethodDoc","description":"center the bounds position around the given coordinates
","params":[{"identifier":"x","optional":false,"description":"the x coordinate around which to center this bounds
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y coordinate around which to center this bounds
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"ordN-i10WjyYspVDmnT_h","name":"clear","brief":"reset the bound
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"2QqdNETbZp37kCuwpXVK7","name":"clone","brief":"","scope":"instance","type":"MethodDoc","description":"clone this bounds
","params":[],"returns":[{"dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"-dLQmYMG-QdlsMPFX-zBQ","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"ancestor","optional":false,"description":"the parent object that contains this TextMetrics object
","dataType":{"tokens":[{"value":"Text | BitmapText","kind":"canonical"},{"value":"Text","kind":"link"},{"value":"BitmapText","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"5uL_isL-9OQFDLJVKewMs","name":"contains","brief":"","examples":[{"caption":"","code":"if (bounds.contains(10, 10)) {\n // do something\n}\n// or\nif (bounds.contains(myVector2d)) {\n // do something\n}"}],"scope":"instance","type":"MethodDoc","description":"Returns true if the bounds contains the given point.
","params":[{"identifier":"x","description":"x coordinate or a vector point to check
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"description":"y coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"True if the bounds contain the point, otherwise false
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"CpICy_5Dykkfgsga7XcFg","name":"isFinite","brief":"","scope":"instance","type":"MethodDoc","description":"determines whether all coordinates of this bounds are finite numbers.
","params":[],"returns":[{"description":"false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"YZOPRUmo3XJrKXsVwrjr4","name":"lineHeight","brief":"","scope":"instance","type":"MethodDoc","description":"Returns the height of a segment of inline text in CSS pixels.
","params":[],"returns":[{"description":"the height of a segment of inline text in CSS pixels.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"94hlA05H8CWRl6h7a9xR1","name":"lineWidth","brief":"","scope":"instance","type":"MethodDoc","description":"Returns the width of the given segment of inline text in CSS pixels.
","params":[{"identifier":"text","optional":false,"description":"the text to be measured
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"context","optional":true,"description":"reference to an active 2d context for canvas rendering
","dataType":{"tokens":[{"value":"CanvasRenderingContext2D","kind":"canonical"},{"value":"CanvasRenderingContext2D","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"the width of the given segment of inline text in CSS pixels.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"ASpawnZ7fG3ZGZ8L6hPv8","name":"measureText","brief":"","scope":"instance","type":"MethodDoc","description":"measure the given text size in CSS pixels
","params":[{"identifier":"text","optional":false,"description":"the text to be measured
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"context","optional":true,"description":"reference to an active 2d context for canvas rendering
","dataType":{"tokens":[{"value":"CanvasRenderingContext2D","kind":"canonical"},{"value":"CanvasRenderingContext2D","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this
","dataType":{"tokens":[{"value":"TextMetrics","kind":"canonical"},{"value":"TextMetrics","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"uqjoyz9QiXMCx2Ey3gFDd","name":"overlaps","brief":"","scope":"instance","type":"MethodDoc","description":"Returns true if the two bounds intersect.
","params":[{"identifier":"bounds","optional":false,"dataType":{"tokens":[{"value":"Bounds | Rect","kind":"canonical"},{"value":"Bounds","kind":"link"},{"value":"Rect","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"True if the bounds overlap, otherwise false
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"Pb3W-kqHueZt27M8CtXGh","name":"setMinMax","brief":"","scope":"instance","type":"MethodDoc","description":"sets the bounds to the given min and max value
","params":[{"identifier":"minX","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"minY","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"maxX","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"maxY","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"duTL020wCehHREaXcWw0M","name":"shift","brief":"","examples":[{"caption":"","code":"bounds.shift(10, 10);\n// or\nbounds.shift(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"Shifts the bounds to the given x, y position.
","params":[{"identifier":"x","description":"x coordinate or a vector point to shift to
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"IwNhhuvy9QAZxCbjICVPb","name":"toPolygon","brief":"","scope":"instance","type":"MethodDoc","description":"Returns a polygon whose edges are the same as this bounds.
","params":[],"returns":[{"description":"a new Polygon that represents this bounds.
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"GoguWlWtL5bfBO54-6Bdb","name":"translate","brief":"","examples":[{"caption":"","code":"bounds.translate(10, 10);\n// or\nbounds.translate(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"Translates the bounds by the given point
","params":[{"identifier":"x","description":"x coordinate or a vector point to translate by
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"u_5fPnRwUOgBagGYGn6Y2","name":"update","brief":"","scope":"instance","type":"MethodDoc","description":"Updates bounds using the given vertices
","params":[{"identifier":"vertices","optional":false,"description":"an array of Vector2d or Point
","dataType":{"tokens":[{"value":"Array | Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Array","kind":"canonical"},{"value":"Point","kind":"link"}],"template":"%1<%2> | %3<%4>"}}],"returns":[],"extends":[],"implements":[]},{"id":"7VmlAUNrEoytyOFCY3YcH","name":"wordWrap","brief":"","scope":"instance","type":"MethodDoc","description":"wrap the given text based on the given width
","params":[{"identifier":"text","optional":false,"description":"the text to be wrapped
","dataType":{"tokens":[{"value":"string | Array","kind":"canonical"},{"value":"Array","kind":"canonical"}],"template":"string | %1"}},{"identifier":"width","optional":false,"description":"maximum width of one segment of text in css pixel
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"context","optional":true,"description":"reference to an active 2d context for canvas rendering
","dataType":{"tokens":[{"value":"CanvasRenderingContext2D","kind":"canonical"},{"value":"CanvasRenderingContext2D","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"an array of string representing wrapped text
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]}]},{"id":"tajt7sY0S2-keM-lk4zTP","name":"TextureAtlas","brief":"","type":"ClassDoc","description":"A Texture atlas class, currently supports :
\n\n[TexturePacker]{@link http://www.codeandweb.com/texturepacke...","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"G1wh2IVUbLgGaHAiEZe25","name":"addRegion","brief":"","scope":"instance","type":"MethodDoc","description":"add a region to the atlas
","params":[{"identifier":"name","optional":false,"description":"region mame
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"x","optional":false,"description":"x origin of the region
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"y origin of the region
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"w","optional":false,"description":"width of the region
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"h","optional":false,"description":"height of the region
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"the created region
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}}],"extends":[],"implements":[]},{"id":"YnQvvog_po5HndDOI2Ri9","name":"addUVs","brief":"","scope":"instance","type":"MethodDoc","description":"add uvs mapping for the given region
","params":[{"identifier":"atlas","optional":false,"description":"the atlas dictionnary where the region is define
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}},{"identifier":"name","optional":false,"description":"region (or frame) name
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}},{"identifier":"w","optional":false,"description":"the width of the region
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"h","optional":false,"description":"the height of the region
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"the created region UVs
","dataType":{"tokens":[{"value":"Float32Array","kind":"canonical"},{"value":"Float32Array","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"gxE1hBQkZHStmDK0bI90M","name":"constructor","brief":"","examples":[{"caption":"","code":" // create a texture atlas from a JSON Object\n game.texture = new me.TextureAtlas(\n me.loader.getJSON(\"texture\")\n );\n\n // create a texture atlas from a multipack JSON Object\n game.texture = new me.TextureAtlas([\n me.loader.getJSON(\"texture-0\"),\n me.loader.getJSON(\"texture-1\"),\n me.loader.getJSON(\"texture-2\")\n ]);\n\n // create a texture atlas for a spritesheet with an anchorPoint in the center of each frame\n game.texture = new me.TextureAtlas(\n {\n framewidth : 32,\n frameheight : 32,\n anchorPoint : new me.Vector2d(0.5, 0.5)\n },\n me.loader.getImage(\"spritesheet\")"}],"scope":"instance","type":"MethodDoc","params":[{"identifier":"atlases","optional":false,"description":"atlas information. See {@link loader.getJSON}
","dataType":{"tokens":[{"value":"object | Array","kind":"canonical"},{"value":"Array","kind":"canonical"}],"template":"object | %1"}},{"identifier":"src","optional":true,"default":"atlas.meta.image","description":"Image source
","dataType":{"tokens":[{"value":"HTMLImageElement | HTMLCanvasElement | string | Array | Array | Array","kind":"canonical"},{"value":"HTMLImageElement","kind":"canonical"},{"value":"HTMLCanvasElement","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"HTMLImageElement","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"HTMLCanvasElement","kind":"canonical"},{"value":"Array","kind":"canonical"}],"template":"%1 | %2 | string | %3<%4> | %5<%6> | %7"}},{"identifier":"cache","optional":true,"default":"false","description":"Use true to skip caching this Texture
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"dS9Dd4733Fpy1VqZ865q5","name":"createAnimationFromName","brief":"","examples":[{"caption":"","code":" // create a new texture object under the `game` namespace\n game.texture = new me.TextureAtlas(\n me.loader.getJSON(\"texture\"),\n me.loader.getImage(\"texture\")\n );\n\n // create a new Animated Sprite\n let sprite = game.texture.createAnimationFromName([\n \"walk0001.png\", \"walk0002.png\", \"walk0003.png\",\n \"walk0004.png\", \"walk0005.png\", \"walk0006.png\",\n \"walk0007.png\", \"walk0008.png\", \"walk0009.png\",\n \"walk0010.png\", \"walk0011.png\"\n ]);\n\n // define an additional basic walking animation\n sprite.addAnimation (\"simple_walk\", [0,2,1]);\n // you can also use frame name to define your animation\n sprite.addAnimation (\"speed_walk\", [\"walk0007.png\", \"walk0008.png\", \"walk0009.png\", \"walk0010.png\"]);\n // set the default animation\n sprite.setCurrentAnimation(\"simple_walk\");\n // set the renderable position to bottom center\n sprite.anchorPoint.set(0.5, 1.0);"}],"scope":"instance","type":"MethodDoc","description":"Create an animation object using the first region found using all specified names
","params":[{"identifier":"names","optional":true,"description":"list of names for each sprite (if not specified all defined names/entries in the atlas will be added)\n(when manually creat...","dataType":{"tokens":[{"value":"Array | Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1 | %3<%2>"}},{"identifier":"settings","optional":true,"description":"Additional settings passed to the {@link Sprite} contructor
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}}],"returns":[{"dataType":{"tokens":[{"value":"Sprite","kind":"canonical"},{"value":"Sprite","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"e24wN-fu2dxV-frX49Ywt","name":"createSpriteFromName","brief":"","examples":[{"caption":"","code":"// create a new texture object under the `game` namespace\ngame.texture = new me.TextureAtlas(\n me.loader.getJSON(\"texture\"),\n me.loader.getImage(\"texture\")\n);\n...\n...\n// create a new \"coin\" sprite\nlet sprite = game.texture.createSpriteFromName(\"coin.png\");\n// set the renderable position to bottom center\nsprite.anchorPoint.set(0.5, 1.0);\n...\n...\n// create a 9-slice sprite\nlet dialogPanel = game.texture.createSpriteFromName(\n \"rpg_dialo.png\",\n // width & height are mandatory for 9-slice sprites\n { width: this.width, height: this.height },\n true\n);"}],"scope":"instance","type":"MethodDoc","description":"Create a sprite object using the first region found using the specified name
","params":[{"identifier":"name","optional":false,"description":"name of the sprite
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"settings","optional":true,"description":"Additional settings passed to the {@link Sprite} contructor
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}},{"identifier":"nineSlice","optional":true,"default":"false","description":"if true returns a 9-slice sprite
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"dataType":{"tokens":[{"value":"Sprite | NineSliceSprite","kind":"canonical"},{"value":"Sprite","kind":"link"},{"value":"NineSliceSprite","kind":"link"}],"template":"%1 | %2"}}],"extends":[],"implements":[]},{"id":"wIuGQQplDmiQnZ6nc_Cqg","name":"getAtlas","brief":"","scope":"instance","type":"MethodDoc","description":"return the default or specified atlas dictionnary
","params":[{"identifier":"name","optional":true,"description":"atlas name in case of multipack textures
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"returns":[{"dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}}],"extends":[],"implements":[]},{"id":"Ra4zI31X66_4sBdELHHBp","name":"getFormat","brief":"","scope":"instance","type":"MethodDoc","description":"return the format of the atlas dictionnary
","params":[],"returns":[{"description":"will return "texturepacker", or "ShoeBox", or "melonJS", or "Spritesheet (fixed cell si...","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"extends":[],"implements":[]},{"id":"PcH68jYl798WJpg1ZlbKU","name":"getRegion","brief":"","scope":"instance","type":"MethodDoc","description":"
return a normalized region (or frame) information for the specified sprite name
","params":[{"identifier":"name","optional":false,"description":"name of the sprite
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"atlas","optional":true,"description":"name of a specific atlas where to search for the region
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}}],"returns":[{"dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}}],"extends":[],"implements":[]},{"id":"qdFpdOz5c5nxV91jrX7TI","name":"getTexture","brief":"","scope":"instance","type":"MethodDoc","description":"return the source texture for the given region (or default one if none specified)
","params":[{"identifier":"region","optional":true,"description":"region name in case of multipack textures
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}}],"returns":[{"dataType":{"tokens":[{"value":"HTMLImageElement | HTMLCanvasElement","kind":"canonical"},{"value":"HTMLImageElement","kind":"canonical"},{"value":"HTMLCanvasElement","kind":"canonical"}],"template":"%1 | %2"}}],"extends":[],"implements":[]},{"id":"bUpQlZ0QEhMhqlBH6dBQP","name":"getUVs","brief":"","scope":"instance","type":"MethodDoc","description":"return the uvs mapping for the given region
","params":[{"identifier":"name","optional":false,"description":"region (or frame) name
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}}],"returns":[{"description":"region Uvs
","dataType":{"tokens":[{"value":"Float32Array","kind":"canonical"},{"value":"Float32Array","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]}]},{"id":"yESIcL94uJrqMHRXB2ZCW","name":"Tile","brief":"","type":"ClassDoc","description":"a basic tile object
","params":[],"returns":[],"extends":["Bounds"],"implements":[],"members":[{"id":"3TvfgNLhxDfknCxkUxuhf","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"8586JgnmrJVa5GwnU8pA6","name":"center","brief":"","scope":"instance","type":"PropertyDoc","description":"return the center position of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"H1cgwSQ4Xi3vXz0TMG8I3","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"center position of the bound on the x axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"FVW5S6ZHs4AY6h8kZZHPA","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"center position of the bound on the y axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"xADDQ18DwrvuN9DbOxDoa","name":"flipped","brief":"","scope":"instance","type":"PropertyDoc","description":"Global flag that indicates if the tile is flipped
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"vi4K3uiRVqKHCZQGoMm8H","name":"flippedAD","brief":"","scope":"instance","type":"PropertyDoc","description":"True if the tile is flipped anti-diagonally
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"5-tmZNBB9xvj7zKuC3-RJ","name":"flippedX","brief":"","scope":"instance","type":"PropertyDoc","description":"True if the tile is flipped horizontally
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"DyrEPMdq84Eo6eqlXRz71","name":"flippedY","brief":"","scope":"instance","type":"PropertyDoc","description":"True if the tile is flipped vertically
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"UMjkEahKmgP3ajuyQCKUy","name":"height","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the bounds
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"K7q0HdnBUfOmEd82qUMq1","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"-bAkHbBsf5xT9qoJbKdO2","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"d-M3qz0mpRMBSgAdAvIL8","name":"tileId","brief":"","scope":"instance","type":"PropertyDoc","description":"tileId
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"sj5W5ky0GxAA6vL3HAIpT","name":"tileset","brief":"","scope":"instance","type":"PropertyDoc","description":"tileset
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"-o3Bbl8x1PVJC29aDnPQi","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"tH2sb9XncrJp3lXCg8jVh","name":"type","brief":"","defaultValue":"\"Bounds\"","scope":"instance","type":"PropertyDoc","description":"the object type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"PwSm33v4aUH8DvfC2-VtL","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the bounds
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"_37UYIHPGjRc_TG8zaxs3","name":"x","brief":"","scope":"instance","type":"PropertyDoc","description":"x position of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"T3d3dLICQYPOll4EHJAzX","name":"y","brief":"","scope":"instance","type":"PropertyDoc","description":"y position of the bounds
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"WLUgfSJ8GaWqmOLtzZo4E","name":"add","brief":"","scope":"instance","type":"MethodDoc","description":"add the given vertices to the bounds definition.
","params":[{"identifier":"vertices","optional":false,"description":"an array of Vector2d or Point
","dataType":{"tokens":[{"value":"Array | Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Array","kind":"canonical"},{"value":"Point","kind":"link"}],"template":"%1<%2> | %3<%4>"}},{"identifier":"clear","optional":true,"default":"false","description":"either to reset the bounds before adding the new vertices
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"YU6SjziZvwI55i3Air-gX","name":"addBounds","brief":"","scope":"instance","type":"MethodDoc","description":"add the given bounds to the bounds definition.
","params":[{"identifier":"bounds","optional":false,"dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}},{"identifier":"clear","optional":true,"default":"false","description":"either to reset the bounds before adding the new vertices
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"U9IqCa_xLRmtEUvRk-huf","name":"addFrame","brief":"","scope":"instance","type":"MethodDoc","description":"add the given quad coordinates to this bound definition, multiplied by the given matrix
","params":[{"identifier":"x0","optional":false,"description":"left X coordinates of the quad
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y0","optional":false,"description":"top Y coordinates of the quad
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"x1","optional":false,"description":"right X coordinates of the quad
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y1","optional":false,"description":"bottom y coordinates of the quad
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"m","optional":true,"description":"an optional transform to apply to the given frame coordinates
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"pYmZbudJqcfZsVCZTiC5I","name":"addPoint","brief":"","scope":"instance","type":"MethodDoc","description":"add the given point to the bounds definition.
","params":[{"identifier":"point","optional":false,"description":"the vector or point to be added to the bounds
","dataType":{"tokens":[{"value":"Vector2d | Point","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Point","kind":"link"}],"template":"%1 | %2"}},{"identifier":"m","optional":true,"description":"an optional transform to apply to the given point (if the given point is a Vector2d)
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"OAZxRAwYC31u2BU3Gr8xB","name":"centerOn","brief":"","scope":"instance","type":"MethodDoc","description":"center the bounds position around the given coordinates
","params":[{"identifier":"x","optional":false,"description":"the x coordinate around which to center this bounds
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y coordinate around which to center this bounds
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"wWi6gf2xBD5-pEbKvr7CU","name":"clear","brief":"reset the bound
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"pVeCENPY1wU5Varq6me7Z","name":"clone","brief":"","scope":"instance","type":"MethodDoc","description":"clone this bounds
","params":[],"returns":[{"dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"rshuPPn2s8QKXWjPVwOlu","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"x","optional":false,"description":"x index of the Tile in the map
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"y index of the Tile in the map
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"gid","optional":false,"description":"tile gid
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"tileset","optional":false,"description":"the corresponding tileset object
","dataType":{"tokens":[{"value":"TMXTileset","kind":"canonical"},{"value":"TMXTileset","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"EKrg0tmzGr0d2Xw5qEvUz","name":"contains","brief":"","examples":[{"caption":"","code":"if (bounds.contains(10, 10)) {\n // do something\n}\n// or\nif (bounds.contains(myVector2d)) {\n // do something\n}"}],"scope":"instance","type":"MethodDoc","description":"Returns true if the bounds contains the given point.
","params":[{"identifier":"x","description":"x coordinate or a vector point to check
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"description":"y coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"True if the bounds contain the point, otherwise false
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"uGq8ChCqngG67-fB9lcBT","name":"getRenderable","brief":"","scope":"instance","type":"MethodDoc","description":"return a renderable object for this Tile object
","params":[{"identifier":"settings","optional":true,"description":"see {@link Sprite}
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}}],"returns":[{"description":"a me.Sprite object
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"NDTlKumzVwfQGcYyOguNs","name":"isFinite","brief":"","scope":"instance","type":"MethodDoc","description":"determines whether all coordinates of this bounds are finite numbers.
","params":[],"returns":[{"description":"false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"iCkb6UAJF6wx7sTCes6G1","name":"overlaps","brief":"","scope":"instance","type":"MethodDoc","description":"Returns true if the two bounds intersect.
","params":[{"identifier":"bounds","optional":false,"dataType":{"tokens":[{"value":"Bounds | Rect","kind":"canonical"},{"value":"Bounds","kind":"link"},{"value":"Rect","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"True if the bounds overlap, otherwise false
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"Ok5yB7p60GR9CfPFqopiV","name":"setMinMax","brief":"","scope":"instance","type":"MethodDoc","description":"sets the bounds to the given min and max value
","params":[{"identifier":"minX","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"minY","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"maxX","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"maxY","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"P30C46kAtelDLOSKE9tRM","name":"shift","brief":"","examples":[{"caption":"","code":"bounds.shift(10, 10);\n// or\nbounds.shift(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"Shifts the bounds to the given x, y position.
","params":[{"identifier":"x","description":"x coordinate or a vector point to shift to
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"xoxZSJgWKwbIaaKJCceC2","name":"toPolygon","brief":"","scope":"instance","type":"MethodDoc","description":"Returns a polygon whose edges are the same as this bounds.
","params":[],"returns":[{"description":"a new Polygon that represents this bounds.
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"yCJr1D2l1FNNSq72QUmNe","name":"translate","brief":"","examples":[{"caption":"","code":"bounds.translate(10, 10);\n// or\nbounds.translate(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"Translates the bounds by the given point
","params":[{"identifier":"x","description":"x coordinate or a vector point to translate by
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"MK02HZKSzyLV3rJZ_s7Y5","name":"update","brief":"","scope":"instance","type":"MethodDoc","description":"Updates bounds using the given vertices
","params":[{"identifier":"vertices","optional":false,"description":"an array of Vector2d or Point
","dataType":{"tokens":[{"value":"Array | Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Array","kind":"canonical"},{"value":"Point","kind":"link"}],"template":"%1<%2> | %3<%4>"}}],"returns":[],"extends":[],"implements":[]}]},{"id":"WOokUvGl1nnjkKHGjK-q0","name":"Timer","brief":"","see":["{@link timer} the default global timer instance"],"type":"ClassDoc","description":"a Timer class to manage timing related function (FPS, Game Tick, Time...)
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"LYogGmqIfGdHas3tGJXQm","name":"fps","brief":"","access":"public","defaultValue":"0","scope":"instance","type":"PropertyDoc","description":"Last measured fps rate.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"2ShWJ2ZID2gLZS8kQWSaF","name":"interpolation","brief":"","defaultValue":"false","scope":"instance","see":["tick"],"type":"PropertyDoc","description":"Enable/disable frame interpolation
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"VufDfUhLovcfNpEIO2mc-","name":"maxfps","brief":"","access":"public","defaultValue":"60","scope":"instance","see":["tick"],"type":"PropertyDoc","description":"Set the maximum target display frame per second
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"lVTItNctEpbz-KuUN5OUJ","name":"tick","brief":"","access":"public","defaultValue":"1","scope":"instance","see":["interpolation"],"type":"PropertyDoc","description":"Last game tick value.
cancels the timed, repeating action which was previously established by a call to setInterval().
","params":[{"identifier":"intervalID","optional":false,"description":"ID of the interval to be cleared
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"ED61Iyx_mQ0Xghqh9Um7F","name":"clearTimeout","brief":"","scope":"instance","type":"MethodDoc","description":"Cancels a timeout previously established by calling setTimeout().
","params":[{"identifier":"timeoutID","optional":false,"description":"ID of the timeout to be cancelled
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"Z1PaC2cEDc4l6NS1DHEMH","name":"getDelta","brief":"","scope":"instance","type":"MethodDoc","description":"Return elapsed time in milliseconds since the last update
","params":[],"returns":[{"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"0Noz2PbWnfNu5rQZGD5lk","name":"getTime","brief":"","scope":"instance","type":"MethodDoc","description":"Return the current timestamp in milliseconds
Calls a function continously at the specified interval. See setTimeout to call function a single time.
","params":[{"identifier":"fn","optional":false,"description":"the function to execute
","dataType":{"tokens":[{"value":"Function","kind":"canonical"}],"template":"Function"}},{"identifier":"delay","optional":false,"description":"the number of milliseconds (thousandths of a second) on how often to execute the function
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"pauseable","optional":true,"default":"true","description":"respects the pause state of the engine.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}},{"identifier":"args","optional":false,"variadic":true,"description":"optional parameters which are passed through to the function specified by fn once the timer expires.
","dataType":{"tokens":[{"value":"unknown","kind":"canonical"}],"template":"unknown"}}],"returns":[{"description":"a numeric, non-zero value which identifies the timer created by the call to setInterval(), which can be used later with me...","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"-5GDhzKHPnXUvtzRW4uCV","name":"setTimeout","brief":"","examples":[{"caption":"","code":"// set a timer to call \"myFunction\" after 1000ms\nme.timer.setTimeout(myFunction, 1000);\n// set a timer to call \"myFunction\" after 1000ms (respecting the pause state) and passing param1 and param2\nme.timer.setTimeout(myFunction, 1000, true, param1, param2);"}],"scope":"instance","type":"MethodDoc","description":"
Calls a function once after a specified delay. See me.timer.setInterval to repeativly call a function.
","params":[{"identifier":"fn","optional":false,"description":"the function you want to execute after delay milliseconds.
","dataType":{"tokens":[{"value":"Function","kind":"canonical"}],"template":"Function"}},{"identifier":"delay","optional":false,"description":"the number of milliseconds (thousandths of a second) that the function call should be delayed by.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"pauseable","optional":true,"default":"true","description":"respects the pause state of the engine.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}},{"identifier":"args","optional":false,"variadic":true,"description":"optional parameters which are passed through to the function specified by fn once the timer expires.
","dataType":{"tokens":[{"value":"unknown","kind":"canonical"}],"template":"unknown"}}],"returns":[{"description":"a positive integer value which identifies the timer created by the call to setTimeout(), which can be used later with me.t...","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]}]},{"id":"HZ65JQty1PwV6z44RrOjU","name":"TMXHexagonalRenderer","brief":"","type":"ClassDoc","description":"
an Hexagonal Map Renderder
","params":[],"returns":[],"extends":["TMXRenderer"],"implements":[],"members":[{"id":"86ckLdGhsdbH4-xurBSs7","name":"canRender","brief":"","scope":"instance","type":"MethodDoc","description":"return true if the renderer can render the specified map or layer
","params":[{"identifier":"component","optional":false,"description":"TMX Map or Layer
","dataType":{"tokens":[{"value":"TMXTileMap | TMXLayer","kind":"canonical"},{"value":"TMXTileMap","kind":"link"},{"value":"TMXLayer","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"0H-oTTydHvG06YYr6ITls","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"map","optional":false,"description":"the TMX map
","dataType":{"tokens":[{"value":"TMXTileMap","kind":"canonical"},{"value":"TMXTileMap","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"j-97G5QnoLOmJbu-Vk4dV","name":"drawTile","brief":"","scope":"instance","type":"MethodDoc","description":"draw the given tile at the specified layer
","params":[{"identifier":"renderer","optional":false,"description":"a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}},{"identifier":"x","optional":false,"description":"X coordinate where to draw the tile
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"Y coordinate where to draw the tile
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"tile","optional":false,"description":"the tile object to draw
","dataType":{"tokens":[{"value":"Tile","kind":"canonical"},{"value":"Tile","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"UpTiOpH_IZLElFSxigZ9h","name":"drawTileLayer","brief":"","scope":"instance","type":"MethodDoc","description":"draw the given TMX Layer for the given area
","params":[{"identifier":"renderer","optional":false,"description":"a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}},{"identifier":"layer","optional":false,"description":"a TMX Layer object
","dataType":{"tokens":[{"value":"TMXLayer","kind":"canonical"},{"value":"TMXLayer","kind":"link"}],"template":"%1"}},{"identifier":"rect","optional":false,"description":"the area of the layer to draw
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"Ob1NChiVHr5l5PI0PzeJH","name":"getBounds","brief":"","scope":"instance","type":"MethodDoc","description":"return the bounding rect for this map renderer
","params":[{"identifier":"layer","optional":true,"description":"calculate the bounding rect for a specific layer (will return a new bounds object)
","dataType":{"tokens":[{"value":"TMXLayer","kind":"canonical"},{"value":"TMXLayer","kind":"link"}],"template":"%1"}}],"returns":[{"dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"1OOrU--7vHkBMPNrXPwef","name":"pixelToTileCoords","brief":"","scope":"instance","type":"MethodDoc","description":"return the tile position corresponding to the specified pixel
","params":[{"identifier":"x","optional":false,"description":"X coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"Y coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":true,"description":"an optional vector object where to put the return values
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"jSlITpSj6RYAK-0TdVFLb","name":"tileToPixelCoords","brief":"","scope":"instance","type":"MethodDoc","description":"return the pixel position corresponding of the specified tile
","params":[{"identifier":"col","optional":false,"description":"tile horizontal position
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"row","optional":false,"description":"tile vertical position
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":true,"description":"an optional vector object where to put the return values
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]}]},{"id":"hfs0K36EyhiEXZDM-2lDW","name":"TMXIsometricRenderer","brief":"","type":"ClassDoc","description":"an Isometric Map Renderder
","params":[],"returns":[],"extends":["TMXRenderer"],"implements":[],"members":[{"id":"D0Py3attcy9WbE9ffKjqS","name":"canRender","brief":"","scope":"instance","type":"MethodDoc","description":"return true if the renderer can render the specified map or layer
","params":[{"identifier":"component","optional":false,"description":"TMX Map or Layer
","dataType":{"tokens":[{"value":"TMXTileMap | TMXLayer","kind":"canonical"},{"value":"TMXTileMap","kind":"link"},{"value":"TMXLayer","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"JE-N8DVKt18KZa6Fmq6on","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"map","optional":false,"description":"the TMX map
","dataType":{"tokens":[{"value":"TMXTileMap","kind":"canonical"},{"value":"TMXTileMap","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"mROq_Qg_yeJs28ywVp7iC","name":"drawTile","brief":"","scope":"instance","type":"MethodDoc","description":"draw the given tile at the specified layer
","params":[{"identifier":"renderer","optional":false,"description":"a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}},{"identifier":"x","optional":false,"description":"X coordinate where to draw the tile
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"Y coordinate where to draw the tile
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"tile","optional":false,"description":"the tile object to draw
","dataType":{"tokens":[{"value":"Tile","kind":"canonical"},{"value":"Tile","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"HUTTNbVCqNtnbWY3h_leh","name":"drawTileLayer","brief":"","scope":"instance","type":"MethodDoc","description":"draw the given TMX Layer for the given area
","params":[{"identifier":"renderer","optional":false,"description":"a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}},{"identifier":"layer","optional":false,"description":"a TMX Layer object
","dataType":{"tokens":[{"value":"TMXLayer","kind":"canonical"},{"value":"TMXLayer","kind":"link"}],"template":"%1"}},{"identifier":"rect","optional":false,"description":"the area of the layer to draw
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"Irc9OctjFcmsjTePnkLoH","name":"getBounds","brief":"","scope":"instance","type":"MethodDoc","description":"return the bounding rect for this map renderer
","params":[{"identifier":"layer","optional":true,"description":"calculate the bounding rect for a specific layer (will return a new bounds object)
","dataType":{"tokens":[{"value":"TMXLayer","kind":"canonical"},{"value":"TMXLayer","kind":"link"}],"template":"%1"}}],"returns":[{"dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"dT-G2hACrmT8ndaz2Rj9J","name":"pixelToTileCoords","brief":"","scope":"instance","type":"MethodDoc","description":"return the tile position corresponding to the specified pixel
","params":[{"identifier":"x","optional":false,"description":"X coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"Y coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":true,"description":"an optional vector object where to put the return values
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"zMnl7RZbfFpp0u5Wg673C","name":"tileToPixelCoords","brief":"","scope":"instance","type":"MethodDoc","description":"return the pixel position corresponding of the specified tile
","params":[{"identifier":"col","optional":false,"description":"tile horizontal position
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"row","optional":false,"description":"tile vertical position
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":true,"description":"an optional vector object where to put the return values
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]}]},{"id":"J3uar8LCKh0OmWxNGkKDt","name":"TMXLayer","brief":"","type":"ClassDoc","description":"a TMX Tile Layer Object\nTiled QT 0.7.x format
","params":[],"returns":[],"extends":["Renderable"],"implements":[],"members":[{"id":"OMh54recDV-BbxNJ-FHbW","name":"alpha","brief":"","defaultValue":"1.0","scope":"instance","see":["Renderable#setOpacity","Renderable#getOpacity"],"type":"PropertyDoc","description":"Define the renderable opacity
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"GkfpFp9QFvL7MxyoCj0uZ","name":"alwaysUpdate","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object will always update, even when outside of the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"xjwICbPtwPGkt43IfZY38","name":"ancestor","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"a reference to the parent object that contains this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"J-4v_9EyS7Zo4Wxw7i6cQ","name":"anchorPoint","brief":"","defaultValue":"<0.5,0.5>","scope":"instance","type":"PropertyDoc","description":"The anchor point is used for attachment behavior, and/or when applying transformations.
All animated tilesets in this layer
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"XQ7ZrlOd-eCJyCqigquyw","name":"autoTransform","brief":"","defaultValue":"true","examples":[{"caption":"","code":"// enable \"automatic\" transformation when the object is activated\nonActivateEvent: function () {\n // reset the transformation matrix\n this.currentTransform.identity();\n // ensure the anchor point is the renderable center\n this.anchorPoint.set(0.5, 0.5);\n // enable auto transform\n this.autoTransform = true;\n ....\n}"}],"scope":"instance","type":"PropertyDoc","description":"When enabled, an object container will automatically apply\nany defined transformation before calling the child draw method...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"uVuGxtj5eFZQ_gXD0PXpK","name":"blendMode","brief":"","defaultValue":"\"normal\"","scope":"instance","see":["CanvasRenderer#setBlendMode","WebGLRenderer#setBlendMode"],"type":"PropertyDoc","description":"
the blend mode to be applied to this renderable (see renderer setBlendMode for available blend mode)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"5gomsiKPVYxxdswPlP9cW","name":"body","brief":"","examples":[{"caption":"","code":" // define a new Player Class\n class PlayerEntity extends me.Sprite {\n // constructor\n constructor(x, y, settings) {\n // call the parent constructor\n super(x, y , settings);\n\n // define a basic walking animation\n this.addAnimation(\"walk\", [...]);\n // define a standing animation (using the first frame)\n this.addAnimation(\"stand\", [...]);\n // set the standing animation as default\n this.setCurrentAnimation(\"stand\");\n\n // add a physic body\n this.body = new me.Body(this);\n // add a default collision shape\n this.body.addShape(new me.Rect(0, 0, this.width, this.height));\n // configure max speed, friction, and initial force to be applied\n this.body.setMaxVelocity(3, 15);\n this.body.setFriction(0.4, 0);\n this.body.force.set(3, 0);\n this.isKinematic = false;\n\n // set the display to follow our position on both axis\n me.game.viewport.follow(this.pos, me.game.viewport.AXIS.BOTH);\n }\n\n ...\n\n }"}],"scope":"instance","type":"PropertyDoc","description":"the renderable physic body
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ipk8c1Fdzn1O1unRXNXMY","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"zBSgtboU1VAXH-SsBgnxi","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"n74f67vQYVHSYd-e0IbpZ","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"pmebTd-vRRkCdio3vpw_o","name":"class","brief":"","scope":"instance","type":"PropertyDoc","description":"the layer class
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"rF0BoaA9w0jBsvJi875qy","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"lZNslGkExgmYjwApa1a9k","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ag1tHaiWlEfpiVBp3yZat","name":"floating","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"If true, this renderable will be rendered using screen coordinates,\nas opposed to world coordinates. Use this, for example...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"7cmj4Kihgi7ngwdkOGymI","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"
(G)ame (U)nique (Id)entifier"
height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"T4qn34nBd0qsI-2gwcjej","name":"inViewport","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object is visible and within the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"H4ZOvMLDnlTN88r5x18ie","name":"isAnimated","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Layer contains tileset animations
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"G-It2Fn6UFB9V_Uwb41uO","name":"isDirty","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"when true the renderable will be redrawn during the next update cycle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"JZlDvDToiKxMqlHbP-Cdp","name":"isFlippedX","brief":"","access":"public","scope":"instance","see":["Renderable#flipX"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"lMbkItk3LdF_SX_vuC40f","name":"isFlippedY","brief":"","access":"public","scope":"instance","see":["Renderable#flipY"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"LJBvNpsPMWl-kD9NPkggl","name":"isFloating","brief":"","scope":"instance","see":["Renderable#floating"],"type":"PropertyDoc","description":"Whether the renderable object is floating (i.e. used screen coordinates), or contained in a floating parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"a9ttN28aGjKLy9QZ_asOs","name":"isKinematic","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"If true then physic collision and input events will not impact this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"2oTLxqD8sSFSpiPPJ32_0","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"cultOPgjAxeEWjCSw5LDu","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"qo2EGVqArgrNAF44OAEsA","name":"mask","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"// apply a mask in the shape of a Star\nmyNPCSprite.mask = new me.Polygon(myNPCSprite.width / 2, 0, [\n // draw a star\n {x: 0, y: 0},\n {x: 14, y: 30},\n {x: 47, y: 35},\n {x: 23, y: 57},\n {x: 44, y: 90},\n {x: 0, y: 62},\n {x: -44, y: 90},\n {x: -23, y: 57},\n {x: -47, y: 35},\n {x: -14, y: 30}\n]);"}],"scope":"instance","type":"PropertyDoc","description":"A mask limits rendering elements to the shape and position of the given mask object.\nSo, if the renderable is larger than ...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"5qkVMw9mZYjBHi0TGRQ4j","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"K7rSHD7GmZiU_isXGBl4a","name":"onVisibilityChange","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"this.onVisibilityChange = function(inViewport) {\n if (inViewport === true) {\n console.log(\"object has entered the in a camera viewport!\");\n }\n};"}],"scope":"instance","type":"PropertyDoc","description":"an event handler that is called when the renderable leave or enter a camera viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"G1FEKOEcciYMJl-YR_LKk","name":"parentApp","brief":"","scope":"instance","type":"PropertyDoc","description":"returns the parent application (or game) to which this renderable is attached to
","params":[],"returns":[{"description":"the parent application or undefined if not attached to any container/app
","dataType":{"tokens":[{"value":"Application","kind":"canonical"},{"value":"Application","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"3PoxOQplqoNGlfAsCBDMC","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"mgDl4PzuzDnf9vYlV5c0L","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Qc8oENKcoKoS6wbiSTQQw","name":"renderorder","brief":"","defaultValue":"\"right-down\"","scope":"instance","type":"PropertyDoc","description":"the order in which tiles on orthogonal tile layers are rendered.\n(valid values are "left-down", "left-up&qu...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"LpkPRYsl9Qohudm3xnm-G","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"
right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"BORV4oaW4rhBaeR5I54al","name":"shader","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"(Experimental) an optional shader, to be used instead of the default built-in one, when drawing this renderable (WebGL onl...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"0E5vESvgb5nv1oZIVt7LJ","name":"tilesets","brief":"","scope":"instance","type":"PropertyDoc","description":"
The Layer corresponding Tilesets
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"qchEBOChzmCVOUww2UxN6","name":"tint","brief":"","defaultValue":"(255, 255, 255)","examples":[{"caption":"","code":"// add a red tint to this renderable\nthis.tint.setColor(255, 128, 128);\n// remove the tint\nthis.tint.setColor(255, 255, 255);"}],"scope":"instance","type":"PropertyDoc","description":"define a tint for this renderable. a (255, 255, 255) r, g, b value will remove the tint effect.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"uvQWFuTy47VyHn3fNOyHs","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"MDfrhGLZpG0Ac-UCpmq6a","name":"type","brief":"","defaultValue":"\"Rectangle\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"sczJl263pnUd0seBhisrO","name":"updateWhenPaused","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether to update this object when the game is paused.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"rd_KxBppA2C44v_AdZDLa","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"nSIQk9Lp4qLksFnwY-C2i","name":"x","brief":"","defaultValue":"0","scope":"instance","type":"PropertyDoc","description":"Horizontal layer offset in tiles
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"XC4oxYa1keC2eBVoy-Jkp","name":"y","brief":"","defaultValue":"0","scope":"instance","type":"PropertyDoc","description":"Vertical layer offset in tiles
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"YZzJAst7R8zVy1LJTVnen","name":"angleTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the angle to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"angle in radians
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"QIWD6J0I3qqhC3UpVPpkK","name":"cellAt","brief":"","examples":[{"caption":"","code":"// return the first tile at offset 0, 0\nlet tile = layer.cellAt(0, 0);"}],"scope":"instance","type":"MethodDoc","description":"Return the Tile object at the specified tile coordinates
","params":[{"identifier":"x","optional":false,"description":"x position of the tile (in Tile unit)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"x position of the tile (in Tile unit)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"boundsCheck","optional":true,"default":"true","description":"check first if within the layer bounds
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"corresponding tile or null if there is no defined tile at the position or if outside of the layer bounds
","dataType":{"tokens":[{"value":"Tile","kind":"canonical"},{"value":"Tile","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"71NwKJ3f9qgYRj5A_josf","name":"centerOn","brief":"","scope":"instance","type":"MethodDoc","description":"center the rectangle position around the given coordinates
","params":[{"identifier":"x","optional":false,"description":"the x coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"mqhtNNzwHdHshZ11LpXxx","name":"clearTile","brief":"","examples":[{"caption":"","code":"me.game.world.getChildByType(me.TMXLayer).forEach(function(layer) {\n // clear all tiles at the given x,y coordinates\n layer.clearTile(x, y);\n});"}],"scope":"instance","type":"MethodDoc","description":"clear the tile at the specified position
","params":[{"identifier":"x","optional":false,"description":"X coordinate (in map coordinates: row/column)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"Y coordinate (in map coordinates: row/column)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"sTTMdsC0zmqKxdBVWngpP","name":"clone","brief":"","scope":"instance","type":"MethodDoc","description":"clone this rectangle
","params":[],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"us8yj-iFLsjHkiAL7OsWw","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"map","optional":false,"description":"layer data in JSON format ({@link http://docs.mapeditor.org/en/stable/reference/tmx-map-format/#layer})
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}},{"identifier":"data","optional":false,"description":"layer data in JSON format ({@link http://docs.mapeditor.org/en/stable/reference/tmx-map-format/#layer})
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}},{"identifier":"tilewidth","optional":false,"description":"width of each tile in pixels
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"tileheight","optional":false,"description":"height of each tile in pixels
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"orientation","optional":false,"description":""isometric" or "orthogonal"
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"tilesets","optional":false,"description":"tileset as defined in Tiled
","dataType":{"tokens":[{"value":"TMXTilesetGroup","kind":"canonical"},{"value":"TMXTilesetGroup","kind":"link"}],"template":"%1"}},{"identifier":"z","optional":false,"description":"z-index position
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"3gIwe1LexeAzoPia7WVJQ","name":"contains","brief":"","examples":[{"caption":"","code":"if (rect.contains(10, 10)) {\n // do something\n}\n// or\nif (rect.contains(myVector2d)) {\n // do something\n}\nif (rect.contains(myRect)) {\n // do something\n}"}],"scope":"instance","type":"MethodDoc","description":"Returns true if the rectangle contains the given point or rectangle
","params":[{"identifier":"x","description":"x coordinate or a vector point, or a rectangle to test
","dataType":{"tokens":[{"value":"number | Vector2d | Rect","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"Rect","kind":"link"}],"template":"%1 | %2 | %3"}},{"identifier":"y","optional":true,"description":"y coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"True if the rectangle contain the given point or rectangle, otherwise false
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"9SSQoXolVhgixdMnaKAox","name":"copy","brief":"","scope":"instance","type":"MethodDoc","description":"copy the position and size of the given rectangle into this one
","params":[{"identifier":"rect","optional":false,"description":"Source rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"IjxjqMWAStUE2GcL1AozN","name":"distanceTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the distance to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"distance
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"tbCUQ8ZcrLXLFzg3r4xri","name":"draw","brief":"","scope":"instance","see":["Renderable#preDraw","Renderable#postDraw"],"type":"MethodDoc","description":"Draw this renderable (automatically called by melonJS).\nAll draw operations for renderable are made respectively\nto the po...","params":[{"identifier":"renderer","optional":false,"description":"
a renderer instance
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}},{"identifier":"viewport","optional":true,"description":"the viewport to (re)draw
","dataType":{"tokens":[{"value":"Camera2d","kind":"canonical"},{"value":"Camera2d","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"3kqHXQoNHURqhaIYoAIWk","name":"equals","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is identical to the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if equals
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"aU6C5l4lMgVf8PPq_oAMo","name":"flipX","brief":"","scope":"instance","see":["Matrix2d#scaleX"],"type":"MethodDoc","description":"flip the renderable on the horizontal axis (around the center of the renderable)
","params":[{"identifier":"flip","optional":true,"default":"true","description":"true to flip this renderable.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"hjBcCIAp62RUr0BjuNwAI","name":"flipY","brief":"","scope":"instance","see":["Matrix2d#scaleY"],"type":"MethodDoc","description":"flip the renderable on the vertical axis (around the center of the renderable)
","params":[{"identifier":"flip","optional":true,"default":"true","description":"true to flip this renderable.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"HDpKn1HwISyEeubB44bSz","name":"getAbsolutePosition","brief":"","scope":"instance","type":"MethodDoc","description":"return the renderable absolute position in the game world
","params":[],"returns":[{"dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"fx4NdSUgSzt61sIXM_NAb","name":"getBounds","brief":"","scope":"instance","type":"MethodDoc","description":"returns the bounding box for this renderable
","params":[],"returns":[{"description":"bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"z9zfBaPlnAxIZtAxFKTaK","name":"getIndices","brief":"","scope":"instance","type":"MethodDoc","description":"returns a list of indices for all triangles defined in this polygon
","params":[],"returns":[{"description":"an array of vertex indices for all triangles forming this polygon.
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1<%2>"}}],"extends":[],"implements":[]},{"id":"7o7W5-J9UUrUQJ2WBBHCJ","name":"getOpacity","brief":"","scope":"instance","type":"MethodDoc","description":"get the renderable alpha channel value
","params":[],"returns":[{"description":"current opacity value between 0 and 1
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"aOEL92LjHICHDs78_SEWk","name":"getRenderer","brief":"","scope":"instance","type":"MethodDoc","description":"Return the layer current renderer object
","params":[],"returns":[{"description":"renderer
","dataType":{"tokens":[{"value":"TMXRenderer","kind":"canonical"},{"value":"TMXRenderer","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"xQrQh_xfaeVClrnQSFDj5","name":"getTile","brief":"","examples":[{"caption":"","code":"// get the TMX Map Layer called \"Front layer\"\nlet layer = me.game.world.getChildByName(\"Front Layer\")[0];\n// get the tile object corresponding to the latest pointer position\nlet tile = layer.getTile(me.input.pointer.x, me.input.pointer.y);"}],"scope":"instance","type":"MethodDoc","description":"Return the Tile object at the specified position
","params":[{"identifier":"x","optional":false,"description":"X coordinate (in world/pixels coordinates)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"Y coordinate (in world/pixels coordinates)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"corresponding tile or null if there is no defined tile at the coordinate or if outside of the layer bounds
","dataType":{"tokens":[{"value":"Tile","kind":"canonical"},{"value":"Tile","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"n8FuHwnQBQ6fp2K6BvmBj","name":"getTileById","brief":"","scope":"instance","type":"MethodDoc","description":"return a new the Tile object corresponding to the given tile id
","params":[{"identifier":"tileId","optional":false,"description":"tileId
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"x","optional":false,"description":"X coordinate (in world/pixels coordinates)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"Y coordinate (in world/pixels coordinates)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"the tile object
","dataType":{"tokens":[{"value":"Tile","kind":"canonical"},{"value":"Tile","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"F9WYOVLibg4I5bszPBjR6","name":"getTileId","brief":"","scope":"instance","type":"MethodDoc","description":"Return the TileId of the Tile at the specified position
","params":[{"identifier":"x","optional":false,"description":"X coordinate (in world/pixels coordinates)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"Y coordinate (in world/pixels coordinates)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"TileId or null if there is no Tile at the given position
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"VKcp3IHtYNu99mF2LceqK","name":"isConvex","brief":"","scope":"instance","type":"MethodDoc","description":"Returns true if the vertices composing this polygon form a convex shape (vertices must be in clockwise order).
","params":[],"returns":[{"description":"true if the vertices are convex, false if not, null if not computable
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"GnltlvebOC1gDMA8mgn4_","name":"isFinite","brief":"","scope":"instance","type":"MethodDoc","description":"determines whether all coordinates of this rectangle are finite numbers.
","params":[],"returns":[{"description":"false if all coordinates are positive or negative Infinity or NaN; otherwise, true.
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"cLGMOojMazq0g2bIDvdxe","name":"lookAt","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this renderable towards the given target.
","params":[{"identifier":"target","optional":false,"description":"the renderable or position to look at
","dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"eMhVVbLrseYweEjKEONIY","name":"onCollision","brief":"","examples":[{"caption":"","code":"// colision handler\nonCollision(response) {\n if (response.b.body.collisionType === me.collision.types.ENEMY_OBJECT) {\n // makes the other object solid, by substracting the overlap vector to the current position\n this.pos.sub(response.overlapV);\n this.hurt();\n // not solid\n return false;\n }\n // Make the object solid\n return true;\n},"}],"scope":"instance","type":"MethodDoc","description":"onCollision callback, triggered in case of collision,\nwhen this renderable body is colliding with another one
","params":[{"identifier":"response","optional":false,"description":"the collision response object
","dataType":{"tokens":[{"value":"ResponseObject","kind":"canonical"},{"value":"ResponseObject","kind":"link"}],"template":"%1"}},{"identifier":"other","optional":false,"description":"the other renderable touching this one (a reference to response.a or response.b)
","dataType":{"tokens":[{"value":"Renderable | Container | Entity | Sprite | NineSliceSprite","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Container","kind":"link"},{"value":"Entity","kind":"link"},{"value":"Sprite","kind":"link"},{"value":"NineSliceSprite","kind":"link"}],"template":"%1 | %2 | %3 | %4 | %5"}}],"returns":[{"description":"true if the object should respond to the collision (its position and velocity will be corrected)
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"E7eZoY0tMnezwDH8Is4L6","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"OnDestroy Notification function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"pYnK3Ad3brKyPGDe6FX_C","name":"overlaps","brief":"","scope":"instance","type":"MethodDoc","description":"check if this rectangle is intersecting with the specified one
","params":[{"identifier":"rect","optional":false,"dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"true if overlaps
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"PpciwqBJZJ2-xhOlKjGLY","name":"postDraw","brief":"","scope":"instance","see":["Renderable#preDraw","Renderable#draw"],"type":"MethodDoc","description":"restore the rendering context after drawing (automatically called by melonJS).
","params":[{"identifier":"renderer","optional":false,"description":"a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"s1tg_jHplvh3IOe0dOq7p","name":"preDraw","brief":"","scope":"instance","see":["Renderable#draw","Renderable#postDraw"],"type":"MethodDoc","description":"Prepare the rendering context before drawing (automatically called by melonJS).\nThis will apply any defined transforms, an...","params":[{"identifier":"renderer","optional":false,"description":"
a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}}],"returns":[],"extends":[],"implements":[]},{"id":"MVfkBbOKv2YMH-BvZbl8F","name":"recalc","brief":"","scope":"instance","type":"MethodDoc","description":"Computes the calculated collision polygon.\nThis must be called if the points array, an...","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Xe3nxLWo7IfiGFpeUBV_P","name":"resize","brief":"","scope":"instance","type":"MethodDoc","description":"resize the rectangle
","params":[{"identifier":"w","optional":false,"description":"new width of the rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"h","optional":false,"description":"new height of the rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"HLRf6HDgFUBNXBy9Ha124","name":"rotate","brief":"","scope":"instance","type":"MethodDoc","description":"Rotate this renderable by the specified angle (in radians).
","params":[{"identifier":"angle","optional":false,"description":"The angle to rotate (in radians)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":true,"description":"an optional point to rotate around
","dataType":{"tokens":[{"value":"Vector2d | ObservableVector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"},{"value":"ObservableVector2d","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"wkD3DV9dTWsw9OeJQIBPk","name":"scale","brief":"","scope":"instance","type":"MethodDoc","description":"scale the renderable around his anchor point. Scaling actually applies changes\nto the currentTransform member wich is use...","params":[{"identifier":"x","optional":false,"description":"
a number representing the abscissa of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":true,"default":"x","description":"a number representing the ordinate of the scaling vector.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Wq7II8a5pUe5ilVCIOpXD","name":"scaleV","brief":"","scope":"instance","type":"MethodDoc","description":"scale the renderable around his anchor point
","params":[{"identifier":"v","optional":false,"description":"scaling vector
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"SzbfG8G7sRQS5mTiLqC_K","name":"setOpacity","brief":"","scope":"instance","type":"MethodDoc","description":"set the renderable alpha channel value
","params":[{"identifier":"alpha","optional":false,"description":"opacity value between 0.0 and 1.0
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"vJHFsvwPgCT2Z3Mn0NvBv","name":"setRenderer","brief":"","examples":[{"caption":"","code":"// use the parent map default renderer\nlet layer = new me.TMXLayer(...);\nlayer.setRenderer(map.getRenderer());"}],"scope":"instance","type":"MethodDoc","description":"Set the TMX renderer for this layer object
","params":[{"identifier":"renderer","optional":false,"dataType":{"tokens":[{"value":"TMXRenderer","kind":"canonical"},{"value":"TMXRenderer","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"cfDr1Oj2U1cw3SLPxBDl-","name":"setShape","brief":"","scope":"instance","type":"MethodDoc","description":"set new value to the rectangle shape
","params":[{"identifier":"x","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"position of the Rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"w","optional":false,"description":"width of the rectangle, or an array of vector defining the rectangle
","dataType":{"tokens":[{"value":"number | Array","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %3<%2>"}},{"identifier":"h","optional":true,"description":"height of the rectangle, if a numeral width parameter is specified
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"__ubCpGyPlj_CSE65h00s","name":"setTile","brief":"","scope":"instance","type":"MethodDoc","description":"assign the given Tile object to the specified position
","params":[{"identifier":"tile","optional":false,"description":"the tile object to be assigned
","dataType":{"tokens":[{"value":"Tile","kind":"canonical"},{"value":"Tile","kind":"link"}],"template":"%1"}},{"identifier":"x","optional":false,"description":"x coordinate (in world/pixels coordinates)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"y coordinate (in world/pixels coordinates)
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"the tile object
","dataType":{"tokens":[{"value":"Tile","kind":"canonical"},{"value":"Tile","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Yi1tyxPscRNsO6arlsbq7","name":"setVertices","brief":"","scope":"instance","type":"MethodDoc","description":"set the vertices defining this Polygon
","params":[{"identifier":"vertices","optional":false,"description":"array of vector or vertice defining the Polygon
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1<%2>"}}],"returns":[{"description":"this instance for objecf chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"2-AyAxRX4QBB66hxa-ZhG","name":"shift","brief":"","examples":[{"caption":"","code":"polygon.shift(10, 10);\n// or\npolygon.shift(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"Shifts the Polygon to the given position vector.
","params":[{"identifier":"x","description":"x coordinate or a vector point to shift to
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"X1li4aUUIVrGI5qLuEGQe","name":"to2d","brief":"","scope":"instance","type":"MethodDoc","description":"apply a 2d projection to this shapen
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"N-FAtFu5v4IoDCo5uI2LZ","name":"toIso","brief":"","scope":"instance","type":"MethodDoc","description":"apply an isometric projection to this shape
","params":[],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Fu_qgN5shd7lZk_WWdXE8","name":"toPolygon","brief":"","scope":"instance","type":"MethodDoc","description":"Returns a polygon whose edges are the same as this box.
","params":[],"returns":[{"description":"a new Polygon that represents this rectangle.
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"nQtK9kVNOrhY0EQFwhqQK","name":"transform","brief":"","scope":"instance","see":["Renderable#currentTransform"],"type":"MethodDoc","description":"multiply the renderable currentTransform with the given matrix
","params":[{"identifier":"m","optional":false,"description":"the transformation matrix
","dataType":{"tokens":[{"value":"Matrix2d","kind":"canonical"},{"value":"Matrix2d","kind":"link"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Renderable","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"G98F-Bw8hGIkJQ7c_Ot0R","name":"translate","brief":"","examples":[{"caption":"","code":"polygon.translate(10, 10);\n// or\npolygon.translate(myVector2d);"}],"scope":"instance","type":"MethodDoc","description":"translate the Polygon by the specified offset
","params":[{"identifier":"x","description":"x offset or a vector point to translate by
","dataType":{"tokens":[{"value":"number | Vector2d","kind":"canonical"},{"value":"number","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1 | %2"}},{"identifier":"y","optional":true,"description":"y offset
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"Reference to this object for method chaining
","dataType":{"tokens":[{"value":"Polygon","kind":"canonical"},{"value":"Polygon","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"iirqlh4gSjy7jNBqtj9Cg","name":"union","brief":"","scope":"instance","type":"MethodDoc","description":"merge this rectangle with another one
","params":[{"identifier":"rect","optional":false,"description":"other rectangle to union with
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[{"description":"the union(ed) rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"nbIbEZH7h4HZ1YXwibBuQ","name":"update","brief":"","scope":"instance","type":"MethodDoc","description":"update function (automatically called by melonJS).
","params":[{"identifier":"dt","optional":false,"description":"time since the last update in milliseconds.
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"true if the renderable is dirty
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"MCDjYXQDDZCgWDlzgBN6X","name":"updateBounds","brief":"","scope":"instance","type":"MethodDoc","description":"update the bounding box for this shape.
","params":[{"identifier":"absolute","optional":true,"default":"true","description":"update the bounds size and position in (world) absolute coordinates
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"this shape bounding box Rectangle object
","dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"zBGJx9E8L1bN-BH81qfkx","name":"onAnchorUpdate","brief":"","access":"private","scope":"instance","type":"MethodDoc","description":"called when the anchor point value is changed
","params":[{"identifier":"x","optional":false,"description":"the new X value to be set for the anchor
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the new Y value to be set for the anchor
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]}]},{"id":"6t1NdgfppCmYX8InH5D_6","name":"TMXOrthogonalRenderer","brief":"","type":"ClassDoc","description":"an Orthogonal Map Renderder
","params":[],"returns":[],"extends":["TMXRenderer"],"implements":[],"members":[{"id":"VuPHYy7Fjn5O0F20ovzdu","name":"canRender","brief":"","scope":"instance","type":"MethodDoc","description":"return true if the renderer can render the specified map or layer
","params":[{"identifier":"component","optional":false,"description":"TMX Map or Layer
","dataType":{"tokens":[{"value":"TMXTileMap | TMXLayer","kind":"canonical"},{"value":"TMXTileMap","kind":"link"},{"value":"TMXLayer","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"oc6FaHKNV7rOsIjmW6abE","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"map","optional":false,"description":"the TMX map
","dataType":{"tokens":[{"value":"TMXTileMap","kind":"canonical"},{"value":"TMXTileMap","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"92J-jMdq-KWx1FQ1tmGSO","name":"drawTile","brief":"","scope":"instance","type":"MethodDoc","description":"draw the given tile at the specified layer
","params":[{"identifier":"renderer","optional":false,"description":"a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}},{"identifier":"x","optional":false,"description":"X coordinate where to draw the tile
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"Y coordinate where to draw the tile
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"tile","optional":false,"description":"the tile object to draw
","dataType":{"tokens":[{"value":"Tile","kind":"canonical"},{"value":"Tile","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"5lQ2S4oanecmJxbeMk-_b","name":"drawTileLayer","brief":"","scope":"instance","type":"MethodDoc","description":"draw the given TMX Layer for the given area
","params":[{"identifier":"renderer","optional":false,"description":"a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}},{"identifier":"layer","optional":false,"description":"a TMX Layer object
","dataType":{"tokens":[{"value":"TMXLayer","kind":"canonical"},{"value":"TMXLayer","kind":"link"}],"template":"%1"}},{"identifier":"rect","optional":false,"description":"the area of the layer to draw
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"y-x0AMh3Y-UOga4AdJhDl","name":"getBounds","brief":"","scope":"instance","type":"MethodDoc","description":"return the bounding rect for this map renderer
","params":[{"identifier":"layer","optional":true,"description":"calculate the bounding rect for a specific layer (will return a new bounds object)
","dataType":{"tokens":[{"value":"TMXLayer","kind":"canonical"},{"value":"TMXLayer","kind":"link"}],"template":"%1"}}],"returns":[{"dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"mU_AVzugMNVz7f2UFU6S6","name":"pixelToTileCoords","brief":"","scope":"instance","type":"MethodDoc","description":"return the tile position corresponding to the specified pixel
","params":[{"identifier":"x","optional":false,"description":"X coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"Y coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":true,"description":"an optional vector object where to put the return values
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"h_eZiajnsK0OvQghAoxlU","name":"tileToPixelCoords","brief":"","scope":"instance","type":"MethodDoc","description":"return the pixel position corresponding of the specified tile
","params":[{"identifier":"col","optional":false,"description":"tile horizontal position
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"row","optional":false,"description":"tile vertical position
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":true,"description":"an optional vector object where to put the return values
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]}]},{"id":"ESBDWxEe5HYSdwjo35Kei","name":"TMXRenderer","brief":"","type":"ClassDoc","description":"The map renderer base class
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"rggH8DYIJ2okT1RKeg5gf","name":"canRender","brief":"","scope":"instance","type":"MethodDoc","description":"return true if the renderer can render the specified map or layer
","params":[{"identifier":"component","optional":false,"description":"TMX Map or Layer
","dataType":{"tokens":[{"value":"TMXTileMap | TMXLayer","kind":"canonical"},{"value":"TMXTileMap","kind":"link"},{"value":"TMXLayer","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"EOm61N9YJQD2DA29uDGrc","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"cols","optional":false,"description":"width of the tilemap in tiles
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"rows","optional":false,"description":"height of the tilemap in tiles
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"tilewidth","optional":false,"description":"width of each tile in pixels
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"tileheight","optional":false,"description":"height of each tile in pixels
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"s-g-kajRqXeCJWkC3i0Yq","name":"drawTile","brief":"","scope":"instance","type":"MethodDoc","description":"draw the given tile at the specified layer
","params":[{"identifier":"renderer","optional":false,"description":"a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}},{"identifier":"x","optional":false,"description":"X coordinate where to draw the tile
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"Y coordinate where to draw the tile
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"tile","optional":false,"description":"the tile object to draw
","dataType":{"tokens":[{"value":"Tile","kind":"canonical"},{"value":"Tile","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"cf_fagGxLyLPV_4xCyxWp","name":"drawTileLayer","brief":"","scope":"instance","type":"MethodDoc","description":"draw the given TMX Layer for the given area
","params":[{"identifier":"renderer","optional":false,"description":"a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}},{"identifier":"layer","optional":false,"description":"a TMX Layer object
","dataType":{"tokens":[{"value":"TMXLayer","kind":"canonical"},{"value":"TMXLayer","kind":"link"}],"template":"%1"}},{"identifier":"rect","optional":false,"description":"the area of the layer to draw
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"M_o_IWmZRipO1ZwzlTrxE","name":"getBounds","brief":"","scope":"instance","type":"MethodDoc","description":"return the bounding rect for this map renderer
","params":[{"identifier":"layer","optional":true,"description":"calculate the bounding rect for a specific layer (will return a new bounds object)
","dataType":{"tokens":[{"value":"TMXLayer","kind":"canonical"},{"value":"TMXLayer","kind":"link"}],"template":"%1"}}],"returns":[{"dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"kpDAuTXrihqu-YGGU9P7p","name":"pixelToTileCoords","brief":"","scope":"instance","type":"MethodDoc","description":"return the tile position corresponding to the specified pixel
","params":[{"identifier":"x","optional":false,"description":"X coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"Y coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":true,"description":"an optional vector object where to put the return values
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"S2myjOvs6_8LO5X9LeQbB","name":"tileToPixelCoords","brief":"","scope":"instance","type":"MethodDoc","description":"return the pixel position corresponding of the specified tile
","params":[{"identifier":"col","optional":false,"description":"tile horizontal position
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"row","optional":false,"description":"tile vertical position
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":true,"description":"an optional vector object where to put the return values
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]}]},{"id":"xdDflSqFte4f4V1yEnvcf","name":"TMXStaggeredRenderer","type":"ClassDoc","description":"a Staggered Map Renderder
","params":[],"returns":[],"extends":["TMXHexagonalRenderer"],"implements":[],"members":[{"id":"Rj4BIj_MaO13bFvghqCvT","name":"canRender","brief":"","scope":"instance","type":"MethodDoc","description":"return true if the renderer can render the specified map or layer
","params":[{"identifier":"component","optional":false,"description":"TMX Map or Layer
","dataType":{"tokens":[{"value":"TMXTileMap | TMXLayer","kind":"canonical"},{"value":"TMXTileMap","kind":"link"},{"value":"TMXLayer","kind":"link"}],"template":"%1 | %2"}}],"returns":[{"dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"_-aaVkhp6dVxHl_efE4o-","name":"constructor","brief":"","access":"public","scope":"instance","type":"MethodDoc","params":[],"returns":[]},{"id":"rnc_uOy9YskHkFFuHEoRH","name":"drawTile","brief":"","scope":"instance","type":"MethodDoc","description":"draw the given tile at the specified layer
","params":[{"identifier":"renderer","optional":false,"description":"a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}},{"identifier":"x","optional":false,"description":"X coordinate where to draw the tile
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"Y coordinate where to draw the tile
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"tile","optional":false,"description":"the tile object to draw
","dataType":{"tokens":[{"value":"Tile","kind":"canonical"},{"value":"Tile","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"7sR-CfLY0pvm6-67AhLSC","name":"drawTileLayer","brief":"","scope":"instance","type":"MethodDoc","description":"draw the given TMX Layer for the given area
","params":[{"identifier":"renderer","optional":false,"description":"a renderer object
","dataType":{"tokens":[{"value":"CanvasRenderer | WebGLRenderer","kind":"canonical"},{"value":"CanvasRenderer","kind":"link"},{"value":"WebGLRenderer","kind":"link"}],"template":"%1 | %2"}},{"identifier":"layer","optional":false,"description":"a TMX Layer object
","dataType":{"tokens":[{"value":"TMXLayer","kind":"canonical"},{"value":"TMXLayer","kind":"link"}],"template":"%1"}},{"identifier":"rect","optional":false,"description":"the area of the layer to draw
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"DAs-xIUp9NYTA2W30ii8d","name":"getBounds","brief":"","scope":"instance","type":"MethodDoc","description":"return the bounding rect for this map renderer
","params":[{"identifier":"layer","optional":true,"description":"calculate the bounding rect for a specific layer (will return a new bounds object)
","dataType":{"tokens":[{"value":"TMXLayer","kind":"canonical"},{"value":"TMXLayer","kind":"link"}],"template":"%1"}}],"returns":[{"dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"jyxrWKvTfZ-e4irv90li4","name":"pixelToTileCoords","brief":"","scope":"instance","type":"MethodDoc","description":"return the tile position corresponding to the specified pixel
","params":[{"identifier":"x","optional":false,"description":"X coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"Y coordinate
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":true,"description":"an optional vector object where to put the return values
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"-pVENyEU3sKGf3ddFl9ME","name":"tileToPixelCoords","brief":"","scope":"instance","type":"MethodDoc","description":"return the pixel position corresponding of the specified tile
","params":[{"identifier":"col","optional":false,"description":"tile horizontal position
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"row","optional":false,"description":"tile vertical position
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"v","optional":true,"description":"an optional vector object where to put the return values
","dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"returns":[{"dataType":{"tokens":[{"value":"Vector2d","kind":"canonical"},{"value":"Vector2d","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]}]},{"id":"FTmtYEx1qE8wJhz0Qd1Ql","name":"TMXTileMap","brief":"","type":"ClassDoc","description":"a TMX Tile Map Object\nTiled QT +0.7.x format
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"6O77UF7UcT30zNoRt2KQo","name":"class","brief":"","scope":"instance","type":"PropertyDoc","description":"The map class.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"PKT5knDog-Y0Lg15P4bDc","name":"cols","brief":"","defaultValue":"-","scope":"instance","type":"PropertyDoc","description":"width of the tilemap in tiles
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"oAVzmGCsfrwHNpqEhfiNb","name":"infinite","brief":"","defaultValue":"0","scope":"instance","type":"PropertyDoc","description":"is the map an infinite map
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"OkkBCpYR8Ytca8M-ayhaf","name":"name","brief":"","scope":"instance","type":"PropertyDoc","description":"name of the tilemap
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"CGthZ9yt6dM5drF_Tyw7j","name":"orientation","brief":"","defaultValue":"\"orthogonal\"","scope":"instance","type":"PropertyDoc","description":"the map orientation type. melonJS supports “orthogonal”, “isometric”, “staggered” and “hexagonal”.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"vkn1Dov1Flr0Fb5SZiIqF","name":"renderorder","brief":"","defaultValue":"\"right-down\"","scope":"instance","type":"PropertyDoc","description":"the order in which tiles on orthogonal tile layers are rendered.\n(valid values are "left-down", "left-up&qu...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"nClAurUzDI74IHNfbQ2zm","name":"rows","brief":"","defaultValue":"-","scope":"instance","type":"PropertyDoc","description":"
height of the tilemap in tiles
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"be6pi0WMMdzTWouRHjBMM","name":"tiledversion","brief":"","scope":"instance","type":"PropertyDoc","description":"The Tiled version used to save the file (since Tiled 1.0.1).
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"IT-ezOPhHplYNCVa3bq44","name":"tileheight","brief":"","defaultValue":"-","scope":"instance","type":"PropertyDoc","description":"Tile height
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"vTRM5DrhYbkYtsfoO5-OU","name":"tilewidth","brief":"","defaultValue":"-","scope":"instance","type":"PropertyDoc","description":"Tile width
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"FE1dev6k7zGfvmq6lY6Yn","name":"version","brief":"","scope":"instance","type":"PropertyDoc","description":"the TMX format version
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"NnQfZHBeLhfaKVkPyoR2u","name":"addTo","brief":"","examples":[{"caption":"","code":"// create a new level object based on the TMX JSON object\nlet level = new me.TMXTileMap(levelId, me.loader.getTMX(levelId));\n// add the level to the game world container\nlevel.addTo(me.game.world, true, true);"}],"scope":"instance","type":"MethodDoc","description":"add all the map layers and objects to the given container.\nnote : this will not automatically update the camera viewport
","params":[{"identifier":"container","optional":false,"description":"target container
","dataType":{"tokens":[{"value":"Container","kind":"canonical"},{"value":"Container","kind":"link"}],"template":"%1"}},{"identifier":"flatten","optional":true,"default":"true","description":"if true, flatten all objects into the given container, else a me.Container object will be created for each co...","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}},{"identifier":"setViewportBounds","optional":true,"default":"false","description":"
if true, set the viewport bounds to the map size, this should be set to true especially if adding a level to the game worl...","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"TEippsD3UrGCqDPoDTil7","name":"constructor","brief":"","examples":[{"caption":"","code":"// create a new level object based on the TMX JSON object\nlet level = new me.TMXTileMap(levelId, me.loader.getTMX(levelId));\n// add the level to the game world container\nlevel.addTo(me.game.world, true);"}],"scope":"instance","type":"MethodDoc","params":[{"identifier":"levelId","optional":false,"description":"
name of TMX map
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"data","optional":false,"description":"TMX map in JSON format
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}}],"returns":[],"extends":[],"implements":[]},{"id":"PxniYULUdDid7Pnii7PfV","name":"destroy","brief":"destroy function, clean all allocated objects
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"TqpiDKcnPUrXd6I3jXFLv","name":"getBounds","brief":"","scope":"instance","type":"MethodDoc","description":"return the map bounding rect
","params":[],"returns":[{"dataType":{"tokens":[{"value":"Bounds","kind":"canonical"},{"value":"Bounds","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"uYovOkFm5wC8Hlkp2h_Jf","name":"getLayers","brief":"","scope":"instance","type":"MethodDoc","description":"return all the existing layers
","params":[],"returns":[{"description":"Array of Layers
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"TMXLayer","kind":"link"}],"template":"%1<%2>"}}],"extends":[],"implements":[]},{"id":"zWqfM9x1iVBUTP8a_56C_","name":"getObjects","brief":"","scope":"instance","type":"MethodDoc","description":"return an Array of instantiated objects, based on the map object definition
","params":[{"identifier":"flatten","optional":true,"default":"true","description":"if true, flatten all objects into the returned array.\nwhen false, a me.Container object will be created for e...","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[{"description":"
Array of Objects
","dataType":{"tokens":[{"value":"Array","kind":"canonical"},{"value":"Array","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1<%2>"}}],"extends":[],"implements":[]},{"id":"wzrTOLHri5S47hn4Xt0do","name":"getRenderer","brief":"","scope":"instance","type":"MethodDoc","description":"Return the map default renderer
","params":[],"returns":[{"description":"a TMX renderer
","dataType":{"tokens":[{"value":"TMXRenderer","kind":"canonical"},{"value":"TMXRenderer","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]}]},{"id":"G8NK7NVA8cRehT0GL1KuP","name":"TMXTileset","brief":"","type":"ClassDoc","description":"a TMX Tile Set Object
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"d4EGadMSKeDumdydy9jhK","name":"class","brief":"","scope":"instance","type":"PropertyDoc","description":"the tileset class
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"X5FGUcNGhaFg7SuOdnlRe","name":"isAnimated","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Tileset contains animated tiles
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"kIDqS269LrxpHHfN1RyZ7","name":"isCollection","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"true if the tileset is a "Collection of Image" Tileset
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"j8WxzO7UWwItqMeUwvSci","name":"_lastUpdate","brief":"","access":"private","defaultValue":"0","scope":"instance","type":"PropertyDoc","description":"Remember the last update timestamp to prevent too many animation updates
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"KllOOLCmt1gkkZ3vM_qfh","name":"animations","brief":"","access":"private","scope":"instance","type":"PropertyDoc","description":"Tileset animations
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"kBBt1RNCPm21p9zSLdYPi","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"tileset","optional":false,"description":"tileset data in JSON format ({@link http://docs.mapeditor.org/en/stable/reference/tmx-map-format/#tileset})
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}}],"returns":[],"extends":[],"implements":[]},{"id":"pUMm51vbtrBiWj7wOZ7wK","name":"contains","brief":"","scope":"instance","type":"MethodDoc","description":"return true if the gid belongs to the tileset
","params":[{"identifier":"gid","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]},{"id":"t0VL7hxncJ0wz7ctDVMU8","name":"getTileImage","brief":"","scope":"instance","type":"MethodDoc","description":"return the tile image from a "Collection of Image" tileset
","params":[{"identifier":"gid","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"corresponding image or undefined
","dataType":{"tokens":[{"value":"Image","kind":"canonical"},{"value":"Image","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"faW7ThQwcfhFKQmVaPisK","name":"getTileProperties","brief":"","scope":"instance","type":"MethodDoc","description":"return the properties of the specified tile
","params":[{"identifier":"tileId","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}}],"extends":[],"implements":[]},{"id":"QFfaTrqVZhgXd3BP-l99p","name":"getViewTileId","brief":"","scope":"instance","type":"MethodDoc","description":"Get the view (local) tile ID from a GID, with animations applied
","params":[{"identifier":"gid","optional":false,"description":"Global tile ID
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"View tile ID
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]}]},{"id":"_P7KNr9YTOZdSH4zVrjKe","name":"TMXTilesetGroup","brief":"","type":"ClassDoc","description":"an object containing all tileset
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"v5D7kgwR2B-NVEBTxgQNy","name":"add","brief":"","scope":"instance","type":"MethodDoc","description":"add a tileset to the tileset group
","params":[{"identifier":"tileset","optional":false,"dataType":{"tokens":[{"value":"TMXTileset","kind":"canonical"},{"value":"TMXTileset","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"fDxEZcr-oYh46wSjhk2JW","name":"getTilesetByGid","brief":"","scope":"instance","type":"MethodDoc","description":"return the tileset corresponding to the specified id
","params":[{"identifier":"gid","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"corresponding tileset
","dataType":{"tokens":[{"value":"TMXTileset","kind":"canonical"},{"value":"TMXTileset","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"P0gQeE9gobVJsAw4kz5sE","name":"getTilesetByIndex","brief":"","scope":"instance","type":"MethodDoc","description":"return the tileset at the specified index
","params":[{"identifier":"i","optional":false,"dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"corresponding tileset
","dataType":{"tokens":[{"value":"TMXTileset","kind":"canonical"},{"value":"TMXTileset","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]}]},{"id":"XvX9QYvj-pleVrlTiotrh","name":"Trigger","brief":"","type":"ClassDoc","description":"trigger an event when colliding with another object
","params":[],"returns":[],"extends":["Renderable"],"implements":[],"members":[{"id":"dvEMwYwo9Y77pW-xr9rYT","name":"alpha","brief":"","defaultValue":"1.0","scope":"instance","see":["Renderable#setOpacity","Renderable#getOpacity"],"type":"PropertyDoc","description":"Define the renderable opacity
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"rkeXdVC8MBRomG3H4Q5rr","name":"alwaysUpdate","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object will always update, even when outside of the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"H_cQYJGkYmecFxU9QF39i","name":"ancestor","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"a reference to the parent object that contains this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"FjzR7Gxi6WIwfk6FwGQuW","name":"anchorPoint","brief":"","defaultValue":"<0.5,0.5>","scope":"instance","type":"PropertyDoc","description":"The anchor point is used for attachment behavior, and/or when applying transformations.
When enabled, an object container will automatically apply\nany defined transformation before calling the child draw method...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"acAMmd8JnOAGXejT-K-le","name":"blendMode","brief":"","defaultValue":"\"normal\"","scope":"instance","see":["CanvasRenderer#setBlendMode","WebGLRenderer#setBlendMode"],"type":"PropertyDoc","description":"
the blend mode to be applied to this renderable (see renderer setBlendMode for available blend mode)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Zh5BUPrAXafNdKFnboq8Z","name":"body","brief":"","examples":[{"caption":"","code":" // define a new Player Class\n class PlayerEntity extends me.Sprite {\n // constructor\n constructor(x, y, settings) {\n // call the parent constructor\n super(x, y , settings);\n\n // define a basic walking animation\n this.addAnimation(\"walk\", [...]);\n // define a standing animation (using the first frame)\n this.addAnimation(\"stand\", [...]);\n // set the standing animation as default\n this.setCurrentAnimation(\"stand\");\n\n // add a physic body\n this.body = new me.Body(this);\n // add a default collision shape\n this.body.addShape(new me.Rect(0, 0, this.width, this.height));\n // configure max speed, friction, and initial force to be applied\n this.body.setMaxVelocity(3, 15);\n this.body.setFriction(0.4, 0);\n this.body.force.set(3, 0);\n this.isKinematic = false;\n\n // set the display to follow our position on both axis\n me.game.viewport.follow(this.pos, me.game.viewport.AXIS.BOTH);\n }\n\n ...\n\n }"}],"scope":"instance","type":"PropertyDoc","description":"the renderable physic body
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"tAlUErw1jXNFgfrDZ8njd","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"v1w5DaOV_e1Q7KaWiTWHZ","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"_7WpFVr72MM7IXlL4_nM3","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"TgSQfwa_oxMFCXU2Jmq9k","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"00-Q6AOAVb9NcbFzfkkhe","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"wxz4qtTop3XNvPDYC3gR0","name":"floating","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"If true, this renderable will be rendered using screen coordinates,\nas opposed to world coordinates. Use this, for example...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"sUzMl_CroY1Nwqo6Qa_Jw","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"
(G)ame (U)nique (Id)entifier"
height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"yiPbErst7I0vSGRQfS1Y5","name":"inViewport","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether the renderable object is visible and within the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"zbm9GmP2XRBm3lyNwZ2zI","name":"isDirty","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"when true the renderable will be redrawn during the next update cycle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"_YLfsUdiW1GKVTW4YWzkD","name":"isFlippedX","brief":"","access":"public","scope":"instance","see":["Renderable#flipX"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"MtK3upBPu9wQuVuiZaxih","name":"isFlippedY","brief":"","access":"public","scope":"instance","see":["Renderable#flipY"],"type":"PropertyDoc","description":"returns true if this renderable is flipped on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"q-zKNGLLJO4r9Qa41a7zv","name":"isFloating","brief":"","scope":"instance","see":["Renderable#floating"],"type":"PropertyDoc","description":"Whether the renderable object is floating (i.e. used screen coordinates), or contained in a floating parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"z1DvvSIRebXELInR3uUsy","name":"isKinematic","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"If true then physic collision and input events will not impact this renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Gq_-dtL-ymHk2R6T_FIuT","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Y2swF9mVtg3tqkDS30DO_","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"F2RylRWATeDTwtLS6ADR8","name":"mask","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"// apply a mask in the shape of a Star\nmyNPCSprite.mask = new me.Polygon(myNPCSprite.width / 2, 0, [\n // draw a star\n {x: 0, y: 0},\n {x: 14, y: 30},\n {x: 47, y: 35},\n {x: 23, y: 57},\n {x: 44, y: 90},\n {x: 0, y: 62},\n {x: -44, y: 90},\n {x: -23, y: 57},\n {x: -47, y: 35},\n {x: -14, y: 30}\n]);"}],"scope":"instance","type":"PropertyDoc","description":"A mask limits rendering elements to the shape and position of the given mask object.\nSo, if the renderable is larger than ...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"TkcWNE6qRmfT2yMPhGvGd","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"rFZ6Bvy1Zi1L0ZScOFOxQ","name":"onVisibilityChange","brief":"","defaultValue":"undefined","examples":[{"caption":"","code":"this.onVisibilityChange = function(inViewport) {\n if (inViewport === true) {\n console.log(\"object has entered the in a camera viewport!\");\n }\n};"}],"scope":"instance","type":"PropertyDoc","description":"an event handler that is called when the renderable leave or enter a camera viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"nI0eh_gySQCvuFwiSjbUQ","name":"parentApp","brief":"","scope":"instance","type":"PropertyDoc","description":"returns the parent application (or game) to which this renderable is attached to
","params":[],"returns":[{"description":"the parent application or undefined if not attached to any container/app
","dataType":{"tokens":[{"value":"Application","kind":"canonical"},{"value":"Application","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"0hBgIWEzAk5kn3jYqDY-E","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Dxu9ym9IY_5BVncOZG-dG","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"pXEQmMES_Qf_FFe9Z59ps","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"h-baJQM0pwJheFzhcZ4S6","name":"shader","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"(Experimental) an optional shader, to be used instead of the default built-in one, when drawing this renderable (WebGL onl...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"mq9JsoYnDPlIiFx7dhGL2","name":"tint","brief":"","defaultValue":"(255, 255, 255)","examples":[{"caption":"","code":"// add a red tint to this renderable\nthis.tint.setColor(255, 128, 128);\n// remove the tint\nthis.tint.setColor(255, 255, 255);"}],"scope":"instance","type":"PropertyDoc","description":"
define a tint for this renderable. a (255, 255, 255) r, g, b value will remove the tint effect.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"yu7KyABOhI3oQPWOSxLKs","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"hPqImXPaNfD6LUjpjMyxw","name":"type","brief":"","defaultValue":"\"Rectangle\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"0ZKtXqV5Y5PXgoH84Nc5F","name":"updateWhenPaused","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Whether to update this object when the game is paused.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Gv4YiPxjTXSA5PqnPtjev","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"JmjFFmvu2fVEJq9zNAbww","name":"angleTo","brief":"","scope":"instance","type":"MethodDoc","description":"return the angle to the specified target
","params":[{"identifier":"target","optional":false,"dataType":{"tokens":[{"value":"Renderable | Vector2d | Vector3d","kind":"canonical"},{"value":"Renderable","kind":"link"},{"value":"Vector2d","kind":"link"},{"value":"Vector3d","kind":"link"}],"template":"%1 | %2 | %3"}}],"returns":[{"description":"angle in radians
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"Z6odRmrg0m4h1MMOIdlq-","name":"centerOn","brief":"","scope":"instance","type":"MethodDoc","description":"center the rectangle position around the given coordinates
","params":[{"identifier":"x","optional":false,"description":"the x coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y coordinate around which to center this rectangle
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}}],"returns":[{"description":"this rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"YegQT8ZEVFZGRpeK9wW9o","name":"clone","brief":"","scope":"instance","type":"MethodDoc","description":"clone this rectangle
","params":[],"returns":[{"description":"new rectangle
","dataType":{"tokens":[{"value":"Rect","kind":"canonical"},{"value":"Rect","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"e22OStrfO8JnJ0kLql_rB","name":"constructor","brief":"","examples":[{"caption":"","code":"world.addChild(new me.Trigger(\n x, y, {\n shapes: [new me.Rect(0, 0, 100, 100)],\n \"duration\" : 250,\n \"color\" : \"#000\",\n \"to\" : \"mymap2\"\n }\n));"}],"scope":"instance","type":"MethodDoc","params":[{"identifier":"x","optional":false,"description":"the x coordinates of the trigger area
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"y","optional":false,"description":"the y coordinates of the trigger area
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings.width","optional":true,"description":"width of the trigger area
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings.height","optional":true,"description":"height of the trigger area
","dataType":{"tokens":[{"value":"number","kind":"canonical"},{"value":"number","kind":"canonical"}],"template":"%1"}},{"identifier":"settings.shapes","optional":true,"description":"collision shape(s) that will trigger the event
","dataType":{"tokens":[{"value":"Array | Array | Array | Array
Gamepad id string","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"mapping","description":"