Command

Command is a lua class assisting in creating new player commands.

Functions

• Command:New(Command name) – Used to create a new instance.
• self:register() – Used to register the command.
• self.handler(event) – Override to set callback for the command.

Variables

• self.words – The word used for calling the function.
• self.groups – The groups allowed to use the command, use "All" to let all groups use the command and use group names in an array to let certain groups use the command. Ex. {"Gamemaster", "Senior Gamemaster"}.

Event Structure

• event.player – The player who called the command.
• event.param – The parameter passed in the command. Ex. /goto Azlan.

Examples

A command that creates a new monster

local CreateMonster = Command:new("CreateMonster")

CreateMonster.words = "/m"
CreateMonster.groups = {"Gamemaster", "Senior Gamemaster", "Community Manager", "Server Administrator"}

function CreateMonster.handler(event)
	local name = event.param:strip_whitespace()
	local monster = createMonster(name, event.creature:getPosition())

	if not monster then
		sendMagicEffect(event.creature:getPosition(), MAGIC_EFFECT_POFF)
		event.creature:sendNote("Could not summon monster '" .. name .. "'.");
	end
end

CreateMonster:register()