<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Phaser Class: RetroFont</title> <!--[if lt IE 9]> <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> <![endif]--> <link type="text/css" rel="stylesheet" href="styles/default.css"> <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 style="position: absolute; width: 143px; height: 31px; right: 10px; top: 10px; z-index: 1050"><a href="http://phaser.io"><img src="img/phaser.png" border="0" /></a></div> <div class="navbar-inner"> <a class="brand" href="index.html">Phaser API</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 "> <li class="class-depth-0"> <a href="Phaser.html">Phaser</a> </li> <li class="class-depth-0"> <a href="Phaser.KeyCode.html">KeyCode</a> </li> <li class="class-depth-0"> <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 class="class-depth-1"> <a href="Phaser.Animation.html">Animation</a> </li> <li class="class-depth-1"> <a href="Phaser.AnimationManager.html">AnimationManager</a> </li> <li class="class-depth-1"> <a href="Phaser.AnimationParser.html">AnimationParser</a> </li> <li class="class-depth-1"> <a href="Phaser.ArraySet.html">ArraySet</a> </li> <li class="class-depth-1"> <a href="Phaser.ArrayUtils.html">ArrayUtils</a> </li> <li class="class-depth-1"> <a href="Phaser.AudioSprite.html">AudioSprite</a> </li> <li class="class-depth-1"> <a href="Phaser.BitmapData.html">BitmapData</a> </li> <li class="class-depth-1"> <a href="Phaser.BitmapText.html">BitmapText</a> </li> <li class="class-depth-1"> <a href="Phaser.Button.html">Button</a> </li> <li class="class-depth-1"> <a href="Phaser.Cache.html">Cache</a> </li> <li class="class-depth-1"> <a href="Phaser.Camera.html">Camera</a> </li> <li class="class-depth-1"> <a href="Phaser.Canvas.html">Canvas</a> </li> <li class="class-depth-1"> <a href="Phaser.Circle.html">Circle</a> </li> <li class="class-depth-1"> <a href="Phaser.Color.html">Color</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.Angle.html">Angle</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.Animation.html">Animation</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.AutoCull.html">AutoCull</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.Bounds.html">Bounds</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.BringToTop.html">BringToTop</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.Core.html">Core</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.Crop.html">Crop</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.Delta.html">Delta</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.Destroy.html">Destroy</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.FixedToCamera.html">FixedToCamera</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.Health.html">Health</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.InCamera.html">InCamera</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.InputEnabled.html">InputEnabled</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.InWorld.html">InWorld</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.LifeSpan.html">LifeSpan</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.LoadTexture.html">LoadTexture</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.Overlap.html">Overlap</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.PhysicsBody.html">PhysicsBody</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.Reset.html">Reset</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.ScaleMinMax.html">ScaleMinMax</a> </li> <li class="class-depth-2"> <a href="Phaser.Component.Smoothed.html">Smoothed</a> </li> <li class="class-depth-1"> <a href="Phaser.Create.html">Create</a> </li> <li class="class-depth-1"> <a href="Phaser.Creature.html">Creature</a> </li> <li class="class-depth-1"> <a href="Phaser.Device.html">Device</a> </li> <li class="class-depth-1"> <a href="Phaser.DeviceButton.html">DeviceButton</a> </li> <li class="class-depth-1"> <a href="Phaser.DOM.html">DOM</a> </li> <li class="class-depth-1"> <a href="Phaser.Easing.html">Easing</a> </li> <li class="class-depth-2"> <a href="Phaser.Easing.Back.html">Back</a> </li> <li class="class-depth-2"> <a href="Phaser.Easing.Bounce.html">Bounce</a> </li> <li class="class-depth-2"> <a href="Phaser.Easing.Circular.html">Circular</a> </li> <li class="class-depth-2"> <a href="Phaser.Easing.Cubic.html">Cubic</a> </li> <li class="class-depth-2"> <a href="Phaser.Easing.Elastic.html">Elastic</a> </li> <li class="class-depth-2"> <a href="Phaser.Easing.Exponential.html">Exponential</a> </li> <li class="class-depth-2"> <a href="Phaser.Easing.Linear.html">Linear</a> </li> <li class="class-depth-2"> <a href="Phaser.Easing.Quadratic.html">Quadratic</a> </li> <li class="class-depth-2"> <a href="Phaser.Easing.Quartic.html">Quartic</a> </li> <li class="class-depth-2"> <a href="Phaser.Easing.Quintic.html">Quintic</a> </li> <li class="class-depth-2"> <a href="Phaser.Easing.Sinusoidal.html">Sinusoidal</a> </li> <li class="class-depth-1"> <a href="Phaser.Ellipse.html">Ellipse</a> </li> <li class="class-depth-1"> <a href="Phaser.Events.html">Events</a> </li> <li class="class-depth-1"> <a href="Phaser.Filter.html">Filter</a> </li> <li class="class-depth-1"> <a href="Phaser.FlexGrid.html">FlexGrid</a> </li> <li class="class-depth-1"> <a href="Phaser.FlexLayer.html">FlexLayer</a> </li> <li class="class-depth-1"> <a href="Phaser.Frame.html">Frame</a> </li> <li class="class-depth-1"> <a href="Phaser.FrameData.html">FrameData</a> </li> <li class="class-depth-1"> <a href="Phaser.Game.html">Game</a> </li> <li class="class-depth-1"> <a href="Phaser.GameObjectCreator.html">GameObjectCreator</a> </li> <li class="class-depth-1"> <a href="Phaser.GameObjectFactory.html">GameObjectFactory</a> </li> <li class="class-depth-1"> <a href="Phaser.Gamepad.html">Gamepad</a> </li> <li class="class-depth-1"> <a href="Phaser.Graphics.html">Graphics</a> </li> <li class="class-depth-1"> <a href="Phaser.Group.html">Group</a> </li> <li class="class-depth-1"> <a href="Phaser.Image.html">Image</a> </li> <li class="class-depth-1"> <a href="Phaser.ImageCollection.html">ImageCollection</a> </li> <li class="class-depth-1"> <a href="Phaser.Input.html">Input</a> </li> <li class="class-depth-1"> <a href="Phaser.InputHandler.html">InputHandler</a> </li> <li class="class-depth-1"> <a href="Phaser.Key.html">Key</a> </li> <li class="class-depth-1"> <a href="Phaser.Keyboard.html">Keyboard</a> </li> <li class="class-depth-1"> <a href="Phaser.Line.html">Line</a> </li> <li class="class-depth-1"> <a href="Phaser.LinkedList.html">LinkedList</a> </li> <li class="class-depth-1"> <a href="Phaser.Loader.html">Loader</a> </li> <li class="class-depth-1"> <a href="Phaser.LoaderParser.html">LoaderParser</a> </li> <li class="class-depth-1"> <a href="Phaser.Math.html">Math</a> </li> <li class="class-depth-1"> <a href="Phaser.Matrix.html">Matrix</a> </li> <li class="class-depth-1"> <a href="Phaser.Mouse.html">Mouse</a> </li> <li class="class-depth-1"> <a href="Phaser.MSPointer.html">MSPointer</a> </li> <li class="class-depth-1"> <a href="Phaser.Net.html">Net</a> </li> <li class="class-depth-1"> <a href="Phaser.Particle.html">Particle</a> </li> <li class="class-depth-1"> <a href="Phaser.Particles.html">Particles</a> </li> <li class="class-depth-2"> <a href="Phaser.Particles.Arcade.html">Arcade</a> </li> <li class="class-depth-3"> <a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a> </li> <li class="class-depth-1"> <a href="Phaser.Physics.html">Physics</a> </li> <li class="class-depth-2"> <a href="Phaser.Physics.Arcade.html">Arcade</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.Arcade.Body.html">Body</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.Arcade.TilemapCollision.html">TilemapCollision</a> </li> <li class="class-depth-2"> <a href="Phaser.Physics.Ninja.html">Ninja</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.Ninja.AABB.html">AABB</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.Ninja.Body.html">Body</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.Ninja.Circle.html">Circle</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.Ninja.Tile.html">Tile</a> </li> <li class="class-depth-2"> <a href="Phaser.Physics.P2.html">P2</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.P2.Body.html">Body</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.P2.BodyDebug.html">BodyDebug</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.P2.DistanceConstraint.html">DistanceConstraint</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.P2.FixtureList.html">FixtureList</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.P2.GearConstraint.html">GearConstraint</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.P2.InversePointProxy.html">InversePointProxy</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.P2.LockConstraint.html">LockConstraint</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.P2.Material.html">Material</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.P2.PointProxy.html">PointProxy</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.P2.PrismaticConstraint.html">PrismaticConstraint</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.P2.RevoluteConstraint.html">RevoluteConstraint</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.P2.RotationalSpring.html">RotationalSpring</a> </li> <li class="class-depth-3"> <a href="Phaser.Physics.P2.Spring.html">Spring</a> </li> <li class="class-depth-1"> <a href="Phaser.Plugin.html">Plugin</a> </li> <li class="class-depth-1"> <a href="Phaser.PluginManager.html">PluginManager</a> </li> <li class="class-depth-1"> <a href="Phaser.Point.html">Point</a> </li> <li class="class-depth-1"> <a href="Phaser.Pointer.html">Pointer</a> </li> <li class="class-depth-1"> <a href="Phaser.PointerMode.html">PointerMode</a> </li> <li class="class-depth-1"> <a href="Phaser.Polygon.html">Polygon</a> </li> <li class="class-depth-1"> <a href="Phaser.QuadTree.html">QuadTree</a> </li> <li class="class-depth-1"> <a href="Phaser.RandomDataGenerator.html">RandomDataGenerator</a> </li> <li class="class-depth-1"> <a href="Phaser.Rectangle.html">Rectangle</a> </li> <li class="class-depth-1"> <a href="Phaser.RenderTexture.html">RenderTexture</a> </li> <li class="class-depth-1"> <a href="Phaser.RequestAnimationFrame.html">RequestAnimationFrame</a> </li> <li class="class-depth-1"> <a href="Phaser.RetroFont.html">RetroFont</a> </li> <li class="class-depth-1"> <a href="Phaser.Rope.html">Rope</a> </li> <li class="class-depth-1"> <a href="Phaser.RoundedRectangle.html">RoundedRectangle</a> </li> <li class="class-depth-1"> <a href="Phaser.ScaleManager.html">ScaleManager</a> </li> <li class="class-depth-1"> <a href="Phaser.Signal.html">Signal</a> </li> <li class="class-depth-1"> <a href="Phaser.SignalBinding.html">SignalBinding</a> </li> <li class="class-depth-1"> <a href="Phaser.SinglePad.html">SinglePad</a> </li> <li class="class-depth-1"> <a href="Phaser.Sound.html">Sound</a> </li> <li class="class-depth-1"> <a href="Phaser.SoundManager.html">SoundManager</a> </li> <li class="class-depth-1"> <a href="Phaser.Sprite.html">Sprite</a> </li> <li class="class-depth-1"> <a href="Phaser.SpriteBatch.html">SpriteBatch</a> </li> <li class="class-depth-1"> <a href="Phaser.Stage.html">Stage</a> </li> <li class="class-depth-1"> <a href="Phaser.State.html">State</a> </li> <li class="class-depth-1"> <a href="Phaser.StateManager.html">StateManager</a> </li> <li class="class-depth-1"> <a href="Phaser.Text.html">Text</a> </li> <li class="class-depth-1"> <a href="Phaser.Tile.html">Tile</a> </li> <li class="class-depth-1"> <a href="Phaser.Tilemap.html">Tilemap</a> </li> <li class="class-depth-1"> <a href="Phaser.TilemapLayer.html">TilemapLayer</a> </li> <li class="class-depth-1"> <a href="Phaser.TilemapParser.html">TilemapParser</a> </li> <li class="class-depth-1"> <a href="Phaser.Tileset.html">Tileset</a> </li> <li class="class-depth-1"> <a href="Phaser.TileSprite.html">TileSprite</a> </li> <li class="class-depth-1"> <a href="Phaser.Time.html">Time</a> </li> <li class="class-depth-1"> <a href="Phaser.Timer.html">Timer</a> </li> <li class="class-depth-1"> <a href="Phaser.TimerEvent.html">TimerEvent</a> </li> <li class="class-depth-1"> <a href="Phaser.Touch.html">Touch</a> </li> <li class="class-depth-1"> <a href="Phaser.Tween.html">Tween</a> </li> <li class="class-depth-1"> <a href="Phaser.TweenData.html">TweenData</a> </li> <li class="class-depth-1"> <a href="Phaser.TweenManager.html">TweenManager</a> </li> <li class="class-depth-1"> <a href="Phaser.Utils.html">Utils</a> </li> <li class="class-depth-2"> <a href="Phaser.Utils.Debug.html">Debug</a> </li> <li class="class-depth-1"> <a href="Phaser.Video.html">Video</a> </li> <li class="class-depth-1"> <a href="Phaser.World.html">World</a> </li> <li class="class-depth-1"> <a href="PIXI.AbstractFilter.html">AbstractFilter</a> </li> <li class="class-depth-1"> <a href="PIXI.BaseTexture.html">BaseTexture</a> </li> <li class="class-depth-1"> <a href="PIXI.CanvasBuffer.html">CanvasBuffer</a> </li> <li class="class-depth-1"> <a href="PIXI.CanvasGraphics.html">CanvasGraphics</a> </li> <li class="class-depth-1"> <a href="PIXI.CanvasMaskManager.html">CanvasMaskManager</a> </li> <li class="class-depth-1"> <a href="PIXI.CanvasPool.html">CanvasPool</a> </li> <li class="class-depth-1"> <a href="PIXI.CanvasRenderer.html">CanvasRenderer</a> </li> <li class="class-depth-1"> <a href="PIXI.CanvasTinter.html">CanvasTinter</a> </li> <li class="class-depth-1"> <a href="PIXI.ComplexPrimitiveShader.html">ComplexPrimitiveShader</a> </li> <li class="class-depth-1"> <a href="PIXI.DisplayObject.html">DisplayObject</a> </li> <li class="class-depth-1"> <a href="PIXI.DisplayObjectContainer.html">DisplayObjectContainer</a> </li> <li class="class-depth-1"> <a href="PIXI.EarCut.html">EarCut</a> </li> <li class="class-depth-1"> <a href="PIXI.Event.html">Event</a> </li> <li class="class-depth-1"> <a href="PIXI.EventTarget.html">EventTarget</a> </li> <li class="class-depth-1"> <a href="PIXI.FilterTexture.html">FilterTexture</a> </li> <li class="class-depth-1"> <a href="PIXI.Graphics.html">Graphics</a> </li> <li class="class-depth-1"> <a href="PIXI.GraphicsData.html">GraphicsData</a> </li> <li class="class-depth-1"> <a href="PIXI.PIXI.html">PIXI</a> </li> <li class="class-depth-1"> <a href="PIXI.PixiFastShader.html">PixiFastShader</a> </li> <li class="class-depth-1"> <a href="PIXI.PixiShader.html">PixiShader</a> </li> <li class="class-depth-1"> <a href="PIXI.PolyK.html">PolyK</a> </li> <li class="class-depth-1"> <a href="PIXI.PrimitiveShader.html">PrimitiveShader</a> </li> <li class="class-depth-1"> <a href="PIXI.RenderTexture.html">RenderTexture</a> </li> <li class="class-depth-1"> <a href="PIXI.Rope.html">Rope</a> </li> <li class="class-depth-1"> <a href="PIXI.Sprite.html">Sprite</a> </li> <li class="class-depth-1"> <a href="PIXI.SpriteBatch.html">SpriteBatch</a> </li> <li class="class-depth-1"> <a href="PIXI.Strip.html">Strip</a> </li> <li class="class-depth-1"> <a href="PIXI.StripShader.html">StripShader</a> </li> <li class="class-depth-1"> <a href="PIXI.Texture.html">Texture</a> </li> <li class="class-depth-1"> <a href="PIXI.TilingSprite.html">TilingSprite</a> </li> <li class="class-depth-1"> <a href="PIXI.WebGLBlendModeManager.html">WebGLBlendModeManager</a> </li> <li class="class-depth-1"> <a href="PIXI.WebGLFastSpriteBatch.html">WebGLFastSpriteBatch</a> </li> <li class="class-depth-1"> <a href="PIXI.WebGLFilterManager.html">WebGLFilterManager</a> </li> <li class="class-depth-1"> <a href="PIXI.WebGLRenderer.html">WebGLRenderer</a> </li> </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 class="class-depth-0"> <a href="global.html#AUTO">AUTO</a> </li> <li class="class-depth-0"> <a href="global.html#BITMAPDATA">BITMAPDATA</a> </li> <li class="class-depth-0"> <a href="global.html#BITMAPTEXT">BITMAPTEXT</a> </li> <li class="class-depth-0"> <a href="global.html#blendModes">blendModes</a> </li> <li class="class-depth-0"> <a href="global.html#BUTTON">BUTTON</a> </li> <li class="class-depth-0"> <a href="global.html#CANVAS">CANVAS</a> </li> <li class="class-depth-0"> <a href="global.html#CANVAS_FILTER">CANVAS_FILTER</a> </li> <li class="class-depth-0"> <a href="global.html#CIRCLE">CIRCLE</a> </li> <li class="class-depth-0"> <a href="global.html#CREATURE">CREATURE</a> </li> <li class="class-depth-0"> <a href="global.html#DOWN">DOWN</a> </li> <li class="class-depth-0"> <a href="global.html#ELLIPSE">ELLIPSE</a> </li> <li class="class-depth-0"> <a href="global.html#EMITTER">EMITTER</a> </li> <li class="class-depth-0"> <a href="global.html#GAMES">GAMES</a> </li> <li class="class-depth-0"> <a href="global.html#GRAPHICS">GRAPHICS</a> </li> <li class="class-depth-0"> <a href="global.html#GROUP">GROUP</a> </li> <li class="class-depth-0"> <a href="global.html#HEADLESS">HEADLESS</a> </li> <li class="class-depth-0"> <a href="global.html#IMAGE">IMAGE</a> </li> <li class="class-depth-0"> <a href="global.html#LEFT">LEFT</a> </li> <li class="class-depth-0"> <a href="global.html#LINE">LINE</a> </li> <li class="class-depth-0"> <a href="global.html#MATRIX">MATRIX</a> </li> <li class="class-depth-0"> <a href="global.html#NONE">NONE</a> </li> <li class="class-depth-0"> <a href="global.html#PENDING_ATLAS">PENDING_ATLAS</a> </li> <li class="class-depth-0"> <a href="global.html#POINT">POINT</a> </li> <li class="class-depth-0"> <a href="global.html#POINTER">POINTER</a> </li> <li class="class-depth-0"> <a href="global.html#POLYGON">POLYGON</a> </li> <li class="class-depth-0"> <a href="global.html#RECTANGLE">RECTANGLE</a> </li> <li class="class-depth-0"> <a href="global.html#RENDERTEXTURE">RENDERTEXTURE</a> </li> <li class="class-depth-0"> <a href="global.html#RETROFONT">RETROFONT</a> </li> <li class="class-depth-0"> <a href="global.html#RIGHT">RIGHT</a> </li> <li class="class-depth-0"> <a href="global.html#ROPE">ROPE</a> </li> <li class="class-depth-0"> <a href="global.html#ROUNDEDRECTANGLE">ROUNDEDRECTANGLE</a> </li> <li class="class-depth-0"> <a href="global.html#scaleModes">scaleModes</a> </li> <li class="class-depth-0"> <a href="global.html#SPRITE">SPRITE</a> </li> <li class="class-depth-0"> <a href="global.html#SPRITEBATCH">SPRITEBATCH</a> </li> <li class="class-depth-0"> <a href="global.html#TEXT">TEXT</a> </li> <li class="class-depth-0"> <a href="global.html#TILEMAP">TILEMAP</a> </li> <li class="class-depth-0"> <a href="global.html#TILEMAPLAYER">TILEMAPLAYER</a> </li> <li class="class-depth-0"> <a href="global.html#TILESPRITE">TILESPRITE</a> </li> <li class="class-depth-0"> <a href="global.html#UP">UP</a> </li> <li class="class-depth-0"> <a href="global.html#VERSION">VERSION</a> </li> <li class="class-depth-0"> <a href="global.html#VIDEO">VIDEO</a> </li> <li class="class-depth-0"> <a href="global.html#WEBGL">WEBGL</a> </li> <li class="class-depth-0"> <a href="global.html#WEBGL_FILTER">WEBGL_FILTER</a> </li> </ul> </li> <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown">Core<b class="caret"></b></a> <ul class="dropdown-menu "> <li class="class-depth-1"><a href="Phaser.Game.html">Game</a></li> <li class="class-depth-1"><a href="Phaser.Group.html">Group</a></li> <li class="class-depth-1"><a href="Phaser.World.html">World</a></li> <li class="class-depth-1"><a href="Phaser.Loader.html">Loader</a></li> <li class="class-depth-1"><a href="Phaser.Cache.html">Cache</a></li> <li class="class-depth-1"><a href="Phaser.Time.html">Time</a></li> <li class="class-depth-1"><a href="Phaser.Camera.html">Camera</a></li> <li class="class-depth-1"><a href="Phaser.StateManager.html">State Manager</a></li> <li class="class-depth-1"><a href="Phaser.TweenManager.html">Tween Manager</a></li> <li class="class-depth-1"><a href="Phaser.SoundManager.html">Sound Manager</a></li> <li class="class-depth-1"><a href="Phaser.Input.html">Input Manager</a></li> <li class="class-depth-1"><a href="Phaser.ScaleManager.html">Scale Manager</a></li> </ul> </li> <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown">Game Objects<b class="caret"></b></a> <ul class="dropdown-menu "> <li class="class-depth-1"><a href="Phaser.GameObjectFactory.html">Factory (game.add)</a></li> <li class="class-depth-1"><a href="Phaser.GameObjectCreator.html">Creator (game.make)</a></li> <li class="class-depth-1"><a href="Phaser.Sprite.html">Sprite</a></li> <li class="class-depth-1"><a href="Phaser.Image.html">Image</a></li> <li class="class-depth-1"><a href="Phaser.Sound.html">Sound</a></li> <li class="class-depth-1"><a href="Phaser.Video.html">Video</a></li> <li class="class-depth-1"><a href="Phaser.Particles.Arcade.Emitter.html">Particle Emitter</a></li> <li class="class-depth-1"><a href="Phaser.Particle.html">Particle</a></li> <li class="class-depth-1"><a href="Phaser.Text.html">Text</a></li> <li class="class-depth-1"><a href="Phaser.Tween.html">Tween</a></li> <li class="class-depth-1"><a href="Phaser.BitmapText.html">BitmapText</a></li> <li class="class-depth-1"><a href="Phaser.Tilemap.html">Tilemap</a></li> <li class="class-depth-1"><a href="Phaser.BitmapData.html">BitmapData</a></li> <li class="class-depth-1"><a href="Phaser.RetroFont.html">RetroFont</a></li> <li class="class-depth-1"><a href="Phaser.Button.html">Button</a></li> <li class="class-depth-1"><a href="Phaser.Animation.html">Animation</a></li> <li class="class-depth-1"><a href="Phaser.Graphics.html">Graphics</a></li> <li class="class-depth-1"><a href="Phaser.RenderTexture.html">RenderTexture</a></li> <li class="class-depth-1"><a href="Phaser.TileSprite.html">TileSprite</a></li> </ul> </li> <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown">Geometry<b class="caret"></b></a> <ul class="dropdown-menu "> <li class="class-depth-1"><a href="Phaser.Circle.html">Circle</a></li> <li class="class-depth-1"><a href="Phaser.Ellipse.html">Ellipse</a></li> <li class="class-depth-1"><a href="Phaser.Line.html">Line</a></li> <li class="class-depth-1"><a href="Phaser.Matrix.html">Matrix</a></li> <li class="class-depth-1"><a href="Phaser.Point.html">Point</a></li> <li class="class-depth-1"><a href="Phaser.Polygon.html">Polygon</a></li> <li class="class-depth-1"><a href="Phaser.Rectangle.html">Rectangle</a></li> <li class="class-depth-1"><a href="Phaser.RoundedRectangle.html">Rounded Rectangle</a></li> </ul> </li> <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown">Physics<b class="caret"></b></a> <ul class="dropdown-menu "> <li class="class-depth-1"><a href="Phaser.Physics.Arcade.html">Arcade Physics</a></li> <li class="class-depth-2"><a href="Phaser.Physics.Arcade.Body.html">Body</a></li> <li class="class-depth-1"><a href="Phaser.Physics.P2.html">P2 Physics</a></li> <li class="class-depth-2"><a href="Phaser.Physics.P2.Body.html">Body</a></li> <li class="class-depth-2"><a href="Phaser.Physics.P2.Spring.html">Spring</a></li> <li class="class-depth-2"><a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a></li> <li class="class-depth-2"><a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a></li> <li class="class-depth-1"><a href="Phaser.Physics.Ninja.html">Ninja Physics</a></li> <li class="class-depth-2"><a href="Phaser.Physics.Body.html">Body</a></li> </ul> </li> <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown">Input<b class="caret"></b></a> <ul class="dropdown-menu "> <li class="class-depth-1"><a href="Phaser.InputHandler.html">Input Handler</a></li> <li class="class-depth-1"><a href="Phaser.Pointer.html">Pointer</a></li> <li class="class-depth-1"><a href="Phaser.DeviceButton.html">Device Button</a></li> <li class="class-depth-1"><a href="Phaser.Mouse.html">Mouse</a></li> <li class="class-depth-1"><a href="Phaser.Keyboard.html">Keyboard</a></li> <li class="class-depth-1"><a href="Phaser.Key.html">Key</a></li> <li class="class-depth-1"><a href="Phaser.Gamepad.html">Gamepad</a></li> </ul> </li> <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown">Community<b class="caret"></b></a> <ul class="dropdown-menu "> <li class="class-depth-1"><a href="http://phaser.io">Phaser Web Site</a></li> <li class="class-depth-1"><a href="https://github.com/photonstorm/phaser">Phaser Github</a></li> <li class="class-depth-1"><a href="http://phaser.io/examples">Phaser Examples</a></li> <li class="class-depth-1"><a href="https://github.com/photonstorm/phaser-plugins">Phaser Plugins</a></li> <li class="class-depth-1"><a href="http://www.html5gamedevs.com/forum/14-phaser/">Forum</a></li> <li class="class-depth-1"><a href="http://stackoverflow.com/questions/tagged/phaser-framework">Stack Overflow</a></li> <li class="class-depth-1"><a href="http://phaser.io/learn">Tutorials</a></li> <li class="class-depth-1"><a href="http://phaser.io/community/newsletter">Newsletter</a></li> <li class="class-depth-1"><a href="http://phaser.io/community/twitter">Twitter</a></li> <li class="class-depth-1"><a href="http://phaser.io/news/2015/08/phaser-slack-channel">Slack</a></li> <li class="class-depth-1"><a href="https://www.codeandweb.com/texturepacker/phaser">Texture Packer</a></li> </ul> </li> </ul> </div> </div> <div class="row-fluid"> <div class="span8"> <div id="main"> <!--<h1 class="page-title">Class: RetroFont</h1>--> <section> <header> <h2> <span class="ancestors"><a href="Phaser.html">Phaser</a>.</span> RetroFont </h2> </header> <article> <div class="container-overview"> <dt> <h4 class="name " id="RetroFont"><span class="type-signature"></span>new RetroFont<span class="signature">(game, key, characterWidth, characterHeight, chars, <span class="optional">charsPerRow</span>, <span class="optional">xSpacing</span>, <span class="optional">ySpacing</span>, <span class="optional">xOffset</span>, <span class="optional">yOffset</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>A Retro Font is similar to a BitmapFont, in that it uses a texture to render the text. However unlike a BitmapFont every character in a RetroFont is the same size. This makes it similar to a sprite sheet. You typically find font sheets like this from old 8/16-bit games and demos.</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>game</code></td> <td class="type"> <span class="param-type"><a href="Phaser.Game.html">Phaser.Game</a></span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>Current game instance.</p></td> </tr> <tr> <td class="name"><code>key</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The font set graphic set as stored in the Game.Cache.</p></td> </tr> <tr> <td class="name"><code>characterWidth</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The width of each character in the font set.</p></td> </tr> <tr> <td class="name"><code>characterHeight</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The height of each character in the font set.</p></td> </tr> <tr> <td class="name"><code>chars</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The characters used in the font set, in display order. You can use the TEXT_SET consts for common font set arrangements.</p></td> </tr> <tr> <td class="name"><code>charsPerRow</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"><p>The number of characters per row in the font set. If not given charsPerRow will be the image width / characterWidth.</p></td> </tr> <tr> <td class="name"><code>xSpacing</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 0 </td> <td class="description last"><p>If the characters in the font set have horizontal spacing between them set the required amount here.</p></td> </tr> <tr> <td class="name"><code>ySpacing</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 0 </td> <td class="description last"><p>If the characters in the font set have vertical spacing between them set the required amount here.</p></td> </tr> <tr> <td class="name"><code>xOffset</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 0 </td> <td class="description last"><p>If the font set doesn't start at the top left of the given image, specify the X coordinate offset here.</p></td> </tr> <tr> <td class="name"><code>yOffset</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 0 </td> <td class="description last"><p>If the font set doesn't start at the top left of the given image, specify the Y coordinate offset here.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-25">line 25</a> </dt> </dl> </dd> </div> <h3 class="subsection-title">Extends</h3> <ul> <li><a href="Phaser.RenderTexture.html">Phaser.RenderTexture</a></li> </ul> <h3 class="subsection-title">Members</h3> <dl> <dt> <h4 class="name " id=".ALIGN_CENTER"><span class="type-signature"><static, constant> </span>ALIGN_CENTER<span class="type-signature"> :string</span></h4> </dt> <dd> <div class="description"> <p>Align each line of multi-line text in the center.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-196">line 196</a> </dt> </dl> </dd> <dt> <h4 class="name " id=".ALIGN_LEFT"><span class="type-signature"><static, constant> </span>ALIGN_LEFT<span class="type-signature"> :string</span></h4> </dt> <dd> <div class="description"> <p>Align each line of multi-line text to the left.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-182">line 182</a> </dt> </dl> </dd> <dt> <h4 class="name " id=".ALIGN_RIGHT"><span class="type-signature"><static, constant> </span>ALIGN_RIGHT<span class="type-signature"> :string</span></h4> </dt> <dd> <div class="description"> <p>Align each line of multi-line text to the right.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-189">line 189</a> </dt> </dl> </dd> <dt> <h4 class="name " id=".TEXT_SET1"><span class="type-signature"><static, constant> </span>TEXT_SET1<span class="type-signature"> :string</span></h4> </dt> <dd> <div class="description"> <p>Text Set 1 = !"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[]^_`abcdefghijklmnopqrstuvwxyz{|}~</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-203">line 203</a> </dt> </dl> </dd> <dt> <h4 class="name " id=".TEXT_SET2"><span class="type-signature"><static, constant> </span>TEXT_SET2<span class="type-signature"> :string</span></h4> </dt> <dd> <div class="description"> <p>Text Set 2 = !"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-210">line 210</a> </dt> </dl> </dd> <dt> <h4 class="name " id=".TEXT_SET3"><span class="type-signature"><static, constant> </span>TEXT_SET3<span class="type-signature"> :string</span></h4> </dt> <dd> <div class="description"> <p>Text Set 3 = ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-217">line 217</a> </dt> </dl> </dd> <dt> <h4 class="name " id=".TEXT_SET4"><span class="type-signature"><static, constant> </span>TEXT_SET4<span class="type-signature"> :string</span></h4> </dt> <dd> <div class="description"> <p>Text Set 4 = ABCDEFGHIJKLMNOPQRSTUVWXYZ 0123456789</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-224">line 224</a> </dt> </dl> </dd> <dt> <h4 class="name " id=".TEXT_SET5"><span class="type-signature"><static, constant> </span>TEXT_SET5<span class="type-signature"> :string</span></h4> </dt> <dd> <div class="description"> <p>Text Set 5 = ABCDEFGHIJKLMNOPQRSTUVWXYZ.,/() '!?-*:0123456789</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-231">line 231</a> </dt> </dl> </dd> <dt> <h4 class="name " id=".TEXT_SET6"><span class="type-signature"><static, constant> </span>TEXT_SET6<span class="type-signature"> :string</span></h4> </dt> <dd> <div class="description"> <p>Text Set 6 = ABCDEFGHIJKLMNOPQRSTUVWXYZ!?:;0123456789"(),-.'</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-238">line 238</a> </dt> </dl> </dd> <dt> <h4 class="name " id=".TEXT_SET7"><span class="type-signature"><static, constant> </span>TEXT_SET7<span class="type-signature"> :string</span></h4> </dt> <dd> <div class="description"> <p>Text Set 7 = AGMSY+:4BHNTZ!;5CIOU.?06DJPV,(17EKQW")28FLRX-'39</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-245">line 245</a> </dt> </dl> </dd> <dt> <h4 class="name " id=".TEXT_SET8"><span class="type-signature"><static, constant> </span>TEXT_SET8<span class="type-signature"> :string</span></h4> </dt> <dd> <div class="description"> <p>Text Set 8 = 0123456789 .ABCDEFGHIJKLMNOPQRSTUVWXYZ</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-252">line 252</a> </dt> </dl> </dd> <dt> <h4 class="name " id=".TEXT_SET9"><span class="type-signature"><static, constant> </span>TEXT_SET9<span class="type-signature"> :string</span></h4> </dt> <dd> <div class="description"> <p>Text Set 9 = ABCDEFGHIJKLMNOPQRSTUVWXYZ()-0123456789.:,'"?!</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-259">line 259</a> </dt> </dl> </dd> <dt> <h4 class="name " id=".TEXT_SET10"><span class="type-signature"><static, constant> </span>TEXT_SET10<span class="type-signature"> :string</span></h4> </dt> <dd> <div class="description"> <p>Text Set 10 = ABCDEFGHIJKLMNOPQRSTUVWXYZ</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-266">line 266</a> </dt> </dl> </dd> <dt> <h4 class="name " id=".TEXT_SET11"><span class="type-signature"><static, constant> </span>TEXT_SET11<span class="type-signature"> :string</span></h4> </dt> <dd> <div class="description"> <p>Text Set 11 = ABCDEFGHIJKLMNOPQRSTUVWXYZ.,"-+!?()':;0123456789</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-273">line 273</a> </dt> </dl> </dd> <dt> <h4 class="name " id="align"><span class="type-signature"></span>align<span class="type-signature"> :string</span></h4> </dt> <dd> <div class="description"> <p>Alignment of the text when multiLine = true or a fixedWidth is set. Set to RetroFont.ALIGN_LEFT (default), RetroFont.ALIGN_RIGHT or RetroFont.ALIGN_CENTER.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-77">line 77</a> </dt> </dl> </dd> <dt> <h4 class="name " id="autoUpperCase"><span class="type-signature"></span>autoUpperCase<span class="type-signature"> :boolean</span></h4> </dt> <dd> <div class="description"> <p>Automatically convert any text to upper case. Lots of old bitmap fonts only contain upper-case characters, so the default is true.</p> </div> <dl class="details"> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>true</li></ul></dd> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-89">line 89</a> </dt> </dl> </dd> <dt> <h4 class="name " id="baseTexture"><span class="type-signature"></span>baseTexture<span class="type-signature"> :<a href="PIXI.BaseTexture.html">PIXI.BaseTexture</a></span></h4> </dt> <dd> <div class="description"> <p>The base texture object that this texture uses</p> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="PIXI.RenderTexture.html#baseTexture">PIXI.RenderTexture#baseTexture</a> </li></dd> <dt class="tag-source">Source - <a href="src_pixi_textures_RenderTexture.js.html">pixi/textures/RenderTexture.js</a>, <a href="src_pixi_textures_RenderTexture.js.html#sunlight-1-line-78">line 78</a> </dt> </dl> </dd> <dt> <h4 class="name " id="characterHeight"><span class="type-signature"></span>characterHeight<span class="type-signature"> :number</span></h4> </dt> <dd> <div class="description"> <p>The height of each character in the font set.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-45">line 45</a> </dt> </dl> </dd> <dt> <h4 class="name " id="characterPerRow"><span class="type-signature"></span>characterPerRow<span class="type-signature"> :number</span></h4> </dt> <dd> <div class="description"> <p>The number of characters per row in the font set.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-60">line 60</a> </dt> </dl> </dd> <dt> <h4 class="name " id="characterSpacingX"><span class="type-signature"></span>characterSpacingX<span class="type-signature"> :number</span></h4> </dt> <dd> <div class="description"> <p>If the characters in the font set have horizontal spacing between them set the required amount here.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-50">line 50</a> </dt> </dl> </dd> <dt> <h4 class="name " id="characterSpacingY"><span class="type-signature"></span>characterSpacingY<span class="type-signature"> :number</span></h4> </dt> <dd> <div class="description"> <p>If the characters in the font set have vertical spacing between them set the required amount here.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-55">line 55</a> </dt> </dl> </dd> <dt> <h4 class="name " id="characterWidth"><span class="type-signature"></span>characterWidth<span class="type-signature"> :number</span></h4> </dt> <dd> <div class="description"> <p>The width of each character in the font set.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-40">line 40</a> </dt> </dl> </dd> <dt> <h4 class="name " id="crop"><span class="type-signature"></span>crop<span class="type-signature"> :Rectangle</span></h4> </dt> <dd> <div class="description"> <p>This is the area of the BaseTexture image to actually copy to the Canvas / WebGL when rendering, irrespective of the actual frame size or placement (which can be influenced by trimmed texture atlases)</p> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="PIXI.RenderTexture.html#crop">PIXI.RenderTexture#crop</a> </li></dd> <dt class="tag-source">Source - <a href="src_pixi_textures_RenderTexture.js.html">pixi/textures/RenderTexture.js</a>, <a href="src_pixi_textures_RenderTexture.js.html#sunlight-1-line-69">line 69</a> </dt> </dl> </dd> <dt> <h4 class="name " id="customSpacingX"><span class="type-signature"></span>customSpacingX<span class="type-signature"> :number</span></h4> </dt> <dd> <div class="description"> <p>Adds horizontal spacing between each character of the font, in pixels.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-95">line 95</a> </dt> </dl> </dd> <dt> <h4 class="name " id="customSpacingY"><span class="type-signature"></span>customSpacingY<span class="type-signature"> :number</span></h4> </dt> <dd> <div class="description"> <p>Adds vertical spacing between each line of multi-line text, set in pixels.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-101">line 101</a> </dt> </dl> </dd> <dt> <h4 class="name " id="fixedWidth"><span class="type-signature"></span>fixedWidth<span class="type-signature"> :number</span></h4> </dt> <dd> <div class="description"> <p>If you need this RetroFont image to have a fixed width you can set the width in this value. If text is wider than the width specified it will be cropped off.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-108">line 108</a> </dt> </dl> </dd> <dt> <h4 class="name " id="fontSet"><span class="type-signature"></span>fontSet<span class="type-signature"> :Image</span></h4> </dt> <dd> <div class="description"> <p>A reference to the image stored in the Game.Cache that contains the font.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-113">line 113</a> </dt> </dl> </dd> <dt> <h4 class="name " id="frame"><span class="type-signature"></span>frame<span class="type-signature"> :Rectangle</span></h4> </dt> <dd> <div class="description"> <p>The framing rectangle of the render texture</p> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="PIXI.RenderTexture.html#frame">PIXI.RenderTexture#frame</a> </li></dd> <dt class="tag-source">Source - <a href="src_pixi_textures_RenderTexture.js.html">pixi/textures/RenderTexture.js</a>, <a href="src_pixi_textures_RenderTexture.js.html#sunlight-1-line-61">line 61</a> </dt> </dl> </dd> <dt> <h4 class="name " id="frameData"><span class="type-signature"></span>frameData<span class="type-signature"> :<a href="Phaser.FrameData.html">Phaser.FrameData</a></span></h4> </dt> <dd> <div class="description"> <p>The FrameData representing this Retro Font.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-130">line 130</a> </dt> </dl> </dd> <dt> <h4 class="name " id="game"><span class="type-signature"></span>game<span class="type-signature"> :<a href="Phaser.Game.html">Phaser.Game</a></span></h4> </dt> <dd> <div class="description"> <p>A reference to the currently running game.</p> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="Phaser.RenderTexture.html#game">Phaser.RenderTexture#game</a> </li></dd> <dt class="tag-source">Source - <a href="src_gameobjects_RenderTexture.js.html">gameobjects/RenderTexture.js</a>, <a href="src_gameobjects_RenderTexture.js.html#sunlight-1-line-31">line 31</a> </dt> </dl> </dd> <dt> <h4 class="name " id="height"><span class="type-signature"></span>height<span class="type-signature"> :Number</span></h4> </dt> <dd> <div class="description"> <p>The height of the render texture</p> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="PIXI.RenderTexture.html#height">PIXI.RenderTexture#height</a> </li></dd> <dt class="tag-source">Source - <a href="src_pixi_textures_RenderTexture.js.html">pixi/textures/RenderTexture.js</a>, <a href="src_pixi_textures_RenderTexture.js.html#sunlight-1-line-45">line 45</a> </dt> </dl> </dd> <dt> <h4 class="name " id="isTiling"><span class="type-signature"></span>isTiling<span class="type-signature"> :Boolean</span></h4> </dt> <dd> <div class="description"> <p>Is this a tiling texture? As used by the likes of a TilingSprite.</p> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="PIXI.Texture.html#isTiling">PIXI.Texture#isTiling</a> </li></dd> <dt class="tag-source">Source - <a href="src_pixi_textures_Texture.js.html">pixi/textures/Texture.js</a>, <a href="src_pixi_textures_Texture.js.html#sunlight-1-line-84">line 84</a> </dt> </dl> </dd> <dt> <h4 class="name " id="key"><span class="type-signature"></span>key<span class="type-signature"> :string</span></h4> </dt> <dd> <div class="description"> <p>The key of the RenderTexture in the Cache, if stored there.</p> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="Phaser.RenderTexture.html#key">Phaser.RenderTexture#key</a> </li></dd> <dt class="tag-source">Source - <a href="src_gameobjects_RenderTexture.js.html">gameobjects/RenderTexture.js</a>, <a href="src_gameobjects_RenderTexture.js.html#sunlight-1-line-36">line 36</a> </dt> </dl> </dd> <dt> <h4 class="name " id="multiLine"><span class="type-signature"></span>multiLine<span class="type-signature"> :boolean</span></h4> </dt> <dd> <div class="description"> <p>If set to true all carriage-returns in text will form new lines (see align). If false the font will only contain one single line of text (the default)</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-83">line 83</a> </dt> </dl> </dd> <dt> <h4 class="name " id="noFrame"><span class="type-signature"></span>noFrame<span class="type-signature"> :Boolean</span></h4> </dt> <dd> <div class="description"> <p>Does this Texture have any frame data assigned to it?</p> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="PIXI.Texture.html#noFrame">PIXI.Texture#noFrame</a> </li></dd> <dt class="tag-source">Source - <a href="src_pixi_textures_Texture.js.html">pixi/textures/Texture.js</a>, <a href="src_pixi_textures_Texture.js.html#sunlight-1-line-33">line 33</a> </dt> </dl> </dd> <dt> <h4 class="name " id="offsetX"><span class="type-signature"><readonly> </span>offsetX<span class="type-signature"> :number</span></h4> </dt> <dd> <div class="description"> <p>If the font set doesn't start at the top left of the given image, specify the X coordinate offset here.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-66">line 66</a> </dt> </dl> </dd> <dt> <h4 class="name " id="offsetY"><span class="type-signature"><readonly> </span>offsetY<span class="type-signature"> :number</span></h4> </dt> <dd> <div class="description"> <p>If the font set doesn't start at the top left of the given image, specify the Y coordinate offset here.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-72">line 72</a> </dt> </dl> </dd> <dt> <h4 class="name " id="renderer"><span class="type-signature"></span>renderer<span class="type-signature"> :<a href="PIXI.CanvasRenderer.html">PIXI.CanvasRenderer</a>|<a href="PIXI.WebGLRenderer.html">PIXI.WebGLRenderer</a></span></h4> </dt> <dd> <div class="description"> <p>The renderer this RenderTexture uses. A RenderTexture can only belong to one renderer at the moment if its webGL.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="PIXI.CanvasRenderer.html">PIXI.CanvasRenderer</a></span> | <span class="param-type"><a href="PIXI.WebGLRenderer.html">PIXI.WebGLRenderer</a></span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="PIXI.RenderTexture.html#renderer">PIXI.RenderTexture#renderer</a> </li></dd> <dt class="tag-source">Source - <a href="src_pixi_textures_RenderTexture.js.html">pixi/textures/RenderTexture.js</a>, <a href="src_pixi_textures_RenderTexture.js.html#sunlight-1-line-99">line 99</a> </dt> </dl> </dd> <dt> <h4 class="name " id="requiresReTint"><span class="type-signature"></span>requiresReTint<span class="type-signature"> :Boolean</span></h4> </dt> <dd> <div class="description"> <p>This will let a renderer know that a tinted parent has updated its texture.</p> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="PIXI.Texture.html#requiresReTint">PIXI.Texture#requiresReTint</a> </li></dd> <dt class="tag-source">Source - <a href="src_pixi_textures_Texture.js.html">pixi/textures/Texture.js</a>, <a href="src_pixi_textures_Texture.js.html#sunlight-1-line-100">line 100</a> </dt> </dl> </dd> <dt> <h4 class="name " id="requiresUpdate"><span class="type-signature"></span>requiresUpdate<span class="type-signature"> :Boolean</span></h4> </dt> <dd> <div class="description"> <p>This will let a renderer know that a texture has been updated (used mainly for webGL uv updates)</p> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="PIXI.Texture.html#requiresUpdate">PIXI.Texture#requiresUpdate</a> </li></dd> <dt class="tag-source">Source - <a href="src_pixi_textures_Texture.js.html">pixi/textures/Texture.js</a>, <a href="src_pixi_textures_Texture.js.html#sunlight-1-line-92">line 92</a> </dt> </dl> </dd> <dt> <h4 class="name " id="resolution"><span class="type-signature"></span>resolution<span class="type-signature"> :Number</span></h4> </dt> <dd> <div class="description"> <p>The Resolution of the texture.</p> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="PIXI.RenderTexture.html#resolution">PIXI.RenderTexture#resolution</a> </li></dd> <dt class="tag-source">Source - <a href="src_pixi_textures_RenderTexture.js.html">pixi/textures/RenderTexture.js</a>, <a href="src_pixi_textures_RenderTexture.js.html#sunlight-1-line-53">line 53</a> </dt> </dl> </dd> <dt> <h4 class="name " id="smoothed"><span class="type-signature"></span>smoothed<span class="type-signature"> :boolean</span></h4> </dt> <dd> <div class="description"> <p>Sets if the stamp is smoothed or not.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-585">line 585</a> </dt> </dl> </dd> <dt> <h4 class="name " id="stamp"><span class="type-signature"><readonly> </span>stamp<span class="type-signature"> :<a href="Phaser.Image.html">Phaser.Image</a></span></h4> </dt> <dd> <div class="description"> <p>The image that is stamped to the RenderTexture for each character in the font.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-163">line 163</a> </dt> </dl> </dd> <dt> <h4 class="name " id="text"><span class="type-signature"></span>text<span class="type-signature"> :string</span></h4> </dt> <dd> <div class="description"> <p>Set this value to update the text in this sprite. Carriage returns are automatically stripped out if multiLine is false. Text is converted to upper case if autoUpperCase is true.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-547">line 547</a> </dt> </dl> </dd> <dt> <h4 class="name " id="trim"><span class="type-signature"></span>trim<span class="type-signature"> :Rectangle</span></h4> </dt> <dd> <div class="description"> <p>The texture trim data.</p> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="PIXI.Texture.html#trim">PIXI.Texture#trim</a> </li></dd> <dt class="tag-source">Source - <a href="src_pixi_textures_Texture.js.html">pixi/textures/Texture.js</a>, <a href="src_pixi_textures_Texture.js.html#sunlight-1-line-68">line 68</a> </dt> </dl> </dd> <dt> <h4 class="name " id="type"><span class="type-signature"></span>type<span class="type-signature"> :number</span></h4> </dt> <dd> <div class="description"> <p>Base Phaser object type.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-170">line 170</a> </dt> </dl> </dd> <dt> <h4 class="name " id="valid"><span class="type-signature"></span>valid<span class="type-signature"> :Boolean</span></h4> </dt> <dd> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="PIXI.RenderTexture.html#valid">PIXI.RenderTexture#valid</a> </li></dd> <dt class="tag-source">Source - <a href="src_pixi_textures_RenderTexture.js.html">pixi/textures/RenderTexture.js</a>, <a href="src_pixi_textures_RenderTexture.js.html#sunlight-1-line-125">line 125</a> </dt> </dl> </dd> <dt> <h4 class="name " id="width"><span class="type-signature"></span>width<span class="type-signature"> :Number</span></h4> </dt> <dd> <div class="description"> <p>The with of the render texture</p> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="PIXI.RenderTexture.html#width">PIXI.RenderTexture#width</a> </li></dd> <dt class="tag-source">Source - <a href="src_pixi_textures_RenderTexture.js.html">pixi/textures/RenderTexture.js</a>, <a href="src_pixi_textures_RenderTexture.js.html#sunlight-1-line-37">line 37</a> </dt> </dl> </dd> </dl> <h3 class="subsection-title">Methods</h3> <dl> <dt> <h4 class="name " id="buildRetroFontText"><span class="type-signature"></span>buildRetroFontText<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Updates the texture with the new text.</p> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-328">line 328</a> </dt> </dl> </dd> <dt> <h4 class="name " id="clear"><span class="type-signature"></span>clear<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Clears the RenderTexture.</p> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="PIXI.RenderTexture.html#clear">PIXI.RenderTexture#clear</a> </li></dd> <dt class="tag-source">Source - <a href="src_pixi_textures_RenderTexture.js.html">pixi/textures/RenderTexture.js</a>, <a href="src_pixi_textures_RenderTexture.js.html#sunlight-1-line-175">line 175</a> </dt> </dl> </dd> <dt> <h4 class="name " id="destroy"><span class="type-signature"></span>destroy<span class="signature">(destroyBase)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Destroys this texture</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>destroyBase</code></td> <td class="type"> <span class="param-type">Boolean</span> </td> <td class="description last"><p>Whether to destroy the base texture as well</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="PIXI.Texture.html#destroy">PIXI.Texture#destroy</a> </li></dd> <dt class="tag-source">Source - <a href="src_pixi_textures_Texture.js.html">pixi/textures/Texture.js</a>, <a href="src_pixi_textures_Texture.js.html#sunlight-1-line-170">line 170</a> </dt> </dl> </dd> <dt> <h4 class="name " id="getBase64"><span class="type-signature"></span>getBase64<span class="signature">()</span><span class="type-signature"> → {String}</span></h4> </dt> <dd> <div class="description"> <p>Will return a base64 encoded string of this texture. It works by calling RenderTexture.getCanvas and then running toDataURL on that.</p> </div> <h5>Returns:</h5> <div class="returns"> <div class="returns-type"> <span class="param-type">String</span> - </div> <div class="returns-desc param-desc"> <p>A base64 encoded string of the texture.</p> </div> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="PIXI.RenderTexture.html#getBase64">PIXI.RenderTexture#getBase64</a> </li></dd> <dt class="tag-source">Source - <a href="src_pixi_textures_RenderTexture.js.html">pixi/textures/RenderTexture.js</a>, <a href="src_pixi_textures_RenderTexture.js.html#sunlight-1-line-309">line 309</a> </dt> </dl> </dd> <dt> <h4 class="name " id="getCanvas"><span class="type-signature"></span>getCanvas<span class="signature">()</span><span class="type-signature"> → {HTMLCanvasElement}</span></h4> </dt> <dd> <div class="description"> <p>Creates a Canvas element, renders this RenderTexture to it and then returns it.</p> </div> <h5>Returns:</h5> <div class="returns"> <div class="returns-type"> <span class="param-type">HTMLCanvasElement</span> - </div> <div class="returns-desc param-desc"> <p>A Canvas element with the texture rendered on.</p> </div> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="PIXI.RenderTexture.html#getCanvas">PIXI.RenderTexture#getCanvas</a> </li></dd> <dt class="tag-source">Source - <a href="src_pixi_textures_RenderTexture.js.html">pixi/textures/RenderTexture.js</a>, <a href="src_pixi_textures_RenderTexture.js.html#sunlight-1-line-320">line 320</a> </dt> </dl> </dd> <dt> <h4 class="name " id="getImage"><span class="type-signature"></span>getImage<span class="signature">()</span><span class="type-signature"> → {Image}</span></h4> </dt> <dd> <div class="description"> <p>Will return a HTML Image of the texture</p> </div> <h5>Returns:</h5> <div class="returns"> <div class="returns-type"> <span class="param-type">Image</span> - </div> <div class="returns-desc param-desc"> </div> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="PIXI.RenderTexture.html#getImage">PIXI.RenderTexture#getImage</a> </li></dd> <dt class="tag-source">Source - <a href="src_pixi_textures_RenderTexture.js.html">pixi/textures/RenderTexture.js</a>, <a href="src_pixi_textures_RenderTexture.js.html#sunlight-1-line-296">line 296</a> </dt> </dl> </dd> <dt> <h4 class="name " id="getLongestLine"><span class="type-signature"></span>getLongestLine<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> </dt> <dd> <div class="description"> <p>Works out the longest line of text in _text and returns its length</p> </div> <h5>Returns:</h5> <div class="returns"> <div class="returns-type"> <span class="param-type">number</span> - </div> <div class="returns-desc param-desc"> <p>The length of the longest line of text.</p> </div> </div> <dl class="details"> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-459">line 459</a> </dt> </dl> </dd> <dt> <h4 class="name " id="pasteLine"><span class="type-signature"></span>pasteLine<span class="signature">(line, x, y, customSpacingX)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Internal function that takes a single line of text (2nd parameter) and pastes it into the BitmapData at the given coordinates. Used by getLine and getMultiLine</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>line</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"><p>The single line of text to paste.</p></td> </tr> <tr> <td class="name"><code>x</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The x coordinate.</p></td> </tr> <tr> <td class="name"><code>y</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The y coordinate.</p></td> </tr> <tr> <td class="name"><code>customSpacingX</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>Custom X spacing.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-420">line 420</a> </dt> </dl> </dd> <dt> <h4 class="name " id="removeUnsupportedCharacters"><span class="type-signature"><internal> </span>removeUnsupportedCharacters<span class="signature">(<span class="optional">stripCR</span>)</span><span class="type-signature"> → {string}</span></h4> </dt> <dd> <div class="description"> <p>Internal helper function that removes all unsupported characters from the _text String, leaving only characters contained in the font set.</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>stripCR</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> true </td> <td class="description last"><p>Should it strip carriage returns as well?</p></td> </tr> </tbody> </table> <h5>Returns:</h5> <div class="returns"> <div class="returns-type"> <span class="param-type">string</span> - </div> <div class="returns-desc param-desc"> <p>A clean version of the string.</p> </div> </div> <dl class="details"> <dt class="important tag-deprecated">Internal:</dt> <dd class="tag-deprecated"><ul> <li>This member is <em>internal (protected)</em> and may be modified or removed in the future.</li> </ul></dd> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-486">line 486</a> </dt> </dl> </dd> <dt> <h4 class="name " id="render"><span class="type-signature"></span>render<span class="signature">(displayObject, <span class="optional">matrix</span>, <span class="optional">clear</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>This function will draw the display object to the RenderTexture.</p> <p>In versions of Phaser prior to 2.4.0 the second parameter was a Phaser.Point object. This is now a Matrix allowing you much more control over how the Display Object is rendered. If you need to replicate the earlier behavior please use Phaser.RenderTexture.renderXY instead.</p> <p>If you wish for the displayObject to be rendered taking its current scale, rotation and translation into account then either pass <code>null</code>, leave it undefined or pass <code>displayObject.worldTransform</code> as the matrix value.</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>displayObject</code></td> <td class="type"> <span class="param-type"><a href="Phaser.Sprite.html">Phaser.Sprite</a></span> | <span class="param-type"><a href="Phaser.Image.html">Phaser.Image</a></span> | <span class="param-type"><a href="Phaser.Text.html">Phaser.Text</a></span> | <span class="param-type"><a href="Phaser.BitmapText.html">Phaser.BitmapText</a></span> | <span class="param-type"><a href="Phaser.Group.html">Phaser.Group</a></span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The display object to render to this texture.</p></td> </tr> <tr> <td class="name"><code>matrix</code></td> <td class="type"> <span class="param-type"><a href="Phaser.Matrix.html">Phaser.Matrix</a></span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"><p>Optional matrix to apply to the display object before rendering. If null or undefined it will use the worldTransform matrix of the given display object.</p></td> </tr> <tr> <td class="name"><code>clear</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p>If true the texture will be cleared before the display object is drawn.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="Phaser.RenderTexture.html#render">Phaser.RenderTexture#render</a> </li></dd> <dt class="tag-source">Source - <a href="src_gameobjects_RenderTexture.js.html">gameobjects/RenderTexture.js</a>, <a href="src_gameobjects_RenderTexture.js.html#sunlight-1-line-118">line 118</a> </dt> </dl> </dd> <dt> <h4 class="name " id="renderRawXY"><span class="type-signature"></span>renderRawXY<span class="signature">(displayObject, x, y, <span class="optional">clear</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>This function will draw the display object to the RenderTexture at the given coordinates.</p> <p>When the display object is drawn it doesn't take into account scale, rotation or translation.</p> <p>If you need those then use RenderTexture.renderXY instead.</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>displayObject</code></td> <td class="type"> <span class="param-type"><a href="Phaser.Sprite.html">Phaser.Sprite</a></span> | <span class="param-type"><a href="Phaser.Image.html">Phaser.Image</a></span> | <span class="param-type"><a href="Phaser.Text.html">Phaser.Text</a></span> | <span class="param-type"><a href="Phaser.BitmapText.html">Phaser.BitmapText</a></span> | <span class="param-type"><a href="Phaser.Group.html">Phaser.Group</a></span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The display object to render to this texture.</p></td> </tr> <tr> <td class="name"><code>x</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The x position to render the object at.</p></td> </tr> <tr> <td class="name"><code>y</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The y position to render the object at.</p></td> </tr> <tr> <td class="name"><code>clear</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p>If true the texture will be cleared before the display object is drawn.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="Phaser.RenderTexture.html#renderRawXY">Phaser.RenderTexture#renderRawXY</a> </li></dd> <dt class="tag-source">Source - <a href="src_gameobjects_RenderTexture.js.html">gameobjects/RenderTexture.js</a>, <a href="src_gameobjects_RenderTexture.js.html#sunlight-1-line-90">line 90</a> </dt> </dl> </dd> <dt> <h4 class="name " id="renderXY"><span class="type-signature"></span>renderXY<span class="signature">(displayObject, x, y, <span class="optional">clear</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>This function will draw the display object to the RenderTexture at the given coordinates.</p> <p>When the display object is drawn it takes into account scale and rotation.</p> <p>If you don't want those then use RenderTexture.renderRawXY instead.</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>displayObject</code></td> <td class="type"> <span class="param-type"><a href="Phaser.Sprite.html">Phaser.Sprite</a></span> | <span class="param-type"><a href="Phaser.Image.html">Phaser.Image</a></span> | <span class="param-type"><a href="Phaser.Text.html">Phaser.Text</a></span> | <span class="param-type"><a href="Phaser.BitmapText.html">Phaser.BitmapText</a></span> | <span class="param-type"><a href="Phaser.Group.html">Phaser.Group</a></span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The display object to render to this texture.</p></td> </tr> <tr> <td class="name"><code>x</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The x position to render the object at.</p></td> </tr> <tr> <td class="name"><code>y</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The y position to render the object at.</p></td> </tr> <tr> <td class="name"><code>clear</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p>If true the texture will be cleared before the display object is drawn.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="Phaser.RenderTexture.html#renderXY">Phaser.RenderTexture#renderXY</a> </li></dd> <dt class="tag-source">Source - <a href="src_gameobjects_RenderTexture.js.html">gameobjects/RenderTexture.js</a>, <a href="src_gameobjects_RenderTexture.js.html#sunlight-1-line-58">line 58</a> </dt> </dl> </dd> <dt> <h4 class="name " id="resize"><span class="type-signature"></span>resize<span class="signature">(width, height, updateBase)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Resizes the RenderTexture.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>width</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last"><p>The width to resize to.</p></td> </tr> <tr> <td class="name"><code>height</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last"><p>The height to resize to.</p></td> </tr> <tr> <td class="name"><code>updateBase</code></td> <td class="type"> <span class="param-type">Boolean</span> </td> <td class="description last"><p>Should the baseTexture.width and height values be resized as well?</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="PIXI.RenderTexture.html#resize">PIXI.RenderTexture#resize</a> </li></dd> <dt class="tag-source">Source - <a href="src_pixi_textures_RenderTexture.js.html">pixi/textures/RenderTexture.js</a>, <a href="src_pixi_textures_RenderTexture.js.html#sunlight-1-line-139">line 139</a> </dt> </dl> </dd> <dt> <h4 class="name " id="setFixedWidth"><span class="type-signature"></span>setFixedWidth<span class="signature">(width, <span class="optional">lineAlignment</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>If you need this RetroFont to have a fixed width and custom alignment you can set the width here. If text is wider than the width specified it will be cropped off.</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>width</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>Width in pixels of this RetroFont. Set to zero to disable and re-enable automatic resizing.</p></td> </tr> <tr> <td class="name"><code>lineAlignment</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 'left' </td> <td class="description last"><p>Align the text within this width. Set to RetroFont.ALIGN_LEFT (default), RetroFont.ALIGN_RIGHT or RetroFont.ALIGN_CENTER.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-275">line 275</a> </dt> </dl> </dd> <dt> <h4 class="name " id="setFrame"><span class="type-signature"></span>setFrame<span class="signature">(frame)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Specifies the region of the baseTexture that this texture will use.</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>frame</code></td> <td class="type"> <span class="param-type">Rectangle</span> </td> <td class="description last"><p>The frame of the texture to set it to</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="PIXI.Texture.html#setFrame">PIXI.Texture#setFrame</a> </li></dd> <dt class="tag-source">Source - <a href="src_pixi_textures_Texture.js.html">pixi/textures/Texture.js</a>, <a href="src_pixi_textures_Texture.js.html#sunlight-1-line-183">line 183</a> </dt> </dl> </dd> <dt> <h4 class="name " id="setText"><span class="type-signature"></span>setText<span class="signature">(content, <span class="optional">multiLine</span>, <span class="optional">characterSpacing</span>, <span class="optional">lineSpacing</span>, <span class="optional">lineAlignment</span>, <span class="optional">allowLowerCase</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>A helper function that quickly sets lots of variables at once, and then updates the text.</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>content</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The text of this sprite.</p></td> </tr> <tr> <td class="name"><code>multiLine</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p>Set to true if you want to support carriage-returns in the text and create a multi-line sprite instead of a single line.</p></td> </tr> <tr> <td class="name"><code>characterSpacing</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 0 </td> <td class="description last"><p>To add horizontal spacing between each character specify the amount in pixels.</p></td> </tr> <tr> <td class="name"><code>lineSpacing</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 0 </td> <td class="description last"><p>To add vertical spacing between each line of text, set the amount in pixels.</p></td> </tr> <tr> <td class="name"><code>lineAlignment</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 'left' </td> <td class="description last"><p>Align each line of multi-line text. Set to RetroFont.ALIGN_LEFT, RetroFont.ALIGN_RIGHT or RetroFont.ALIGN_CENTER.</p></td> </tr> <tr> <td class="name"><code>allowLowerCase</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p>Lots of bitmap font sets only include upper-case characters, if yours needs to support lower case then set this to true.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-293">line 293</a> </dt> </dl> </dd> <dt> <h4 class="name " id="updateOffset"><span class="type-signature"></span>updateOffset<span class="signature">(<span class="optional">xOffset</span>, <span class="optional">yOffset</span>)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Updates the x and/or y offset that the font is rendered from. This updates all of the texture frames, so be careful how often it is called. Note that the values given for the x and y properties are either ADDED to or SUBTRACTED from (if negative) the existing offsetX/Y values of the characters. So if the current offsetY is 8 and you want it to start rendering from y16 you would call updateOffset(0, 8) to add 8 to the current y offset.</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>xOffset</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 0 </td> <td class="description last"><p>If the font set doesn't start at the top left of the given image, specify the X coordinate offset here.</p></td> </tr> <tr> <td class="name"><code>yOffset</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 0 </td> <td class="description last"><p>If the font set doesn't start at the top left of the given image, specify the Y coordinate offset here.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source - <a href="src_gameobjects_RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="src_gameobjects_RetroFont.js.html#sunlight-1-line-514">line 514</a> </dt> </dl> </dd> </dl> </article> </section> </div> <div class="clearfix"></div> <footer> <span class="copyright"> Phaser Copyright © 2012-2016 Photon Storm Ltd. </span> <br /> <span class="jsdoc-message"> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Thu May 19 2016 12:35:45 GMT+0100 (GMT Daylight Time) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>. </span> </footer> </div> <div class="span3"> <div id="toc"></div> </div> <br clear="both"> </div> </div> <script src="scripts/sunlight.js"></script> <script src="scripts/sunlight.javascript.js"></script> <script src="scripts/sunlight-plugin.doclinks.js"></script> <script src="scripts/sunlight-plugin.linenumbers.js"></script> <script src="scripts/sunlight-plugin.menu.js"></script> <script src="scripts/jquery.min.js"></script> <script src="scripts/jquery.scrollTo.js"></script> <script src="scripts/jquery.localScroll.js"></script> <script src="scripts/bootstrap-dropdown.js"></script> <script src="scripts/toc.js"></script> <script> Sunlight.highlightAll({lineNumbers:true, showMenu: true, enableDoclinks :true}); </script> <script> $( function () { $( "#toc" ).toc( { anchorName : function(i, heading, prefix) { return $(heading).attr("id") || ( prefix + i ); }, 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>