InsertValue: Difference between revisions
Jump to navigation
Jump to search
(New page: ==insertValue== Lua Syntax: <pre>insertValue(field, value [, object], {flags=1, index = int})</pre> ===Arguments=== ====field==== :'''int''' - A data field which must be of a list-t...) |
m (Bot (Edward's framework)) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 4: | Line 4: | ||
Lua Syntax: | Lua Syntax: | ||
<pre>insertValue(field, value [, object], {flags=1, | <pre>insertValue(field, value [, object], {flags=1, | ||
index = int})</pre> | index = int, | ||
flush = true|false})</pre> | |||
===Arguments=== | ===Arguments=== | ||
====field==== | ====field==== | ||
| Line 16: | Line 17: | ||
:Position (starting with 0) were the value will be inserted into the list. | :Position (starting with 0) were the value will be inserted into the list. | ||
====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 11:57, 16 August 2009
insertValue
Lua Syntax:
insertValue(field, value [, 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 the value will be inserted.
value
- VARIANT - Value to insert. The type of the value must match the element type of the list field. E.g. if the field type is t_vint then the value type must be t_int.
object
- "object path"|"object id"|object - Object which contains the list (specified by the field) where the value will be inserted into. If no object is given the selected object is used.
Flags
i/index
- Position (starting with 0) were the value will be inserted into the list.
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.