/*
	Copyright 2011 MCForge
	
	Dual-licensed under the	Educational Community License, Version 2.0 and
	the GNU General Public License, Version 3 (the "Licenses"); you may
	not use this file except in compliance with the Licenses. You may
	obtain a copy of the Licenses at
	
	http://www.opensource.org/licenses/ecl2.php
	http://www.gnu.org/licenses/gpl-3.0.html
	
	Unless required by applicable law or agreed to in writing,
	software distributed under the Licenses are distributed on an "AS IS"
	BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
	or implied. See the Licenses for the specific language governing
	permissions and limitations under the Licenses.
*/
using System;

namespace MCGalaxy.Commands {
    public sealed class CmdGarbage : Command {
        public override string name { get { return "garbage"; } }
        public override string shortcut { get { return ""; } }
        public override string type { get { return CommandTypes.Other; } }
        public override bool museumUsable { get { return true; } }
        public override LevelPermission defaultRank { get { return LevelPermission.Operator; } }
        public CmdGarbage() { }

        public override void Use(Player p, string message) {
            Player.Message(p, "Forcing garbage collection...");
            GC.Collect();
            GC.WaitForPendingFinalizers();
            Player.Message(p, "Garbage collection completed!");
        }
        
        public override void Help(Player p) {
            Player.Message(p, "%T/garbage");
            Player.Message(p, "%HForces the .NET garbage collector to run, which releases unused memory. You shouldn't need to use this often.");
        }
    }
}
