Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-12-20 01:55:45 +00:00
Code Issues Projects Releases Packages Wiki Activity
phaser/docs/Image.js.html

1304 lines
36 KiB
HTML
Raw Normal View History

Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Phaser Source: gameobjects/Image.js</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.cerulean.css">
</head>
<body>
<div class="container-fluid">
<div class="navbar navbar-fixed-top navbar-inverse">
<div class="navbar-inner">
<a class="brand" href="index.html">Phaser</a>
<ul class="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 ">
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-0">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.html">Phaser</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b
class="caret"></b></a>
<ul class="dropdown-menu ">
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Animation.html">Animation</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.AnimationManager.html">AnimationManager</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.AnimationParser.html">AnimationParser</a>
</li>
Docs update.
2014-04-29 14:39:02 +00:00
<li class="class-depth-1">
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.BitmapText.html">BitmapText</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Button.html">Button</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Cache.html">Cache</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Camera.html">Camera</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Canvas.html">Canvas</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Circle.html">Circle</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Color.html">Color</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Device.html">Device</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Easing.html">Easing</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Easing.Back.html">Back</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Easing.Bounce.html">Bounce</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Easing.Circular.html">Circular</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Easing.Cubic.html">Cubic</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Easing.Elastic.html">Elastic</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Easing.Exponential.html">Exponential</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Easing.Linear.html">Linear</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Easing.Quadratic.html">Quadratic</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Easing.Quartic.html">Quartic</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Easing.Quintic.html">Quintic</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Easing.Sinusoidal.html">Sinusoidal</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
<a href="Phaser.Ellipse.html">Ellipse</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Events.html">Events</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Filter.html">Filter</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Frame.html">Frame</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.FrameData.html">FrameData</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Game.html">Game</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated docs - they now actually list the new body methods :)
2014-02-21 15:37:26 +00:00
<a href="Phaser.GameObjectCreator.html">GameObjectCreator</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.GameObjectFactory.html">GameObjectFactory</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Gamepad.html">Gamepad</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.GamepadButton.html">GamepadButton</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Graphics.html">Graphics</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Group.html">Group</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Image.html">Image</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Input.html">Input</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.InputHandler.html">InputHandler</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Key.html">Key</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Keyboard.html">Keyboard</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Line.html">Line</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.LinkedList.html">LinkedList</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Loader.html">Loader</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.LoaderParser.html">LoaderParser</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Math.html">Math</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Mouse.html">Mouse</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.MSPointer.html">MSPointer</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Net.html">Net</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
<a href="Phaser.Particle.html">Particle</a>
</li>
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Particles.html">Particles</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Physics.html">Physics</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Physics.Arcade.html">Arcade</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.Arcade.Body.html">Body</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.Ninja.html">Ninja</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.Ninja.AABB.html">AABB</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.Ninja.Body.html">Body</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.Ninja.Circle.html">Circle</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.Ninja.Tile.html">Tile</a>
Updated docs - they now actually list the new body methods :)
2014-02-21 15:37:26 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.html">P2</a>
Updated docs - they now actually list the new body methods :)
2014-02-21 15:37:26 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.Body.html">Body</a>
Updated docs - they now actually list the new body methods :)
2014-02-21 15:37:26 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.BodyDebug.html">BodyDebug</a>
Updated docs - they now actually list the new body methods :)
2014-02-21 15:37:26 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a>
Updated docs - they now actually list the new body methods :)
2014-02-21 15:37:26 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a>
Updated docs - they now actually list the new body methods :)
2014-02-21 15:37:26 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.DistanceConstraint.html">DistanceConstraint</a>
Updated docs - they now actually list the new body methods :)
2014-02-21 15:37:26 +00:00
</li>
Preparing for final 2.0.3 release. Updated docs, readme and build files.
2014-04-11 12:09:28 +00:00
<li class="class-depth-3">
<a href="Phaser.Physics.P2.FixtureList.html">FixtureList</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.GearConstraint.html">GearConstraint</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.InversePointProxy.html">InversePointProxy</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.LockConstraint.html">LockConstraint</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.Material.html">Material</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.PointProxy.html">PointProxy</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.PrismaticConstraint.html">PrismaticConstraint</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.RevoluteConstraint.html">RevoluteConstraint</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-3">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.Physics.P2.Spring.html">Spring</a>
Updated docs - they now actually list the new body methods :)
2014-02-21 15:37:26 +00:00
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Plugin.html">Plugin</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.PluginManager.html">PluginManager</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Point.html">Point</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Pointer.html">Pointer</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Polygon.html">Polygon</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.QuadTree.html">QuadTree</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.RandomDataGenerator.html">RandomDataGenerator</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Rectangle.html">Rectangle</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.RenderTexture.html">RenderTexture</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.RequestAnimationFrame.html">RequestAnimationFrame</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.RetroFont.html">RetroFont</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
<a href="Phaser.ScaleManager.html">ScaleManager</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Signal.html">Signal</a>
</li>
Preparing for final 2.0.3 release. Updated docs, readme and build files.
2014-04-11 12:09:28 +00:00
<li class="class-depth-1">
<a href="Phaser.SignalBinding.html">SignalBinding</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.SinglePad.html">SinglePad</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Sound.html">Sound</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.SoundManager.html">SoundManager</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Sprite.html">Sprite</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
<a href="Phaser.SpriteBatch.html">SpriteBatch</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Stage.html">Stage</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.State.html">State</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.StateManager.html">StateManager</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Text.html">Text</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Tile.html">Tile</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Tilemap.html">Tilemap</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.TilemapLayer.html">TilemapLayer</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.TilemapParser.html">TilemapParser</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Tileset.html">Tileset</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.TileSprite.html">TileSprite</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Time.html">Time</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Timer.html">Timer</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.TimerEvent.html">TimerEvent</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Touch.html">Touch</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Tween.html">Tween</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.TweenManager.html">TweenManager</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Utils.html">Utils</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-2">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.Utils.Debug.html">Debug</a>
</li>
re-generated documentation
2014-04-10 22:13:43 +00:00
<li class="class-depth-1">
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<a href="Phaser.World.html">World</a>
</li>
</ul>
</li>
Docs rebuilt for 2.0.5
2014-05-20 09:12:48 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</ul>
</div>
</div>
<div class="row-fluid">
<div class="span12">
<div id="main">
<h1 class="page-title">Source: gameobjects/Image.js</h1>
<section>
<article>
<pre class="sunlight-highlight-javascript linenums">/**
* @author Richard Davey &lt;rich@photonstorm.com>
* @copyright 2014 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
/**
* @class Phaser.Image
*
* @classdesc Create a new `Image` object. An Image is a light-weight object you can use to display anything that doesn't need physics or animation.
* It can still rotate, scale, crop and receive input events. This makes it perfect for logos, backgrounds, simple buttons and other non-Sprite graphics.
*
* @constructor
* @param {Phaser.Game} game - A reference to the currently running game.
Docs rebuilt for 2.0.5
2014-05-20 09:12:48 +00:00
* @param {number} x - The x coordinate of the Image. The coordinate is relative to any parent container this Image may be in.
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* @param {number} y - The y coordinate of the Image. The coordinate is relative to any parent container this Image may be in.
* @param {string|Phaser.RenderTexture|Phaser.BitmapData|PIXI.Texture} key - The texture used by the Image during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture, BitmapData or PIXI.Texture.
* @param {string|number} frame - If this Image is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.
*/
Phaser.Image = function (game, x, y, key, frame) {
x = x || 0;
y = y || 0;
key = key || null;
frame = frame || null;
Sprite would glitch if it had an ArcadePhysics Body that was re-positioned out of loop. Sprite would "fly off" if it had an ArcadePhysics Body that was re-positioned during an input handler. Newly generated docs
2014-03-28 01:42:49 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
/**
* @property {Phaser.Game} game - A reference to the currently running Game.
*/
this.game = game;
Sprite would glitch if it had an ArcadePhysics Body that was re-positioned out of loop. Sprite would "fly off" if it had an ArcadePhysics Body that was re-positioned during an input handler. Newly generated docs
2014-03-28 01:42:49 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
/**
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
* @property {boolean} exists - If exists = false then the Image isn't updated by the core game loop.
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* @default
*/
this.exists = true;
/**
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
* @property {string} name - The user defined name given to this Image.
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* @default
*/
this.name = '';
/**
* @property {number} type - The const type of this object.
* @readonly
*/
this.type = Phaser.IMAGE;
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
/**
* @property {number} z - The z-depth value of this object within its Group (remember the World is a Group as well). No two objects in a Group can have the same z value.
*/
this.z = 0;
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
/**
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
* @property {Phaser.Events} events - The Events you can subscribe to that are dispatched when certain things happen on this Image or its components.
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
*/
this.events = new Phaser.Events(this);
/**
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
* @property {string|Phaser.RenderTexture|Phaser.BitmapData|PIXI.Texture} key - This is the image or texture used by the Image during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture, BitmapData or PIXI.Texture.
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
*/
this.key = key;
PIXI.Sprite.call(this, PIXI.TextureCache['__default']);
this.position.set(x, y);
/**
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
* @property {Phaser.Point} world - The world coordinates of this Image. This differs from the x/y coordinates which are relative to the Images container.
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
*/
this.world = new Phaser.Point(x, y);
/**
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
* Should this Image be automatically culled if out of range of the camera?
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* A culled sprite has its renderable property set to 'false'.
* Be advised this is quite an expensive operation, as it has to calculate the bounds of the object every frame, so only enable it if you really need it.
*
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
* @property {boolean} autoCull - A flag indicating if the Image should be automatically camera culled or not.
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* @default
*/
this.autoCull = false;
/**
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
* @property {Phaser.InputHandler|null} input - The Input Handler for this object. Needs to be enabled with image.inputEnabled = true before you can use it.
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
*/
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
this.input = null;
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
/**
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
* @property {Phaser.Point} cameraOffset - If this object is fixedToCamera then this stores the x/y offset that its drawn at, from the top-left of the camera view.
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
*/
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
this.cameraOffset = new Phaser.Point();
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
Republished docs.
2014-07-10 19:31:11 +00:00
/**
* @property {Phaser.Rectangle} cropRect - The Rectangle used to crop the texture. Set this via Sprite.crop. Any time you modify this property directly you must call Sprite.updateCrop.
* @default
*/
this.cropRect = null;
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
/**
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
* A small internal cache:
Republished docs.
2014-07-10 19:31:11 +00:00
*
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
* 0 = previous position.x
* 1 = previous position.y
* 2 = previous rotation
* 3 = renderID
* 4 = fresh? (0 = no, 1 = yes)
* 5 = outOfBoundsFired (0 = no, 1 = yes)
* 6 = exists (0 = no, 1 = yes)
* 7 = fixed to camera (0 = no, 1 = yes)
Docs update.
2014-04-29 14:39:02 +00:00
* 8 = destroy phase? (0 = no, 1 = yes)
Republished docs.
2014-07-10 19:31:11 +00:00
* 9 = frame index
Updated docs to 2.0.1.
2014-03-24 12:41:45 +00:00
* @property {Array} _cache
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* @private
*/
Docs update.
2014-04-29 14:39:02 +00:00
this._cache = [ 0, 0, 0, 0, 1, 0, 1, 0, 0 ];
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
Republished docs.
2014-07-10 19:31:11 +00:00
/**
* @property {Phaser.Rectangle} _crop - Internal cache var.
* @private
*/
this._crop = null;
/**
* @property {Phaser.Rectangle} _frame - Internal cache var.
* @private
*/
this._frame = null;
/**
* @property {Phaser.Rectangle} _bounds - Internal cache var.
* @private
*/
this._bounds = new Phaser.Rectangle();
/**
* @property {string} _frameName - Internal cache var.
* @private
*/
this._frameName = '';
this.loadTexture(key, frame);
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
};
Phaser.Image.prototype = Object.create(PIXI.Sprite.prototype);
Phaser.Image.prototype.constructor = Phaser.Image;
/**
* Automatically called by World.preUpdate.
*
* @method Phaser.Image#preUpdate
* @memberof Phaser.Image
*/
Phaser.Image.prototype.preUpdate = function() {
this._cache[0] = this.world.x;
this._cache[1] = this.world.y;
this._cache[2] = this.rotation;
if (!this.exists || !this.parent.exists)
{
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
this._cache[3] = -1;
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
return false;
}
if (this.autoCull)
{
// Won't get rendered but will still get its transform updated
this.renderable = this.game.world.camera.screenView.intersects(this.getBounds());
}
this.world.setTo(this.game.camera.x + this.worldTransform[2], this.game.camera.y + this.worldTransform[5]);
if (this.visible)
{
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
this._cache[3] = this.game.stage.currentRenderOrderID++;
}
// Update any Children
for (var i = 0, len = this.children.length; i &lt; len; i++)
{
this.children[i].preUpdate();
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
}
return true;
Sprite would glitch if it had an ArcadePhysics Body that was re-positioned out of loop. Sprite would "fly off" if it had an ArcadePhysics Body that was re-positioned during an input handler. Newly generated docs
2014-03-28 01:42:49 +00:00
};
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
/**
* Override and use this function in your own custom objects to handle any update requirements you may have.
*
* @method Phaser.Image#update
* @memberof Phaser.Image
*/
Phaser.Image.prototype.update = function() {
Sprite would glitch if it had an ArcadePhysics Body that was re-positioned out of loop. Sprite would "fly off" if it had an ArcadePhysics Body that was re-positioned during an input handler. Newly generated docs
2014-03-28 01:42:49 +00:00
};
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
/**
* Internal function called by the World postUpdate cycle.
*
* @method Phaser.Image#postUpdate
* @memberof Phaser.Image
*/
Phaser.Image.prototype.postUpdate = function() {
Updated docs to 2.0.1.
2014-03-24 12:41:45 +00:00
if (this.key instanceof Phaser.BitmapData)
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
{
this.key.render();
}
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
// Fixed to Camera?
if (this._cache[7] === 1)
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
{
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
this.position.x = (this.game.camera.view.x + this.cameraOffset.x) / this.game.camera.scale.x;
this.position.y = (this.game.camera.view.y + this.cameraOffset.y) / this.game.camera.scale.y;
}
// Update any Children
for (var i = 0, len = this.children.length; i &lt; len; i++)
{
this.children[i].postUpdate();
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
}
Sprite would glitch if it had an ArcadePhysics Body that was re-positioned out of loop. Sprite would "fly off" if it had an ArcadePhysics Body that was re-positioned during an input handler. Newly generated docs
2014-03-28 01:42:49 +00:00
};
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
/**
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
* Changes the Texture the Image is using entirely. The old texture is removed and the new one is referenced or fetched from the Cache.
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* This causes a WebGL texture update, so use sparingly or in low-intensity portions of your game.
*
* @method Phaser.Image#loadTexture
* @memberof Phaser.Image
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
* @param {string|Phaser.RenderTexture|Phaser.BitmapData|PIXI.Texture} key - This is the image or texture used by the Image during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture, BitmapData or PIXI.Texture.
* @param {string|number} frame - If this Image is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
*/
Phaser.Image.prototype.loadTexture = function (key, frame) {
frame = frame || 0;
Republished docs.
2014-07-10 19:31:11 +00:00
this.key = key;
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
if (key instanceof Phaser.RenderTexture)
{
this.key = key.key;
this.setTexture(key);
}
else if (key instanceof Phaser.BitmapData)
{
this.setTexture(key.texture);
}
else if (key instanceof PIXI.Texture)
{
this.setTexture(key);
}
else
{
if (key === null || typeof key === 'undefined')
{
this.key = '__default';
this.setTexture(PIXI.TextureCache[this.key]);
}
Preparing for final 2.0.3 release. Updated docs, readme and build files.
2014-04-11 12:09:28 +00:00
else if (typeof key === 'string' && !this.game.cache.checkImageKey(key))
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
{
this.key = '__missing';
this.setTexture(PIXI.TextureCache[this.key]);
}
Republished docs.
2014-07-10 19:31:11 +00:00
else
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
{
Republished docs.
2014-07-10 19:31:11 +00:00
if (this.game.cache.isSpriteSheet(key))
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
{
Republished docs.
2014-07-10 19:31:11 +00:00
var frameData = this.game.cache.getFrameData(key);
if (typeof frame === 'string')
{
this.setTexture(new PIXI.Texture(PIXI.BaseTextureCache[key], frameData.getFrameByName(frame)));
}
else
{
this.setTexture(new PIXI.Texture(PIXI.BaseTextureCache[key], frameData.getFrame(frame)));
}
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
}
else
{
Republished docs.
2014-07-10 19:31:11 +00:00
this.setTexture(new PIXI.Texture(PIXI.BaseTextureCache[key]));
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
}
}
}
Republished docs.
2014-07-10 19:31:11 +00:00
this._frame = Phaser.Rectangle.clone(this.texture.frame);
Sprite would glitch if it had an ArcadePhysics Body that was re-positioned out of loop. Sprite would "fly off" if it had an ArcadePhysics Body that was re-positioned during an input handler. Newly generated docs
2014-03-28 01:42:49 +00:00
};
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
/**
Republished docs.
2014-07-10 19:31:11 +00:00
* Resets the Texture frame dimensions that the Image uses for rendering.
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
*
Republished docs.
2014-07-10 19:31:11 +00:00
* @method Phaser.Image#resetFrame
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* @memberof Phaser.Image
*/
Republished docs.
2014-07-10 19:31:11 +00:00
Phaser.Image.prototype.resetFrame = Phaser.Sprite.prototype.resetFrame;
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
Republished docs.
2014-07-10 19:31:11 +00:00
/**
* Sets the Texture frame the Image uses for rendering.
* This is primarily an internal method used by Image.loadTexture, although you may call it directly.
*
* @method Phaser.Image#setFrame
* @memberof Phaser.Image
* @param {Phaser.Frame} frame - The Frame to be used by the Image texture.
*/
Phaser.Image.prototype.setFrame = Phaser.Sprite.prototype.setFrame;
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
Republished docs.
2014-07-10 19:31:11 +00:00
/**
* If you have set a crop rectangle on this Image via Image.crop and since modified the Image.cropRect property (or the rectangle it references)
* then you need to update the crop frame by calling this method.
*
* @method Phaser.Image#updateCrop
* @memberof Phaser.Image
*/
Phaser.Image.prototype.updateCrop = Phaser.Sprite.prototype.updateCrop;
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
Republished docs.
2014-07-10 19:31:11 +00:00
/**
* Crop allows you to crop the texture used to display this Image.
* This modifies the core Image texture frame, so the Image width/height properties will adjust accordingly.
*
* Cropping takes place from the top-left of the Image and can be modified in real-time by either providing an updated rectangle object to Image.crop,
* or by modifying Image.cropRect (or a reference to it) and then calling Image.updateCrop.
*
* The rectangle object given to this method can be either a Phaser.Rectangle or any object so long as it has public x, y, width and height properties.
* A reference to the rectangle is stored in Image.cropRect unless the `copy` parameter is `true` in which case the values are duplicated to a local object.
*
* @method Phaser.Image#crop
* @memberof Phaser.Image
* @param {Phaser.Rectangle} rect - The Rectangle used during cropping. Pass null or no parameters to clear a previously set crop rectangle.
* @param {boolean} [copy=false] - If false Image.cropRect will be a reference to the given rect. If true it will copy the rect values into a local Image.cropRect object.
*/
Phaser.Image.prototype.crop = Phaser.Sprite.prototype.crop;
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
/**
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
* Brings a 'dead' Image back to life, optionally giving it the health value specified.
* A resurrected Image has its alive, exists and visible properties all set to true.
* It will dispatch the onRevived event, you can listen to Image.events.onRevived for the signal.
Sprite would glitch if it had an ArcadePhysics Body that was re-positioned out of loop. Sprite would "fly off" if it had an ArcadePhysics Body that was re-positioned during an input handler. Newly generated docs
2014-03-28 01:42:49 +00:00
*
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* @method Phaser.Image#revive
* @memberof Phaser.Image
* @return {Phaser.Image} This instance.
*/
Phaser.Image.prototype.revive = function() {
this.alive = true;
this.exists = true;
this.visible = true;
if (this.events)
{
this.events.onRevived.dispatch(this);
}
return this;
Sprite would glitch if it had an ArcadePhysics Body that was re-positioned out of loop. Sprite would "fly off" if it had an ArcadePhysics Body that was re-positioned during an input handler. Newly generated docs
2014-03-28 01:42:49 +00:00
};
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
/**
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
* Kills a Image. A killed Image has its alive, exists and visible properties all set to false.
* It will dispatch the onKilled event, you can listen to Image.events.onKilled for the signal.
* Note that killing a Image is a way for you to quickly recycle it in a Image pool, it doesn't free it up from memory.
* If you don't need this Image any more you should call Image.destroy instead.
Sprite would glitch if it had an ArcadePhysics Body that was re-positioned out of loop. Sprite would "fly off" if it had an ArcadePhysics Body that was re-positioned during an input handler. Newly generated docs
2014-03-28 01:42:49 +00:00
*
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* @method Phaser.Image#kill
* @memberof Phaser.Image
* @return {Phaser.Image} This instance.
*/
Republished docs.
2014-07-10 19:31:11 +00:00
Phaser.Image.prototype.kill = Phaser.Sprite.prototype.kill;
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
/**
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
* Destroys the Image. This removes it from its parent group, destroys the input, event and animation handlers if present
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* and nulls its reference to game, freeing it up for garbage collection.
Sprite would glitch if it had an ArcadePhysics Body that was re-positioned out of loop. Sprite would "fly off" if it had an ArcadePhysics Body that was re-positioned during an input handler. Newly generated docs
2014-03-28 01:42:49 +00:00
*
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* @method Phaser.Image#destroy
* @memberof Phaser.Image
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
* @param {boolean} [destroyChildren=true] - Should every child of this object have its destroy method called?
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
*/
Republished docs.
2014-07-10 19:31:11 +00:00
Phaser.Image.prototype.destroy = Phaser.Sprite.prototype.destroy;
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
/**
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
* Resets the Image. This places the Image at the given x/y world coordinates and then sets alive, exists, visible and renderable all to true.
Sprite would glitch if it had an ArcadePhysics Body that was re-positioned out of loop. Sprite would "fly off" if it had an ArcadePhysics Body that was re-positioned during an input handler. Newly generated docs
2014-03-28 01:42:49 +00:00
*
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* @method Phaser.Image#reset
* @memberof Phaser.Image
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
* @param {number} x - The x coordinate (in world space) to position the Image at.
* @param {number} y - The y coordinate (in world space) to position the Image at.
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* @return {Phaser.Image} This instance.
*/
Phaser.Image.prototype.reset = function(x, y) {
this.world.setTo(x, y);
this.position.x = x;
this.position.y = y;
this.alive = true;
this.exists = true;
this.visible = true;
this.renderable = true;
return this;
Sprite would glitch if it had an ArcadePhysics Body that was re-positioned out of loop. Sprite would "fly off" if it had an ArcadePhysics Body that was re-positioned during an input handler. Newly generated docs
2014-03-28 01:42:49 +00:00
};
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
/**
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
* Brings the Image to the top of the display list it is a child of. Images that are members of a Phaser.Group are only
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* bought to the top of that Group, not the entire display list.
Sprite would glitch if it had an ArcadePhysics Body that was re-positioned out of loop. Sprite would "fly off" if it had an ArcadePhysics Body that was re-positioned during an input handler. Newly generated docs
2014-03-28 01:42:49 +00:00
*
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* @method Phaser.Image#bringToTop
* @memberof Phaser.Image
* @return {Phaser.Image} This instance.
*/
Republished docs.
2014-07-10 19:31:11 +00:00
Phaser.Image.prototype.bringToTop = Phaser.Sprite.prototype.bringToTop;
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
/**
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
* Indicates the rotation of the Image, in degrees, from its original orientation. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation.
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* Values outside this range are added to or subtracted from 360 to obtain a value within the range. For example, the statement player.angle = 450 is the same as player.angle = 90.
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
* If you wish to work in radians instead of degrees use the property Image.rotation instead. Working in radians is also a little faster as it doesn't have to convert the angle.
Sprite would glitch if it had an ArcadePhysics Body that was re-positioned out of loop. Sprite would "fly off" if it had an ArcadePhysics Body that was re-positioned during an input handler. Newly generated docs
2014-03-28 01:42:49 +00:00
*
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
* @name Phaser.Image#angle
* @property {number} angle - The angle of this Image in degrees.
*/
Object.defineProperty(Phaser.Image.prototype, "angle", {
get: function() {
return Phaser.Math.wrapAngle(Phaser.Math.radToDeg(this.rotation));
},
set: function(value) {
this.rotation = Phaser.Math.degToRad(Phaser.Math.wrapAngle(value));
}
});
/**
* Returns the delta x value. The difference between world.x now and in the previous step.
*
* @name Phaser.Image#deltaX
* @property {number} deltaX - The delta value. Positive if the motion was to the right, negative if to the left.
* @readonly
*/
Object.defineProperty(Phaser.Image.prototype, "deltaX", {
get: function() {
return this.world.x - this._cache[0];
}
});
/**
* Returns the delta y value. The difference between world.y now and in the previous step.
*
* @name Phaser.Image#deltaY
* @property {number} deltaY - The delta value. Positive if the motion was downwards, negative if upwards.
* @readonly
*/
Object.defineProperty(Phaser.Image.prototype, "deltaY", {
get: function() {
Sprite would glitch if it had an ArcadePhysics Body that was re-positioned out of loop. Sprite would "fly off" if it had an ArcadePhysics Body that was re-positioned during an input handler. Newly generated docs
2014-03-28 01:42:49 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
return this.world.y - this._cache[1];
}
});
/**
* Returns the delta z value. The difference between rotation now and in the previous step.
*
* @name Phaser.Image#deltaZ
* @property {number} deltaZ - The delta value.
* @readonly
*/
Object.defineProperty(Phaser.Image.prototype, "deltaZ", {
get: function() {
Sprite would glitch if it had an ArcadePhysics Body that was re-positioned out of loop. Sprite would "fly off" if it had an ArcadePhysics Body that was re-positioned during an input handler. Newly generated docs
2014-03-28 01:42:49 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
return this.rotation - this._cache[2];
}
});
/**
* Checks if the Image bounds are within the game world, otherwise false if fully outside of it.
*
* @name Phaser.Image#inWorld
* @property {boolean} inWorld - True if the Image bounds is within the game world, even if only partially. Otherwise false if fully outside of it.
* @readonly
*/
Object.defineProperty(Phaser.Image.prototype, "inWorld", {
get: function() {
return this.game.world.bounds.intersects(this.getBounds());
}
});
/**
* Checks if the Image bounds are within the game camera, otherwise false if fully outside of it.
*
* @name Phaser.Image#inCamera
* @property {boolean} inCamera - True if the Image bounds is within the game camera, even if only partially. Otherwise false if fully outside of it.
* @readonly
*/
Object.defineProperty(Phaser.Image.prototype, "inCamera", {
get: function() {
Sprite would glitch if it had an ArcadePhysics Body that was re-positioned out of loop. Sprite would "fly off" if it had an ArcadePhysics Body that was re-positioned during an input handler. Newly generated docs
2014-03-28 01:42:49 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
return this.game.world.camera.screenView.intersects(this.getBounds());
}
});
/**
* @name Phaser.Image#frame
* @property {number} frame - Gets or sets the current frame index and updates the Texture for display.
*/
Object.defineProperty(Phaser.Image.prototype, "frame", {
get: function() {
Sprite would glitch if it had an ArcadePhysics Body that was re-positioned out of loop. Sprite would "fly off" if it had an ArcadePhysics Body that was re-positioned during an input handler. Newly generated docs
2014-03-28 01:42:49 +00:00
Republished docs.
2014-07-10 19:31:11 +00:00
return this._cache[9];
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
},
set: function(value) {
Preparing for final 2.0.3 release. Updated docs, readme and build files.
2014-04-11 12:09:28 +00:00
if (value !== this.frame && this.game.cache.isSpriteSheet(this.key))
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
{
var frameData = this.game.cache.getFrameData(this.key);
Preparing for final 2.0.3 release. Updated docs, readme and build files.
2014-04-11 12:09:28 +00:00
if (frameData && value &lt; frameData.total && frameData.getFrame(value))
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
{
Republished docs.
2014-07-10 19:31:11 +00:00
this._cache[9] = value;
this.setFrame(frameData.getFrame(value));
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
}
}
}
});
/**
* @name Phaser.Image#frameName
* @property {string} frameName - Gets or sets the current frame by name and updates the Texture for display.
*/
Object.defineProperty(Phaser.Image.prototype, "frameName", {
get: function() {
Sprite would glitch if it had an ArcadePhysics Body that was re-positioned out of loop. Sprite would "fly off" if it had an ArcadePhysics Body that was re-positioned during an input handler. Newly generated docs
2014-03-28 01:42:49 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
return this._frameName;
},
set: function(value) {
Preparing for final 2.0.3 release. Updated docs, readme and build files.
2014-04-11 12:09:28 +00:00
if (value !== this.frameName && this.game.cache.isSpriteSheet(this.key))
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
{
var frameData = this.game.cache.getFrameData(this.key);
Preparing for final 2.0.3 release. Updated docs, readme and build files.
2014-04-11 12:09:28 +00:00
if (frameData && frameData.getFrameByName(value))
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
{
this._frameName = value;
Republished docs.
2014-07-10 19:31:11 +00:00
this.setFrame(frameData.getFrameByName(value));
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
}
}
}
});
/**
* @name Phaser.Image#renderOrderID
* @property {number} renderOrderID - The render order ID, reset every frame.
* @readonly
*/
Object.defineProperty(Phaser.Image.prototype, "renderOrderID", {
get: function() {
return this._cache[3];
}
});
/**
* By default an Image won't process any input events at all. By setting inputEnabled to true the Phaser.InputHandler is
* activated for this object and it will then start to process click/touch events and more.
*
* @name Phaser.Image#inputEnabled
* @property {boolean} inputEnabled - Set to true to allow this object to receive input events.
*/
Object.defineProperty(Phaser.Image.prototype, "inputEnabled", {
Sprite would glitch if it had an ArcadePhysics Body that was re-positioned out of loop. Sprite would "fly off" if it had an ArcadePhysics Body that was re-positioned during an input handler. Newly generated docs
2014-03-28 01:42:49 +00:00
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
get: function () {
Preparing for final 2.0.3 release. Updated docs, readme and build files.
2014-04-11 12:09:28 +00:00
return (this.input && this.input.enabled);
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
},
set: function (value) {
if (value)
{
if (this.input === null)
{
this.input = new Phaser.InputHandler(this);
this.input.start();
}
Preparing for final 2.0.3 release. Updated docs, readme and build files.
2014-04-11 12:09:28 +00:00
else if (this.input && !this.input.enabled)
re-generated documentation
2014-04-10 22:13:43 +00:00
{
this.input.start();
}
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
}
else
{
Preparing for final 2.0.3 release. Updated docs, readme and build files.
2014-04-11 12:09:28 +00:00
if (this.input && this.input.enabled)
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
{
this.input.stop();
}
}
}
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
});
/**
* An Image that is fixed to the camera uses its x/y coordinates as offsets from the top left of the camera. These are stored in Image.cameraOffset.
* Note that the cameraOffset values are in addition to any parent in the display list.
* So if this Image was in a Group that has x: 200, then this will be added to the cameraOffset.x
*
* @name Phaser.Image#fixedToCamera
* @property {boolean} fixedToCamera - Set to true to fix this Image to the Camera at its current world coordinates.
*/
Object.defineProperty(Phaser.Image.prototype, "fixedToCamera", {
Sprite would glitch if it had an ArcadePhysics Body that was re-positioned out of loop. Sprite would "fly off" if it had an ArcadePhysics Body that was re-positioned during an input handler. Newly generated docs
2014-03-28 01:42:49 +00:00
Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world. After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required. Debug.renderPhysicsBody updated to take camera location and body rotation into account. Body movement functions put back to velocity :) Updated to latest dev version of pixi and latest p2.js Updated docs
2014-02-18 03:01:51 +00:00
get: function () {
return !!this._cache[7];
},
set: function (value) {
if (value)
{
this._cache[7] = 1;
this.cameraOffset.set(this.x, this.y);
}
else
{
this._cache[7] = 0;
}
}
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
});
/**
* Enable or disable texture smoothing for this Image. Only works for bitmap/image textures. Smoothing is enabled by default.
*
* @name Phaser.Image#smoothed
* @property {boolean} smoothed - Set to true to smooth the texture of this Image, or false to disable smoothing (great for pixel art)
*/
Object.defineProperty(Phaser.Image.prototype, "smoothed", {
Sprite would glitch if it had an ArcadePhysics Body that was re-positioned out of loop. Sprite would "fly off" if it had an ArcadePhysics Body that was re-positioned during an input handler. Newly generated docs
2014-03-28 01:42:49 +00:00
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
get: function () {
return !this.texture.baseTexture.scaleMode;
},
set: function (value) {
if (value)
{
if (this.texture)
{
this.texture.baseTexture.scaleMode = 0;
}
}
else
{
if (this.texture)
{
this.texture.baseTexture.scaleMode = 1;
}
}
}
Docs update.
2014-04-29 14:39:02 +00:00
});
/**
* @name Phaser.Image#destroyPhase
* @property {boolean} destroyPhase - True if this object is currently being destroyed.
*/
Object.defineProperty(Phaser.Image.prototype, "destroyPhase", {
get: function () {
return !!this._cache[8];
}
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
});
</pre>
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
Phaser Copyright © 2012-2014 Photon Storm Ltd.
</span>
<br />
<span class="jsdoc-message">
Preparing for final 2.0.3 release. Updated docs, readme and build files.
2014-04-11 12:09:28 +00:00
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
Republished docs.
2014-07-10 19:31:11 +00:00
on Thu Jul 10 2014 20:18:55 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
</span>
</footer>
</div>
<br clear="both">
</div>
</div>
<script src="scripts/sunlight.js"></script>
<script src="scripts/sunlight.javascript.js"></script>
<script src="scripts/sunlight-plugin.doclinks.js"></script>
<script src="scripts/sunlight-plugin.linenumbers.js"></script>
<script src="scripts/sunlight-plugin.menu.js"></script>
<script src="scripts/jquery.min.js"></script>
<script src="scripts/jquery.scrollTo.js"></script>
<script src="scripts/jquery.localScroll.js"></script>
<script src="scripts/bootstrap-dropdown.js"></script>
<script src="scripts/toc.js"></script>
<script> Sunlight.highlightAll({lineNumbers:true, showMenu: true, enableDoclinks :true}); </script>
<script>
$( function () {
$( "#toc" ).toc( {
re-generated documentation
2014-04-10 22:13:43 +00:00
anchorName : function(i, heading, prefix) {
Updated docs for 2.0 release and updated README.
2014-03-14 06:36:05 +00:00
return $(heading).attr("id") || ( prefix + i );
},
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
selectors : "h1,h2,h3,h4",
showAndHide : false,
scrollTo : 60
} );
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
} );
</script>
</body>
</html>
Reference in a new issue Copy permalink