CPFont
Font descriptor.
Font is an asset. Just like other assets such as images, sounds, animations or videos they are not managed or governed by the CosPlay game engine unlike scenes and scene objects that are managed and governed by the game engine. Assets are typically created outside the game loop and managed by the developer, they can be freely shared between scenes or scene objects as any other standard Scala objects.
CosPlay comes with a full support for FIGLet fonts as well as standard "system" font , all of which implement this interface. In other words, there's no difference whether you are drawing with a system (1-character height) font or a FIGLet font.
Attributes
- See also
-
CPFIGLetFont FIGLet fonts.
CPSystemFont System font.
CPStyledString Styled string using system font.
CPCanvas.drawStyledString Canvas drawing using system font or styled strings.
- Example
-
See CPFontsExample source code for an example of font functionality.
- Source
- CPFont.scala
- Graph
-
- Supertypes
- Known subtypes
-
class CPFIGLetFontobject CPSystemFont.type
Members list
Value members
Abstract methods
Gets baseline of this font in standard character.
Gets encoding used by this font. Note that for the system font it returns "UTF-8".
Gets encoding used by this font. Note that for the system font it returns "UTF-8".
Attributes
- Source
- CPFont.scala
Gets height of this font in standard characters.
Gets width of this font in standard characters.
Whether or not this is a "standard" 1-character height system font.
Renders single line text as an image with this font.
Renders single line text as an image with this font.
Value parameters
- bg
-
Optional background color to use. Default value is
None. - fg
-
Foreground color to use.
- s
-
Text to render. Must be non-empty.
Attributes
- Returns
-
Image as a rendering of the given single line text with this font.
- Source
- CPFont.scala
Concrete methods
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:
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 is0.
- 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.
- Source
- CPFont.scala
Renders given multiline text as an image.
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 is0.
- 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.
- Source
- CPFont.scala
Inherited methods
Compares the receiver object (this) with the argument object (that) for equivalence.
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
xof typeAny,x.equals(x)should returntrue. - It is symmetric: for any instances
xandyof typeAny,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any instances
x,y, andzof typeAnyifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue.
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
-
trueif the receiver object is equivalent to the argument;falseotherwise. - Definition Classes
-
CPGameObject -> Any
- Inherited from:
- CPGameObject
- Source
- CPGameObject.scala
Gets unique ID of this game object.
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.
Gets optional set of organizational tags. Note that by default the set of tags is empty.
Attributes
- See also
- Inherited from:
- CPGameObject
- Source
- CPGameObject.scala
Concrete 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.
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
- Source
- CPFont.scala