CPFIGLetFont

org.cosplay.CPFIGLetFont

See theCPFIGLetFont companion object

class CPFIGLetFont(flfPath: String) extends CPFont

FIGLet fonts allow creating art text out of ordinary letters, for example:

 /$$$$$$                      /$$$$$$$  /$$
/$$__  $$                    | $$__  $$| $$
| $$  \__/  /$$$$$$   /$$$$$$$| $$  \ $$| $$  /$$$$$$  /$$   /$$
| $$       /$$__  $$ /$$_____/| $$$$$$$/| $$ |____  $$| $$  | $$
| $$      | $$  \ $$|  $$$$$$ | $$____/ | $$  /$$$$$$$| $$  | $$
| $$    $$| $$  | $$ \____  $$| $$      | $$ /$$__  $$| $$  | $$
|  $$$$$$/|  $$$$$$/ /$$$$$$$/| $$      | $$|  $$$$$$$|  $$$$$$$
\______/  \______/ |_______/ |__/      |__/ \_______/ \____  $$
  ___  _____  ___  ____  __      __   _  _            /$$  | $$
 / __)(  _  )/ __)(  _ \(  )    /__\ ( \/ )          |  $$$$$$/
( (__  )(_)( \__ \ )___/ )(__  /(__)\ \  /            \______/
 \___)(_____)(___/(__)  (____)(__)(__)(__)
                                       ,,
 .g8"""bgd                 `7MM"""Mq.`7MM
.dP'     `M                   MM   `MM. MM
dM'       ` ,pW"Wq.  ,pP"Ybd  MM   ,M9  MM   ,6"Yb.`7M'   `MF'
MM         6W'   `Wb 8I   `"  MMmmdM9   MM  8)   MM  VA   ,V
MM.        8M     M8 `YMMMa.  MM        MM   ,pm9MM   VA ,V
`Mb.     ,'YA.   ,A9 L.   I8  MM        MM  8M   MM    VVV
 `"bmmmd'  `Ybmd9'  M9mmmP'.JMML.    .JMML.`Moo9^Yo.  ,V
                                                     ,V
                                                  OOb"

You can read the full FIGLet specification here. This class provides relatively full implementation for FIGLet fonts with the following limitations:

code tags are NOT supported
only UTF-8 and windows-1252 charsets are supported
only left-to-right font direction is supported
vertical smushing iS NOT supported (ignored)

CosPlay comes with 277 built-in pre-packaged FIGLet fonts. Companion object for this class contains constants for all these fonts.

Here's an example of rendering FIGLet fonts using static image sprites. Note that when invoking render it returns an image that can be rendered or used just like any other image in CosPlay:

val spr1 = CPStaticImageSprite(30, 14, 4, FIG_OGRE.render("CosPlay", C_WHITE).trimBg())
val spr1 = CPStaticImageSprite(30, 20, 4, FIG_OGRE.withKerning().render("CosPlay", C_LIGHT_STEEL_BLUE).trimBg())
val spr1 = CPStaticImageSprite(30, 27, 4, FIG_OGRE.withFullWidth().render("CosPlay", C_LIGHT_CORAL).trimBg())

Here's the list of helpful links when working with FIGLet fonts:

http://www.figlet.org - Linux/Unix FIGLet utility.
http://www.jave.de/figlet/figfont.html - full specification for FIGLet font.
https://patorjk.com/software/taag - convenient online tester for various FIGLet fonts.

Attributes

Example: See CPFontsExample source code for an example of FIGLet font functionality.
Companion: object
Source: CPFIGLetFont.scala
Graph
Supertypes: class CPFont

trait CPAsset

class CPGameObject

class Object

trait Matchable

class Any
Show all

Members list

Type members

Classlikes

Attributes

Source: CPFIGLetFont.scala
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value members

Concrete methods

Gets baseline of this font in standard character.

Attributes

Definition Classes: CPFont
Source: CPFIGLetFont.scala

Gets encoding used by this font. Note that for the system font it returns "UTF-8".

Attributes

Definition Classes: CPFont
Source: CPFIGLetFont.scala

Gets height of this font in standard characters.

Attributes

Definition Classes: CPFont
Source: CPFIGLetFont.scala

Gets width of this font in standard characters.

Attributes

Definition Classes: CPFont
Source: CPFIGLetFont.scala

Whether or not this is a "standard" 1-character height system font.

Attributes

Definition Classes: CPFont
Source: CPFIGLetFont.scala

Renders single line text as an image with this font.

Attributes

Definition Classes: CPFont
Source: CPFIGLetFont.scala

Clones this font with controlled smushing.

Attributes

See also: http://www.jave.de/figlet/figfont.html for FIGLet specification for details.

https://patorjk.com/software/taag for convenient online tester for various FIGLet fonts and their properties.
Source: CPFIGLetFont.scala

Clones this font with full width

Attributes

See also: http://www.jave.de/figlet/figfont.html for FIGLet specification for details.

https://patorjk.com/software/taag for convenient online tester for various FIGLet fonts and their properties.
Source: CPFIGLetFont.scala

Clones this font with kerning fitting.

Attributes

See also: http://www.jave.de/figlet/figfont.html for FIGLet specification for details.

https://patorjk.com/software/taag for convenient online tester for various FIGLet fonts and their properties.
Source: CPFIGLetFont.scala

Clones this font with universal smushing.

Attributes

See also: http://www.jave.de/figlet/figfont.html for FIGLet specification for details.

https://patorjk.com/software/taag for convenient online tester for various FIGLet fonts and their properties.
Source: CPFIGLetFont.scala

Inherited methods

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

It is reflexive: for any instance x of type Any, x.equals(x) should return true.
It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters

that: the object to compare against this object for equality.

Attributes

Returns: true if the receiver object is equivalent to the argument; false otherwise.
Definition Classes: CPGameObject -> Any
Inherited from:: CPGameObject
Source: CPGameObject.scala

Gets unique ID of this game object.

Attributes

Inherited from:: CPGameObject
Source: CPGameObject.scala

Gets optional set of organizational tags. Note that by default the set of tags is empty.

Attributes

See also: CPSceneObjectContext.getObjectsForTags
Inherited from:: CPGameObject
Source: CPGameObject.scala

Renders given multiline text as an image. Supplied string will be split by system-specific "new line' character sequence ('\n' or '\n\r'). This call is equivalent to:

renderSeq(s.split(CPUtils.NL).filter(!_.isBlank).toSeq, fg, bg, align)

Value parameters

align

Alignment of text. The only allowed values are:

-1 - left justified alignment.
0 - centered alignment.
1 - right justified alignment. Default value is 0.

bg

Optional background color to use. Default value is None.

fg

Foreground color to use.

s

Multiline text to render as an image. Must be non-empty.

Attributes

Returns: Image as a rendering of the given string with this font.
Inherited from:: CPFont
Source: CPFont.scala

Renders given multiline text as an image.

Value parameters

align

Alignment of text. The only allowed values are:

-1 - left justified alignment.
0 - centered alignment.
1 - right justified alignment. Default value is 0.

bg

Optional background color to use. Default value is None.

fg

Foreground color to use.

ss

Sequence of text lines to render as an image. Must be non-empty.

Attributes

Returns: Image as a rendering of the given string with this font.
Inherited from:: CPFont
Source: CPFont.scala

Inherited fields

Gets the origin of this asset. Typically, this should be a URL, file name or class name for in-code assets like array images, animations or system font.

Attributes

Inherited from:: CPFont
Source: CPFont.scala

In this article

Generated with