Version: stable
FUNCTION | |
---|---|
label.set_text() | set the text for a label |
label.get_text_metrics() | gets the text metrics for a label |
label.get_text() | gets the text for a label |
PROPERTIES | |
---|---|
color | vector4 label color |
outline | vector4 label outline |
shadow | vector4 label shadow |
scale | number | vector3 label scale |
size | vector3 label size |
material | hash label material |
font | hash label font |
label.set_text(url,text)
dispatch messages
step.
More information is available in the Application Lifecycle manual.
PARAMETERS
url |
the label that should have a constant set |
text |
the text |
EXAMPLES
function init(self) label.set_text("#label", "Hello World!") end
label.get_text_metrics(url)
PARAMETERS
url |
the label to get the (unscaled) metrics from |
RETURNS
metrics |
a table with the following fields:
|
EXAMPLES
function init(self) local metrics = label.get_text_metrics("#label") pprint(metrics) end
label.get_text(url)
PARAMETERS
url |
the label to get the text from |
RETURNS
metrics |
the label text |
EXAMPLES
function init(self) local text = label.get_text("#label") print(text) end
The color of the label. The type of the property is vector4.
vector4 label color
EXAMPLES
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
The outline color of the label. The type of the property is vector4.
vector4 label outline
EXAMPLES
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
The shadow color of the label. The type of the property is vector4.
vector4 label shadow
EXAMPLES
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
The scale of the label. The type of the property is number (uniform) or vector3 (non uniform).
number | vector3 label scale
EXAMPLES
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
Returns the size of the label. The size will constrain the text if line break is enabled. The type of the property is vector3.
vector3 label size
EXAMPLES
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
The material used when rendering the label. The type of the property is hash.
hash label material
EXAMPLES
How to set material using a script property (see resource.material)go.property("my_material", resource.material("/material.material")) function init(self) go.set("#label", "material", self.my_material) end
The font used when rendering the label. The type of the property is hash.
hash label font
EXAMPLES
How to set font using a script property (see resource.font)go.property("my_font", resource.font("/font.font")) function init(self) go.set("#label", "font", self.my_font) end