docs/Phaser.Camera.html

<!DOCTYPE html>


<html lang="en">
<head>
	<meta charset="utf-8">
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<title>Phaser CE Class: Camera</title>
	<link rel="stylesheet" href="styles/site.phaser.css?2025022010">
</head>

<body>


<div class="navbar navbar-default navbar-fixed-top navbar-inverse">
  <div class="container-fluid">
  	<div class="navbar-header">
  		<a class="navbar-brand" href="index.html">Phaser CE</a>
  		<button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
  			<span class="icon-bar"></span>
  			<span class="icon-bar"></span>
  			<span class="icon-bar"></span>
      </button>
  	</div>
  	<div class="navbar-collapse collapse" id="topNavigation">
  		<ul class="nav navbar-nav">
  			
  			<li class="dropdown">
  				<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
  				<ul class="dropdown-menu ">
  					<li><a href="Phaser.html">Phaser</a></li><li><a href="PhaserGlobal.html">PhaserGlobal</a></li><li><a href="PIXI.html">PIXI</a></li>
  				</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 ">
  					<li><a href="CreatureShader.html">CreatureShader</a></li><li><a href="EarCut.html">EarCut</a></li><li><a href="Event.html">Event</a></li><li><a href="EventTarget.html">EventTarget</a></li><li><a href="Phaser.Animation.html">Phaser.Animation</a></li><li><a href="Phaser.AnimationManager.html">Phaser.AnimationManager</a></li><li><a href="Phaser.AnimationParser.html">Phaser.AnimationParser</a></li><li><a href="Phaser.ArraySet.html">Phaser.ArraySet</a></li><li><a href="Phaser.ArrayUtils.html">Phaser.ArrayUtils</a></li><li><a href="Phaser.AudioSprite.html">Phaser.AudioSprite</a></li><li><a href="Phaser.BitmapData.html">Phaser.BitmapData</a></li><li><a href="Phaser.BitmapText.html">Phaser.BitmapText</a></li><li><a href="Phaser.Bullet.html">Phaser.Bullet</a></li><li><a href="Phaser.Button.html">Phaser.Button</a></li><li><a href="Phaser.Cache.html">Phaser.Cache</a></li><li><a href="Phaser.Camera.html">Phaser.Camera</a></li><li><a href="Phaser.Canvas.html">Phaser.Canvas</a></li><li><a href="Phaser.CanvasPool.html">Phaser.CanvasPool</a></li><li><a href="Phaser.Circle.html">Phaser.Circle</a></li><li><a href="Phaser.Color.html">Phaser.Color</a></li><li><a href="Phaser.Component.Angle.html">Phaser.Component.Angle</a></li><li><a href="Phaser.Component.Animation.html">Phaser.Component.Animation</a></li><li><a href="Phaser.Component.AutoCull.html">Phaser.Component.AutoCull</a></li><li><a href="Phaser.Component.Bounds.html">Phaser.Component.Bounds</a></li><li><a href="Phaser.Component.BringToTop.html">Phaser.Component.BringToTop</a></li><li><a href="Phaser.Component.Core.html">Phaser.Component.Core</a></li><li><a href="Phaser.Component.Crop.html">Phaser.Component.Crop</a></li><li><a href="Phaser.Component.Delta.html">Phaser.Component.Delta</a></li><li><a href="Phaser.Component.Destroy.html">Phaser.Component.Destroy</a></li><li><a href="Phaser.Component.FixedToCamera.html">Phaser.Component.FixedToCamera</a></li><li><a href="Phaser.Component.Health.html">Phaser.Component.Health</a></li><li><a href="Phaser.Component.InCamera.html">Phaser.Component.InCamera</a></li><li><a href="Phaser.Component.InputEnabled.html">Phaser.Component.InputEnabled</a></li><li><a href="Phaser.Component.InWorld.html">Phaser.Component.InWorld</a></li><li><a href="Phaser.Component.LifeSpan.html">Phaser.Component.LifeSpan</a></li><li><a href="Phaser.Component.LoadTexture.html">Phaser.Component.LoadTexture</a></li><li><a href="Phaser.Component.Overlap.html">Phaser.Component.Overlap</a></li><li><a href="Phaser.Component.PhysicsBody.html">Phaser.Component.PhysicsBody</a></li><li><a href="Phaser.Component.Reset.html">Phaser.Component.Reset</a></li><li><a href="Phaser.Component.ScaleMinMax.html">Phaser.Component.ScaleMinMax</a></li><li><a href="Phaser.Component.Smoothed.html">Phaser.Component.Smoothed</a></li><li><a href="Phaser.Create.html">Phaser.Create</a></li><li><a href="Phaser.Creature.html">Phaser.Creature</a></li><li><a href="Phaser.Device.html">Phaser.Device</a></li><li><a href="Phaser.DeviceButton.html">Phaser.DeviceButton</a></li><li><a href="Phaser.DOM.html">Phaser.DOM</a></li><li><a href="Phaser.Easing.html">Phaser.Easing</a></li><li><a href="Phaser.Easing.Back.html">Phaser.Easing.Back</a></li><li><a href="Phaser.Easing.Bounce.html">Phaser.Easing.Bounce</a></li><li><a href="Phaser.Easing.Circular.html">Phaser.Easing.Circular</a></li><li><a href="Phaser.Easing.Cubic.html">Phaser.Easing.Cubic</a></li><li><a href="Phaser.Easing.Elastic.html">Phaser.Easing.Elastic</a></li><li><a href="Phaser.Easing.Exponential.html">Phaser.Easing.Exponential</a></li><li><a href="Phaser.Easing.Linear.html">Phaser.Easing.Linear</a></li><li><a href="Phaser.Easing.Quadratic.html">Phaser.Easing.Quadratic</a></li><li><a href="Phaser.Easing.Quartic.html">Phaser.Easing.Quartic</a></li><li><a href="Phaser.Easing.Quintic.html">Phaser.Easing.Quintic</a></li><li><a href="Phaser.Easing.Sinusoidal.html">Phaser.Easing.Sinusoidal</a></li><li><a href="Phaser.Ellipse.html">Phaser.Ellipse</a></li><li><a href="Phaser.Events.html">Phaser.Events</a></li><li><a href="Phaser.Filter.html">Phaser.Filter</a></li><li><a href="Phaser.FlexGrid.html">Phaser.FlexGrid</a></li><li><a href="Phaser.FlexLayer.html">Phaser.FlexLayer</a></li><li><a href="Phaser.Frame.html">Phaser.Frame</a></li><li><a href="Phaser.FrameData.html">Phaser.FrameData</a></li><li><a href="Phaser.Game.html">Phaser.Game</a></li><li><a href="Phaser.GameObjectCreator.html">Phaser.GameObjectCreator</a></li><li><a href="Phaser.GameObjectFactory.html">Phaser.GameObjectFactory</a></li><li><a href="Phaser.Gamepad.html">Phaser.Gamepad</a></li><li><a href="Phaser.Graphics.html">Phaser.Graphics</a></li><li><a href="Phaser.GraphicsData.html">Phaser.GraphicsData</a></li><li><a href="Phaser.Group.html">Phaser.Group</a></li><li><a href="Phaser.Hermite.html">Phaser.Hermite</a></li><li><a href="Phaser.Image.html">Phaser.Image</a></li><li><a href="Phaser.ImageCollection.html">Phaser.ImageCollection</a></li><li><a href="Phaser.Input.html">Phaser.Input</a></li><li><a href="Phaser.InputHandler.html">Phaser.InputHandler</a></li><li><a href="Phaser.Key.html">Phaser.Key</a></li><li><a href="Phaser.Keyboard.html">Phaser.Keyboard</a></li><li><a href="Phaser.KeyCode.html">Phaser.KeyCode</a></li><li><a href="Phaser.Line.html">Phaser.Line</a></li><li><a href="Phaser.LinkedList.html">Phaser.LinkedList</a></li><li><a href="Phaser.Loader.html">Phaser.Loader</a></li><li><a href="Phaser.LoaderParser.html">Phaser.LoaderParser</a></li><li><a href="Phaser.Math.html">Phaser.Math</a></li><li><a href="Phaser.Matrix.html">Phaser.Matrix</a></li><li><a href="Phaser.Mouse.html">Phaser.Mouse</a></li><li><a href="Phaser.MouseWheel.html">Phaser.MouseWheel</a></li><li><a href="Phaser.MSPointer.html">Phaser.MSPointer</a></li><li><a href="Phaser.Particle.html">Phaser.Particle</a></li><li><a href="Phaser.Particles.html">Phaser.Particles</a></li><li><a href="Phaser.Particles.Arcade.html">Phaser.Particles.Arcade</a></li><li><a href="Phaser.Particles.Arcade.Emitter.html">Phaser.Particles.Arcade.Emitter</a></li><li><a href="Phaser.Path.html">Phaser.Path</a></li><li><a href="Phaser.PathFollower.html">Phaser.PathFollower</a></li><li><a href="Phaser.PathPoint.html">Phaser.PathPoint</a></li><li><a href="Phaser.Physics.html">Phaser.Physics</a></li><li><a href="Phaser.Physics.Arcade.html">Phaser.Physics.Arcade</a></li><li><a href="Phaser.Physics.Arcade.Body.html">Phaser.Physics.Arcade.Body</a></li><li><a href="Phaser.Physics.Arcade.TilemapCollision.html">Phaser.Physics.Arcade.TilemapCollision</a></li><li><a href="Phaser.Physics.Ninja.html">Phaser.Physics.Ninja</a></li><li><a href="Phaser.Physics.Ninja.AABB.html">Phaser.Physics.Ninja.AABB</a></li><li><a href="Phaser.Physics.Ninja.Body.html">Phaser.Physics.Ninja.Body</a></li><li><a href="Phaser.Physics.Ninja.Circle.html">Phaser.Physics.Ninja.Circle</a></li><li><a href="Phaser.Physics.Ninja.Tile.html">Phaser.Physics.Ninja.Tile</a></li><li><a href="Phaser.Physics.P2.html">Phaser.Physics.P2</a></li><li><a href="Phaser.Physics.P2.Body.html">Phaser.Physics.P2.Body</a></li><li><a href="Phaser.Physics.P2.BodyDebug.html">Phaser.Physics.P2.BodyDebug</a></li><li><a href="Phaser.Physics.P2.CollisionGroup.html">Phaser.Physics.P2.CollisionGroup</a></li><li><a href="Phaser.Physics.P2.ContactMaterial.html">Phaser.Physics.P2.ContactMaterial</a></li><li><a href="Phaser.Physics.P2.DistanceConstraint.html">Phaser.Physics.P2.DistanceConstraint</a></li><li><a href="Phaser.Physics.P2.FixtureList.html">Phaser.Physics.P2.FixtureList</a></li><li><a href="Phaser.Physics.P2.GearConstraint.html">Phaser.Physics.P2.GearConstraint</a></li><li><a href="Phaser.Physics.P2.InversePointProxy.html">Phaser.Physics.P2.InversePointProxy</a></li><li><a href="Phaser.Physics.P2.LockConstraint.html">Phaser.Physics.P2.LockConstraint</a></li><li><a href="Phaser.Physics.P2.Material.html">Phaser.Physics.P2.Material</a></li><li><a href="Phaser.Physics.P2.PointProxy.html">Phaser.Physics.P2.PointProxy</a></li><li><a href="Phaser.Physics.P2.PrismaticConstraint.html">Phaser.Physics.P2.PrismaticConstraint</a></li><li><a href="Phaser.Physics.P2.RevoluteConstraint.html">Phaser.Physics.P2.RevoluteConstraint</a></li><li><a href="Phaser.Physics.P2.RotationalSpring.html">Phaser.Physics.P2.RotationalSpring</a></li><li><a href="Phaser.Physics.P2.Spring.html">Phaser.Physics.P2.Spring</a></li><li><a href="Phaser.Plugin.html">Phaser.Plugin</a></li><li><a href="Phaser.Plugin.PathManager.html">Phaser.Plugin.PathManager</a></li><li><a href="Phaser.PluginManager.html">Phaser.PluginManager</a></li><li><a href="Phaser.Point.html">Phaser.Point</a></li><li><a href="Phaser.Pointer.html">Phaser.Pointer</a></li><li><a href="Phaser.PointerLock.html">Phaser.PointerLock</a></li><li><a href="Phaser.PointerMode.html">Phaser.PointerMode</a></li><li><a href="Phaser.Polygon.html">Phaser.Polygon</a></li><li><a href="Phaser.QuadTree.html">Phaser.QuadTree</a></li><li><a href="Phaser.RandomDataGenerator.html">Phaser.RandomDataGenerator</a></li><li><a href="Phaser.Rectangle.html">Phaser.Rectangle</a></li><li><a href="Phaser.RenderTexture.html">Phaser.RenderTexture</a></li><li><a href="Phaser.RequestAnimationFrame.html">Phaser.RequestAnimationFrame</a></li><li><a href="Phaser.RetroFont.html">Phaser.RetroFont</a></li><li><a href="Phaser.Rope.html">Phaser.Rope</a></li><li><a href="Phaser.RoundedRectangle.html">Phaser.RoundedRectangle</a></li><li><a href="Phaser.ScaleManager.html">Phaser.ScaleManager</a></li><li><a href="Phaser.Signal.html">Phaser.Signal</a></li><li><a href="Phaser.SignalBinding.html">Phaser.SignalBinding</a></li><li><a href="Phaser.SinglePad.html">Phaser.SinglePad</a></li><li><a href="Phaser.Sound.html">Phaser.Sound</a></li><li><a href="Phaser.SoundManager.html">Phaser.SoundManager</a></li><li><a href="Phaser.Sprite.html">Phaser.Sprite</a></li><li><a href="Phaser.SpriteBatch.html">Phaser.SpriteBatch</a></li><li><a href="Phaser.Stage.html">Phaser.Stage</a></li><li><a href="Phaser.State.html">Phaser.State</a></li><li><a href="Phaser.StateManager.html">Phaser.StateManager</a></li><li><a href="Phaser.Text.html">Phaser.Text</a></li><li><a href="Phaser.Tile.html">Phaser.Tile</a></li><li><a href="Phaser.Tilemap.html">Phaser.Tilemap</a></li><li><a href="Phaser.TilemapLayer.html">Phaser.TilemapLayer</a></li><li><a href="Phaser.TilemapParser.html">Phaser.TilemapParser</a></li><li><a href="Phaser.Tileset.html">Phaser.Tileset</a></li><li><a href="Phaser.TileSprite.html">Phaser.TileSprite</a></li><li><a href="Phaser.Time.html">Phaser.Time</a></li><li><a href="Phaser.Timer.html">Phaser.Timer</a></li><li><a href="Phaser.TimerEvent.html">Phaser.TimerEvent</a></li><li><a href="Phaser.Touch.html">Phaser.Touch</a></li><li><a href="Phaser.Tween.html">Phaser.Tween</a></li><li><a href="Phaser.TweenData.html">Phaser.TweenData</a></li><li><a href="Phaser.TweenManager.html">Phaser.TweenManager</a></li><li><a href="Phaser.Utils.html">Phaser.Utils</a></li><li><a href="Phaser.Utils.Debug.html">Phaser.Utils.Debug</a></li><li><a href="Phaser.Video.html">Phaser.Video</a></li><li><a href="Phaser.Weapon.html">Phaser.Weapon</a></li><li><a href="Phaser.World.html">Phaser.World</a></li><li><a href="PIXI.BaseTexture.html">PIXI.BaseTexture</a></li><li><a href="PIXI.CanvasBuffer.html">PIXI.CanvasBuffer</a></li><li><a href="PIXI.CanvasGraphics.html">PIXI.CanvasGraphics</a></li><li><a href="PIXI.CanvasMaskManager.html">PIXI.CanvasMaskManager</a></li><li><a href="PIXI.CanvasRenderer.html">PIXI.CanvasRenderer</a></li><li><a href="PIXI.CanvasTinter.html">PIXI.CanvasTinter</a></li><li><a href="PIXI.ComplexPrimitiveShader.html">PIXI.ComplexPrimitiveShader</a></li><li><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></li><li><a href="PIXI.DisplayObjectContainer.html">PIXI.DisplayObjectContainer</a></li><li><a href="PIXI.FilterTexture.html">PIXI.FilterTexture</a></li><li><a href="PIXI.PixiFastShader.html">PIXI.PixiFastShader</a></li><li><a href="PIXI.PixiShader.html">PIXI.PixiShader</a></li><li><a href="PIXI.PrimitiveShader.html">PIXI.PrimitiveShader</a></li><li><a href="PIXI.Sprite.html">PIXI.Sprite</a></li><li><a href="PIXI.StripShader.html">PIXI.StripShader</a></li><li><a href="PIXI.Texture.html">PIXI.Texture</a></li><li><a href="PIXI.WebGLBlendModeManager.html">PIXI.WebGLBlendModeManager</a></li><li><a href="PIXI.WebGLFastSpriteBatch.html">PIXI.WebGLFastSpriteBatch</a></li><li><a href="PIXI.WebGLFilterManager.html">PIXI.WebGLFilterManager</a></li><li><a href="PIXI.WebGLRenderer.html">PIXI.WebGLRenderer</a></li>
  				</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 ">
  					<li><a href="global.html">Global</a></li>
  				</ul>
  			</li>
  			
        <li>
  <a href="https://github.com/photonstorm/phaser-ce/blob/master/README.md">
    <span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span>
    README
  </a>
</li>

<li>
  <a href="https://github.com/photonstorm/phaser-ce/blob/master/CHANGELOG.md">
    <span class="glyphicon glyphicon-list" aria-hidden="true"></span>
    CHANGELOG
  </a>
</li>

<li class="dropdown">
  <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">
    <span class="glyphicon glyphicon-globe" aria-hidden="true"></span>
    Community
    <span class="caret"></span>
  </a>
  <ul class="dropdown-menu">
    <li>
      <a href="http://phaser.io">Phaser</a>
    </li>
    <li>
      <a href="https://github.com/photonstorm/phaser-ce">Phaser CE on GitHub</a>
    </li>
    <li>
      <a href="https://codepen.io/collection/AMbZgY/">Phaser CE Examples</a>
    </li>
    <li>
      <a href="http://www.html5gamedevs.com/forum/14-phaser/">Forum</a>
    </li>
    <li>
      <a href="https://twitter.com/photonstorm">Twitter</a>
    </li>
    <li>
      <a href="http://phaser.io/community/slack">Slack</a>
    </li>
    <li>
      <a href="http://phaser.io/community/donate">Donate</a>
    </li>
  </ul>
</li>

  		</ul>
          
  	</div>
  </div>
</div>


<div class="container-fluid" id="toc-content">
	<div class="row">
		
	  <div class="col-md-9 col-md-offset-3">
		
			<div id="main">

	<h1 class="page-title">Class: Camera</h1>
<section>

<header>
    
        <h2>
            <span class="ancestors"><a href="Phaser.html">Phaser</a>.</span>
        
        Camera
        </h2>
        
    
</header>


<article>
    <div class="container-overview">
    
        
<dt>
    <h4 class="name" id="Camera" data-name="Camera">
      <span class="type-signature"></span>new Camera(game, id, x, y, width, height)
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-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 param-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 param-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 param-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 param-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 param-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 param-description last"><p>The height of the view rectangle</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L20" title="Camera on line 20 of src/core/Camera.js">src/core/Camera.js line 20</a>
    

</dl>


</dd>

    
    </div>

    
        <h3 class="subsection-title">Members</h3>

        <dl>
            
<dt>
    <h4 id=".ENABLE_FX" data-name="ENABLE_FX">
      <span class="type-signature">&lt;static, constant> </span>ENABLE_FX<span class="type-signature"> : boolean</span>
      
    </h4>
    
</dt>
<dd>
    

        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L245" title="ENABLE_FX on line 245 of src/core/Camera.js">src/core/Camera.js line 245</a>
    

</dl>


</dd>

        
<dt>
    <h4 id=".FADE_IN" data-name="FADE_IN">
      <span class="type-signature">&lt;static, constant> </span>FADE_IN<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    

        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L263" title="FADE_IN on line 263 of src/core/Camera.js">src/core/Camera.js line 263</a>
    

</dl>


</dd>

        
<dt>
    <h4 id=".FADE_OUT" data-name="FADE_OUT">
      <span class="type-signature">&lt;static, constant> </span>FADE_OUT<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    

        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L257" title="FADE_OUT on line 257 of src/core/Camera.js">src/core/Camera.js line 257</a>
    

</dl>


</dd>

        
<dt>
    <h4 id=".FLASH" data-name="FLASH">
      <span class="type-signature">&lt;static, constant> </span>FLASH<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    

        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L251" title="FLASH on line 251 of src/core/Camera.js">src/core/Camera.js line 251</a>
    

</dl>


</dd>

        
<dt>
    <h4 id=".FOLLOW_LOCKON" data-name="FOLLOW_LOCKON">
      <span class="type-signature">&lt;static, constant> </span>FOLLOW_LOCKON<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>A follow style that uses no deadzone.</p>
    </div>
    

        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L197" title="FOLLOW_LOCKON on line 197 of src/core/Camera.js">src/core/Camera.js line 197</a>
    

</dl>


</dd>

        
<dt>
    <h4 id=".FOLLOW_PLATFORMER" data-name="FOLLOW_PLATFORMER">
      <span class="type-signature">&lt;static, constant> </span>FOLLOW_PLATFORMER<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>A follow style that uses a tall, narrow deadzone (0.33 x 0.125) with a center slightly above the view center.</p>
    </div>
    

        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L205" title="FOLLOW_PLATFORMER on line 205 of src/core/Camera.js">src/core/Camera.js line 205</a>
    

</dl>


</dd>

        
<dt>
    <h4 id=".FOLLOW_TOPDOWN" data-name="FOLLOW_TOPDOWN">
      <span class="type-signature">&lt;static, constant> </span>FOLLOW_TOPDOWN<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>A follow style that uses a square deadzone (0.25 of the larger view edge).</p>
    </div>
    

        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L213" title="FOLLOW_TOPDOWN on line 213 of src/core/Camera.js">src/core/Camera.js line 213</a>
    

</dl>


</dd>

        
<dt>
    <h4 id=".FOLLOW_TOPDOWN_TIGHT" data-name="FOLLOW_TOPDOWN_TIGHT">
      <span class="type-signature">&lt;static, constant> </span>FOLLOW_TOPDOWN_TIGHT<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>A follow style that uses a small square deadzone (0.125 of the larger view edge).</p>
    </div>
    

        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L221" title="FOLLOW_TOPDOWN_TIGHT on line 221 of src/core/Camera.js">src/core/Camera.js line 221</a>
    

</dl>


</dd>

        
<dt>
    <h4 id=".SHAKE_BOTH" data-name="SHAKE_BOTH">
      <span class="type-signature">&lt;static, constant> </span>SHAKE_BOTH<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    

        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L227" title="SHAKE_BOTH on line 227 of src/core/Camera.js">src/core/Camera.js line 227</a>
    

</dl>


</dd>

        
<dt>
    <h4 id=".SHAKE_HORIZONTAL" data-name="SHAKE_HORIZONTAL">
      <span class="type-signature">&lt;static, constant> </span>SHAKE_HORIZONTAL<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    

        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L233" title="SHAKE_HORIZONTAL on line 233 of src/core/Camera.js">src/core/Camera.js line 233</a>
    

</dl>


</dd>

        
<dt>
    <h4 id=".SHAKE_VERTICAL" data-name="SHAKE_VERTICAL">
      <span class="type-signature">&lt;static, constant> </span>SHAKE_VERTICAL<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    

        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L239" title="SHAKE_VERTICAL on line 239 of src/core/Camera.js">src/core/Camera.js line 239</a>
    

</dl>


</dd>

        
<dt>
    <h4 id="atLimit" data-name="atLimit">
      <span class="type-signature"></span>atLimit<span class="type-signature"> : boolean</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>Whether this camera is flush with the World Bounds or not.</p>
    </div>
    

        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L76" title="atLimit on line 76 of src/core/Camera.js">src/core/Camera.js line 76</a>
    

</dl>


</dd>

        
<dt>
    <h4 id="bounds" data-name="bounds">
      <span class="type-signature"></span>bounds<span class="type-signature"> : <a href="Phaser.Rectangle.html">Phaser.Rectangle</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <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>
    </div>
    

        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Rectangle.html">Phaser.Rectangle</a></span>


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L54" title="bounds on line 54 of src/core/Camera.js">src/core/Camera.js line 54</a>
    

</dl>


</dd>

        
<dt>
    <h4 id="centerX" data-name="centerX">
      <span class="type-signature">&lt;readonly> </span>centerX<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The x position of the center of the Camera's viewport, relative to the top-left of the game canvas.</p>
    </div>
    

        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L1016" title="centerX on line 1016 of src/core/Camera.js">src/core/Camera.js line 1016</a>
    

</dl>


</dd>

        
<dt>
    <h4 id="centerY" data-name="centerY">
      <span class="type-signature">&lt;readonly> </span>centerY<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The y position of the center of the Camera's viewport, relative to the top-left of the game canvas.</p>
    </div>
    

        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L1031" title="centerY on line 1031 of src/core/Camera.js">src/core/Camera.js line 1031</a>
    

</dl>


</dd>

        
<dt>
    <h4 id="deadzone" data-name="deadzone">
      <span class="type-signature"></span>deadzone<span class="type-signature"> : <a href="Phaser.Rectangle.html">Phaser.Rectangle</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>Moving inside this Rectangle will not cause the camera to move.</p>
    </div>
    

        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Rectangle.html">Phaser.Rectangle</a></span>


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L59" title="deadzone on line 59 of src/core/Camera.js">src/core/Camera.js line 59</a>
    

</dl>


</dd>

        
<dt>
    <h4 id="displayObject" data-name="displayObject">
      <span class="type-signature"></span>displayObject<span class="type-signature"> : <a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The display object to which all game objects are added. Set by World.boot.</p>
    </div>
    

        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L87" title="displayObject on line 87 of src/core/Camera.js">src/core/Camera.js line 87</a>
    

</dl>


</dd>

        
<dt>
    <h4 id="fixedView" data-name="fixedView">
      <span class="type-signature">&lt;readonly> </span>fixedView<span class="type-signature"> : <a href="Phaser.Rectangle.html">Phaser.Rectangle</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>Immobile <a href="Phaser.Camera.html#view">view</a> rectangle. Its top-left is always (0, 0). You can use this align fixedToCamera objects.</p>
    </div>
    

        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Rectangle.html">Phaser.Rectangle</a></span>


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L999" title="fixedView on line 999 of src/core/Camera.js">src/core/Camera.js line 999</a>
    

</dl>


</dd>

        
<dt>
    <h4 id="fx" data-name="fx">
      <span class="type-signature">&lt;protected> </span>fx<span class="type-signature"> : <a href="Phaser.Graphics.html">Phaser.Graphics</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The Graphics object used to handle camera fx such as fade and flash.</p>
    </div>
    

        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Graphics.html">Phaser.Graphics</a></span>


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L136" title="fx on line 136 of src/core/Camera.js">src/core/Camera.js line 136</a>
    

</dl>


</dd>

        
<dt>
    <h4 id="game" data-name="game">
      <span class="type-signature"></span>game<span class="type-signature"> : <a href="Phaser.Game.html">Phaser.Game</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>A reference to the currently running Game.</p>
    </div>
    

        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Game.html">Phaser.Game</a></span>


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L25" title="game on line 25 of src/core/Camera.js">src/core/Camera.js line 25</a>
    

</dl>


</dd>

        
<dt>
    <h4 id="height" data-name="height">
      <span class="type-signature"></span>height<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <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>
    </div>
    

        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L961" title="height on line 961 of src/core/Camera.js">src/core/Camera.js line 961</a>
    

</dl>


</dd>

        
<dt>
    <h4 id="id" data-name="id">
      <span class="type-signature"></span>id<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>Reserved for future multiple camera set-ups.</p>
    </div>
    

        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L36" title="id on line 36 of src/core/Camera.js">src/core/Camera.js line 36</a>
    

</dl>


</dd>

        
<dt>
    <h4 id="lerp" data-name="lerp">
      <span class="type-signature"></span>lerp<span class="type-signature"> : <a href="Phaser.Point.html">Phaser.Point</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <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>
    </div>
    

        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Point.html">Phaser.Point</a></span>


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L109" title="lerp on line 109 of src/core/Camera.js">src/core/Camera.js line 109</a>
    

</dl>


</dd>

        
<dt>
    <h4 id="onFadeComplete" data-name="onFadeComplete">
      <span class="type-signature"></span>onFadeComplete<span class="type-signature"> : <a href="Phaser.Signal.html">Phaser.Signal</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>This signal is dispatched when the camera fade effect (fade in or fade out) completes.
You can look at the value of <code>Camera.fx.alpha</code> to determine which effect it was.
When the fade out effect completes <code>Camera.fx.alpha</code> is 1 and you will be left with the screen black (or whatever
color you faded to). In order to reset this call <code>Camera.resetFX</code>. <code>Camera.resetFX</code> is called automatically when you change State.
When the fade in effect completes, <code>Camera.fx.alpha</code> is 0 and there is no visible camera fill.</p>
    </div>
    

        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Signal.html">Phaser.Signal</a></span>


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L129" title="onFadeComplete on line 129 of src/core/Camera.js">src/core/Camera.js line 129</a>
    

</dl>


</dd>

        
<dt>
    <h4 id="onFlashComplete" data-name="onFlashComplete">
      <span class="type-signature"></span>onFlashComplete<span class="type-signature"> : <a href="Phaser.Signal.html">Phaser.Signal</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>This signal is dispatched when the camera flash effect completes.</p>
    </div>
    

        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Signal.html">Phaser.Signal</a></span>


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L119" title="onFlashComplete on line 119 of src/core/Camera.js">src/core/Camera.js line 119</a>
    

</dl>


</dd>

        
<dt>
    <h4 id="onShakeComplete" data-name="onShakeComplete">
      <span class="type-signature"></span>onShakeComplete<span class="type-signature"> : <a href="Phaser.Signal.html">Phaser.Signal</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>This signal is dispatched when the camera shake effect completes.</p>
    </div>
    

        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Signal.html">Phaser.Signal</a></span>


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L114" title="onShakeComplete on line 114 of src/core/Camera.js">src/core/Camera.js line 114</a>
    

</dl>


</dd>

        
<dt>
    <h4 id="position" data-name="position">
      <span class="type-signature"></span>position<span class="type-signature"> : <a href="Phaser.Point.html">Phaser.Point</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <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>
    </div>
    

        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Point.html">Phaser.Point</a></span>


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L915" title="position on line 915 of src/core/Camera.js">src/core/Camera.js line 915</a>
    

</dl>


</dd>

        
<dt>
    <h4 id="roundPx" data-name="roundPx">
      <span class="type-signature"></span>roundPx<span class="type-signature"> : boolean</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <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>
    </div>
    

        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
	<dd class="tag-default">
		<ul class="dummy">
			<li>true</li>
		</ul>
	</dd>
	

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L71" title="roundPx on line 71 of src/core/Camera.js">src/core/Camera.js line 71</a>
    

</dl>


</dd>

        
<dt>
    <h4 id="scale" data-name="scale">
      <span class="type-signature"></span>scale<span class="type-signature"> : <a href="Phaser.Point.html">Phaser.Point</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The scale of the display object to which all game objects are added. Set by World.boot.</p>
    </div>
    

        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Point.html">Phaser.Point</a></span>


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L92" title="scale on line 92 of src/core/Camera.js">src/core/Camera.js line 92</a>
    

</dl>


</dd>

        
<dt>
    <h4 id="shakeIntensity" data-name="shakeIntensity">
      <span class="type-signature"></span>shakeIntensity<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The Cameras shake intensity. Gets or sets the cameras shake intensity.</p>
    </div>
    

        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L980" title="shakeIntensity on line 980 of src/core/Camera.js">src/core/Camera.js line 980</a>
    

</dl>


</dd>

        
<dt>
    <h4 id="target" data-name="target">
      <span class="type-signature"></span>target<span class="type-signature"> : <a href="Phaser.Sprite.html">Phaser.Sprite</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>If the camera is tracking a Sprite, this is a reference to it, otherwise null.</p>
    </div>
    

        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Sprite.html">Phaser.Sprite</a></span>


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L82" title="target on line 82 of src/core/Camera.js">src/core/Camera.js line 82</a>
    

</dl>


</dd>

        
<dt>
    <h4 id="totalInView" data-name="totalInView">
      <span class="type-signature">&lt;readonly> </span>totalInView<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>The total number of Sprites with <code>autoCull</code> set to <code>true</code> that are visible by this Camera.</p>
    </div>
    

        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L98" title="totalInView on line 98 of src/core/Camera.js">src/core/Camera.js line 98</a>
    

</dl>


</dd>

        
<dt>
    <h4 id="view" data-name="view">
      <span class="type-signature"></span>view<span class="type-signature"> : <a href="Phaser.Rectangle.html">Phaser.Rectangle</a></span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-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.
Sprites outside of this view are not rendered if Sprite.autoCull is set to <code>true</code>. Otherwise they are always rendered.</p>
    </div>
    

        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Rectangle.html">Phaser.Rectangle</a></span>


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L45" title="view on line 45 of src/core/Camera.js">src/core/Camera.js line 45</a>
    

</dl>


</dd>

        
<dt>
    <h4 id="visible" data-name="visible">
      <span class="type-signature"></span>visible<span class="type-signature"> : boolean</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-description">
        <p>Whether this camera is visible or not.</p>
    </div>
    

        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
	<dd class="tag-default">
		<ul class="dummy">
			<li>true</li>
		</ul>
	</dd>
	

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L65" title="visible on line 65 of src/core/Camera.js">src/core/Camera.js line 65</a>
    

</dl>


</dd>

        
<dt>
    <h4 id="width" data-name="width">
      <span class="type-signature"></span>width<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-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>
    

        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L942" title="width on line 942 of src/core/Camera.js">src/core/Camera.js line 942</a>
    

</dl>


</dd>

        
<dt>
    <h4 id="world" data-name="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 members-description">
        <p>A reference to the game world.</p>
    </div>
    

        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.World.html">Phaser.World</a></span>


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L30" title="world on line 30 of src/core/Camera.js">src/core/Camera.js line 30</a>
    

</dl>


</dd>

        
<dt>
    <h4 id="x" data-name="x">
      <span class="type-signature"></span>x<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-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>
    

        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L867" title="x on line 867 of src/core/Camera.js">src/core/Camera.js line 867</a>
    

</dl>


</dd>

        
<dt>
    <h4 id="y" data-name="y">
      <span class="type-signature"></span>y<span class="type-signature"> : number</span>
      
    </h4>
    
</dt>
<dd>
    
    <div class="description members-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>
    

        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>


            </li>
        </ul>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L891" title="y on line 891 of src/core/Camera.js">src/core/Camera.js line 891</a>
    

</dl>


</dd>

        </dl>
    

        <h3 class="subsection-title">Methods</h3>

        <dl>
            
<dt>
    <h4 class="name" id="checkBounds" data-name="checkBounds">
      <span class="type-signature">&lt;protected> </span>checkBounds()
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-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="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L728" title="checkBounds on line 728 of src/core/Camera.js">src/core/Camera.js line 728</a>
    

</dl>


</dd>

        
<dt>
    <h4 class="name" id="fade" data-name="fade">
      <span class="type-signature"></span>fade( [color] [, duration] [, force] [, alpha])
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>This creates a camera fade out effect. It works by filling the game with the
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 param-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 param-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 param-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>

    
        <tr>
            
                <td class="name"><code>alpha</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    1
                
                </td>
            

            <td class="description param-description last"><p>The alpha value of the color applied to the fade effect.</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L467" title="fade on line 467 of src/core/Camera.js">src/core/Camera.js line 467</a>
    

</dl>


    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>True if the effect was started, otherwise false.</p>
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">boolean</span>


    </dd>
</dl>


</dd>

        
<dt>
    <h4 class="name" id="fadeIn" data-name="fadeIn">
      <span class="type-signature"></span>fadeIn( [color] [, duration] [, force] [, alpha])
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>This creates a camera fade in effect.
It fills the game with a solid color and then removes it over the duration given.</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 param-description last"><p>The color the game will fade from. 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 param-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 param-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>

    
        <tr>
            
                <td class="name"><code>alpha</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    1
                
                </td>
            

            <td class="description param-description last"><p>The alpha value of the color applied to the fade effect.</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L492" title="fadeIn on line 492 of src/core/Camera.js">src/core/Camera.js line 492</a>
    

</dl>


    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>True if the effect was started, otherwise false.</p>
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">boolean</span>


    </dd>
</dl>


</dd>

        
<dt>
    <h4 class="name" id="flash" data-name="flash">
      <span class="type-signature"></span>flash( [color] [, duration] [, force] [, alpha])
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-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 param-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 param-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 param-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>

    
        <tr>
            
                <td class="name"><code>alpha</code></td>
            

            <td class="type">
            
                
<span class="param-type">numer</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    1
                
                </td>
            

            <td class="description param-description last"><p>The alpha value of the color applied to the flash effect.</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L426" title="flash on line 426 of src/core/Camera.js">src/core/Camera.js line 426</a>
    

</dl>


    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>True if the effect was started, otherwise false.</p>
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">boolean</span>


    </dd>
</dl>


</dd>

        
<dt>
    <h4 class="name" id="focusOn" data-name="focusOn">
      <span class="type-signature"></span>focusOn(displayObject)
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-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 param-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 method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L363" title="focusOn on line 363 of src/core/Camera.js">src/core/Camera.js line 363</a>
    

</dl>


</dd>

        
<dt>
    <h4 class="name" id="focusOnXY" data-name="focusOnXY">
      <span class="type-signature"></span>focusOnXY(x, y)
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-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>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
            <td class="description param-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 param-description last"><p>Y position.</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L373" title="focusOnXY on line 373 of src/core/Camera.js">src/core/Camera.js line 373</a>
    

</dl>


</dd>

        
<dt>
    <h4 class="name" id="follow" data-name="follow">
      <span class="type-signature"></span>follow(target [, style] [, lerpX] [, lerpY])
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Tell the camera which sprite to follow.</p>
<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>
<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>
    </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>target</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Phaser.Sprite.html">Phaser.Sprite</a></span>
|

<span class="param-type"><a href="Phaser.Image.html">Phaser.Image</a></span>
|

<span class="param-type"><a href="Phaser.Text.html">Phaser.Text</a></span>


            </td>

            
                <td class="attributes">
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description param-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="default">
                
                </td>
            

            <td class="description param-description last"><p>Leverage one of the existing deadzone presets. If you use a custom deadzone, ignore this parameter and manually specify the deadzone after calling follow().</p></td>
        </tr>

    
        <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 param-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 param-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>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L299" title="follow on line 299 of src/core/Camera.js">src/core/Camera.js line 299</a>
    

</dl>


</dd>

        
<dt>
    <h4 class="name" id="preUpdate" data-name="preUpdate">
      <span class="type-signature"></span>preUpdate()
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Camera preUpdate. Sets the total view counter to zero.</p>
    </div>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L289" title="preUpdate on line 289 of src/core/Camera.js">src/core/Camera.js line 289</a>
    

</dl>


</dd>

        
<dt>
    <h4 class="name" id="reset" data-name="reset">
      <span class="type-signature"></span>reset()
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-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 method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L825" title="reset on line 825 of src/core/Camera.js">src/core/Camera.js line 825</a>
    

</dl>


</dd>

        
<dt>
    <h4 class="name" id="resetFX" data-name="resetFX">
      <span class="type-signature"></span>resetFX()
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <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>
    </div>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L846" title="resetFX on line 846 of src/core/Camera.js">src/core/Camera.js line 846</a>
    

</dl>


</dd>

        
<dt>
    <h4 class="name" id="setBoundsToWorld" data-name="setBoundsToWorld">
      <span class="type-signature"></span>setBoundsToWorld()
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Update the Camera bounds to match the game world.</p>
    </div>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L715" title="setBoundsToWorld on line 715 of src/core/Camera.js">src/core/Camera.js line 715</a>
    

</dl>


</dd>

        
<dt>
    <h4 class="name" id="setPosition" data-name="setPosition">
      <span class="type-signature"></span>setPosition(x, y)
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-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 param-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 param-description last"><p>Y position.</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L793" title="setPosition on line 793 of src/core/Camera.js">src/core/Camera.js line 793</a>
    

</dl>


</dd>

        
<dt>
    <h4 class="name" id="setSize" data-name="setSize">
      <span class="type-signature"></span>setSize(width, height)
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-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 param-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 param-description last"><p>The desired height.</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L812" title="setSize on line 812 of src/core/Camera.js">src/core/Camera.js line 812</a>
    

</dl>


</dd>

        
<dt>
    <h4 class="name" id="shake" data-name="shake">
      <span class="type-signature"></span>shake( [intensity] [, duration] [, force] [, direction] [, shakeBounds])
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <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>
    </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>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 param-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>
            

            <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 param-description last"><p>The duration of the shake 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">
                
                    true
                
                </td>
            

            <td class="description param-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>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    Phaser.Camera.SHAKE_BOTH
                
                </td>
            

            <td class="description param-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 param-description last"><p>Is the effect allowed to shake the camera beyond its bounds (if set?).</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L384" title="shake on line 384 of src/core/Camera.js">src/core/Camera.js line 384</a>
    

</dl>


    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>True if the shake effect was started, otherwise false.</p>
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">boolean</span>


    </dd>
</dl>


</dd>

        
<dt>
    <h4 class="name" id="unfollow" data-name="unfollow">
      <span class="type-signature"></span>unfollow()
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>Sets the Camera follow target to null, stopping it from following an object if it's doing so.</p>
    </div>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L353" title="unfollow on line 353 of src/core/Camera.js">src/core/Camera.js line 353</a>
    

</dl>


</dd>

        
<dt>
    <h4 class="name" id="update" data-name="update">
      <span class="type-signature">&lt;protected> </span>update()
      
    </h4>
    
</dt>
<dd>

    
    <div class="description method-description">
        <p>The camera update loop. This is called automatically by the core game loop.</p>
    </div>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
    
      <a href="https://github.com/photonstorm/phaser-ce/blob/v2.20.2/src/core/Camera.js#L550" title="update on line 550 of src/core/Camera.js">src/core/Camera.js line 550</a>
    

</dl>


</dd>

        </dl>
    

</article>

</section>


</div>
	    <footer class="footer">


<p class="package-signature">
  phaser-ce@2.20.2
  is on
  <a href="https://github.com/photonstorm/phaser-ce/releases/tag/v2.20.2">GitHub</a>
  and
  <a href="https://www.npmjs.com/package/phaser-ce">NPM</a>
</p>


	<p class="copyright">
	Phaser Copyright © 2012-2016 Photon Storm Ltd.
	</p>


<p class="jsdoc-message">
	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
	
		on 2025-02-20
	
	using <a href="https://github.com/photonstorm/phaser-ce/tree/master/resources/docstrap-master">Tomorrow</a>.
</p>

</footer>

		</div>
    
      <div class="toc-container hidden-xs hidden-sm">
  <div class="toc-filter">
    <div class="form-inline">
    <div class="form-group">
      <label for="filter" class="control-label">Filter</label>
      <input type="text" class="form-control" id="toc-filter-input">
    </div>
  </div>
  </div>
  <div id="toc">
    <div class="list-group">
      <div id="toc-insert"></div>
    </div>
  </div>
</div>

    
	</div>
</div>

<script defer src="scripts/bundle.js?2025022010"></script>


</body>
</html>