Scripting API

<<EnhanceEdgesMore Main Index Erode>>
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Eraser

Script Name: Eraser
Name: Eraser
Library: ToolPaint
Description: Erase an area on the image.
Status bar text: Eraser Tool: Use to replace colors in image with background color or transparency
Tool tip text: Eraser Tool
Undo text: Eraser Brush
 
Parameter Repository:
NameScript NameType Description Supports None Default Minimum Maximum
Brush TipBrushTipParameter RepositoryBrush tip parametersNo
BrushBrushParameter RepositoryBrush settings.No
Primary MaterialPrimaryMaterialEnumeration (MaterialRef)The primary material for the tool action, foreground or background.NoForeground
Foreground MaterialForegroundMaterialParameter RepositoryThe foreground material.Yes
Background MaterialBackgroundMaterialParameter RepositoryThe background material.Yes
StrokeStrokeListThe path of the brush stroke.No0
General SettingsGeneralSettingsParameter RepositoryContains parameters that control the execution of the command.No
 
Command Attributes:
IsExternal: true
IsUndoable: true
NoRepeat: true
Has Random Seed: true
DisallowNullMaterial: true
UsesCachedMaterials: true
ProcessChanges: true
FinalizeTransient: true
 
Resource Attributes: