Difference between revisions of "SetName"

From VisionaireWiki
Jump to navigation Jump to search
(New page: ==setName== Lua Syntax: <pre>setName(object, name)</pre> ===Arguments=== ====object==== :'''"object path"|"object id"|object''' - Specifies an object to rename. ====name==== :'''"string"...)
 
m (Bot (Edward's framework))
 
(One intermediate revision by one other user not shown)
Line 3: Line 3:
  
 
Lua Syntax:
 
Lua Syntax:
<pre>setName(object, name)</pre>
+
<pre>setName(object, name, {flags=1,
 +
    flush = true|false})</pre>
 
===Arguments===
 
===Arguments===
 
====object====
 
====object====
Line 10: Line 11:
 
:'''"string"''' - The new name of the object.
 
:'''"string"''' - The new name of the object.
 
===Flags===
 
===Flags===
 +
====fl/flush====
 +
 +
:If true then the pending notifications will be flushed immediately. By default notifications of commands inside a command group will be sent after the group is closed.
 
===Return Values===
 
===Return Values===
 
None.
 
None.

Latest revision as of 12:57, 16 August 2009

setName

Lua Syntax:

setName(object, name, {flags=1, 
    flush = true|false})

Arguments

object

"object path"|"object id"|object - Specifies an object to rename.

name

"string" - The new name of the object.

Flags

fl/flush

If true then the pending notifications will be flushed immediately. By default notifications of commands inside a command group will be sent after the group is closed.

Return Values

None.