virtualx-engine/doc/classes/ResourceImporterBMFont.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="ResourceImporterBMFont" inherits="ResourceImporter" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Imports a bitmap font in the BMFont ([code].fnt[/code]) format.
	</brief_description>
	<description>
		The BMFont format is a format created by the [url=https://www.angelcode.com/products/bmfont/]BMFont[/url] program. Many BMFont-compatible programs also exist, like [url=https://www.bmglyph.com/]BMGlyph[/url].
		Compared to [ResourceImporterImageFont], [ResourceImporterBMFont] supports bitmap fonts with varying glyph widths/heights.
		See also [ResourceImporterDynamicFont].
	</description>
	<tutorials>
		<link title="Bitmap fonts - Using fonts">$DOCS_URL/tutorials/ui/gui_using_fonts.html#bitmap-fonts</link>
	</tutorials>
	<members>
		<member name="compress" type="bool" setter="" getter="" default="true">
			If [code]true[/code], uses lossless compression for the resulting font.
		</member>
		<member name="fallbacks" type="Array" setter="" getter="" default="[]">
			List of font fallbacks to use if a glyph isn't found in this bitmap font. Fonts at the beginning of the array are attempted first.
		</member>
		<member name="scaling_mode" type="int" setter="" getter="" default="2">
			Font scaling mode.
		</member>
	</members>
</class>
Document editor import options in the class reference Tooltips are displayed when hovering import options, both in the Import dock and in the import defaults editor (which is in the Project Settings). Co-authored-by: Rémi Verschelde <rverschelde@gmail.com> 2021-05-13 22:34:34 +02:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Fix documentation validation after 8352122e70ec2a582af9a713791eabbbcb935c10 2023-07-12 17:30:34 +02:00			`<class name="ResourceImporterBMFont" inherits="ResourceImporter" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
Document editor import options in the class reference Tooltips are displayed when hovering import options, both in the Import dock and in the import defaults editor (which is in the Project Settings). Co-authored-by: Rémi Verschelde <rverschelde@gmail.com> 2021-05-13 22:34:34 +02:00			`<brief_description>`
Fill in descriptions for import options in the class reference 2023-07-13 02:25:33 +02:00			`Imports a bitmap font in the BMFont ([code].fnt[/code]) format.`
Document editor import options in the class reference Tooltips are displayed when hovering import options, both in the Import dock and in the import defaults editor (which is in the Project Settings). Co-authored-by: Rémi Verschelde <rverschelde@gmail.com> 2021-05-13 22:34:34 +02:00			`</brief_description>`
			`<description>`
Fill in descriptions for import options in the class reference 2023-07-13 02:25:33 +02:00			`The BMFont format is a format created by the [url=https://www.angelcode.com/products/bmfont/]BMFont[/url] program. Many BMFont-compatible programs also exist, like [url=https://www.bmglyph.com/]BMGlyph[/url].`
			`Compared to [ResourceImporterImageFont], [ResourceImporterBMFont] supports bitmap fonts with varying glyph widths/heights.`
			`See also [ResourceImporterDynamicFont].`
Document editor import options in the class reference Tooltips are displayed when hovering import options, both in the Import dock and in the import defaults editor (which is in the Project Settings). Co-authored-by: Rémi Verschelde <rverschelde@gmail.com> 2021-05-13 22:34:34 +02:00			`</description>`
			`<tutorials>`
Fill in descriptions for import options in the class reference 2023-07-13 02:25:33 +02:00			`<link title="Bitmap fonts - Using fonts">$DOCS_URL/tutorials/ui/gui_using_fonts.html#bitmap-fonts</link>`
Document editor import options in the class reference Tooltips are displayed when hovering import options, both in the Import dock and in the import defaults editor (which is in the Project Settings). Co-authored-by: Rémi Verschelde <rverschelde@gmail.com> 2021-05-13 22:34:34 +02:00			`</tutorials>`
			`<members>`
			`<member name="compress" type="bool" setter="" getter="" default="true">`
Fill in descriptions for import options in the class reference 2023-07-13 02:25:33 +02:00			`If [code]true[/code], uses lossless compression for the resulting font.`
Document editor import options in the class reference Tooltips are displayed when hovering import options, both in the Import dock and in the import defaults editor (which is in the Project Settings). Co-authored-by: Rémi Verschelde <rverschelde@gmail.com> 2021-05-13 22:34:34 +02:00			`</member>`
			`<member name="fallbacks" type="Array" setter="" getter="" default="[]">`
Fill in descriptions for import options in the class reference 2023-07-13 02:25:33 +02:00			`List of font fallbacks to use if a glyph isn't found in this bitmap font. Fonts at the beginning of the array are attempted first.`
Document editor import options in the class reference Tooltips are displayed when hovering import options, both in the Import dock and in the import defaults editor (which is in the Project Settings). Co-authored-by: Rémi Verschelde <rverschelde@gmail.com> 2021-05-13 22:34:34 +02:00			`</member>`
[Bitmap fonts] Add support for scaling. 2023-08-14 09:42:49 +02:00			`<member name="scaling_mode" type="int" setter="" getter="" default="2">`
			`Font scaling mode.`
			`</member>`
Document editor import options in the class reference Tooltips are displayed when hovering import options, both in the Import dock and in the import defaults editor (which is in the Project Settings). Co-authored-by: Rémi Verschelde <rverschelde@gmail.com> 2021-05-13 22:34:34 +02:00			`</members>`
			`</class>`