Scripting API

<<BrushStrokes Main Index Buttonize>>
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

Burn

Script Name: Burn
Name: Burn
Library: ToolPaint
Description: Darkens areas in the image that are too light.
Status bar text: Burn Brush: Use to darken areas in images that are too light
Tool tip text: Burn Brush
Undo text: Burn Brush
 
Parameter Repository:
NameScript NameType Description Supports None Default Minimum Maximum
Brush TipBrushTipParameter RepositoryBrush tip parametersNo
BrushBrushParameter RepositoryBrush settings.No
Invert OperationInvertOperationEnumeration (Boolean)If set to TRUE opposite operation will be performed.NoFalse
LimitLimitEnumeration (TonalRange)Limit modified pixels based upon brightnessNoNone
Foreground MaterialForegroundMaterialParameter RepositoryThe foreground 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
UsesCachedMaterials: true
ProcessChanges: true
FinalizeTransient: true
 
Resource Attributes: