RemoveLink

From VisionaireWiki
Jump to: navigation, search

removeLink

Lua Syntax:

removeLink(field, linkedObject [, object], {flags=1, 
    flush = true|false})

Arguments

field

int - The t_links field of the data structure were the object will be removed from. The removed link is of course a non-parent link. Parent links can only be removed with deleteObject.

linkedObject

"object path"|"object id"|object - Object which will be removed from the t_links-field of an object.

object

"object path"|"object id"|object - Object were the linked object will be removed from (in the specified field). 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.