RemoveValue

From VisionaireWiki
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

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.