Difference between revisions of "RemoveValue"

From VisionaireWiki
Jump to navigation Jump to search
(New page: ==removeValue== Lua Syntax: <pre>removeValue(field [, object], {flags=1, index = int})</pre> ===Arguments=== ====field==== :'''int''' - A data field which must be of a list-type (t_...)
 
m (Bot (Edward's framework))
 
(One intermediate revision by one other user not shown)
Line 4: Line 4:
 
Lua Syntax:
 
Lua Syntax:
 
<pre>removeValue(field [, object], {flags=1,  
 
<pre>removeValue(field [, object], {flags=1,  
     index = int})</pre>
+
     index = int,
 +
    flush = true|false})</pre>
 
===Arguments===
 
===Arguments===
 
====field====
 
====field====
Line 14: Line 15:
  
 
:Position (starting with 0) of the value item which will be removed.
 
:Position (starting with 0) of the value item which will be removed.
 +
====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

removeValue

Lua Syntax:

removeValue(field [, object], {flags=1, 
    index = int, 
    flush = true|false})

Arguments

field

int - A data field which must be of a list-type (t_vint, t_links, ...) where a value will be removed.

object

"object path"|"object id"|object - Object which contains the list (specified by the field) where a value will be removed from. If no object is given the selected object is used.

Flags

i/index

Position (starting with 0) of the value item which will be removed.

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.