RemoveValue: Difference between revisions

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_...)
(No difference)

Revision as of 10:39, 25 October 2008

removeValue

Lua Syntax:

removeValue(field [, object], {flags=1, 
    index = int})

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.

Return Values

None.