phaser

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Phaser Class: RetroFont</title>  <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 "> <li class="class-depth-0"> <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 "> <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.ArrayList.html">ArrayList</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-1"> <a href="Phaser.Device.html">Device</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.GamepadButton.html">GamepadButton</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.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.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-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.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.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.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.World.html">World</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> <div class="class-description"><p>Phaser.RetroFont</p></div> </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:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="RetroFont.js.html#sunlight-1-line-25">line 25</a> </li></ul></dd> </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> <h5>Type:</h5> <ul> <li> <span class="param-type">string</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="RetroFont.js.html#sunlight-1-line-205">line 205</a> </li></ul></dd> </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> <h5>Type:</h5> <ul> <li> <span class="param-type">string</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="RetroFont.js.html#sunlight-1-line-191">line 191</a> </li></ul></dd> </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> <h5>Type:</h5> <ul> <li> <span class="param-type">string</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="RetroFont.js.html#sunlight-1-line-198">line 198</a> </li></ul></dd> </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> <h5>Type:</h5> <ul> <li> <span class="param-type">string</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="RetroFont.js.html#sunlight-1-line-212">line 212</a> </li></ul></dd> </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> <h5>Type:</h5> <ul> <li> <span class="param-type">string</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="RetroFont.js.html#sunlight-1-line-219">line 219</a> </li></ul></dd> </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> <h5>Type:</h5> <ul> <li> <span class="param-type">string</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="RetroFont.js.html#sunlight-1-line-226">line 226</a> </li></ul></dd> </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> <h5>Type:</h5> <ul> <li> <span class="param-type">string</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="RetroFont.js.html#sunlight-1-line-233">line 233</a> </li></ul></dd> </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> <h5>Type:</h5> <ul> <li> <span class="param-type">string</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="RetroFont.js.html#sunlight-1-line-240">line 240</a> </li></ul></dd> </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> <h5>Type:</h5> <ul> <li> <span class="param-type">string</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="RetroFont.js.html#sunlight-1-line-247">line 247</a> </li></ul></dd> </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> <h5>Type:</h5> <ul> <li> <span class="param-type">string</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="RetroFont.js.html#sunlight-1-line-254">line 254</a> </li></ul></dd> </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> <h5>Type:</h5> <ul> <li> <span class="param-type">string</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="RetroFont.js.html#sunlight-1-line-261">line 261</a> </li></ul></dd> </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> <h5>Type:</h5> <ul> <li> <span class="param-type">string</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="RetroFont.js.html#sunlight-1-line-268">line 268</a> </li></ul></dd> </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> <h5>Type:</h5> <ul> <li> <span class="param-type">string</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="RetroFont.js.html#sunlight-1-line-275">line 275</a> </li></ul></dd> </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> <h5>Type:</h5> <ul> <li> <span class="param-type">string</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="RetroFont.js.html#sunlight-1-line-282">line 282</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="align"><span class="type-signature"></span>align<span class="type-signature"></span></h4> </dt> <dd> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>align</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"><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></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="RetroFont.js.html#sunlight-1-line-77">line 77</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="autoUpperCase"><span class="type-signature"></span>autoUpperCase<span class="type-signature"></span></h4> </dt> <dd> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>autoUpperCase</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last"><p>Automatically convert any text to upper case. Lots of old bitmap fonts only contain upper-case characters, so the default is true.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>true</li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="RetroFont.js.html#sunlight-1-line-89">line 89</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="characterHeight"><span class="type-signature"></span>characterHeight<span class="type-signature"></span></h4> </dt> <dd> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>characterHeight</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The height of each character in the font set.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="RetroFont.js.html#sunlight-1-line-45">line 45</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="characterPerRow"><span class="type-signature"></span>characterPerRow<span class="type-signature"></span></h4> </dt> <dd> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>characterPerRow</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The number of characters per row in the font set.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="RetroFont.js.html#sunlight-1-line-60">line 60</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="characterSpacingX"><span class="type-signature"></span>characterSpacingX<span class="type-signature"></span></h4> </dt> <dd> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>characterSpacingX</code></td> <td class="type"> <span class="param-type">number</span> </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> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="RetroFont.js.html#sunlight-1-line-50">line 50</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="characterSpacingY"><span class="type-signature"></span>characterSpacingY<span class="type-signature"></span></h4> </dt> <dd> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>characterSpacingY</code></td> <td class="type"> <span class="param-type">number</span> </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> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="RetroFont.js.html#sunlight-1-line-55">line 55</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="characterWidth"><span class="type-signature"></span>characterWidth<span class="type-signature"></span></h4> </dt> <dd> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>characterWidth</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>The width of each character in the font set.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="RetroFont.js.html#sunlight-1-line-40">line 40</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="customSpacingX"><span class="type-signature"></span>customSpacingX<span class="type-signature"></span></h4> </dt> <dd> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>customSpacingX</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>Adds horizontal spacing between each character of the font, in pixels.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>0</li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="RetroFont.js.html#sunlight-1-line-95">line 95</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="customSpacingY"><span class="type-signature"></span>customSpacingY<span class="type-signature"></span></h4> </dt> <dd> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>customSpacingY</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>Adds vertical spacing between each line of multi-line text, set in pixels.</p></td> </tr> </tbody> </table> </dl> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"><li>0</li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="RetroFont.js.html">gameobjects/RetroFont.js</a>, <a href="RetroFont.js.html#sunlight-1-line-101">line 101</a> </li></ul></dd> </dl> </dd> <dt> <h4 class="name" id="fixedWidth"><span class="type-signature"></span>fixedWidth<span class="type-signature"></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">