<effect>.setRemoveFlags

Vizard 8 » Command Index » Vizard objects » effect » <effect>.setRemoveFlags

8.1

<effect>.setRemoveFlags

Set unapply flags to execute when effect is removed

<effect>.setRemoveFlags(
flags
)

flags

A combination of the following unapply flags:

Flag	Description
viz.UNAPPLY_NODE	Remove the effect from all previously applied nodes.
viz.UNAPPLY_COMPOSER	Remove the effect from all previously applied composers.
viz.UNAPPLY_ALL	An alias for (viz.UNAPPLY_NODE \| viz.UNAPPLY_COMPOSER).

Remarks

This command is used to control how the effect is unapplied when it is removed. By default, the remove flags are 0, meaning the effect will not be unapplied when removed.

Return Value

None

Example

effect.setRemoveFlags(viz.UNAPPLY_ALL)
.
.
.
# Effect will be unapplied from nodes and composers
effect.remove()

<effect>.setRemoveFlags

Remarks

Return Value

Example

See also