Functions to manipulate a label component.
vector4 label color
The color of the label. The type of the property is vector4.
function init(self) -- Get the current color's y component local red_component = go.get("#label", "color.y") -- Animate the color go.animate("#label", "color", go.PLAYBACK_LOOP_PINGPONG, vmath.vector4(0,1,0,1), go.EASING_INOUTSINE, 1) end
gets the text for a label
Gets the text from a label component
url -
string | hash | url the label to get the text from
metrics -
string the label text
function init(self) local text = label.get_text("#label") print(text) end
gets the text metrics for a label
Gets the text metrics from a label component
url -
string | hash | url the label to get the (unscaled) metrics from
metrics -
table a table with the following fields:
function init(self) local metrics = label.get_text_metrics("#label") pprint(metrics) end
set the text for a label
Sets the text of a label component
This method uses the message passing that means the value will be set after dispatch messages
step.
More information is available in the Application Lifecycle manual.
url -
string | hash | url the label that should have a constant set
text -
string the text
function init(self) label.set_text("#label", "Hello World!") end
vector4 label outline
The outline color of the label. The type of the property is vector4.
function init(self) -- Get the current outline color local outline = go.get("#label", "outline") -- Animate the property go.animate("#label", "outline", go.PLAYBACK_LOOP_PINGPONG, vmath.vector4(0,1,0,1), go.EASING_INOUTSINE, 1) end
number | vector3 label scale
The scale of the label. The type of the property is number (uniform) or vector3 (non uniform).
How to scale a label independently along the X and Y axis:
function init(self) -- Double the y-axis scaling on component "label" local yscale = go.get("#label", "scale.y") go.set("#label", "scale.y", yscale * 2) -- Set the new scale altogether go.set("#label", "scale", vmath.vector3(2,2,2)) -- Animate the scale go.animate("#label", "scale", go.PLAYBACK_LOOP_PINGPONG, vmath.vector3(2,2,2), go.EASING_INOUTSINE, 1) end
vector4 label shadow
The shadow color of the label. The type of the property is vector4.
function init(self) -- Get the current shadow color local shadow = go.get("#label", "shadow") -- Animate the property go.animate("#label", "shadow", go.PLAYBACK_LOOP_PINGPONG, vmath.vector4(0,1,0,1), go.EASING_INOUTSINE, 1) end
vector3 label size
Returns the size of the label. The size will constrain the text if line break is enabled The type of the property is vector3.
How to query a label's size, either as a vector or selecting a specific dimension:
function init(self) -- get size from component "label" local size = go.get("#label", "size") local sizex = go.get("#label", "size.x") -- do something useful assert(size.x == sizex) end