Skip to content

Bitmap Text Reference

Displays a text using a "Bitmap Font" (an image representing characters). This is more performant than a traditional Text object and it allows for complete control on the characters aesthetic. Read more explanations about it.

Bitmap Text

Displays a text using a "Bitmap Font" (an image representing characters). This is more performant than a traditional Text object and it allows for complete control on the characters aesthetic.

Object properties

  • Alignment (choice, one of: "left", "center", "right"). Default value is left.
  • Bitmap Font (🗂️ Resource).
  • Text scale (🔢 Number). Default value is 1.
  • Text (🔤 Multiline text (String)). Default value is This text use the default bitmap font. Use a custom Bitmap Font to create your own texts..
  • Bitmap Atlas (🗂️ Resource).
  • Font tint (🎨 Color). Default value is 255;255;255.
  • Vertical alignment (choice, one of: "top", "center", "bottom"). Default value is top.
See internal technical details
  • Alignment is stored as align (choice). Default value is left.
  • Bitmap Font is stored as bitmapFontResourceName (resource). Default value is ``.
  • Text scale is stored as scale (number). Default value is 1.
  • Text is stored as text (multilinestring). Default value is `This text use the default bitmap font.

Use a custom Bitmap Font to create your own texts.. - **Bitmap Atlas** is stored astextureAtlasResourceName(resource). Default value is ``. - **Font tint** is stored astint(color). Default value is255;255;255. - **Vertical alignment** is stored asverticalTextAlignment(choice). Default value istop`.

Object actions

Wrapping width
Change the width, in pixels, after which the text is wrapped on next line.

See parameters & details
  • Parameter 0 (👾 Object): Bitmap text
  • Parameter 1: 🟰 Operator
  • Parameter 2 (🔢 Number): Value

Technical note: this action internal type (in GDevelop JSON) is BitmapText::BitmapTextObject::SetWrappingWidth.

Alignment
Change the alignment of a Bitmap text object.

See parameters & details
  • Parameter 0 (👾 Object): Bitmap text
  • Parameter 1 (🔤 String): Alignment (one of: "left", "center", "right")

Technical note: this action internal type (in GDevelop JSON) is BitmapText::SetAlignment.

Bitmap files resources
Change the Bitmap Font and/or the atlas image used by the object.

See parameters & details
  • Parameter 0 (👾 Object): Bitmap text
  • Parameter 1 (bitmapFontResource): Bitmap font resource name
  • Parameter 2 (imageResource): Texture atlas resource name

Technical note: this action internal type (in GDevelop JSON) is BitmapText::SetBitmapFontAndTextureAtlasResourceName2.

Tint
Set the tint of the Bitmap Text object.

See parameters & details
  • Parameter 0 (👾 Object): Bitmap text
  • Parameter 1: 🎨 Color

Technical note: this action internal type (in GDevelop JSON) is BitmapText::SetTint.

Word wrapping
De/activate word wrapping.

See parameters & details
  • Parameter 0 (👾 Object): Bitmap text
  • Parameter 1 (❓ Yes or No): Activate word wrapping

Technical note: this action internal type (in GDevelop JSON) is BitmapText::SetWordWrap.

Object conditions

Alignment
Compare the text alignment.

See parameters & details
  • Parameter 0 (👾 Object): Bitmap text
  • Parameter 1: 🟰 Relational operator
  • Parameter 2 (🔤 String): Alignment ("left", "right" or "center")

Technical note: this condition internal type (in GDevelop JSON) is BitmapText::BitmapTextObject::Alignment.

Font name
Compare the font name (defined in the Bitmap font).

See parameters & details
  • Parameter 0 (👾 Object): Bitmap text
  • Parameter 1: 🟰 Relational operator
  • Parameter 2 (🔤 String): Value to compare

Technical note: this condition internal type (in GDevelop JSON) is BitmapText::BitmapTextObject::FontName.

Font size
Compare the font size, defined in the Bitmap Font.

See parameters & details
  • Parameter 0 (👾 Object): Bitmap text
  • Parameter 1: 🟰 Relational operator
  • Parameter 2 (🔢 Number): Value to compare

Technical note: this condition internal type (in GDevelop JSON) is BitmapText::BitmapTextObject::FontSize.

Wrapping width
Compare the width, in pixels, after which the text is wrapped on next line.

See parameters & details
  • Parameter 0 (👾 Object): Bitmap text
  • Parameter 1: 🟰 Relational operator
  • Parameter 2 (🔢 Number): Value to compare

Technical note: this condition internal type (in GDevelop JSON) is BitmapText::BitmapTextObject::WrappingWidth.

Word wrapping
Check if word wrapping is enabled.

See parameters & details
  • Parameter 0 (👾 Object): Bitmap text

Technical note: this condition internal type (in GDevelop JSON) is BitmapText::WordWrap.

Object expressions

Expression Description
Object.Alignment() Return the text alignment.
Object.FontName() Return the font name (defined in the Bitmap font).
Object.FontSize() Return the font size, defined in the Bitmap Font.
Object.Text() Return the text.
Object.WrappingWidth() Return the width, in pixels, after which the text is wrapped on next line.

The Bitmap Text extension is always installed in all GDevelop projects: there is no need to add it from the Project Manager.

This page is an auto-generated reference page about the Bitmap Text feature of GDevelop, the open-source, AI-powered, cross-platform game engine designed for everyone. Learn more about all GDevelop features here.