phaser/docs/Phaser.Camera.html

3650 lines
61 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>
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-04-29 14:39:02 +00:00
<li class="class-depth-1">
<a href="Phaser.ArrayList.html">ArrayList</a>
</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>
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>
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>
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">
2014-02-05 06:29:17 +00:00
<a href="Phaser.GamepadButton.html">GamepadButton</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>
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>
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>
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>
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>
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">
2013-10-02 11:11:22 +00:00
<a href="Phaser.World.html">World</a>
</li>
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
<a href="PIXI.AbstractFilter.html">AbstractFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.AjaxRequest.html">AjaxRequest</a>
</li>
<li class="class-depth-1">
<a href="PIXI.AlphaMaskFilter.html">AlphaMaskFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.AsciiFilter.html">AsciiFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.AssetLoader.html">AssetLoader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.AtlasLoader.html">AtlasLoader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.BaseTexture.html">BaseTexture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.BitmapFontLoader.html">BitmapFontLoader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.BitmapText.html">BitmapText</a>
</li>
<li class="class-depth-1">
<a href="PIXI.BlurFilter.html">BlurFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.BlurXFilter.html">BlurXFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.BlurYFilter.html">BlurYFilter</a>
</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>
<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.Circle.html">Circle</a>
</li>
<li class="class-depth-1">
<a href="PIXI.ColorMatrixFilter.html">ColorMatrixFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.ColorStepFilter.html">ColorStepFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.ComplexPrimitiveShader.html">ComplexPrimitiveShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.ConvolutionFilter.html">ConvolutionFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CrossHatchFilter.html">CrossHatchFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.DisplacementFilter.html">DisplacementFilter</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>
<li class="class-depth-1">
<a href="PIXI.DotScreenFilter.html">DotScreenFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Ellipse.html">Ellipse</a>
</li>
<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.FilterBlock.html">FilterBlock</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.GrayFilter.html">GrayFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.ImageLoader.html">ImageLoader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.InteractionData.html">InteractionData</a>
</li>
<li class="class-depth-1">
<a href="PIXI.InteractionManager.html">InteractionManager</a>
</li>
<li class="class-depth-1">
<a href="PIXI.InvertFilter.html">InvertFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.JsonLoader.html">JsonLoader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Matrix.html">Matrix</a>
</li>
<li class="class-depth-1">
<a href="PIXI.MovieClip.html">MovieClip</a>
</li>
<li class="class-depth-1">
<a href="PIXI.NoiseFilter.html">NoiseFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.NormalMapFilter.html">NormalMapFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PixelateFilter.html">PixelateFilter</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">
<a href="PIXI.Point.html">Point</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Polygon.html">Polygon</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PolyK.html">PolyK</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PrimitiveShader.html">PrimitiveShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Rectangle.html">Rectangle</a>
</li>
<li class="class-depth-1">
<a href="PIXI.RenderTexture.html">RenderTexture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.RGBSplitFilter.html">RGBSplitFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Rope.html">Rope</a>
</li>
<li class="class-depth-1">
<a href="PIXI.RoundedRectangle.html">RoundedRectangle</a>
</li>
<li class="class-depth-1">
<a href="PIXI.SepiaFilter.html">SepiaFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.SmartBlurFilter.html">SmartBlurFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Spine.html">Spine</a>
</li>
<li class="class-depth-1">
<a href="PIXI.SpineLoader.html">SpineLoader</a>
</li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1">
<a href="PIXI.SpineTextureLoader.html">SpineTextureLoader</a>
</li>
2014-11-15 20:01:46 +00:00
<li class="class-depth-1">
<a href="PIXI.Sprite.html">Sprite</a>
</li>
<li class="class-depth-1">
<a href="PIXI.SpriteBatch.html">SpriteBatch</a>
</li>
<li class="class-depth-1">
<a href="PIXI.SpriteSheetLoader.html">SpriteSheetLoader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Stage.html">Stage</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Strip.html">Strip</a>
</li>
<li class="class-depth-1">
<a href="PIXI.StripShader.html">StripShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Text.html">Text</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Texture.html">Texture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.TilingSprite.html">TilingSprite</a>
</li>
<li class="class-depth-1">
<a href="PIXI.TiltShiftFilter.html">TiltShiftFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.TiltShiftXFilter.html">TiltShiftXFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.TiltShiftYFilter.html">TiltShiftYFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.TwistFilter.html">TwistFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.VideoTexture.html">VideoTexture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.WebGLBlendModeManager.html">WebGLBlendModeManager</a>
</li>
<li class="class-depth-1">
<a href="PIXI.WebGLFastSpriteBatch.html">WebGLFastSpriteBatch</a>
</li>
<li class="class-depth-1">
<a href="PIXI.WebGLFilterManager.html">WebGLFilterManager</a>
</li>
<li class="class-depth-1">
<a href="PIXI.WebGLRenderer.html">WebGLRenderer</a>
</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>
<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>
<li class="class-depth-1"><a href="Phaser.InputManager.html">Input Manager</a></li>
<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>
<li class="class-depth-1"><a href="Phaser.Emitter.html">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.Rectangle.html">Rectangle</a></li>
<li class="class-depth-1"><a href="Phaser.Point.html">Point</a></li>
<li class="class-depth-1"><a href="Phaser.Line.html">Line</a></li>
<li class="class-depth-1"><a href="Phaser.Ellipse.html">Ellipse</a></li>
<li class="class-depth-1"><a href="Phaser.Polygon.html">Polygon</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>
<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 ">
<li class="class-depth-1"><a href="https://github.com/photonstorm/phaser">Phaser Github</a></li>
<li class="class-depth-1"><a href="http://examples.phaser.io">Phaser Examples</a></li>
<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>
<li class="class-depth-1"><a href="https://confirmsubscription.com/h/r/369DE48E3E86AF1E">Newsletter</a></li>
<li class="class-depth-1"><a href="https://twitter.com/photonstorm">Twitter</a></li>
<li class="class-depth-1"><a href="http://www.html5gamedevs.com/topic/4470-official-phaserio-irc-channel-phaserio-on-freenode/">IRC</a></li>
2014-12-03 10:39:11 +00:00
<li class="class-depth-1"><a href="https://leanpub.com/u/photonstorm">Phaser Books</a></li>
2014-11-25 00:23:44 +00:00
<li class="class-depth-1"><a href="https://www.gittip.com/photonstorm/">GitTip</a></li>
</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 -
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-20">line 20</a>
</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 "
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 -
2014-11-25 00:23:44 +00:00
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-132">line 132</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 "
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 -
2014-11-25 00:23:44 +00:00
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-138">line 138</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 "
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 -
2014-11-25 00:23:44 +00:00
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-144">line 144</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 "
id="FOLLOW_TOPDOWN_TIGHT"><span class="type-signature">&lt;static, constant> </span>FOLLOW_TOPDOWN_TIGHT<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 -
2014-11-25 00:23:44 +00:00
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-150">line 150</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 "
2014-11-25 00:23:44 +00:00
id="atLimit"><span class="type-signature"></span>atLimit<span class="type-signature"> :boolean</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
<div class="description">
2014-11-25 00:23:44 +00:00
<p>Whether this camera is flush with the World Bounds or not.</p>
2014-11-15 20:01:46 +00:00
</div>
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 -
2014-11-25 00:23:44 +00:00
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-82">line 82</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 "
2014-11-25 00:23:44 +00:00
id="bounds"><span class="type-signature"></span>bounds<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
<div class="description">
2014-11-25 00:23:44 +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 -
2014-11-25 00:23:44 +00:00
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-60">line 60</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2014-11-25 00:23:44 +00:00
id="deadzone"><span class="type-signature"></span>deadzone<span class="type-signature"> :<a href="Phaser.Rectangle.html">Phaser.Rectangle</a></span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
2014-11-25 00:23:44 +00:00
<p>Moving inside this Rectangle will not cause the camera to move.</p>
</div>
<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 -
2014-11-25 00:23:44 +00:00
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-65">line 65</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 "
2014-11-25 00:23:44 +00:00
id="displayObject"><span class="type-signature"></span>displayObject<span class="type-signature"> :<a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span></h4>
2014-11-15 20:01:46 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
2014-11-25 00:23:44 +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>
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2014-11-25 00:23:44 +00:00
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-93">line 93</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 "
2014-11-25 00:23:44 +00:00
id="game"><span class="type-signature"></span>game<span class="type-signature"> :<a href="Phaser.Game.html">Phaser.Game</a></span></h4>
2013-10-02 00:16:40 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
2014-11-25 00:23:44 +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
<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 -
2014-11-25 00:23:44 +00:00
<a href="Camera.js.html">core/Camera.js</a>, <a href="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-02-05 06:29:17 +00:00
</dl>
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2014-11-25 00:23:44 +00:00
id="height"><span class="type-signature"></span>height<span class="type-signature"> :number</span></h4>
2014-02-05 06:29:17 +00:00
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
2014-11-25 00:23:44 +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
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2014-11-25 00:23:44 +00:00
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-497">line 497</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 "
2014-11-25 00:23:44 +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">
2014-11-25 00:23:44 +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-25 00:23:44 +00:00
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>0</li></ul></dd>
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2014-11-25 00:23:44 +00:00
<a href="Camera.js.html">core/Camera.js</a>, <a href="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
</dl>
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
2014-11-25 00:23:44 +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
2014-11-15 20:01:46 +00:00
<div class="description">
2014-11-25 00:23:44 +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>
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 -
2014-11-25 00:23:44 +00:00
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-455">line 455</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 "
2014-11-25 00:23:44 +00:00
id="roundPx"><span class="type-signature"></span>roundPx<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
<div class="description">
2014-11-25 00:23:44 +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>
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
2014-11-25 00:23:44 +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 -
2014-11-25 00:23:44 +00:00
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-77">line 77</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 "
2014-11-25 00:23:44 +00:00
id="scale"><span class="type-signature"></span>scale<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">
2014-11-25 00:23:44 +00:00
<p>The scale of 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 -
2014-11-25 00:23:44 +00:00
<a href="Camera.js.html">core/Camera.js</a>, <a href="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-25 00:23:44 +00:00
<h4 class="name toc-deprecated"
id="screenView"><span class="type-signature"></span>screenView<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-25 00:23:44 +00:00
<dt class="important deprecated-notice">
This method is <em>deprecated</em> and should not be used. It may be removed in the future.
</dt>
2014-11-15 20:01:46 +00:00
<div class="description">
2014-11-25 00:23:44 +00:00
<p>Used by Sprites to work out Camera culling.</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
2014-11-25 00:23:44 +00:00
<dt class="important tag-deprecated">Deprecated:</dt>
<dd class="tag-deprecated"><ul>
<li>No longer used for camera culling. Uses Camera.view instead.</li>
</ul></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
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 -
2014-11-25 00:23:44 +00:00
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-51">line 51</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 "
2014-11-25 00:23:44 +00:00
id="target"><span class="type-signature"></span>target<span class="type-signature"> :<a href="Phaser.Sprite.html">Phaser.Sprite</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">
2014-11-25 00:23:44 +00:00
<p>If the camera is tracking a Sprite, this is a reference to it, otherwise null.</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-25 00:23:44 +00:00
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd>
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2014-11-25 00:23:44 +00:00
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-88">line 88</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 "
2014-11-25 00:23:44 +00:00
id="totalInView"><span class="type-signature">&lt;readonly> </span>totalInView<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">
2014-11-25 00:23:44 +00:00
<p>The total number of Sprites with <code>autoCull</code> set to <code>true</code> that are visible by this Camera.</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 -
2014-11-25 00:23:44 +00:00
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-104">line 104</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 "
id="view"><span class="type-signature"></span>view<span class="type-signature"> :<a href="Phaser.Rectangle.html">Phaser.Rectangle</a></span></h4>
</dt>
<dd>
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
<div class="description">
<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.
2014-11-25 00:23:44 +00:00
Sprites outside of this view are not rendered if Sprite.autoCull is set to <code>true</code>. Otherwise they are always rendered.</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 -
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-45">line 45</a>
</dt>
2013-10-02 00:16:40 +00:00
</dl>
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="visible"><span class="type-signature"></span>visible<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">
<p>Whether this camera is visible or not.</p>
</div>
2013-10-02 00:16:40 +00:00
<dl class="details">
2014-11-15 20:01:46 +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 -
2014-11-25 00:23:44 +00:00
<a href="Camera.js.html">core/Camera.js</a>, <a href="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>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="width"><span class="type-signature"></span>width<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">
2014-11-15 20:01:46 +00:00
<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>
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 -
2014-11-25 00:23:44 +00:00
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-480">line 480</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 "
id="world"><span class="type-signature"></span>world<span class="type-signature"> :<a href="Phaser.World.html">Phaser.World</a></span></h4>
</dt>
<dd>
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
<div class="description">
<p>A reference to the game world.</p>
</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 -
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-30">line 30</a>
</dt>
2013-10-02 00:16:40 +00:00
</dl>
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="x"><span class="type-signature"></span>x<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">
2014-11-15 20:01:46 +00:00
<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>
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 -
2014-11-25 00:23:44 +00:00
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-409">line 409</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 "
id="y"><span class="type-signature"></span>y<span class="type-signature"> :number</span></h4>
</dt>
<dd>
2013-10-02 00:16:40 +00:00
2014-11-15 20:01:46 +00:00
<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>
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 -
2014-11-25 00:23:44 +00:00
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-432">line 432</a>
2014-11-15 20:01:46 +00:00
</dt>
2013-10-02 00:16:40 +00:00
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="checkWorldBounds"><span class="type-signature"></span>checkWorldBounds<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">
<p>Method called to ensure the camera doesn't venture outside of the game world.</p>
</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 -
2014-11-25 00:23:44 +00:00
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-322">line 322</a>
2014-11-15 20:01:46 +00:00
</dt>
</dl>
2014-11-15 20:01:46 +00:00
</dd>
<dt>
2014-11-15 20:01:46 +00:00
<h4 class="name "
id="focusOn"><span class="type-signature"></span>focusOn<span class="signature">(displayObject)</span><span class="type-signature"></span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<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>
2014-11-15 20:01:46 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2014-11-25 00:23:44 +00:00
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-214">line 214</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 "
id="focusOnXY"><span class="type-signature"></span>focusOnXY<span class="signature">(x, y)</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>Move the camera focus on a location instantly.</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>
<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
2013-10-02 00:16:40 +00:00
<dl class="details">
2014-11-15 20:01:46 +00:00
<dt class="tag-source">Source -
2014-11-25 00:23:44 +00:00
<a href="Camera.js.html">core/Camera.js</a>, <a href="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>
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 "
id="follow"><span class="type-signature"></span>follow<span class="signature">(target, <span class="optional">style</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">
<p>Tells this camera which sprite to follow.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<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>
<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>
<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>
</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 -
2014-11-25 00:23:44 +00:00
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-160">line 160</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 "
id="reset"><span class="type-signature"></span>reset<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
2014-11-15 20:01:46 +00:00
<div class="description">
<p>Resets the camera back to 0,0 and un-follows any object it may have been tracking.</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 -
2014-11-25 00:23:44 +00:00
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-392">line 392</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 "
id="setBoundsToWorld"><span class="type-signature"></span>setBoundsToWorld<span class="signature">()</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">
<p>Update the Camera bounds to match the game world.</p>
</div>
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 -
2014-11-25 00:23:44 +00:00
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-309">line 309</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 "
id="setPosition"><span class="type-signature"></span>setPosition<span class="signature">(x, y)</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 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>
</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>
<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 -
2014-11-25 00:23:44 +00:00
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-358">line 358</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 "
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">
<p>Sets the size of the view rectangle given the width and height in parameters.</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>width</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The desired width.</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 desired height.</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 -
2014-11-25 00:23:44 +00:00
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-378">line 378</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 -
2014-11-25 00:23:44 +00:00
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-203">line 203</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 "
id="update"><span class="type-signature"></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">
<p>Update focusing and scrolling.</p>
</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 -
2014-11-25 00:23:44 +00:00
<a href="Camera.js.html">core/Camera.js</a>, <a href="Camera.js.html#sunlight-1-line-237">line 237</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">
2014-02-05 06:29:17 +00:00
Phaser Copyright © 2012-2014 Photon Storm Ltd.
2013-10-02 00:16:40 +00:00
</span>
<br />
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
2014-12-03 10:39:11 +00:00
on Wed Dec 03 2014 10:30:37 GMT-0000 (GMT) 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>