ClearValue: Difference between revisions

From VisionaireWiki
Jump to navigation Jump to search
(Removing all content from page)
m (Bot (Edward's framework))
 
Line 1: Line 1:
==clearValue==


Lua Syntax:
<pre>clearValue(field [, object], {flags=1,
    flush = true|false})</pre>
===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.

Latest revision as of 11: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.