com.planet_ink.coffee_mud.Commands
Class Shutdown

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

All Implemented Interfaces:

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

public class Shutdown
extends StdCommand
implements Tickable

Field Summary

protected java.lang.String	externalCommand
protected boolean	keepItDown
protected long	shuttingDownCompletes
protected MOB	shuttingDownMob
protected long	shuttingDownNextAnnounce

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

ID, noCoinFilter

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.Tickable

STATUS_AFFECT, STATUS_ALIVE, STATUS_BEHAVIOR, STATUS_CLASS, STATUS_DEAD, STATUS_END, STATUS_FIGHT, STATUS_MISC, STATUS_MISC2, STATUS_MISC3, STATUS_MISC4, STATUS_MISC5, STATUS_MISC6, STATUS_MISC7, STATUS_NOT, STATUS_OTHER, STATUS_RACE, STATUS_REBIRTH, STATUS_SCRIPT, STATUS_START, STATUS_WEATHER, TICKID_AREA, TICKID_BEAMWEAPON, TICKID_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_ELECTRONICS, TICKID_EMAIL, TICKID_EXIT_BEHAVIOR, TICKID_EXIT_REOPEN, TICKID_ITEM_BEHAVIOR, TICKID_ITEM_BOUNCEBACK, TICKID_LIGHT_FLICKERS, TICKID_LIVEAUCTION, TICKID_LONGERMASK, TICKID_MISCELLANEOUS, TICKID_MOB, TICKID_PROPERTY_SPECIAL, TICKID_QUEST, TICKID_READYTOSTOP, TICKID_ROOM_BEHAVIOR, TICKID_ROOM_ITEM_REJUV, TICKID_SOLITARYMASK, TICKID_SPECIALCOMBAT, TICKID_SPECIALMANEUVER, TICKID_SPELL_AFFECT, TICKID_SUPPORT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET

Constructor Summary

Shutdown()

Method Summary

boolean	canBeOrdered() Whether the a group leader or charmer can order their followers to do this command.
boolean	execute(MOB mob, java.util.List<java.lang.String> commands, int metaFlags) This method actually performs the command, when the given parsed set of command-line words.
java.lang.Object	executeInternal(MOB mob, int metaFlags, java.lang.Object... args) This method is used for making "insider" calls to the command.
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.
protected java.lang.String	getDisplayableShutdownTimeRemaining()
int	getTickStatus() A coded status for this object during the period where its tick method is being called.
java.lang.String	name() The displayable name of this object.
boolean	securityCheck(MOB mob) Whether this command is available to the given player
protected void	showDisplayableShutdownTimeRemaining()
void	startShutdown(MOB mob)
boolean	tick(Tickable ticking, int tickID) this is the method which is called periodically by the threading engine.

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

actionsCost, checkArguments, checkedActionsCost, combatActionsCost, compareTo, copyOf, I, ID, initializeClass, L, newInstance, preExecute

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

copyOf, ID, initializeClass, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

shuttingDownMob

protected MOB shuttingDownMob

shuttingDownNextAnnounce

protected long shuttingDownNextAnnounce

shuttingDownCompletes

protected long shuttingDownCompletes

keepItDown

protected boolean keepItDown

externalCommand

protected java.lang.String externalCommand

Constructor Detail

Shutdown

public Shutdown()

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

getDisplayableShutdownTimeRemaining

protected java.lang.String getDisplayableShutdownTimeRemaining()

showDisplayableShutdownTimeRemaining

protected void showDisplayableShutdownTimeRemaining()

execute

public boolean execute(MOB mob,
                       java.util.List<java.lang.String> 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, List), Command.securityCheck(MOB)

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.

securityCheck

public boolean securityCheck(MOB mob)

Description copied from interface: Command

Whether this command is available to the given player

Specified by:

securityCheck in interface Command

Overrides:

securityCheck in class StdCommand

Parameters:

mob - the player mob who might not even know about this command

Returns:

true if the command is available, and false if it is unknown

startShutdown

public void startShutdown(MOB mob)

getTickStatus

public int getTickStatus()

Description copied from interface: Tickable

A coded status for this object during the period where its tick method is being called. The statis is defined, at least in part, by constants in this interface STATUS_*. STATUS_NOT should be returned when the objects tick method is not currently in execution. It should never return STATUS_NOT when the objects tick method is in execution.

Specified by:

getTickStatus in interface Tickable

Returns:

the numeric status of this object

See Also:

Tickable.tick(Tickable, int)

name

public java.lang.String name()

Description copied from interface: CMObject

The displayable name of this object. May be modified by phyStats() object. Is derived from the Name().

Specified by:

name in interface CMObject

Specified by:

name in interface Tickable

Overrides:

name in class StdCommand

Returns:

the modified final name of this object on the map.

See Also:

Environmental.Name()

tick

public boolean tick(Tickable ticking,
                    int tickID)

Description copied from interface: Tickable

this is the method which is called periodically by the threading engine. How often it is called depends on the parameters passed to the threadding engine when it is submitted for thread access. Typically the period is once per TIME_TICK period, but that is determined when the object is submitted to the thread engine.

Specified by:

tick in interface Tickable

Parameters:

ticking - a reference to this Tickable object

tickID - the TICKID_ constant describing this periodic call, as defined in Tickable

Returns:

true always, unless this object no longer wishes to ever tick again, in which case false

See Also:

Tickable, ServiceEngine, TickableGroup

executeInternal

public java.lang.Object executeInternal(MOB mob,
                                        int metaFlags,
                                        java.lang.Object... args)
                                 throws java.io.IOException

Description copied from interface: Command

This method is used for making "insider" calls to the command. It's parameters and implementation can follow any rules you like. The engine will sometimes use these to make direct calls to the command implementations.

Specified by:

executeInternal in interface Command

Overrides:

executeInternal in class StdCommand

Parameters:

mob - the mob or player issueing the command

metaFlags - flags denoting how the command is being executed

args - a set of object parameters

Returns:

a object response

Throws:

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