[This is preliminary documentation and is subject to change.]
[Missing <summary> documentation for "T:fCraft.Drawing.UndoDrawOperation"]
Assembly: fCraft (in fCraft.dll) Version: 0.6.2.4 (0.6.2.4)
Syntax
| C# |
public sealed class UndoDrawOperation : DrawOpWithBrush
Members
| All Members | Constructors  | Fields  | Properties  | Methods |
 Public Protected | Instance Static  | Declared Inherited | XNA Framework Only  .NET Compact Framework Only  |
| Member | Description | |
|---|---|---|
| UndoDrawOperation(Player, UndoState, Boolean) | Initializes a new instance of the UndoDrawOperation class |
| AnnounceCompletion | Whether completion or cancellation of this DrawOperation should be announced to Player. (Inherited from DrawOperation.) |
| Begin()()()() | (Overrides DrawOperation..::..Begin()()()().) |
| BlocksDenied | Number of blocks/coordinates that were supposed to be changed/updated,
but were left untouched due to permission issues. (Inherited from DrawOperation.) |
| BlocksLeftToProcess | Estimated total blocks left to process. (Inherited from DrawOperation.) |
| BlocksProcessed | Number of blocks/coordinates that were considered for drawing. (Inherited from DrawOperation.) |
| 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. (Inherited from DrawOperation.) |
| 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. (Inherited from DrawOperation.) |
| BlocksUpdated | Number of blocks/coordinates that ended up being changed/updated. (Inherited from DrawOperation.) |
| 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. (Inherited from DrawOperation.) |
| Brush | Brush used to determine which blocks to place.
Must be assigned before DrawOperation.Prepare() is called. (Inherited from DrawOperation.) |
| Cancel()()()() | (Inherited from DrawOperation.) |
| Context | Block change context, to be reported to BlockDB and Player.PlacingBlock/PlacedBlock events.
Should include BlockChangeContext.Drawn flag. (Inherited from DrawOperation.) |
| Coords | Coordinates that are currently being processed. (Inherited from DrawOperation.) |
| Description | (Overrides DrawOpWithBrush..::..Description.) |
| DrawBatch(Int32) | (Overrides DrawOperation..::..DrawBatch(Int32).) |
 | DrawOneBlock()()()() | (Inherited from DrawOperation.) |
| Equals(Object) | (Inherited from Object.) |
| ExpectedMarks | (Overrides DrawOperation..::..ExpectedMarks.) |
| 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). (Inherited from DrawOperation.) |
| IsCancelled | Whether this operation has been cancelled (e.g. by /Undo or /WLock). (Inherited from DrawOperation.) |
| IsDone | Whether this operation is done (has finished or had been cancelled). (Inherited from DrawOperation.) |
| LogCompletion | Whether completion or cancellation of this DrawOperation should be logged. (Inherited from DrawOperation.) |
| Map | Map to draw blocks to. (Inherited from DrawOperation.) |
| Marks | Marks given by the player to this command. Marks could come from either clicks or /Mark command.
Set by DrawOperation.Prepare() (Inherited from DrawOperation.) |
| MemberwiseClone()()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) |
| Name | (Overrides DrawOperation..::..Name.) |
| NextBlock()()()() | (Overrides DrawOpWithBrush..::..NextBlock()()()().) |
| PercentDone | Approximate completion percentage of this command. (Inherited from DrawOperation.) |
| Player | Player who is executing this command.
Used for both permission checks and messaging. (Inherited from DrawOperation.) |
| Prepare(array<Vector3I>[]()[][]) | (Overrides DrawOperation..::..Prepare(array<Vector3I>[]()[][]).) |
| ReadParams(Command) | (Overrides DrawOpWithBrush..::..ReadParams(Command).) |
| Redo | |
| StartTime | Time when the draw operatation began. Set by DrawOperation.Begin() (Inherited from DrawOperation.) |
| State | |
 | TimeToEndBatch | (Inherited from DrawOperation.) |
| ToString()()()() | (Inherited from Object.) |
 | UndoState | Undo state associated with this operation. Created by DrawOperation.Begin(). (Inherited from DrawOperation.) |
| UseAlternateBlock | Whether the brush should use alternate block (if available)
for filling insides of hollow DrawOps. Currently only usable with NormalBrush. (Inherited from DrawOperation.) |
Inheritance Hierarchy
System..::..Object
fCraft.Drawing..::..DrawOperation
fCraft.Drawing..::..DrawOpWithBrush
fCraft.Drawing..::..UndoDrawOperation
fCraft.Drawing..::..DrawOperation
fCraft.Drawing..::..DrawOpWithBrush
fCraft.Drawing..::..UndoDrawOperation
