DestroyTextBox: Difference between revisions
From Onset Developer Wiki
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{Info|Function|Client|1.0}} | {{Info|Function|Client|1.0}} | ||
{{FuncDescription| | {{FuncDescription|Destroy a text box created with [[CreateTextBox]].}} | ||
{{FuncSyntax|DestroyTextBox(textid)}} | {{FuncSyntax|DestroyTextBox(textid)}} | ||
{{FuncParameters}} | {{FuncParameters}} | ||
{{FuncParam|textid| | {{FuncParam|textid|The text identifier.}} | ||
{{FuncReturnValue| | {{FuncReturnValue|This function returns nothing.}} | ||
== Example == | == Example == | ||
<syntaxhighlight lang="Lua> | |||
-- client side | |||
CashText = 0 | |||
AddEvent("OnPackageStart", function() | |||
CashText = CreateTextBox(-15, 180, 'CASH', "right") | |||
SetTextBoxAnchors(CashText, 1.0, 0.0, 1.0, 0.0) | |||
SetTextBoxAlignment(CashText, 1.0, 0.0) | |||
end) | |||
AddEvent("OnPackageStop", function() | |||
DestroyTextBox(CashText) | |||
end) | |||
</syntaxhighlight> | |||
{{RelatedFunctions}} | {{RelatedFunctions}} | ||
{{Template:TextFunctions}} | |||
Latest revision as of 13:03, 20 November 2019
Description
Destroy a text box created with CreateTextBox.
Syntax
DestroyTextBox(textid)
Parameters
- textid
The text identifier.
Return Value
- This function returns nothing.
Example
-- client side
CashText = 0
AddEvent("OnPackageStart", function()
CashText = CreateTextBox(-15, 180, 'CASH', "right")
SetTextBoxAnchors(CashText, 1.0, 0.0, 1.0, 0.0)
SetTextBoxAlignment(CashText, 1.0, 0.0)
end)
AddEvent("OnPackageStop", function()
DestroyTextBox(CashText)
end)
