Skip block

[Hellenion]

Imitates the skip block behaviour from 0.700

It may not be as sophisticated as f's implementation but this was the easiest way for modders to copy it.

Patch:

Show

Code: Select all

Index: fCraft/Commands/BuildingCommands.cs
===================================================================
--- fCraft/Commands/BuildingCommands.cs	(revision 1634)
+++ fCraft/Commands/BuildingCommands.cs	(working copy)
@@ -546,6 +546,8 @@
             Block block = map.GetBlock( coord );
             if( block == drawBlock ) return;
 
+			if( block == Block.Skip ) return;
+			
             if( player.CanPlace( map, coord, drawBlock, context ) != CanPlaceResult.Allowed ) {
                 blocksDenied++;
                 return;

Index: fCraft/Commands/WorldCommands.cs
===================================================================
--- fCraft/Commands/WorldCommands.cs	(revision 1634)
+++ fCraft/Commands/WorldCommands.cs	(working copy)
@@ -666,7 +666,7 @@
 
                 case "edge":
                     Block block = Map.GetBlockByName( valueText );
-                    if( block == Block.Undefined ) {
+                    if( block == Block.Undefined || block == Block.Skip ) {
                         CdEnv.PrintUsage( player );
                         return;
                     }

Index: fCraft/World/Block.cs
===================================================================
--- fCraft/World/Block.cs	(revision 1634)
+++ fCraft/World/Block.cs	(working copy)
@@ -4,6 +4,7 @@
     /// <summary> Enumeration of all standard Minecraft Classic block types. </summary>
     public enum Block : byte {
         Undefined = 255, // for error checking
+		Skip = 50, //May safely be changed if in conflict, do update the binding array in Player.cs.
 
         Air = 0,
         Stone = 1,

Index: fCraft/Drawing/DrawOperation.cs
===================================================================
--- fCraft/Drawing/DrawOperation.cs	(revision 1634)
+++ fCraft/Drawing/DrawOperation.cs	(working copy)
@@ -214,7 +214,7 @@
             int blockIndex = Map.Index( Coords );
 
             Block oldBlock = (Block)Map.Blocks[blockIndex];
-            if( oldBlock == newBlock ) {
+            if( oldBlock == newBlock  || newBlock == Block.Skip ) {
                 BlocksSkipped++;
                 return false;
             }

Index: fCraft/Player/Player.cs
===================================================================
--- fCraft/Player/Player.cs	(revision 1634)
+++ fCraft/Player/Player.cs	(working copy)
@@ -824,6 +824,12 @@
                 return false;
             }
 
+			if( type == Block.Skip )
+			{
+				RevertBlockNow( coord );
+				return false;
+			}
+
             CanPlaceResult canPlaceResult;
             if( type == Block.Stair && coord.Z > 0 && map.GetBlock( coordBelow ) == Block.Stair ) {
                 // stair stacking
@@ -944,7 +950,7 @@
 
         #region Binding
 
-        readonly Block[] bindings = new Block[50];
+        readonly Block[] bindings = new Block[51];
 
         public void Bind( Block type, Block replacement ) {
             bindings[(byte)type] = replacement;

Manual implementation:

Show

fCraft/Commands/BuildingCommands.cs: line 548
add:

Code: Select all

			if( block == Block.Skip ) return;
			

fCraft/Commands/WorldCommands.cs: line 669
Change:

Code: Select all

                    if( block == Block.Undefined || block == Block.Skip ) {

fCraft/World/Block.cs: line 7
Add:

Code: Select all

		Skip = 50, //May safely be changed if in conflict, do update the binding array in Player.cs.

fCraft/Drawing/DrawOperation.cs: line 217
Change:

Code: Select all

            if( oldBlock == newBlock  || newBlock == Block.Skip ) {

fCraft/Player/Player.cs: line 827
Add:

Code: Select all

			if( type == Block.Skip )
			{
				RevertBlockNow( coord );
				return false;
			}

fCraft/Player/Player.cs: near line 953 or near line 947
Change:

Code: Select all

        readonly Block[] bindings = new Block[51];

[fragmer]

The official skip-block support was added in r1458-r1459. Here's the diff (won't be applicable to 0.6xx).

The most notable change was rewroting CommandReader.NextBlock(), CommandReader.NextBlockWithParam(), and Map.GetBlockByName(). Previously they just took a string and a player name, and returned Block. Now they write result into an "out" variable, and return a bool. This allows me to distinguish between cases where "skip" block was given and when an unrecognized block name was given.

Code: Select all

/// <summary> Finds Block corresponding to given blockName. </summary>
/// <param name="blockName"> Given block name to parse. </param>
/// <param name="allowNoneBlock"> Whether "none" block type is acceptible. </param>
/// <param name="block"> Block corresponding to given blockName;
/// Block.None if value could not be parsed. </param>
/// <returns> True if given blockName was parsed as an acceptible block type. </returns>
/// <exception cref="ArgumentNullException"> If blockName is null. </exception>
public static bool GetBlockByName( [NotNull] string blockName, bool allowNoneBlock, out Block block ) {...

So a typical usage before was...

Code: Select all

Block block = cmd.NextBlock( Player );
if( block == Block.Undefined ){
    // unrecognized block name
}else{
    // normal blocktype given
}

...and now it became...

Code: Select all

Block block;
if( !cmd.NextBlock( Player, true, out block ) ){
    // unrecognized block name
}else if( block == Block.None ){
    // "none" blocktype given
}else{
    // normal blocktype given
}

[fragmer]

I merged the official "skip" block implementation with fCraft 0.630:

fcraft: fragmer * r1646 /branch-0.60x/fCraft/ (34 files in 9 dirs):
Added support for "none" block in brushes - http://forum.fcraft.net/viewtopic.php?p=18087
Rewrote CommandReader.NextBlock, CommandReader.NextBlockWithParam, and Map.GetBlockByName to accommodate the change.
Renamed Block.Undefined to Block.None