Text Component: Difference between revisions

From Pummel Party Mod Documentation
Jump to navigation Jump to search
(Initial content)
 
m (Updated table formatting)
Line 22: Line 22:
| '''Outline''' || Should the text have an outline.
| '''Outline''' || Should the text have an outline.
|-
|-
| style="padding-left: 2em;" | '''Outline Color''' || The color of the outline.
| style="padding-left: 1em;" | '''Outline Color''' || The color of the outline.
|-
|-
| style="padding-left: 2em;" | '''Thickness''' || The thickness of the outline.
| style="padding-left: 1em;" | '''Thickness''' || The thickness of the outline.
|-
|-
| '''Shadow''' || Should the text have a shadow. This shadow is placed behind the text and can help it stand out.
| '''Shadow''' || Should the text have a shadow. This shadow is placed behind the text and can help it stand out.
|-
|-
| style="padding-left: 2em;" | '''Shadow Color''' || The color of the shadow.
| style="padding-left: 1em;" | '''Shadow Color''' || The color of the shadow.
|-
|-
| style="padding-left: 2em;" | '''Offset X''' || The shadow's horizontal offset. Ranges from -1 to 1.
| style="padding-left: 1em;" | '''Offset X''' || The shadow's horizontal offset. Ranges from -1 to 1.
|-
|-
| style="padding-left: 2em;" | '''Offset Y''' || The shadow's vertical offset. Ranges from -1 to 1.
| style="padding-left: 1em;" | '''Offset Y''' || The shadow's vertical offset. Ranges from -1 to 1.
|-
|-
| style="padding-left: 2em;" | '''Softness''' || The softness or fuzziness of the shadow. 0 results in a crisp shadow with hard edges. 1 gives a blurry shadow with blended edges.
| style="padding-left: 1em;" | '''Softness''' || The softness or fuzziness of the shadow. 0 results in a crisp shadow with hard edges. 1 gives a blurry shadow with blended edges.
|}
|}

Revision as of 22:53, 24 October 2022

The Text Component allows text to be displayed in the world.

Component Settings

Property Description
Text The text to be displayed in the world by the Text Component.
Font The font used to render the text.
Color The color of the text.
Font Size How large the text is rendered.
Size The space available for the text to fill. The text will wrap if it extends beyond the width of this size.
Horizontal The horizontal alignment of the text. Available alignment are Left aligned, Centered and Right aligned.
Font Styles Change the style of the text. Available styles are Bold, Underline, Italic and Strikethrough.
Outline Should the text have an outline.
Outline Color The color of the outline.
Thickness The thickness of the outline.
Shadow Should the text have a shadow. This shadow is placed behind the text and can help it stand out.
Shadow Color The color of the shadow.
Offset X The shadow's horizontal offset. Ranges from -1 to 1.
Offset Y The shadow's vertical offset. Ranges from -1 to 1.
Softness The softness or fuzziness of the shadow. 0 results in a crisp shadow with hard edges. 1 gives a blurry shadow with blended edges.