<?xml version="1.0" encoding="UTF-8" ?> <class name="BitmapFont" inherits="Font" category="Core" version="3.1"> <brief_description> Renders text using [code]*.fnt[/code] fonts. </brief_description> <description> Renders text using [code]*.fnt[/code] fonts containing texture atlases. Supports distance fields. For using vector font files like TTF directly, see [DynamicFont]. </description> <tutorials> </tutorials> <demos> </demos> <methods> <method name="add_char"> <return type="void"> </return> <argument index="0" name="character" type="int"> </argument> <argument index="1" name="texture" type="int"> </argument> <argument index="2" name="rect" type="Rect2"> </argument> <argument index="3" name="align" type="Vector2" default="Vector2( 0, 0 )"> </argument> <argument index="4" name="advance" type="float" default="-1"> </argument> <description> Adds a character to the font, where [code]character[/code] is the unicode value, [code]texture[/code] is the texture index, [code]rect[/code] is the region in the texture (in pixels!), [code]align[/code] is the (optional) alignment for the character and [code]advance[/code] is the (optional) advance. </description> </method> <method name="add_kerning_pair"> <return type="void"> </return> <argument index="0" name="char_a" type="int"> </argument> <argument index="1" name="char_b" type="int"> </argument> <argument index="2" name="kerning" type="int"> </argument> <description> Adds a kerning pair to the [code]BitmapFont[/code] as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character. </description> </method> <method name="add_texture"> <return type="void"> </return> <argument index="0" name="texture" type="Texture"> </argument> <description> Adds a texture to the [code]BitmapFont[/code]. </description> </method> <method name="clear"> <return type="void"> </return> <description> Clears all the font data and settings. </description> </method> <method name="create_from_fnt"> <return type="int" enum="Error"> </return> <argument index="0" name="path" type="String"> </argument> <description> Creates a BitmapFont from the [code]*.fnt[/code] file at [code]path[/code]. </description> </method> <method name="get_char_size" qualifiers="const"> <return type="Vector2"> </return> <argument index="0" name="char" type="int"> </argument> <argument index="1" name="next" type="int" default="0"> </argument> <description> Returns the size of a character, optionally taking kerning into account if the next character is provided. </description> </method> <method name="get_kerning_pair" qualifiers="const"> <return type="int"> </return> <argument index="0" name="char_a" type="int"> </argument> <argument index="1" name="char_b" type="int"> </argument> <description> Returns a kerning pair as a difference. </description> </method> <method name="get_texture" qualifiers="const"> <return type="Texture"> </return> <argument index="0" name="idx" type="int"> </argument> <description> Returns the font atlas texture at index [code]idx[/code]. </description> </method> <method name="get_texture_count" qualifiers="const"> <return type="int"> </return> <description> Returns the number of textures in the BitmapFont atlas. </description> </method> </methods> <members> <member name="ascent" type="float" setter="set_ascent" getter="get_ascent"> Ascent (number of pixels above the baseline). </member> <member name="distance_field" type="bool" setter="set_distance_field_hint" getter="is_distance_field_hint"> If [code]true[/code] distance field hint is enabled. </member> <member name="fallback" type="BitmapFont" setter="set_fallback" getter="get_fallback"> The fallback font. </member> <member name="height" type="float" setter="set_height" getter="get_height"> Total font height (ascent plus descent) in pixels. </member> </members> <constants> </constants> </class>