ChangeOrder: Difference between revisions

From VisionaireWiki
Jump to navigation Jump to search
(New page: ==changeOrder== Lua Syntax: <pre>changeOrder("up"|"down" [, object])</pre> ===Arguments=== ===="up"|"down"==== :'''"string"''' - Defines how the order is changed. ====object==== :'''"obj...)
 
m (Bot (Edward's framework))
 
(One intermediate revision by one other user not shown)
Line 3: Line 3:


Lua Syntax:
Lua Syntax:
<pre>changeOrder("up"|"down" [, object])</pre>
<pre>changeOrder("up"|"down" [, object], {flags=1,
    flush = true|false})</pre>
===Arguments===
===Arguments===
===="up"|"down"====
===="up"|"down"====
Line 10: Line 11:
:'''"object path"|"object id"|object''' - The order of this object is changed in the list it is stored in. If no object is given the selected object is used.
:'''"object path"|"object id"|object''' - The order of this object is changed in the list it is stored in. If no object is given the selected object is used.
===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 11:56, 16 August 2009

changeOrder

Lua Syntax:

changeOrder("up"|"down" [, object], {flags=1, 
    flush = true|false})

Arguments

"up"|"down"

"string" - Defines how the order is changed.

object

"object path"|"object id"|object - The order of this object is changed in the list it is stored in. If no object is given the selected object is used.

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.