Difference between revisions of "SetValue"

From VisionaireWiki
Jump to navigation Jump to search
(Removing all content from page)
m (Bot (Edward's framework))
 
Line 1: Line 1:
 +
==setValue==
  
 +
 +
Lua Syntax:
 +
<pre>setValue(field, value, {flags=1,
 +
    index = int,
 +
    flush = true|false})</pre>
 +
===Arguments===
 +
====field====
 +
:'''int''' - Data field which will be set.
 +
====value====
 +
:'''VARIANT''' - Value to set. The type of the value must match the type of the field. E.g. if the field type is t_int then the value type must also be t_int.
 +
===Flags===
 +
====i/index====
 +
 +
:If specified then an existing list element at the given index will modified. In this case the field type must be of a list-type (t_vint, t_links, ...).
 +
====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 12:57, 16 August 2009

setValue

Lua Syntax:

setValue(field, value, {flags=1, 
    index = int, 
    flush = true|false})

Arguments

field

int - Data field which will be set.

value

VARIANT - Value to set. The type of the value must match the type of the field. E.g. if the field type is t_int then the value type must also be t_int.

Flags

i/index

If specified then an existing list element at the given index will modified. In this case the field type must be of a list-type (t_vint, t_links, ...).

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.