phaser/docs/Phaser.Camera.html

5387 lines
91 KiB
HTML
Raw Normal View History

2013-10-02 00:16:40 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Phaser Class: Camera</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
2014-11-15 20:01:46 +00:00
<link type="text/css" rel="stylesheet" href="styles/default.css">
2013-10-02 00:16:40 +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>
2014-11-25 00:23:44 +00:00
2013-10-02 00:16:40 +00:00
<div class="container-fluid">
<div class="navbar navbar-fixed-top navbar-inverse">
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>
2013-10-02 00:16:40 +00:00
<div class="navbar-inner">
2014-11-25 00:23:44 +00:00
<a class="brand" href="index.html">Phaser API</a>
2013-10-02 00:16:40 +00:00
<ul class="nav">
2014-11-25 00:23:44 +00:00
2013-10-02 00:16:40 +00:00
<li class="dropdown">
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b
2013-10-02 00:16:40 +00:00
class="caret"></b></a>
<ul class="dropdown-menu ">
2014-04-10 22:13:43 +00:00
<li class="class-depth-0">
<a href="Phaser.html">Phaser</a>
2013-10-02 00:16:40 +00:00
</li>
2015-10-15 11:06:38 +00:00
<li class="class-depth-0">
<a href="Phaser.KeyCode.html">KeyCode</a>
</li>
2014-11-15 20:01:46 +00:00
<li class="class-depth-0">
<a href="PIXI.html">PIXI</a>
</li>
2013-10-02 00:16:40 +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 ">
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 00:16:40 +00:00
<a href="Phaser.Animation.html">Animation</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.AnimationManager.html">AnimationManager</a>
2013-10-02 00:16:40 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.AnimationParser.html">AnimationParser</a>
2013-10-02 00:16:40 +00:00
</li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1">
<a href="Phaser.ArraySet.html">ArraySet</a>
</li>
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
<a href="Phaser.ArrayUtils.html">ArrayUtils</a>
</li>
2014-10-09 15:12:53 +00:00
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.BitmapText.html">BitmapText</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Button.html">Button</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Cache.html">Cache</a>
2013-10-02 00:16:40 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Camera.html">Camera</a>
2013-10-02 00:16:40 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Canvas.html">Canvas</a>
2013-10-02 14:05:55 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Circle.html">Circle</a>
2013-10-02 00:16:40 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Color.html">Color</a>
2013-10-03 00:21:08 +00:00
</li>
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>
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>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Device.html">Device</a>
2013-10-02 11:11:22 +00:00
</li>
2015-07-22 14:31:30 +00:00
<li class="class-depth-1">
<a href="Phaser.DeviceButton.html">DeviceButton</a>
</li>
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
<a href="Phaser.DOM.html">DOM</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Easing.html">Easing</a>
</li>
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>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Ellipse.html">Ellipse</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Events.html">Events</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.Filter.html">Filter</a>
</li>
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>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Frame.html">Frame</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.FrameData.html">FrameData</a>
2013-10-03 00:21:08 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 00:16:40 +00:00
<a href="Phaser.Game.html">Game</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.GameObjectCreator.html">GameObjectCreator</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.GameObjectFactory.html">GameObjectFactory</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Gamepad.html">Gamepad</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Graphics.html">Graphics</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 00:16:40 +00:00
<a href="Phaser.Group.html">Group</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Image.html">Image</a>
</li>
2015-07-22 14:31:30 +00:00
<li class="class-depth-1">
<a href="Phaser.ImageCollection.html">ImageCollection</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 12:18:58 +00:00
<a href="Phaser.Input.html">Input</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.InputHandler.html">InputHandler</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.Key.html">Key</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.Keyboard.html">Keyboard</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.Line.html">Line</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 11:11:22 +00:00
<a href="Phaser.LinkedList.html">LinkedList</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.Loader.html">Loader</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.LoaderParser.html">LoaderParser</a>
2013-10-02 14:05:55 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.Math.html">Math</a>
</li>
2015-07-22 14:31:30 +00:00
<li class="class-depth-1">
<a href="Phaser.Matrix.html">Matrix</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.Mouse.html">Mouse</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.MSPointer.html">MSPointer</a>
2013-10-02 11:11:22 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 19:18:24 +00:00
<a href="Phaser.Net.html">Net</a>
</li>
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">
2013-10-02 19:18:24 +00:00
<a href="Phaser.Particles.html">Particles</a>
</li>
2014-10-09 15:12:53 +00:00
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
2013-10-02 19:18:24 +00:00
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Physics.html">Physics</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Physics.Arcade.html">Arcade</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Arcade.Body.html">Body</a>
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-3">
2015-08-24 14:43:45 +00:00
<a href="Phaser.Physics.Arcade.TilemapCollision.html">TilemapCollision</a>
2015-03-23 23:46:30 +00:00
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Physics.Ninja.html">Ninja</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.AABB.html">AABB</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Body.html">Body</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Circle.html">Circle</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Tile.html">Tile</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Physics.P2.html">P2</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Body.html">Body</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.BodyDebug.html">BodyDebug</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.DistanceConstraint.html">DistanceConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.FixtureList.html">FixtureList</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.GearConstraint.html">GearConstraint</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.InversePointProxy.html">InversePointProxy</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.LockConstraint.html">LockConstraint</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Material.html">Material</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.PointProxy.html">PointProxy</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.PrismaticConstraint.html">PrismaticConstraint</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.RevoluteConstraint.html">RevoluteConstraint</a>
</li>
2014-09-09 14:36:56 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.RotationalSpring.html">RotationalSpring</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Spring.html">Spring</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 11:11:22 +00:00
<a href="Phaser.Plugin.html">Plugin</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.PluginManager.html">PluginManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 11:11:22 +00:00
<a href="Phaser.Point.html">Point</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.Pointer.html">Pointer</a>
</li>
2015-10-15 11:06:38 +00:00
<li class="class-depth-1">
<a href="Phaser.PointerMode.html">PointerMode</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Polygon.html">Polygon</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.QuadTree.html">QuadTree</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.RandomDataGenerator.html">RandomDataGenerator</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 11:11:22 +00:00
<a href="Phaser.Rectangle.html">Rectangle</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.RenderTexture.html">RenderTexture</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.RequestAnimationFrame.html">RequestAnimationFrame</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.RetroFont.html">RetroFont</a>
</li>
2014-09-09 14:36:56 +00:00
<li class="class-depth-1">
<a href="Phaser.Rope.html">Rope</a>
</li>
2015-07-22 14:31:30 +00:00
<li class="class-depth-1">
<a href="Phaser.RoundedRectangle.html">RoundedRectangle</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.ScaleManager.html">ScaleManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 11:11:22 +00:00
<a href="Phaser.Signal.html">Signal</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SignalBinding.html">SignalBinding</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.SinglePad.html">SinglePad</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.Sound.html">Sound</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-03 00:21:08 +00:00
<a href="Phaser.SoundManager.html">SoundManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Sprite.html">Sprite</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.SpriteBatch.html">SpriteBatch</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 11:11:22 +00:00
<a href="Phaser.Stage.html">Stage</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 11:11:22 +00:00
<a href="Phaser.State.html">State</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 11:11:22 +00:00
<a href="Phaser.StateManager.html">StateManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.Text.html">Text</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.Tile.html">Tile</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.Tilemap.html">Tilemap</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.TilemapLayer.html">TilemapLayer</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.TilemapParser.html">TilemapParser</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.Tileset.html">Tileset</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-25 15:54:40 +00:00
<a href="Phaser.TileSprite.html">TileSprite</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Time.html">Time</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-11-28 15:57:09 +00:00
<a href="Phaser.Timer.html">Timer</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2014-02-05 06:29:17 +00:00
<a href="Phaser.TimerEvent.html">TimerEvent</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2013-10-02 14:05:55 +00:00
<a href="Phaser.Touch.html">Touch</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Tween.html">Tween</a>
</li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1">
<a href="Phaser.TweenData.html">TweenData</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.TweenManager.html">TweenManager</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Utils.html">Utils</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
<a href="Phaser.Utils.Debug.html">Debug</a>
</li>
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
2015-07-22 14:31:30 +00:00
<a href="Phaser.Video.html">Video</a>
2013-10-02 11:11:22 +00:00
</li>
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
2015-07-22 14:31:30 +00:00
<a href="Phaser.World.html">World</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-07-22 14:31:30 +00:00
<a href="PIXI.AbstractFilter.html">AbstractFilter</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-07-22 14:31:30 +00:00
<a href="PIXI.BaseTexture.html">BaseTexture</a>
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>
2015-08-24 14:43:45 +00:00
<li class="class-depth-1">
<a href="PIXI.CanvasPool.html">CanvasPool</a>
</li>
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>
2016-02-08 17:01:36 +00:00
<li class="class-depth-1">
<a href="PIXI.EarCut.html">EarCut</a>
</li>
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">
<a href="PIXI.PIXI.html">PIXI</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PixiFastShader.html">PixiFastShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PixiShader.html">PixiShader</a>
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.PolyK.html">PolyK</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.PrimitiveShader.html">PrimitiveShader</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.RenderTexture.html">RenderTexture</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.Rope.html">Rope</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.Sprite.html">Sprite</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.SpriteBatch.html">SpriteBatch</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.Strip.html">Strip</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.StripShader.html">StripShader</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.Texture.html">Texture</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.TilingSprite.html">TilingSprite</a>
2014-11-15 20:01:46 +00:00
</li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.WebGLBlendModeManager.html">WebGLBlendModeManager</a>
2014-11-25 00:23:44 +00:00
</li>
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.WebGLFastSpriteBatch.html">WebGLFastSpriteBatch</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.WebGLFilterManager.html">WebGLFilterManager</a>
2014-11-15 20:01:46 +00:00
</li>
<li class="class-depth-1">
2015-03-23 23:46:30 +00:00
<a href="PIXI.WebGLRenderer.html">WebGLRenderer</a>
2014-11-15 20:01:46 +00:00
</li>
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 ">
2016-06-03 17:48:34 +00:00
<li class="class-depth-0">
<a href="global.html#ANGLE_DOWN">ANGLE_DOWN</a>
</li>
<li class="class-depth-0">
<a href="global.html#ANGLE_LEFT">ANGLE_LEFT</a>
</li>
<li class="class-depth-0">
<a href="global.html#ANGLE_NORTH_EAST">ANGLE_NORTH_EAST</a>
</li>
<li class="class-depth-0">
<a href="global.html#ANGLE_NORTH_WEST">ANGLE_NORTH_WEST</a>
</li>
<li class="class-depth-0">
<a href="global.html#ANGLE_RIGHT">ANGLE_RIGHT</a>
</li>
<li class="class-depth-0">
<a href="global.html#ANGLE_SOUTH_EAST">ANGLE_SOUTH_EAST</a>
</li>
<li class="class-depth-0">
<a href="global.html#ANGLE_SOUTH_WEST">ANGLE_SOUTH_WEST</a>
</li>
<li class="class-depth-0">
<a href="global.html#ANGLE_UP">ANGLE_UP</a>
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
2015-07-22 14:31:30 +00:00
<a href="global.html#AUTO">AUTO</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
2015-07-22 14:31:30 +00:00
<a href="global.html#BITMAPDATA">BITMAPDATA</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
2015-07-22 14:31:30 +00:00
<a href="global.html#BITMAPTEXT">BITMAPTEXT</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
<a href="global.html#blendModes">blendModes</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
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>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
2015-07-22 14:31:30 +00:00
<a href="global.html#CREATURE">CREATURE</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
2015-07-22 14:31:30 +00:00
<a href="global.html#DOWN">DOWN</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
2015-07-22 14:31:30 +00:00
<a href="global.html#ELLIPSE">ELLIPSE</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
2015-07-22 14:31:30 +00:00
<a href="global.html#EMITTER">EMITTER</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
2015-07-22 14:31:30 +00:00
<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>
2016-06-03 17:48:34 +00:00
<li class="class-depth-0">
<a href="global.html#intersectsRectangle">intersectsRectangle</a>
</li>
2015-07-22 14:31:30 +00:00
<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>
2016-02-08 17:01:36 +00:00
<li class="class-depth-0">
<a href="global.html#PENDING_ATLAS">PENDING_ATLAS</a>
</li>
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>
</li>
<li class="class-depth-0">
<a href="global.html#POLYGON">POLYGON</a>
</li>
<li class="class-depth-0">
<a href="global.html#RECTANGLE">RECTANGLE</a>
</li>
<li class="class-depth-0">
<a href="global.html#RENDERTEXTURE">RENDERTEXTURE</a>
</li>
<li class="class-depth-0">
<a href="global.html#RETROFONT">RETROFONT</a>
</li>
<li class="class-depth-0">
<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>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
<a href="global.html#scaleModes">scaleModes</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
2015-07-22 14:31:30 +00:00
<a href="global.html#SPRITE">SPRITE</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
2015-07-22 14:31:30 +00:00
<a href="global.html#SPRITEBATCH">SPRITEBATCH</a>
2014-11-15 20:01:46 +00:00
</li>
2015-03-23 23:46:30 +00:00
<li class="class-depth-0">
2015-07-22 14:31:30 +00:00
<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>
</li>
<li class="class-depth-0">
<a href="global.html#VERSION">VERSION</a>
</li>
<li class="class-depth-0">
<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>
2014-11-15 20:01:46 +00:00
</li>
2013-10-02 00:16:40 +00:00
</ul>
</li>
2014-11-25 00:23:44 +00:00
2014-11-15 20:01:46 +00:00
<li class="dropdown">
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 ">
2014-12-03 10:39:11 +00:00
<li class="class-depth-1"><a href="Phaser.Game.html">Game</a></li>
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>
2015-07-22 14:31:30 +00:00
<li class="class-depth-1"><a href="Phaser.Cache.html">Cache</a></li>
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>
2015-01-06 06:57:25 +00:00
<li class="class-depth-1"><a href="Phaser.Input.html">Input Manager</a></li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="Phaser.ScaleManager.html">Scale Manager</a></li>
</ul>
</li>
2014-11-15 20:01:46 +00:00
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>
2014-11-15 20:01:46 +00:00
<ul class="dropdown-menu ">
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>
2015-07-22 14:31:30 +00:00
<li class="class-depth-1"><a href="Phaser.Video.html">Video</a></li>
2015-01-06 06:57:25 +00:00
<li class="class-depth-1"><a href="Phaser.Particles.Arcade.Emitter.html">Particle Emitter</a></li>
2014-12-03 10:39:11 +00:00
<li class="class-depth-1"><a href="Phaser.Particle.html">Particle</a></li>
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>
2014-11-15 20:01:46 +00:00
2014-11-25 00:23:44 +00:00
<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>
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>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="Phaser.Polygon.html">Polygon</a></li>
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>
2014-11-15 20:01:46 +00:00
</ul>
</li>
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>
</ul>
</li>
<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>
2015-07-22 14:31:30 +00:00
<li class="class-depth-1"><a href="Phaser.DeviceButton.html">Device Button</a></li>
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 ">
2015-03-26 02:55:18 +00:00
<li class="class-depth-1"><a href="http://phaser.io">Phaser Web Site</a></li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="https://github.com/photonstorm/phaser">Phaser Github</a></li>
2015-03-26 02:55:18 +00:00
<li class="class-depth-1"><a href="http://phaser.io/examples">Phaser Examples</a></li>
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>
2015-07-22 14:31:30 +00:00
<li class="class-depth-1"><a href="http://phaser.io/learn">Tutorials</a></li>
2016-05-19 11:36:51 +00:00
<li class="class-depth-1"><a href="http://phaser.io/community/newsletter">Newsletter</a></li>
2015-03-26 02:55:18 +00:00
<li class="class-depth-1"><a href="http://phaser.io/community/twitter">Twitter</a></li>
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>
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>
2014-11-25 00:23:44 +00:00
</ul>
</li>
2014-11-15 20:01:46 +00:00
</ul>
</div>
</div>
<div class="row-fluid">
2013-10-02 00:16:40 +00:00
<div class="span8">
<div id="main">
2014-11-25 00:23:44 +00:00
<!--<h1 class="page-title">Class: Camera</h1>-->
2013-10-02 00:16:40 +00:00
<section>
<header>
<h2>
<span class="ancestors"><a href="Phaser.html">Phaser</a>.</span>
2013-10-02 00:16:40 +00:00
Camera
</h2>
</header>
<article>
<div class="container-overview">
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="Camera"><span class="type-signature"></span>new Camera<span class="signature">(game, id, x, y, width, height)</span><span class="type-signature"></span></h4>
2013-10-02 00:16:40 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
<div class="description">
<p>A Camera is your view into the game world. It has a position and size and renders only those objects within its field of view.
The game automatically creates a single Stage sized camera on boot. Move the camera around the world with Phaser.Camera.x/y</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>game</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Game.html">Phaser.Game</a></span>
</td>
<td class="description last"><p>Game reference to the currently running game.</p></td>
</tr>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>Not being used at the moment, will be when Phaser supports multiple camera</p></td>
</tr>
<tr>
<td class="name"><code>x</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>Position of the camera on the X axis</p></td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>Position of the camera on the Y axis</p></td>
</tr>
<tr>
<td class="name"><code>width</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The width of the view rectangle</p></td>
</tr>
<tr>
<td class="name"><code>height</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The height of the view rectangle</p></td>
</tr>
</tbody>
</table>
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2015-03-23 23:46:30 +00:00
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-20">line 20</a>
2014-11-15 20:01:46 +00:00
</dt>
2013-10-02 00:16:40 +00:00
</dl>
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
</dd>
</div>
<h3 class="subsection-title">Members</h3>
<dl>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2016-04-22 14:15:28 +00:00
id=".ENABLE_FX"><span class="type-signature">&lt;static, constant> </span>ENABLE_FX<span class="type-signature"> :boolean</span></h4>
2013-10-02 00:16:40 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-231">line 231</a>
2014-11-15 20:01:46 +00:00
</dt>
2013-10-02 00:16:40 +00:00
</dl>
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2016-04-22 14:15:28 +00:00
id=".FOLLOW_LOCKON"><span class="type-signature">&lt;static, constant> </span>FOLLOW_LOCKON<span class="type-signature"> :number</span></h4>
2013-10-02 00:16:40 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-189">line 189</a>
2014-11-15 20:01:46 +00:00
</dt>
2013-10-02 00:16:40 +00:00
</dl>
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2016-04-22 14:15:28 +00:00
id=".FOLLOW_PLATFORMER"><span class="type-signature">&lt;static, constant> </span>FOLLOW_PLATFORMER<span class="type-signature"> :number</span></h4>
2013-10-02 00:16:40 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-195">line 195</a>
2014-11-15 20:01:46 +00:00
</dt>
2013-10-02 00:16:40 +00:00
</dl>
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2016-04-22 14:15:28 +00:00
id=".FOLLOW_TOPDOWN"><span class="type-signature">&lt;static, constant> </span>FOLLOW_TOPDOWN<span class="type-signature"> :number</span></h4>
2013-10-02 00:16:40 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-201">line 201</a>
2014-11-15 20:01:46 +00:00
</dt>
2014-10-09 15:12:53 +00:00
</dl>
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2016-04-22 14:15:28 +00:00
id=".FOLLOW_TOPDOWN_TIGHT"><span class="type-signature">&lt;static, constant> </span>FOLLOW_TOPDOWN_TIGHT<span class="type-signature"> :number</span></h4>
2014-10-09 15:12:53 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
2014-10-09 15:12:53 +00:00
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-10-09 15:12:53 +00:00
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-207">line 207</a>
2014-11-15 20:01:46 +00:00
</dt>
2013-10-02 00:16:40 +00:00
</dl>
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2016-04-22 14:15:28 +00:00
id=".SHAKE_BOTH"><span class="type-signature">&lt;static, constant> </span>SHAKE_BOTH<span class="type-signature"> :number</span></h4>
2013-10-02 00:16:40 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-213">line 213</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2016-04-22 14:15:28 +00:00
id=".SHAKE_HORIZONTAL"><span class="type-signature">&lt;static, constant> </span>SHAKE_HORIZONTAL<span class="type-signature"> :number</span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-219">line 219</a>
2014-11-15 20:01:46 +00:00
</dt>
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
</dl>
2014-11-15 20:01:46 +00:00
</dd>
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
<dt>
<h4 class="name "
2016-04-22 14:15:28 +00:00
id=".SHAKE_VERTICAL"><span class="type-signature">&lt;static, constant> </span>SHAKE_VERTICAL<span class="type-signature"> :number</span></h4>
2014-11-15 20:01:46 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-225">line 225</a>
2014-11-15 20:01:46 +00:00
</dt>
2013-10-02 00:16:40 +00:00
</dl>
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2016-04-22 14:15:28 +00:00
id="atLimit"><span class="type-signature"></span>atLimit<span class="type-signature"> :boolean</span></h4>
2013-10-02 00:16:40 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
2016-04-22 14:15:28 +00:00
<p>Whether this camera is flush with the World Bounds or not.</p>
2014-11-15 20:01:46 +00:00
</div>
2013-10-02 00:16:40 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-76">line 76</a>
2014-11-15 20:01:46 +00:00
</dt>
2013-10-02 00:16:40 +00:00
2014-02-05 06:29:17 +00:00
</dl>
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2016-04-22 14:15:28 +00:00
id="bounds"><span class="type-signature"></span>bounds<span class="type-signature"> :<a href="Phaser.Rectangle.html">Phaser.Rectangle</a></span></h4>
2014-02-05 06:29:17 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
2016-04-22 14:15:28 +00:00
<p>The Camera is bound to this Rectangle and cannot move outside of it. By default it is enabled and set to the size of the World.
The Rectangle can be located anywhere in the world and updated as often as you like. If you don't wish the Camera to be bound
at all then set this to null. The values can be anything and are in World coordinates, with 0,0 being the top-left of the world. The Rectangle in which the Camera is bounded. Set to null to allow for movement anywhere.</p>
2014-11-15 20:01:46 +00:00
</div>
2013-10-02 00:16:40 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-54">line 54</a>
2014-11-15 20:01:46 +00:00
</dt>
2013-10-02 00:16:40 +00:00
</dl>
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2016-04-22 14:15:28 +00:00
id="deadzone"><span class="type-signature"></span>deadzone<span class="type-signature"> :<a href="Phaser.Rectangle.html">Phaser.Rectangle</a></span></h4>
2013-10-02 00:16:40 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
<div class="description">
2016-04-22 14:15:28 +00:00
<p>Moving inside this Rectangle will not cause the camera to move.</p>
2013-10-02 00:16:40 +00:00
</div>
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-59">line 59</a>
2014-11-15 20:01:46 +00:00
</dt>
2013-10-02 00:16:40 +00:00
</dl>
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2016-04-22 14:15:28 +00:00
id="displayObject"><span class="type-signature"></span>displayObject<span class="type-signature"> :<a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span></h4>
2013-10-02 00:16:40 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
<div class="description">
2016-04-22 14:15:28 +00:00
<p>The display object to which all game objects are added. Set by World.boot.</p>
2014-11-15 20:01:46 +00:00
</div>
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
<dl class="details">
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-87">line 87</a>
2014-11-15 20:01:46 +00:00
</dt>
2013-10-02 00:16:40 +00:00
</dl>
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2016-04-22 14:15:28 +00:00
id="fx"><span class="type-signature">&lt;internal> </span>fx<span class="type-signature"> :<a href="Phaser.Graphics.html">Phaser.Graphics</a></span></h4>
2013-10-02 00:16:40 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
<div class="description">
2016-04-22 14:15:28 +00:00
<p>The Graphics object used to handle camera fx such as fade and flash.</p>
2013-10-02 00:16:40 +00:00
</div>
<dl class="details">
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2016-04-22 14:15:28 +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>
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2016-04-22 14:15:28 +00:00
2014-11-25 00:23:44 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-135">line 135</a>
2014-11-15 20:01:46 +00:00
</dt>
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
</dl>
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
</dd>
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
<dt>
<h4 class="name "
2016-04-22 14:15:28 +00:00
id="game"><span class="type-signature"></span>game<span class="type-signature"> :<a href="Phaser.Game.html">Phaser.Game</a></span></h4>
2014-11-15 20:01:46 +00:00
</dt>
<dd>
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
<div class="description">
2016-04-22 14:15:28 +00:00
<p>A reference to the currently running Game.</p>
2014-11-15 20:01:46 +00:00
</div>
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
<dl class="details">
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-25">line 25</a>
2014-11-15 20:01:46 +00:00
</dt>
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
</dl>
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
</dd>
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
<dt>
<h4 class="name "
2016-04-22 14:15:28 +00:00
id="height"><span class="type-signature"></span>height<span class="type-signature"> :number</span></h4>
2014-11-15 20:01:46 +00:00
</dt>
<dd>
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
<div class="description">
2016-04-22 14:15:28 +00:00
<p>The Cameras height. By default this is the same as the Game size and should not be adjusted for now. Gets or sets the cameras height.</p>
2014-11-15 20:01:46 +00:00
</div>
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
<dl class="details">
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-06-03 17:48:34 +00:00
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-898">line 898</a>
2014-11-15 20:01:46 +00:00
</dt>
2013-10-02 00:16:40 +00:00
</dl>
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2016-04-22 14:15:28 +00:00
id="id"><span class="type-signature"></span>id<span class="type-signature"> :number</span></h4>
2013-10-02 00:16:40 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
<div class="description">
2016-04-22 14:15:28 +00:00
<p>Reserved for future multiple camera set-ups.</p>
2013-10-02 00:16:40 +00:00
</div>
<dl class="details">
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-36">line 36</a>
2014-11-15 20:01:46 +00:00
</dt>
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
</dl>
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
</dd>
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
<dt>
<h4 class="name "
2016-04-22 14:15:28 +00:00
id="lerp"><span class="type-signature"></span>lerp<span class="type-signature"> :<a href="Phaser.Point.html">Phaser.Point</a></span></h4>
2014-11-15 20:01:46 +00:00
</dt>
<dd>
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
<div class="description">
2016-04-22 14:15:28 +00:00
<p>The linear interpolation value to use when following a target.
The default values of 1 means the camera will instantly snap to the target coordinates.
A lower value, such as 0.1 means the camera will more slowly track the target, giving
a smooth transition. You can set the horizontal and vertical values independently, and also
adjust this value in real-time during your game.</p>
2014-11-15 20:01:46 +00:00
</div>
<dl class="details">
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-109">line 109</a>
2014-11-15 20:01:46 +00:00
</dt>
2013-10-02 00:16:40 +00:00
</dl>
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2016-04-22 14:15:28 +00:00
id="onFadeComplete"><span class="type-signature"></span>onFadeComplete<span class="type-signature"> :<a href="Phaser.Signal.html">Phaser.Signal</a></span></h4>
2013-10-02 00:16:40 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
2016-04-22 14:15:28 +00:00
<p>This signal is dispatched when the camera fade effect completes.
When the fade effect completes you will be left with the screen black (or whatever
color you faded to). In order to reset this call <code>Camera.resetFX</code>. This is called
automatically when you change State.</p>
2014-11-15 20:01:46 +00:00
</div>
2013-10-02 00:16:40 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-128">line 128</a>
2014-11-15 20:01:46 +00:00
</dt>
2013-10-02 00:16:40 +00:00
</dl>
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2016-04-22 14:15:28 +00:00
id="onFlashComplete"><span class="type-signature"></span>onFlashComplete<span class="type-signature"> :<a href="Phaser.Signal.html">Phaser.Signal</a></span></h4>
2013-10-02 00:16:40 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
<div class="description">
2016-04-22 14:15:28 +00:00
<p>This signal is dispatched when the camera flash effect completes.</p>
2013-10-02 00:16:40 +00:00
</div>
<dl class="details">
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-119">line 119</a>
2014-11-15 20:01:46 +00:00
</dt>
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
</dl>
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
</dd>
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
<dt>
<h4 class="name "
2016-04-22 14:15:28 +00:00
id="onShakeComplete"><span class="type-signature"></span>onShakeComplete<span class="type-signature"> :<a href="Phaser.Signal.html">Phaser.Signal</a></span></h4>
2014-11-15 20:01:46 +00:00
</dt>
<dd>
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
<div class="description">
2016-04-22 14:15:28 +00:00
<p>This signal is dispatched when the camera shake effect completes.</p>
2014-11-15 20:01:46 +00:00
</div>
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
<dl class="details">
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-114">line 114</a>
2014-11-15 20:01:46 +00:00
</dt>
2013-10-02 00:16:40 +00:00
</dl>
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2016-04-22 14:15:28 +00:00
id="position"><span class="type-signature"></span>position<span class="type-signature"> :<a href="Phaser.Point.html">Phaser.Point</a></span></h4>
2013-10-02 00:16:40 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
<div class="description">
2016-04-22 14:15:28 +00:00
<p>The Cameras position. This value is automatically clamped if it falls outside of the World bounds. Gets or sets the cameras xy position using Phaser.Point object.</p>
2013-10-02 00:16:40 +00:00
</div>
<dl class="details">
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-06-03 17:48:34 +00:00
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-849">line 849</a>
2014-11-15 20:01:46 +00:00
</dt>
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
</dl>
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
</dd>
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
<dt>
<h4 class="name "
2016-04-22 14:15:28 +00:00
id="roundPx"><span class="type-signature"></span>roundPx<span class="type-signature"> :boolean</span></h4>
2014-11-15 20:01:46 +00:00
</dt>
<dd>
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
<div class="description">
2016-04-22 14:15:28 +00:00
<p>If a Camera has roundPx set to <code>true</code> it will call <code>view.floor</code> as part of its update loop, keeping its boundary to integer values. Set this to <code>false</code> to disable this from happening.</p>
2014-11-15 20:01:46 +00:00
</div>
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
<dl class="details">
2013-10-02 00:16:40 +00:00
2016-04-22 14:15:28 +00:00
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>true</li></ul></dd>
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-71">line 71</a>
2014-11-15 20:01:46 +00:00
</dt>
2013-10-02 00:16:40 +00:00
</dl>
</dd>
2016-04-22 14:15:28 +00:00
2013-10-02 00:16:40 +00:00
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2016-04-22 14:15:28 +00:00
id="scale"><span class="type-signature"></span>scale<span class="type-signature"> :<a href="Phaser.Point.html">Phaser.Point</a></span></h4>
2013-10-02 00:16:40 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
<div class="description">
2016-04-22 14:15:28 +00:00
<p>The scale of the display object to which all game objects are added. Set by World.boot.</p>
2013-10-02 00:16:40 +00:00
</div>
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-92">line 92</a>
2014-11-15 20:01:46 +00:00
</dt>
2016-05-19 11:36:51 +00:00
</dl>
</dd>
<dt>
<h4 class="name "
id="shakeIntensity"><span class="type-signature"></span>shakeIntensity<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The Cameras shake intensity. Gets or sets the cameras shake intensity.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
2016-06-03 17:48:34 +00:00
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-920">line 920</a>
2016-05-19 11:36:51 +00:00
</dt>
</dl>
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2016-04-22 14:15:28 +00:00
id="target"><span class="type-signature"></span>target<span class="type-signature"> :<a href="Phaser.Sprite.html">Phaser.Sprite</a></span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
2016-04-22 14:15:28 +00:00
<p>If the camera is tracking a Sprite, this is a reference to it, otherwise null.</p>
</div>
2016-04-22 14:15:28 +00:00
2016-04-22 14:15:28 +00:00
<dl class="details">
2016-04-22 14:15:28 +00:00
2016-04-22 14:15:28 +00:00
2016-04-22 14:15:28 +00:00
2016-04-22 14:15:28 +00:00
2016-04-22 14:15:28 +00:00
2016-04-22 14:15:28 +00:00
2016-04-22 14:15:28 +00:00
2016-04-22 14:15:28 +00:00
2016-04-22 14:15:28 +00:00
<dt class="tag-source">Source -
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-82">line 82</a>
</dt>
2016-04-22 14:15:28 +00:00
2016-04-22 14:15:28 +00:00
2016-04-22 14:15:28 +00:00
</dl>
2016-04-22 14:15:28 +00:00
</dd>
2016-04-22 14:15:28 +00:00
<dt>
<h4 class="name "
id="totalInView"><span class="type-signature">&lt;readonly> </span>totalInView<span class="type-signature"> :number</span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
2016-04-22 14:15:28 +00:00
<div class="description">
<p>The total number of Sprites with <code>autoCull</code> set to <code>true</code> that are visible by this Camera.</p>
</div>
2016-04-22 14:15:28 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-98">line 98</a>
2014-11-15 20:01:46 +00:00
</dt>
2013-10-02 00:16:40 +00:00
</dl>
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2016-04-22 14:15:28 +00:00
id="view"><span class="type-signature"></span>view<span class="type-signature"> :<a href="Phaser.Rectangle.html">Phaser.Rectangle</a></span></h4>
2013-10-02 00:16:40 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
<div class="description">
2016-04-22 14:15:28 +00:00
<p>Camera view.
The view into the world we wish to render (by default the game dimensions).
The x/y values are in world coordinates, not screen coordinates, the width/height is how many pixels to render.
Sprites outside of this view are not rendered if Sprite.autoCull is set to <code>true</code>. Otherwise they are always rendered.</p>
2013-10-02 00:16:40 +00:00
</div>
2016-04-22 14:15:28 +00:00
2013-10-02 00:16:40 +00:00
2016-04-22 14:15:28 +00:00
<dl class="details">
2013-10-02 00:16:40 +00:00
2016-04-22 14:15:28 +00:00
2013-10-02 00:16:40 +00:00
2016-04-22 14:15:28 +00:00
2013-10-02 00:16:40 +00:00
2016-04-22 14:15:28 +00:00
2013-10-02 00:16:40 +00:00
2016-04-22 14:15:28 +00:00
2013-10-02 00:16:40 +00:00
2016-04-22 14:15:28 +00:00
2013-10-02 00:16:40 +00:00
2016-04-22 14:15:28 +00:00
2013-10-02 00:16:40 +00:00
2016-04-22 14:15:28 +00:00
2013-10-02 00:16:40 +00:00
2016-04-22 14:15:28 +00:00
<dt class="tag-source">Source -
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-45">line 45</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="visible"><span class="type-signature"></span>visible<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>Whether this camera is visible or not.</p>
</div>
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>true</li></ul></dd>
<dt class="tag-source">Source -
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-65">line 65</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="width"><span class="type-signature"></span>width<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The Cameras width. By default this is the same as the Game size and should not be adjusted for now. Gets or sets the cameras width.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
2016-06-03 17:48:34 +00:00
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-877">line 877</a>
2016-04-22 14:15:28 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="world"><span class="type-signature"></span>world<span class="type-signature"> :<a href="Phaser.World.html">Phaser.World</a></span></h4>
</dt>
<dd>
<div class="description">
<p>A reference to the game world.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-30">line 30</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="x"><span class="type-signature"></span>x<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The Cameras x coordinate. This value is automatically clamped if it falls outside of the World bounds. Gets or sets the cameras x position.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
2016-06-03 17:48:34 +00:00
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-799">line 799</a>
2016-04-22 14:15:28 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="y"><span class="type-signature"></span>y<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The Cameras y coordinate. This value is automatically clamped if it falls outside of the World bounds. Gets or sets the cameras y position.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
2016-06-03 17:48:34 +00:00
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-824">line 824</a>
2016-04-22 14:15:28 +00:00
</dt>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name "
id="checkBounds"><span class="type-signature">&lt;internal> </span>checkBounds<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Method called to ensure the camera doesn't venture outside of the game world.
Called automatically by Camera.update.</p>
</div>
<dl class="details">
<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>
<dt class="tag-source">Source -
2016-06-03 17:48:34 +00:00
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-657">line 657</a>
2016-04-22 14:15:28 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="fade"><span class="type-signature"></span>fade<span class="signature">(<span class="optional">color</span>, <span class="optional">duration</span>, <span class="optional">force</span>)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
2016-05-19 11:36:51 +00:00
<p>This creates a camera fade effect. It works by filling the game with the
2016-04-22 14:15:28 +00:00
color specified, over the duration given, ending with a solid fill.</p>
<p>You can use this for things such as transitioning to a new scene.</p>
<p>The game will be left 'filled' at the end of this effect, likely obscuring
everything. In order to reset it you can call <code>Camera.resetFX</code> and it will clear the
fade. Or you can call <code>Camera.flash</code> with the same color as the fade, and it will
reverse the process, bringing the game back into view again.</p>
<p>When the effect ends the signal Camera.onFadeComplete is dispatched.</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>color</code></td>
<td class="type">
<span class="param-type">numer</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0x000000
</td>
<td class="description last"><p>The color the game will fade to. I.e. 0x000000 for black, 0xff0000 for red, etc.</p></td>
</tr>
<tr>
<td class="name"><code>duration</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
500
</td>
<td class="description last"><p>The duration of the fade in milliseconds.</p></td>
</tr>
<tr>
<td class="name"><code>force</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>If a camera flash or fade effect is already running and force is true it will replace the previous effect, resetting the duration.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">boolean</span>
-
</div>
<div class="returns-desc param-desc">
<p>True if the effect was started, otherwise false.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-441">line 441</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="flash"><span class="type-signature"></span>flash<span class="signature">(<span class="optional">color</span>, <span class="optional">duration</span>, <span class="optional">force</span>)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>This creates a camera flash effect. It works by filling the game with the solid fill
color specified, and then fading it away to alpha 0 over the duration given.</p>
<p>You can use this for things such as hit feedback effects.</p>
<p>When the effect ends the signal Camera.onFlashComplete is dispatched.</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>color</code></td>
<td class="type">
<span class="param-type">numer</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0xffffff
</td>
<td class="description last"><p>The color of the flash effect. I.e. 0xffffff for white, 0xff0000 for red, etc.</p></td>
</tr>
<tr>
<td class="name"><code>duration</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
500
</td>
<td class="description last"><p>The duration of the flash effect in milliseconds.</p></td>
</tr>
<tr>
<td class="name"><code>force</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>If a camera flash or fade effect is already running and force is true it will replace the previous effect, resetting the duration.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">boolean</span>
-
</div>
<div class="returns-desc param-desc">
<p>True if the effect was started, otherwise false.</p>
</div>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-401">line 401</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="focusOn"><span class="type-signature"></span>focusOn<span class="signature">(displayObject)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Move the camera focus on a display object instantly.</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>displayObject</code></td>
<td class="type">
<span class="param-type">any</span>
</td>
<td class="description last"><p>The display object to focus the camera on. Must have visible x/y properties.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-335">line 335</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="focusOnXY"><span class="type-signature"></span>focusOnXY<span class="signature">(x, y)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Move the camera focus on a location instantly.</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>x</code></td>
2013-10-02 00:16:40 +00:00
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>X position.</p></td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>Y position.</p></td>
</tr>
</tbody>
</table>
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-346">line 346</a>
2014-11-15 20:01:46 +00:00
</dt>
2013-10-02 00:16:40 +00:00
</dl>
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2016-04-22 14:15:28 +00:00
id="follow"><span class="type-signature"></span>follow<span class="signature">(target, <span class="optional">style</span>, <span class="optional">lerpX</span>, <span class="optional">lerpY</span>)</span><span class="type-signature"></span></h4>
2013-10-02 00:16:40 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
<div class="description">
2015-03-23 23:46:30 +00:00
<p>Tell the camera which sprite to follow.</p>
2016-04-22 14:15:28 +00:00
<p>You can set the follow type and a linear interpolation value.
Use low lerp values (such as 0.1) to automatically smooth the camera motion.</p>
2015-03-23 23:46:30 +00:00
<p>If you find you're getting a slight &quot;jitter&quot; effect when following a Sprite it's probably to do with sub-pixel rendering of the Sprite position.
This can be disabled by setting <code>game.renderer.renderSession.roundPixels = true</code> to force full pixel rendering.</p>
2013-10-02 00:16:40 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
2016-04-22 14:15:28 +00:00
<th>Default</th>
2013-10-02 00:16:40 +00:00
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>target</code></td>
<td class="type">
2013-10-25 15:54:40 +00:00
<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.Text.html">Phaser.Text</a></span>
2013-10-02 00:16:40 +00:00
</td>
<td class="attributes">
</td>
2016-04-22 14:15:28 +00:00
<td class="default">
</td>
2013-10-02 00:16:40 +00:00
<td class="description last"><p>The object you want the camera to track. Set to null to not follow anything.</p></td>
</tr>
<tr>
<td class="name"><code>style</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
2016-04-22 14:15:28 +00:00
<td class="default">
</td>
2013-10-02 00:16:40 +00:00
<td class="description last"><p>Leverage one of the existing &quot;deadzone&quot; presets. If you use a custom deadzone, ignore this parameter and manually specify the deadzone after calling follow().</p></td>
</tr>
2016-04-22 14:15:28 +00:00
<tr>
<td class="name"><code>lerpX</code></td>
<td class="type">
<span class="param-type">float</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
1
</td>
<td class="description last"><p>A value between 0 and 1. This value specifies the amount of linear interpolation to use when horizontally tracking the target. The closer the value to 1, the faster the camera will track.</p></td>
</tr>
<tr>
<td class="name"><code>lerpY</code></td>
<td class="type">
<span class="param-type">float</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
1
</td>
<td class="description last"><p>A value between 0 and 1. This value specifies the amount of linear interpolation to use when vertically tracking the target. The closer the value to 1, the faster the camera will track.</p></td>
</tr>
2013-10-02 00:16:40 +00:00
</tbody>
</table>
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-269">line 269</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="preUpdate"><span class="type-signature"></span>preUpdate<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Camera preUpdate. Sets the total view counter to zero.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-258">line 258</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="reset"><span class="type-signature"></span>reset<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Resets the camera back to 0,0 and un-follows any object it may have been tracking.
Also immediately resets any camera effects that may have been running such as
shake, flash or fade.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
2016-06-03 17:48:34 +00:00
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-759">line 759</a>
2015-07-22 14:31:30 +00:00
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
2016-04-22 14:15:28 +00:00
id="resetFX"><span class="type-signature"></span>resetFX<span class="signature">()</span><span class="type-signature"></span></h4>
2015-07-22 14:31:30 +00:00
</dt>
<dd>
<div class="description">
2016-04-22 14:15:28 +00:00
<p>Resets any active FX, such as a fade or flash and immediately clears it.
Useful to calling after a fade in order to remove the fade from the Stage.</p>
2015-07-22 14:31:30 +00:00
</div>
<dl class="details">
<dt class="tag-source">Source -
2016-06-03 17:48:34 +00:00
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-779">line 779</a>
2014-11-15 20:01:46 +00:00
</dt>
2014-02-05 06:29:17 +00:00
</dl>
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2016-04-22 14:15:28 +00:00
id="setBoundsToWorld"><span class="type-signature"></span>setBoundsToWorld<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
2016-04-22 14:15:28 +00:00
<p>Update the Camera bounds to match the game world.</p>
</div>
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-06-03 17:48:34 +00:00
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-643">line 643</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2016-04-22 14:15:28 +00:00
id="setPosition"><span class="type-signature"></span>setPosition<span class="signature">(x, y)</span><span class="type-signature"></span></h4>
2014-02-05 06:29:17 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
<div class="description">
2016-04-22 14:15:28 +00:00
<p>A helper function to set both the X and Y properties of the camera at once
without having to use game.camera.x and game.camera.y.</p>
2014-02-05 06:29:17 +00:00
</div>
2016-04-22 14:15:28 +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>x</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>X position.</p></td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>Y position.</p></td>
</tr>
</tbody>
</table>
2014-11-15 20:01:46 +00:00
2014-02-05 06:29:17 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-06-03 17:48:34 +00:00
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-725">line 725</a>
2014-11-15 20:01:46 +00:00
</dt>
2013-10-02 00:16:40 +00:00
</dl>
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2016-04-22 14:15:28 +00:00
id="setSize"><span class="type-signature"></span>setSize<span class="signature">(width, height)</span><span class="type-signature"></span></h4>
2013-10-02 00:16:40 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
<div class="description">
2016-04-22 14:15:28 +00:00
<p>Sets the size of the view rectangle given the width and height in parameters.</p>
2013-10-02 00:16:40 +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>
2016-04-22 14:15:28 +00:00
<td class="name"><code>width</code></td>
2013-10-02 00:16:40 +00:00
<td class="type">
<span class="param-type">number</span>
</td>
2016-04-22 14:15:28 +00:00
<td class="description last"><p>The desired width.</p></td>
2013-10-02 00:16:40 +00:00
</tr>
<tr>
2016-04-22 14:15:28 +00:00
<td class="name"><code>height</code></td>
2013-10-02 00:16:40 +00:00
<td class="type">
<span class="param-type">number</span>
</td>
2016-04-22 14:15:28 +00:00
<td class="description last"><p>The desired height.</p></td>
2013-10-02 00:16:40 +00:00
</tr>
</tbody>
</table>
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-06-03 17:48:34 +00:00
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-745">line 745</a>
2014-11-15 20:01:46 +00:00
</dt>
2013-10-02 00:16:40 +00:00
</dl>
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2016-04-22 14:15:28 +00:00
id="shake"><span class="type-signature"></span>shake<span class="signature">(<span class="optional">intensity</span>, <span class="optional">duration</span>, <span class="optional">force</span>, <span class="optional">direction</span>, <span class="optional">shakeBounds</span>)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
2013-10-02 00:16:40 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
<div class="description">
2016-04-22 14:15:28 +00:00
<p>This creates a camera shake effect. It works by applying a random amount of additional
spacing on the x and y axis each frame. You can control the intensity and duration
of the effect, and if it should effect both axis or just one.</p>
<p>When the shake effect ends the signal Camera.onShakeComplete is dispatched.</p>
2013-10-02 00:16:40 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
2016-04-22 14:15:28 +00:00
<th>Argument</th>
2013-10-02 00:16:40 +00:00
2016-04-22 14:15:28 +00:00
<th>Default</th>
2013-10-02 00:16:40 +00:00
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
2016-04-22 14:15:28 +00:00
<td class="name"><code>intensity</code></td>
<td class="type">
<span class="param-type">float</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0.05
</td>
<td class="description last"><p>The intensity of the camera shake. Given as a percentage of the camera size representing the maximum distance that the camera can move while shaking.</p></td>
</tr>
<tr>
<td class="name"><code>duration</code></td>
2013-10-02 00:16:40 +00:00
<td class="type">
<span class="param-type">number</span>
</td>
2016-04-22 14:15:28 +00:00
<td class="attributes">
&lt;optional><br>
</td>
2013-10-02 00:16:40 +00:00
2016-04-22 14:15:28 +00:00
<td class="default">
500
</td>
2013-10-02 00:16:40 +00:00
2016-04-22 14:15:28 +00:00
<td class="description last"><p>The duration of the shake effect in milliseconds.</p></td>
2013-10-02 00:16:40 +00:00
</tr>
<tr>
2016-04-22 14:15:28 +00:00
<td class="name"><code>force</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 a camera shake effect is already running and force is true it will replace the previous effect, resetting the duration.</p></td>
</tr>
<tr>
<td class="name"><code>direction</code></td>
2013-10-02 00:16:40 +00:00
<td class="type">
<span class="param-type">number</span>
</td>
2016-04-22 14:15:28 +00:00
<td class="attributes">
&lt;optional><br>
</td>
2013-10-02 00:16:40 +00:00
2016-04-22 14:15:28 +00:00
<td class="default">
Phaser.Camera.SHAKE_BOTH
</td>
2013-10-02 00:16:40 +00:00
2016-04-22 14:15:28 +00:00
<td class="description last"><p>The directions in which the camera can shake. Either Phaser.Camera.SHAKE_BOTH, Phaser.Camera.SHAKE_HORIZONTAL or Phaser.Camera.SHAKE_VERTICAL.</p></td>
</tr>
<tr>
<td class="name"><code>shakeBounds</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>Is the effect allowed to shake the camera beyond its bounds (if set?).</p></td>
2013-10-02 00:16:40 +00:00
</tr>
</tbody>
</table>
2014-11-15 20:01:46 +00:00
2016-04-22 14:15:28 +00:00
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">boolean</span>
-
</div>
<div class="returns-desc param-desc">
<p>True if the shake effect was started, otherwise false.</p>
</div>
</div>
2013-10-02 00:16:40 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-358">line 358</a>
2014-11-15 20:01:46 +00:00
</dt>
2014-04-29 14:39:02 +00:00
</dl>
2014-11-15 20:01:46 +00:00
2014-04-29 14:39:02 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="unfollow"><span class="type-signature"></span>unfollow<span class="signature">()</span><span class="type-signature"></span></h4>
2014-04-29 14:39:02 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
2014-04-29 14:39:02 +00:00
<div class="description">
<p>Sets the Camera follow target to null, stopping it from following an object if it's doing so.</p>
</div>
2014-11-15 20:01:46 +00:00
2014-04-29 14:39:02 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-324">line 324</a>
2014-11-15 20:01:46 +00:00
</dt>
2013-10-02 00:16:40 +00:00
</dl>
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2016-04-22 14:15:28 +00:00
id="update"><span class="type-signature">&lt;internal> </span>update<span class="signature">()</span><span class="type-signature"></span></h4>
2013-10-02 00:16:40 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
<div class="description">
2016-04-22 14:15:28 +00:00
<p>The camera update loop. This is called automatically by the core game loop.</p>
2013-10-02 00:16:40 +00:00
</div>
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
<dl class="details">
2016-04-22 14:15:28 +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>
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2016-04-22 14:15:28 +00:00
<a href="src_core_Camera.js.html">core/Camera.js</a>, <a href="src_core_Camera.js.html#sunlight-1-line-486">line 486</a>
2014-11-15 20:01:46 +00:00
</dt>
2013-10-02 00:16:40 +00:00
</dl>
2014-11-15 20:01:46 +00:00
2013-10-02 00:16:40 +00:00
</dd>
</dl>
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
2016-04-22 14:15:28 +00:00
Phaser Copyright © 2012-2016 Photon Storm Ltd.
2013-10-02 00:16:40 +00:00
</span>
<br />
<span class="jsdoc-message">
2015-08-24 14:43:45 +00:00
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a>
2016-06-03 17:48:34 +00:00
on Fri Jun 03 2016 18:46:48 GMT+0100 (GMT Daylight Time) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
2013-10-02 00:16:40 +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( {
2014-04-10 22:13:43 +00:00
anchorName : function(i, heading, prefix) {
return $(heading).attr("id") || ( prefix + i );
},
2013-10-02 00:16:40 +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>