mirror of
https://github.com/godotengine/godot.git
synced 2024-11-25 21:52:51 +00:00
78 lines
4.1 KiB
XML
78 lines
4.1 KiB
XML
|
<?xml version="1.0" encoding="UTF-8" ?>
|
||
|
|
<class name="TextMesh" inherits="PrimitiveMesh" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
||
|
|
<brief_description>
|
||
|
|
Generate an [PrimitiveMesh] from the text.
|
||
|
|
</brief_description>
|
||
|
|
<description>
|
||
|
|
Generate an [PrimitiveMesh] from the text.
|
||
|
|
TextMesh can be generated only when using dynamic fonts with vector glyph contours. Bitmap fonts (including bitmap data in the TrueType/OpenType containers, like color emoji fonts) are not supported.
|
||
|
|
The UV layout is arranged in 4 horizontal strips, top to bottom: 40% of the height for the front face, 40% for the back face, 10% for the outer edges and 10% for the inner edges.
|
||
|
|
</description>
|
||
|
|
<tutorials>
|
||
|
|
</tutorials>
|
||
|
|
<methods>
|
||
|
|
<method name="clear_opentype_features">
|
||
|
|
<return type="void" />
|
||
|
|
<description>
|
||
|
|
Removes all OpenType features.
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
<method name="get_opentype_feature" qualifiers="const">
|
||
|
|
<return type="int" />
|
||
|
|
<argument index="0" name="tag" type="String" />
|
||
|
|
<description>
|
||
|
|
Returns OpenType feature [code]tag[/code].
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
<method name="set_opentype_feature">
|
||
|
|
<return type="void" />
|
||
|
|
<argument index="0" name="tag" type="String" />
|
||
|
|
<argument index="1" name="value" type="int" />
|
||
|
|
<description>
|
||
|
|
Returns OpenType feature [code]tag[/code]. More info: [url=https://docs.microsoft.com/en-us/typography/opentype/spec/featuretags]OpenType feature tags[/url].
|
||
|
|
</description>
|
||
|
|
</method>
|
||
|
|
</methods>
|
||
|
|
<members>
|
||
|
|
<member name="curve_step" type="float" setter="set_curve_step" getter="get_curve_step" default="0.5">
|
||
|
|
Step (in pixels) used to approximate Bézier curves.
|
||
|
|
</member>
|
||
|
|
<member name="depth" type="float" setter="set_depth" getter="get_depth" default="0.05">
|
||
|
|
Depths of the mesh, if set to [code]0.0[/code] only front surface, is generated, and UV layout is changed to use full texture for the front face only.
|
||
|
|
</member>
|
||
|
|
<member name="font" type="Font" setter="set_font" getter="get_font">
|
||
|
|
[Font] used for the [TextMesh]'s text.
|
||
|
|
</member>
|
||
|
|
<member name="font_size" type="int" setter="set_font_size" getter="get_font_size" default="16">
|
||
|
|
Font size of the [TextMesh]'s text.
|
||
|
|
</member>
|
||
|
|
<member name="horizontal_alignment" type="int" setter="set_horizontal_alignment" getter="get_horizontal_alignment" enum="HorizontalAlignment" default="1">
|
||
|
|
Controls the text's horizontal alignment. Supports left, center, right, and fill, or justify. Set it to one of the [enum HorizontalAlignment] constants.
|
||
|
|
</member>
|
||
|
|
<member name="language" type="String" setter="set_language" getter="get_language" default="""">
|
||
|
|
Language code used for text shaping algorithms, if left empty current locale is used instead.
|
||
|
|
</member>
|
||
|
|
<member name="pixel_size" type="float" setter="set_pixel_size" getter="get_pixel_size" default="0.01">
|
||
|
|
The size of one pixel's width on the text to scale it in 3D.
|
||
|
|
</member>
|
||
|
|
<member name="structured_text_bidi_override" type="int" setter="set_structured_text_bidi_override" getter="get_structured_text_bidi_override" enum="TextServer.StructuredTextParser" default="0">
|
||
|
|
Set BiDi algorithm override for the structured text.
|
||
|
|
</member>
|
||
|
|
<member name="structured_text_bidi_override_options" type="Array" setter="set_structured_text_bidi_override_options" getter="get_structured_text_bidi_override_options" default="[]">
|
||
|
|
Set additional options for BiDi override.
|
||
|
|
</member>
|
||
|
|
<member name="text" type="String" setter="set_text" getter="get_text" default="""">
|
||
|
|
The text to generate mesh from.
|
||
|
|
</member>
|
||
|
|
<member name="text_direction" type="int" setter="set_text_direction" getter="get_text_direction" enum="TextServer.Direction" default="0">
|
||
|
|
Base text writing direction.
|
||
|
|
</member>
|
||
|
|
<member name="uppercase" type="bool" setter="set_uppercase" getter="is_uppercase" default="false">
|
||
|
|
If [code]true[/code], all the text displays as UPPERCASE.
|
||
|
|
</member>
|
||
|
|
<member name="width" type="float" setter="set_width" getter="get_width" default="500.0">
|
||
|
|
Text width (in pixels), used for fill alignment.
|
||
|
|
</member>
|
||
|
|
</members>
|
||
|
|
</class>
|