SetName: Difference between revisions
Jump to navigation
Jump to search
(Removing all content from page) |
m (Bot (Edward's framework)) |
||
| Line 1: | Line 1: | ||
==setName== | |||
Lua Syntax: | |||
<pre>setName(object, name, {flags=1, | |||
flush = true|false})</pre> | |||
===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. | |||
Latest revision as of 11: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.