Font

    Inherited By: , DynamicFont

    Internationalized font and text drawing support.

    Font contains a Unicode-compatible character set, as well as the ability to draw it with variable width, ascent, descent and kerning. For creating fonts from TTF files (or other font formats), see the editor support for fonts.

    Note: If a DynamicFont doesn’t contain a character used in a string, the character in question will be replaced with codepoint if it’s available in the DynamicFont. If this replacement character isn’t available in the DynamicFont, the character will be hidden without displaying any replacement character in the string.

    • void draw ( canvas_item, Vector2 position, string, Color modulate=Color( 1, 1, 1, 1 ), clip_w=-1, Color outline_modulate=Color( 1, 1, 1, 1 ) ) const

    Draw string into a canvas item using the font at a given position, with modulate color, and optionally clipping the width. specifies the baseline, not the top. To draw from the top, ascent must be added to the Y axis.

    See also .

    Draw character char into a canvas item using the font at a given position, with modulate color, and optionally kerning if is passed. clipping the width. position specifies the baseline, not the top. To draw from the top, ascent must be added to the Y axis. The width used by the character is returned, making this function useful for drawing strings character by character.

    • float get_ascent ( ) const

    Returns the font ascent (number of pixels above the baseline).

    • get_char_size ( int char, next=0 ) const
    • float get_descent ( ) const

    Returns the font descent (number of pixels below the baseline).

    • get_height ( ) const

    Returns the total font height (ascent plus descent) in pixels.

    Returns the size of a string, taking kerning and advance into account.

    • Vector2 get_wordwrap_string_size ( string, float width ) const

    Returns the size that the string would have with word wrapping enabled with a fixed width.

    • has_outline ( ) const
    • bool is_distance_field_hint ( ) const
    • void update_changes ( )

    After editing a font (changing size, ascent, char rects, etc.). Call this function to propagate changes to controls that might use it.