[This is preliminary documentation and is subject to change.]
The DrawOperation type exposes the following properties.
Properties
| Member | Description | |
|---|---|---|
| AlternateBlockIndex | Whether the brush should use alternate block (if available)
for filling insides of hollow DrawOps. Currently only supported by NormalBrush.
Used with CuboidH/CuboidW/EllipsoidH drawops. | |
| AnnounceCompletion | Whether completion or cancellation of this DrawOperation should be announced to Player. | |
| BlocksDenied | Number of blocks/coordinates that were supposed to be changed/updated,
but were left untouched due to permission issues. | |
| BlocksLeftToProcess | Estimated total blocks left to process. | |
| BlocksProcessed | Number of blocks/coordinates that were considered for drawing. | |
| BlocksSkipped | Number of blocks/coordinates that were processed, and left untouched: either because the Brush decided to skip it,
or because map's current block matched the desired blocktype. | |
| BlocksTotalEstimate | Estimate of total number of blocks that will be processed by this command.
Should be as accurate as reasonably possible by DrawOperation.Prepare().
Used for volume permission checks. Must not be negative. | |
| BlocksUpdated | Number of blocks/coordinates that ended up being changed/updated. | |
| Bounds | Area that bounds the DrawOperation's extent, if possible to estimate in advance.
Used for logging. Should be assigned, as accurately as possible, before DrawOp finishes. | |
| Brush | Brush used to determine which blocks to place.
Must be assigned before DrawOperation.Prepare() is called. | |
| Context | Block change context, to be reported to BlockDB and Player.PlacingBlock/PlacedBlock events.
Should include BlockChangeContext.Drawn flag. | |
| Description | Compact description of this specific draw operation,
with any instance-specific parameters,
and the brush's instance description. | |
| ExpectedMarks | Expected number of marks to pass to DrawOperation.Prepare() | |
| HasBegun | Whether this operation has been started (queued for processing on the Map). | |
| IsCancelled | Whether this operation has been cancelled (e.g. by /Undo or /WLock). | |
| IsDone | Whether this operation is done (has finished or had been cancelled). | |
| LogCompletion | Whether completion or cancellation of this DrawOperation should be logged. | |
| Marks | Marks given by the player to this command. Marks could come from either clicks or /Mark command.
Set by DrawOperation.Prepare() | |
| Name | General name of this type of draw operation. Should be same for all instances. | |
| PercentDone | Approximate completion percentage of this command. | |
| StartTime | Time when the draw operatation began. Set by DrawOperation.Begin() | |
| TimeToEndBatch |