-
Notifications
You must be signed in to change notification settings - Fork 85
Command Template
Rasmus edited this page Mar 12, 2016
·
1 revision
This is a Command template for the scripting interface (or injecting into the code). This place was made for people coding commands for servers without access to Cmdcreate and the server directory.
/*
Auto-generated command skeleton class.
Use this as a basis for custom commands implemented via the MCGalaxy scripting framework.
File and class should be named a specific way. For example, /update is named 'CmdUpdate.cs' for the file, and 'CmdUpdate' for the class.
*/
// Add any other using statements you need up here, of course.
// As a note, MCGalaxy is designed for .NET 3.5.
using System;
namespace MCGalaxy
{
public class CmdHelloworld : Command
{
// The command's name, in all lowercase. What you'll be putting behind the slash when using it.
public override string name { get { return "helloworld"; } }
// Command's shortcut (please take care not to use an existing one, or you may have issues.
public override string shortcut { get { return ""; } }
// Determines which submenu the command displays in under /help.
public override string type { get { return "other"; } }
// Determines whether or not this command can be used in a museum. Block/map altering commands should be made false to avoid errors.
public override bool museumUsable { get { return false; } }
// Determines the command's default rank. Valid values are:
// LevelPermission.Nobody, LevelPermission.Banned, LevelPermission.Guest
// LevelPermission.Builder, LevelPermission.AdvBuilder, LevelPermission.Operator, LevelPermission.Admin
public override LevelPermission defaultRank { get { return LevelPermission.Banned; } }
// This is where the magic happens, naturally.
// p is the player object for the player executing the command. message is everything after the command invocation itself.
public override void Use(Player p, string message)
{
Player.SendMessage(p, "Hello World!");
}
// This one controls what happens when you use /help [commandname].
public override void Help(Player p)
{
Player.SendMessage(p, "/helloworld - Does stuff. Example command.");
}
}
}