Text#

type krpc_UI_Text_t#

A text label. Added to a krpc_UI_Canvas_t or a krpc_UI_Panel_t.

krpc_error_t krpc_UI_Text_RectTransform(krpc_connection_t connection, krpc_UI_RectTransform_t *returnValue, krpc_UI_Text_t instance)#: The rect transform for the UI object.

krpc_error_t krpc_UI_Text_LayoutElement(krpc_connection_t connection, krpc_UI_LayoutElement_t *returnValue, krpc_UI_Text_t instance)#: How much space the UI object asks a layout for.

Note

Only has an effect when the object is in a panel that has a layout. A canvas is not inside a layout and does not have one.

krpc_error_t krpc_UI_Text_Visible(krpc_connection_t connection, bool *returnValue, krpc_UI_Text_t instance)#

krpc_error_t krpc_UI_Text_set_Visible(krpc_connection_t connection, krpc_UI_Text_t instance, bool value)#: Whether the UI object is visible.

Note

This is the object’s own setting, which is what it was last set to. An object is only drawn when everything it is inside is visible as well, so an interface can be built with its parts visible, inside a panel that is not, and shown all at once by making that panel visible.

krpc_error_t krpc_UI_Text_Content(krpc_connection_t connection, char **returnValue, krpc_UI_Text_t instance)#

krpc_error_t krpc_UI_Text_set_Content(krpc_connection_t connection, krpc_UI_Text_t instance, const char *value)#: The text string

krpc_error_t krpc_UI_Text_WordWrap(krpc_connection_t connection, bool *returnValue, krpc_UI_Text_t instance)#

krpc_error_t krpc_UI_Text_set_WordWrap(krpc_connection_t connection, krpc_UI_Text_t instance, bool value)#: Whether the text wraps onto further lines when it is wider than the space it has. Text that does not wrap carries on past the edge, and its preferred size is that of a single line, so a changing value leaves a layout in place.

krpc_error_t krpc_UI_Text_Font(krpc_connection_t connection, char **returnValue, krpc_UI_Text_t instance)#

krpc_error_t krpc_UI_Text_set_Font(krpc_connection_t connection, krpc_UI_Text_t instance, const char *value)#: Name of the font

Note

Empty if the game provided no font to draw the text with, in which case it is not drawn. See krpc_UI_Text_AvailableFonts() for the names that can be set.

krpc_error_t krpc_UI_Text_AvailableFonts(krpc_connection_t connection, krpc_list_string_t *returnValue, krpc_UI_Text_t instance)#: A list of all available fonts.

krpc_error_t krpc_UI_Text_Size(krpc_connection_t connection, int32_t *returnValue, krpc_UI_Text_t instance)#

krpc_error_t krpc_UI_Text_set_Size(krpc_connection_t connection, krpc_UI_Text_t instance, int32_t value)#: Font size.

krpc_error_t krpc_UI_Text_Style(krpc_connection_t connection, krpc_UI_FontStyle_t *returnValue, krpc_UI_Text_t instance)#

krpc_error_t krpc_UI_Text_set_Style(krpc_connection_t connection, krpc_UI_Text_t instance, krpc_UI_FontStyle_t value)#: Font style.

krpc_error_t krpc_UI_Text_Color(krpc_connection_t connection, krpc_StdLib_ColorRGBA_t *returnValue, krpc_UI_Text_t instance)#

krpc_error_t krpc_UI_Text_set_Color(krpc_connection_t connection, krpc_UI_Text_t instance, const krpc_StdLib_ColorRGBA_t *value)#: The color the text is drawn in.

krpc_error_t krpc_UI_Text_Alignment(krpc_connection_t connection, krpc_UI_TextAnchor_t *returnValue, krpc_UI_Text_t instance)#

krpc_error_t krpc_UI_Text_set_Alignment(krpc_connection_t connection, krpc_UI_Text_t instance, krpc_UI_TextAnchor_t value)#: Alignment.

krpc_error_t krpc_UI_Text_LineSpacing(krpc_connection_t connection, float *returnValue, krpc_UI_Text_t instance)#

krpc_error_t krpc_UI_Text_set_LineSpacing(krpc_connection_t connection, krpc_UI_Text_t instance, float value)#: Line spacing.

krpc_error_t krpc_UI_Text_Remove(krpc_connection_t connection, krpc_UI_Text_t instance)#: Remove the UI object.

type krpc_UI_FontStyle_t#

Font style.

KRPC_UI_FONTSTYLE_NORMAL#: Normal.

KRPC_UI_FONTSTYLE_BOLD#: Bold.

KRPC_UI_FONTSTYLE_ITALIC#: Italic.

KRPC_UI_FONTSTYLE_BOLDANDITALIC#: Bold and italic.

type krpc_UI_TextAlignment_t#

Text alignment.

KRPC_UI_TEXTALIGNMENT_LEFT#: Left aligned.

KRPC_UI_TEXTALIGNMENT_RIGHT#: Right aligned.

KRPC_UI_TEXTALIGNMENT_CENTER#: Center aligned.

type krpc_UI_TextAnchor_t#

Text alignment.

KRPC_UI_TEXTANCHOR_LOWERCENTER#: Lower center.

KRPC_UI_TEXTANCHOR_LOWERLEFT#: Lower left.

KRPC_UI_TEXTANCHOR_LOWERRIGHT#: Lower right.

KRPC_UI_TEXTANCHOR_MIDDLECENTER#: Middle center.

KRPC_UI_TEXTANCHOR_MIDDLELEFT#: Middle left.

KRPC_UI_TEXTANCHOR_MIDDLERIGHT#: Middle right.

KRPC_UI_TEXTANCHOR_UPPERCENTER#: Upper center.

KRPC_UI_TEXTANCHOR_UPPERLEFT#: Upper left.

KRPC_UI_TEXTANCHOR_UPPERRIGHT#: Upper right.