View source for Set3DTextScale

<!-- This page is generated automatically from the function definition: set3DTextScale. -->
= set3DTextScale =
Changes the visual scale of a replicated world-space text label.

== Syntax ==
<syntaxhighlight lang="lua">
bool set3DTextScale(string textId, number scale)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>textId</code> || <code>string</code> || yes || The opaque identifier returned by create3DText.
|-
| <code>scale</code> || <code>number</code> || yes || Text scale from 0.25 to 5.0.
|}

== Returns ==
Returns <code>true</code> when the label is owned by the current resource and the update is accepted; otherwise returns <code>false</code>.

== Examples ==
Increase the size of an important location label:
<syntaxhighlight lang="lua" line>
set3DTextScale(locationLabel, 1.25)
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* The scale is validated by the server before replication.

[[Category:Server Functions]]
[[Category:World Functions]]