TextItemSetScale: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
(Remove spaces) |
||
| (4 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server function}} | |||
This function allows the setting of the scale of a text item. | This function allows the setting of the scale of a text item. | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool textItemSetScale ( textitem | bool textItemSetScale ( textitem theTextitem, float scale ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*''' | *'''theTextitem:''' The text item you wish to set the scale of. | ||
*'''scale:''' A floating point value indicating the scale of the text you wish to set to. 1.0 is around 12pt. | *'''scale:''' A floating point value indicating the scale of the text you wish to set to. 1.0 is around 12pt. | ||
| Line 15: | Line 16: | ||
==Example== | ==Example== | ||
This example | This example retrieves the scale of the ''theTextitem'' text item, and if it is too small it enlarges it so it is more visible. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
scale = textItemGetScale ( | local scale = textItemGetScale ( theTextItem ) --get the scale of theTextitem and define it as 'scale' | ||
if scale < 0.5 then --if the scale is smaller than 0.5 | if (scale < 0.5) then --if the scale is smaller than 0.5 | ||
textItemSetScale ( theTextItem, 1.0 ) --then restore it to default size, 1.0. | |||
end | end | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Latest revision as of 21:13, 29 October 2023
This function allows the setting of the scale of a text item.
Syntax
bool textItemSetScale ( textitem theTextitem, float scale )
Required Arguments
- theTextitem: The text item you wish to set the scale of.
- scale: A floating point value indicating the scale of the text you wish to set to. 1.0 is around 12pt.
Returns
Returns true if the scale was successfully set, false otherwise.
Example
This example retrieves the scale of the theTextitem text item, and if it is too small it enlarges it so it is more visible.
local scale = textItemGetScale ( theTextItem ) --get the scale of theTextitem and define it as 'scale' if (scale < 0.5) then --if the scale is smaller than 0.5 textItemSetScale ( theTextItem, 1.0 ) --then restore it to default size, 1.0. end
See Also
- textCreateDisplay
- textCreateTextItem
- textDestroyDisplay
- textDestroyTextItem
- textDisplayAddObserver
- textDisplayAddText
- textDisplayGetObservers
- textDisplayIsObserver
- textDisplayRemoveObserver
- textDisplayRemoveText
- textItemGetColor
- textItemGetPosition
- textItemGetPriority
- textItemGetScale
- textItemGetText
- textItemSetColor
- textItemSetPosition
- textItemSetPriority
- textItemSetScale
- textItemSetText