Go to: Synopsis. Return value. Flags. MEL examples.

Synopsis

removeMultiInstance [-allChildren boolean] [-break boolean] attribute

removeMultiInstance is undoable, NOT queryable, and NOT editable.

Removes a particular instance of a multiElement. This is only useful for input attributes since outputs will get regenerated the next time the node gets executed. This command will remove the instance and optionally break all incoming and outgoing connections to that instance. If the connections are not broken (with the -b true) flag, then the command will fail if connections exist.

Return value

boolean(true if the instance was removed, false if something went wrong, like the attribute is connected but -b true was not specified)

Flags

allChildren, break
Long name (short name) Argument types Properties
-allChildren(-all) boolean create
If the argument is true, remove all children of the multi parent.
-break(-b) boolean create
If the argument is true, all connections to the attribute will be broken before the element is removed. If false, then the command will fail if the element is connected.
Flag can appear in Create mode of command Flag can appear in Edit mode of command
Flag can appear in Query mode of command Flag can be used more than once in a command.

MEL examples

// This will remove the element with index 4 from the input of
// the choice node as long as there are no incoming or outgoing
// connections to the attribute.
//
removeMultiInstance choice.input[4];

// This will remove the element with index 100 from the input of
// the choice node, breaking any existing connections first.
//
removeMultiInstance -b true choice.input[100];