Skip to content

BBCode Text Object Reference

A BBText is an object displaying on the screen a rich text formatted using BBCode markup (allowing to set parts of the text as bold, italic, use different colors and shadows). Read more explanations about it.

BBText

Displays a rich text label using BBCode markup (allowing to set parts of the text as bold, italic, use different colors and shadows).

Object properties

  • Base alignment (choice, one of: "left", "center", "right"). Default value is left.
  • Base color (🎨 Color). Default value is 0;0;0.
  • Font (🗂️ Resource). Default value is Arial.
  • Base size (🔢 Number). Default value is 20.
  • BBCode text (🔤 Multiline text (String)). Default value is [b]bold[/b] [i]italic[/i] [size=15]smaller[/size] [font=times]times[/font] font [spacing=12]spaced out[/spacing] [outline=yellow]outlined[/outline] [shadow=red]DropShadow[/shadow].
  • Vertical alignment (choice, one of: "top", "center", "bottom"). Default value is top.
  • Visible on start (🔘 Boolean). Default value is true.
See internal technical details
  • Base alignment is stored as align (choice). Default value is left.
  • Base color is stored as color (color). Default value is 0;0;0.
  • Font is stored as fontFamily (resource). Default value is Arial.
  • Base size is stored as fontSize (number). Default value is 20.
  • BBCode text is stored as text (multilinestring). Default value is `[b]bold[/b] [i]italic[/i] [size=15]smaller[/size] [font=times]times[/font] font

[spacing=12]spaced out[/spacing] [outline=yellow]outlined[/outline] [shadow=red]DropShadow[/shadow] . - **Vertical alignment** is stored asverticalTextAlignment(choice). Default value istop. - **Visible on start** is stored asvisible(boolean). Default value istrue`.

Object actions

Alignment
Change the alignment of the text.

See parameters & details
  • Parameter 0 (👾 Object): BBText
  • Parameter 1: 🟰 Operator
  • Parameter 2 (🔤 String): Alignment (one of: "left", "right", "center")

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

BBCode text
Set BBCode text

See parameters & details
  • Parameter 0 (👾 Object): BBText
  • Parameter 1: 🟰 Operator
  • Parameter 2 (🔤 String): Text

Technical note: this action internal type (in GDevelop JSON) is BBText::SetBBText.

Color
Set base color

See parameters & details
  • Parameter 0 (👾 Object): BBText
  • Parameter 1 (🎨 Color): Color (R;G;B)

Technical note: this action internal type (in GDevelop JSON) is BBText::SetColor.

Font family
Set font family

See parameters & details
  • Parameter 0 (👾 Object): BBText
  • Parameter 1 (fontResource): Font family

Technical note: this action internal type (in GDevelop JSON) is BBText::SetFontFamily2.

Font size
Set base font size

See parameters & details
  • Parameter 0 (👾 Object): BBText
  • Parameter 1: 🟰 Operator
  • Parameter 2 (🔢 Number): Font size

Technical note: this action internal type (in GDevelop JSON) is BBText::SetFontSize.

Word wrapping
De/activate word wrapping.

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

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

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

See parameters & details
  • Parameter 0 (👾 Object): BBText
  • Parameter 1: 🟰 Operator
  • Parameter 2 (🔢 Number): Wrapping width

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

Object conditions

Alignment
Check the current text alignment.

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

Technical note: this condition internal type (in GDevelop JSON) is BBText::IsAlignment.

BBCode text
Compare the value of the BBCode text.

See parameters & details
  • Parameter 0 (👾 Object): BBText
  • Parameter 1: 🟰 Relational operator
  • Parameter 2 (🔤 String): Text

Technical note: this condition internal type (in GDevelop JSON) is BBText::IsBBText.

Font family
Compare the value of font family

See parameters & details
  • Parameter 0 (👾 Object): BBText
  • Parameter 1: 🟰 Relational operator
  • Parameter 2 (🔤 String): Font family

Technical note: this condition internal type (in GDevelop JSON) is BBText::IsFontFamily.

Font size
Compare the base font size of the text.

See parameters & details
  • Parameter 0 (👾 Object): BBText
  • Parameter 1: 🟰 Relational operator
  • Parameter 2 (🔢 Number): Font size

Technical note: this condition internal type (in GDevelop JSON) is BBText::IsFontSize.

Word wrapping
Check if word wrapping is enabled.

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

Technical note: this condition internal type (in GDevelop JSON) is BBText::IsWordWrap.

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

See parameters & details
  • Parameter 0 (👾 Object): BBText
  • Parameter 1: 🟰 Relational operator
  • Parameter 2 (🔢 Number): Wrapping width

Technical note: this condition internal type (in GDevelop JSON) is BBText::IsWrappingWidth.

Object expressions

Expression Description
Object.GetAlignment() Get the text alignment
Object.GetBBText() Get BBCode text
Object.GetFontFamily() Get the base font family
Object.GetFontSize() Get the base font size
Object.GetWrappingWidth() Get the wrapping width

The BBCode Text Object 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 BBCode Text Object feature of GDevelop, the open-source, AI-powered, cross-platform game engine designed for everyone. Learn more about all GDevelop features here.