[This is preliminary documentation and is subject to change.]
Abstract class representing a drawing operation.
Namespace: fCraft.DrawingAssembly: fCraft (in fCraft.dll) Version: 0.6.2.4 (0.6.2.4)
Syntax
| C# |
public abstract class DrawOperation
Members
| All Members | Constructors | Fields | Properties | Methods | Events |
| Member | Description | |
|---|---|---|
| DrawOperation(Player) | Initializes a new instance of the DrawOperation class | |
| AnnounceCompletion | Whether completion or cancellation of this DrawOperation should be announced to Player. | |
| Began | ||
| Begin()()()() | ||
| Beginning | ||
| 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. | |
| Cancel()()()() | ||
| Context | Block change context, to be reported to BlockDB and Player.PlacingBlock/PlacedBlock events.
Should include BlockChangeContext.Drawn flag. | |
| Coords | Coordinates that are currently being processed. | |
| Description | Compact description of this specific draw operation,
with any instance-specific parameters,
and the brush's instance description. | |
| DrawBatch(Int32) | ||
| DrawOneBlock()()()() | ||
| Ended | ||
| Equals(Object) | (Inherited from Object.) | |
| ExpectedMarks | Expected number of marks to pass to DrawOperation.Prepare() | |
| Finalize()()()() |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) | |
| GetHashCode()()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) | |
| GetType()()()() |
Gets the Type of the current instance.
(Inherited from Object.) | |
| 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). | |
| LineEnumerator(Vector3I, Vector3I) | ||
| LogCompletion | Whether completion or cancellation of this DrawOperation should be logged. | |
| Map | Map to draw blocks to. | |
| Marks | Marks given by the player to this command. Marks could come from either clicks or /Mark command.
Set by DrawOperation.Prepare() | |
| MemberwiseClone()()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) | |
| Name | General name of this type of draw operation. Should be same for all instances. | |
| PercentDone | Approximate completion percentage of this command. | |
| Player | Player who is executing this command.
Used for both permission checks and messaging. | |
| Prepare(array<Vector3I>[]()[][]) | ||
| RaiseBeganEvent(DrawOperation) | ||
| RaiseBeginningEvent(DrawOperation) | ||
| RaiseEndedEvent(DrawOperation) | ||
| StartTime | Time when the draw operatation began. Set by DrawOperation.Begin() | |
| TimeToEndBatch | ||
| ToString()()()() | (Inherited from Object.) | |
| UndoState | Undo state associated with this operation. Created by DrawOperation.Begin(). | |
| UseAlternateBlock | Whether the brush should use alternate block (if available)
for filling insides of hollow DrawOps. Currently only usable with NormalBrush. |
Inheritance Hierarchy
System..::..Object
fCraft.Drawing..::..DrawOperation
fCraft.Drawing..::..CuboidDrawOperation
fCraft.Drawing..::..CuboidHollowDrawOperation
fCraft.Drawing..::..CuboidWireframeDrawOperation
fCraft.Drawing..::..CutDrawOperation
fCraft.Drawing..::..DrawOpWithBrush
fCraft.Drawing..::..EllipsoidDrawOperation
fCraft.Drawing..::..EllipsoidHollowDrawOperation
fCraft.Drawing..::..LineDrawOperation
fCraft.Drawing..::..TorusDrawOperation
fCraft.Drawing..::..TriangleDrawOperation
fCraft.Drawing..::..TriangleWireframeDrawOperation
fCraft.Drawing..::..DrawOperation
fCraft.Drawing..::..CuboidDrawOperation
fCraft.Drawing..::..CuboidHollowDrawOperation
fCraft.Drawing..::..CuboidWireframeDrawOperation
fCraft.Drawing..::..CutDrawOperation
fCraft.Drawing..::..DrawOpWithBrush
fCraft.Drawing..::..EllipsoidDrawOperation
fCraft.Drawing..::..EllipsoidHollowDrawOperation
fCraft.Drawing..::..LineDrawOperation
fCraft.Drawing..::..TorusDrawOperation
fCraft.Drawing..::..TriangleDrawOperation
fCraft.Drawing..::..TriangleWireframeDrawOperation