com.planet_ink.coffee_mud.Commands
Class Skills

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

All Implemented Interfaces:

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

Direct Known Subclasses:

Chants, Languages, Prayers, Qualify, Report, Songs, Spells, Stat, WillQualify

public class Skills
extends StdCommand

Field Summary

protected static java.util.Comparator<Ability>

nameComparator

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

ID, noCoinFilter

Constructor Summary

Skills()

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.
protected java.lang.StringBuilder	getAbilities(MOB viewerM, MOB ableM, int ofType, int ofDomain, boolean addQualLine, int maxLevel)
protected java.lang.StringBuilder	getAbilities(MOB viewerM, MOB ableM, java.util.List<java.lang.Integer> ofTypes, int mask, boolean addQualLine, int maxLevel)
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	isDomainIncludedInAnyAbility(int domain, int acode) Returns whether there are any crossings between a particular Ability type and a particular Ability domain.
protected void	parseDomainInfo(MOB mob, java.util.List<java.lang.String> commands, java.util.Vector<java.lang.Integer> acodes, int[] level, int[] domain, java.lang.String[] domainName)
protected boolean	parsedOutIndividualSkill(MOB mob, java.lang.String qual, int acode)
protected boolean	parsedOutIndividualSkill(MOB mob, java.lang.String qual, java.util.List<java.lang.Integer> acodes)
protected int	parseOutLevel(java.util.List<java.lang.String> commands)

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

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

Methods inherited from class java.lang.Object

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

Field Detail

nameComparator

protected static final java.util.Comparator<Ability> nameComparator

Constructor Detail

Skills

public Skills()

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

parsedOutIndividualSkill

protected boolean parsedOutIndividualSkill(MOB mob,
                                           java.lang.String qual,
                                           int acode)

parsedOutIndividualSkill

protected boolean parsedOutIndividualSkill(MOB mob,
                                           java.lang.String qual,
                                           java.util.List<java.lang.Integer> acodes)

parseOutLevel

protected int parseOutLevel(java.util.List<java.lang.String> commands)

isDomainIncludedInAnyAbility

public boolean isDomainIncludedInAnyAbility(int domain,
                                            int acode)

Returns whether there are any crossings between a particular Ability type and a particular Ability domain.

Parameters:

domain - the domain mask

acode - the ability code

Returns:

true if they meet somewhere

See Also:

Ability.abilityCode(), Ability.DOMAIN_DESCS, Ability.ACODE_DESCS

parseDomainInfo

protected void parseDomainInfo(MOB mob,
                               java.util.List<java.lang.String> commands,
                               java.util.Vector<java.lang.Integer> acodes,
                               int[] level,
                               int[] domain,
                               java.lang.String[] domainName)

getAbilities

protected java.lang.StringBuilder getAbilities(MOB viewerM,
                                               MOB ableM,
                                               int ofType,
                                               int ofDomain,
                                               boolean addQualLine,
                                               int maxLevel)

getAbilities

protected java.lang.StringBuilder getAbilities(MOB viewerM,
                                               MOB ableM,
                                               java.util.List<java.lang.Integer> ofTypes,
                                               int mask,
                                               boolean addQualLine,
                                               int maxLevel)

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.