Difference between revisions of "SetTextBoxText"

From Onset Developer Wiki
(Created page with "{{Info|Function|Client|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|SetTextBoxText(textid, text)}} {{FuncParameters}} {{FuncParam|textid|__EDIT_ME__}} {{FuncParam|tex...")
 
 
Line 1: Line 1:
 
{{Info|Function|Client|1.0}}
 
{{Info|Function|Client|1.0}}
  
{{FuncDescription|__EDIT_ME__}}
+
{{FuncDescription|Set the string of the specified text box.}}
  
 
{{FuncSyntax|SetTextBoxText(textid, text)}}
 
{{FuncSyntax|SetTextBoxText(textid, text)}}
  
 
{{FuncParameters}}
 
{{FuncParameters}}
{{FuncParam|textid|__EDIT_ME__}}
+
{{FuncParam|textid|The text identifier.}}
{{FuncParam|text|__EDIT_ME__}}
+
{{FuncParam|text|The string of the text you want to show.}}
  
{{FuncReturnValue|__EDIT_ME__}}
+
{{FuncReturnValue|Returns '''true''' on success.}}
  
 
== Example ==
 
== Example ==
__EDIT_ME__
+
<syntaxhighlight lang='Lua'>
 +
SetTextBoxText(textId, "Update")
 +
</syntaxhighlight>
  
 
{{RelatedFunctions}}
 
{{RelatedFunctions}}
__EDIT_ME__
+
{{TextFunctions}}

Latest revision as of 18:07, 16 January 2020

SetTextBoxText

Type: Function
Context: Client
Introduced: v1.0

Description

Set the string of the specified text box.

Syntax

SetTextBoxText(textid, text)

Parameters

  • textid
    The text identifier.
  • text
    The string of the text you want to show.

Return Value

  • Returns true on success.

Example

SetTextBoxText(textId, "Update")

See also