SetValue: Difference between revisions
Jump to navigation
Jump to search
(New page: ==setValue== Lua Syntax: <pre>setValue(field, value, {flags=1, index = int})</pre> ===Arguments=== ====field==== :'''int''' - Data field which will be set. ====value==== :'''VARIANT...) |
m (Bot (Edward's framework)) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 4: | Line 4: | ||
Lua Syntax: | Lua Syntax: | ||
<pre>setValue(field, value, {flags=1, | <pre>setValue(field, value, {flags=1, | ||
index = int})</pre> | index = int, | ||
flush = true|false})</pre> | |||
===Arguments=== | ===Arguments=== | ||
====field==== | ====field==== | ||
| Line 14: | Line 15: | ||
: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, ...). | :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=== | ===Return Values=== | ||
None. | 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.