phaser/resources/docgen/output/Phaser.FlexGrid.json

{"class":{"name":"Phaser.FlexGrid","extends":"","static":false,"constructor":true,"parameters":[{"name":"manager","type":["Phaser.ScaleManager"],"help":"The ScaleManager.","optional":false,"default":null},{"name":"width","type":["number"],"help":"The width of the game.","optional":false,"default":null},{"name":"height","type":["number"],"help":"The height of the game.","optional":false,"default":null}],"help":"WARNING: This is an EXPERIMENTAL class. The API will change significantly in the coming versions and is incomplete.\\nPlease try to avoid using in production games with a long time to build.\\nThis is also why the documentation is incomplete.\\n\\nFlexGrid is a a responsive grid manager that works in conjunction with the ScaleManager RESIZE scaling mode and FlexLayers\\nto provide for game object positioning in a responsive manner."},"consts":[],"methods":{"public":[{"name":"createCustomLayer","static":false,"returns":{"types":["Phaser.FlexLayer"],"help":"The Layer object."},"help":"A custom layer is centered on the game and maintains its aspect ratio as it scales up and down.","line":113,"public":true,"protected":false,"private":false,"parameters":[{"name":"width","type":["number"],"help":"Width of this layer in pixels.","optional":false,"default":null},{"name":"height","type":["number"],"help":"Height of this layer in pixels.","optional":false,"default":null},{"name":"children","type":["array"],"help":"An array of children that are used to populate the FlexLayer.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"createFixedLayer","static":false,"returns":{"types":["Phaser.FlexLayer"],"help":"The Layer object."},"help":"A fixed layer is centered on the game and is the size of the required dimensions and is never scaled.","line":201,"public":true,"protected":false,"private":false,"parameters":[{"name":"children","type":["array"],"help":"An array of children that are used to populate the FlexLayer.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"createFluidLayer","static":false,"returns":{"types":["Phaser.FlexLayer"],"help":"The Layer object."},"help":"A fluid layer is centered on the game and maintains its aspect ratio as it scales up and down.","line":148,"public":true,"protected":false,"private":false,"parameters":[{"name":"children","type":["array"],"help":"An array of children that are used to populate the FlexLayer.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"createFullLayer","static":false,"returns":{"types":["Phaser.FlexLayer"],"help":"The Layer object."},"help":"A full layer is placed at 0,0 and extends to the full size of the game. Children are scaled according to the fluid ratios.","line":177,"public":true,"protected":false,"private":false,"parameters":[{"name":"children","type":["array"],"help":"An array of children that are used to populate the FlexLayer.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"debug","static":false,"returns":null,"help":"Call in the render function to output the bounds rects.","line":304,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"onResize","static":false,"returns":null,"help":"Called when the game container changes dimensions.","line":247,"public":true,"protected":false,"private":false,"parameters":[{"name":"width","type":["number"],"help":"The new width of the game container.","optional":false,"default":null},{"name":"height","type":["number"],"help":"The new height of the game container.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"refresh","static":false,"returns":null,"help":"Updates all internal vars such as the bounds and scale values.","line":258,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"reset","static":false,"returns":null,"help":"Resets the layer children references","line":223,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"setSize","static":false,"returns":null,"help":"Sets the core game size. This resets the w\/h parameters and bounds.","line":84,"public":true,"protected":false,"private":false,"parameters":[{"name":"width","type":["number"],"help":"The new dimensions.","optional":false,"default":null},{"name":"height","type":["number"],"help":"The new dimensions.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running Game.","line":26,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"position","type":["Phaser.Point"],"help":"","inlineHelp":"","line":46,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"scale","type":["Phaser.ScaleManager"],"help":"","inlineHelp":"A reference to the ScaleManager.","line":31,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scaleFactor","type":["Phaser.Point"],"help":"","inlineHelp":"The scale factor based on the game dimensions vs. the scaled dimensions.","line":55,"default":null,"public":true,"protected":false,"private":false,"readOnly":true}],"protected":[],"private":[]}}