ClearValue: Difference between revisions
Jump to navigation
Jump to search
(New page: ==clearValue== Lua Syntax: <pre>clearValue(field [, object])</pre> ===Arguments=== ====field==== :'''int''' - The data field to clear. For links (t_link and t_links field type) this is o...) |
m (Bot (Edward's framework)) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 3: | Line 3: | ||
Lua Syntax: | Lua Syntax: | ||
<pre>clearValue(field [, object])</pre> | <pre>clearValue(field [, object], {flags=1, | ||
flush = true|false})</pre> | |||
===Arguments=== | ===Arguments=== | ||
====field==== | ====field==== | ||
| Line 10: | Line 11: | ||
:'''"object path"|"object id"|object''' - The object which contains the data field to clear. If no object is given the selected object is used. | :'''"object path"|"object id"|object''' - The object which contains the data field to clear. If no object is given the selected object is used. | ||
===Flags=== | ===Flags=== | ||
====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:56, 16 August 2009
clearValue
Lua Syntax:
clearValue(field [, object], {flags=1,
flush = true|false})
Arguments
field
- int - The data field to clear. For links (t_link and t_links field type) this is only allowed for non-parent links! To remove a parent link use deleteObject (the link is automatically removed when the object is deleted), otherwise Undo will not work correctly!
object
- "object path"|"object id"|object - The object which contains the data field to clear. If no object is given the selected object is used.
Flags
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.