","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":"tue3yldu2_pmNkPpkNEku","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":"G-dCT0MpjnO_grhzO9nTc","name":"file","brief":"","defaultValue":"undefined","readonly":true,"scope":"static","type":"NSDoc","description":"a collection of file utility functions
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"lwFCWADj4DP_hxPcIHu6D","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":"wU_pBT1nnRS1ZjcThCyOr","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":"qJwmOiiSm_hqCfFOsSIYD","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":"5eszMABzYobyVqIp7Hllt","name":"function","brief":"","scope":"static","type":"NSDoc","description":"a collection of utility functions
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"K_jBa9h1MbTNN4oX8lCYE","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":"0cDG2c9df2a8MTJoGQfuI","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":"WEuf1hqBx3pB7uztI6F7-","name":"string","brief":"","scope":"static","type":"NSDoc","description":"a collection of string utility functions
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"xMaaSgcvN1lOfPtNwskyW","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":"GROgyxv1NpUT0r1Kslcmz","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":"3Z106Ud3lthLR2nW156O0","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":"-uWwNoJcs84J1RboYT6eu","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":"-T7shuWkPvpqi1lROSb1I","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":"Zl6mEJ1HUMROgou_d7G6v","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":"L1nfxsC6Axpc32U7PBul-","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":"Ra5GpA7ty_txJhPpZcEM0","name":"debug","brief":"","access":"public","defaultValue":"false","scope":"static","type":"PropertyDoc","description":"display the debug panel (if preloaded)
"},{"id":"FGKAi8F-IzTvV32RjaRXP","name":"debugToggleKey","brief":"","access":"public","defaultValue":"\"s\"","scope":"static","type":"PropertyDoc","description":"show/hide the debug panel (if preloaded)
"},{"id":"k5nEmmnPy4hUJvAoC_gs-","name":"hitbox","brief":"","access":"public","defaultValue":"false","scope":"static","type":"PropertyDoc","description":"draw the hitbox in the debug panel (if enabled)
"},{"id":"hqIsFui6bJaACkRDN9WU7","name":"quadtree","brief":"","access":"public","defaultValue":"false","scope":"static","type":"PropertyDoc","description":"draw the quadtree in the debug panel (if enabled)
"},{"id":"GYNufHp1uQT6iDiEVJ4h5","name":"velocity","brief":"","access":"public","defaultValue":"false","scope":"static","type":"PropertyDoc","description":"draw the entities velocity in the debug panel (if enabled)
"},{"id":"DiWkkx8WLK_IfMqqVBN2P","name":"webgl","brief":"","access":"public","defaultValue":"false","scope":"static","type":"PropertyDoc","description":"force the renderer to WebGL
"}]}]},{"id":"hPIySWfWrkeMQ0Sblka0Z","name":"video","brief":"","type":"NSDoc","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"FV2zdXZFHLbnfOiN_Fj86","name":"renderer","brief":"","defaultValue":"undefined","type":"PropertyDoc","description":"A reference to the active Canvas or WebGL active renderer renderer
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ClEdkYgbOD1y73AoqG5I2","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":"039LJS3eBvmgB5kQ8JkC4","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":"MKsYKtjXrtL8C6u6STJID","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":"ApplicationSettings","kind":"canonical"},{"value":"ApplicationSettings","kind":"link"}],"template":"%1"}}],"returns":[{"description":"false if initialization failed (canvas not supported)
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"extends":[],"implements":[]}]},{"id":"PUf1mLE96ZDOeULopbMQL","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":"anKhm7iNzo7aa1MKNegGw","name":"isInitialized","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"
true when this app instance has been initialized
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"HSWuKzUVtv-xquV898_0R","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":"zwmWNscbZDjgtvaaugWr1","name":"parentElement","brief":"","scope":"instance","type":"PropertyDoc","description":"
the parent HTML element holding the main canvas of this application
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"iAj6mK4mDQEGp_e_cnWfs","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":"jovJoAnyVn8Tqt8wnerFI","name":"renderer","brief":"","scope":"instance","type":"PropertyDoc","description":"a reference to the active Canvas or WebGL active renderer renderer
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"yDj2KpQppJqv2N99Oh54C","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":"FJGUnlo0OymcqbG9rdTSV","name":"settings","brief":"","scope":"instance","type":"PropertyDoc","description":"the given settings used when creating this application
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"hEjIImVMnF4NRa-Dfk-lE","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":"BBfZLEwzbiyp7F5EIseHO","name":"stopOnBlur","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"
Specify whether to stop this app when losing focus
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"dn17VQpO3KqoiERQHQHHe","name":"viewport","brief":"","scope":"instance","type":"PropertyDoc","description":"the active stage "default" camera
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"NFczq2pRFfzmEhMxal5ik","name":"world","brief":"","scope":"instance","type":"PropertyDoc","description":"a reference to the game world,
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"udEmJeJZN8dMSIag4TqKs","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":"ApplicationSettings","kind":"canonical"},{"value":"ApplicationSettings","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"tHkJXHUFtqBDUGm8PFBhZ","name":"draw","brief":"draw the active scene/stage associated to this game
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"2oTLxSoiIR3ck8o-ZFvwr","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":"qLFfr9Wlv-P2T0FS_QhnF","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":"ApplicationSettings","kind":"canonical"},{"value":"ApplicationSettings","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"siJaBGG8xL3Lo4ojyl-qB","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":"wTO_2_l8Boi97gyXiZ8VR","name":"reset","brief":"","scope":"instance","type":"MethodDoc","description":"reset the game Object manager\ndestroy all current objects
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"sKIs0NFYoVWcZvWc8_WbB","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":"ubHuZmqmuUd1q34-bm0Fh","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":"-2FNlv3UvtPpJofn5CEnU","name":"BitmapText","brief":"","type":"ClassDoc","description":"a bitmap font object
","params":[],"returns":[],"extends":["Renderable"],"implements":[],"members":[{"id":"OIh2Odu2_BnlcMurB6DtU","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":"UZCpnS3MaSR2ro-r_V0eO","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":"ytotPaVa-StAowEBDwE-a","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":"MjGDHPNLrpzHe5vlrPPr4","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":"1A5_ieIJu2qPRZfpJgOFq","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":"A_txxJGhQ9U6zjqR-Leie","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":"qtWEtlsSPRObXKL6qncTk","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"98iJ-8QL49XP5PANlFz3e","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"sdemjf_P5UGjjpx5Xxi4F","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"7TEh2KvaOUGXRetg2HnGt","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"0__DSXYGZIc8-sqYLrDQt","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"EvXNZ0T2cAfgpvYd6JkjY","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":"8tx9fQnLb0Rw30OzCQFEp","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":"sZzp7X2uBAur029NvUCt-","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"
(G)ame (U)nique (Id)entifier"
height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"WUUF2Yf91epvpHjxlMlS9","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":"kX3QkKc16vEbsmAto24tS","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":"O5SDE2GL0GveAkW0HqVNn","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":"0qiLEUCQctJxyFn1bma-l","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":"i8ZJdfW8dRC3J6T3cF1xs","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":"3s__g2cnUjuWUykh1Y5vX","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":"Ilo189QUT3CFdjFkX-poB","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"4-IP8tZ-XZe2vxJvlBg8d","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"wkk3ESXt5N9teDYscaEd5","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":"WmFh41OXzISj7wenYchi3","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"xzD1d9f-Rbz5wVTm2eqjy","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":"Hrd7inV86H42OnwSy-Oqx","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":"JLKsMNDfbwJxXksLTmtkb","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"wQ-67OVuy9oqvyK71R4pX","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"W9NByq1RS2n_lycibgeEU","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"np8l8emOFu04sXbnJssJs","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":"8VtYAKYkSGgTneUFPAPED","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":"pC_8e9wBxBMzmEVa0GBD2","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"MPYlmQ6RD44S4eoOlmbsZ","name":"type","brief":"","defaultValue":"\"Rectangle\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"_OjdmWjdQj-3mBCceVrZW","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":"s2j20PSaqk1x8s-KU2sNd","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"v2KrpLPIjdd2kBd4m3Gxe","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":"1GeiSmq1AWvZ5Oi2xKSIF","name":"_text","brief":"","access":"private","scope":"instance","type":"PropertyDoc","description":"the text to be displayed
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"NZ223q1YOIV3Wtu_199G3","name":"fontData","brief":"","access":"private","scope":"instance","type":"PropertyDoc","description":"font data
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"8d0lfW_9AsQSct4dJYQOW","name":"fontImage","brief":"","access":"private","scope":"instance","type":"PropertyDoc","description":"font image
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"1H6fKoGu6Hasfj8ItZwhi","name":"fontScale","brief":"","access":"private","scope":"instance","type":"PropertyDoc","description":"scaled font size
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Nbdy8XIRHQ4ZSqDPsKlVU","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":"eHyOkep2xfKjh6P_yJh2o","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":"kBMviiSKuLsrTqMFsXntT","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":"iJciUoUh_CKlN3Uum23Xb","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":"0RUSgomcxeyAHAGbGziVQ","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":"w_o4QZVQT8Qfk2wrQgE19","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":"LVLuepRDBKEx8ow_cbtVS","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":"TO3pTXx69Y8dOxPl_eMk3","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":"LoLR3RqD9B-Pr-I359w8n","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":"rnMWrzZLewgC-Nbp9rGPU","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":"rzv6EToUYZrK-J9M3n-K_","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":"luhLfaeaT3s0XZ3D_VTJO","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":"qwfiDIgRUrFJl4PuIpFdd","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":"dlqTZlk8ooaQIKt6-K7yf","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":"fSsZ9eBTMEg_A5pSIy4J_","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":"K7TYRmF27aW17Wu_Avj-s","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":"84TvApdKUGJDuBMMjJhpQ","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":"bFC0Lyk5rwHWzr3UDMwfd","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":"Qa0_4jxcnNNzb7b4hAUMA","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":"JVzW3LTgMKfgCtG-umK_K","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","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"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":"F8W4RJNIXEG13PRRn5c6L","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"OnDestroy Notification function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Si7BP9Ur1H2vJBU-eqWzL","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":"ACbS-pxp_GKzbu_jng07W","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":"0ObpdU9W_KCpPBPtDHQii","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":"GSwtapHvl32NDd1sR6Ghk","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":"UuCcuxav0j_f8UN5fCw46","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":"xX7XPJXUIW7-LM95G48xR","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":"OMa841w74cE939eUzDK2-","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":"PFJtJAEEyZBAOIa5PIDx6","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":"6t8IE48TpMhI3yqOQHNCT","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":"1EUMEZiHbruZ2ZXeiUTAq","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":"2HFAXEnRuAVuItozr80T8","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":"_-yeIu4DFdCinDtRyc6gl","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":"bHaOiZEUx07jJ3jru9him","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":"3O4FT4IgTITr91_czfCCo","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":"1vlYkJJol1PYXtKVYf_u1","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":"lMI5YSzwFjkAs0EB9b2E6","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":"5OZzrv7GI4inykKqWpVuq","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":"0AWeTuAzM8JYxhXBCE3WP","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":"0hy8Yvn2_LaQpk6sd4NsJ","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":"Z1rGGpadxjulZwG_Bx9j0","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":"N-HU61cgXLVfj4N9xZYcL","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":"lK1_a7zcFcunGAKbdsyTi","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":"SksqJ_WdXT9kkBmrxnIYV","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":"iWqLW27iZd5pzBZ5chlo2","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":"B7G_I1wxMiXGEyi32_HVm","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":"TszmWjTuHftNY5cwYxOAi","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":"C_TDCE1WVPAzfbH3uguK7","name":"bounds","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
The AABB bounds box reprensenting this body
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"BrVpsvyfrETg5w38jxHxj","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":"eOB_etSud4xmopcJemHBV","name":"falling","brief":"","access":"public","defaultValue":"false","readonly":true,"scope":"instance","type":"PropertyDoc","description":"falling state of the body
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"tIgYf-E5LZKNRsR5n-yGY","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":"FlYDMoocDWQ3CMTajNsbk","name":"friction","brief":"","access":"public","defaultValue":"<0,0>","scope":"instance","type":"PropertyDoc","description":"
body friction
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"a5cacNsEAGN3ff1qVRVL5","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":"ORtAMI69aYdMSA898BrqN","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":"uyBQD0iHnoMakpgzfbjbY","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":"K38wocpdQ9M2ULViGdzzj","name":"jumping","brief":"","access":"public","defaultValue":"false","readonly":true,"scope":"instance","type":"PropertyDoc","description":"jumping state of the body
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Dyi9Ht2yopSMYtbmkioY6","name":"mass","brief":"","access":"public","defaultValue":"1","scope":"instance","type":"PropertyDoc","description":"the body mass
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"qIOcvXOIyWQPrSybUAUnj","name":"maxVel","brief":"","access":"public","defaultValue":"<490,490>","scope":"instance","type":"PropertyDoc","description":"max velocity (to limit body velocity)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"0t_kBQkDOUIixlf2YYd3p","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":"GZ_wSCtnwJiXpI6qTpIZe","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":"z1b2WJ0qxGz4OlsmrLbXi","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":"S9xoQVbnlAM_xh4fF2_O5","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":"JeJ0lK7HLt5aeyiJ0_uy1","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":"h-6Vw5guutHtbK8v8XJYL","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":"hTXLHgzyWPqhGKkn8Nlof","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":"zLgNQbJRzboRFJ8giInw_","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":"5B_HpPPwyGwukDLOq__so","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":"uC7HE65Sqxjnc0X5kLwvy","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":"HF9g_wqoErT2ajk7y_LUY","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":"8eU3LKXQDuJJ4N49JV0FU","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":"woQWEwS3-PPLZ4ASoLLQv","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":"XnQoXAmwFN2c8lciv_z_0","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":"sLDhTLI4LFK547nDgn4Mw","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":"egkTJgN2CVhNZ1hPHJtFc","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":"D68teQhAwNxBdRHLVlGJI","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":"b4CWug18NqDT3UrSq3XAL","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":"L90-ANHVmDa3l0Hot-91O","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":"2g8cmKQaQqVj7r8b5HyQ0","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":"iUgvRCCjZkt_1W5CBoJnF","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":"LjIlV2OAFjVsqtbeWqySM","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"XIj0zVrPmYelPd4eT6_k1","name":"center","brief":"","scope":"instance","type":"PropertyDoc","description":"return the center position of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"vdHZwuTxRDc768fre4wu4","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"center position of the bound on the x axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"h1IdwnA58UDVym81jhJFN","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"center position of the bound on the y axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Gw4fl0OXVMJIUECS-eVN1","name":"height","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the bounds
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"JK2gRubMHhEg39OHomftm","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"v8dwQ6Feveu1OmlO9bjVl","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"YTL6xlgNhyBKFsSvaHwgM","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"GIEnUfzZkLdWD8ZKq5tpR","name":"type","brief":"","defaultValue":"\"Bounds\"","scope":"instance","type":"PropertyDoc","description":"the object type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ukTlzL-VL9iMcKMHskSa_","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the bounds
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Jcs129o85ROzl-78RmYzV","name":"x","brief":"","scope":"instance","type":"PropertyDoc","description":"x position of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"XJu9Au8V1P-DN5bC8uhyo","name":"y","brief":"","scope":"instance","type":"PropertyDoc","description":"y position of the bounds
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"t4B0K1xM17livbRGnGxpX","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":"8Gdw68TErl04-Aw_B39dG","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":"EoZAitkpA5KQrCZC13uUf","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":"qdjzh6YdKjsWUYqswA-Ab","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":"QDVguSSU1IKDbJ9y_iuJ1","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":"gkSMjWKPzDN7sRvAvo4UD","name":"clear","brief":"reset the bound
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"W4toSjudRoTP9L8Ol2nyF","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":"V1jfYA8Vh0vuQ87HdcoYT","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":"c5VMfeuL5A11Yelp2SXVa","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":"REwWYLuX4whVvFxG6q3JL","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":"hjIlJ8X7ntGfvc-A8MZJs","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":"YJMb6BaPzQwFsbEWWfYRi","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":"NoGRMcARV1HoYYRiXkNkZ","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":"slBjcW5D196y7Omp4RXto","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":"GusWTvsslNcGPzubpv-rC","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":"O2_Ce_ExenI-_uuLzgxIX","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":"Z1IOPcHH1s3DvTtyrE6Zr","name":"Camera2d","brief":"","type":"ClassDoc","description":"a 2D orthographic camera
","params":[],"returns":[],"extends":["Renderable"],"implements":[],"members":[{"id":"B-pnDPkqhDjsXnoLZE9Oo","name":"AXIS","brief":"","readonly":true,"type":"EnumDoc","description":"Axis definition
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"NpVXR5SOQp8k0HMUAbke1","name":"BOTH","brief":"","access":"public","scope":"static","type":"PropertyDoc","description":"both axis
"},{"id":"wDFVVXH4K2n_6raIFO3Gs","name":"HORIZONTAL","brief":"","access":"public","scope":"static","type":"PropertyDoc","description":"horizontal axis only
"},{"id":"Um9sZKKR6f3W_joX0kB3z","name":"NONE","brief":"","access":"public","scope":"static","type":"PropertyDoc","description":"no axis
"},{"id":"sXRG5E-x-P_Z1F2AF_oR8","name":"VERTICAL","brief":"","access":"public","scope":"static","type":"PropertyDoc","description":"vertical axis only
"}]},{"id":"Yyys0Rz7iNMh5O51bn2yj","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":"PftGJxZfUaAs5CNfC0ttM","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":"ildiR1UczaIiUr9n-7NCT","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":"nFSpGixU6vk2dhNJSEABA","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":"FgMkaoLt_zfheNoWsWvSs","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":"d3rme2fqP8E1PPUy_-qH5","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":"Ikw0_iNvjSpRYj2GeNLbe","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"A2GUH4QmUwj92aZLMKkE9","name":"bounds","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"Camera bounds
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"RYnzJsuqM4K5-y-EPNLyB","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ucxflpJXmkd5jcNjB7cIG","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"STHoflZYuyqi0aJeM1Ur9","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"vp9pTzmV5EgtmjqJV_fwY","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":"IMRCBRlL5S-rU9B3QFQpG","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"3pE5-wIwnZ_9ppvo-A_Zl","name":"far","brief":"","access":"public","defaultValue":"1000","scope":"instance","type":"PropertyDoc","description":"the furthest point relative to the camera.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"jvn9SLZODzSlE_T2N0H_6","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":"9N1F9Wf1xvrVrePe5Vu_N","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"
(G)ame (U)nique (Id)entifier"
height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"hl6fwLNtquKbRIencK2Bz","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":"1mWBXzBF7cOOxfOnkHjk0","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":"QjmxaiJMZjzCG2EJ6olJJ","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":"uAQf3bTZo9NB3yk4AY2Pc","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":"gN4sbkvGW69J5PICehIWF","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":"Nrlp1AXWpvqUtD5G6SK0J","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":"QH9zcxAI8Fkfndv1hX5Uw","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"dFlbV8qWw43ggqzMbWtMC","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"T3VrjRAyZ3Qbv6sfh3G9E","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":"x99Dwt8-H3qet3mNuhTH1","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"gP6qnUhnfJBImQPhfoUkc","name":"near","brief":"","access":"public","defaultValue":"-1000","scope":"instance","type":"PropertyDoc","description":"the closest point relative to the camera
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"TP_L4dnZXv91HDQ5_gTl9","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":"TCtv0O-kRF-GmdSiEsTFF","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":"vVw6mKSJvHVvLchSLkBS_","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"7T76NGtUghJQnGZeS8d6H","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"pp78-wFULMrkKlzuZAaPO","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":"so6916oOeyh8jbHuoh_tM","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"FJfWvVZXOwFqh4K3NAAlJ","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":"wc4cYEY4BFdFvskyvRoNi","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":"lePdCUVAj9K04awh0ZQm5","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"PaN3hxXOmhaocGb7-8sjd","name":"type","brief":"","defaultValue":"\"Rectangle\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"EzYL1QgRT7zaojl24J2hz","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":"3CFNZy7Ly7quVWTBBiReT","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"9YpnUy3_7UaRVIo9FX_fx","name":"smoothFollow","brief":"","access":"private","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"enable or disable damping
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Hgp44KZwfNgIgOgV6y79P","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":"bYXVRfi-UFy1_hri_xRiI","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":"ds8mYCbpQO8GUd4_cPQtu","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":"BistiMTCROWcpB6kYwa_9","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":"WxFymerkW_U92CKfIswm_","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":"CLsys-TQOgRBI5_rCvoPp","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":"axBDrQ5AI6As8V-vtAcv5","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":"6mkXLBq3Y3wqXSgFLs2Td","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":"AM5lBbm2YarrzVi-yXBG5","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":"WLCSj59YiLdfL3haUQdJP","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":"xXljOCYXRkGuOvftDVNer","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":"-L9haFCS_rANycY2-TvdB","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":"J1qQKIMhJK7Hjwh37MmVA","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":"GqDzRNaenecGZGgigWmg2","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":"HMRx86U1kYREHsd4YEu7b","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":"OL5DAVtRxhF9IqDAkwEfS","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":"EfDKtQUzhGh6gcBfAv7Ic","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":"sZFmu4X1H_7SketYqfXIs","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":"4Gv1GmTyjh86B9H-c6pyg","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":"HmvqltBFW0H-pyqAPpEm0","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":"QwhmjlRAKokfJVoIb29Us","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":"kcHriB1_73apJh1G0swcG","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":"vU10o4eAXnxL8VInyAq_y","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":"UjToFc-3-uakTxMnZU52H","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":"aRiTyEKcUhEiIUTV8Hzot","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":"hdRCUmAEA_uajdCzCnHi5","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":"EORw3HokgzsqLCOwHU33L","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","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"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":"NVOOUCtjRPDaoyHSb2eD7","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"OnDestroy Notification function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"24tva9Z8mK2qtTRA80B3j","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":"WXlgqADY4IzF1LcPQjStz","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":"AzWTRavRQmj1LW7B416ZX","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":"7AD5SsNcESmqWac9glQbw","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":"h71uo9_x375FtOYMkF7kf","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":"2ZTNGJLfW26D1TOH6XaYg","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":"fPdTBG1E3LC4bW5IFkmpv","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":"9kA10-waLhgSH4IpF821n","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":"QdWQsK0qzCnpx0KXf-WJ7","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":"sz7B2qQroVVr10NpabbbG","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":"JxRCxk_hfqlE2JnTQtdzq","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":"9KpH5Asg-MqrE0px9H1HZ","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":"rktunv3IPSnXegvJ-EqBw","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":"MpU4DpudPWynRbODJv79b","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":"vzCoBGj6p39TUW4-sNRn5","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":"kv25N6PnLI-MHbY1EsGNu","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":"Ofy_dIDKsuPqerheZJCyK","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":"l8zIbX_TUtoVSq0tDlzMP","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":"P_94GrQiNKGlb9cIu4jGk","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":"439NfUh2-kDIGdwqgeiLk","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":"WOkLRxBPK4WO44kg40VrM","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":"9I78-XDchLk3ppyhgNxAS","name":"unfollow","brief":"","scope":"instance","type":"MethodDoc","description":"unfollow the current target
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ug2AeIiguPFN-cGWVz2Wu","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":"KFSljmDsh5NiRYP7oncDr","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":"dhsyibZ0eGcWofGatYFeo","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":"2IMgwHke3CrtwJSC-iRF6","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":"IXTuW7FF63BOR_CDlDP1j","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":"0J2P-vYlEJOFhXCrcRdIo","name":"CanvasRenderer","brief":"","type":"ClassDoc","description":"a canvas renderer object
","params":[],"returns":[],"extends":["Renderer"],"implements":[],"members":[{"id":"3lCWq0poklrKWpIw0waVE","name":"depthTest","brief":"","defaultValue":"\"sorting\"","scope":"instance","type":"PropertyDoc","description":"the default method to sort object ("sorting", "z-buffer")
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"aSMdzToYpqfKxSI1-BFME","name":"designRatio","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"the requested video size ratio
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Jiocc8JBS5-zJo0tEw_fX","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":"KEq1PmVRqZicU6utZV41L","name":"isContextValid","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"true if the current rendering context is valid
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"aQdvACU0s8ihLLh3BZ_ti","name":"lineJoin","brief":"","defaultValue":"\"miter\"","scope":"instance","type":"PropertyDoc","description":"sets or returns the shape used to join two line segments where they meet.\nThere are three possible values for this propert...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"HKhBGi7OBr00sKYCO9x2n","name":"lineWidth","brief":"","defaultValue":"1","scope":"instance","type":"PropertyDoc","description":"
sets or returns the thickness of lines for shape drawing
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"j03kSsbYfOxpEbyydatPv","name":"path2D","brief":"","scope":"instance","type":"PropertyDoc","description":"The Path2D instance used by the renderer to draw primitives
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"puQyifsckCebCsR8Rbn3f","name":"renderTarget","brief":"","scope":"instance","type":"PropertyDoc","description":"The renderer renderTarget
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"4A18_PgiOu0WvowY0EtLK","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":"WIPmC61KvX5OCwxplsxrV","name":"settings","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"The given constructor options
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"jIFarfkPidK2nd5S-i6o2","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":"XhztWZRg8qVAB5AmPJMxo","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":"UrYLZ2bWY_3jVNw8GMVzZ","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":"HLGJZNRTyXZIbBohrgeOq","name":"clear","brief":"prepare the framebuffer for drawing a new frame
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ONTP2ktjQfJ5qcW-2KqHQ","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":"UhFdXCzZ02CMlSmPeXPNb","name":"clearMask","brief":"","scope":"instance","see":["CanvasRenderer#setMask"],"type":"MethodDoc","description":"disable (remove) the rendering mask set through setMask.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"LEDJoeia2ZsS4_zy6fIW8","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":"VtLizEgiyqmIRSvNFxv73","name":"clearTint","brief":"","scope":"instance","see":["Renderer#setTint"],"type":"MethodDoc","description":"clear the rendering tint set through setTint.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"E_eJiTaQg7QvSFvnUsd_Z","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":"eUOCLSpEZLrezzcBYUlX_","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":"3hlFRS669eV6qkkV0bbCh","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"options","optional":true,"description":"optional parameters for the renderer
","dataType":{"tokens":[{"value":"ApplicationSettings","kind":"canonical"},{"value":"ApplicationSettings","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"pXGWJd8mPFfjviWBhGxm1","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":"Xw5BOxTk6pR2KjPnlTsa7","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":"44ym547ZN0bp23IpdPoPz","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":"fpwR3sWkPX3CXGChTXEus","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":"HFz0RwI9Tzu-9pcxLaDEb","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":"zd-cafKjskVRPY6WJcw84","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":"ExHoDr_t8DkzwPkAi3pYf","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":"cag6PebtRum3oqIluRDzE","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":"Kx68g93peIGBqN3s00nqU","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":"y6MS_LS5PKqdyyGWg1_Zh","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":"flje6X5vYLsrQwCdPOaiV","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":"iQAGxc-KP3q9MENN53Qfu","name":"flush","brief":"render the main framebuffer on screen
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"rypwpZ-Qozl3MjZOqTeJg","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":"G4MdsuE560CZ3qPMBzRBb","name":"getCanvas","brief":"","scope":"instance","type":"MethodDoc","description":"return a reference to the current render target corresponding canvas which this renderer draws to
","params":[],"returns":[{"dataType":{"tokens":[{"value":"HTMLCanvasElement","kind":"canonical"},{"value":"HTMLCanvasElement","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"eQkinoZ9WbXtflHokAQ8-","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":"q8te1xJl24lmKtNQPpZin","name":"getContext","brief":"","scope":"instance","type":"MethodDoc","description":"return a reference to the current render target 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":"sbmm28IgfnPB_LeCZ3Cxw","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":"easMJHvLZnZg2h1vMqwFx","name":"getHeight","brief":"","access":"public","deprecated":"since 15.12.0","scope":"instance","see":["height"],"type":"MethodDoc","description":"return the height of the system Canvas
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ThV8BHuAJHjRuOs60OUju","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":"T8TGn-2jT-jXWioBAqOCA","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":"plU5cS7an4WQp7PC-gIYu","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":"u9OAiXFLKkQBsdw2INlYX","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":"liOi57NZle3Y7MpxaTUF7","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":"cfT6lWpCe3NrpEb3DFxML","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":"TGZ-VpEfhzz_JMOwuho3s","name":"reset","brief":"Reset context state
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"F_HEDzBcEa19LrgMz0_3_","name":"resetTransform","brief":"Reset the canvas transform to identity
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"tT9BBgN0LXabENjSllnpF","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":"JArtkUOPnOQPO2sCnIVEG","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":"Hs3A3gOCsFHi8zKYWZsC6","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":"mBQ9GHiwobbqphcO6JKxD","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":"6SIRw013RRK26z1Cj1Db5","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":"anZUj6p7bOK7zRd7Ce3FV","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":"K1WS-UV1BU6i-CKkJ-0zQ","name":"setAntiAlias","brief":"","scope":"instance","type":"MethodDoc","description":"
enable/disable image smoothing (scaling interpolation) for the current render target
","params":[{"identifier":"enable","optional":true,"default":"false","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"MEJlWlzfvzyhMXiJ1k6yk","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":"MY3h_6Cerv6FhFRvBEiy7","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":"Dy1LvMgfghwXVX1MGuEpA","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":"iWV4QeH2eDTg5SOyx9nU3","name":"setLineWidth","brief":"","access":"public","deprecated":"since 17.3.0","scope":"instance","see":["lineWidth"],"type":"MethodDoc","description":"return the height of the system Canvas
","params":[{"identifier":"width","optional":false}],"returns":[],"extends":[],"implements":[]},{"id":"Vt99nnojT5dCXibgieIxf","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":"vmYZozh5fz2XIgT8x42fX","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":"A9F5nIUoWAwxUzj4YwdLu","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":"jtE9LhotA0sTl96IGpMvT","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":"hAnhZMp2DFotx3-TNy6zw","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":"3WcFfa69cPXCbAOxVKlwI","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":"AezH7GFIxAYXGgZ1hoI5-","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":"_HJhXZUzUQOYPYzHYGfL1","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":"zU-b05lFv42Fhzo9mExnY","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":"_STV8U5C6-UhxaivAP7Pz","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":"Ilrk8XSXFxe4P_K999Ytv","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":"172737nBuaO1JqySBLhKj","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":"bVYiTZWwKlkuv_43_ayM5","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 or offscreencanvas (if supported) 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":"QWHuonnom4kWSziZ2_xFx","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":"qITCZtLXkGX7Qy855ggT1","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":"NuuFh4pZtN79AJxKTdb4W","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":"sYaxJA7fyYNUCgXEJytZ0","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":"r0yeS_CJAgp-WVSKlxjl2","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":"exz3PpfmUuduKz-kZgMau","name":"CanvasRenderTarget","brief":"CanvasRenderTarget is 2D render target which exposes a Canvas interface.
","type":"ClassDoc","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"O8haNNlcSk6TXdDkrnIpP","name":"height","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"The height of this canvas texture in pixels
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"_voyOldGTzXUjkXH22xL_","name":"width","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"The width of this canvas texture in pixels
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"iWplcDJy4N2YFci2rRCz7","name":"clear","brief":"Clears the content of the canvas texture
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"8rJ4HK8RNzpx5PoCBe_GN","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")
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"attributes.preferWebGL1","optional":true,"default":"false","description":"set to true for force using WebGL1 instead of WebGL2 (if supported)
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}},{"identifier":"attributes.transparent","optional":true,"default":"false","description":"specify if the canvas contains an alpha channel
","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":"s8wxzdvJq5O28m4tbcQ3Y","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 CanvasRenderTarget.
","dataType":{"tokens":[{"value":"ImageData","kind":"canonical"},{"value":"ImageData","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"18T_x85NKT-0w0A1kYido","name":"invalidate","brief":"","scope":"instance","type":"MethodDoc","description":"invalidate the current CanvasRenderTarget, and force a reupload of the corresponding texture\n(call this if you modify the ...","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":"Y-gbdN2pS5ZmDHYTFu8mG","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":"ArjjWN1AGTBuyvzkk_ia_","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":"ceafjdT9ld5N33A6O-6XY","name":"toBlob","brief":"","examples":[{"caption":"","code":"renderTarget.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":"v2nODmqGa274ja7HSHhEU","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":"YtjTgUHy-Gqt0Ip0JikSG","name":"toImageBitmap","brief":"","examples":[{"caption":"","code":"renderTarget.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":"TuKV18b-hR2tS0zTezTlV","name":"CanvasTexture","brief":"","deprecated":"since 17.1.0","see":["CanvasRenderTarget"],"type":"ClassDoc","params":[],"returns":[],"extends":["CanvasRenderTarget"],"implements":[],"members":[{"id":"HOPIG7xHyk9AlBLK283Fl","name":"height","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"The height of this canvas texture in pixels
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"t-BJU2g54Q1AZbJ0sHCMx","name":"width","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"The width of this canvas texture in pixels
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"iGB1yLMO12HfDesAr7rqL","name":"clear","brief":"Clears the content of the canvas texture
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"b5lmAt7bIY2rY0tgRW22r","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":"AxukKN6-VanyUj1Y2f590","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 CanvasRenderTarget.
","dataType":{"tokens":[{"value":"ImageData","kind":"canonical"},{"value":"ImageData","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"XlC9BPhDb2KsK1iqup3lo","name":"invalidate","brief":"","scope":"instance","type":"MethodDoc","description":"invalidate the current CanvasRenderTarget, and force a reupload of the corresponding texture\n(call this if you modify the ...","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":"hEBg-2nAYYzn22oBngHoo","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":"bOYQf1_jB_vNqcmAv5ald","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":"ZjloWWAIO_SNV6NWqdVP1","name":"toBlob","brief":"","examples":[{"caption":"","code":"renderTarget.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":"9LtcGkVcCAc1qP-rFOAYT","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":"Bh9P6lSfIH1P9kqwmwwLc","name":"toImageBitmap","brief":"","examples":[{"caption":"","code":"renderTarget.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":"AaSHA5EqYCURu0EjXHGLT","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":"hgvmHwe4T5xDLeVX7haZP","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":"ejDrRcFo213flF0wiMC8R","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":"l_oe-xakxc8PeYxWbJAl_","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":"e0Ow_rf4cSCgj2X0fVZ3I","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":"S6HClXRLVkiNThXbw56_9","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":"rfl6t9BPTH3m1dEBh4ebQ","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":"EqtS6Akolx9DsyeGCJ8-b","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":"94HEJ8VPEMiUOa8mN8I7M","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"u5l12y-eIY5X8KiKXX-_U","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"C9Pw6eCP1B4xAMS1h_Hny","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"bAFL8kdj9AwsOTPFoVNod","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"kuXKYToyeMgcF9befTD-l","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"wl2xCA7qzpCGThCWQjeq4","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":"LirjqmaixCaNVU9ODd-lS","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"
(G)ame (U)nique (Id)entifier"
height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Zej2tHP7fI9gPEhK_YPlL","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":"Sk29Xnc8Y2DFAIOJA31LH","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":"zTQmPa-gi6F3RyTMx69_y","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":"KnxuHNtHGL3Ys512xpEVH","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":"8HS9psb3mwFFxtlTfGtKH","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":"lvBnm2y7bt0NiFKRJ5CJA","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":"pnb_FDS7jLt0jOrN91jk1","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"rAZX0g3cA4kyAMyXW_IjH","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":"iOjT-ynD9MYDWol4YFcKT","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"hxcZ8Lq6AwgZN0QHDAxI1","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":"LNXr9YgZUnuMCtbsHAT8T","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"otOI6JHj0asZe8W3YsY7n","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":"Hp0LukBJyWbxfyEWv4NTC","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":"t5e4uCR2oj0m5Yb7MU8TM","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":"DvuYVt8Ji7cmUy4xGD5N9","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"silgE-h3mXzTyG2YfJ2WF","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Y7LNbfCtdCswJ4Tu1ZViE","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"4RZyLuHhjrPYCAHywa56O","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":"FKrzjQvtY6zPhHVpmlrrW","name":"source","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"
The source texture object this sprite object is using
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"o2rb8976kCPjd0C_8UHXY","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":"8PPU8FVW5_64Lqc9h0A2f","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"NJzXp6kBOYDT_haN7teX_","name":"type","brief":"","defaultValue":"\"Rectangle\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"McTQgGASWU5qywSwi1_KJ","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":"3QFtMPjzANAGvwZFoPdK1","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ks-CtUQvVWSZKnHHZruWt","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":"2dDyXMbVRKZuAsqPU1bNs","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":"hyTVpEBujAaaugpKE_9Ua","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":"CJJHZTTlIJ6EaqV2Zx-Nu","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":"_kk6GqdhBFjuuhsILxVVA","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":"27B6NN3VhrVsPgmEx82bC","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":"T82aYO44JJPCLZW3IRPmK","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":"phNV6vi4Ulwskktkifxsv","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":"-YTbmhvmOE_biI2whUKe6","name":"draw","brief":"","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":"opyPXY4LCIXO2j1hFR7M1","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":"nbKghg4yecQY5-fyJiUAD","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":"5pHEZ-VlTzc7OQ-dMCgCm","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":"D53muDCws85MqvWqgvLUb","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":"4LQPxhizLCmG05GpowtTg","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":"eOAA1IxkRl2mhXWowsv-t","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":"50wKVRceLBUnc74vFbH7p","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":"RFtK35ldRGOwjyVhcmqzi","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":"YF4kluQQbSnwNSotYPkYc","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":"T4qxUXwgWXXpLW1GZO_eV","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":"teSal71bQ04vij2_VSwUT","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":"bQbYzRfUJudbeJT0hq9kZ","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":"G4B8LUkbqTo4_W1jU4xpm","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":"SZ5qKLEdJ2L8So69ohrCs","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":"4vz5ssEPAlMLZTfl0vWrT","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","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"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":"vssdWIE8kpg70gS7ta47Y","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"OnDestroy Notification function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"khE-1309f5MeBOXf1urRe","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":"kLnhIeJciMNVDp1NTpjqk","name":"pause","brief":"play or resume the current animation or video
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"TjreIlg3eRIfJllFmiZvo","name":"play","brief":"play or resume the current animation or video
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"WOdBraYH_ljvqaY2ak_6z","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":"YFnY51gywRTO_6F2mjpxD","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":"qm5YByw-B4iMh9NgiTiur","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":"DB5I__8Mcumvia_WVz6MU","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":"jIWNwYEZzNn15vTsN3zFe","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":"BF8vHdcRW9ihpwViaYsu1","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":"2f_gRG8kY1a-f0ryMKQUv","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":"prscRPt7V0vTmaU8A9O4n","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":"Nx3haMZ2_bBkdHcO5skyN","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":"WsVA-_jJC2AvS9tG-W35D","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":"H0_N2ylnlKluvjFCgLpA5","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":"OqMzhPhjgHxuFlbAc7OiA","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":"uvxYRH6SV2tIrS_ps0xsA","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":"OyOFa2V8NMEbRHIhUh7fG","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":"DCvO1EbCeKs22wd9dMjyV","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":"1iIRLvBXA5pLpFHNtPvYU","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":"2n4tAEVLBHBE6q1cpvaRW","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":"WoStTV9xfNakfufyMaIkJ","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":"27jWJEMEcI9lIiFc6yNUC","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":"NnNyCNwJ2RuueYTRCNYaU","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":"aZXj7qPa6vK22ad65Cdf-","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":"wuOWtygL11aXDRyZLDjTu","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":"U9uBdRVMeOceGpdWneD_g","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":"Lm9DesM2o3AO2kMKJ0e-S","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":"yB-QEokGxGDRhKhQRxCTI","name":"Color","brief":"","type":"ClassDoc","description":"A color manipulation object.
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"DRQeolM5X7C1Dxk_gUv3O","name":"alpha","brief":"","scope":"instance","type":"PropertyDoc","description":"Color Alpha Component [0.0 .. 1.0]
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"RvOwImCxmNWuoqhCdUv4-","name":"b","brief":"","scope":"instance","type":"PropertyDoc","description":"Color Blue Component [0 .. 255]
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"HVXcqD2r2qMUKjZjwmLnm","name":"g","brief":"","scope":"instance","type":"PropertyDoc","description":"Color Green Component [0 .. 255]
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"XG4198pKysuyrsznitKQO","name":"r","brief":"","scope":"instance","type":"PropertyDoc","description":"Color Red Component [0 .. 255]
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"kRUvw2h0vEZlLwah4fD38","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":"dGukjZXlJ3JAf8CmfO8Mc","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":"DSrR0oTxygM6R2hzaea5Z","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":"GFebdMMYzlL2THO8cMPOE","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":"hPD1m1JqhS3E2TgM_NJcd","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":"iFjliNBxqA5qdTNOR9nMK","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":"jlYKsGnKNa9n7XFeO8Rc8","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":"I3eCnzeqSe3qKuECs4VJu","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":"lGic_nMWUp9T9t5dq-vkV","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":"XyI8fiW9kRZYyMDfoX9wA","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":"NQV8XLbmKPCQXhkQAe4x-","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":"2AECOJrjrSbGIXuSdTvyn","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":"afQUNAa-UMfdnUFtvXfKs","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":"WK0mva3J2V2f8Iunkhtlz","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":"AVMdmKIqByokLg4B-KIzD","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":"bPwouRYaVX1hNWwtD2uWR","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":"Wv6yAmRAQ23knKQSHHxLB","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":"mc2ECkKBU7aOSP6ZPieRW","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":"SxPcYozUcWgrH4h5qAf2r","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":"avqDQ_BWQMZchwL6sdhbg","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":"5RAxsOr1YUx_DQ22l7h6T","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":"nvlF3f8NS7ZxgHbOBncv2","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":"ZfJu9u5YztERFYfwjI0xc","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":"1XGjgDfmkSPf6m5QZ2bsn","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":"gnfPVi3Cru0pkX97x4tbH","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":"qXWEhsV_Axwyh-RuW-XXP","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":"DvoE_azxIuknqivCXly8W","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":"ZCm29lKF6xlnUW2nQwSYS","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":"9oetfRDxJkQCqmBAL06F9","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":"lc3BP4YRl1LP7S5ek_vU3","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"JkBih-ZMxu3RlAZgB80cr","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"-p4cYCkQVangzAotmNAlz","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"YuomGvplGZK0K0QqP2IaX","name":"color","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"the layer color component
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"PwTry1h2lYlbU9u9_Kpqg","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"DhSWrCsDsHL9_bajOO0-g","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"r3vqJkKMWGgwn6R11n31B","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":"3qaeml-mElmee9j7ilKcF","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"
(G)ame (U)nique (Id)entifier"
height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"rALdCoHZhDnInSdKECgyy","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":"-vfbcXMStlk4NQEejakK0","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":"wmA6opywmie0X_nU-OJ3U","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":"wPBZaxpDaYrk1PDZb85iy","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":"k27h7eeYrK-P9yDFHioTz","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":"ah2iisRsmhmiOb_yx3Etd","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":"MCb72rRCIcHQNJ0yhGNkx","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"F-mQCa99Lt8_FOfpt1y4C","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"BUpVpN2Rfea7I6mXTj9F6","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":"ppAw8JNNT-DaSz31am9Ak","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"FK0N3KhneiWBffOWhFbLo","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":"wzRSRlr0ZOdLwZG06HH-a","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":"X8LLVV-_0adVOjCpP8pxd","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"7s76iY0vEJymg-hihrWbu","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"AebZatcVGLyfkHciZkN5N","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"n0ojSKzY6WfUdqwgpsp_e","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":"4zksujTHSQtF9nrOCDoqP","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":"dv5DbNhQFaih5Y6Z1hOmE","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"70cwFffziagCtU215SDRb","name":"type","brief":"","defaultValue":"\"Rectangle\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"F9boJHs8B9EMqny0k0ms8","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":"E13Bp1uCBZGRTJAsNgKIV","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"gqBKsHpEwMKbRikP-7jtF","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":"Y9-UUjx1Lf5XLeT8fk5Dy","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":"ixh70_5lJ3HfQVNaULdqn","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":"AWoHBZr7Eni64FP49z6OG","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":"Zi83et8xmHhUJvM0magUn","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":"800lxXLzDazWzWWvlpwym","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":"iRDo5F6UYFTqkGTtyarLK","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":"SuoD4ZEcobOj0XzOhnJ-I","name":"draw","brief":"","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":"KGDKBE-Y4tQU3ajxEahyX","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":"ntnouFm63pRluPzmTOnSI","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":"9_a7dw1fwvaBKnIsbFGzN","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":"yc5zWA3SRBt8WYBj7Efl6","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":"jtcqB2GdhUGsOAoXIC2fN","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":"a-6F6DbjalDPXet74dl2I","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":"Wrm4P-p7-geP3DGX_-NSs","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":"55yOk9SbK7iRGg3lpuHCt","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":"3XXNSjqdD7Mdsey1UiMpV","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":"wzLdIiXRnHoxUKlIzEOLM","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":"9AQKWQNCHhM8z16DJXtpX","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","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"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":"Zt3eLnIbxYB9Oo22_mT7A","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"OnDestroy Notification function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"nMD5t1JYHvHfjke97uqOW","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":"c0PsMEkhvHoxPyAEqOHWG","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":"FtxxQZ2901POx8FNqBsHs","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":"9PI3Emz7iDmE2-XGM0hwn","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":"oCNhV26ocb_5nBCXjRb4m","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":"61LEd8mAi6dKdPwlk5zWC","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":"x79rJHXz7YD-x7IzHpP8P","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":"iR3VyVayCLkJjVNXezmLo","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":"pvbuNm9uyKU25Dy-Rf5-v","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":"i-OOYPynBykjIdzzbEb-8","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":"qkvh23I0fZvbgTb6Y7WnP","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":"A7HTfdZhl_QRQDPQfZ56d","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":"tJJRCvBQhW5RFkFiM-KLm","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":"QhSxKvuQ3THztiuSHS92k","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":"7lwuDWzZ324UvC0FpICpl","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":"702cXhfq0cFX4ZLE1raZ2","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":"8xPLti-jQ4TfYsBDuXn9N","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":"b2Y9J2yNe1fdsZUM1ZjyS","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":"tEGQ-Xh3xwnpgdh8ZwDKF","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":"FyQmxiIBH-bPW4FJ79puL","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":"s_XAb-iW4f9rusLhFm6q9","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":"5Lrzgdy-I154gpuqn2kwk","name":"Compositor","brief":"","type":"ClassDoc","description":"A base Compositor object.
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"-LzrE6ctZ5duiZIFaJ1av","name":"attributes","brief":"","scope":"instance","see":["WebGLCompositor.addAttribute"],"type":"PropertyDoc","description":"an array of vertex attribute properties
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"LnBKdGjbsH8_viATbPjme","name":"currentShader","brief":"","scope":"instance","type":"PropertyDoc","description":"the shader currently used by this compositor
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"jK5aqyv2J_v4mxA3XTDsJ","name":"defaultShader","brief":"","scope":"instance","type":"PropertyDoc","description":"the default shader created by this compositor
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"W8tm6EwJ5RVzdUBiQNjYw","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":"r_QJOeyBxkUHQbmO4b1EV","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":"dKUjk3JQPOJcKTaBE0xVR","name":"vertexData","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"the vertex data buffer used by this compositor
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"eM57n7MICRrpoEmO0u980","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":"bZlCTU44Iw7nINO55iLkT","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":"6oBpApN7NAtwsmTg2Nvye","name":"bind","brief":"called by the WebGL renderer when a compositor become the current one
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"UMPUePxapyuhPvlLeL1Wo","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":"IC7IZh3jJBKgIt7OHLje3","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":"ZBOPLrijuDnDsgsakOGO-","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":"mE6O57GfsaRz6DfK6tqT9","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":"5yDVuTZDxsXWnnN5tKiiA","name":"Container","brief":"","type":"ClassDoc","description":"Container represents a collection of child objects
","params":[],"returns":[],"extends":["Renderable"],"implements":[],"members":[{"id":"O7haA6_aWJ_i-eQOBLPxW","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":"0djx_sBFjFfB0oxB4fkgY","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":"FeKt0UjIt_SFY2zM69Q5z","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":"Mjcxs443U2N3LhmUTyRpf","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":"crIOjdaILb89Miq7G3630","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":"OZwx0vhubQpcGv_4wo7Di","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":"TxSuXPnWr7Eswg02yetuk","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":"T5-krzPuUSDnmMA94HVOH","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":"th9zVTAS0o5RaR9Px0JFo","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":"1aDKNdZbh26VIVeZFBSXu","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"RRJpvGruvKgC_iUE_kcnX","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"xD9lhbuQ0wC6dUNOzmvN6","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"cxHCvAeFtlB6FMoL8zfI-","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":"vzD-VzvemHlzca8iRsi7q","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"pY1JT6pCxQivZGvDWSdg8","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"P7anrX1Xlyqv7T-oQvezR","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":"o6IzYFjMDj-QB3UDVtuUx","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":"wkArF6d1Da4OiRRT_AvyU","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"
(G)ame (U)nique (Id)entifier"
height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"mEY-RrPtk-gcHJwNToECz","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":"WZUX_7gwz5cr4-NNGtX8c","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":"L8vi7SoEtLmuB9L9Nkd28","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":"JxReNNk0TmM7Iv5foqell","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":"3Tc8yID3ynU0FnroXa3he","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":"u527ZCHIdDykcFE_U0sYB","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":"7kuLfV-iQDc2Z6UdmLaTH","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"SbSxMWyy0lYBJOTY5p4zF","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"itE6lIvOmiTxwhnrUha2f","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":"kz9_32wlr5-at1OZ4766J","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"YUOyNtXEmbf_4IFwd44Df","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":"Ds-XDesFinxcEmBdqvz0c","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":"USZo8R3EGv0F6Q_ceijGs","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"qfRmiloJ7QqboWuNo4XQY","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"roCUsxL4hKGk6mPuKl5pv","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"KCPCg6ONYjeZ8We3_Ea4l","name":"root","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"whether the container is the root of the scene
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"HAStCdHXwG7BCZ8rdwJF6","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":"ObQKgC-nTnomj3Y__Jc4h","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":"OAFJ7p3NkNSAyUBl9L5Wu","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":"6eDJG85HDOgS7guFATmG0","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"-f_yYIUNjnfLcEm5BsSYt","name":"type","brief":"","defaultValue":"\"Rectangle\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"lNUGVXWMi7dTE5ovio9TL","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":"GrZG6c2UeE0UU2wOaasw2","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"A1KfMGiwmnV7mFXMNcbaq","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":"xP-H8FfOnXMBSGISBiAEN","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":"EO8mjWrEr7Ee-_Eojk3-Y","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":"4unG1uTuXkzxiS88jEh8c","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":"FOV2AojirbpkVZSwUnKgh","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":"p1Kc2-ZJcfnAn3kkgoXdh","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":"ZxwJUE___IWjNotP63GBu","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":"lNzLWBxKSNQPCk_kvbYHG","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":"k_CoT9YcfHL3ZAm9L0Uh0","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":"xezos09FKTjfu1pVMioJR","name":"draw","brief":"","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":"LKe45MX4Hulegel-UrY2H","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":"8Nk9JTCJBk-Rglrjoawmy","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":"VfHlyIkrtfHUOvfczCbAs","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":"_cK0p4JFCTqxtTUZPlrel","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":"eJ_4VzDzp0_ft3uzsWYkd","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":"hoWtH475zc0AewdtULuEi","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":"Y5k3IT8WZ9lCeMcZJTpty","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":"NPA6IfVGBJnitGst3cEt7","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":"ytYOWwl2pk6npafEfYnJL","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":"SIxJ-KGZc9pGqvvt7RS-F","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":"TYQOJOWxrYt6sf_0IzAYd","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":"1jYT4AUCewf3lPjI1xdBP","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":"vIpNtsoCl8YBPjE9Cs3aw","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":"LExKijR-ytxHBsg5bODZt","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":"PIrgYn0hOraHKZ_gVOuCd","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":"bZ5Af2lxMnoRMeuwZVr0Z","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":"B3Ot0BnSYLIrO1feNOV-r","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":"0lgS01oEeqOFgt56qpmW4","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":"ZICi5zRFgEsQuGydwZYuA","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":"76WSC1ZV6PsdAaUcegZrH","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":"bV_g3Bxo_q9fhXcN0Rnzv","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":"RVj6laUG3ft9b8-9sRnE8","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":"wbt8VMB6EO-eiRHMtMcSl","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":"kKXq3MSYXAIgeR8ZO4Q36","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":"ywnpjfDABDAFRhOzigy2c","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":"pe4BvaR8-7_q6XUWQ1dSL","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":"rW6TBHBkg7Dg1VCkvDm2X","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":"MCZKlp3p7t_WkcdfOpvI2","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","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"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":"WzFGPqdF6Igd42ccM32V_","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"OnDestroy Notification function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"j7Gexk6YlXfW872dalxbC","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":"fv2PryLdXhFU4HUtRd5jJ","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":"drG19dE_lMDPFizdvLsSj","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":"oxxNyo71uAItJ3n0UgbkD","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":"eA4FKonkxhkX9giGH0hGt","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":"Renderable | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText","kind":"canonical"},{"value":"Renderable","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"}},{"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":"J53PqO0kkSZ79iOOG1iei","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":"1LiIk_8Lhy5lZge8rb9vO","name":"reset","brief":"reset the container, removing all childrens, and reseting transforms.
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"rBUH1uk5l9O8dR9rSdXBG","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":"solApgOqnFxsmtw9vR0gQ","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":"i7fWJUi_pCpQavIEm4BUl","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":"PeYHxxjUK5OWa8q4bNd7M","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":"VNwnjIE8pRdUr4iMK7OI9","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":"0Mibt2Aki-FBVfSnaxN1N","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":"gPdDLSfIgy1cjckmS1WZa","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":"s46NSWe4pTV7FMJPqzJ-7","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":"l4iMmChLVi73wVwKCe-Lf","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":"1zydE5eYw0CV9v0shGnC4","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":"EGHcLx1RK56oN59qV3BBK","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":"OsD2nQJ_jayKTnYKmTWx2","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":"_CKQGH22n2bi7PwxuAPLG","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":"vWnq6MP07yrYPN5Q4tI4t","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":"-X1dYOb03vEOkCslnwjaL","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":"Oz2cT5uDwjY595--tbOKb","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":"wXeEc-uS-DBCSWaxzN05l","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":"96sSIjbZXL4NGapmiylhE","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":"rZWJsmWc68Cb8z971GNvK","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":"tZQfWP4mDNZWI8_FlxW8g","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":"i6889kEWLAjsJggw2H0Y2","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":"OmbxBffbzvQwUHicp5lAM","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":"6qwt0PlQNmOzXJPRVpOcE","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":"BSJqCkmbRs3fFI2VdR5yH","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":"XbC9oKcI7uXtx5gWv79fG","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":"vu1lDUAf0rsuc4JW5lprL","name":"Draggable","brief":"","see":["DropTarget"],"type":"ClassDoc","description":"A Draggable base object
","params":[],"returns":[],"extends":["Renderable"],"implements":[],"members":[{"id":"SmEXbywp9NEeIx7LCLa3x","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":"f8XCVHxrlcCp-LImofn71","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":"G9boSQcI0mdczUClrCXi3","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":"FOjn1sthkK_WCDQIiaErR","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":"Fwd0hMO7VoWUJW-R-TwbE","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":"e9MT-hdIfTSUYXHlcRwg3","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":"uJb99dydGGO79-YAKX_db","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"X5CKs0PdCzj82QI4KLpeX","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"imZtjf3_jdkgeLTxZ4Jr5","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Pz4tzxr8zDvf7uTxtdYCq","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"FKur0yMlRNdQpuSg5l4G6","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"UrYblMe892-5Rtvt_azZk","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":"eh5uMgfOJt67tuID-UEDt","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"
(G)ame (U)nique (Id)entifier"
height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"aHxvz5zR-rXxP22GsZFpF","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":"ww7iiWsAeiipWybkxNi03","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":"GxdHsPMUejlx7p8pJT0ub","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":"sc9U595LF42v1HRDvz027","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":"r8JkMOHzHrT8LzoNCDVXt","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":"GYD2MgbKXWUWWLlWXqz7w","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":"T45DlFhoGvJrV3Y2lMgnn","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"cWmkbK1II6jpMtn7vvxXc","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"AYy7-cGIZAFQOxojATSzX","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":"b08Thy4RdK-ZH2q6GdN9_","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"lRGb-CR_rzRCv9u5_fQAu","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":"fj09seE5L44UMmCnVwpJa","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":"JjZS4JOsxTcIGFvnCbWYM","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"rPTcy_GdEsADlPcFee-Jm","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"GTpPGfhXPH9YxQm3h1WIE","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"8C-mvEKTS0p-QmK21aNxU","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":"MLOXeaN_ItvSePkWTPgKq","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":"G5pdQX8d8SLGKC_D2r0pj","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"v5vK9y6kf1NNvchPONsQb","name":"type","brief":"","defaultValue":"\"Rectangle\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"QZQUQPjHKMOWo5sl6iZT9","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":"DdMVKgY27DIE8lgDyACVt","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"uFmKHGrqs8cbzH9pvssxa","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":"1v9pLT6mT7qXAjnncZsgj","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":"skHHJdb63q90029LxzoXJ","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":"RFzf2LjyGXMpweFxOUwjW","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":"STDIhC0z6VOYEz-6ZyjgN","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":"tdauoyIg5RYSJ3Gf0d9oh","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":"_lJdv3-Wv8k9SEVY29HvF","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":"W4T0lZ8v2a0oAMRUcTg8T","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":"4Jz4A2FYGVpqUt_0F4t9Z","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":"yIsOFqSljazp-8oWKvhGI","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":"xvEOMWLyd3t1mFmcdp2gg","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":"OTV__jf6ucbothglkPpsr","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":"h7tbpOs5OrboN4recP2c4","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":"TugbBx0F87XLMVtpQ2P4R","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":"dKP3MpDRQq-c66r67mRWk","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":"uwVYGqWIus2kxj5h0Zi1L","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":"XKD9rEQR7Tncdqg2gxPfI","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":"OLWlSkRE4KXVUofm7-LkN","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":"2eb_U_W1TVLZjm_OQMYaw","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":"WsbojIpMYVNgBNCW2VsLU","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":"HDHLCn3alvqoFVJxVC7QE","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":"GOAwXP5ZRgogplVEBbFYU","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","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"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":"58xQF1bFNNJKPU3AiYrG8","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"OnDestroy Notification function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"YDY3Dduw6jOmDI1zhV89O","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":"ZcTNAcmOPndf8-Fv8zZ3i","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":"qZolrfisN7jykUvTQCWsh","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":"OyRt7JTvbxRw_IEq4KSy8","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":"YMokyQ35GPXjn2ZRMowqF","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":"6V5HMTCRwLw9wpbPv8SeX","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":"cT2dzLlFuRzFWlE5HFuMj","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":"o0WBMOX9h8isKcXH27sW3","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":"QzVYQQN2jQ-9Om3K1Aa9M","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":"h_iZZHgQHL4yB9SKTpuqO","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":"JdCZ-FihNxT4ioD4F80ig","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":"sfXZJgWIDsjQr0Mt05kg7","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":"zBJjsAQTcsElC_IInNXrG","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":"Gsn6kdFaTg1b3grGe4Vd4","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":"Ohqt-9y4qOwWHte9LkYXX","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":"BKYqNh_PmXtACZcyVhwMw","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":"QJ8I2hUsxOr8xoA3-gPFf","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":"RuIDK997-I5wG7honVZXw","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":"v_2WYXVUrm39bRDAs7E5g","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":"dvNjbKxwG2vGkaTNbcL8f","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":"FPpHqwosCitCc8ICjH8VX","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":"V62dEF-HAxqYob0Hix54R","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":"mxRN4-_RP7qAcMM8i1u6A","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":"17LhE9TDkeutzN532CGzI","name":"alive","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"dead/living state of the entity
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"lYWsD31oqFjwt3HW10XNG","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":"DsFV5IPNd26W_9cQQreMv","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":"ehRxnqeFMAj7zM-pJ90pk","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":"97w-cgH5X-LiGgFeKyPww","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":"SJ4DOvuSfzFPiTdvqXSIe","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":"e-i_5Nab60vA_Y5liVUPd","name":"body","brief":"","scope":"instance","type":"PropertyDoc","description":"the entity body object
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"R_CWkDy8db1d37YYISPjo","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"tLPgJSh9srnL6k6rcvACc","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Kvb1lqEAYh1HUyF4tpnDh","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"zx7e-37lTK6WZykHse2xO","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"nu44RULoNJm6ZLzIAq92Q","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"r3sqHPkMkcoJIdzA8IMxU","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":"BcAVzeoDpoMKHYlP2h9LY","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"
(G)ame (U)nique (Id)entifier"
height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"XU_TRN2ETZcwabDESS2wg","name":"id","brief":"","scope":"instance","type":"PropertyDoc","description":"object unique ID (as defined in Tiled)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"1DbhidsKh7ZeGCD2ZKn5d","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":"Pm_wgPBnzq_ZiFeww2RWj","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":"Y8ng63C16ZDOGzUsGeMLv","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":"nVSu0YhI3Q6sM0meGmqwI","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":"u7vcmG-0hYnSYcQKIjcmN","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":"elqOe3aewsfPo6VMeA1lc","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":"evjoszpEiFV7zz5pBRVIh","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"XtxHklxs08CyI1xLrpGjy","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"IcosUUF1KjhVfzJljLWKf","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":"KhOhmZMD4AgUQpMtP9OkI","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Brx7y3vimnm8N0BACdtVF","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":"fIJhGf-tMPlDeuM1JrS-a","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":"yR6UkTDruYa2D-mxbJBdB","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"lPQI51RNWX3TPebw5h-oI","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"7vJg6FRrrMXdQlQ5zm_Vb","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":"wxlAJ3319QOfPQo6DKeIV","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"6NYRr0zKzsP9gUuybPJeD","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":"gvEybLHNpZe6YwwrEJaso","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":"71Xuh7QPQ9BjRkSGAgREb","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Za7lKYVd05ZD1ENCp98YC","name":"type","brief":"","scope":"instance","type":"PropertyDoc","description":"object type (as defined in Tiled)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"SJjIDOsmyvzvhO3FNnpZQ","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":"UHoJ34dvbPfgFgGPDN_ge","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"2auxnHQK1-U9a6LsvClJF","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":"qvByp4H-GbtpIsR-B-LYz","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":"wtR8GG7vJvTbUW-CjmWz9","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":"uSbwq49awjUDJYnXyg9tj","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":"XvgCOq1ocN3OEV21_OdK7","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":"iWvZ8W0qqUB_YWLQHnjMe","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":"FaP78TzbLhDXEohfsvzLo","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":"dBP6DNG2xDFABBop4Yqpo","name":"draw","brief":"","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":"eNB4Tl0nOweGBRl_vdQCl","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":"DTHhn7jTQyplKM1ziH1zC","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":"6GX0sLLxHK95z_QE8vXCT","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":"A9zvTX4zNlaTWPdPkZZEq","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":"HYvQg7Nln5xnEocASn5Gf","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":"nLrSfZ7q2LdmVX0HcjMbt","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":"GDmK0xaWgvT2v4SaVT9bA","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":"A_kOsvKpxPvM8A5q-aq4G","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":"038pJkQAGB2TqJ2rscLKF","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":"wSmrgZH4AskM2sDEUmzKX","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":"QZ3c8ebtdXVGTSkFd02kc","name":"onBodyUpdate","brief":"update the bounds when the body is modified
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"WJJ0YCiOh1PcTl-5DlFVE","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","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"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":"oglK4sFXVNalD6Lz53TNR","name":"onDeactivateEvent","brief":"onDeactivateEvent Notification function
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"pEooeXGumnM7N2FhF6gz2","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"OnDestroy Notification function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"zh7XbBMNnNLjnLFaTcKwq","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":"yZ-y--YE0Mvg5yDzUrvCX","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":"dO-cR8uPjOkjj47gyglFw","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":"sa4NhMbpD758pkFj69jtq","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":"cJWtZwt26sEUs-GrcS2Yr","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":"XtBfejVqZw2zUntkOGAQl","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":"G55tc80J4hLVorVGNJUR_","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":"rw219wPTmAhZlO7Fotexo","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":"DwzSlMF5OVk9EJ067Q7Tu","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":"L3_LM4MMrPjyoeqss22bc","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":"byf3sUC6E5mJix-1eBc-6","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":"bFF3Z4bPtXAkJth4GMr0E","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":"34X2n2M6nQMgkixgMvqFM","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":"ARP5bQLmVhi7iJ3HeRfJK","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":"TZeRSc3JmgQCELfDftkZf","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":"2cdSigzVoW-2KR6sTV7VD","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":"3O7GyJJwbBM9wQGEz_9MC","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":"-FHKaqs6KDyfIZjrFlx6T","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":"UaDoo3ACpZ-m_djIcIRvv","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":"PQAPsLbljUUBXITWNjE-u","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":"D80JoWTbigklEOKjp96gt","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":"Rj5q-hhUe1YRJGgePUvrS","name":"DropTarget","brief":"","see":["Draggable"],"type":"ClassDoc","description":"a base drop target object
","params":[],"returns":[],"extends":["Renderable"],"implements":[],"members":[{"id":"b2IkFem6wy9BFRXndT_Xb","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":"boaICmY_6enuB7jAc_KDT","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":"HVx0QSLlvmVKQIcBUSnty","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":"UaUDXEkhdTFgkr-YiM621","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":"lLz0-ZwaHKXr67zddnOIb","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":"OVvNfaRHQXiXP7zc9lWyG","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":"M_jIgZ596jGxeXpPZydDI","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"6p2-leeNfJVD-IN6hCLpz","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"MqZSPlrz9iBa2u9Gp11PS","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"YmKhU7qVtkePjH9CsXZgb","name":"checkMethod","brief":"","access":"public","defaultValue":"\"overlaps\"","scope":"instance","type":"PropertyDoc","description":"the checkmethod we want to use
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"LQGFhKAPxLk7V5ehwwKi8","name":"CHECKMETHOD_CONTAINS","brief":"","access":"public","defaultValue":"\"contains\"","scope":"instance","type":"PropertyDoc","description":"constant for the contains method
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"1cnO4ZolfqSQ7Bq7EY1EV","name":"CHECKMETHOD_OVERLAP","brief":"","access":"public","defaultValue":"\"overlaps\"","scope":"instance","type":"PropertyDoc","description":"constant for the overlaps method
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"EP4SEEdFE_Ez84YkoBUND","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"TJ7BdQBSHo6moCQRRBUf5","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"cYyl20DGQc27re1Lt8slh","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":"I5s_RX4BmtiwmX7NOkEBs","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"
(G)ame (U)nique (Id)entifier"
height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ocqoTwbCX_P1jEcTIAvcA","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":"YHCd5M7qS9K_kOdDjuTes","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":"YjSlrLAU_Rc3T_7a1fsuR","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":"7GuLl0hAvVY2ov_-DKIWH","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":"g2OVAqIk9vXTRJxEi8qYg","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":"a06IYwC_wk_zqyoHkbIVc","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":"_EnhaAWqm5TUjGvmx5nkR","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"s-3Aq-yZwkNduW39vRSIT","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"vdMTJbJZxHqVreI5sZodp","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":"a32wn_9jGwxBOi-VSaBRw","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"j_ubhiNGARrlRC1xtfYPe","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":"5-8nEwQhJnqT47fawM0gq","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":"tfXi5Vl1clRWvYDNe2P11","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"xPOQU9YDBLzYGrS89CRvY","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"l5hxmk7hrVb18Tm5QbuHM","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Qtvwy0zSzCu5F59NwLRPq","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":"6FxwzhnbW2JrLnDLZZHeU","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":"5JiDXLO1q9bdP9t2NRp3s","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"qDjVaEU0oeO3s5vPgegYB","name":"type","brief":"","defaultValue":"\"Rectangle\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"JOaUpG21fBvx8LP4toTHJ","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":"zl3JtzuQU-IZVRqFcmKFR","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"V-ct15XWBqUdAFvuRxrlt","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":"CZY_vfEXlE28Fu8aZJ-g5","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":"Z28lcaidu39-k-y6wv5G6","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":"aC-UXWOE_8DIiw9DfRtmk","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":"CxhV-M8SGoWJfpVT-cesU","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":"WP16zhiGiYlsGT-VOccJh","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":"AM_64nZQD7WuuYX8Uk58S","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":"v6nJKp_hhzNFMuw1zrvIM","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":"xyZ-Eto0UKXpBwTrTY0F1","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":"awwqIZFOm6fHxDshNb2sj","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":"1yKtaLxlcgQ_m_-5451Ig","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":"8ygCTyfmcusB_4gky4q9k","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":"FqEfMYuRcixVmaHTspz_6","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":"8-gu5sTFb3KU6WZcDloXf","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":"qZk5cH_Fga3SvHlcpOI1K","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":"MuS4CV4cDYTK5muOeakTN","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":"BtY9pN411OBSqxeF6w-YG","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":"8OM1CxdT9_FSmnJyPZgXK","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":"31frZNBh8pBlmZ4HSzE7M","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":"nTFLZ0oD_vo6ThlKEnr-9","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":"wmmUjNHZ4ktAVvITzYrwF","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","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"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":"I8RcThvIpx5VGZEZ8apEj","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"OnDestroy Notification function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"arqSNVG00suS8aq-ZXBeD","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":"nWalebIwYhaLduNPMcJXc","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":"CCJh-mkTiV71XTc-uCC1l","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":"ewZH_rYGbDjP470SET-aq","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":"CbTHRVTmKAssAqHBlbNpQ","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":"fJzRpPA9Iba6JDZrdqF90","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":"jXAR5YQE_euheXt1Gy1a0","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":"lwp69UBXX8lFaoiUyqU_c","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":"Ef76K4DpkpIJ0ITkD1ve9","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":"QA-pO00VvT9khOT2gY3bb","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":"p1nSUJSmCTtJaIY4zhlKV","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":"W8a4vEI-AJMGV9fLNW4tZ","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":"266tjm-rbwIdjeqH_kTIk","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":"4d3MX9NAxhFnyIdzIPmyP","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":"d8-o2aNBKh0ykzVo73Vyl","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":"kBwF_5w0ckLpmQZEqtxRc","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":"dBmC2_dtO2Vuk5FaT0lWr","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":"mZ0ky6Jy0THytAlB7o--M","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":"5UFVGaDfGluqJpTbr_2fv","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":"sReJaK42BeIuxFfYWa8y3","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":"9p8uPVtkDcM7CPlkkj-4S","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":"he51iZ9B7bGS4lLymOXKn","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":"jy2rGm9IlEDdhIKuNNoC0","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":"BkfsbGXPNqabtlcP4uO1x","name":"alive","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"dead/living state of the entity
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"eJmi4C-09oLV4YCzmnIrH","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":"iiPzn8SB_wKnU9XMqTwuj","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":"zxv-yr7IlHq33dtxFDHXj","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":"LLhOKMXbSk0S_gGv_Yt1K","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":"1Lt-yIh3e4UW-zqEVUnpn","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":"zAt_hIcLpVA3uXddYkbOc","name":"body","brief":"","scope":"instance","type":"PropertyDoc","description":"the entity body object
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"tcy6vgP_64AnlTUWdIgYk","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"sMX88EIfswo_SMMv4ffGZ","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"TSnwi3gjHfcJ5jo5Aevtd","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"SmmghrnwrmR82r935dsTQ","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"vEjY1Z7GOamRd7UZIj23I","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"0P8RoSVC5Aga7y_z73OeI","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":"wD4t5kxkqVBC2ca-hJ8W_","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"
(G)ame (U)nique (Id)entifier"
height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"d8jzvlXKUOmG7kt5KAo53","name":"id","brief":"","scope":"instance","type":"PropertyDoc","description":"object unique ID (as defined in Tiled)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"uqMTZTlQPIy1z_rREtt9J","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":"zTGkHTmSqHqtu4z8927-K","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":"uIUVqTmVACURBJa1ATMIr","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":"ErkTBkHmIjgCmECQPF_FU","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":"ve8VTSomLv2LRetp4Lgok","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":"qB7eOGI85KyGXLwR_6y2f","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":"J7oW6uQTXyVNwHn3-5BN7","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Zwl8xcuuhQhSLTMl0WSVc","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"67QAshy76dNT9Ts7iaqCZ","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":"fFx-fyUgc-ONLQEIoG0Js","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"sT-EiAAPKOONrROegBxFv","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":"FqpUVvhNwOPQmv6jK3eMQ","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":"qQzJHCRuS0XHgfert-eNe","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"4gqZHOjNdkyV8C4PWgIPQ","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"jMZAGyllFe1CnLd3GuTty","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":"L2ImUNYBYE0xNtovQ5y2x","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"54KD5h4TOIeaBHJ7erj7C","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":"7vbxhj_ng1ZlHskd-Qb2-","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":"TFoGhZGhETcj1_cgX3qro","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"J8S4CTCrtFGIQ4RHyA6aQ","name":"type","brief":"","scope":"instance","type":"PropertyDoc","description":"object type (as defined in Tiled)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"lX6dXnLBUWnjPXJ1QBm_x","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":"my6pjzBQMYrmGDa-vAwcH","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"uKpTNPzLQ5osW3eWLTXCv","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":"Vbv5odAMerDQOQu7VzoFU","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":"GcVJ2PdmD17FgsNuoqd_g","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":"B_hshV8wpmRFxO2k71mI0","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":"ny3QA-sybGMB8AbtN6wy9","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":"5xkUTnUZZXr9VeV7glc_C","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":"6c5MHfT8ay0-6H2g4z_lh","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":"SDlRcEdig_-WIZZWC_R4c","name":"draw","brief":"","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":"onNiZzGWC7SYG42GmQJQj","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":"vUSqm85OcywKne8BkwgX6","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":"ltunftex9ezUwXmuNM2tu","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":"-hnWnt6VDqnz0h6MZqw4J","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":"1y8-3GQ4keviAX9aPXhbx","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":"GGk_vK5-DtqLx2YyB0wH4","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":"V0IgoBRxEJR2X2PURdQf5","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":"IIq2wh2Ww4moSwuNplhZn","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":"y84waYmDD6xuehWnKbB4R","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":"wnHJSlEofdgeVWdofmrDk","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":"dzTH70Icmlx0w1o5NRla8","name":"onBodyUpdate","brief":"update the bounds when the body is modified
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Nr0XUTketp1Sw7c8jtVZ7","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","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"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":"iw2GDWJtLdDVDnRFdT1OJ","name":"onDeactivateEvent","brief":"onDeactivateEvent Notification function
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"0QDGRLfI0HLpVLbL4OzL0","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"OnDestroy Notification function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"emE8G90aByZlAymt3Y5b4","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":"Sra_PgDD_on1-JkCnSece","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":"KcMXzdunR4sO-MKyaQAf_","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":"i7Pb4Fxj6jLkhJy3EDMkd","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":"bzVCvrjnqlewnfgZIBGb2","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":"1Sz9obbAowNfGezAJNxPt","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":"ITwOx3lhNrU7DqSD78xZc","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":"XOkE4j6KBcNv5iVVh0KHD","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":"oNDAYd-KUJwWwSAbo2Yxm","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":"on44_xggS8vZB5rdk3hiL","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":"GREY9Ekhucgg91aWElzIa","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":"MIhaFbLME4R2JH_YEpvU1","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":"LGRvPPVx60QFQmCP_oINO","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":"_8mnuapXPegr-6sAv-6s0","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":"0xLpa88xNh9xuN_Iq2pvL","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":"X2eyh_dxhAUkJjs5-jHvW","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":"MZC9xKnq6aynXAfBeeA5J","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":"zOjmEwYqEU0pxMWhUqCED","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":"61f7MBq-484aUoU4XoRuO","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":"17YuvApnTm80ESW6lHhn6","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":"cVgHOBk0UeIVRcyPbYff4","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":"RCht5pAL7IdFwIUi85X3n","name":"Ellipse","brief":"","type":"ClassDoc","description":"an ellipse Object
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"uQfN1f67z_aqpKdRMNDxl","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"the center coordinates of the ellipse
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"lwCSNBq8M7JR8RSgTkFsg","name":"radius","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"Maximum radius of the ellipse
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"vR8DrcQypoZSZS5vHnXQ1","name":"radiusSq","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"Radius squared, for pythagorean theorom
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"HxQBBt0VPhKO2-RauNver","name":"radiusV","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"Pre-scaled radius vector for ellipse
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"2KNpB2JS_WZtYJ3zcfYAC","name":"ratio","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"x/y scaling ratio for ellipse
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"YBp3LkTZRGbWo4MyVDX1a","name":"type","brief":"","defaultValue":"\"Ellipse\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"s8lJDsWuqtdqHO3Bt4TEz","name":"_bounds","brief":"","access":"private","scope":"instance","type":"PropertyDoc","description":"The bounding rectangle for this shape
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"TfVaJnSpK9U88CrD_1fJ2","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":"Dgqa32jaHtaZ3Y63NvdHj","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":"Nzr6V-juIfWHlFTO4mj5K","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":"GlHR2nA1YRlYDB82nVTww","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":"UNTwKLIgOaTf8M4eUHdlT","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":"vv_vv9WxpuatBkMy7yX4Y","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":"ApqVLl0OZKm7Fuc6wsxpg","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":"k7FYApTtiSbRa8mOpr3c8","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":"71p7kZsnMWaWT9bLWHvSx","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":"Ellipse","kind":"canonical"},{"value":"Ellipse","kind":"link"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"V5nDyCzS0vsv0ii6sypy4","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":"bMD81QtF_CTjRp_kpg9Ex","name":"Entity","brief":"","type":"ClassDoc","description":"a Generic Object Entity
","params":[],"returns":[],"extends":["Renderable"],"implements":[],"members":[{"id":"Zg5VOhA9zG84P2xeosyRh","name":"alive","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"dead/living state of the entity
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Rok47NLntpoSo4s2Dz3RB","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":"OGZB8y4gKOg-ZcBWbVEeF","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":"LcJBUPv4lk4Ujj8cwGSG5","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":"4s8WiGEiz8F7mDHDng43l","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":"fAB6AMzpgqJ9TPoJPaetr","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":"007YHJ5q7sXl34usGOkm4","name":"body","brief":"","scope":"instance","type":"PropertyDoc","description":"the entity body object
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"hYTnAU30AyemyCq4ZbrTP","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"b1mj5kh7m0PwwDTRlPkoy","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"9GFsra6Y1hXGrvgJD1ES6","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"iP-PsCN46H0lNAnSf9UN-","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"aUQ8SksJINKTYMAuoxyv-","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"mn-8ips3KEzDDyGecc1kS","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":"2XjwKgluQvHnyVJ0vyTfU","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"
(G)ame (U)nique (Id)entifier"
height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"mIPbm66WBhdrBFCFPO8EC","name":"id","brief":"","scope":"instance","type":"PropertyDoc","description":"object unique ID (as defined in Tiled)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"iusO6GzB9fb0AZ7qPi22e","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":"Vd_VRrkYhFY-WN5PCXqSc","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":"tv3LAkF8S21fHr2PTmUB5","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":"GtgP_m_rArw0t1jNYA-Bn","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":"0_2aAtv3H-QyxA5Rp3vBW","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":"ukU7InXiIPwLuk52FkDoc","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":"8FD3G6wH2EZqmJf6FDPAq","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"8XOsVSY1Cm8t5XKlTNJ0f","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Uy9suBaeDFz-XBhiDm5nw","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":"juLKZvFY_4Qn7gT08CXxm","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"H5cj1Bd08T0UIXXGBd5cx","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":"UnHga48vXJlKrdKCmjh-2","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":"a6NajR_wi1BpsqrTKcCw9","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"4O51Oc41L5krhd7Kx7O2B","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"gH2plzL_VnrbCvPkjDCs2","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":"ILS5KETvOB7UYwjWSfrcV","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"iysVH4iB1Vt-ZE9mOXGQi","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":"yeoWQrin0NL_1cWsW6OA8","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":"coMWiR0CjzOTZiHS1XpFe","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"iL5c7dqT1n11Vb6k9B7f_","name":"type","brief":"","scope":"instance","type":"PropertyDoc","description":"object type (as defined in Tiled)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"STSHbj0YmAduhvWvbxnXK","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":"xX-shbeZTLz8ElAhRkZSp","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"7ShAgvx3dPQXzRYRLwPCr","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":"5LciTs4pFGecydKUd8rak","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":"s4A0ydqhoDGw5h9m6tjEe","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":"ZxkYX4jQELTnkVPNqT5F2","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":"GDMhtA8zlvsGZiT68YvCm","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":"z7IyANIejbxibxcxJBewL","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":"dKRLbARolgonduo6uGw6L","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":"5AV-oQEXARP60MY1Kzaje","name":"draw","brief":"","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":"3ofCtlyoNrvJsR1VZQUsn","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":"1D6SM0GLXtP71xazQSyZd","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":"sW--m5CooHbyAkup1TFAK","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":"IcWGWbWDFmk_B03r4xC5o","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":"0e18I5R6BwpZM2wOHuDT9","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":"Oe8wnLJcn0s57RiKWrc4E","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":"PhX3GsuMrisgrY7d734pe","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":"G3o59ZM2TGzfdeIf1d2_D","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":"Y5_PosnH62gg0_SefWAnd","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":"o8Iifo8dg43nsOyhljNB-","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":"GMM3atc7KEm7swPUoaftq","name":"onBodyUpdate","brief":"update the bounds when the body is modified
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"kOq1498SVKFVJkk1781fs","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","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"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":"BVzAEJOOfLfmvMd7d-WBl","name":"onDeactivateEvent","brief":"onDeactivateEvent Notification function
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"xL_3-QP8PR2wV_7VLNdhL","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"OnDestroy Notification function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"TVYWN8pF3aV1AIuvMu7ss","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":"zrvt7h6UiOVjA_L7PvZo_","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":"tH_zmuvCOv5o8b6IfiRfL","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":"chbiRX-GK9hAcaDmkZZg1","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":"Ikuk5lJNHh0dV_gL_eVB1","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":"i58xqCIS0M7j4sgmobkDh","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":"eUOgwQv7-6XrvgljUNct_","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":"JuIOjHwCb_V7byqWR5gHV","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":"FmJkFCL_NhSfRzAYrzN8L","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":"_7EyLf3VeEmgld0VUUL8p","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":"3WTaGmElPVIq19ACPAnG9","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":"E8BjLJ5k-U8YAcPlQTxEP","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":"hi7YwdzDegUS02HMpVcaP","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":"2Ctl9eAOHQZPtEKfWcNop","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":"-pn3k2Ds1oX3omoScr19p","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":"2i0M535j1NpTkHD0a-ECW","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":"BjdVRr1aP9AaihzirYw3O","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":"VA2eGrLde8D72lXtpmuqG","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":"Wq6XQe8__JkgnoNGGdPE2","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":"5ZqEmiuEa_BPD0Zm84fyt","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":"iOzUCmSOOEVckh0Dlrs4f","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":"JN5enmcVjWZN-mXdPaiSN","name":"GLShader","brief":"","type":"ClassDoc","description":"a base GL Shader object
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"rpFWlbFMk7kttw3QW_SJf","name":"attributes","brief":"","scope":"instance","type":"PropertyDoc","description":"the location attributes of the shader
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"CvTXCfCjYlY4aON4VFlF2","name":"fragment","brief":"","scope":"instance","type":"PropertyDoc","description":"the fragment shader source code
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"I4fak29JUuKOdLDedCRFf","name":"gl","brief":"","scope":"instance","type":"PropertyDoc","description":"the active gl rendering context
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"giDn31bTU6KXsT8yZ7-Qi","name":"program","brief":"","scope":"instance","type":"PropertyDoc","description":"a reference to the shader program (once compiled)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"mi0zdh50QMpJgVRzwV6W3","name":"uniforms","brief":"","scope":"instance","type":"PropertyDoc","description":"the uniforms of the shader
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"SATrEjvGQ3rBkoqJnDj3Q","name":"vertex","brief":"","scope":"instance","type":"PropertyDoc","description":"the vertex shader source code
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"BvMXBt-KINMf8K_pw9UlL","name":"bind","brief":"Installs this shader program as part of current rendering state
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"4ZodNeMTfrlob8yck0xDL","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":"7W3eYqvoIn3mNeDEx-ZJE","name":"destroy","brief":"destroy this shader objects resources (program, attributes, uniforms)
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"2wPks9_W7HthHMV3NhHJK","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":"g22vKFfi2kTKDiwMc1Uv6","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":"aTU6fEVvsQBYfPjN0Gj1z","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":"8iqpORwfAmugYLca_x1mU","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":"rka8FUYic1rZ2BAfQprji","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":"wk_RvD1rX7tOaVWL9MmST","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":"NVY5C_7RAJV2E6j1Ma4xb","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":"mNSSm-2FnTxq5Pc2GZB_R","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":"-K5UiZ6VSSVmMokfX89-j","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":"v2n6kHtGfVFIU9gqC9tbS","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":"-pTB6Dp2ZgasEYWrQ5aje","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":"BVeYTY7B1jE1YBtsfFI-y","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"NgAvQZHFIDEelt3lgzqTG","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"sMFt8DjT7vuK097sqMMQ_","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"CeBepWSlDQ4FgDvBe4TWK","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"VRBbmWj356rsBQ2mrRgKr","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"pk__Tw-8gjhSPG428UOJk","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":"zm5Vxg6-UkwBDByBAaGjO","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"
(G)ame (U)nique (Id)entifier"
height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"l0Uo3-kRAqEihuBnCrIE0","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":"4nj625MctZHC9hQb1ULaC","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":"HzmHKXj3nEmeTCFTLH0MP","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":"FRT03jfaIfOssgdPszYPp","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":"UlFBC-GONtnXILakhRyLX","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":"NFmn5q5LPlDdmUBsrChlo","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":"JAzr-bcawS0js0I_oamiv","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"tOineOHA3gXlFKLkVoD1Q","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":"_FFzfphSkD7MhnDtzEPhH","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"VCL77XP-cW4NucD0SdQAE","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":"LatxlhbI2XnxYbYjVuQxu","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"1mOG3e5hom301uicGGbh7","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":"sqbu1cqIRRG3ElOICRqLt","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":"Cbv6ZrGcpZbLt8GbzmBU6","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":"7iZSgGyigHp792ipwXRVv","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"gdlBJOvm2DUM6hlGY4BBE","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"xhhODXkpiYwUbB5rwN0nQ","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"eD3glypILKKV_t0doJFLI","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":"liuwrT4taNn552zulCuEu","name":"source","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"
The source texture object this sprite object is using
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"RH-Kl6JSHYhWSXqkrxtoU","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":"Q4tHR2Sw1ASFMj7IHdhjr","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"3z-Y5KIx4xtVNbJ69o_Kj","name":"type","brief":"","defaultValue":"\"Rectangle\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"k14ODGitL0b89vN0AmAJq","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":"YPfHYqa0m6hABy6df-2Ef","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"m_yNegZ3bemXPVzNzGM7l","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":"aQVGV0x30gLAgW-pgJ8Hy","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":"TMIM1O6oz6qxwvnYu3AM1","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":"aCwTqFVZloLBL23QIujdF","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":"95M_9RBctm-GvvOkwGFHK","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":"XhA-NgqncH2tLI-J0XErt","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":"uPK_fRc4JfqzzQyz5XzoC","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":"v6sIclrnjbYNy7XUs6CgG","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":"XEzv1cNKQBVugglqxxnKK","name":"draw","brief":"","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":"NW3X697EQRZgk2OILjpoC","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":"auIy8kp3KuqemQCQOcK2i","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":"5qIqktiU1oHeVA4OBqjPc","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":"Fpq-nyQHjYpVhyX8OVHJy","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":"jyf1uHUAbX6Zp4-piH_Ew","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":"aAYGCGX3WSK4LNEcxmSGP","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":"DZ_2LKisgHJc0saWu01Nc","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":"1AbbGlst6K0f9yjDqZWgh","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":"zts9ExmZydkDYKSbH75gU","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":"8lDrxYsUxBndoI8opzUDa","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":"alM8aywEa68DATmYlbEIV","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":"qxI-YgmWQfPpSGhzfDYg2","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":"0EqQjRX0iB0iJtKA6-JzJ","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":"8HjPnU3VqfIY36KWN6R-c","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":"bpMBRqZzCt_h6bf7p-pJh","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","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"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":"vFrkYxaDz2n2Vuc2QpfmU","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"OnDestroy Notification function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"PPBw8ZVaeVG3KwNLI99nM","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":"utRV56FMnrs53zGi3PcYQ","name":"pause","brief":"play or resume the current animation or video
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"8dCte1vopnUkA2_ih-JCG","name":"play","brief":"play or resume the current animation or video
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"G1EA6MuaH65982z83Q2-I","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":"WSllcyATpEx29tpeeyXUi","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":"PbHHEeZS6fpPUs51Z4O-d","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":"4GHPffIMMIyL1oWNBg9eA","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":"uIOLedYZklt7WTT8L8KPH","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":"LLcboUYNbxSq84URliISN","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":"w-TSEl3ZDGHA04OPMAoxe","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":"9QZJIsmeOk4gfqfSApTD-","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":"Q12yZ0PEiTebiGMIOvCRA","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":"4x21lbStt62cHFMSyvtK6","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":"xP548Y0H-E72usyvKk15w","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":"Td8lx7D1iQONN2d7qP_Cd","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":"KZPPuy5n-msIK-bJcBFTB","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":"HPDVSZZ_yxj9MyI8o43DE","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":"q1SZU96IStTpL1rKnD2Dw","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":"Fn0F72UzuxYF9BqvPNpG9","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":"A8ZkVlDHcxL1okq9WxgM-","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":"R_7OkzO3nCdd4rhcrEnXj","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":"1vox-pVzqTYTQyEpZcGia","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":"0dyPPvA3wyxtqmLqeYYDq","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":"dD__yYeyjPtZcvJaw-72F","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":"eiq0L_wwpM8wRn41jdQUf","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":"95vYaBrFPXnckA_aatA73","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":"PlyZcMdtPbJ2MIrnonIKm","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":"3HF_ZqwAud7KTettv1nos","name":"ImageLayer","brief":"","type":"ClassDoc","description":"a generic Image Layer Object
","params":[],"returns":[],"extends":["Sprite"],"implements":[],"members":[{"id":"lLU1Pwi_J1vRPTI_S0Aku","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":"DlodvlZ0R0fUPM7v-r8sW","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":"puh43GYUjRg4tawgzWUq9","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":"MZZBPp_UGwjptlhkDX3le","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":"-Fpc-OE0rNzeaI7vbiKOx","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":"OO0g0RSIdQfCjOs4wz8nx","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":"zWFOmzZ1yFEKKiJz0OKzH","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":"dSDD6cw-FNnfxjgs6Ir2l","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"zZdaM9wKAoybHcsfl9Bbj","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"4X_-H78haQTMlU7Eaxq-I","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"4KBklLUBYpRgtXcrIfvQ6","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"kTiFsLsG02suYx7ksGzLQ","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"iYVhKdcVbQ2MEjbH5ui78","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":"cgtaFLgRVU08b5to2a3kj","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"
(G)ame (U)nique (Id)entifier"
height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"cVBZgEqJuwPzPgOAhtYML","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":"LuK0F5fbouudMjFOSR5Pc","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":"eADVyF1JKmQZ_j3iVsg41","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":"mwL6JWfuPO0xLydWic9ux","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":"-6AGr8rDa95TNGdh9IXIx","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":"CFZD5XH8t8UcirtAchgT-","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":"AEp98sabdD5iv575QiFLQ","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Wj3hYgwLILug1qQRW5922","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":"CmN4txpqiP2hn_a-G5xbi","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"rtkrBLTyVKJli4k_nkuKX","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":"BrQdExFdEpbx8GzDnb4qE","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"NjJtxac18MANUbdbO7X_v","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":"s4CLD4cXDWI_dmuKlzLmF","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":"qknPZsgDWP9N0ZejD7xeA","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":"QcjW6o1OhDO88h_nVtT_H","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"k5rDv0hrwq4u42d4j0o9w","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"B0TXGLs0U7eXjlX7OqdxM","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":"iPy8QCzDfgjRchE3VR-BD","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":"FQPCS9TzLdOKaORM9DZR7","name":"source","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"
The source texture object this sprite object is using
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"4D_CBBmPC18Egyq1IPpEB","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":"poYdzDs9dnVxul4nzI3Vk","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"a56VHcT49UskGFfx-mEnu","name":"type","brief":"","defaultValue":"\"Rectangle\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"SpJXpowpKkXaI79ExfEsq","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":"9MfCovIgIA7x-qjqVWZsQ","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"wfIwKFIUT6HR3zRQkp5CQ","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":"snBvaH2Ru7vH1d29qKImg","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":"EWPbVKMXY-KXs8IzC2jKp","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":"qlfoqN5or1kbVeKAxJ7NA","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":"fowlg0Yz0ew75Vr7LfB4m","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":"DOXYnEg_S_AsFTYQIlG8i","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":"GfpH4gU_jOsUUVhZnTjaE","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":"CGv4Yb0vfKF1nO2_586Zo","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":"_w-2KpFDem4bYKnOKYCkG","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":"Tqh33zj1VGVXcbX_guUd1","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":"o_8UMoB2UA7qd1vm7AQU3","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":"5h9qR2xJofgN4MUkwVEWY","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":"_tjnWNJVQmzfck-UFUiXK","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":"69mAOuTfNB-2BvvV-Zt7T","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":"X7uR7Zs8zd6BKsCko9AsR","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":"sGjd4ewDjmCy7Rqf5HDfP","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":"ci_B1MZ35mn5QXdeqgWJk","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":"c_tcX3tZDggjGOX4iI5aj","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":"j2a78LcrGkVBxEQzv2nXd","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":"mjzS53D2jv3PdQE-vXUXD","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":"eFkoyvZihGzcbTka3JDVK","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":"YBEvK-e2i1tuHU8ZruTQh","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":"3HfmbSS_g62eav4VhiEJ6","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","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"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":"4eCCalV7Hy42QJmmeiksP","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"OnDestroy Notification function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"gx_9SsbU-dWSw1gTT1a51","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":"iaDyDUDgualQf6WSAjMOI","name":"pause","brief":"play or resume the current animation or video
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"O9b3hDl5g_hQFkN2z9eXf","name":"play","brief":"play or resume the current animation or video
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"e0PRWAeMd4_LTZXjTQGE-","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":"sagKGpgrZJt-j99NuExHS","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":"-TrT1X8vVDVX0iiocwQIm","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":"t_hjA0vfvYFWfqUncEF4c","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":"gttyTxZu8zQ4lTkcgBnK8","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":"9_m2osPJEGwqJviQgWkyG","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":"2P0HuTc6mFgot-3zLa3Mc","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":"_YGwnb46hRkXUnzmSdDgd","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":"bD8Yf1eFiQfgnk9GnI8dL","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":"7ShTxoGUL7MxgvE1WLKj5","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":"FKjZFwPEawzQbtAb-ravT","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":"pfGAZy9QQXmtQspN1Bf91","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":"vWK-SSE5r2JqBpvp_Tewe","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":"vRhAD3qchjqwlLREXtu9E","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":"jDHvXqXiNAl6RaInPo6kM","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":"WBcsuaQIG3gdiFiUhGTxS","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":"jv2DOKx3FR1kqGjJHFH7c","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":"PmBVyfja49wDuYNoYAIkQ","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":"vCD8-7Yo862O7S58vnQB9","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":"0e9rY9D4CJ7Xsq2KAD6r0","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":"_z-GSYjDDGY8V0eNSVXsZ","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":"pSybH0Jun1CbK6btJtFcv","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":"DliU5wTR-qh4U5wc1vwYv","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":"HotQHv_aDa4-224QrpiSI","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":"Cy3GmMlDNyHoywfXHbvhI","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":"4inTm5Ncae3UAeFIg9FXP","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":"4qu4C2IovENfcp4oPFthp","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":"Rg1Br4NLVRaOgkbcqJPK2","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":"wkDDeMPZMyteZQ-ucBD3X","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":"EdqCJssKW-mZUjxUKNJZA","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":"dfhIr7f6t4WyMOet7Lmds","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":"xGjerkR30rQ_10aecfq4k","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":"XwEAzbzIF9cinw1fBVcL3","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"T-pJ5Ye6zRjHBmVPKzLNl","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"j555hzh_L6XGvHvMi2PaK","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"VSn3qmGk_fpv7AM9UiAJI","name":"color","brief":"","defaultValue":"\"#FFF\"","scope":"instance","type":"PropertyDoc","description":"the color of the light
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"uoRv9rQRD6jtK1DmS1GSa","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"fuCvzDrWnnnKW8IXsQIwf","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"DKsbJULjvv7tYQ4JXi6Fp","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":"xH_UJ2l82oTmT58XQ0n9S","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"
(G)ame (U)nique (Id)entifier"
height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"joJBfyKGrH-ksDpaa_V3p","name":"intensity","brief":"","defaultValue":"0.7","scope":"instance","type":"PropertyDoc","description":"The intensity of the light
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"zmAk92V1MyizqjwbHp3Ou","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":"NIUhelFUUTMD28Tnye0rW","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":"KV6hp1AC3CmBQmSO55Aq4","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":"HzuRF64Z65l9gx5PT6AjL","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":"N67DlSFG_O3z4QS12OMM4","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":"aMqQ-BisJwEgqg7-aXyXm","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":"Ft0VmrTS7lgvhwVhMkrjV","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"8SPhJclfEPLbAW998NpBw","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"FH6HySoPRUji02FpocgTC","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":"y1GBqb1qbbyFLUJnd8xuA","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"1XRZ_-_vPW2uwmX4g7xur","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":"Uyt1YukBXcyM1OjUPuoNn","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":"gN8yg8JeuW0KvDI1T2-Kl","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"M8okmXjQCt0ucReN5UXcb","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"qPvh8hMAmKWfypRL5mARb","name":"radiusX","brief":"","scope":"instance","type":"PropertyDoc","description":"The horizontal radius of the light
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"1478O446DCEmQJft0x7SV","name":"radiusY","brief":"","scope":"instance","type":"PropertyDoc","description":"The vertical radius of the light
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"P0tFxw9AeH9BGpjsTg5b6","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"m7wGzHA3jXE4nctUWZf_I","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":"uAf6Z1SXGw5N8wpWRiWCQ","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":"Z55Za0fp2uVbepqtRuQ9l","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"CXb6Cv3r0NDnB-iC1SlS_","name":"type","brief":"","defaultValue":"\"Rectangle\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"fKPOwa3m3LkjDcuLBtUo9","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":"bMWV-P-nSmJ8oy8S93xoF","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"N3FFaFH-nI67pBEyWBFOk","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":"hzO9Y_c3Uh8QEA7Xz7Iwc","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":"qr_m_UsXK4Ty1FkVynFGE","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":"VlpsFmtiJzhJEfUWe7MFr","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":"xk33iA8Hh_NEiezCcT94B","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":"QBw9us4eqGcnpQ-2S1dWa","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":"LQsQKVGqixpLma4pbIV22","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":"PY8mjMeQ23-WY7woG5NW1","name":"draw","brief":"","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":"ww6oYCv5NJPG5TC_staNY","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":"tx7K5pOOjiaYHWQ7VfpKH","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":"pMTpckNH5ye56E-4bqCeV","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":"IJmexYsoGl8Bh_iWBPrP2","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":"570MpRUIKKOzADpaVt0GE","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":"SyXmIux4Nhcik0V-W0EuQ","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":"uPV0qtyHgrHyzKBYYP9QJ","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":"55z_xYM1Q1VvbRhViXmkV","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":"HVskP_nfIPidW9JcjUqMF","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":"4MsUs82-1bo0OzoGiA3Pi","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":"PGoJ3Aj20TEa9Yw1q80lL","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":"FjdlY1LNa8ywhSelU1wKz","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","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"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":"Qg0jBcWTWeCjLjUGP_UyQ","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"OnDestroy Notification function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"rFX0U0KdrDvx-UWU88ZF8","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":"SIm0gHVoY2zPIvaearv2G","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":"AWFQuqVXKN9_NowdVE8cm","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":"HHo8cTizm12Ski-cMv3gX","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":"pd6UHItJOiz4Zf32qftLN","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":"3RuoNM9F-L-Vo62EaKRMQ","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":"xvM8outDtHTJIZ_V-1zve","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":"4BynmzZmjkBkkU_6xfjty","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":"l3ICzizvBc1lk5lGtbJVW","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":"kOlzJ3CgFqq0cC-2Qaxgv","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":"3_rW-F9iIb_4dlshu0YEi","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":"EzunmvmYyp0QGxZPwoFcD","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":"F9iE8Zu43QWaAPm4H8aZF","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":"--Iu14ZN6jeYGQJ5bqUxa","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":"-U_EeCzfHjFx3wvKDXYX1","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":"ROINVlgmNp2JVwk7rHIFk","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":"iv--HAnnd9aKaQZ1mjwi2","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":"b5rp2QxGfheQMpcUis_n4","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":"aqk3UqI7spqGTg1uX09Z1","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":"b7qvFJtlMlhcwuBjbaip9","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":"Mif5psKm7wyFHHrH5V46U","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":"dhsdsqTmPGzShC-qKvSrK","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":"bEtfRxyqUHl-NcXisNkQy","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"bZ2-bb0ph21qqYIq7TgOP","name":"pos","brief":"","scope":"instance","type":"PropertyDoc","description":"
origin point of the Polygon
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"mKvZod_av1z5K3BqLO_mF","name":"type","brief":"","defaultValue":"\"Polygon\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"LzsUDFf-_WgmkDEFjlNW9","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":"xsyicBSh0Ma6UIu1GgEUx","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":"MSl6mzCZg0-NssUmteDJH","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":"0cCpP1MJC0Wb3bNNa8sMu","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":"WnNjU69-8iz1y_LuJ0f-R","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":"whNI1LYk2_-Q2PHIEQCZx","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":"AgRHsdV_G3OMSqCkj5g8V","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":"HkuwTOkgLZ8MD6CxZcufp","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":"ecqO0SqUfb7lJ9TaiXD14","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":"z-CBo0YIIQYoqwo0pXbPq","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":"x58WT1OwuCPpNrXt1v7LK","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":"31ODYjQZElkbqDxvLSZHT","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":"MmFwJOPnDaKDDE8CSHEUJ","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":"1Z7VoCtYKXZtaQidA5WkV","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":"wE8xdv0jq4w_osimfFFsQ","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":"WIY9WjGCNcJ-j4oLEtsAG","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":"7sP9-oWNLsDkrt6pmbuzQ","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":"YrJ0yKn7D4t_I1tX7lYFf","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":"PMeGDmpBbWM7jnHctyJw6","name":"Matrix2d","brief":"","type":"ClassDoc","description":"a Matrix2d Object.
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"hK3ApG4xDWtwDleKsqXXC","name":"tx","brief":"","scope":"instance","see":["Matrix2d.translate"],"type":"PropertyDoc","description":"tx component of the matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"54FGbYuPfFRP5pA0gb-uR","name":"ty","brief":"","scope":"instance","see":["Matrix2d.translate"],"type":"PropertyDoc","description":"ty component of the matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"mlTGF7gwIllwhVTBwPu-1","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":"pMaLlOwxMwc98yEa8hNl6","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":"XXANSpgM-CDJ8p_PvAykd","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":"wBOz8a0EKTMMAuopPtqvL","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":"v2XPj88hDLvVOsqpp-z8p","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":"JsSrBXnyIW7afOoTZ8WWS","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":"wVsUB67oR-FP2fr1wLfdk","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":"OBIABXBjcXZzsvWdAYb9p","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":"kzVNrEygvB39CfHRPv20r","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":"YQxoRQpmsxNwvfqNjOshI","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":"_2r9loDHuCD3KX_So8RRV","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":"DbdqRCdOgyyF6F-GYtV_W","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":"HtPxJrewSHSGZgTkwH__z","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":"nx00CKtM-0scsOdx_cE8h","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":"o-q1AT8gJxrjAmVagyN71","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":"sdZmZxdYxAmOk802P-CMO","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":"w6fcnC2lDupxsCMRCazDf","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":"eAuy1dTlHuvf6bV826b6C","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":"Y1i0HJOMN_YZe1L1F3vld","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":"48FBl8awriUn2NYd9cY7W","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":"s1MoiYNJkCcpS_6eIA6fz","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":"HM64J951C5Q1UtMMO5IoV","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":"mT5g4R_7M7_mZ7cItrR9S","name":"Matrix3d","brief":"","type":"ClassDoc","description":"a 4x4 Matrix3d Object
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"vxj_e1LDw8td01b4MujaQ","name":"tx","brief":"","scope":"instance","type":"PropertyDoc","description":"tx component of the matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"79RwJWov0jExGt6OWp1fa","name":"ty","brief":"","scope":"instance","type":"PropertyDoc","description":"ty component of the matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Mfx2cbnVi5IpkCM-ZVN6y","name":"tz","brief":"","scope":"instance","type":"PropertyDoc","description":"ty component of the matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"hK3t50unTdCo0sYj_eINu","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":"3r1JHadBvX6gx7i7p4UR4","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":"g5fEJiZQzyvzFHAbgGIxj","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":"v7f35sVDWE0CyM0gHTPqR","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":"R0ruOHHZNzdk19Ab6hRwO","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":"BlA27c5gePV8HxtkQ7tfi","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":"SdHjJCOXEAx85BB6bY366","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":"pmTeyCxJdN1DxSe8gq_4y","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":"Jcob54okHuVkcHLoZokyM","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":"DqLDaYySvHiyQsBPYOOXG","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":"baPMH8l9gd5IWLgstUtB2","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":"OVWFAIZfzlcBRt3YEb0Sl","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":"PNbEgGEnlxInqGM55P3MY","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":"HlZXbTYlIl9RdLb8_XcQz","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":"vAzdh0mKTETdItWnQiB2t","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":"b7EtH-j6h0iIL_Fq3IPeS","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":"O6ER7AP1yDjYdKDiRK1va","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":"hgTBTXLi-M2OfkgwDahPv","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":"CMvyR5diVJXww-KNn2vWp","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":"hhyk2aKrGTYk3Vo4nu6O_","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":"8zYJwLd5ihnMZ9y6akV6d","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":"BaeZeQ0eXiw8PBnH20FIX","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":"_NLdLI69QMOrhQpjvxqVI","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":"MG0csv51HWUVMdcBNBhrv","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":"-LT1EtPYOsU_D5F3tmmbz","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":"BF-BGon4_F5noCF9bqyxR","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":"Yrr3Yo_7-8TM-IKrIRe52","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":"93C4MhJkoKemQ8JCtTreh","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":"7rx-5ewCV8AiPdMdu9CqL","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":"98ATpg4pkzhMtYfXBkMz7","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":"K5DxScJTyiDeDie9fkyzt","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"8E8RcqYhGm8-GAmbWBEu3","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"SejqbSR9jMlHN61fbMoI6","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"VHjNHSVOERcT651SmUfL9","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"PpBlDk8SBFlTh6mnng0Rs","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"vvG1Qu5Qcn_lbp-Q3Vtfi","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":"nxySs2JiBNNo-pd41EpB0","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"
(G)ame (U)nique (Id)entifier"
height of the NineSliceSprite
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"l3bNiY0XrJGXi7vmeKits","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":"gkqDnhLtaowh8wqHngivU","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":"EM8vRqY6xV7N8LtfrlG92","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":"-bOqvZi3RuevFZ2TujXMJ","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":"Kw00ZRo4Rgf3oyqdljeIP","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":"HvI8TnKLnbnmZqUMajigw","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":"B9DhZCuF1NeNd1X5qBmnh","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"BoJ8-kxAkqsQh4JrGrd9n","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":"UdD7Cu4o2lYheuFW2O4KA","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"sb4uTvMIjAz_IiYl9snL4","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":"YskbkDYLAkOq7qqI1sSEK","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"PbjYeaMX49R--gOAOLj7U","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":"H6V37bKhmATRlHz0R1pBb","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":"1y53e7bscfWzzQPP9CB_6","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":"5oHRM8XKeOCU5k2UREt6Z","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"kW-dy1MH2nV-sUqdu2yk1","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"JHWsxE9L6i35in7xx7kaf","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"zquV_WHT0wnB9oIeMQluz","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":"heXgfni4OaN1bfl46zP94","name":"source","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"
The source texture object this sprite object is using
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"_b0lwgvbW4bHVIxAiZ4Rk","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":"hiLDSCV7Z76i9I1n9Uh3e","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Hjm_SKiDoNrABHVtP21mG","name":"type","brief":"","defaultValue":"\"Rectangle\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"EIRBq2TaHNGICFnZFeEe9","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":"F0zkI4H-czbkTqvfo-gDq","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the NineSliceSprite
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"yrHdoQxXeeJRP6uCO-iSD","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":"nMCA-duxvhonZQ_G6Pw8Y","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":"FUQm8FuOn_9txQDjYFOwK","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":"vC1qf0arSzarT9zxS-4SC","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":"ahX7DZYPOXIfboNU8rCyx","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":"Kby-TWN-vx45G67MhaMbV","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":"QYHCsltM9ogSE1OC6IhEa","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":"O-UsopyPL7lmwOnJIjr-u","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":"U48Z-T0K3VYBrv3GliKhY","name":"draw","brief":"","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":"TOzfEYX-Dz3XjpWM6sbgt","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":"fEggGVoorgUZ8MZFlG6nW","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":"R3nEk3gmATKCYnceqDOQU","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":"_netXC8Mlvv3U2y7UrRvp","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":"lBK0u5uW6xFnc4o0dh_yi","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":"zEvnhwXwYHeeA6Ot-0N7j","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":"os3v6op_ObCkxSLdtpX7S","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":"AVGZ8ohxzSgOwQN4LG0an","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":"J3tXCHWn21eGGOV-R9XuB","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":"0IhY7XHuyKktg-qo-tRvv","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":"q1iGvBMJsnSCV-pv5w6pa","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":"VcGtSW6UCSLRnloJ3YdVo","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":"H0XwqsFI8sIDXKcYt7e5K","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":"AQi8LIOlg2MHy7SUk1Drl","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":"jJIjfz3Qn-ElU1JhXfA_D","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","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"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":"fSZlfJlckyKrF177Nj5r3","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"OnDestroy Notification function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"vBDftxqY7uytiI7ioGRVI","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":"GMrsOG3SmIVswqr5mqT_F","name":"pause","brief":"play or resume the current animation or video
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Eajm_t_ofsS_oTCdQlrhh","name":"play","brief":"play or resume the current animation or video
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"D64pvf1_ulO0PB1MgeCNv","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":"7X18fTPCdzljQiRr4p93i","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":"nxPKb_LshqzuMFBYQiu3x","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":"_fg1XS4F5Xq2-OeRltz0f","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":"_-QDdsB5bz2J_zFTjfPF1","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":"p6biYahVEvpfnilSLNNOP","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":"JbWs9yBwAyjVtQU9a-pBI","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":"lAwz1cHA-KOJfD5OobrgB","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":"66d1TqaTcgd1_11cp3C8G","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":"DBczmHSToP7_b1I8haZU9","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":"vXeLYoQAHGuUQ0_qfbb2Q","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":"AAuU7l-3ewC_PMalsjiWV","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":"lUopXPrhUOpGWVMCyFSTg","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":"MDaRWq4ctzUSiqsLWAxeB","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":"OvNBvFIs3kXO0NUaBCPod","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":"huKF09CiBnhdRglJ9bbBE","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":"N0uyZ0I5B-j-NIwVv5V8H","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":"TK-VEDuKjlSFHc7aGru-f","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":"VVdkmLBPw00_h_3gnNWz5","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":"QqK75pxHMPzUwqRmcQp6S","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":"BROo9mpgLuoHECoowhqeU","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":"pxGO0j3No6jkEdtLqArJH","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":"-PtxoXQ-1ecdrJpHWvpda","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":"RlGAdStbQ01xwut8QjHJa","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":"017ivb8TcMu2YG8LaPak3","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":"bZK9ehTXfNq9RrojzkEBs","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":"FAAwMwdIWZYkZMTcxK2FL","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":"Z-rHDYzyeEFFM2fFCTBT1","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":"args","optional":true,"variadic":true,"description":"arguments to be passed when instantiating/reinitializing the object
","dataType":{"tokens":[{"value":"unknown","kind":"canonical"}],"template":"unknown"}}],"returns":[{"description":"the instance of the requested object
","dataType":{"tokens":[{"value":"object","kind":"canonical"}],"template":"object"}}],"extends":[],"implements":[]},{"id":"nZGObxMOdCMrmmk5n7NTV","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":"aRR5TzAXeiUWl7dK0etg4","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":"r4PrAW79-Cj5gKHaQO0E3","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":"bzc2PDH15J02TjjNeeoMI","name":"x","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"x value of the vector
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"lPCKrLwAJQ7MnXdddBwf4","name":"y","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"y value of the vector
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"hwWXekIFtw6GcJdsuvIe6","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":"fUgkSlWhN7341y0zjYct1","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":"s5QrK4ivLPKeFH-JJO8sp","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":"LaYDwUtLEwzSgRGi0Jxpd","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":"gkw4nCsLcoLpMUPmQZrx1","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":"5ngmX9EjwCKZIPV9h9AlA","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":"GkvGNGVmaIOqag4Zbvzdq","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":"YdBZWDMArmpT_mlHzcBxV","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":"3AkKCtPUGdrlGFGkF0sJy","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":"ZlKJYNFo0scu6u1jngErG","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":"kCtD8q1y2-5AfqRv6KkcK","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":"ap3cT-lywKP-2uiymJJEC","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":"BdfsF307gDH2hzzUHp20a","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":"2hIPF0-ixwbkPE1kx9iJ1","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":"XEvvWIcPW8anTeoklJteb","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":"2CTxe5fimCEDpX-4nCvVt","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":"RtOE3w_ixM06jz4mfn1_8","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":"mfZr2bUB5UPoLS4WYCxLs","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":"8RlshNLq-sklRb6Rsppu9","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":"orwimd1gkHEQJ68mBUvRk","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":"rKopkHFtW1st5xHl1EiH2","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":"QwFLYzXDT8fFlaDaDDgda","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":"FDtwlops8czNGavrCHWYb","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":"5EXGcbHkDz4saeYbz560x","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":"kt2NHBiO-LIUdVvDcHcZ2","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":"xCHSRpdWI4XrVP6b8epN7","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":"3K3YVFetdl-wkAZuR6MP8","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":"5cNP9U43OY86k__wAGLEk","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":"2tDe960iSdTG1gRbsMR-c","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":"1gFSipsc3NH432NTVAdNG","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":"TCrDbRx0nzqiOD9lpsm8L","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":"FeHGRM8r24_GUqrIpFUOf","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":"rUPee0DrYIwhJccbX0qAk","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":"8GwOZOwZbAv_dXzge1erH","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":"bNGlbh4BNAwiAZD1txqCp","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":"pRrNliJuDl5TFEzl-Ry_w","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":"xCViOPBa56xo0nabB1Lp_","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":"vH63hqTcazEB1l-fqgHj7","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":"qEoWf2DRydXUxMI_f1BL0","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":"Ty7YrvDCc4vn5tNwEL2gP","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":"ZOUrB1wJrnaDU7CyjfsSf","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":"us26AvnVcLipZnvBKnvvm","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":"b9LN9-eipBXxRCWDGWJpn","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":"JquN7BY5AX2TVS5j8e5aW","name":"x","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"x value of the vector
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"i83XxQ2p66q9j9MMlB6ht","name":"y","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"y value of the vector
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"6Nuej16t8aJd4o4EFVldn","name":"z","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"z value of the vector
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"2qgjgT-5_hk7A0sOZV_Xa","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":"o9ImUEkPJhuFzyZUVIu_I","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":"irrAQ5RE8T8ANfaQ-bfpA","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":"unlM2FIxSZ4jFIVsLa7h0","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":"mrF-5O4GY7x46D8jNhD-C","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":"e1_UoGSQ8z4S1UtlfMtBj","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":"0wj_te_6V43vE7N_cGdXH","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":"BP9HYAWdLWO62rKTCPW-x","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":"WeL8XVZL9zDxCnHa4DFNt","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":"fVqOnAuBei60cmPo70rsN","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":"1QLsjfNwLUp1AoGqSB6kb","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":"mLLdCbRKI0kFD0LX7zjIF","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":"h3YINYxWYMPV0xzKHV2Dw","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":"gEXYIl3BlVqJG4oqg413s","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":"iDzxY6mhjn5EZuVakmrNh","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":"ttv5Y-o8idq3Vla4QiwSL","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":"mRrZcDjhDxgnU3-liNTFl","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":"OPob9R-242b8vpDekAqta","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":"7r5dwzOttbtgu9RrPVD3k","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":"Cb2tsSjqJNKRNNWbUYi-g","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":"NDpJIJJS3SSeYbQWfdhMZ","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":"3cqb6Txo3GIkO2XvFSeTa","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":"RSD4aj_TEtKcJ4M1cEVAT","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":"VRWKCeXhILYm036R3rxWs","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":"YINWoa7UcCkpbPsKjVI4O","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":"_1auX6lAbC2rZsyRpAr21","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":"jeVvOQTpwu8-eZSZdhN67","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":"LH8hkKo4b2v-y0DftJYx-","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":"q96YJPALrTmV7XGXmP0So","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":"Y2OW9Yljtni4KGxdjzUbY","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":"DahXomwL27Ic2qHYgpTzp","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":"3gUr-1z26P4abYbuvND8j","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":"0mPH048-dViSZo_TqXRh6","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":"U7h6HgtnPRgqr4ANtd3Y4","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":"CTatNJht7vu3bbJwT8i8e","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":"4s9jd9ky_Jx2DkJszJyiy","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":"WxDHFZs2c4Bj_S8Ad6nbe","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":"BRR4BvgamHcdtYIGtfjFi","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":"znY0euNDm-FIjj4zLxwFI","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":"_LrB_sS3h9RslfDkTPlll","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":"pGLmivxXCehdpsAUBUjQP","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":"togb_3-8Lak7nI8ypclUt","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":"e5VXwRwa3cUtSV83j2A_t","name":"Particle","brief":"","type":"ClassDoc","description":"Single Particle Object.
","params":[],"returns":[],"extends":["Renderable"],"implements":[],"members":[{"id":"r70CgghFxQGt6Gc28BU9l","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":"HXQhocA1OJEWGJ5gzV3fy","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":"2g9iS2mHk0TSy61aiKISC","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":"qhu036wcUxyYCFlLHr-9A","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":"AXHtZXyvPJGX_W86eMZr6","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":"AUZs_yerpyEALPAfjvNdP","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":"BxUvTBDvCLN4gKoTdFrnR","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"hpsdklYqCCZ4RZUdQQEA0","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"zd2rGAwrPgFmw5-15cVZP","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"5LmKskyCU6rRKBDy_Niqg","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"oil4XQ_so46WGLFzXo6A5","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"LxVim-XaTyCxk3A_Cs_aa","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":"PXwrFZOil_LfCtEv1pLDy","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"
(G)ame (U)nique (Id)entifier"
height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Aql9CgLQBc4O-8WX7ARJp","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":"nB1JLOxc5lHfR2Icx2U6l","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":"nxfyB6R4MoV_mUkU7O-6r","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":"N4o7cLxhzCKi1si93idmd","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":"NuPXqh112z6P-Z9B6T7eR","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":"wa_kPgKmi3IKBWBLA2YRv","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":"tBlCXrsvDnizXVsUQLCiB","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"V0mrkrQetHyt_1D16N2ks","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"bquQ6eNS9K0taLP9HAfUg","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":"jo8DFebTjqTEzrIhVr2hM","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"2hI0eVStJW6o1ItF7vExl","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":"GES3jGK5cdeyz58UuG_l3","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":"MArf_VeUn-EtwlZYvBj_w","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"w7yXB1nY1r163ZdtikR3q","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"d3TEjVBorpFjGr2y3PiN0","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"qOevfcyHsIsjOUCZ3AKfZ","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":"H2vaF0jn5fBkmVwhb2fDb","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":"_e-99KTom5ohLbGyIUbvZ","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"q7-4lOLKeaB4JWOBGeqFl","name":"type","brief":"","defaultValue":"\"Rectangle\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"J9QOZJ8epqPydbUordYiF","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":"7_VFyKUlzx_LG8I407TaW","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"yh4D7dxALkLp-NEei50oD","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":"ktLZ4J80VL46epEZbtlLs","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":"fszUC-ex-m0_iI2od47gD","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":"xzY6u4d0VHJiYhWaDENZj","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":"jaKaiX3nQlrRokD_3gZ8X","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":"kEFGv1j0Zz6C44MeiQ3T0","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":"HTh4zducski0amurgfXt1","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":"LB3Jrq_k5P1kN2x2SiTMm","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":"YEguRVhT3dVTDzm6j-p_i","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":"THR5sIk16as-qbVeDQqeg","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":"SNwKGUIqkGgGYtsXF6tjp","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":"s1NIdFGFtfDO4asQgfbXd","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":"VGL8VWTkmFarHUneMv5RY","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":"WigFfpDQZE2bjdiY9GUTj","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":"Uh3ambwHbqSiPr5eAK2-h","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":"ZuV_1aCigupahFpzU_-N9","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":"kB39jeqppBSI5LHHKdFRS","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":"pobVb-98KewQ5ALZsAnLX","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":"sMXKJJMfIRD2TmXeFFpia","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","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"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":"eUkTPlwjIVpS6I2MQlW1P","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"OnDestroy Notification function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"tff8dZeDRj-B5Q9P0PgDE","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":"Uoy1hrD13pJarQttwjPWQ","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":"OiU_3WU7LHsVJRP-14Its","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":"Kl6UnSYD0GurGK5Hbo7rH","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":"jZD6haT8UI3SXXL-bkOLE","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":"aAYscHQs8LK5GZo5ibTg2","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":"a_sOyEAx_qkz7JJi1R8fH","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":"zAp3nHKW68E6OScFi-lf0","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":"25blONrREyhRSq-SwSyaC","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":"HchTXuMUpfmDzo9utuI4n","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":"yf3dxD9EebJaI_8bkenUR","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":"xfVM73Xb5i8wk1lrDmcUx","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":"sGq-fArGVYyjtaLUjQWxX","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":"SDf3BnLC1LmYFvNT1PUHm","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":"oCwCvoZ5VSSgjbqc4qT_H","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":"Ztem6YHEuXxxoH-s4VXzu","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":"Th3n9PIyjXluui7oW2G__","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":"AZsjIgA93tEj7iN7FM7d8","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":"eKHLCNMndZc_vYZI909vb","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":"cprSuqxgCyeAlUwQa-tET","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":"eFveIz9F5cifJ9BDFK4QD","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":"2125hEpvJi8QRhMRU-vNC","name":"ParticleEmitter","brief":"","type":"ClassDoc","description":"Particle Emitter Object.
","params":[],"returns":[],"extends":["Container"],"implements":[],"members":[{"id":"brxeAzZ7_nNH3tLlBLvpV","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":"9LSzgBai5K5OF1Bw8ncLx","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":"qexoBXjg8uIMwj7hgUHfS","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":"AFCRRFZHxO5dazs6cXAlh","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":"EjQIjVi82Erwjc3o4xYkp","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":"48oCjdrFGZyT3BASgZ43U","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":"C7RnD4XX8AcQq42nK2HNp","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":"EXhOvQYVnyY4Em0NzcxSp","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":"m4GoTbfW2nB7GIEZodplN","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":"nfGdRBWtulfFIfaGp-8OZ","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"_Z1q-VkJ7NEvXAlUTUJBR","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"5_Ewah3FJnleIJo-3qMtG","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"iNrZzWSNcIw2utXkYmvIL","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":"4uu4kzeADJwiHqd5KwcmT","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ZN2gndwFbtoBb6ZvV91YZ","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"uRJo4ABsI8m5h-Z72jNMi","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":"ev2iQz2EHNuHYRPzJOMZt","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":"CPiDSW6UZO5pdSTGSWIqC","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"
(G)ame (U)nique (Id)entifier"
height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ZrdcGpAgIRnxeCu6agYAQ","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":"nsRCOWTXv2x1_1cFS8XkC","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":"knS6Q8UkJZrl3_L_EPvBv","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":"BIuetoUo-QCOgyLr6y-cA","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":"e2281UGrJKHSNG0OBLNGI","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":"wyWHtk5rCLLNu22MWFnf7","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":"Y3clSLcowCdbgbIydkq-C","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"NaTLZWWbU52R1AOqzIrBk","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Pqwdw-K3Z0WepEODBINs4","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":"zG2TfprzSJ6kWdbPvycxu","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"XdupqAJ3pAPatpHNETmtd","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":"GZJpSTysMg1KhNx7soJrF","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":"QDO6jqNG9VawMgQE41_kd","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"_r4RS0wp32Bgg3LC23ENv","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"F3M8SO5beA_9wiOHxhbFZ","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"yglSqOsZ37CiMmv9NDvbq","name":"root","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"whether the container is the root of the scene
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"7PzTxEgm3U9siC3O7oA0m","name":"settings","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"the current (active) emitter settings
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ppkrMs7ziMLp_MnZfOQFX","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":"oyWiu3wSSRINh7vhLgVzp","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":"r-iDhAmIAeGCnw33bO-vC","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":"O9-4HcJNqRDXrk0Ep6-ZQ","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"wx5fFZcJx0WgnouxFyydu","name":"type","brief":"","defaultValue":"\"Rectangle\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"EuVM2hb1QJwGXTz7zdO0e","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":"a53jKG9Omgxaa-_VWmSWM","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"olKZ09UHQTpCxGKNUcK-W","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":"rasE0P41mI8dlstSpIK5y","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":"XSBLJzESnYOET6RRcbJZr","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":"a6rRdi06vF0GqefNeq3Xz","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":"3Y5PXXiVeQ0DplL-Pb94D","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":"gDniCHDe_-mSz3Q0_Dmcy","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":"MZ_4b7r0h74VLkTwYFhpW","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":"5G1gz1ykz6CzS3W3eGrvh","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":"-ecOAgcRqYFZtKqi2Yf8K","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":"1rS6bnzELa7-siZ55NBAF","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":"eHqxfzqK9G_uNtjpy25S_","name":"draw","brief":"","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":"RDpjmKEj70QRFlFDsmYki","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":"XOP2G0RKhq1o6ZOehMrNq","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":"W33raaFHK-1AwTPXbOT9R","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":"Ll3hKWV5gv88PCQlMq7Vn","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":"39HiUORRhQTvHQK6Of6q0","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":"oFhzSd9fipFadpYz8UZSN","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":"TODcHA-blFfgAA0roQrEU","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":"x2mLkTyxTyKol2KHIM7oq","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":"xasT4SOjUnHI0HZuhoiNq","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":"T_coIDSw1qTlBosHPeSq_","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":"FBry1ekv_ecyZ6UgBVXhy","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":"k8bSgeFxja3hegdfoAkuF","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":"eW1HTtIlKqMTJN74U0eQP","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":"Hob7rZgGnhFGdOKZSfEgb","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":"5EQAv3H9G3fBKr2zsNYUY","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":"YXBD9eIlHKG0OBkIHdwmw","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":"4KVxY00gYzuBTrtI692LY","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":"rm8INpkGYetXZmSpBKlCJ","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":"S1cdWwOS6LIIQDjyoyUOY","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":"IUPPIz4Fa5_ofaa-NWC4L","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":"wwvUHrEevjpY58A8DLRoU","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":"31xRcCSMuQlONdh5vUXbg","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":"Y77VVNXoFCGXH5kt4jcdi","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":"-KGkuFJ7EOvAM1LAFS_0l","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":"bR8tPcXXuoQCjFnRdiOzA","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":"Ynn3_GYi72R9mbgOHW9_W","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":"U89Jzb_r6yoXZKrb-vz6h","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":"ZahkidH6i2sp8Lz5ZuoC3","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":"AmPI-KphB6kYrW-_PmKaV","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":"KWmNyiPHLQfGt4Rl-LQL4","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":"TJKCLg6PS5zwJK3ZlPF0k","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","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"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":"W8Hg7wjVHzNvqK5VwUQLX","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"OnDestroy Notification function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"yUEDQvXObhGa1ocXy5kFx","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":"SyAmqFt71of7DKfh7wxsG","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":"H5S_qIgfDTVbyRN0--cQx","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":"Zd8G6RLrU8LVieMqd6BYT","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":"fNHYuQqLMx8_S_HFQFU3l","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":"Renderable | Sprite | Collectable | Trigger | Draggable | DropTarget | NineSliceSprite | ImageLayer | ColorLayer | Light2d | UIBaseElement | UISpriteElement | UITextButton | Text | BitmapText","kind":"canonical"},{"value":"Renderable","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"}},{"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":"Qu9ySsI80dqwySbIpAuy0","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":"TJNg4bmZOajOq3T73tMPR","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":"IyOXetWld8x0fbBEUfP4n","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":"jbcq2U66QuKYWT6mVj_Fs","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":"L34hq60pWkFor41YBlV7-","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":"hgU72JLrBJXlQ3ECiVEyd","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":"TGGNyeRnxAeXnPAJZfzXH","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":"QGpUC9g6Yj0jg_xyv3OY0","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":"bxmFdLcgoOP3Ztk7-1od7","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":"r3uC97J5SJHHsm8snggGQ","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":"3JDJ9c1EiryWry4kY0xmT","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":"4pYKjeyU4l5oSH1gcGxP0","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":"HvP4MLiVk39sLOBfwE-eg","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":"6BRl5J6OAxjef-4f_9g4c","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":"AV1TDxKJVJ7z06O5yaWuP","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":"pc--YO3zNwOfXqSjI5nRd","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":"PehOc11_fwPuEwRRJ87sO","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":"1uE5XLleb5v5gFr10F-ER","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":"oYQ5fiqrogRuK1FZN20SM","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":"04l5pA2SS55jPlKPE0vgF","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":"-BYDUqX1lW4yzPTplxFl-","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":"gIXID6qXoyWDii861mtrx","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":"emqbdlzIBFg6cG_Cxhda8","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":"rGzYyn5taICNEoYxjmK-N","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":"Ijpf_r_h4V9pz7Xu4FPTU","name":"Path2D","brief":"","type":"ClassDoc","description":"a simplified path2d implementation, supporting only one path
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"DmASK0hqa8vKzvWqH5C1t","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":"6s2jq2T4IbhmG1RbQhO7C","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"the points defining the current path
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"6909AM3kw6RKKzMBtw9LZ","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":"Jyp7n7oOXivmr6x6s_Xcq","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":"syEYqDxW7c4mv37sXoDuh","name":"beginPath","brief":"begin a new path
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"huzoIGIHU601rxFiCBVBk","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":"PMyBm6JC0MFf0Kor04pZg","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":"Ak5MYRcZXjeFzKvJ_vya5","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":"c5FMLHBtBGa7IFRYejIEJ","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":"FNhVnPZY0aVU0kf0ERpkW","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":"SaPAWC1G7HpYQWKu71UV7","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":"-YlX3wD8qKqxPOF0BvgF9","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":"ksNyrxg7MDkKaF1QbbchQ","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":"Nk786zy1LxYIigri2cCJb","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":"SSMjEBPAC5YglgsNNtbmh","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":"UplYXAFD7lvheLuVhTMBY","name":"Point","brief":"","type":"ClassDoc","description":"represents a point in a 2d space
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"HfI29nvmeYrG14nRhudHg","name":"type","brief":"","defaultValue":"\"Point\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"hReMW1sPR1JlNseVbpNuS","name":"x","brief":"","defaultValue":"0","scope":"instance","type":"PropertyDoc","description":"the position of the point on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"_3gez8zwldAocAZ8MBZjI","name":"y","brief":"","defaultValue":"0","scope":"instance","type":"PropertyDoc","description":"the position of the point on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"GIsDNU2mNhYMEleNWDyYi","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":"iSUVCBYLeBuME0G6d54Y_","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":"IwuchjnoAy24h6UHifzF5","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":"MSthBL5V_orLqz0E40Cix","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":"0SmPwyFv7FCs9XGDJ10YB","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"D1Pc1pzr6ltM59OvC1XxW","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":"6elUOfK0-sXjprF8ECwbs","name":"center","brief":"","scope":"instance","type":"PropertyDoc","description":"return the center position of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"0zkzN8kimFC35UxWLEmZ-","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"center position of the bound on the x axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"yDdGR1qdKzAf8DCB0KjNu","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"center position of the bound on the y axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"3cBLRT94TfRwVbb7WaRN9","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":"O6pWfJrqAd4mvd5OQ1Vm5","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":"Zvit8efinTi0yhftXe9zw","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":"5rEamx3U-r0Ub9ps1WDhG","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":"UpkCQCndYkuPxuJZmRzXt","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":"GqBDQfwYMoln2UoKJ9HnD","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":"gS4Us-AAZ-Hv755yriUNG","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":"Ctx2ZoATXwAXuxGVQa1h5","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":"swgC2LEFfcpxjt7YWXqOL","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":"2yDrPDGo1kOyeBrt8LFlg","name":"gameScreenX","brief":"","access":"public","defaultValue":"0","scope":"instance","type":"PropertyDoc","description":"Event X coordinate relative to the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"EpXO2x3VmOZ3fFPHhSVet","name":"gameScreenY","brief":"","access":"public","defaultValue":"0","scope":"instance","type":"PropertyDoc","description":"Event Y coordinate relative to the viewport
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"aiJyRAN0Fefwfj_XCFSKY","name":"gameWorldX","brief":"","access":"public","defaultValue":"0","scope":"instance","type":"PropertyDoc","description":"Event X coordinate relative to the map
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"2sm5YZfufT7GE0s570S95","name":"gameWorldY","brief":"","access":"public","defaultValue":"0","scope":"instance","type":"PropertyDoc","description":"Event Y coordinate relative to the map
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"du6FTmU-4yPSurFDaEYGL","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":"8DVqFek5zdGOr2qsvsXzO","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":"E5mfO1CVmX_MBElIVi8Pn","name":"height","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the bounds
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"p98XEt-qTail_GB4M7VxJ","name":"isNormalized","brief":"","access":"public","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"true if not originally a pointer event
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"b0kKmcYb-4Epa77Dlp6Ye","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":"dj00vw640AG70qzkguOWE","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"AEqoFBlxzeaYF53LqjE0S","name":"LEFT","brief":"","access":"public","defaultValue":"0","scope":"instance","type":"PropertyDoc","description":"constant for left button
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"zXjiAVV5DNZWjEDYOtBnA","name":"locked","brief":"","access":"public","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"true if the pointer is currently locked
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"XyUgzzqCh1bslm75t1wTj","name":"MIDDLE","brief":"","access":"public","defaultValue":"1","scope":"instance","type":"PropertyDoc","description":"constant for middle button
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"TSE8QkyJxrxGxpvdeKW8h","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":"Bx6VmUuEhbAjYx48kLaTr","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":"GLc-bXpTMzb3h3rB0lN8j","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":"kp2zVqwbEtNy21ffi-XSY","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":"Z9HoHsMauiYE9jqSZPPGN","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":"YWrmryKZCmkrO8LaG143F","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"5JhzrV2epArz4Cg6sLsWj","name":"RIGHT","brief":"","access":"public","defaultValue":"2","scope":"instance","type":"PropertyDoc","description":"constant for right button
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"WK11kbmgCHJKycDgSsMJL","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"RYLZjnPbeQ0HGIwPrx4hQ","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":"n5fFl7XCe7gv2LThzru5h","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the bounds
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"tG39ydNPZcX-RfTv0Zl99","name":"x","brief":"","scope":"instance","type":"PropertyDoc","description":"x position of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"kPcH9MyMz6X8-svsZMERD","name":"y","brief":"","scope":"instance","type":"PropertyDoc","description":"y position of the bounds
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"yMh23Z_LE1IgbdDg4ib-a","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":"Jkx0asSe71mXq7CcPkQeG","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":"Ryt4aK658NR5L6uJcYmQP","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":"eb-G6YZgEi-6geLr430xB","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":"bnHFSNEYoFleG-KjC-bXX","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":"iM_-Q1PTIJvApCpXiJI-b","name":"clear","brief":"reset the bound
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"NdwmgygthpMCOXAeupj3z","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":"eYL7tZDZFm77sq1dbzxa_","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":"N2QyiGNxfEcANPE9q22pv","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":"9F4DEjYf16GROJ7LX-urN","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":"y-XTVnxBPL-TajrBeiA79","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":"b3a9AcvQhCmA6CP8_VEdT","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":"BkxmT52LoNBtCVmTsiEf1","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":"ViYrM2q116C0qYXyXQXvs","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":"vW6skw7a2zoT3Yhsfnerb","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":"ckJmrEqOdp0T5H8lnjDJO","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":"P_Yvrs1wj6hLZaAKPZqHC","name":"Polygon","brief":"","type":"ClassDoc","description":"a polygon Object.
Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"uqjc3Izfeqk9FjpCD-HVb","name":"pos","brief":"","scope":"instance","type":"PropertyDoc","description":"
origin point of the Polygon
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"kkH1TKQtkdrNS29KY5Qvg","name":"type","brief":"","defaultValue":"\"Polygon\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"h9wKjd19MMLN0ahJ--KE1","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":"6070m44XEfmR0L4N_5pbf","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":"LKXRgkmrGDZ6vVAPPIaAR","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":"DtoC3J_OGuhnSbHEvZGC8","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":"Z1AMO8K9ArcVUtp8ASyJk","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":"NVipIm0oz1DZ-LQW79lMu","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":"EY1qlRUjVg2DcqLTvew3B","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":"u5CmA5b_G449otmZAAfmy","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":"Ddn8W5Z0qodgBUr36Cwob","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":"R1OFZhSYE8jKW5077id1S","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":"ygl58rEUhP-p43lYBeZpG","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":"XaelrQOIi7K6SojC2mpNk","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":"U8iXLMWBaP3f0JNxj7ch1","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":"Vi5W9nn9_06x-hp-fV0He","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":"IcUXaoLzXHUAPTA2mhTMv","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":"1tcC_ZPUKR9aouacFtrck","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":"MKaoCllxQQLH738n4iAWl","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":"-4hccPSR8fWD3NVtMajIV","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":"TtEfeSRAleqsfQ8oEDawN","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":"dJwgFL8tiJFs6io5xoVVY","name":"currentShader","brief":"","scope":"instance","type":"PropertyDoc","description":"the shader currently used by this compositor
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"xZlTM0maFSk29El9Htc3b","name":"defaultShader","brief":"","scope":"instance","type":"PropertyDoc","description":"the default shader created by this compositor
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"n2jUqk6xMhJo4ewx3OaFt","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":"Mr74jDeLjjUdS39vuHAni","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":"7py1G-oRP3ZtBalWDq_GL","name":"vertexData","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"the vertex data buffer used by this compositor
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"lFzqaOLHIuHkMEcoA_W2F","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":"ps3d5hCcSQdFoZ5YYjdXv","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":"ktWfEwul71m-zFUjLQGn5","name":"bind","brief":"called by the WebGL renderer when a compositor become the current one
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"VIdaG-9ATA5HHIA91jsZO","name":"constructor","brief":"","access":"public","scope":"instance","type":"MethodDoc","params":[],"returns":[]},{"id":"lBQLrhpz5UPdi6nCxpevG","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":"tOncbLOTaohW8zBWN64CX","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":"TJ7WHrVs_pROcndcCarE2","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":"qb5CUm9m7XDiLo7Ntk01O","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":"rhlNdyKoqyGyFmVI07vUF","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":"FKj9sgxatDsSS3dj8tQeF","name":"currentShader","brief":"","scope":"instance","type":"PropertyDoc","description":"the shader currently used by this compositor
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"XRoFuZtYuYBDvzl-P6YGt","name":"defaultShader","brief":"","scope":"instance","type":"PropertyDoc","description":"the default shader created by this compositor
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"QL63AA2G1yeuJCf4U2gqf","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":"T67kad62wyGm2DUoKYGK7","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":"NjoRvDG3u6Uufy4GieAc7","name":"vertexData","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"the vertex data buffer used by this compositor
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"n3g1AYA2Dtaw5-911VCdN","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":"qkVJRC5le6k7yTctiQjdU","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":"ZN9_Ce4Rw9kV6uxYlyxeE","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":"IUyhe3S2P2fd81GPWWvp9","name":"bind","brief":"called by the WebGL renderer when a compositor become the current one
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"PT01sjEm93HVFaV5N98tC","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":"DuW7kSHnbNO3EpQNuExOV","name":"constructor","brief":"","access":"public","scope":"instance","type":"MethodDoc","params":[],"returns":[]},{"id":"DIOLf4pLy49oRrOv2xEwS","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":"HEnpZU7qTRlL8Z9Cuo_RF","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":"VDs0S2z__Ftwf2FzZxThe","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":"g1FtgM_SvycORDW4_Vsrz","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":"FlwA4qUYS5yYyKmFTkPsW","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":"c9HV1-fRfPIloSfbpNjNa","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":"irxq0aTXFkc2sQAa4bTom","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":"LQwtKIBmFQ91jcwT80IAo","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":"od_UeQd8qtIKpY_z9LRoF","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":"Q4tyLqg8FY91tnGgsjClR","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":"3q3eSl4lT038nsWZmBbW0","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":"Bm_WUg7TZhV8YsPX82oqY","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":"c6yvB_FYEy4SMgRDX-KRb","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":"ycxwmMxAr-6-YzciZrCqn","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":"tP1hjatGFa7m4LSV60bqm","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":"H_4lhEUVYPxYLV6kEH_G4","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":"JEFgR0Bl-znmESug8KCjS","name":"Rect","brief":"","type":"ClassDoc","description":"a rectangle Object
","params":[],"returns":[],"extends":["Polygon"],"implements":[],"members":[{"id":"m-V-onXWCPe22g60NBbXo","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"_cp0PYBAVLelO6paxHT70","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"pSPVvcOUms7BoOnASCH_T","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Opuf8pN2FoMDpu8-Gtk-r","name":"height","brief":"","scope":"instance","type":"PropertyDoc","description":"height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"GddmYP0D7QKG-nX8hhR5V","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"CQd8HlmJSBaj8RXM-gEaj","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"fu4zz_XzzEa3p8l3SgxdA","name":"pos","brief":"","scope":"instance","type":"PropertyDoc","description":"
origin point of the Polygon
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"9LXU2gNibZoRSdhgaE2e3","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"OQAfDarLKA_CCTL8V83t7","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"eGj4asb_KwPkIqxSVlHtQ","name":"type","brief":"","defaultValue":"\"Rectangle\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"AXMyfAF5EnptPTcl20HdO","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"xqvrRNi126ElMYDvAeGb5","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":"WrWLtoEEw0M0UNmdDrtZb","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":"krv-nCAPQOG_ge1b-EzX1","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":"fITcn-0-bUgPHqqs2Qzzg","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":"PEdiES2U4SZTJJl3_Rsui","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":"p39fuxR7weZ3cgKCGuLzL","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":"vh6_Q-svSUPIa0TTDGq2M","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":"o5Rfuia68LPxWAnomj7OF","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":"3aePCRdPnB_4rNjgXPb6u","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":"hlVAvYiGE_AU5WgWsRufL","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":"pBQX7p_3IOZCAiDVOi47W","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":"C4cWSBC4xDzSmyW7X1FWL","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":"2f8uPVvzkvBcGBc7Z1yF5","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":"NLF8qP9v9UKrA_LlvHRaD","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":"sqdYr8l5WVZO1Ruj1G6zx","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":"t_lwtjEv8aRzXkSxzbXWL","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":"1WXNvCK7iSQDHuXqeMklT","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":"3MEAU0NQAhcAxg2YNd0K3","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":"a7bRnVNaLdaz5Y6209c_a","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":"0OADljdaiugwleVA-DBz4","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":"Tmu0CIf7U7LBSQjuPAghD","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":"mzXFv_xL1wcL98ieeJyEh","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":"Xorg_5irMT8UqpUojrDCr","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":"IxNXDLYLR7KkIPa_JYaCu","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":"rtRviLCUsXTgeApUtTDST","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":"_yLiNBqbarILbIT3VBGDM","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":"reN8YWp287CLR5Hf47RtH","name":"Renderable","brief":"","type":"ClassDoc","description":"A base class for renderable objects.
","params":[],"returns":[],"extends":["Rect"],"implements":[],"members":[{"id":"g_BsoLKfRYKsVd2g-6Yjp","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":"hKPRvjKwmxYFF8yFo8Dh5","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":"9VtxvPg4fRjY_6UVNtgu7","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":"xLXbx90L-Rj-lTMRj5-N6","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":"wE8TJSl-jpCRBNVo0nrGL","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":"VT-JIX8gqHoAchVpuaRhC","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":"n9_LrE3R6ehbmKu2L0LLL","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"PGHkDPNdqqHNRX8L___yG","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"7nwf3LkG5P2CD0RXYDZSu","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"XC4ws7wNLWxq_PQ8CcqRx","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"tTQ87Hc7rVSVLYtJV8AHU","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"FVnkXHDAGEIkBsNm3YhMe","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":"sBrSc4TC7lJ7r2KiIvN0E","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"
(G)ame (U)nique (Id)entifier"
height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"inMg2ebeWSYAkZSwVvwza","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":"B-IZByPb5DDQtNm3E-JCy","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":"VcKGTZpeseJd6aIEfgkvd","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":"zgLUiTiRrohC1Pct5GTz7","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":"QSHLYrBDT6JM17FZNUJPe","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":"J7eNM7lSP9miNeCzKkPib","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":"ZRJagNcZLj_v-ipRIgO-M","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"uLRch8yJcMY-w9VKaBiYM","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"9sxdTym0FWHpS_Q9hkqyo","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":"X2adheLOttWqv4tbnWykK","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"gvB17PnLOy4jTjmfkpsgt","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":"jtgL2bXDj2U_soX2UYzpr","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":"JE3CN-Z03GSIAXaDtNwyr","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"LZ5YXFS0e6x32pWFaxyXZ","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"7cgJYRjmXglbr1-EFueaZ","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ZsrNZ-h226S6_78FSO82L","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":"IIvM0SomP09Aqfk_rVBuM","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":"xjE0j-IpWfUKncrrzfl5M","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"BHtdTx_73c631S5hW-r0y","name":"type","brief":"","defaultValue":"\"Rectangle\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"IFb79HVHsSCltCSDyyROv","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":"9O--J8Lmmfoazxaiz_pI0","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ObBBcpZF-XsnFV-dIIEpA","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":"XhdfA9E0fAi0jiIEiWDs5","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":"N499-7smbJWRFEZG8QCLl","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":"RanX4-FeozTFMbbLf5abq","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":"DHkDIpipaz-AUhJsGVViw","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":"UmiJs_43BE4-k0jQ05uv7","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":"vgB8mfKD_cqykoLAwOyzL","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":"iVOly5Fg5t3Z_34Wd_-5I","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":"wJ_YmqiBnhg02WPt4UzAy","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":"n4eGZwv2nno2KRmB9E27Y","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":"4LFyPIcScbfwQ5JgWdjqQ","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":"jHN9Y6mV6L6cVWhN6r52q","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":"moXtW3CYR2dUqCfbu6CEm","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":"o7qRSNiFFjL9wAV22KbjM","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":"DoEyWqH41VOP7C55bnp0G","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":"jFjJQafdW2-D12VJwtY_J","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":"L6VipNDT8r33tB88DV7H0","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":"r8rAoTszr0vPt9GzIPSgT","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":"02dbSyC7GqYUcZBZH7L5h","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","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"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":"x8ys5wTLNz_rIjppkXxpf","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"OnDestroy Notification function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"S4l_8DkpQTP5tub0WNbh7","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":"zHa8zuiOjgWS60OTOAgzd","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":"nHLs-uepggboVcezTlm4s","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":"re0j588XoLLatcf75BYtc","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":"gAaqEf5QazV-A-n9Kf7To","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":"nX1kdLQJaTWRGwq52R4NZ","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":"pGIZk8RPU7AG3DmmkYFG7","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":"9tamsf80jzwIM9bf03bXH","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":"Ex5aa0iUWjgg-QiIb_35u","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":"MJZBmWCusYkneM4c1vewz","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":"1ny-KOAN3d96CQEvyyLvg","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":"LHkUJBeu434USWt1Hggtp","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":"plD7Ti45VK_rHVzOTcIDV","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":"3OWkMjbCb-yCuO_g1OLuK","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":"5kdhrkw5oFywFwJRaQsc2","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":"B7pZCd6kVRUb6FnWx97rS","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":"_-_dKdpjyEqXX1QAd8Car","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":"ouThkWmDNka78Jy7TR1XD","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":"33WajF9joGp9gfL_evtk-","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":"HImn-XaElRv8w6AQ2YpuZ","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":"wvsPbvc6TdoLAjTcKXx7x","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":"elYLD1xGGjx_8eWM7qC0a","name":"Renderer","brief":"","type":"ClassDoc","description":"a base renderer object
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"a_eYLmOlbbUNk1oX5uS_6","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":"dUcv3BS5tWXpIFJPFEeLo","name":"constructor","brief":"","access":"public","scope":"instance","type":"MethodDoc","params":[],"returns":[]}]},{"id":"NkAyVKHjbD03p5uECSe4I","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":"Jtia6nrZKCzQqhrGmUbYh","name":"constructor","brief":"","access":"public","scope":"instance","type":"MethodDoc","params":[],"returns":[]}]},{"id":"uXj0Nnt8T0NwV1e7bIQE7","name":"depthTest","brief":"","defaultValue":"\"sorting\"","scope":"instance","type":"PropertyDoc","description":"the default method to sort object ("sorting", "z-buffer")
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"-5jnFMEaFTcWtABiGH2gf","name":"designRatio","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"the requested video size ratio
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"RWaulBGm19opVQq9Cg7m1","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":"RmMVTI5ac4PM-QK1kC0pR","name":"isContextValid","brief":"","defaultValue":"true","scope":"instance","type":"PropertyDoc","description":"true if the current rendering context is valid
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Ajnk8v6AnsGF8yb5bPhKd","name":"path2D","brief":"","scope":"instance","type":"PropertyDoc","description":"The Path2D instance used by the renderer to draw primitives
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Pxg18Xu3pPd6kcbc18j2v","name":"renderTarget","brief":"","scope":"instance","type":"PropertyDoc","description":"The renderer renderTarget
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"lk34N2t_6z7eWLLXG6Ypb","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":"xfOWCmU5-OXtKMzV8CYhu","name":"settings","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"The given constructor options
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"80Kt-BP2jOMLRJ53A3sM6","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":"hoS0NpR9UIE6VkE41LCJc","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":"s_pPkWoQXneFrUMFmLn5s","name":"clear","brief":"prepare the framebuffer for drawing a new frame
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"jXVq7ejDUYKOouJHnCbtI","name":"clearMask","brief":"","scope":"instance","see":["Renderer#setMask"],"type":"MethodDoc","description":"disable (remove) the rendering mask set through setMask.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"jHpQcdH9tgIaH_wN3Shsk","name":"clearTint","brief":"","scope":"instance","see":["Renderer#setTint"],"type":"MethodDoc","description":"clear the rendering tint set through setTint.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Z8k9UAoayrmRo0d45Rkic","name":"constructor","brief":"","scope":"instance","type":"MethodDoc","params":[{"identifier":"options","optional":true,"description":"optional parameters for the renderer
","dataType":{"tokens":[{"value":"ApplicationSettings","kind":"canonical"},{"value":"ApplicationSettings","kind":"link"}],"template":"%1"}}],"returns":[],"extends":[],"implements":[]},{"id":"evGsg0PP0z1DQLPAgHOeo","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":"wUMxAXpy0h7RWWyj6iII8","name":"flush","brief":"render the main framebuffer on screen
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"kSP9JCbXPuBWDYWJdhAV6","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":"tmd7IJOeRASXZxnM8V4la","name":"getCanvas","brief":"","scope":"instance","type":"MethodDoc","description":"return a reference to the current render target corresponding canvas which this renderer draws to
","params":[],"returns":[{"dataType":{"tokens":[{"value":"HTMLCanvasElement","kind":"canonical"},{"value":"HTMLCanvasElement","kind":"canonical"}],"template":"%1"}}],"extends":[],"implements":[]},{"id":"nRM-vPDu9-is51GdST7ra","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":"BNj2XNqEP2R4G2EEc1LQA","name":"getContext","brief":"","scope":"instance","type":"MethodDoc","description":"return a reference to the current render target 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":"T_8CgEJDeG3PvQxrR0DQm","name":"getHeight","brief":"","access":"public","deprecated":"since 15.12.0","scope":"instance","see":["height"],"type":"MethodDoc","description":"return the height of the system Canvas
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"pa5j7Qb281-NIJ-wI42ME","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":"VSu6YqCX44-DRo4q8Ml1T","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":"Dkma5XaqByrRfXeDVHqNX","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":"2fSFYJ7cJDiHJNxB9iEzM","name":"reset","brief":"Reset context state
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"iUgXcFeZAHZZH_oaLt4u0","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":"4CpOyJOEhS6_N8umTqfkt","name":"setAntiAlias","brief":"","scope":"instance","type":"MethodDoc","description":"enable/disable image smoothing (scaling interpolation) for the current render target
","params":[{"identifier":"enable","optional":true,"default":"false","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"Jf6HdeIlFerAe60uU4Isg","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":"U7L7eY97vR0KqjsQEUe-K","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":"G7Te-uLAmf7o963F4o2Hp","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":"jt_i8qSohjO5VUgQovrwX","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":"KnvGlytSTHqK-AWsuO1Wh","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 or offscreencanvas (if supported) 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":"yb8ZlloQIFkX7wkCErF0E","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":"94wdhfYF29phEc9UtqMSu","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":"rzdwV185QzR0xB0f1so9t","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":"mJPiicFaC_F_dz3WYyHSM","name":"ResponseObject","brief":"","access":"public","type":"ClassDoc","description":"An object representing the result of an intersection.
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"SZddMnCz0kifqPG41GJmy","name":"a","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"The first object participating in the intersection
"},{"id":"IyBPmXAOe7DpHbPj91Lht","name":"aInB","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"Whether the first object is entirely inside the second
"},{"id":"dtefYQH6odo6wrSl3khdW","name":"b","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"The second object participating in the intersection
"},{"id":"x7_1Ekxpr9hsXHmkYEOKD","name":"bInA","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"Whether the second object is entirely inside the first
"},{"id":"S4TSPfePGbn18pgoTpbYT","name":"indexShapeA","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"The index of the colliding shape for the object a body
"},{"id":"SR4GS5IBk12ygm-nj9reV","name":"indexShapeB","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"The index of the colliding shape for the object b body
"},{"id":"6i6DGYflkIyQjSYSUtr9V","name":"overlap","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"Magnitude of the overlap on the shortest colliding axis
"},{"id":"b944zyP8IrfoDKz5Ogo0U","name":"overlapN","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"The shortest colliding axis (unit-vector)
"},{"id":"g5xjUSpe3TbR9OAT2a5u-","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":"7qZLe9uBQ5xxGDFaUxhgm","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":"iejlIkicBYkPftbxV7g3-","name":"RoundRect","brief":"","type":"ClassDoc","description":"a rectangle object with rounded corners
","params":[],"returns":[],"extends":["Rect"],"implements":[],"members":[{"id":"0kz4msIF-tTGG0VymwnbE","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"WKDpqVDDWkpwEZ5QSa-6v","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"DlYLFTMuRh6248Fk81aas","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Q5IJtd_UVFpvUAnlDNwxC","name":"height","brief":"","scope":"instance","type":"PropertyDoc","description":"height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"5OLbp04K_ZnNCEwsswSCg","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"5G8mwMrO7zusrEn-wgse1","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Q2P4untG91wKso9RGPJH4","name":"pos","brief":"","scope":"instance","type":"PropertyDoc","description":"
origin point of the Polygon
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"vPFsRjm_z4ACyGPMvOvf1","name":"radius","brief":"","defaultValue":"20","scope":"instance","type":"PropertyDoc","description":"the radius of the rounded corner
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"M11Cadtst-9AueJZRmuZv","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"wzgZD33NR8BlqV0LbFMdu","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"4WYBk89n6xAxP6tG5aXe9","name":"type","brief":"","defaultValue":"\"RoundRect\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"3oQH_j6eBWqc5A9BRuHsH","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"4oNZKJy1fnyqBQ6v04bGN","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":"ZCjFMBqOm8AtByL-ri6cx","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":"o0DmWaHkfScP7bv5ECi5F","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":"LZ7SkE2AnBrqsouMq1880","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":"g_lEX18qD1-Law3V7Bjlm","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":"avuT2prfMe1ozEY5vZ1Y5","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":"FB29yPkzAHrSA54Y3BuOr","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":"TphLP3F0ikJjRXbDod6xA","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":"7mjm_U6BDg4tflYXj3lXN","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":"PbNZ5bHnJOKihSxN6kqzL","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":"UC8bSialsEROe6jjHONDC","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":"UCFblNUacGttAB-4RYqyd","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":"GJzlNpsJsECygQfhbcGzJ","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":"aGMxfsQBJMj2a9NpfLY6l","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":"zNSpCL-L0dpRyGR34MSd_","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":"McukPXlpt6mooTlv55un9","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":"Z4BHYRjZDxtA8fWrF4AOG","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":"VDBLi-p45esNcoxYoFxCe","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":"LYs3hqyAwnNtObRHuY8QH","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":"Ft9Vy9yaWdDz-pI7fF9rn","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":"NfJl2CJmqsAbkSUqvfHLX","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":"jjgFgb45AdMpjgSQn-bOi","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":"SuIxAhA8eyzoJhu_op6aE","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":"p6YECO528s7if2RUsGmZM","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":"5SvA8Kuy3_hK8aYnCRIyD","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":"RMk-Ka4KT9PaTrFePLJmn","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":"e19DsobpgY634ZOvjFZp8","name":"Sprite","brief":"","type":"ClassDoc","description":"An object to display a fixed or animated sprite on screen.
","params":[],"returns":[],"extends":["Renderable"],"implements":[],"members":[{"id":"fPT_NQoT9Xxk5glrYBUrZ","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":"rKar68d7ktG6-R0L96EK0","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":"ODsSOIH5GvPgasB6wVGUO","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":"HiVArFxoxamMQrNS1SRrv","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":"VPpg0SIKtdN9JtvT7Rszh","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":"yQeLocPKBDYJ16B03Hs5a","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":"2nHuVp3ywCpgptA2ckKC7","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":"Es8kGG7wUlRpVMIIPmZuW","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"bPr4Fgu9Ia_A3b22ola0E","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"9qvzVUTCCFEpEiKd3Joxa","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"93J1wDDt51VFEP1iON98b","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"MkBgy2Dqu-7Gsm5SH0EK0","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"_lfsYjyIZAS1Mai3xWaiU","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":"HNaHhzJqxj71_iQ2FeLzb","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"
(G)ame (U)nique (Id)entifier"
height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"tcG-46X2fePYPbo3rHyng","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":"a47maq9f5sXaqnU9VzxYB","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":"iJvXXMco5udkTd3QLaCcY","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":"bASEoCgkXxr2zSB0T1mJe","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":"aiT1ldsqQ4JPrL9wI2q_U","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":"zzVhzpHYIm_6pcFdWm286","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":"bHiQobQ8sHeIaLkzB-sWW","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"vRrTbjtUhsN1iiQuHurE8","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":"A0LZmb579sVMLGrE9KcKR","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"1lIqM_DCJ2TRFMcLzaDdZ","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":"wENJyUZjyTyorurtLeoih","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"-ib4dPFjIEd-OwTogwBRQ","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":"jUHMk_JkYysJdwe04Vki7","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":"le3BLT3QaDpoeF-kqjkUm","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":"cEqTcFW9qUMv-NQ8w1Xjd","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"QUeXjIJsuqieyJ0RfUnnG","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"VcZDruF0hZ1XnhHOXpPPL","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"lP77_yxcyi3eSxU-WDm0b","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":"MUnr1OHX9IRp8xl1YJUba","name":"source","brief":"","defaultValue":"undefined","scope":"instance","type":"PropertyDoc","description":"
The source texture object this sprite object is using
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"7x-ksIARCaZaCujGd0CBm","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":"eNkjnW9wV9aO9QTgNS-eQ","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"nPtBE48pRBOiC4wXhh2jW","name":"type","brief":"","defaultValue":"\"Rectangle\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"oq9sqloMyw3PW-49ns_cq","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":"wZiEdJ5tTOj8i6rivG8aa","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"UBrx7eIVziZE97WmPNJsD","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":"w9DjBx9YRAquZ09XVHc3u","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":"_rmDZSbOEj5FMYvGl_9KS","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":"lDQQtIrZvPDfw8z6tJpjY","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":"NiU3LI5Rs8rgXRuLHnocf","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":"xx_mnAG3MBpYGDHMp-he-","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":"FMrqdQWy-lfbcDe0PQey1","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":"pX4rD0aq88z6uAx6nvrhI","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":"1Xhmz4j9CMJdWEz1XjSgU","name":"draw","brief":"","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":"dESK8DnlwxkNvud52zyd2","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":"Vxw7Spb30KbUcNkC1E4CT","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":"fAaAQZyqRYrOTo5612l7Z","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":"mBhMSqN4fHm8ARj8dh20v","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":"QrOFpE1HVXLowhHOpPKWL","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":"yf3x2qRshgKUaKZdHVTBX","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":"rE0EuLK0FoAfu9ig27wUX","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":"ldZTExkhgurpqDanaqrUA","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":"Qs7NQLTQNrumx32fJljFz","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":"b5B1YFz8ctZUvgBaC3RK3","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":"hrKfjkbnxK6IeL2koU6hO","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":"FYDNp6xK_fpAGxZ7LXWlT","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":"s003nu-m9j4fIl2mYMQQ6","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":"yMQyFrx21uJ_63FGwJxQ4","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":"UziLLOKtNhMWdZ580g9Lo","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","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"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":"zQ7AI7arOOYrBeOJLugSs","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"OnDestroy Notification function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"CA16mwK1xaNrhKV5f7dpE","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":"jRAi31PemdIqMTLx5GxCR","name":"pause","brief":"play or resume the current animation or video
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"l0Zu1fXNMRKLoJujzkC8K","name":"play","brief":"play or resume the current animation or video
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"bkNZ1AIa2G3FOlPvzScVJ","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":"o4hTsA93qIHtN_aWPjH2i","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":"-XiE06hkD2LvPLxZ6UvlD","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":"7czfa8Uu23K210Deux6hb","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":"Hyu8s4qJv8ZlwXqaPJo-X","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":"ldGwah-7rKesZylh8eB1f","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":"ZvQ-alvpFcZW-LRqFcGDK","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":"J0DBHF4sqtk4ejqyHZurW","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":"SkzEyj0EQM8e0FXT08NX-","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":"ws1HpNmAN6lOO0GXdS20g","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":"XKclf4_9eJRonQr97TF3s","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":"VrC9-Cvpww2Mdc6j5pdJV","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":"KW-sRa4sm9wXM6e5qkytV","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":"qSUTU-CQ9U0IFPl2d-WC2","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":"_AQLWTtnxQbdJJKjzJdDW","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":"7h0eYd6JFKESYGUdstEEL","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":"X19L_w0T_4pFnCiCuSJtW","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":"wDIZdtq5fyloVIHdQb2Xx","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":"L3KSclUUDtlNpsRNjC6Cg","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":"DOZpERT4QHTZglripDi6X","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":"dbgdtY-JMOiOhoiuxFpTC","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":"PmjRBkWKdBcIeCBGhKWy-","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":"vxGqkTHVAo7BVLCTdlti1","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":"itDRVZQvp3ewtYx3n3z4M","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":"YRuTnIt7otW7bebzWFtQH","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":"EkxaCEoReKMqFFqiXZkxm","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":"AEk7Qn3HcAjGRsmMJTFKd","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":"_hx9Hx431fuESR-R57Nom","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":"TBmtYwtf2oMETDTHk0K6E","name":"settings","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"The given constructor options
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"I1acnkL_UeRxwl1cYugFB","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":"PeknOkMnOCy8r2ALQzASK","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"onDestroyEvent function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"hOnFuPc_KVm9R5_pIFZ16","name":"onResetEvent","brief":"","scope":"instance","see":["state#change"],"type":"MethodDoc","description":"onResetEvent function
optional arguments passed when switching state
","dataType":{"tokens":[{"value":"unknown","kind":"canonical"}],"template":"unknown"}}],"returns":[],"extends":[],"implements":[]}]},{"id":"nxEj-sh64UItPu8xfpFrI","name":"Text","brief":"","type":"ClassDoc","description":"a generic system font object.
","params":[],"returns":[],"extends":["Renderable"],"implements":[],"members":[{"id":"wiwTtt9jASUsGZQ1vtCp-","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":"rp2KpjeegFYleGtWNUK8e","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":"W32Nv4NL-Ogu-mCNHy9r6","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":"uXJFCTMbK6BH00WhigwAC","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":"W1KYPb0hcf1KsfD5Zm7K_","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":"3eQfx0jwqmjUvBQcrHe86","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":"c3Z9KfHhdA2xiLoe9BJFx","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"xfacxVCaGdlwmx9ann-g3","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"S_p0cYbq93Gt6j9rYsfcX","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"fJwZ0ofMFnYLjR0GBZ5Sh","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"QYIxvKtqVN6YNzUNOc2BL","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"JHDLeSs5sgzKfoDt9KAli","name":"fillStyle","brief":"","defaultValue":"black","scope":"instance","type":"PropertyDoc","description":"defines the color used to draw the font.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"bXnkadce8GwG8v57HElHk","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":"fnGNSJzVUzi0D0FnRaXXD","name":"fontSize","brief":"","defaultValue":"10","scope":"instance","type":"PropertyDoc","description":"
the font size (in px)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"pMVDXCvLyDGzFXhvulBT9","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"(G)ame (U)nique (Id)entifier"
height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"gQ30PJxaffafOsk9Z3wp3","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":"hTpXC7OsL_pyymm-hnTTM","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":"9J8-FLuReS2a6q58eC0ET","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":"bJLdnFb43zUq_eFscNnI2","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":"1vT6O9m_bvVjj1PkI7qRg","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":"TqIDyeW38gXH3BRnLh8tW","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":"m83RCJxrMO_tN8K-jXPta","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"9bx-VH0O_gMyTxPps2SLs","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"MO8hEhRO4UC6L1hojJDtt","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":"iLoPa7Ezv77KCHdwBM8vP","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":"1SnoPexPdaoGDEoM_waWM","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"N4nHFth8koinGzI16_hhT","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":"kQOvtgkL372Of8RkdyX2B","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":"Kr0F0pqqhkHP6LciKx3ZU","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"bq14AgCk03nqI7QR9mA4U","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"IuG9yQ2q2J-rmmCNsb2Ei","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"x52Z_RQR7u_LheDxCAfGN","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":"3fp1LXsejhXR49R_E8CKl","name":"strokeStyle","brief":"","defaultValue":"black","scope":"instance","type":"PropertyDoc","description":"
defines the color used to draw the font stroke.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"J4HKmEHxJwl-cxxG_1Xya","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":"-yACGNzf-ew8mtInllgzO","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"HZVKUGnuE0altCJCCiGcQ","name":"type","brief":"","defaultValue":"\"Rectangle\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"N5fIs6K1R3OFOhrobssl9","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":"TwfQa6n7cQD4mj9UMfE3d","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ZF9Z5HMgJYAzGOaCICE8J","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":"78DQyA2y5TU3WApUShs2g","name":"_text","brief":"","access":"private","scope":"instance","type":"PropertyDoc","description":"the text to be displayed
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"khQlBiFYExEZ5U-YHP6F9","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":"9cL42wgbvs4fbOAltoblP","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":"Jry3YKjfe9mFeyQ1YHRlU","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":"PFhCerWjQSWP46jHWVxQV","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":"asqTfy_mTJWjLdM7mpLxO","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":"MnqCrtz-7rrNI3t9j2ivw","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":"WPQwhNByZqDWdeQFPs86R","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":"KfE7LaQoAaP2cAEM1dnl2","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":"bvwXecwZZvDRuzChSvJb1","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":"1bVlNs_VtHsn63eFpPFn7","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":"7_Q8yt4_q727pdZQkWB4R","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":"eglGlEetwVwD7BUwWnHye","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":"BWJgXCjhtFfR1auDea1mc","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":"frIiBeNiZB2chUPzipcum","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":"c-bNfR4lT0JDgAe3rt2RU","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":"1qaDbg44_tiI0WlBrEm_C","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":"LZ7KZVKmZQ0xW_5KMZDFH","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":"uawOWY1RxPtDxq4_JUszX","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":"dvFXz6YXnLlKHkGrc8brF","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":"_f7o5GsC2hV9wat06OY6Z","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":"zp6folcswT56WnMUM624o","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":"B9IBav55AVwcj_nLUoeoq","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":"510PWLUA8ysni99UBg72F","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","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"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":"vCaJ8Ze981PZdO-ifu4ty","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"OnDestroy Notification function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"VMBatlbYZ0_7IZkM0Pgum","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":"x1LqESFgF25W5H458IxSV","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":"wOR8n99xhjfG-w07dlylk","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":"-LfL0Q7pqekuJpah1wr7U","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":"lCNjM4vneVcuRZXxLkQgg","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":"Yjyj0lwI_pwNZl9Y1AxZi","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":"gF9Gllw-bxgGvxD3xrfJ_","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":"g9i50PhfxMkUMvO7rsUau","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":"-JU0TRk7H5sYTqWZ_JazD","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":"au6QPZAJDjaQ7dwBc5qu0","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":"F_QyS7IkGxsQouSbU9-Z2","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":"9pGhPSWgaeuhJCjTWLdg-","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":"7vgK01XWgqQk_6mB_QwJT","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":"5dqSj479xM_Y_NgKS7l-M","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":"OqDWfcvlpgoVCBjggynD5","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":"BYt1OJezyCo1bql_tykgi","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":"_21V3CMshMXfJWR1KKpsl","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":"O6oR4qVL6PD8FQfBGn4Ei","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":"jPmN0H5jKmmpd-fHGN6hP","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":"rI-8zIN0o0ydkPGcGT_uX","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":"hhFGGU8FQRkeuJJhTUBpL","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":"NHs_Ol--JkGkIIPHci1Ps","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":"5UQlUvoxUcNcKTACz6RJk","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":"bcGUTUG0MfvP0PBxpHiYW","name":"TextMetrics","brief":"","type":"ClassDoc","description":"a Text Metrics object that contains helper for text manipulation
","params":[],"returns":[],"extends":["Bounds"],"implements":[],"members":[{"id":"GRz0A-TWBmPYhQZkDv132","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":"ioxhbxfQCax9XWk7aUJMI","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"apIzsp1KOXgIDxUTLGhL2","name":"center","brief":"","scope":"instance","type":"PropertyDoc","description":"return the center position of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"anbA_5mWRs-MLAr1t4Nbh","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"center position of the bound on the x axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"buCoo3pndLL7HUM1TmSIM","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"center position of the bound on the y axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Ffjd9ngyN0Zm_8ayvuzko","name":"height","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the bounds
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"l5miYtlsLn8UwTLia-coJ","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Q9FltxS7YXKMjLwk587Cy","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"vMCH4d20XBZF54wgc_A8a","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"cvDokkr7kchQIXBeklf8P","name":"type","brief":"","defaultValue":"\"Bounds\"","scope":"instance","type":"PropertyDoc","description":"the object type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"C9Xru-f-wip3iIZNj_Qv9","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the bounds
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"r-A7RfMd03bSbVq6CrM09","name":"x","brief":"","scope":"instance","type":"PropertyDoc","description":"x position of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"RtaQbWbNSpy8TS8HbnCy2","name":"y","brief":"","scope":"instance","type":"PropertyDoc","description":"y position of the bounds
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"BAFnqEb3UMUJ7ciEj7Z3z","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":"fYrliKKG9Dar2MgGGia_5","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":"ZKfGnpblw34PDcIG8sur5","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":"wO5Zr4X8fkVMOBCLRgTBa","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":"LqxgH0Y2y2soBqhS4TccX","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":"70tacM0O7-z5WB7QZw242","name":"clear","brief":"reset the bound
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"_TDUtCTIV8W4-mIcHdivl","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":"UF-AzmL5D4i_FU6zC5XLa","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":"TDplVIxQm68LvCmuloLK-","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":"0UqIzmlSCM-LhANMrDPE-","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":"IIxtJNeWnDF4KGaP1XkVq","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":"04Jb60EFelV7N7IAIYEbg","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":"COLGgMtZ9OWbNJ7oNyUpY","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":"kJIV1XgiiJJRnWGGwE7E_","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":"127x_yDiYlSt5AB3sThS6","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":"HVJeLQCxue6_IA8sshpUD","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":"WFDbHtVWCa_ojiNNLq0tN","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":"-I2KE8uZo7JTptg2l01Ds","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":"WtUZhmMhdBJta0JrNKxrs","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":"2W-4Q1OGtkzgNuokYjSUL","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":"FTIZuIjmWYcD23GWz7179","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":"cmL_ggJI3y0JEPmk8km8L","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":"5_KIV1jpUNs0U3Fij9v-3","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":"r2tNsCOSYYbfNUGlKhE35","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":"TqnAF_P1qtL1YDCbyq0P4","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":"wyHZT5c8472LOVCeNHpU5","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":"XVnsCt6Dbcmd3J4NVA1SO","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":"zUFigxdwTyFYp9TJ_7RMA","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":"jS4Dir0G-KIvnXuW1ZbfI","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":"ThIdPome2Z6eGiaMy9M1q","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":"Iub05UIXGrySYnrhn5qO0","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":"hUYiy8XUU2lMm6OIjcyC9","name":"Tile","brief":"","type":"ClassDoc","description":"a basic tile object
","params":[],"returns":[],"extends":["Bounds"],"implements":[],"members":[{"id":"HGRahDizCmZ7N6SVcC1as","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"RZqZIwZqDA4TRMPUkR6pn","name":"center","brief":"","scope":"instance","type":"PropertyDoc","description":"return the center position of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"2EsAj_6hoQ7xh-npP1Qs2","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"center position of the bound on the x axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"BV6p2dldS3I1M-zf8c6kb","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"center position of the bound on the y axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Deivd_idRZIXg-dkYE9Z-","name":"flipped","brief":"","scope":"instance","type":"PropertyDoc","description":"Global flag that indicates if the tile is flipped
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"mjCYrwDwaW44Jy4iTHU4y","name":"flippedAD","brief":"","scope":"instance","type":"PropertyDoc","description":"True if the tile is flipped anti-diagonally
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"POBQQlOEKeJEpUS3nDBvW","name":"flippedX","brief":"","scope":"instance","type":"PropertyDoc","description":"True if the tile is flipped horizontally
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"7DlF9Lv6ozvqmNHEOLTC8","name":"flippedY","brief":"","scope":"instance","type":"PropertyDoc","description":"True if the tile is flipped vertically
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"RJk1KBDPvsKpiyuTLeLul","name":"height","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the bounds
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"dlKIQ33ajfg-nJ3Qn1isO","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Mjhr5qIcnV-So26r-ZYjG","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"FCFV47wQFJGLydNUevWu_","name":"tileId","brief":"","scope":"instance","type":"PropertyDoc","description":"tileId
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"qqGq7p5vHsyOeudNP0mzb","name":"tileset","brief":"","scope":"instance","type":"PropertyDoc","description":"tileset
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Bym_p7Sp387ab88O8B4AS","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"lEXGIYaYFvcEfAKK7B3Dt","name":"type","brief":"","defaultValue":"\"Bounds\"","scope":"instance","type":"PropertyDoc","description":"the object type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"L24zvZzipiYRPims2eJ6h","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the bounds
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"2s24efizUH5TB5TEanKs8","name":"x","brief":"","scope":"instance","type":"PropertyDoc","description":"x position of the bound
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"NpkvqeE13qwV-8Kuwo7Jv","name":"y","brief":"","scope":"instance","type":"PropertyDoc","description":"y position of the bounds
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"wkNP1loISJbofiULLU1nL","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":"NAUlhb0BNxCCfZg7VLGKN","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":"3I_ENMZm6qgwR6lrY1tdE","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":"1WmYtIOQv2aMMWW2PYuPc","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":"4XjY94phod-z5s_6XdCmi","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":"KkqO0PNucNpEFmoIx9Hgl","name":"clear","brief":"reset the bound
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"g_H0oYmuYRDnKb7qpirmm","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":"7bCYsFn3cQFTLYtFiZKLz","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":"OvVxwKLFKqsE9ZLi64GPC","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":"NgJ8D0iJBTF8l4uD6GqvW","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":"fv9A7BJVVrxkR9llss9G7","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":"KuK9F4J7DgV28STC9RR5i","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":"eq5uskqfegsoWHZMyXgil","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":"y9M125lyd283wMuLazjdP","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":"7QgODFI8bzJCrjJ6oFNzO","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":"VejfVBb57jSeFKdlkkvoS","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":"xxuI4Pc5QVjOwERuzlRx7","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":"2L-Fn2wI38rZmpgBpAd3c","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":"d_1znf8sjq-5ki-8PPARE","name":"fps","brief":"","access":"public","defaultValue":"0","scope":"instance","type":"PropertyDoc","description":"Last measured fps rate.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"52EKLd3Fg8EWm4IRIsrbT","name":"interpolation","brief":"","defaultValue":"false","scope":"instance","see":["tick"],"type":"PropertyDoc","description":"Enable/disable frame interpolation
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"8rEwpykg8tj5GExg9_8jW","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":"MAz44lpKDlIgQdO64S1AO","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":"HRddw8vvKTFeBTrNmkuiE","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":"s6YsdkErolR6d1NDekwCD","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":"T8YdgJIUFa3gZSpu4TJC7","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":"d7Q0lsfOlMUxp9dfTGiJ8","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":"PB3ZXuaU3VlhzBHurcASr","name":"TMXHexagonalRenderer","brief":"","type":"ClassDoc","description":"
an Hexagonal Map Renderder
","params":[],"returns":[],"extends":["TMXRenderer"],"implements":[],"members":[{"id":"NkRHo3ETkbh3JU8QLKPbx","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":"i8ttFpS1KfowOmw4OzMeW","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":"sd9XUjYrZwHwzWMrIuL3O","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":"pM4YTShBJK8uHoOVa1zS6","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":"TA9ByJ8YEtI_k1a7RV764","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":"eSfSuye9AVN3sQrWLyr3j","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":"DPKDkorfkGj06be7_x9uY","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":"f4M8ozx640-bZMKZn2MQh","name":"TMXIsometricRenderer","brief":"","type":"ClassDoc","description":"an Isometric Map Renderder
","params":[],"returns":[],"extends":["TMXRenderer"],"implements":[],"members":[{"id":"wd5vEdDba0m7ce5f840Gz","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":"D4h7bYLd5fVFG8WBgNM6s","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":"7wxNieAzKa17Es2sl76_w","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":"dI00vTSavuVBPo_FqX7vQ","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":"D8FmtsOMBs39_Izti_p0j","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":"-A0lQXV7XCo4thNGEjiht","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":"aPb1w26XTvYQfKyyRoshc","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":"mJ-Ht176H15aKmhh31OyH","name":"TMXLayer","brief":"","type":"ClassDoc","description":"a TMX Tile Layer Object\nTiled QT 0.7.x format
","params":[],"returns":[],"extends":["Renderable"],"implements":[],"members":[{"id":"SGvlkm8GU8Wp6pd4KzKYN","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":"7yTWdSOHTCWcroHJhwToG","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":"Q8z_vkOer1vN5WeJeOLZz","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":"SMsshzOtDzV9ZHuWd9Lbv","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":"tKUzvzjv7IF3_tQ_qavds","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":"D8D-_oeZBcZ56UyIwyiBt","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":"OlX-ZnRZERQvRbqJIg8fw","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":"TCcedNAipKR1-yIx00JPb","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"VeUf6h3R5H9VzW_YSX1I7","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"qEyls_Zq2S4mqYiojWacn","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"yEmp5Im2eY38itJpAhfHy","name":"class","brief":"","scope":"instance","type":"PropertyDoc","description":"the layer class
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"pn10UYTbEOr99G_vuSJCh","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"aVzTVZPwk6Y1YT3MBMKR9","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Ci_s8Wl2JKNhNXcOVdRxw","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":"y5Y1ByqFl4l7DM6LeyYUa","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"
(G)ame (U)nique (Id)entifier"
height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"VWl7MHM29SAf5acbIjf5e","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":"6kZz2xVrDmU7uOaMRNgu1","name":"isAnimated","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Layer contains tileset animations
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"yhPr7Zwmx6CyFtuH2Wcej","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":"BrRbFQEbphflAtbhpxb5R","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":"9xUBkY0CxArZV3GxoBJg1","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":"-ZlkjFA6cYwSfF_PRLVnE","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":"9YKeJQg4OmDbhMsNMQ_d2","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":"KfI_I5_vP_WCf6BefteRY","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"wXf0Ttu0s2wFO2n9ly-kq","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Vn5iCI-gziBtGnglYYt7X","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":"2VEsGsiUWSf3-SbcrCo4f","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"dzW2V18Q0bc9GdfIwbsns","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":"VZtE2xbG5IXeMj7dTnv2m","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":"HeFSnwDsxFC3yajfQLo0l","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"cf4fT11dPAhB3BZNOw1f1","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"8TjMVelgKT0-PugqyajQX","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":"WVjcfNaV0zeIUYfy3iu_f","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"
right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"-kWUNTg2vp8iVagoFrOij","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":"1S_Z4WNY6WKbVRbvf25GV","name":"tilesets","brief":"","scope":"instance","type":"PropertyDoc","description":"
The Layer corresponding Tilesets
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"CbMJRDLEumNIh5w9cWE9y","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":"wOvKm2wN82vuJ2z32ZSOS","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"u4YW17K84rbE_iaztOLNN","name":"type","brief":"","defaultValue":"\"Rectangle\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"sj2dIDo8lzy5CXhaZmkeS","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":"nTcydkZe0KzPCoH3AXpqa","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"PvE0kIvcD_kYm1W7XEDqL","name":"x","brief":"","defaultValue":"0","scope":"instance","type":"PropertyDoc","description":"Horizontal layer offset in tiles
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"Vm-GwobSB9a9ge7plOEYf","name":"y","brief":"","defaultValue":"0","scope":"instance","type":"PropertyDoc","description":"Vertical layer offset in tiles
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"lKQ05vRcJuMqDaKwybvrl","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":"UK725TesS0NUyUVuw5TMn","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":"t0_6AXszek4u9izhZsZGD","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":"1B7H4j4u8xTkzAaJtonJq","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":"mvTyHF8DNC70ieChX1pJd","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":"4ajugAeoPkzTT6yBJTeVg","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":"_kzSqFfKXu6ERWTdTEdai","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":"8FK0HfjxGUKk-BzgmHFEJ","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":"Qv_CNNFmqGDDoNORWu0dz","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":"TIdrajAVIdXCbE_9ioJNj","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":"L2Xhy5T5mIS1yBWQ1gO1v","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":"d8opBspI-XGCgO8KJ5U4d","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":"3L7QeU-4yXQ5yUxwNpEdW","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":"RNtqtcCE9II9TKMoufqEn","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":"WuqegTQ01zyLZ-3VFBN77","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":"Yo8EnHeLgupeB-h_ZuNEt","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":"2bXLdhHpCKPwLJpaXENwz","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":"sWliQoTLZuY8cJFiTSBD1","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":"BV-ukbkTQhjfqr2DtEaFn","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":"iOgKv3KdphrkF2z_UslCj","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":"C02LoK2RHuK_nSaOHqwJn","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":"DcIVgO35X1KFUCyeGbdsT","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":"Q9mNl0FNa1b9doJKJ8Le-","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":"7Kak8Jk5tZsL_vfGcD8cN","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":"2x8vYMMtXxZEte1MzAYye","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","kind":"canonical"},{"value":"Renderable","kind":"link"}],"template":"%1"}}],"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":"QeF1oQouT6lPqQKgqkXU-","name":"onDestroyEvent","brief":"","scope":"instance","type":"MethodDoc","description":"OnDestroy Notification function
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"-GIVUgKzhFjpq3G2A1lov","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":"6PZ89I7FvoZ_P9WGbjbmV","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":"7d4_O7NFoksvpd_QzG4w6","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":"3SgReFq1cAOsizJtkED2d","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":"7TN8Y10fMJKmX0iELfEj4","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":"UUIqJXkl8QIEcIK5RrNOi","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":"QvTV9kCSTv8vOtjlJ8h0W","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":"OTtWH6QagSZgK3w5iAKsJ","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":"Tj35zGPxQdx2nlGy2ZSKB","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":"y2v19lxEIv1TCE7fNdUBg","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":"j5KQsiVzXdmY_dj3PgYLU","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":"nkI1ny88Ii62YYYffbnWe","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":"-Sfa70LziWDyYz05kgodo","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":"cLjNJAIXfh2KALQjKC4d8","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":"bgvtrsRMXB6aQW-1kVcpq","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":"7ciXRtw2QA8Udoh7DsKWe","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":"4ZZCsNsQyewyO6KjOBhC7","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":"AtdR8WXL8Ww1H6PxEbCSA","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":"DhJrclXEsYTBg3UQ2mBLj","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":"itOx0aC-YeT53rbj-FeSw","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":"Ix-0QfPW5mz4z1wvTDSzs","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":"aaDepfHUrec5HcxKYYPBA","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":"4bO-qdMb_V6sEMU8cdWGh","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":"lQrFkjIgkq4QpKtsJ2Ii8","name":"TMXOrthogonalRenderer","brief":"","type":"ClassDoc","description":"an Orthogonal Map Renderder
","params":[],"returns":[],"extends":["TMXRenderer"],"implements":[],"members":[{"id":"kiK7hKjM_hW3otuKBDASn","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":"a6t6giNVoijxOO_R2eeT_","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":"TcmBBc30cLO2Q_cjeXuL9","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":"oit5pigNV6aWJCVm-kIWy","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":"0EKZtuaaHb9dWjK0EGILk","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":"s3KxO76QdzeHnAp8BATKM","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":"CJPG8kJyS_6A24aBVDQKy","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":"L6QtTk235ifySknqTYi4H","name":"TMXRenderer","brief":"","type":"ClassDoc","description":"The map renderer base class
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"AozKkt7Hqv-4NkILExGvJ","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":"iX78Z6vbOVvI20UJyCZcd","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":"NRMWOrDpvZdetXGZlUFL2","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":"X5PsPHjB8e1WEkHYAHy27","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":"_MMJHcYAnj7voBw18innq","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":"kXYQTEBisJ5qHdj8teBpj","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":"ONh8iPYBSd1sziG_Xw822","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":"t70G6KR_BbyrRibpKEYn2","name":"TMXStaggeredRenderer","type":"ClassDoc","description":"a Staggered Map Renderder
","params":[],"returns":[],"extends":["TMXHexagonalRenderer"],"implements":[],"members":[{"id":"Fs7U8O2V-YgNpaTmV_2J3","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":"-j02OnblxRH0rzqdjFAnE","name":"constructor","brief":"","access":"public","scope":"instance","type":"MethodDoc","params":[],"returns":[]},{"id":"lQIr3jXNqMQU1aX6znait","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":"cgqgUV4IYzVn8DGEJwoEN","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":"LqlyE6H0_8L8BKpwnJjIl","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":"YoxX7neXqF_vwjshxp4qW","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":"11B2nZg1WJ6v7Zzx3YpVD","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":"6taynSXO1NosZ9cjbKL6O","name":"TMXTileMap","brief":"","type":"ClassDoc","description":"a TMX Tile Map Object\nTiled QT +0.7.x format
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"UymKoTVSjrGZi4zVMr_fp","name":"class","brief":"","scope":"instance","type":"PropertyDoc","description":"The map class.
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"TeBlhHZSkZ1-DGByERraF","name":"cols","brief":"","defaultValue":"-","scope":"instance","type":"PropertyDoc","description":"width of the tilemap in tiles
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"SE9M5eqIYXqZKVWjW-xOq","name":"infinite","brief":"","defaultValue":"0","scope":"instance","type":"PropertyDoc","description":"is the map an infinite map
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"uGdHhdCi5NmYqyrjgWcCx","name":"name","brief":"","scope":"instance","type":"PropertyDoc","description":"name of the tilemap
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"RW5lFtgrCdyGgHLMi-qJ-","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":"xR55NhnLgetvpxvJcXKD4","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":"n4RbGsbjBbmbCqDbP1WAf","name":"rows","brief":"","defaultValue":"-","scope":"instance","type":"PropertyDoc","description":"
height of the tilemap in tiles
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"FxuG_3skZkBsYOULvq0Et","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":"qYShFniJqURZNqELavCvR","name":"tileheight","brief":"","defaultValue":"-","scope":"instance","type":"PropertyDoc","description":"Tile height
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"0_-R95RrKtSzPEjmok4Vl","name":"tilewidth","brief":"","defaultValue":"-","scope":"instance","type":"PropertyDoc","description":"Tile width
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"9mJnaczxtgKyw71nxp9US","name":"version","brief":"","scope":"instance","type":"PropertyDoc","description":"the TMX format version
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"gbGaNoVnOX7OFYHbqBeod","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":"RXic0KBtKmVlJCwS03a9y","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":"OLQQwyfm6hgc1B-j4qE32","name":"destroy","brief":"destroy function, clean all allocated objects
","scope":"instance","type":"MethodDoc","params":[],"returns":[],"extends":[],"implements":[]},{"id":"UL0PMMVSMdppmIbrgiz1q","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":"Q3aLGyLkWOwJgwltViTe6","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":"ziDi4N7oP-M5TvY1xEJkM","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":"7Dqj9E8dAJ5nd16ZXwfTo","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":"LOSDbnZqOoEJZ9XbbnIPN","name":"TMXTileset","brief":"","type":"ClassDoc","description":"a TMX Tile Set Object
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"6eanhUtFB42nPQVsSBfWs","name":"class","brief":"","scope":"instance","type":"PropertyDoc","description":"the tileset class
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"vUWNifhUGDbo_VuurrwJn","name":"isAnimated","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"Tileset contains animated tiles
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"H9spPe9Cu6BjeH6Nibtt7","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":"M9BCmR3YqPuJHID-wGJsx","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":"-4PbqudBJZVQp_8ZPnmtc","name":"animations","brief":"","access":"private","scope":"instance","type":"PropertyDoc","description":"Tileset animations
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"R6lhLsdvauyHmacihdlTh","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":"iu9yvIbZkefizVnJGWPuJ","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":"ESwRT7l_ey55riePEreEn","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":"OpDXc_0PaunkrNdBO3AMa","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":"KU2wqLx7RxPQAPAnylJzt","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":"raNCEuqg2D7xRQ5QnxIX1","name":"TMXTilesetGroup","brief":"","type":"ClassDoc","description":"an object containing all tileset
","params":[],"returns":[],"extends":[],"implements":[],"members":[{"id":"RZBDAJb7kI4klCEAIuv-3","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":"weea_wB655E-RuVF_sBn3","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":"UGaVDGd0523_Nd-iQYfTH","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":"oXkrns_EoHLF4buS2hyQv","name":"Trigger","brief":"","type":"ClassDoc","description":"trigger an event when colliding with another object
","params":[],"returns":[],"extends":["Renderable"],"implements":[],"members":[{"id":"ItapNyGhmJSefw6x-Itxi","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":"s3dTAl7iKrSkQOd6N9tpS","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":"ok6TWZ2aEsJbLnSYRqkg8","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":"8L85PCR4m0pyjqkb8-0_g","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":"9cN5orFn5iVGiilJdyFaz","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":"O01DDzfFmnaGGf8T9Qx7G","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":"OyEjHM75JtNhR38AyY4Pc","name":"bottom","brief":"","scope":"instance","type":"PropertyDoc","description":"bottom coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"g1PR75-phNP8nv1KIHVJM","name":"centerX","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the horizontal axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"-3xlQWEj4NXN0dkEt_3dK","name":"centerY","brief":"","scope":"instance","type":"PropertyDoc","description":"absolute center of this rectangle on the vertical axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"lkLf7xy8Wx1RqM8ZW57_b","name":"currentTransform","brief":"","scope":"instance","type":"PropertyDoc","description":"the renderable default transformation matrix
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"sL63d7E6RYKUZOlNKd67k","name":"depth","brief":"","scope":"instance","type":"PropertyDoc","description":"the depth of this renderable on the z axis
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"BjQ5l_vMVtwqcyL2KCWd_","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":"tUeB3b_gao8mtQbH5vbRH","name":"GUID","brief":"","scope":"instance","type":"PropertyDoc","description":"
(G)ame (U)nique (Id)entifier"
height of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"QVG1YG6G2m9H_Ji8AojwG","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":"kfOae3TQNwQGJ-Zdn7jWF","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":"-jYJs8rVtdzpMlqVPk7p4","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":"6MmMGa_dMAjyQQvKBtRSQ","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":"Xb6sNFAQLRaj9Iy-kVgxT","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":"CZ2yoQq4H8ru7RxrsBAlt","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":"BGYoBC2PKxre_WrBD_1K1","name":"isPersistent","brief":"","defaultValue":"false","scope":"instance","type":"PropertyDoc","description":"make the renderable object persistent over level changes
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"R-GYPLqoqwnD69boeN_LL","name":"left","brief":"","scope":"instance","type":"PropertyDoc","description":"left coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"56GDnBTP_I9v1U5_Yr0kj","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":"qDJ5lCEfwFCkDCWPUoW6I","name":"name","brief":"","defaultValue":"\"\"","scope":"instance","type":"PropertyDoc","description":"
The name of the renderable
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"BFdbF3oTZR7-r-4G6iyrA","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":"vJOkwjD60EKp7TcAkIZhs","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":"LBms3h2Boyeur7CDxO9DD","name":"points","brief":"","scope":"instance","type":"PropertyDoc","description":"Array of points defining the Polygon points, you must call...","params":[],"returns":[],"extends":[],"implements":[]},{"id":"ten5tHIUe2HQtfto9YbKM","name":"pos","brief":"","access":"public","scope":"instance","type":"PropertyDoc","description":"
Position of the Renderable relative to its parent container
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"_Cf7eoByx5AQ5qF5CbvjY","name":"right","brief":"","scope":"instance","type":"PropertyDoc","description":"right coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"uz3govL8rEkSa1KUfIBP-","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":"EL3TVzHYRDm3fRx5or6KO","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":"P2d_ARb4G5IPCPpy5WKlq","name":"top","brief":"","scope":"instance","type":"PropertyDoc","description":"top coordinate of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"nUjNFEsYKMPmQjr1SW1xE","name":"type","brief":"","defaultValue":"\"Rectangle\"","scope":"instance","type":"PropertyDoc","description":"the shape type (used internally)
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"49z6lrvIssBpNp_xuWkUd","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":"XxS0u9pMQoL1cBNhSQtjX","name":"width","brief":"","scope":"instance","type":"PropertyDoc","description":"width of the Rectangle
","params":[],"returns":[],"extends":[],"implements":[]},{"id":"acT6-ptIxRiDPDFdGRz_n","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":"o2eVD-aPGZEzL-KBMVl_9","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":"S7xnJgKRL4aFZbcY96tXT","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":"GcV0MnjVJfxCP5_9LmMEZ","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","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>"}},{"identifier":"settings.duration","optional":true,"description":"Fade duration (in ms)
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"settings.color","optional":true,"description":"Fade color
","dataType":{"tokens":[{"value":"string | Color","kind":"canonical"},{"value":"Color","kind":"link"}],"template":"string | %1"}},{"identifier":"settings.event","optional":true,"default":"\"level\"","description":"the type of event to trigger (only "level" supported for now)
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"settings.to","optional":true,"description":"level to load if level trigger
","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"settings.container","optional":true,"description":"Target container. See {@link level.load}
","dataType":{"tokens":[{"value":"string | Container","kind":"canonical"},{"value":"Container","kind":"link"}],"template":"string | %1"}},{"identifier":"settings.onLoaded","optional":true,"description":"Level loaded callback. See {@link level.load}
","dataType":{"tokens":[{"value":"Function","kind":"canonical"}],"template":"Function"}},{"identifier":"settings.flatten","optional":true,"description":"Flatten all objects into the target container. See {@link level.load}
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}},{"identifier":"settings.setViewportBounds","optional":true,"description":"Resize the viewport to match the level. See {@link level.load}
","dataType":{"tokens":[{"value":"boolean","kind":"canonical"}],"template":"boolean"}}],"returns":[],"extends":[],"implements":[]},{"id":"B3nRhXmuZIDt7BdE3Lqpz","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":"Y3aXkGKhozILksuhamzyv","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":"nzdUObSvqVptGL0Q7YiEf","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":"L5iLCtl5pPG7Hug5dDbzv","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":"o3pZAx8CcV9q0q6_Cb1rd","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":"ooZ5EVVgjaG7r9IQGEGsX","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":"
Gamepad id string","dataType":{"tokens":[{"value":"string","kind":"canonical"}],"template":"string"}},{"identifier":"mapping","description":"