com.planet_ink.coffee_mud.Commands
Class Destroy

java.lang.Object
  com.planet_ink.coffee_mud.Commands.StdCommand
      com.planet_ink.coffee_mud.Commands.Destroy

All Implemented Interfaces:

Command, CMObject, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class Destroy
extends StdCommand

Field Summary

Fields inherited from class com.planet_ink.coffee_mud.Commands.StdCommand

ID

Fields inherited from interface com.planet_ink.coffee_mud.Commands.interfaces.Command

METAFLAG_AS, METAFLAG_FORCED, METAFLAG_MPFORCED, METAFLAG_ORDER, METAFLAG_POSSESSED, METAFLAG_SNOOPED

Constructor Summary

Destroy()

Method Summary

boolean	abilities(MOB mob, java.util.Vector commands)
double	actionsCost(MOB mob, java.util.Vector cmds) Returns the number of actions required to completely activate this command.
void	areas(MOB mob, java.util.Vector commands)
boolean	canBeOrdered() Whether the a group leader or charmer can order their followers to do this command.
boolean	classes(MOB mob, java.util.Vector commands)
double	combatActionsCost(MOB mob, java.util.Vector cmds) Returns the number of actions required to completely activate this command.
boolean	components(MOB mob, java.util.Vector commands)
static boolean	destroyItem(MOB mob, Environmental dropThis, boolean quiet, boolean optimize)
boolean	errorOut(MOB mob)
boolean	execute(MOB mob, java.util.Vector commands, int metaFlags) This method actually performs the command, when the given parsed set of command-line words.
void	exits(MOB mob, java.util.Vector commands)
boolean	expertises(MOB mob, java.util.Vector commands)
java.lang.Thread	findThread(java.lang.String threadName)
java.lang.Thread	findThreadGroup(java.lang.String threadName, java.lang.ThreadGroup tGroup)
java.lang.String[]	getAccessWords() Returns the set of command words, with the most public one first, that are entered by the user to initiate this command.
boolean	items(MOB mob, java.util.Vector commands)
boolean	mobs(MOB mob, java.util.Vector commands)
static boolean	players(MOB mob, java.util.Vector commands)
boolean	races(MOB mob, java.util.Vector commands)
void	rooms(MOB mob, java.util.Vector commands)
void	socials(MOB mob, java.util.Vector commands)
boolean	titles(MOB mob, java.util.Vector commands)

Methods inherited from class com.planet_ink.coffee_mud.Commands.StdCommand

compareTo, copyOf, ID, initializeClass, newInstance, preExecute, securityCheck, staffCommand

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Destroy

public Destroy()

Method Detail

getAccessWords

public java.lang.String[] getAccessWords()

Description copied from interface: Command

Returns the set of command words, with the most public one first, that are entered by the user to initiate this command.

Specified by:

getAccessWords in interface Command

Overrides:

getAccessWords in class StdCommand

Returns:

the set of command words that the user enters

errorOut

public boolean errorOut(MOB mob)

mobs

public boolean mobs(MOB mob,
                    java.util.Vector commands)

players

public static boolean players(MOB mob,
                              java.util.Vector commands)
                       throws java.io.IOException

Throws:

java.io.IOException

findThreadGroup

public java.lang.Thread findThreadGroup(java.lang.String threadName,
                                        java.lang.ThreadGroup tGroup)

findThread

public java.lang.Thread findThread(java.lang.String threadName)

rooms

public void rooms(MOB mob,
                  java.util.Vector commands)
           throws java.io.IOException

Throws:

java.io.IOException

exits

public void exits(MOB mob,
                  java.util.Vector commands)

items

public boolean items(MOB mob,
                     java.util.Vector commands)

areas

public void areas(MOB mob,
                  java.util.Vector commands)
           throws java.io.IOException

Throws:

java.io.IOException

races

public boolean races(MOB mob,
                     java.util.Vector commands)

components

public boolean components(MOB mob,
                          java.util.Vector commands)

expertises

public boolean expertises(MOB mob,
                          java.util.Vector commands)

titles

public boolean titles(MOB mob,
                      java.util.Vector commands)

classes

public boolean classes(MOB mob,
                       java.util.Vector commands)

abilities

public boolean abilities(MOB mob,
                         java.util.Vector commands)

socials

public void socials(MOB mob,
                    java.util.Vector commands)
             throws java.io.IOException

Throws:

java.io.IOException

destroyItem

public static boolean destroyItem(MOB mob,
                                  Environmental dropThis,
                                  boolean quiet,
                                  boolean optimize)

execute

public boolean execute(MOB mob,
                       java.util.Vector commands,
                       int metaFlags)
                throws java.io.IOException

Description copied from interface: Command

This method actually performs the command, when the given parsed set of command-line words. The commands list is almost always the set of strings, starting with the access word that triggered the command. Some commands have custom APIs however, that allow almost anything to be in the commands list, or even for the commands to be null. This method is not allowed to be called until the player or mob has satisfied the actionsCost requirements and the securityCheck

Specified by:

execute in interface Command

Overrides:

execute in class StdCommand

Parameters:

mob - the mob or player issueing the command

commands - usually the command words and parameters; a set of strings

metaFlags - flags denoting how the command is being executed

Returns:

whether the command was successfully executed. Is almost meaningless.

Throws:

java.io.IOException - usually means the player has dropped carrier

See Also:

Command.actionsCost(MOB, Vector), Command.securityCheck(MOB)

combatActionsCost

public double combatActionsCost(MOB mob,
                                java.util.Vector cmds)

Description copied from interface: Command

Returns the number of actions required to completely activate this command. A value of 0.0 means perform instantly. This method only applies when the user is fighting in combat.

Specified by:

combatActionsCost in interface Command

Overrides:

combatActionsCost in class StdCommand

Parameters:

mob - the mob executing the command, if any

cmds - the parameters to be passed to the command, if any

Returns:

the number of player free actions required to do this

See Also:

Command.actionsCost(MOB, Vector)

actionsCost

public double actionsCost(MOB mob,
                          java.util.Vector cmds)

Description copied from interface: Command

Returns the number of actions required to completely activate this command. A value of 0.0 means perform instantly. This method only applies when the user is not in combat.

Specified by:

actionsCost in interface Command

Overrides:

actionsCost in class StdCommand

Parameters:

mob - the mob executing the command, if any

cmds - the parameters to be passed to the command, if any

Returns:

the number of player free actions required to do this

See Also:

Command.combatActionsCost(MOB, Vector)

canBeOrdered

public boolean canBeOrdered()

Description copied from interface: Command

Whether the a group leader or charmer can order their followers to do this command.

Specified by:

canBeOrdered in interface Command

Overrides:

canBeOrdered in class StdCommand

Returns:

whether this command can be ordered.