Drawing command example

[dzienny]

Below is a sample code that draws a cube. It contains comments to help you understand how it works. It also uses a new API elements that significantly simplifies the process of capturing player block changes.

It works only with MCDzienny version 10.1+

Code: Select all

using System;
using System.Collections.Generic;

namespace MCDzienny
{
    public class CmdSimpleCuboid : Command
    {
        public override string name { get { return "scuboid"; } }
        public override string shortcut { get { return ""; } }
        public override string type { get { return "build"; } }
        public override bool museumUsable { get { return false; } }
        public override LevelPermission defaultRank { get { return LevelPermission.Builder; } }

        // Usually for building commands the console access should be set to false.
        public override bool ConsoleAccess { get { return false; } }

        public override void Use(Player p, string message)
        {
            byte block = Block.Zero;

            // Parse a block type if specified.
            if (message != "")
            {
                block = Block.Parse(message);

                // Check if the block was parsed correctly.
                if (block == Block.Zero)
                {
                    Player.SendMessage(p, "Unknown block type.");
                    return;
                }

                // Check if the player can place the given block type.
                if (!Block.canPlace(p, block))
                {
                    Player.SendMessage(p, "You can't place this block type.");
                    return;
                }
            }

            // Capture two block changes.
            Player.SendMessage(p, "Place two blocks to determine the edges.");
            BlockCatch.CaptureMultipleBlocks(p, 2, DrawCuboid, new BasicDrawArgs(block));
        }

        private void DrawCuboid(Player p, List<ChangeInfo> changes, BasicDrawArgs da)
        {
            // Set a block type to the block last placed by a player.
            byte block = changes[1].Type;

            // If the block type was specified earlier set it.
            if (da.Type1 != Block.Zero)
                block = da.Type1;

            // Find the start and the end points of the cube.
            // Mind that Y represents a height!
            int startX = Math.Min(changes[0].X, changes[1].X);
            int endX = Math.Max(changes[0].X, changes[1].X);
            int startY = Math.Min(changes[0].Y, changes[1].Y);
            int endY = Math.Max(changes[0].Y, changes[1].Y);
            int startZ = Math.Min(changes[0].Z, changes[1].Z);
            int endZ = Math.Max(changes[0].Z, changes[1].Z);

            // Add every block between two points to the block changes list.
            for (int x = startX; x <= endX; x++)
                for (int y = startY; y <= endY; y++)
                    for (int z = startZ; z <= endZ; z++)
                    {
                        p.BlockChanges.Add(x, y, z, block);
                    }

            // Check if the player can place that many blocks if not abort the changes.
            if (p.group.maxBlocks < p.BlockChanges.Count)
            {
                Player.SendMessage(p, string.Format("You can't place {0} blocks. Your limit is {1}."
                    , p.BlockChanges.Count, p.group.maxBlocks));
                p.BlockChanges.Abort();
                return;
            }

            // Send the block changes.
            Player.SendMessage(p, string.Format("You've built a simple cuboid that consists of {0} blocks."
                , p.BlockChanges.Count));
            p.BlockChanges.Commit();

            // If the static mode is on, repeat.
            if (p.staticCommands)
                BlockCatch.CaptureMultipleBlocks(p, 2, DrawCuboid, da);
        }

        public override void Help(Player p)
        {
            Player.SendMessage(p, "/scuboid <block> - draws a simple cuboid.");
            Player.SendMessage(p, "block - a block type e.g. water, it's optional.");
        }
    }
}

[Conor]

The new block change methods/events look really nice; improved and easy to understand.

Thanks.

[Conor]

[Sorry for double post]

However, does this render all previous custom commands using the old blockchange event as unusable?

I am imagining you would still keep this functionality to save a lot of hassle, but just checking - you can still use the old way?

[dzienny]

It just a method that provides higher abstraction level. Under the hood it works pretty much the old way. The backward compatibility is kept, so no worries. I try hard not to break already existing custom commands.

[ismellike]

It won't compile for me.

It says that "these don't contain definitions for that"

Code: Select all

da.Type1;
Block.Parse(message);
p.BlockChanges

I have the reference for mcdzienny_ set to the latest version

[dzienny]

@ismellike

I know it's a bit confusing but the current version is 10.0.1, and the feature will be available in the version 10.1

[ismellike]

That would make sense lol, didn't see the mcdzienny 10.1+ part