com.planet_ink.coffee_mud.Items.MiscMagic
Class StdDeckOfCards

java.lang.Object
  com.planet_ink.coffee_mud.Items.Basic.StdItem
      com.planet_ink.coffee_mud.Items.Basic.StdContainer
          com.planet_ink.coffee_mud.Items.MiscMagic.StdHandOfCards
              com.planet_ink.coffee_mud.Items.MiscMagic.StdDeckOfCards

All Implemented Interfaces:

Behavable, CMModifiable, CMObject, Environmental, MsgListener, Rider, StatsAffecting, Tickable, Container, DeckOfCards, HandOfCards, Item, MiscMagic, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class StdDeckOfCards
extends StdHandOfCards
implements DeckOfCards

Field Summary

protected java.util.Vector

cardsCache

Fields inherited from class com.planet_ink.coffee_mud.Items.Basic.StdContainer

capacity, containType, hasALid, hasALock, isLocked, isOpen

Fields inherited from class com.planet_ink.coffee_mud.Items.Basic.StdItem

affects, baseEnvStats, baseGoldValue, behaviors, CODES, databaseID, description, destroyed, displayText, dispossessionTime, envStats, imageName, material, miscText, myContainer, myUses, myWornCode, name, owner, properWornBitmap, riding, scripts, secretIdentity, tickStatus, wornLogicalAnd, xtraValues

Fields inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Container

CONTAIN_ANYTHING, CONTAIN_BODIES, CONTAIN_CAGED, CONTAIN_CLOTHES, CONTAIN_COINS, CONTAIN_DAGGERS, CONTAIN_DESCS, CONTAIN_DRINKABLES, CONTAIN_FOOTWEAR, CONTAIN_KEYS, CONTAIN_LIQUID, CONTAIN_ONEHANDWEAPONS, CONTAIN_OTHERWEAPONS, CONTAIN_READABLES, CONTAIN_SCROLLS, CONTAIN_SMOKEABLES, CONTAIN_SSCOMPONENTS, CONTAIN_SWORDS

Fields inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Item

IN_INVENTORY, WORN_ABOUT_BODY, WORN_ARMS, WORN_BACK, WORN_CODES, WORN_DEPENDENCYGRID, WORN_DESCS, WORN_EARS, WORN_EYES, WORN_FEET, WORN_FLOATING_NEARBY, WORN_HANDS, WORN_HEAD, WORN_HELD, WORN_LEFT_FINGER, WORN_LEFT_WRIST, WORN_LEGS, WORN_MOUTH, WORN_NECK, WORN_ORDER, WORN_RIGHT_FINGER, WORN_RIGHT_WRIST, WORN_TORSO, WORN_WAIST, WORN_WEIGHT_POINTS, WORN_WEIGHTS, WORN_WIELD, WORNREQ_ANY, WORNREQ_UNWORNONLY, WORNREQ_WORNONLY

Constructor Summary

StdDeckOfCards()

Method Summary

protected boolean	abilityImbuesMagic()
boolean	addCard(PlayingCard card)
HandOfCards	addPlayerHand(MOB player, HandOfCards cards)
DeckOfCards	createDeck(Environmental owner)
HandOfCards	getPlayerHand(MOB player)
java.lang.String	ID() The CoffeeMud Java Class ID shared by all instances of this object.
protected PlayingCard	makePlayingCard(int cardBitCode)
boolean	okMessage(Environmental myHost, CMMsg msg) The general message event previewer for the object.
void	removePlayerHand(MOB player)
boolean	resetDeckBackTo52Cards()

Methods inherited from class com.planet_ink.coffee_mud.Items.MiscMagic.StdHandOfCards

canContain, containsAtLeastOneOfSuit, containsAtLeastOneOfSuit, containsAtLeastOneOfValue, containsAtLeastOneOfValue, containsCard, containsCard, createEmptyHand, executeMsg, getCard, getCard, getContents, getContentsEncoded, getFirstCardOfSuit, getFirstCardOfSuit, getFirstCardOfValue, getFirstCardOfValue, getTopCardFromDeck, numberOfCards, removeAllCards, removeCard, shuffleDeck, sortByValueAceHigh, sortByValueAceLow

Methods inherited from class com.planet_ink.coffee_mud.Items.Basic.StdContainer

capacity, containTypes, emptyPlease, hasALid, hasALock, isLocked, isOpen, keyName, reallyGetContents, setCapacity, setContainTypes, setKeyName, setLidsNLocks, setMiscText, tick

Methods inherited from class com.planet_ink.coffee_mud.Items.Basic.StdItem

addBehavior, addEffect, addNonUninvokableEffect, addScript, affectCharState, affectCharStats, affectEnvStats, alreadyWornMsg, amDestroyed, amWearingAt, baseEnvStats, baseGoldValue, canWear, canWearComplete, cloneEffects, cloneFix, compareProperLocations, compareTo, container, copyOf, databaseID, delBehavior, delEffect, delScript, description, destroy, displayText, envStats, expirationDate, fetchBehavior, fetchBehavior, fetchEffect, fetchEffect, fetchScript, finalize, fitsOn, getCodeNum, getSaveStatIndex, getStat, getStatCodes, getTickStatus, image, initializeClass, isGeneric, isStat, material, maxRange, minRange, miscTextFormat, name, Name, newInstance, numBehaviors, numberOfItems, numEffects, numScripts, owner, rawImage, rawLogicalAnd, rawProperLocationBitmap, rawSecretIdentity, rawWornCode, readableText, recoverEnvStats, recursiveWeight, removeFromOwnerContainer, riding, sameAs, savable, secretIdentity, setBaseEnvStats, setBaseValue, setContainer, setDatabaseID, setDescription, setDisplayText, setExpirationDate, setImage, setMaterial, setName, setOwner, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, setReadableText, setRiding, setSecretIdentity, setStat, setUsesRemaining, stopTicking, subjectToWearAndTear, tackOns, text, ultimateContainer, unWear, usesRemaining, value, wearAt, wearEvenIfImpossible, wearIfPossible, whereCantWear

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.planet_ink.coffee_mud.Items.interfaces.HandOfCards

containsAtLeastOneOfSuit, containsAtLeastOneOfSuit, containsAtLeastOneOfValue, containsAtLeastOneOfValue, containsCard, containsCard, createEmptyHand, getCard, getCard, getContentsEncoded, getFirstCardOfSuit, getFirstCardOfSuit, getFirstCardOfValue, getFirstCardOfValue, getTopCardFromDeck, numberOfCards, removeAllCards, removeCard, shuffleDeck, sortByValueAceHigh, sortByValueAceLow

Methods inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Container

canContain, capacity, containTypes, emptyPlease, getContents, hasALid, hasALock, isLocked, isOpen, keyName, setCapacity, setContainTypes, setKeyName, setLidsNLocks

Methods inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Item

amWearingAt, baseGoldValue, canWear, compareProperLocations, container, databaseID, fitsOn, material, numberOfItems, owner, rawLogicalAnd, rawProperLocationBitmap, rawSecretIdentity, rawWornCode, readableText, recursiveWeight, removeFromOwnerContainer, secretIdentity, setBaseValue, setContainer, setDatabaseID, setMaterial, setOwner, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, setReadableText, setSecretIdentity, setUsesRemaining, stopTicking, subjectToWearAndTear, ultimateContainer, unWear, usesRemaining, value, wearAt, wearEvenIfImpossible, wearIfPossible, whereCantWear

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

riding, setRiding

Field Detail

cardsCache

protected java.util.Vector cardsCache

Constructor Detail

StdDeckOfCards

public StdDeckOfCards()

Method Detail

ID

public java.lang.String ID()

Description copied from interface: CMObject

The CoffeeMud Java Class ID shared by all instances of this object. Unlike the Java Class name, this method does not include package information. However, it must return a String value unique to its class category in the ClassLoader. Class categories include Libraries, Common, Areas, Abilities, Behaviors, CharClasses, Commands, Exits Locales, MOBS, Races, WebMacros, Basic Items, Armor, Weapons, ClanItems, MiscTech. The name is typically identical to the class name.

Specified by:

ID in interface CMObject

Overrides:

ID in class StdHandOfCards

Returns:

the name of this class

abilityImbuesMagic

protected boolean abilityImbuesMagic()

Overrides:

abilityImbuesMagic in class StdItem

makePlayingCard

protected PlayingCard makePlayingCard(int cardBitCode)

createDeck

public DeckOfCards createDeck(Environmental owner)

Specified by:

createDeck in interface DeckOfCards

resetDeckBackTo52Cards

public boolean resetDeckBackTo52Cards()

Specified by:

resetDeckBackTo52Cards in interface DeckOfCards

getPlayerHand

public HandOfCards getPlayerHand(MOB player)

Specified by:

getPlayerHand in interface DeckOfCards

addPlayerHand

public HandOfCards addPlayerHand(MOB player,
                                 HandOfCards cards)

Specified by:

addPlayerHand in interface DeckOfCards

removePlayerHand

public void removePlayerHand(MOB player)

Specified by:

removePlayerHand in interface DeckOfCards

addCard

public boolean addCard(PlayingCard card)

Specified by:

addCard in interface DeckOfCards

Specified by:

addCard in interface HandOfCards

Overrides:

addCard in class StdHandOfCards

okMessage

public boolean okMessage(Environmental myHost,
                         CMMsg msg)

Description copied from interface: MsgListener

The general message event previewer for the object. Messages passed herein are in a pending state, and may be safely modified or rejected without fear that they might be in the middle of being executed. Messages passed herein may not necessarily be FOR or FROM this object, but will almost always represent events which want to happen in the same rom. This method should always always return true UNLESS this message needs to be canceled, in which case it is necessary to tell the mob initiating the event (CMMsg.source()) why it is being cancelled. Every game event goes through these methods.

Specified by:

okMessage in interface MsgListener

Overrides:

okMessage in class StdContainer

Parameters:

myHost - either the initiator of the event, or the host of this object

msg - the CMMsg that wants to be executed

Returns:

whether this message is allowed to execute

See Also:

CMMsg, CMMsg.source()