class MAGES::ComponentLibrary::Label¶

Overview¶

A simple label in 3D space. More…

class Label: public MonoBehaviour
{
public:
    // classes

    class Data;

    // methods

    Label Text(string text);
    Label Pivot(Vector2 pivot);
    Label Pivot(float x, float y);
    Label Font(Theme.FontData fontData);
    Label Padding(Vector4 padding);
    Label SetData(Data data);
    Label Outline(bool on);
    Label Overlay(bool on);
    Label Appearance(TextAppearance textAppearance);
    Label.Data GetData();
    void Refresh();
};

Detailed Documentation¶

A simple label in 3D space.

Methods¶

Label Text(string text)

Sets the text of the label.

Parameters:

text	The text.

Returns:

Self.

Label Pivot(Vector2 pivot)

Sets the pivot of the underlying canvas of the label.

Parameters:

pivot	The new pivot.

Returns:

Self.

Label Pivot(float x, float y)

Sets the pivot of the underlying canvas of the label.

Parameters:

x	Pivot.x.
y	Pivot.y.

Returns:

Self.

Label Font(Theme.FontData fontData)

Sets the font of the label.

Parameters:

fontData	The new font data.

Returns:

Self.

Label Padding(Vector4 padding)

Sets the padding of the label.

Parameters:

padding	The new padding.

Returns:

Self.

Label SetData(Data data)

Sets the data for the label.

Parameters:

data	The new data.

Returns:

Self.

Label Outline(bool on)

Sets the outline of the label.

Parameters:

on	Whether the outline should be on.

Returns:

Self.

Label Overlay(bool on)

Sets the overlay of the label.

Parameters:

on	Whether overlay should be on.

Returns:

Self.

Label Appearance(TextAppearance textAppearance)

Sets the appearance of the label.

Parameters:

textAppearance	The appearance.

Returns:

Self.

Label.Data GetData()

Gets the data for the label.

Returns:

The data.

void Refresh()

Refresh the layout of the label.