Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-11-30 08:31:01 +00:00
Code Issues Projects Releases Packages Wiki Activity
phaser/docs/Phaser.Image.html

10843 lines
190 KiB
HTML
Raw Normal View History

Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Phaser Class: Image</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
2.2 doc files.
2014-11-15 20:01:46 +00:00
<link type="text/css" rel="stylesheet" href="styles/default.css">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.cerulean.css">
</head>
<body>
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<div class="container-fluid">
<div class="navbar navbar-fixed-top navbar-inverse">
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
<div style="position: absolute; width: 143px; height: 31px; right: 10px; top: 10px; z-index: 1050"><a href="http://phaser.io"><img src="img/phaser.png" border="0" /></a></div>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<div class="navbar-inner">
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
<a class="brand" href="index.html">Phaser API</a>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<ul class="nav">
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<li class="dropdown">
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b
class="caret"></b></a>
<ul class="dropdown-menu ">
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-0">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.html">Phaser</a>
</li>
2.4.4 Release.
2015-10-15 11:06:38 +00:00
<li class="class-depth-0">
<a href="Phaser.KeyCode.html">KeyCode</a>
</li>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<li class="class-depth-0">
<a href="PIXI.html">PIXI</a>
</li>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</ul>
</li>
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b
class="caret"></b></a>
<ul class="dropdown-menu ">
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Animation.html">Animation</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.AnimationManager.html">AnimationManager</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.AnimationParser.html">AnimationParser</a>
</li>
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
<li class="class-depth-1">
<a href="Phaser.ArraySet.html">ArraySet</a>
</li>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
<a href="Phaser.ArrayUtils.html">ArrayUtils</a>
</li>
Updated readme and docs.
2014-10-09 15:12:53 +00:00
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.BitmapText.html">BitmapText</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Button.html">Button</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Cache.html">Cache</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Camera.html">Camera</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Canvas.html">Canvas</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Circle.html">Circle</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Color.html">Color</a>
</li>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<li class="class-depth-2">
<a href="Phaser.Component.Angle.html">Angle</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Animation.html">Animation</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.AutoCull.html">AutoCull</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Bounds.html">Bounds</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.BringToTop.html">BringToTop</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Core.html">Core</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Crop.html">Crop</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Delta.html">Delta</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Destroy.html">Destroy</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.FixedToCamera.html">FixedToCamera</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Health.html">Health</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.InCamera.html">InCamera</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.InputEnabled.html">InputEnabled</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.InWorld.html">InWorld</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.LifeSpan.html">LifeSpan</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.LoadTexture.html">LoadTexture</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Overlap.html">Overlap</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.PhysicsBody.html">PhysicsBody</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Reset.html">Reset</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.ScaleMinMax.html">ScaleMinMax</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Component.Smoothed.html">Smoothed</a>
</li>
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<li class="class-depth-1">
<a href="Phaser.Create.html">Create</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Creature.html">Creature</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Device.html">Device</a>
</li>
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<li class="class-depth-1">
<a href="Phaser.DeviceButton.html">DeviceButton</a>
</li>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
<a href="Phaser.DOM.html">DOM</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Easing.html">Easing</a>
</li>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<li class="class-depth-2">
<a href="Phaser.Easing.Back.html">Back</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Bounce.html">Bounce</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Circular.html">Circular</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Cubic.html">Cubic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Elastic.html">Elastic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Exponential.html">Exponential</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Linear.html">Linear</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Quadratic.html">Quadratic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Quartic.html">Quartic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Quintic.html">Quintic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Sinusoidal.html">Sinusoidal</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
<a href="Phaser.Ellipse.html">Ellipse</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Events.html">Events</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Filter.html">Filter</a>
</li>
Docs updates.
2014-09-09 14:36:56 +00:00
<li class="class-depth-1">
<a href="Phaser.FlexGrid.html">FlexGrid</a>
</li>
<li class="class-depth-1">
<a href="Phaser.FlexLayer.html">FlexLayer</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Frame.html">Frame</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.FrameData.html">FrameData</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Game.html">Game</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated docs - they now actually list the new body methods :)
2014-02-21 15:37:26 +00:00
<a href="Phaser.GameObjectCreator.html">GameObjectCreator</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.GameObjectFactory.html">GameObjectFactory</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Gamepad.html">Gamepad</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Graphics.html">Graphics</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Group.html">Group</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Image.html">Image</a>
</li>
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<li class="class-depth-1">
<a href="Phaser.ImageCollection.html">ImageCollection</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Input.html">Input</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.InputHandler.html">InputHandler</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Key.html">Key</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Keyboard.html">Keyboard</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Line.html">Line</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.LinkedList.html">LinkedList</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Loader.html">Loader</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.LoaderParser.html">LoaderParser</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Math.html">Math</a>
</li>
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<li class="class-depth-1">
<a href="Phaser.Matrix.html">Matrix</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Mouse.html">Mouse</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.MSPointer.html">MSPointer</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Net.html">Net</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Particle.html">Particle</a>
</li>
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Particles.html">Particles</a>
</li>
Updated readme and docs.
2014-10-09 15:12:53 +00:00
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Physics.html">Physics</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Physics.Arcade.html">Arcade</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.Arcade.Body.html">Body</a>
</li>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<li class="class-depth-3">
New docs.
2015-08-24 14:43:45 +00:00
<a href="Phaser.Physics.Arcade.TilemapCollision.html">TilemapCollision</a>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.Ninja.html">Ninja</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.Ninja.AABB.html">AABB</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.Ninja.Body.html">Body</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.Ninja.Circle.html">Circle</a>
Updated docs - they now actually list the new body methods :)
2014-02-21 15:37:26 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.Ninja.Tile.html">Tile</a>
Updated docs - they now actually list the new body methods :)
2014-02-21 15:37:26 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.html">P2</a>
Updated docs - they now actually list the new body methods :)
2014-02-21 15:37:26 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.Body.html">Body</a>
Updated docs - they now actually list the new body methods :)
2014-02-21 15:37:26 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.BodyDebug.html">BodyDebug</a>
Updated docs - they now actually list the new body methods :)
2014-02-21 15:37:26 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a>
Updated docs - they now actually list the new body methods :)
2014-02-21 15:37:26 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a>
Updated docs - they now actually list the new body methods :)
2014-02-21 15:37:26 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.DistanceConstraint.html">DistanceConstraint</a>
</li>
Preparing for final 2.0.3 release. Updated docs, readme and build files.
2014-04-11 12:09:28 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.FixtureList.html">FixtureList</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.GearConstraint.html">GearConstraint</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.InversePointProxy.html">InversePointProxy</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.LockConstraint.html">LockConstraint</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.Material.html">Material</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.PointProxy.html">PointProxy</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.PrismaticConstraint.html">PrismaticConstraint</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.RevoluteConstraint.html">RevoluteConstraint</a>
</li>
Docs updates.
2014-09-09 14:36:56 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.RotationalSpring.html">RotationalSpring</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.Spring.html">Spring</a>
Updated docs - they now actually list the new body methods :)
2014-02-21 15:37:26 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Plugin.html">Plugin</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.PluginManager.html">PluginManager</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Point.html">Point</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Pointer.html">Pointer</a>
</li>
2.4.4 Release.
2015-10-15 11:06:38 +00:00
<li class="class-depth-1">
<a href="Phaser.PointerMode.html">PointerMode</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Polygon.html">Polygon</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.QuadTree.html">QuadTree</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.RandomDataGenerator.html">RandomDataGenerator</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Rectangle.html">Rectangle</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.RenderTexture.html">RenderTexture</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.RequestAnimationFrame.html">RequestAnimationFrame</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.RetroFont.html">RetroFont</a>
</li>
Docs updates.
2014-09-09 14:36:56 +00:00
<li class="class-depth-1">
<a href="Phaser.Rope.html">Rope</a>
</li>
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<li class="class-depth-1">
<a href="Phaser.RoundedRectangle.html">RoundedRectangle</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.ScaleManager.html">ScaleManager</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Signal.html">Signal</a>
</li>
Preparing for final 2.0.3 release. Updated docs, readme and build files.
2014-04-11 12:09:28 +00:00
<li class="class-depth-1">
<a href="Phaser.SignalBinding.html">SignalBinding</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.SinglePad.html">SinglePad</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Sound.html">Sound</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.SoundManager.html">SoundManager</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Sprite.html">Sprite</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
<a href="Phaser.SpriteBatch.html">SpriteBatch</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Stage.html">Stage</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.State.html">State</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.StateManager.html">StateManager</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Text.html">Text</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Tile.html">Tile</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Tilemap.html">Tilemap</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.TilemapLayer.html">TilemapLayer</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.TilemapParser.html">TilemapParser</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Tileset.html">Tileset</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.TileSprite.html">TileSprite</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Time.html">Time</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Timer.html">Timer</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.TimerEvent.html">TimerEvent</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Touch.html">Touch</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Tween.html">Tween</a>
</li>
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
<li class="class-depth-1">
<a href="Phaser.TweenData.html">TweenData</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.TweenManager.html">TweenManager</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Utils.html">Utils</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Utils.Debug.html">Debug</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="Phaser.Video.html">Video</a>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</li>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="Phaser.World.html">World</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="PIXI.AbstractFilter.html">AbstractFilter</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="PIXI.BaseTexture.html">BaseTexture</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasBuffer.html">CanvasBuffer</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasGraphics.html">CanvasGraphics</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasMaskManager.html">CanvasMaskManager</a>
</li>
New docs.
2015-08-24 14:43:45 +00:00
<li class="class-depth-1">
<a href="PIXI.CanvasPool.html">CanvasPool</a>
</li>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
<a href="PIXI.CanvasRenderer.html">CanvasRenderer</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasTinter.html">CanvasTinter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.ComplexPrimitiveShader.html">ComplexPrimitiveShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.DisplayObject.html">DisplayObject</a>
</li>
<li class="class-depth-1">
<a href="PIXI.DisplayObjectContainer.html">DisplayObjectContainer</a>
</li>
New docs.
2016-02-08 17:01:36 +00:00
<li class="class-depth-1">
<a href="PIXI.EarCut.html">EarCut</a>
</li>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
<a href="PIXI.Event.html">Event</a>
</li>
<li class="class-depth-1">
<a href="PIXI.EventTarget.html">EventTarget</a>
</li>
<li class="class-depth-1">
<a href="PIXI.FilterTexture.html">FilterTexture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Graphics.html">Graphics</a>
</li>
<li class="class-depth-1">
<a href="PIXI.GraphicsData.html">GraphicsData</a>
</li>
<li class="class-depth-1">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="PIXI.PIXI.html">PIXI</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="PIXI.PixiFastShader.html">PixiFastShader</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="PIXI.PixiShader.html">PixiShader</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="PIXI.PolyK.html">PolyK</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="PIXI.PrimitiveShader.html">PrimitiveShader</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="PIXI.RenderTexture.html">RenderTexture</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="PIXI.Rope.html">Rope</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="PIXI.Sprite.html">Sprite</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="PIXI.SpriteBatch.html">SpriteBatch</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="PIXI.Strip.html">Strip</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="PIXI.StripShader.html">StripShader</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="PIXI.Texture.html">Texture</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="PIXI.TilingSprite.html">TilingSprite</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="PIXI.WebGLBlendModeManager.html">WebGLBlendModeManager</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="PIXI.WebGLFastSpriteBatch.html">WebGLFastSpriteBatch</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="PIXI.WebGLFilterManager.html">WebGLFilterManager</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="PIXI.WebGLRenderer.html">WebGLRenderer</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
</ul>
</li>
<li class="dropdown">
<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b
class="caret"></b></a>
<ul class="dropdown-menu ">
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="global.html#AUTO">AUTO</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="global.html#BITMAPDATA">BITMAPDATA</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="global.html#BITMAPTEXT">BITMAPTEXT</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
<a href="global.html#blendModes">blendModes</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="global.html#BUTTON">BUTTON</a>
</li>
<li class="class-depth-0">
<a href="global.html#CANVAS">CANVAS</a>
</li>
<li class="class-depth-0">
<a href="global.html#CANVAS_FILTER">CANVAS_FILTER</a>
</li>
<li class="class-depth-0">
<a href="global.html#CIRCLE">CIRCLE</a>
</li>
<li class="class-depth-0">
<a href="global.html#CREATURE">CREATURE</a>
</li>
<li class="class-depth-0">
<a href="global.html#DOWN">DOWN</a>
</li>
<li class="class-depth-0">
<a href="global.html#ELLIPSE">ELLIPSE</a>
</li>
<li class="class-depth-0">
<a href="global.html#EMITTER">EMITTER</a>
</li>
<li class="class-depth-0">
<a href="global.html#GAMES">GAMES</a>
</li>
<li class="class-depth-0">
<a href="global.html#GRAPHICS">GRAPHICS</a>
</li>
<li class="class-depth-0">
<a href="global.html#GROUP">GROUP</a>
</li>
<li class="class-depth-0">
<a href="global.html#HEADLESS">HEADLESS</a>
</li>
<li class="class-depth-0">
<a href="global.html#IMAGE">IMAGE</a>
</li>
<li class="class-depth-0">
<a href="global.html#LEFT">LEFT</a>
</li>
<li class="class-depth-0">
<a href="global.html#LINE">LINE</a>
</li>
<li class="class-depth-0">
<a href="global.html#MATRIX">MATRIX</a>
</li>
<li class="class-depth-0">
<a href="global.html#NONE">NONE</a>
</li>
New docs.
2016-02-08 17:01:36 +00:00
<li class="class-depth-0">
<a href="global.html#PENDING_ATLAS">PENDING_ATLAS</a>
</li>
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<li class="class-depth-0">
<a href="global.html#POINT">POINT</a>
</li>
<li class="class-depth-0">
<a href="global.html#POINTER">POINTER</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="global.html#POLYGON">POLYGON</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="global.html#RECTANGLE">RECTANGLE</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="global.html#RENDERTEXTURE">RENDERTEXTURE</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="global.html#RETROFONT">RETROFONT</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="global.html#RIGHT">RIGHT</a>
</li>
<li class="class-depth-0">
<a href="global.html#ROPE">ROPE</a>
</li>
<li class="class-depth-0">
<a href="global.html#ROUNDEDRECTANGLE">ROUNDEDRECTANGLE</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
<a href="global.html#scaleModes">scaleModes</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="global.html#SPRITE">SPRITE</a>
</li>
<li class="class-depth-0">
<a href="global.html#SPRITEBATCH">SPRITEBATCH</a>
</li>
<li class="class-depth-0">
<a href="global.html#TEXT">TEXT</a>
</li>
<li class="class-depth-0">
<a href="global.html#TILEMAP">TILEMAP</a>
</li>
<li class="class-depth-0">
<a href="global.html#TILEMAPLAYER">TILEMAPLAYER</a>
</li>
<li class="class-depth-0">
<a href="global.html#TILESPRITE">TILESPRITE</a>
</li>
<li class="class-depth-0">
<a href="global.html#UP">UP</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="global.html#VERSION">VERSION</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="global.html#VIDEO">VIDEO</a>
</li>
<li class="class-depth-0">
<a href="global.html#WEBGL">WEBGL</a>
</li>
<li class="class-depth-0">
<a href="global.html#WEBGL_FILTER">WEBGL_FILTER</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</ul>
</li>
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<li class="dropdown">
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Core<b class="caret"></b></a>
<ul class="dropdown-menu ">
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<li class="class-depth-1"><a href="Phaser.Game.html">Game</a></li>
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="Phaser.Group.html">Group</a></li>
<li class="class-depth-1"><a href="Phaser.World.html">World</a></li>
<li class="class-depth-1"><a href="Phaser.Loader.html">Loader</a></li>
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<li class="class-depth-1"><a href="Phaser.Cache.html">Cache</a></li>
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="Phaser.Time.html">Time</a></li>
<li class="class-depth-1"><a href="Phaser.Camera.html">Camera</a></li>
<li class="class-depth-1"><a href="Phaser.StateManager.html">State Manager</a></li>
<li class="class-depth-1"><a href="Phaser.TweenManager.html">Tween Manager</a></li>
<li class="class-depth-1"><a href="Phaser.SoundManager.html">Sound Manager</a></li>
Docs update.
2015-01-06 06:57:25 +00:00
<li class="class-depth-1"><a href="Phaser.Input.html">Input Manager</a></li>
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="Phaser.ScaleManager.html">Scale Manager</a></li>
</ul>
</li>
2.2 doc files.
2014-11-15 20:01:46 +00:00
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Game Objects<b class="caret"></b></a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<ul class="dropdown-menu ">
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="Phaser.GameObjectFactory.html">Factory (game.add)</a></li>
<li class="class-depth-1"><a href="Phaser.GameObjectCreator.html">Creator (game.make)</a></li>
<li class="class-depth-1"><a href="Phaser.Sprite.html">Sprite</a></li>
<li class="class-depth-1"><a href="Phaser.Image.html">Image</a></li>
<li class="class-depth-1"><a href="Phaser.Sound.html">Sound</a></li>
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<li class="class-depth-1"><a href="Phaser.Video.html">Video</a></li>
Docs update.
2015-01-06 06:57:25 +00:00
<li class="class-depth-1"><a href="Phaser.Particles.Arcade.Emitter.html">Particle Emitter</a></li>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<li class="class-depth-1"><a href="Phaser.Particle.html">Particle</a></li>
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="Phaser.Text.html">Text</a></li>
<li class="class-depth-1"><a href="Phaser.Tween.html">Tween</a></li>
<li class="class-depth-1"><a href="Phaser.BitmapText.html">BitmapText</a></li>
<li class="class-depth-1"><a href="Phaser.Tilemap.html">Tilemap</a></li>
<li class="class-depth-1"><a href="Phaser.BitmapData.html">BitmapData</a></li>
<li class="class-depth-1"><a href="Phaser.RetroFont.html">RetroFont</a></li>
<li class="class-depth-1"><a href="Phaser.Button.html">Button</a></li>
<li class="class-depth-1"><a href="Phaser.Animation.html">Animation</a></li>
<li class="class-depth-1"><a href="Phaser.Graphics.html">Graphics</a></li>
<li class="class-depth-1"><a href="Phaser.RenderTexture.html">RenderTexture</a></li>
<li class="class-depth-1"><a href="Phaser.TileSprite.html">TileSprite</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Geometry<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.Circle.html">Circle</a></li>
<li class="class-depth-1"><a href="Phaser.Ellipse.html">Ellipse</a></li>
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<li class="class-depth-1"><a href="Phaser.Line.html">Line</a></li>
<li class="class-depth-1"><a href="Phaser.Matrix.html">Matrix</a></li>
<li class="class-depth-1"><a href="Phaser.Point.html">Point</a></li>
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="Phaser.Polygon.html">Polygon</a></li>
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<li class="class-depth-1"><a href="Phaser.Rectangle.html">Rectangle</a></li>
<li class="class-depth-1"><a href="Phaser.RoundedRectangle.html">Rounded Rectangle</a></li>
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
</ul>
</li>
2.2 doc files.
2014-11-15 20:01:46 +00:00
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Physics<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.Physics.Arcade.html">Arcade Physics</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.Arcade.Body.html">Body</a></li>
<li class="class-depth-1"><a href="Phaser.Physics.P2.html">P2 Physics</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.Body.html">Body</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.Spring.html">Spring</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a></li>
<li class="class-depth-1"><a href="Phaser.Physics.Ninja.html">Ninja Physics</a></li>
<li class="class-depth-2"><a href="Phaser.Physics.Body.html">Body</a></li>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</ul>
</li>
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Input<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1"><a href="Phaser.InputHandler.html">Input Handler</a></li>
<li class="class-depth-1"><a href="Phaser.Pointer.html">Pointer</a></li>
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<li class="class-depth-1"><a href="Phaser.DeviceButton.html">Device Button</a></li>
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="Phaser.Mouse.html">Mouse</a></li>
<li class="class-depth-1"><a href="Phaser.Keyboard.html">Keyboard</a></li>
<li class="class-depth-1"><a href="Phaser.Key.html">Key</a></li>
<li class="class-depth-1"><a href="Phaser.Gamepad.html">Gamepad</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Community<b class="caret"></b></a>
<ul class="dropdown-menu ">
2.3.0 API Docs
2015-03-26 02:55:18 +00:00
<li class="class-depth-1"><a href="http://phaser.io">Phaser Web Site</a></li>
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="https://github.com/photonstorm/phaser">Phaser Github</a></li>
2.3.0 API Docs
2015-03-26 02:55:18 +00:00
<li class="class-depth-1"><a href="http://phaser.io/examples">Phaser Examples</a></li>
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="https://github.com/photonstorm/phaser-plugins">Phaser Plugins</a></li>
<li class="class-depth-1"><a href="http://www.html5gamedevs.com/forum/14-phaser/">Forum</a></li>
<li class="class-depth-1"><a href="http://stackoverflow.com/questions/tagged/phaser-framework">Stack Overflow</a></li>
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<li class="class-depth-1"><a href="http://phaser.io/learn">Tutorials</a></li>
Phaser 2.4.8 release.
2016-05-19 11:36:51 +00:00
<li class="class-depth-1"><a href="http://phaser.io/community/newsletter">Newsletter</a></li>
2.3.0 API Docs
2015-03-26 02:55:18 +00:00
<li class="class-depth-1"><a href="http://phaser.io/community/twitter">Twitter</a></li>
Phaser 2.4.8 release.
2016-05-19 11:36:51 +00:00
<li class="class-depth-1"><a href="http://phaser.io/news/2015/08/phaser-slack-channel">Slack</a></li>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<li class="class-depth-1"><a href="https://www.codeandweb.com/texturepacker/phaser">Texture Packer</a></li>
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
</ul>
</li>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</ul>
</div>
</div>
<div class="row-fluid">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<div class="span8">
<div id="main">
2.2.0 RC11 Docs Export.
2014-11-25 00:23:44 +00:00
<!--<h1 class="page-title">Class: Image</h1>-->
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<section>
<header>
<h2>
<span class="ancestors"><a href="Phaser.html">Phaser</a>.</span>
Image
</h2>
</header>
<article>
<div class="container-overview">
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
id="Image"><span class="type-signature"></span>new Image<span class="signature">(game, <span class="optional">x</span>, <span class="optional">y</span>, <span class="optional">key</span>, <span class="optional">frame</span>)</span><span class="type-signature"></span></h4>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
Updated readme and docs.
2014-10-09 15:12:53 +00:00
<div class="description">
<p>An Image is a light-weight object you can use to display anything that doesn't need physics or animation.
It can still rotate, scale, crop and receive input events. This makes it perfect for logos, backgrounds, simple buttons and other non-Sprite graphics.</p>
</div>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<th>Argument</th>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<th>Default</th>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>game</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Game.html">Phaser.Game</a></span>
</td>
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<td class="attributes">
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<td class="default">
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<td class="description last"><p>A reference to the currently running game.</p></td>
</tr>
<tr>
<td class="name"><code>x</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<td class="attributes">
&lt;optional><br>
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<td class="default">
0
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
Docs rebuilt for 2.0.5
2014-05-20 09:12:48 +00:00
<td class="description last"><p>The x coordinate of the Image. The coordinate is relative to any parent container this Image may be in.</p></td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<td class="attributes">
&lt;optional><br>
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<td class="default">
0
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<td class="description last"><p>The y coordinate of the Image. The coordinate is relative to any parent container this Image may be in.</p></td>
</tr>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type"><a href="Phaser.RenderTexture.html">Phaser.RenderTexture</a></span>
|
<span class="param-type"><a href="Phaser.BitmapData.html">Phaser.BitmapData</a></span>
|
2.2 doc files.
2014-11-15 20:01:46 +00:00
<span class="param-type"><a href="PIXI.Texture.html">PIXI.Texture</a></span>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</td>
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<td class="attributes">
&lt;optional><br>
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<td class="default">
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<td class="description last"><p>The texture used by the Image during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture, BitmapData or PIXI.Texture.</p></td>
</tr>
<tr>
<td class="name"><code>frame</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">number</span>
</td>
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<td class="attributes">
&lt;optional><br>
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<td class="default">
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<td class="description last"><p>If this Image is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.</p></td>
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="src_gameobjects_Image.js.html">gameobjects/Image.js</a>, <a href="src_gameobjects_Image.js.html#sunlight-1-line-35">line 35</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dd>
</div>
Updated readme and docs.
2014-10-09 15:12:53 +00:00
<h3 class="subsection-title">Extends</h3>
<ul>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<li><a href="PIXI.Sprite.html">PIXI.Sprite</a></li>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<li><a href="Phaser.Component.Core.html">Phaser.Component.Core</a></li>
<li><a href="Phaser.Component.Angle.html">Phaser.Component.Angle</a></li>
<li><a href="Phaser.Component.Animation.html">Phaser.Component.Animation</a></li>
<li><a href="Phaser.Component.AutoCull.html">Phaser.Component.AutoCull</a></li>
<li><a href="Phaser.Component.Bounds.html">Phaser.Component.Bounds</a></li>
<li><a href="Phaser.Component.BringToTop.html">Phaser.Component.BringToTop</a></li>
<li><a href="Phaser.Component.Crop.html">Phaser.Component.Crop</a></li>
<li><a href="Phaser.Component.Destroy.html">Phaser.Component.Destroy</a></li>
<li><a href="Phaser.Component.FixedToCamera.html">Phaser.Component.FixedToCamera</a></li>
<li><a href="Phaser.Component.InputEnabled.html">Phaser.Component.InputEnabled</a></li>
<li><a href="Phaser.Component.LifeSpan.html">Phaser.Component.LifeSpan</a></li>
<li><a href="Phaser.Component.LoadTexture.html">Phaser.Component.LoadTexture</a></li>
<li><a href="Phaser.Component.Overlap.html">Phaser.Component.Overlap</a></li>
<li><a href="Phaser.Component.Reset.html">Phaser.Component.Reset</a></li>
<li><a href="Phaser.Component.Smoothed.html">Phaser.Component.Smoothed</a></li>
Updated readme and docs.
2014-10-09 15:12:53 +00:00
</ul>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<h3 class="subsection-title">Members</h3>
<dl>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="alive"><span class="type-signature"></span>alive<span class="type-signature"> :boolean</span></h4>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>A useful flag to control if the Game Object is alive or dead.</p>
<p>This is set automatically by the Health components <code>damage</code> method should the object run out of health.
Or you can toggle it via your game code.</p>
<p>This property is mostly just provided to be used by your game - it doesn't effect rendering or logic updates.
However you can use <code>Group.getFirstAlive</code> in conjunction with this property for fast object pooling and recycling.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dl class="details">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.LifeSpan.html#alive">Phaser.Component.LifeSpan#alive</a>
</li></dd>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
Docs updates.
2014-09-09 14:36:56 +00:00
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>true</li></ul></dd>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="src_gameobjects_components_LifeSpan.js.html">gameobjects/components/LifeSpan.js</a>, <a href="src_gameobjects_components_LifeSpan.js.html#sunlight-1-line-50">line 50</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dl>
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="alpha"><span class="type-signature"></span>alpha<span class="type-signature"> :Number</span></h4>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<div class="description">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<p>The opacity of the object.</p>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</div>
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#alpha">PIXI.DisplayObject#alpha</a>
</li></dd>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2.4.4 Release.
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-46">line 46</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dl>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dd>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt>
<h4 class="name "
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
id="anchor"><span class="type-signature"></span>anchor<span class="type-signature"> :Point</span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
<p>The anchor sets the origin point of the texture.
The default is 0,0 this means the texture's origin is the top left
Setting than anchor to 0.5,0.5 means the textures origin is centered
Setting the anchor to 1,1 would mean the textures origin points will be the bottom right corner</p>
</div>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dl class="details">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.Sprite.html#anchor">PIXI.Sprite#anchor</a>
</li></dd>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="src_pixi_display_Sprite.js.html">pixi/display/Sprite.js</a>, <a href="src_pixi_display_Sprite.js.html#sunlight-1-line-22">line 22</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
</dl>
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="angle"><span class="type-signature"></span>angle<span class="type-signature"> :number</span></h4>
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>The angle property is the rotation of the Game Object in <em>degrees</em> from its original orientation.</p>
<p>Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation.</p>
<p>Values outside this range are added to or subtracted from 360 to obtain a value within the range.
For example, the statement player.angle = 450 is the same as player.angle = 90.</p>
<p>If you wish to work in radians instead of degrees you can use the property <code>rotation</code> instead.
Working in radians is slightly faster as it doesn't have to perform any calculations.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Angle.html#angle">Phaser.Component.Angle#angle</a>
</li></dd>
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="src_gameobjects_components_Angle.js.html">gameobjects/components/Angle.js</a>, <a href="src_gameobjects_components_Angle.js.html#sunlight-1-line-29">line 29</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dl>
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dd>
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt>
<h4 class="name "
id="animations"><span class="type-signature"></span>animations<span class="type-signature"> :<a href="Phaser.AnimationManager.html">Phaser.AnimationManager</a></span></h4>
</dt>
<dd>
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>If the Game Object is enabled for animation (such as a Phaser.Sprite) this is a reference to its AnimationManager instance.
Through it you can create, play, pause and stop animations.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dl class="details">
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Core.html#animations">Phaser.Component.Core#animations</a>
</li></dd>
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
Phaser 2.4.8 release.
2016-05-19 11:36:51 +00:00
<a href="src_gameobjects_components_Core.js.html">gameobjects/components/Core.js</a>, <a href="src_gameobjects_components_Core.js.html#sunlight-1-line-181">line 181</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="Phaser.AnimationManager.html">Phaser.AnimationManager</a></li>
</ul>
</dd>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dl>
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="autoCull"><span class="type-signature"></span>autoCull<span class="type-signature"> :boolean</span></h4>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>A Game Object with <code>autoCull</code> set to true will check its bounds against the World Camera every frame.
If it is not intersecting the Camera bounds at any point then it has its <code>renderable</code> property set to <code>false</code>.
This keeps the Game Object alive and still processing updates, but forces it to skip the render step entirely.</p>
<p>This is a relatively expensive operation, especially if enabled on hundreds of Game Objects. So enable it only if you know it's required,
or you have tested performance and find it acceptable.</p>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</div>
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.AutoCull.html#autoCull">Phaser.Component.AutoCull#autoCull</a>
</li></dd>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="src_gameobjects_components_AutoCull.js.html">gameobjects/components/AutoCull.js</a>, <a href="src_gameobjects_components_AutoCull.js.html#sunlight-1-line-28">line 28</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="blendMode"><span class="type-signature"></span>blendMode<span class="type-signature"> :Number</span></h4>
</dt>
<dd>
<div class="description">
<p>The blend mode to be applied to the sprite. Set to PIXI.blendModes.NORMAL to remove any blend mode.</p>
New docs.
2015-08-24 14:43:45 +00:00
<p>Warning: You cannot have a blend mode and a filter active on the same Sprite. Doing so will render the sprite invisible.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.Sprite.html#blendMode">PIXI.Sprite#blendMode</a>
</li></dd>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>PIXI.blendModes.NORMAL;</li></ul></dd>
<dt class="tag-source">Source -
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="src_pixi_display_Sprite.js.html">pixi/display/Sprite.js</a>, <a href="src_pixi_display_Sprite.js.html#sunlight-1-line-87">line 87</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
id="bottom"><span class="type-signature">&lt;readonly> </span>bottom<span class="type-signature"> :number</span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>The sum of the y and height properties.
This is the same as <code>y + height - offsetY</code>.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="Phaser.Component.Bounds.html#bottom">Phaser.Component.Bounds#bottom</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li></dd>
<dt class="tag-source">Source -
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="src_gameobjects_components_Bounds.js.html">gameobjects/components/Bounds.js</a>, <a href="src_gameobjects_components_Bounds.js.html#sunlight-1-line-110">line 110</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="cacheAsBitmap"><span class="type-signature"></span>cacheAsBitmap<span class="type-signature"> :Boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>Set if this display object is cached as a bitmap.
This basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects.
To remove simply set this property to 'null'</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#cacheAsBitmap">PIXI.DisplayObject#cacheAsBitmap</a>
</li></dd>
<dt class="tag-source">Source -
2.4.4 Release.
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-355">line 355</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="cameraOffset"><span class="type-signature"></span>cameraOffset<span class="type-signature"> :<a href="Phaser.Point.html">Phaser.Point</a></span></h4>
</dt>
<dd>
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>The x/y coordinate offset applied to the top-left of the camera that this Game Object will be drawn at if <code>fixedToCamera</code> is true.</p>
<p>The values are relative to the top-left of the camera view and in addition to any parent of the Game Object on the display list.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.FixedToCamera.html#cameraOffset">Phaser.Component.FixedToCamera#cameraOffset</a>
</li></dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
New API Docs.
2015-03-26 02:38:46 +00:00
<a href="src_gameobjects_components_FixedToCamera.js.html">gameobjects/components/FixedToCamera.js</a>, <a href="src_gameobjects_components_FixedToCamera.js.html#sunlight-1-line-86">line 86</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
id="children"><span class="type-signature">&lt;readonly> </span>children<span class="type-signature"> :Array.&lt;<a href="global.html#DisplayObject">DisplayObject</a>></span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
<p>[read-only] The array of children of this container.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<span class="param-type">Array.&lt;<a href="global.html#DisplayObject">DisplayObject</a>></span>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObjectContainer.html#children">PIXI.DisplayObjectContainer#children</a>
</li></dd>
<dt class="tag-source">Source -
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-17">line 17</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
id="components"><span class="type-signature">&lt;internal> </span>components<span class="type-signature"> :object</span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>The components this Game Object has installed.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Core.html#components">Phaser.Component.Core#components</a>
</li></dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
Phaser 2.4.8 release.
2016-05-19 11:36:51 +00:00
<a href="src_gameobjects_components_Core.js.html">gameobjects/components/Core.js</a>, <a href="src_gameobjects_components_Core.js.html#sunlight-1-line-155">line 155</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
id="cropRect"><span class="type-signature"></span>cropRect<span class="type-signature"> :<a href="Phaser.Rectangle.html">Phaser.Rectangle</a></span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>The Rectangle used to crop the texture this Game Object uses.
Set this property via <code>crop</code>.
If you modify this property directly you must call <code>updateCrop</code> in order to have the change take effect.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Crop.html#cropRect">Phaser.Component.Crop#cropRect</a>
</li></dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="src_gameobjects_components_Crop.js.html">gameobjects/components/Crop.js</a>, <a href="src_gameobjects_components_Crop.js.html#sunlight-1-line-24">line 24</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
id="debug"><span class="type-signature"></span>debug<span class="type-signature"> :boolean</span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>A debug flag designed for use with <code>Game.enableStep</code>.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Core.html#debug">Phaser.Component.Core#debug</a>
</li></dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
Phaser 2.4.8 release.
2016-05-19 11:36:51 +00:00
<a href="src_gameobjects_components_Core.js.html">gameobjects/components/Core.js</a>, <a href="src_gameobjects_components_Core.js.html#sunlight-1-line-206">line 206</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
id="destroyPhase"><span class="type-signature">&lt;readonly> </span>destroyPhase<span class="type-signature"> :boolean</span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>As a Game Object runs through its destroy method this flag is set to true,
and can be checked in any sub-systems or plugins it is being destroyed from.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Destroy.html#destroyPhase">Phaser.Component.Destroy#destroyPhase</a>
</li></dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="src_gameobjects_components_Destroy.js.html">gameobjects/components/Destroy.js</a>, <a href="src_gameobjects_components_Destroy.js.html#sunlight-1-line-22">line 22</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
id="events"><span class="type-signature"></span>events<span class="type-signature"> :<a href="Phaser.Events.html">Phaser.Events</a></span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>All Phaser Game Objects have an Events class which contains all of the events that are dispatched when certain things happen to this
Game Object, or any of its components.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Core.html#events">Phaser.Component.Core#events</a>
</li></dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
Phaser 2.4.8 release.
2016-05-19 11:36:51 +00:00
<a href="src_gameobjects_components_Core.js.html">gameobjects/components/Core.js</a>, <a href="src_gameobjects_components_Core.js.html#sunlight-1-line-173">line 173</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="Phaser.Events.html">Phaser.Events</a></li>
</ul>
</dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dl>
</dd>
<dt>
<h4 class="name "
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
id="exists"><span class="type-signature"></span>exists<span class="type-signature"> :boolean</span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>Controls if this Game Object is processed by the core game loop.
If this Game Object has a physics body it also controls if its physics body is updated or not.
When <code>exists</code> is set to <code>false</code> it will remove its physics body from the physics world if it has one.
It also toggles the <code>visible</code> property to false as well.</p>
<p>Setting <code>exists</code> to true will add its physics body back in to the physics world, if it has one.
It will also set the <code>visible</code> property to <code>true</code>.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Core.html#exists">Phaser.Component.Core#exists</a>
</li></dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
Phaser 2.4.8 release.
2016-05-19 11:36:51 +00:00
<a href="src_gameobjects_components_Core.js.html">gameobjects/components/Core.js</a>, <a href="src_gameobjects_components_Core.js.html#sunlight-1-line-272">line 272</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
id="filterArea"><span class="type-signature"></span>filterArea<span class="type-signature"> :Rectangle</span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>The area the filter is applied to like the hitArea this is used as more of an optimisation
rather than figuring out the dimensions of the displayObject each frame you can set this rectangle</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#filterArea">PIXI.DisplayObject#filterArea</a>
</li></dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2.4.4 Release.
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-164">line 164</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
id="filters"><span class="type-signature"></span>filters<span class="type-signature"> :Array.&lt;Filter></span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>Sets the filters for the displayObject.
New docs.
2015-08-24 14:43:45 +00:00
IMPORTANT: This is a webGL only feature and will be ignored by the Canvas renderer.</p>
<p>To remove filters simply set this property to 'null'.</p>
<p>You cannot have a filter and a multiply blend mode active at the same time. Setting a filter will reset
this objects blend mode to NORMAL.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.&lt;Filter></span>
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
</li>
</ul>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="PIXI.DisplayObject.html#filters">PIXI.DisplayObject#filters</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li></dd>
<dt class="tag-source">Source -
2.4.4 Release.
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-307">line 307</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
id="fixedToCamera"><span class="type-signature"></span>fixedToCamera<span class="type-signature"> :boolean</span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>A Game Object that is &quot;fixed&quot; to the camera uses its x/y coordinates as offsets from the top left of the camera during rendering.</p>
<p>The values are adjusted at the rendering stage, overriding the Game Objects actual world position.</p>
<p>The end result is that the Game Object will appear to be 'fixed' to the camera, regardless of where in the game world
the camera is viewing. This is useful if for example this Game Object is a UI item that you wish to be visible at all times
regardless where in the world the camera is.</p>
<p>The offsets are stored in the <code>cameraOffset</code> property.</p>
<p>Note that the <code>cameraOffset</code> values are in addition to any parent of this Game Object on the display list.</p>
<p>Be careful not to set <code>fixedToCamera</code> on Game Objects which are in Groups that already have <code>fixedToCamera</code> enabled on them.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="Phaser.Component.FixedToCamera.html#fixedToCamera">Phaser.Component.FixedToCamera#fixedToCamera</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li></dd>
<dt class="tag-source">Source -
New API Docs.
2015-03-26 02:38:46 +00:00
<a href="src_gameobjects_components_FixedToCamera.js.html">gameobjects/components/FixedToCamera.js</a>, <a href="src_gameobjects_components_FixedToCamera.js.html#sunlight-1-line-56">line 56</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
id="frame"><span class="type-signature"></span>frame<span class="type-signature"> :integer</span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>Gets or sets the current frame index of the texture being used to render this Game Object.</p>
<p>To change the frame set <code>frame</code> to the index of the new frame in the sprite sheet you wish this Game Object to use,
for example: <code>player.frame = 4</code>.</p>
<p>If the frame index given doesn't exist it will revert to the first frame found in the texture.</p>
<p>If you are using a texture atlas then you should use the <code>frameName</code> property instead.</p>
<p>If you wish to fully replace the texture being used see <code>loadTexture</code>.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.LoadTexture.html#frame">Phaser.Component.LoadTexture#frame</a>
</li></dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
Phaser 2.4.7 Final.
2016-04-22 14:15:28 +00:00
<a href="src_gameobjects_components_LoadTexture.js.html">gameobjects/components/LoadTexture.js</a>, <a href="src_gameobjects_components_LoadTexture.js.html#sunlight-1-line-254">line 254</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
id="frameName"><span class="type-signature"></span>frameName<span class="type-signature"> :string</span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>Gets or sets the current frame name of the texture being used to render this Game Object.</p>
<p>To change the frame set <code>frameName</code> to the name of the new frame in the texture atlas you wish this Game Object to use,
for example: <code>player.frameName = &quot;idle&quot;</code>.</p>
<p>If the frame name given doesn't exist it will revert to the first frame found in the texture and throw a console warning.</p>
<p>If you are using a sprite sheet then you should use the <code>frame</code> property instead.</p>
<p>If you wish to fully replace the texture being used see <code>loadTexture</code>.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.LoadTexture.html#frameName">Phaser.Component.LoadTexture#frameName</a>
</li></dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
Phaser 2.4.7 Final.
2016-04-22 14:15:28 +00:00
<a href="src_gameobjects_components_LoadTexture.js.html">gameobjects/components/LoadTexture.js</a>, <a href="src_gameobjects_components_LoadTexture.js.html#sunlight-1-line-279">line 279</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
id="fresh"><span class="type-signature">&lt;readonly> </span>fresh<span class="type-signature"> :boolean</span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>A Game Object is considered <code>fresh</code> if it has just been created or reset and is yet to receive a renderer transform update.
This property is mostly used internally by the physics systems, but is exposed for the use of plugins.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Core.html#fresh">Phaser.Component.Core#fresh</a>
</li></dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
Phaser 2.4.8 release.
2016-05-19 11:36:51 +00:00
<a href="src_gameobjects_components_Core.js.html">gameobjects/components/Core.js</a>, <a href="src_gameobjects_components_Core.js.html#sunlight-1-line-236">line 236</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="game"><span class="type-signature"></span>game<span class="type-signature"> :<a href="Phaser.Game.html">Phaser.Game</a></span></h4>
</dt>
<dd>
<div class="description">
<p>A reference to the currently running Game.</p>
</div>
<dl class="details">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Core.html#game">Phaser.Component.Core#game</a>
</li></dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
Phaser 2.4.8 release.
2016-05-19 11:36:51 +00:00
<a href="src_gameobjects_components_Core.js.html">gameobjects/components/Core.js</a>, <a href="src_gameobjects_components_Core.js.html#sunlight-1-line-140">line 140</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="height"><span class="type-signature"></span>height<span class="type-signature"> :Number</span></h4>
</dt>
<dd>
<div class="description">
<p>The height of the sprite, setting this will actually modify the scale to achieve the value set</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.Sprite.html#height">PIXI.Sprite#height</a>
</li></dd>
<dt class="tag-source">Source -
New docs.
2015-08-24 14:43:45 +00:00
<a href="src_pixi_display_Sprite.js.html">pixi/display/Sprite.js</a>, <a href="src_pixi_display_Sprite.js.html#sunlight-1-line-139">line 139</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
id="hitArea"><span class="type-signature"></span>hitArea<span class="type-signature"> :Rectangle|Circle|Ellipse|Polygon</span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
<p>This is the defined area that will pick up mouse / touch events. It is null by default.
Setting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)</p>
</div>
<h5>Type:</h5>
<ul>
<li>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<span class="param-type">Rectangle</span>
2.2 doc files.
2014-11-15 20:01:46 +00:00
|
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<span class="param-type">Circle</span>
2.2 doc files.
2014-11-15 20:01:46 +00:00
|
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<span class="param-type">Ellipse</span>
2.2 doc files.
2014-11-15 20:01:46 +00:00
|
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<span class="param-type">Polygon</span>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#hitArea">PIXI.DisplayObject#hitArea</a>
</li></dd>
<dt class="tag-source">Source -
2.4.4 Release.
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-62">line 62</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="inCamera"><span class="type-signature">&lt;readonly> </span>inCamera<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>Checks if the Game Objects bounds intersect with the Game Camera bounds.
Returns <code>true</code> if they do, otherwise <code>false</code> if fully outside of the Cameras bounds.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.AutoCull.html#inCamera">Phaser.Component.AutoCull#inCamera</a>
</li></dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="src_gameobjects_components_AutoCull.js.html">gameobjects/components/AutoCull.js</a>, <a href="src_gameobjects_components_AutoCull.js.html#sunlight-1-line-37">line 37</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="input"><span class="type-signature"></span>input<span class="type-signature"> :<a href="Phaser.InputHandler.html">Phaser.InputHandler</a>|null</span></h4>
</dt>
<dd>
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>The Input Handler for this Game Object.</p>
<p>By default it is disabled. If you wish this Game Object to process input events you should enable it with: <code>inputEnabled = true</code>.</p>
<p>After you have done this, this property will be a reference to the Phaser InputHandler.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="Phaser.InputHandler.html">Phaser.InputHandler</a></span>
|
<span class="param-type">null</span>
</li>
</ul>
<dl class="details">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.InputEnabled.html#input">Phaser.Component.InputEnabled#input</a>
</li></dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="src_gameobjects_components_InputEnabled.js.html">gameobjects/components/InputEnabled.js</a>, <a href="src_gameobjects_components_InputEnabled.js.html#sunlight-1-line-24">line 24</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="inputEnabled"><span class="type-signature"></span>inputEnabled<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>By default a Game Object won't process any input events. By setting <code>inputEnabled</code> to true a Phaser.InputHandler is created
for this Game Object and it will then start to process click / touch events and more.</p>
<p>You can then access the Input Handler via <code>this.input</code>.</p>
<p>Note that Input related events are dispatched from <code>this.events</code>, i.e.: <code>events.onInputDown</code>.</p>
<p>If you set this property to false it will stop the Input Handler from processing any more input events.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.InputEnabled.html#inputEnabled">Phaser.Component.InputEnabled#inputEnabled</a>
</li></dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="src_gameobjects_components_InputEnabled.js.html">gameobjects/components/InputEnabled.js</a>, <a href="src_gameobjects_components_InputEnabled.js.html#sunlight-1-line-38">line 38</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
id="key"><span class="type-signature"></span>key<span class="type-signature"> :string|<a href="Phaser.RenderTexture.html">Phaser.RenderTexture</a>|<a href="Phaser.BitmapData.html">Phaser.BitmapData</a>|<a href="Phaser.Video.html">Phaser.Video</a>|<a href="PIXI.Texture.html">PIXI.Texture</a></span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>The key of the image or texture used by this Game Object during rendering.
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
If it is a string it's the string used to retrieve the texture from the Phaser Image Cache.
It can also be an instance of a RenderTexture, BitmapData, Video or PIXI.Texture.
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
If a Game Object is created without a key it is automatically assigned the key <code>__default</code> which is a 32x32 transparent PNG stored within the Cache.
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
If a Game Object is given a key which doesn't exist in the Image Cache it is re-assigned the key <code>__missing</code> which is a 32x32 PNG of a green box with a line through it.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
|
<span class="param-type"><a href="Phaser.RenderTexture.html">Phaser.RenderTexture</a></span>
|
<span class="param-type"><a href="Phaser.BitmapData.html">Phaser.BitmapData</a></span>
|
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<span class="param-type"><a href="Phaser.Video.html">Phaser.Video</a></span>
|
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<span class="param-type"><a href="PIXI.Texture.html">PIXI.Texture</a></span>
</li>
</ul>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dl class="details">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Core.html#key">Phaser.Component.Core#key</a>
</li></dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
Phaser 2.4.8 release.
2016-05-19 11:36:51 +00:00
<a href="src_gameobjects_components_Core.js.html">gameobjects/components/Core.js</a>, <a href="src_gameobjects_components_Core.js.html#sunlight-1-line-191">line 191</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
id="left"><span class="type-signature">&lt;readonly> </span>left<span class="type-signature"> :number</span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>The left coordinate of the Game Object.
This is the same as <code>x - offsetX</code>.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Bounds.html#left">Phaser.Component.Bounds#left</a>
</li></dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="tag-source">Source -
<a href="src_gameobjects_components_Bounds.js.html">gameobjects/components/Bounds.js</a>, <a href="src_gameobjects_components_Bounds.js.html#sunlight-1-line-59">line 59</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="lifespan"><span class="type-signature"></span>lifespan<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The lifespan allows you to give a Game Object a lifespan in milliseconds.</p>
<p>Once the Game Object is 'born' you can set this to a positive value.</p>
<p>It is automatically decremented by the millisecond equivalent of <code>game.time.physicsElapsed</code> each frame.
When it reaches zero it will call the <code>kill</code> method.</p>
<p>Very handy for particles, bullets, collectibles, or any other short-lived entity.</p>
</div>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dl class="details">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.LifeSpan.html#lifespan">Phaser.Component.LifeSpan#lifespan</a>
</li></dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="src_gameobjects_components_LifeSpan.js.html">gameobjects/components/LifeSpan.js</a>, <a href="src_gameobjects_components_LifeSpan.js.html#sunlight-1-line-65">line 65</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="mask"><span class="type-signature"></span>mask<span class="type-signature"> :<a href="PIXI.Graphics.html">PIXI.Graphics</a></span></h4>
</dt>
<dd>
<div class="description">
<p>Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it.
In PIXI a regular mask must be a PIXI.Graphics object. This allows for much faster masking in canvas as it utilises shape clipping.
To remove a mask, set this property to null.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#mask">PIXI.DisplayObject#mask</a>
</li></dd>
<dt class="tag-source">Source -
2.4.4 Release.
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-282">line 282</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="name"><span class="type-signature"></span>name<span class="type-signature"> :string</span></h4>
</dt>
<dd>
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>A user defined name given to this Game Object.
This value isn't ever used internally by Phaser, it is meant as a game level property.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Core.html#name">Phaser.Component.Core#name</a>
</li></dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
Phaser 2.4.8 release.
2016-05-19 11:36:51 +00:00
<a href="src_gameobjects_components_Core.js.html">gameobjects/components/Core.js</a>, <a href="src_gameobjects_components_Core.js.html#sunlight-1-line-148">line 148</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
id="offsetX"><span class="type-signature">&lt;readonly> </span>offsetX<span class="type-signature"> :number</span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>The amount the Game Object is visually offset from its x coordinate.
This is the same as <code>width * anchor.x</code>.
It will only be &gt; 0 if anchor.x is not equal to zero.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="Phaser.Component.Bounds.html#offsetX">Phaser.Component.Bounds#offsetX</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li></dd>
<dt class="tag-source">Source -
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="src_gameobjects_components_Bounds.js.html">gameobjects/components/Bounds.js</a>, <a href="src_gameobjects_components_Bounds.js.html#sunlight-1-line-24">line 24</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
id="offsetY"><span class="type-signature">&lt;readonly> </span>offsetY<span class="type-signature"> :number</span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>The amount the Game Object is visually offset from its y coordinate.
This is the same as <code>height * anchor.y</code>.
It will only be &gt; 0 if anchor.y is not equal to zero.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="Phaser.Component.Bounds.html#offsetY">Phaser.Component.Bounds#offsetY</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li></dd>
<dt class="tag-source">Source -
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="src_gameobjects_components_Bounds.js.html">gameobjects/components/Bounds.js</a>, <a href="src_gameobjects_components_Bounds.js.html#sunlight-1-line-42">line 42</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
id="parent"><span class="type-signature">&lt;readonly> </span>parent<span class="type-signature"> :<a href="PIXI.DisplayObjectContainer.html">PIXI.DisplayObjectContainer</a></span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>[read-only] The display object container that contains this display object.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="PIXI.DisplayObject.html#parent">PIXI.DisplayObject#parent</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li></dd>
<dt class="tag-source">Source -
2.4.4 Release.
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-79">line 79</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
id="pendingDestroy"><span class="type-signature"></span>pendingDestroy<span class="type-signature"> :boolean</span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<p>A Game Object is that is pendingDestroy is flagged to have its destroy method called on the next logic update.
You can set it directly to allow you to flag an object to be destroyed on its next update.</p>
<p>This is extremely useful if you wish to destroy an object from within one of its own callbacks
such as with Buttons or other Input events.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="Phaser.Component.Core.html#pendingDestroy">Phaser.Component.Core#pendingDestroy</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li></dd>
<dt class="tag-source">Source -
Phaser 2.4.8 release.
2016-05-19 11:36:51 +00:00
<a href="src_gameobjects_components_Core.js.html">gameobjects/components/Core.js</a>, <a href="src_gameobjects_components_Core.js.html#sunlight-1-line-247">line 247</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
id="pivot"><span class="type-signature"></span>pivot<span class="type-signature"> :Point</span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<p>The pivot point of the displayObject that it rotates around</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="PIXI.DisplayObject.html#pivot">PIXI.DisplayObject#pivot</a>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
</li></dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2.4.4 Release.
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-30">line 30</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
id="position"><span class="type-signature"></span>position<span class="type-signature"> :Point</span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<p>The coordinate of the object relative to the local coordinates of the parent.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="PIXI.DisplayObject.html#position">PIXI.DisplayObject#position</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li></dd>
<dt class="tag-source">Source -
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-14">line 14</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
id="previousPosition"><span class="type-signature">&lt;readonly> </span>previousPosition<span class="type-signature"> :<a href="Phaser.Point.html">Phaser.Point</a></span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<p>The position the Game Object was located in the previous frame.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="Phaser.Component.Core.html#previousPosition">Phaser.Component.Core#previousPosition</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li></dd>
<dt class="tag-source">Source -
Phaser 2.4.8 release.
2016-05-19 11:36:51 +00:00
<a href="src_gameobjects_components_Core.js.html">gameobjects/components/Core.js</a>, <a href="src_gameobjects_components_Core.js.html#sunlight-1-line-213">line 213</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
id="previousRotation"><span class="type-signature">&lt;readonly> </span>previousRotation<span class="type-signature"> :number</span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<p>The rotation the Game Object was in set to in the previous frame. Value is in radians.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="Phaser.Component.Core.html#previousRotation">Phaser.Component.Core#previousRotation</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li></dd>
<dt class="tag-source">Source -
Phaser 2.4.8 release.
2016-05-19 11:36:51 +00:00
<a href="src_gameobjects_components_Core.js.html">gameobjects/components/Core.js</a>, <a href="src_gameobjects_components_Core.js.html#sunlight-1-line-220">line 220</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
id="renderable"><span class="type-signature"></span>renderable<span class="type-signature"> :Boolean</span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<p>Can this object be rendered</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="PIXI.DisplayObject.html#renderable">PIXI.DisplayObject#renderable</a>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
</li></dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2.4.4 Release.
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-71">line 71</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
id="renderOrderID"><span class="type-signature">&lt;readonly> </span>renderOrderID<span class="type-signature"> :number</span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<p>The render order ID is used internally by the renderer and Input Manager and should not be modified.
This property is mostly used internally by the renderers, but is exposed for the use of plugins.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Core.html#renderOrderID">Phaser.Component.Core#renderOrderID</a>
</li></dd>
<dt class="tag-source">Source -
Phaser 2.4.8 release.
2016-05-19 11:36:51 +00:00
<a href="src_gameobjects_components_Core.js.html">gameobjects/components/Core.js</a>, <a href="src_gameobjects_components_Core.js.html#sunlight-1-line-228">line 228</a>
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="right"><span class="type-signature">&lt;readonly> </span>right<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The right coordinate of the Game Object.
This is the same as <code>x + width - offsetX</code>.</p>
</div>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="Phaser.Component.Bounds.html#right">Phaser.Component.Bounds#right</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li></dd>
<dt class="tag-source">Source -
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="src_gameobjects_components_Bounds.js.html">gameobjects/components/Bounds.js</a>, <a href="src_gameobjects_components_Bounds.js.html#sunlight-1-line-76">line 76</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
id="rotation"><span class="type-signature"></span>rotation<span class="type-signature"> :Number</span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>The rotation of the object in radians.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="PIXI.DisplayObject.html#rotation">PIXI.DisplayObject#rotation</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li></dd>
<dt class="tag-source">Source -
2.4.4 Release.
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-38">line 38</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
id="scale"><span class="type-signature"></span>scale<span class="type-signature"> :Point</span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>The scale factor of the object.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="PIXI.DisplayObject.html#scale">PIXI.DisplayObject#scale</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li></dd>
<dt class="tag-source">Source -
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-22">line 22</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
id="shader"><span class="type-signature"></span>shader<span class="type-signature"> :<a href="PIXI.AbstractFilter.html">PIXI.AbstractFilter</a></span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>The shader that will be used to render the texture to the stage. Set to null to remove a current shader.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="PIXI.Sprite.html#shader">PIXI.Sprite#shader</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li></dd>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
New docs.
2015-08-24 14:43:45 +00:00
<a href="src_pixi_display_Sprite.js.html">pixi/display/Sprite.js</a>, <a href="src_pixi_display_Sprite.js.html#sunlight-1-line-98">line 98</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
id="smoothed"><span class="type-signature"></span>smoothed<span class="type-signature"> :boolean</span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>Enable or disable texture smoothing for this Game Object.</p>
<p>It only takes effect if the Game Object is using an image based texture.</p>
<p>Smoothing is enabled by default.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="Phaser.Component.Smoothed.html#smoothed">Phaser.Component.Smoothed#smoothed</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li></dd>
<dt class="tag-source">Source -
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="src_gameobjects_components_Smoothed.js.html">gameobjects/components/Smoothed.js</a>, <a href="src_gameobjects_components_Smoothed.js.html#sunlight-1-line-25">line 25</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
2.4.4 Release.
2015-10-15 11:06:38 +00:00
id="stage"><span class="type-signature">&lt;readonly> </span>stage<span class="type-signature"> :Stage</span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<p>[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#stage">PIXI.DisplayObject#stage</a>
</li></dd>
<dt class="tag-source">Source -
2.4.4 Release.
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-88">line 88</a>
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="texture"><span class="type-signature"></span>texture<span class="type-signature"> :<a href="PIXI.Texture.html">PIXI.Texture</a></span></h4>
</dt>
<dd>
<div class="description">
<p>The texture that the sprite is using</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.Sprite.html#texture">PIXI.Sprite#texture</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_pixi_display_Sprite.js.html">pixi/display/Sprite.js</a>, <a href="src_pixi_display_Sprite.js.html#sunlight-1-line-33">line 33</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="tint"><span class="type-signature"></span>tint<span class="type-signature"> :Number</span></h4>
</dt>
<dd>
<div class="description">
<p>The tint applied to the sprite. This is a hex value. A value of 0xFFFFFF will remove any tint effect.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.Sprite.html#tint">PIXI.Sprite#tint</a>
</li></dd>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>0xFFFFFF</li></ul></dd>
<dt class="tag-source">Source -
<a href="src_pixi_display_Sprite.js.html">pixi/display/Sprite.js</a>, <a href="src_pixi_display_Sprite.js.html#sunlight-1-line-59">line 59</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="tintedTexture"><span class="type-signature"></span>tintedTexture<span class="type-signature"> :Canvas</span></h4>
</dt>
<dd>
<div class="description">
<p>A canvas that contains the tinted version of the Sprite (in Canvas mode, WebGL doesn't populate this)</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.Sprite.html#tintedTexture">PIXI.Sprite#tintedTexture</a>
</li></dd>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd>
<dt class="tag-source">Source -
<a href="src_pixi_display_Sprite.js.html">pixi/display/Sprite.js</a>, <a href="src_pixi_display_Sprite.js.html#sunlight-1-line-78">line 78</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="top"><span class="type-signature">&lt;readonly> </span>top<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The y coordinate of the Game Object.
This is the same as <code>y - offsetY</code>.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="Phaser.Component.Bounds.html#top">Phaser.Component.Bounds#top</a>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
</li></dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="src_gameobjects_components_Bounds.js.html">gameobjects/components/Bounds.js</a>, <a href="src_gameobjects_components_Bounds.js.html#sunlight-1-line-93">line 93</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
id="type"><span class="type-signature">&lt;readonly> </span>type<span class="type-signature"> :number</span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<p>The const type of this object.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
<dt class="tag-source">Source -
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="src_gameobjects_Image.js.html">gameobjects/Image.js</a>, <a href="src_gameobjects_Image.js.html#sunlight-1-line-46">line 46</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
id="visible"><span class="type-signature"></span>visible<span class="type-signature"> :Boolean</span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<p>The visibility of the object.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="PIXI.DisplayObject.html#visible">PIXI.DisplayObject#visible</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li></dd>
<dt class="tag-source">Source -
2.4.4 Release.
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-54">line 54</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
id="width"><span class="type-signature"></span>width<span class="type-signature"> :Number</span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<p>The width of the sprite, setting this will actually modify the scale to achieve the value set</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="PIXI.Sprite.html#width">PIXI.Sprite#width</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li></dd>
<dt class="tag-source">Source -
New docs.
2015-08-24 14:43:45 +00:00
<a href="src_pixi_display_Sprite.js.html">pixi/display/Sprite.js</a>, <a href="src_pixi_display_Sprite.js.html#sunlight-1-line-120">line 120</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
id="world"><span class="type-signature"></span>world<span class="type-signature"> :<a href="Phaser.Point.html">Phaser.Point</a></span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<p>The world coordinates of this Game Object in pixels.
Depending on where in the display list this Game Object is placed this value can differ from <code>position</code>,
which contains the x/y coordinates relative to the Game Objects parent.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Core.html#world">Phaser.Component.Core#world</a>
</li></dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
Phaser 2.4.8 release.
2016-05-19 11:36:51 +00:00
<a href="src_gameobjects_components_Core.js.html">gameobjects/components/Core.js</a>, <a href="src_gameobjects_components_Core.js.html#sunlight-1-line-199">line 199</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
id="worldAlpha"><span class="type-signature">&lt;readonly> </span>worldAlpha<span class="type-signature"> :Number</span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<p>[read-only] The multiplied alpha of the displayObject</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="PIXI.DisplayObject.html#worldAlpha">PIXI.DisplayObject#worldAlpha</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li></dd>
<dt class="tag-source">Source -
2.4.4 Release.
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-97">line 97</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
id="worldPosition"><span class="type-signature">&lt;readonly> </span>worldPosition<span class="type-signature"> :Point</span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<p>The position of the Display Object based on the world transform.
This value is updated at the end of updateTransform and takes all parent transforms into account.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="PIXI.DisplayObject.html#worldPosition">PIXI.DisplayObject#worldPosition</a>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
</li></dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2.4.4 Release.
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-116">line 116</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt>
<h4 class="name "
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
id="worldRotation"><span class="type-signature">&lt;readonly> </span>worldRotation<span class="type-signature"> :Number</span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<p>The rotation of the Display Object, in radians, based on the world transform.
This value is updated at the end of updateTransform and takes all parent transforms into account.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="PIXI.DisplayObject.html#worldRotation">PIXI.DisplayObject#worldRotation</a>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
</li></dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="tag-source">Source -
2.4.4 Release.
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-136">line 136</a>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
</dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
</dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt>
<h4 class="name "
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
id="worldScale"><span class="type-signature">&lt;readonly> </span>worldScale<span class="type-signature"> :Point</span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<div class="description">
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<p>The scale of the Display Object based on the world transform.
This value is updated at the end of updateTransform and takes all parent transforms into account.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="PIXI.DisplayObject.html#worldScale">PIXI.DisplayObject#worldScale</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li></dd>
<dt class="tag-source">Source -
2.4.4 Release.
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-126">line 126</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
id="worldVisible"><span class="type-signature"></span>worldVisible<span class="type-signature"> :Boolean</span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>[read-only] Indicates if the sprite is globally visible.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#worldVisible">PIXI.DisplayObject#worldVisible</a>
</li></dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="tag-source">Source -
2.4.4 Release.
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-258">line 258</a>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
</dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
</dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt>
<h4 class="name "
id="x"><span class="type-signature"></span>x<span class="type-signature"> :Number</span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<div class="description">
<p>The position of the displayObject on the x axis relative to the local coordinates of the parent.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="PIXI.DisplayObject.html#x">PIXI.DisplayObject#x</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li></dd>
<dt class="tag-source">Source -
Phaser 2.4.5 Build files.
2016-02-17 13:27:09 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-723">line 723</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
id="y"><span class="type-signature"></span>y<span class="type-signature"> :Number</span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>The position of the displayObject on the y axis relative to the local coordinates of the parent.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#y">PIXI.DisplayObject#y</a>
</li></dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="tag-source">Source -
Phaser 2.4.5 Build files.
2016-02-17 13:27:09 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-741">line 741</a>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
</dt>
</dl>
</dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt>
<h4 class="name "
2.4.4 Release.
2015-10-15 11:06:38 +00:00
id="z"><span class="type-signature">&lt;readonly> </span>z<span class="type-signature"> :number</span></h4>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
</dt>
<dd>
<div class="description">
<p>The z depth of this Game Object within its parent Group.
No two objects in a Group can have the same z value.
2.4.4 Release.
2015-10-15 11:06:38 +00:00
This value is adjusted automatically whenever the Group hierarchy changes.
If you wish to re-order the layering of a Game Object then see methods like Group.moveUp or Group.bringToTop.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dl class="details">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Core.html#z">Phaser.Component.Core#z</a>
</li></dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
Phaser 2.4.8 release.
2016-05-19 11:36:51 +00:00
<a href="src_gameobjects_components_Core.js.html">gameobjects/components/Core.js</a>, <a href="src_gameobjects_components_Core.js.html#sunlight-1-line-165">line 165</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
</dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<h3 class="subsection-title">Methods</h3>
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt>
<h4 class="name "
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
id="addChild"><span class="type-signature"></span>addChild<span class="signature">(child)</span><span class="type-signature"> &rarr; {<a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a>}</span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>Adds a child to the container.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<td class="name"><code>child</code></td>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<td class="type">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</td>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<td class="description last"><p>The DisplayObject to add to the container</p></td>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
</tr>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
</tbody>
</table>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<h5>Returns:</h5>
<div class="returns">
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<div class="returns-type">
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
-
</div>
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<div class="returns-desc param-desc">
<p>The child that was added.</p>
</div>
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
</div>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dl class="details">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObjectContainer.html#addChild">PIXI.DisplayObjectContainer#addChild</a>
</li></dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-91">line 91</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
id="addChildAt"><span class="type-signature"></span>addChildAt<span class="signature">(child, index)</span><span class="type-signature"> &rarr; {<a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a>}</span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<td class="name"><code>child</code></td>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<td class="type">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</td>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<td class="description last"><p>The child to add</p></td>
</tr>
<tr>
<td class="name"><code>index</code></td>
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<td class="type">
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<span class="param-type">Number</span>
</td>
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<td class="description last"><p>The index to place the child in</p></td>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</tr>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>The child that was added.</p>
</div>
</div>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObjectContainer.html#addChildAt">PIXI.DisplayObjectContainer#addChildAt</a>
</li></dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-103">line 103</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
id="bringToTop"><span class="type-signature"></span>bringToTop<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a>}</span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>Brings this Game Object to the top of its parents display list.
Visually this means it will render over the top of any old child in the same Group.</p>
<p>If this Game Object hasn't been added to a custom Group then this method will bring it to the top of the Game World,
because the World is the root Group from which all Game Objects descend.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
2.2 doc files.
2014-11-15 20:01:46 +00:00
-
</div>
<div class="returns-desc param-desc">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>This instance.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
</div>
<dl class="details">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="Phaser.Component.BringToTop.html#bringToTop">Phaser.Component.BringToTop#bringToTop</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li></dd>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Docs updates.
2014-09-09 14:36:56 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="src_gameobjects_components_BringToTop.js.html">gameobjects/components/BringToTop.js</a>, <a href="src_gameobjects_components_BringToTop.js.html#sunlight-1-line-24">line 24</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
id="crop"><span class="type-signature"></span>crop<span class="signature">(rect, <span class="optional">copy</span>)</span><span class="type-signature"></span></h4>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>Crop allows you to crop the texture being used to display this Game Object.
Setting a crop rectangle modifies the core texture frame. The Game Object width and height properties will be adjusted accordingly.</p>
<p>Cropping takes place from the top-left and can be modified in real-time either by providing an updated rectangle object to this method,
or by modifying <code>cropRect</code> property directly and then calling <code>updateCrop</code>.</p>
<p>The rectangle object given to this method can be either a <code>Phaser.Rectangle</code> or any other object
so long as it has public <code>x</code>, <code>y</code>, <code>width</code>, <code>height</code>, <code>right</code> and <code>bottom</code> properties.</p>
<p>A reference to the rectangle is stored in <code>cropRect</code> unless the <code>copy</code> parameter is <code>true</code>,
in which case the values are duplicated to a local object.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h5>Parameters:</h5>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<table class="params table table-striped">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<thead>
<tr>
<th>Name</th>
<th>Type</th>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<th>Argument</th>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<th>Default</th>
<th class="last">Description</th>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</tr>
</thead>
<tbody>
<tr>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<td class="name"><code>rect</code></td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<td class="type">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<span class="param-type"><a href="Phaser.Rectangle.html">Phaser.Rectangle</a></span>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</td>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<td class="attributes">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<td class="default">
</td>
<td class="description last"><p>The Rectangle used during cropping. Pass null or no parameters to clear a previously set crop rectangle.</p></td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</tr>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<tr>
<td class="name"><code>copy</code></td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<td class="type">
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<span class="param-type">boolean</span>
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>If false <code>cropRect</code> will be stored as a reference to the given rect. If true it will copy the rect values into a local Phaser Rectangle object stored in cropRect.</p></td>
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dl class="details">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="Phaser.Component.Crop.html#crop">Phaser.Component.Crop#crop</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li></dd>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="src_gameobjects_components_Crop.js.html">gameobjects/components/Crop.js</a>, <a href="src_gameobjects_components_Crop.js.html#sunlight-1-line-49">line 49</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
New API Docs.
2015-03-26 02:38:46 +00:00
</dd>
<dt>
<h4 class="name "
id="destroy"><span class="type-signature"></span>destroy<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Destroy this DisplayObject.
Removes all references to transformCallbacks, its parent, the stage, filters, bounds, mask and cached Sprites.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#destroy">PIXI.DisplayObject#destroy</a>
</li></dd>
<dt class="tag-source">Source -
2.4.4 Release.
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-223">line 223</a>
New API Docs.
2015-03-26 02:38:46 +00:00
</dt>
</dl>
Docs update.
2014-04-29 14:39:02 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
Phaser 2.4.8 release.
2016-05-19 11:36:51 +00:00
id="generateTexture"><span class="type-signature"></span>generateTexture<span class="signature">(resolution, scaleMode, renderer)</span><span class="type-signature"> &rarr; {<a href="PIXI.RenderTexture.html">PIXI.RenderTexture</a>}</span></h4>
Docs update.
2014-04-29 14:39:02 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Docs update.
2014-04-29 14:39:02 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>Useful function that returns a texture of the displayObject object that can then be used to create sprites
This can be quite useful if your displayObject is static / complicated and needs to be reused multiple times.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
Docs update.
2014-04-29 14:39:02 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h5>Parameters:</h5>
Docs update.
2014-04-29 14:39:02 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<table class="params table table-striped">
Docs update.
2014-04-29 14:39:02 +00:00
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<td class="name"><code>resolution</code></td>
Docs update.
2014-04-29 14:39:02 +00:00
<td class="type">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<span class="param-type">Number</span>
Docs update.
2014-04-29 14:39:02 +00:00
</td>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<td class="description last"><p>The resolution of the texture being generated</p></td>
</tr>
<tr>
<td class="name"><code>scaleMode</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>See {{#crossLink &quot;PIXI/scaleModes:property&quot;}}PIXI.scaleModes{{/crossLink}} for possible values</p></td>
</tr>
<tr>
<td class="name"><code>renderer</code></td>
<td class="type">
<span class="param-type"><a href="PIXI.CanvasRenderer.html">PIXI.CanvasRenderer</a></span>
|
<span class="param-type"><a href="PIXI.WebGLRenderer.html">PIXI.WebGLRenderer</a></span>
</td>
<td class="description last"><p>The renderer used to generate the texture.</p></td>
Docs update.
2014-04-29 14:39:02 +00:00
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
Phaser 2.4.8 release.
2016-05-19 11:36:51 +00:00
<span class="param-type"><a href="PIXI.RenderTexture.html">PIXI.RenderTexture</a></span>
2.2 doc files.
2014-11-15 20:01:46 +00:00
-
</div>
<div class="returns-desc param-desc">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>a texture of the graphics object</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
</div>
<dl class="details">
Docs update.
2014-04-29 14:39:02 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="PIXI.DisplayObject.html#generateTexture">PIXI.DisplayObject#generateTexture</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li></dd>
Docs update.
2014-04-29 14:39:02 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Docs updates.
2014-09-09 14:36:56 +00:00
Docs update.
2014-04-29 14:39:02 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2.4.4 Release.
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-542">line 542</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
id="getBounds"><span class="type-signature"></span>getBounds<span class="signature">(matrix)</span><span class="type-signature"> &rarr; {Rectangle}</span></h4>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Docs updates.
2014-09-09 14:36:56 +00:00
<div class="description">
Phaser 2.4.8 release.
2016-05-19 11:36:51 +00:00
<p>Returns the bounds of the Sprite as a rectangle.
The bounds calculation takes the worldTransform into account.</p>
<p>It is important to note that the transform is not updated when you call this method.
So if this Sprite is the child of a Display Object which has had its transform
updated since the last render pass, those changes will not yet have been applied
to this Sprites worldTransform. If you need to ensure that all parent transforms
are factored into this getBounds operation then you should call <code>updateTransform</code>
on the root most object in this Sprites display list first.</p>
Docs updates.
2014-09-09 14:36:56 +00:00
</div>
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<h5>Parameters:</h5>
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>matrix</code></td>
<td class="type">
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<span class="param-type">Matrix</span>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
</td>
<td class="description last"><p>the transformation matrix of the sprite</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">Rectangle</span>
-
</div>
<div class="returns-desc param-desc">
<p>the framing rectangle</p>
</div>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.Sprite.html#getBounds">PIXI.Sprite#getBounds</a>
</li></dd>
<dt class="tag-source">Source -
Phaser 2.4.8 release.
2016-05-19 11:36:51 +00:00
<a href="src_pixi_display_Sprite.js.html">pixi/display/Sprite.js</a>, <a href="src_pixi_display_Sprite.js.html#sunlight-1-line-194">line 194</a>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="getChildAt"><span class="type-signature"></span>getChildAt<span class="signature">(index)</span><span class="type-signature"> &rarr; {<a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns the child at the specified index</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>index</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The index to get the child from</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>The child at the given index, if any.</p>
</div>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObjectContainer.html#getChildAt">PIXI.DisplayObjectContainer#getChildAt</a>
</li></dd>
<dt class="tag-source">Source -
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-194">line 194</a>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="getChildIndex"><span class="type-signature"></span>getChildIndex<span class="signature">(child)</span><span class="type-signature"> &rarr; {Number}</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns the index position of a child DisplayObject instance</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>child</code></td>
<td class="type">
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
</td>
<td class="description last"><p>The DisplayObject instance to identify</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">Number</span>
-
</div>
<div class="returns-desc param-desc">
<p>The index position of the child display object to identify</p>
</div>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObjectContainer.html#getChildIndex">PIXI.DisplayObjectContainer#getChildIndex</a>
</li></dd>
<dt class="tag-source">Source -
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-159">line 159</a>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="getLocalBounds"><span class="type-signature"></span>getLocalBounds<span class="signature">()</span><span class="type-signature"> &rarr; {Rectangle}</span></h4>
</dt>
<dd>
<div class="description">
<p>Retrieves the non-global local bounds of the displayObjectContainer as a rectangle. The calculation takes all visible children into consideration.</p>
</div>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">Rectangle</span>
-
</div>
<div class="returns-desc param-desc">
<p>The rectangular bounding area</p>
</div>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObjectContainer.html#getLocalBounds">PIXI.DisplayObjectContainer#getLocalBounds</a>
</li></dd>
<dt class="tag-source">Source -
Phaser 2.4.8 release.
2016-05-19 11:36:51 +00:00
<a href="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-370">line 370</a>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="kill"><span class="type-signature"></span>kill<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Kills a Game Object. A killed Game Object has its <code>alive</code>, <code>exists</code> and <code>visible</code> properties all set to false.</p>
<p>It will dispatch the <code>onKilled</code> event. You can listen to <code>events.onKilled</code> for the signal.</p>
2.4.4 Release.
2015-10-15 11:06:38 +00:00
<p>Note that killing a Game Object is a way for you to quickly recycle it in an object pool,
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
it doesn't destroy the object or free it up from memory.</p>
<p>If you don't need this Game Object any more you should call <code>destroy</code> instead.</p>
</div>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This instance.</p>
</div>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.LifeSpan.html#kill">Phaser.Component.LifeSpan#kill</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_LifeSpan.js.html">gameobjects/components/LifeSpan.js</a>, <a href="src_gameobjects_components_LifeSpan.js.html#sunlight-1-line-113">line 113</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="loadTexture"><span class="type-signature"></span>loadTexture<span class="signature">(key, <span class="optional">frame</span>, <span class="optional">stopAnimation</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Changes the base texture the Game Object is using. The old texture is removed and the new one is referenced or fetched from the Cache.</p>
<p>If your Game Object is using a frame from a texture atlas and you just wish to change to another frame, then see the <code>frame</code> or <code>frameName</code> properties instead.</p>
<p>You should only use <code>loadTexture</code> if you want to replace the base texture entirely.</p>
<p>Calling this method causes a WebGL texture update, so use sparingly or in low-intensity portions of your game, or if you know the new texture is already on the GPU.</p>
New docs.
2016-02-08 17:01:36 +00:00
<p>You can use the new const <code>Phaser.PENDING_ATLAS</code> as the texture key for any sprite.
Doing this then sets the key to be the <code>frame</code> argument (the frame is set to zero). </p>
<p>This allows you to create sprites using <code>load.image</code> during development, and then change them
to use a Texture Atlas later in development by simply searching your code for 'PENDING_ATLAS'
and swapping it to be the key of the atlas data.</p>
Phaser 2.4.7 Final.
2016-04-22 14:15:28 +00:00
<p>Note: You cannot use a RenderTexture as a texture for a TileSprite.</p>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type"><a href="Phaser.RenderTexture.html">Phaser.RenderTexture</a></span>
|
<span class="param-type"><a href="Phaser.BitmapData.html">Phaser.BitmapData</a></span>
|
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<span class="param-type"><a href="Phaser.Video.html">Phaser.Video</a></span>
|
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<span class="param-type"><a href="PIXI.Texture.html">PIXI.Texture</a></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<td class="description last"><p>This is the image or texture used by the Sprite during rendering. It can be a string which is a reference to the Cache Image entry, or an instance of a RenderTexture, BitmapData, Video or PIXI.Texture.</p></td>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
</tr>
<tr>
<td class="name"><code>frame</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>If this Sprite is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.</p></td>
</tr>
<tr>
<td class="name"><code>stopAnimation</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>If an animation is already playing on this Sprite you can choose to stop it or let it carry on playing.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.LoadTexture.html#loadTexture">Phaser.Component.LoadTexture#loadTexture</a>
</li></dd>
<dt class="tag-source">Source -
Phaser 2.4.7 Final.
2016-04-22 14:15:28 +00:00
<a href="src_gameobjects_components_LoadTexture.js.html">gameobjects/components/LoadTexture.js</a>, <a href="src_gameobjects_components_LoadTexture.js.html#sunlight-1-line-51">line 51</a>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="moveDown"><span class="type-signature"></span>moveDown<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Moves this Game Object down one place in its parents display list.
This call has no effect if the Game Object is already at the bottom of the display list.</p>
<p>If this Game Object hasn't been added to a custom Group then this method will move it one object down within the Game World,
because the World is the root Group from which all Game Objects descend.</p>
</div>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
2.2 doc files.
2014-11-15 20:01:46 +00:00
-
</div>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="returns-desc param-desc">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>This instance.</p>
</div>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.BringToTop.html#moveDown">Phaser.Component.BringToTop#moveDown</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_BringToTop.js.html">gameobjects/components/BringToTop.js</a>, <a href="src_gameobjects_components_BringToTop.js.html#sunlight-1-line-87">line 87</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="moveUp"><span class="type-signature"></span>moveUp<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Moves this Game Object up one place in its parents display list.
This call has no effect if the Game Object is already at the top of the display list.</p>
<p>If this Game Object hasn't been added to a custom Group then this method will move it one object up within the Game World,
because the World is the root Group from which all Game Objects descend.</p>
</div>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>This instance.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="Phaser.Component.BringToTop.html#moveUp">Phaser.Component.BringToTop#moveUp</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li></dd>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="src_gameobjects_components_BringToTop.js.html">gameobjects/components/BringToTop.js</a>, <a href="src_gameobjects_components_BringToTop.js.html#sunlight-1-line-66">line 66</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dl>
</dd>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt>
<h4 class="name "
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
id="overlap"><span class="type-signature"></span>overlap<span class="signature">(displayObject)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>Checks to see if the bounds of this Game Object overlaps with the bounds of the given Display Object,
which can be a Sprite, Image, TileSprite or anything that extends those such as Button or provides a <code>getBounds</code> method and result.</p>
<p>This check ignores the <code>hitArea</code> property if set and runs a <code>getBounds</code> comparison on both objects to determine the result.</p>
<p>Therefore it's relatively expensive to use in large quantities, i.e. with lots of Sprites at a high frequency.
It should be fine for low-volume testing where physics isn't required.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>displayObject</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Sprite.html">Phaser.Sprite</a></span>
|
<span class="param-type"><a href="Phaser.Image.html">Phaser.Image</a></span>
|
<span class="param-type"><a href="Phaser.TileSprite.html">Phaser.TileSprite</a></span>
|
<span class="param-type"><a href="Phaser.Button.html">Phaser.Button</a></span>
|
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
</td>
<td class="description last"><p>The display object to check against.</p></td>
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h5>Returns:</h5>
<div class="returns">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="returns-type">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<span class="param-type">boolean</span>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
-
</div>
<div class="returns-desc param-desc">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>True if the bounds of this Game Object intersects at any point with the bounds of the given display object.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Overlap.html#overlap">Phaser.Component.Overlap#overlap</a>
</li></dd>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="src_gameobjects_components_Overlap.js.html">gameobjects/components/Overlap.js</a>, <a href="src_gameobjects_components_Overlap.js.html#sunlight-1-line-29">line 29</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
id="play"><span class="type-signature"></span>play<span class="signature">(name, <span class="optional">frameRate</span>, <span class="optional">loop</span>, <span class="optional">killOnComplete</span>)</span><span class="type-signature"> &rarr; {<a href="Phaser.Animation.html">Phaser.Animation</a>}</span></h4>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Docs updates.
2014-09-09 14:36:56 +00:00
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>Plays an Animation.</p>
<p>The animation should have previously been created via <code>animations.add</code>.</p>
<p>If the animation is already playing calling this again won't do anything.
If you need to reset an already running animation do so directly on the Animation object itself or via <code>AnimationManager.stop</code>.</p>
Docs updates.
2014-09-09 14:36:56 +00:00
</div>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h5>Parameters:</h5>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<table class="params table table-striped">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<thead>
<tr>
<th>Name</th>
<th>Type</th>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<th>Argument</th>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<th>Default</th>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<td class="name"><code>name</code></td>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<td class="type">
<span class="param-type">string</span>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
</td>
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The name of the animation to be played, e.g. &quot;fire&quot;, &quot;walk&quot;, &quot;jump&quot;. Must have been previously created via 'AnimationManager.add'.</p></td>
</tr>
<tr>
<td class="name"><code>frameRate</code></td>
<td class="type">
<span class="param-type">number</span>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</td>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<td class="attributes">
&lt;optional><br>
</td>
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<td class="default">
null
</td>
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<td class="description last"><p>The framerate to play the animation at. The speed is given in frames per second. If not provided the previously set frameRate of the Animation is used.</p></td>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</tr>
<tr>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<td class="name"><code>loop</code></td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<td class="type">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<span class="param-type">boolean</span>
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>Should the animation be looped after playback. If not provided the previously set loop value of the Animation is used.</p></td>
</tr>
<tr>
<td class="name"><code>killOnComplete</code></td>
<td class="type">
<span class="param-type">boolean</span>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</td>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<td class="attributes">
&lt;optional><br>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<td class="default">
false
</td>
<td class="description last"><p>If set to true when the animation completes (only happens if loop=false) the parent Sprite will be killed.</p></td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</tr>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="Phaser.Animation.html">Phaser.Animation</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>A reference to playing Animation.</p>
</div>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Animation.html#play">Phaser.Component.Animation#play</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_Animation.js.html">gameobjects/components/Animation.js</a>, <a href="src_gameobjects_components_Animation.js.html#sunlight-1-line-31">line 31</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="postUpdate"><span class="type-signature">&lt;internal> </span>postUpdate<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Internal method called by the World postUpdate cycle.</p>
</div>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dl class="details">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Core.html#postUpdate">Phaser.Component.Core#postUpdate</a>
</li></dd>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="important tag-deprecated">Internal:</dt>
<dd class="tag-deprecated"><ul>
<li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li>
</ul></dd>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
Phaser 2.4.8 release.
2016-05-19 11:36:51 +00:00
<a href="src_gameobjects_components_Core.js.html">gameobjects/components/Core.js</a>, <a href="src_gameobjects_components_Core.js.html#sunlight-1-line-326">line 326</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
id="preUpdate"><span class="type-signature"></span>preUpdate<span class="signature">()</span><span class="type-signature"></span></h4>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>Automatically called by World.preUpdate.</p>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</div>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dl class="details">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="src_gameobjects_Image.js.html">gameobjects/Image.js</a>, <a href="src_gameobjects_Image.js.html#sunlight-1-line-77">line 77</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
id="removeChild"><span class="type-signature"></span>removeChild<span class="signature">(child)</span><span class="type-signature"> &rarr; {<a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a>}</span></h4>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<p>Removes a child from the container.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h5>Parameters:</h5>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<table class="params table table-striped">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<td class="name"><code>child</code></td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<td class="type">
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</td>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<td class="description last"><p>The DisplayObject to remove</p></td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</tr>
</tbody>
</table>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>The child that was removed.</p>
</div>
</div>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dl class="details">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<a href="PIXI.DisplayObjectContainer.html#removeChild">PIXI.DisplayObjectContainer#removeChild</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li></dd>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-211">line 211</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
id="removeChildAt"><span class="type-signature"></span>removeChildAt<span class="signature">(index)</span><span class="type-signature"> &rarr; {<a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a>}</span></h4>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<p>Removes a child from the specified index position.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h5>Parameters:</h5>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<table class="params table table-striped">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<td class="name"><code>index</code></td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<td class="type">
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<span class="param-type">Number</span>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</td>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<td class="description last"><p>The index to get the child from</p></td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</tr>
</tbody>
</table>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>The child that was removed.</p>
</div>
</div>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dl class="details">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<a href="PIXI.DisplayObjectContainer.html#removeChildAt">PIXI.DisplayObjectContainer#removeChildAt</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li></dd>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Docs updates.
2014-09-09 14:36:56 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-226">line 226</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
id="removeChildren"><span class="type-signature"></span>removeChildren<span class="signature">(beginIndex, endIndex)</span><span class="type-signature"></span></h4>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<div class="description">
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<p>Removes all children from this container that are within the begin and end indexes.</p>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</div>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h5>Parameters:</h5>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<table class="params table table-striped">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<td class="name"><code>beginIndex</code></td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<td class="type">
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<span class="param-type">Number</span>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</td>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<td class="description last"><p>The beginning position. Default value is 0.</p></td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</tr>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<tr>
<td class="name"><code>endIndex</code></td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<td class="type">
<span class="param-type">Number</span>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
</td>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<td class="description last"><p>The ending position. Default value is size of the container.</p></td>
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObjectContainer.html#removeChildren">PIXI.DisplayObjectContainer#removeChildren</a>
</li></dd>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-244">line 244</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dl>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dd>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt>
<h4 class="name "
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
id="removeStageReference"><span class="type-signature"></span>removeStageReference<span class="signature">()</span><span class="type-signature"></span></h4>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
<dd>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<p>Removes the current stage reference from the container and all of its children.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dl class="details">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObjectContainer.html#removeStageReference">PIXI.DisplayObjectContainer#removeStageReference</a>
</li></dd>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
Phaser 2.4.8 release.
2016-05-19 11:36:51 +00:00
<a href="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-415">line 415</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
id="reset"><span class="type-signature"></span>reset<span class="signature">(x, y, <span class="optional">health</span>)</span><span class="type-signature"> &rarr; {<a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a>}</span></h4>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>Resets the Game Object.</p>
<p>This moves the Game Object to the given x/y world coordinates and sets <code>fresh</code>, <code>exists</code>,
<code>visible</code> and <code>renderable</code> to true.</p>
<p>If this Game Object has the LifeSpan component it will also set <code>alive</code> to true and <code>health</code> to the given value.</p>
<p>If this Game Object has a Physics Body it will reset the Body.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h5>Parameters:</h5>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<table class="params table table-striped">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<thead>
<tr>
<th>Name</th>
<th>Type</th>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<th>Argument</th>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<th>Default</th>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<td class="name"><code>x</code></td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<td class="type">
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<span class="param-type">number</span>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</td>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<td class="attributes">
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<td class="default">
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<td class="description last"><p>The x coordinate (in world space) to position the Game Object at.</p></td>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>The y coordinate (in world space) to position the Game Object at.</p></td>
</tr>
<tr>
<td class="name"><code>health</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<td class="default">
1
</td>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<td class="description last"><p>The health to give the Game Object if it has the Health component.</p></td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
2.2 doc files.
2014-11-15 20:01:46 +00:00
-
</div>
<div class="returns-desc param-desc">
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<p>This instance.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
</div>
<dl class="details">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Reset.html#reset">Phaser.Component.Reset#reset</a>
</li></dd>
<dt class="tag-source">Source -
<a href="src_gameobjects_components_Reset.js.html">gameobjects/components/Reset.js</a>, <a href="src_gameobjects_components_Reset.js.html#sunlight-1-line-30">line 30</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="resetFrame"><span class="type-signature"></span>resetFrame<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Resets the texture frame dimensions that the Game Object uses for rendering.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.LoadTexture.html#resetFrame">Phaser.Component.LoadTexture#resetFrame</a>
</li></dd>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
Phaser 2.4.7 Final.
2016-04-22 14:15:28 +00:00
<a href="src_gameobjects_components_LoadTexture.js.html">gameobjects/components/LoadTexture.js</a>, <a href="src_gameobjects_components_LoadTexture.js.html#sunlight-1-line-232">line 232</a>
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="resizeFrame"><span class="type-signature"></span>resizeFrame<span class="signature">(parent, width, height)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Resizes the Frame dimensions that the Game Object uses for rendering.</p>
<p>You shouldn't normally need to ever call this, but in the case of special texture types such as Video or BitmapData
it can be useful to adjust the dimensions directly in this way.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>parent</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>The parent texture object that caused the resize, i.e. a Phaser.Video object.</p></td>
</tr>
<tr>
<td class="name"><code>width</code></td>
<td class="type">
<span class="param-type">integer</span>
</td>
<td class="description last"><p>The new width of the texture.</p></td>
</tr>
<tr>
<td class="name"><code>height</code></td>
<td class="type">
<span class="param-type">integer</span>
</td>
<td class="description last"><p>The new height of the texture.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.LoadTexture.html#resizeFrame">Phaser.Component.LoadTexture#resizeFrame</a>
</li></dd>
<dt class="tag-source">Source -
Phaser 2.4.7 Final.
2016-04-22 14:15:28 +00:00
<a href="src_gameobjects_components_LoadTexture.js.html">gameobjects/components/LoadTexture.js</a>, <a href="src_gameobjects_components_LoadTexture.js.html#sunlight-1-line-220">line 220</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
</dl>
</dd>
<dt>
<h4 class="name "
id="revive"><span class="type-signature"></span>revive<span class="signature">(<span class="optional">health</span>)</span><span class="type-signature"> &rarr; {<a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Brings a 'dead' Game Object back to life, optionally resetting its health value in the process.</p>
<p>A resurrected Game Object has its <code>alive</code>, <code>exists</code> and <code>visible</code> properties all set to true.</p>
<p>It will dispatch the <code>onRevived</code> event. Listen to <code>events.onRevived</code> for the signal.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>health</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
New docs.
2016-02-08 17:01:36 +00:00
100
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
</td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<td class="description last"><p>The health to give the Game Object. Only set if the GameObject has the Health component.</p></td>
</tr>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<h5>Returns:</h5>
<div class="returns">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<div class="returns-type">
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
-
</div>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<div class="returns-desc param-desc">
<p>This instance.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
</div>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<dl class="details">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.LifeSpan.html#revive">Phaser.Component.LifeSpan#revive</a>
</li></dd>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<dt class="tag-source">Source -
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="src_gameobjects_components_LifeSpan.js.html">gameobjects/components/LifeSpan.js</a>, <a href="src_gameobjects_components_LifeSpan.js.html#sunlight-1-line-78">line 78</a>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
</dt>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
</dl>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
</dd>
<dt>
<h4 class="name "
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
id="sendToBack"><span class="type-signature"></span>sendToBack<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a>}</span></h4>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>Sends this Game Object to the bottom of its parents display list.
Visually this means it will render below all other children in the same Group.</p>
<p>If this Game Object hasn't been added to a custom Group then this method will send it to the bottom of the Game World,
because the World is the root Group from which all Game Objects descend.</p>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
</div>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
2.2 doc files.
2014-11-15 20:01:46 +00:00
-
</div>
<div class="returns-desc param-desc">
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<p>This instance.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.BringToTop.html#sendToBack">Phaser.Component.BringToTop#sendToBack</a>
</li></dd>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="src_gameobjects_components_BringToTop.js.html">gameobjects/components/BringToTop.js</a>, <a href="src_gameobjects_components_BringToTop.js.html#sunlight-1-line-45">line 45</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
id="setChildIndex"><span class="type-signature"></span>setChildIndex<span class="signature">(child, index)</span><span class="type-signature"></span></h4>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Docs updates.
2014-09-09 14:36:56 +00:00
<div class="description">
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<p>Changes the position of an existing child in the display object container</p>
Docs updates.
2014-09-09 14:36:56 +00:00
</div>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h5>Parameters:</h5>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<table class="params table table-striped">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<td class="name"><code>child</code></td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<td class="type">
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</td>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<td class="description last"><p>The child DisplayObject instance for which you want to change the index number</p></td>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</tr>
<tr>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<td class="name"><code>index</code></td>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<td class="type">
<span class="param-type">Number</span>
</td>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<td class="description last"><p>The resulting index number for the child display object</p></td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dl class="details">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<a href="PIXI.DisplayObjectContainer.html#setChildIndex">PIXI.DisplayObjectContainer#setChildIndex</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li></dd>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-176">line 176</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
id="setFrame"><span class="type-signature"></span>setFrame<span class="signature">(frame)</span><span class="type-signature"></span></h4>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>Sets the texture frame the Game Object uses for rendering.</p>
<p>This is primarily an internal method used by <code>loadTexture</code>, but is exposed for the use of plugins and custom classes.</p>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</div>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>frame</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Frame.html">Phaser.Frame</a></span>
</td>
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<td class="description last"><p>The Frame to be used by the texture.</p></td>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
</tr>
</tbody>
</table>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dl class="details">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.LoadTexture.html#setFrame">Phaser.Component.LoadTexture#setFrame</a>
</li></dd>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
Phaser 2.4.7 Final.
2016-04-22 14:15:28 +00:00
<a href="src_gameobjects_components_LoadTexture.js.html">gameobjects/components/LoadTexture.js</a>, <a href="src_gameobjects_components_LoadTexture.js.html#sunlight-1-line-155">line 155</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
id="setStageReference"><span class="type-signature"></span>setStageReference<span class="signature">(stage)</span><span class="type-signature"></span></h4>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<div class="description">
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<p>Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.</p>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<td class="name"><code>stage</code></td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<td class="type">
2.4.4 Release.
2015-10-15 11:06:38 +00:00
<span class="param-type">Stage</span>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</td>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<td class="description last"><p>the stage that the container will have as its current stage reference</p></td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</tr>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</tbody>
</table>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<a href="PIXI.DisplayObjectContainer.html#setStageReference">PIXI.DisplayObjectContainer#setStageReference</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li></dd>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
Phaser 2.4.8 release.
2016-05-19 11:36:51 +00:00
<a href="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-399">line 399</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
New docs.
2015-08-24 14:43:45 +00:00
id="setTexture"><span class="type-signature"></span>setTexture<span class="signature">(texture, <span class="optional">destroy</span>)</span><span class="type-signature"></span></h4>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<div class="description">
New docs.
2015-08-24 14:43:45 +00:00
<p>Sets the texture of the sprite. Be warned that this doesn't remove or destroy the previous
texture this Sprite was using.</p>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</div>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h5>Parameters:</h5>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<th>Type</th>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New docs.
2015-08-24 14:43:45 +00:00
<th>Argument</th>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
New docs.
2015-08-24 14:43:45 +00:00
<th>Default</th>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<th class="last">Description</th>
</tr>
</thead>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<tbody>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<tr>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<td class="name"><code>texture</code></td>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<td class="type">
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<span class="param-type"><a href="PIXI.Texture.html">PIXI.Texture</a></span>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</td>
New docs.
2015-08-24 14:43:45 +00:00
<td class="attributes">
2.2 doc files.
2014-11-15 20:01:46 +00:00
New docs.
2015-08-24 14:43:45 +00:00
</td>
<td class="default">
</td>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<td class="description last"><p>The PIXI texture that is displayed by the sprite</p></td>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</tr>
New docs.
2015-08-24 14:43:45 +00:00
<tr>
<td class="name"><code>destroy</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>Call Texture.destroy on the current texture before replacing it with the new one?</p></td>
</tr>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</tbody>
</table>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<a href="PIXI.Sprite.html#setTexture">PIXI.Sprite#setTexture</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li></dd>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
New docs.
2015-08-24 14:43:45 +00:00
<a href="src_pixi_display_Sprite.js.html">pixi/display/Sprite.js</a>, <a href="src_pixi_display_Sprite.js.html#sunlight-1-line-158">line 158</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
id="swapChildren"><span class="type-signature"></span>swapChildren<span class="signature">(child, child2)</span><span class="type-signature"></span></h4>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<div class="description">
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<p>Swaps the position of 2 Display Objects within this container.</p>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<td class="name"><code>child</code></td>
<td class="type">
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
</td>
<td class="description last"><p>-</p></td>
</tr>
<tr>
<td class="name"><code>child2</code></td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<td class="type">
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</td>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<td class="description last"><p>-</p></td>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<a href="PIXI.DisplayObjectContainer.html#swapChildren">PIXI.DisplayObjectContainer#swapChildren</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li></dd>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
Phaser 2.4 release.
2015-07-22 14:31:30 +00:00
<a href="src_pixi_display_DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="src_pixi_display_DisplayObjectContainer.js.html#sunlight-1-line-134">line 134</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
Docs updates.
2014-09-09 14:36:56 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
id="toGlobal"><span class="type-signature"></span>toGlobal<span class="signature">(position)</span><span class="type-signature"> &rarr; {Point}</span></h4>
Docs updates.
2014-09-09 14:36:56 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Docs updates.
2014-09-09 14:36:56 +00:00
<div class="description">
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<p>Calculates the global position of the display object</p>
Docs updates.
2014-09-09 14:36:56 +00:00
</div>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h5>Parameters:</h5>
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<th>Type</th>
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<th class="last">Description</th>
</tr>
</thead>
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<tbody>
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<tr>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<td class="name"><code>position</code></td>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<td class="type">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<span class="param-type">Point</span>
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
</td>
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Docs updates.
2014-09-09 14:36:56 +00:00
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<td class="description last"><p>The world origin to calculate from</p></td>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</tr>
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
</tbody>
</table>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<span class="param-type">Point</span>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
-
</div>
<div class="returns-desc param-desc">
<p>A point object representing the position of this object</p>
</div>
</div>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<a href="PIXI.DisplayObject.html#toGlobal">PIXI.DisplayObject#toGlobal</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li></dd>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2.4.4 Release.
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-576">line 576</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
Docs updates.
2014-09-09 14:36:56 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
id="toLocal"><span class="type-signature"></span>toLocal<span class="signature">(position, <span class="optional">from</span>)</span><span class="type-signature"> &rarr; {Point}</span></h4>
Docs updates.
2014-09-09 14:36:56 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Docs updates.
2014-09-09 14:36:56 +00:00
<div class="description">
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<p>Calculates the local position of the display object relative to another point</p>
Docs updates.
2014-09-09 14:36:56 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<th>Argument</th>
Docs updates.
2014-09-09 14:36:56 +00:00
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<td class="name"><code>position</code></td>
<td class="type">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<span class="param-type">Point</span>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
</td>
<td class="attributes">
</td>
<td class="description last"><p>The world origin to calculate from</p></td>
</tr>
<tr>
<td class="name"><code>from</code></td>
Docs updates.
2014-09-09 14:36:56 +00:00
<td class="type">
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
Docs updates.
2014-09-09 14:36:56 +00:00
</td>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<td class="attributes">
&lt;optional><br>
</td>
Docs updates.
2014-09-09 14:36:56 +00:00
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<td class="description last"><p>The DisplayObject to calculate the global position from</p></td>
Docs updates.
2014-09-09 14:36:56 +00:00
</tr>
</tbody>
</table>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<span class="param-type">Point</span>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
-
</div>
<div class="returns-desc param-desc">
<p>A point object representing the position of this object</p>
</div>
</div>
Docs updates.
2014-09-09 14:36:56 +00:00
<dl class="details">
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
Phaser 2.2.0 Docs.
2014-12-03 10:39:11 +00:00
<a href="PIXI.DisplayObject.html#toLocal">PIXI.DisplayObject#toLocal</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</li></dd>
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2.4.4 Release.
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-590">line 590</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
Docs updates.
2014-09-09 14:36:56 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Docs updates.
2014-09-09 14:36:56 +00:00
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="update"><span class="type-signature"></span>update<span class="signature">()</span><span class="type-signature"></span></h4>
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>Override this method in your own custom objects to handle any update requirements.
It is called immediately after <code>preUpdate</code> and before <code>postUpdate</code>.
Remember if this Game Object has any children you should call update on those too.</p>
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
</div>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
<dl class="details">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Core.html#update">Phaser.Component.Core#update</a>
</li></dd>
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
Phaser 2.4.8 release.
2016-05-19 11:36:51 +00:00
<a href="src_gameobjects_components_Core.js.html">gameobjects/components/Core.js</a>, <a href="src_gameobjects_components_Core.js.html#sunlight-1-line-316">line 316</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
Docs updates.
2014-09-09 14:36:56 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dd>
<dt>
<h4 class="name "
id="updateCache"><span class="type-signature"></span>updateCache<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Generates and updates the cached sprite for this object.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#updateCache">PIXI.DisplayObject#updateCache</a>
</li></dd>
<dt class="tag-source">Source -
2.4.4 Release.
2015-10-15 11:06:38 +00:00
<a href="src_pixi_display_DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="src_pixi_display_DisplayObject.js.html#sunlight-1-line-566">line 566</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
</dl>
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
Docs updates.
2014-09-09 14:36:56 +00:00
</dd>
<dt>
2.2 doc files.
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="updateCrop"><span class="type-signature"></span>updateCrop<span class="signature">()</span><span class="type-signature"></span></h4>
Docs updates.
2014-09-09 14:36:56 +00:00
</dt>
<dd>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Docs updates.
2014-09-09 14:36:56 +00:00
<div class="description">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<p>If you have set a crop rectangle on this Game Object via <code>crop</code> and since modified the <code>cropRect</code> property,
or the rectangle it references, then you need to update the crop frame by calling this method.</p>
Docs updates.
2014-09-09 14:36:56 +00:00
</div>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Docs updates.
2014-09-09 14:36:56 +00:00
<dl class="details">
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="Phaser.Component.Crop.html#updateCrop">Phaser.Component.Crop#updateCrop</a>
</li></dd>
Docs updates.
2014-09-09 14:36:56 +00:00
2.2 doc files.
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
New jsdoc files generated.
2015-03-23 23:46:30 +00:00
<a href="src_gameobjects_components_Crop.js.html">gameobjects/components/Crop.js</a>, <a href="src_gameobjects_components_Crop.js.html#sunlight-1-line-86">line 86</a>
2.2 doc files.
2014-11-15 20:01:46 +00:00
</dt>
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
</dl>
2.2 doc files.
2014-11-15 20:01:46 +00:00
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</dd>
</dl>
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
Phaser 2.4.7 Final.
2016-04-22 14:15:28 +00:00
Phaser Copyright © 2012-2016 Photon Storm Ltd.
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</span>
<br />
<span class="jsdoc-message">
New docs.
2015-08-24 14:43:45 +00:00
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a>
Phaser 2.4.8 release.
2016-05-19 11:36:51 +00:00
on Thu May 19 2016 12:35:41 GMT+0100 (GMT Daylight Time) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</span>
</footer>
</div>
<div class="span3">
<div id="toc"></div>
</div>
<br clear="both">
</div>
</div>
<script src="scripts/sunlight.js"></script>
<script src="scripts/sunlight.javascript.js"></script>
<script src="scripts/sunlight-plugin.doclinks.js"></script>
<script src="scripts/sunlight-plugin.linenumbers.js"></script>
<script src="scripts/sunlight-plugin.menu.js"></script>
<script src="scripts/jquery.min.js"></script>
<script src="scripts/jquery.scrollTo.js"></script>
<script src="scripts/jquery.localScroll.js"></script>
<script src="scripts/bootstrap-dropdown.js"></script>
<script src="scripts/toc.js"></script>
<script> Sunlight.highlightAll({lineNumbers:true, showMenu: true, enableDoclinks :true}); </script>
<script>
$( function () {
$( "#toc" ).toc( {
re-generated documentation
2014-04-10 22:13:43 +00:00
anchorName : function(i, heading, prefix) {
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
return $(heading).attr("id") || ( prefix + i );
},
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
selectors : "h1,h2,h3,h4",
showAndHide : false,
scrollTo : 60
} );
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
} );
</script>
</body>
</html>
Reference in a new issue Copy permalink