com.planet_ink.coffee_mud.Items.interfaces
Interface PlayingCard

All Superinterfaces:

Affectable, Behavable, java.lang.Cloneable, CMObject, java.lang.Comparable<CMObject>, Contingent, DBIdentifiable, Environmental, Item, Modifiable, MsgListener, Physical, PhysicalAgent, Readable, Rider, StatsAffecting, Tickable, Wearable

All Known Implementing Classes:

GenPlayingCard, StdPlayingCard

public interface PlayingCard
extends Item

A playing card is just what it sounds like - a card you can play card games with. It is typically contained in both a HandOfCards, managed by a DeckOfCards that created it.

Nested Class Summary

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Wearable

Wearable.CODES

Field Summary

static int[]	cards A static list of card values, 2 through 14, with the ace as 14.
static int[]	suits A static list of bitmap values, one for each suit.

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

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

DEFAULT_WORN_CODES, DEFAULT_WORN_DEPENDENCYGRID, DEFAULT_WORN_DESCS, DEFAULT_WORN_ORDER, DEFAULT_WORN_USUAL_NAMES, DEFAULT_WORN_WEIGHT_POINTS, DEFAULT_WORN_WEIGHTS, FILTER_ANY, FILTER_MOBINVONLY, FILTER_ROOMONLY, FILTER_UNWORNONLY, FILTER_WORNONLY, HIGHEST_WORN_CODE, IN_INVENTORY, WORN_ABOUT_BODY, WORN_ARMS, WORN_BACK, 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_RIGHT_FINGER, WORN_RIGHT_WRIST, WORN_TORSO, WORN_WAIST, WORN_WIELD

Method Summary

int	getBitEncodedSuit() Returns the bitmap value that represents the suit of this card.
int	getBitEncodedValue() Returns the full bit-encoded value of this card, with suit | value.
java.lang.String	getCardValueLongDescription(int value) Returns the english-word representation of the value passed to this method.
java.lang.String	getCardValueShortDescription(int value) Returns partial english-word representation of the value passed to this method.
java.lang.String	getStringEncodedSuit() Returns the suit of this card as a single letter string
java.lang.String	getStringEncodedValue() Return the value of this card as a short string face cards are only a single letter
java.lang.String	getSuitDescription(int suit) Returns an english-word, color-coded representation of the suit passed to this method.
boolean	isFaceUp() Gets whether the card is face up
void	turnFaceDown() Sets the card as face down
void	turnFaceUp() Sets the card as face up

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

baseGoldValue, container, material, numberOfItems, owner, rawSecretIdentity, recursiveWeight, removeFromOwnerContainer, secretIdentity, setBaseValue, setContainer, setMaterial, setOwner, setSecretIdentity, setUsesRemaining, stopTicking, subjectToWearAndTear, ultimateContainer, usesRemaining, value

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

riding, setRiding

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

description, displayText, name

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

description, displayText, expirationDate, image, isGeneric, L, maxRange, minRange, miscTextFormat, Name, rawImage, sameAs, setDescription, setDisplayText, setExpirationDate, setImage, setMiscText, setName, text

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

getTickStatus, name, tick

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

affectCharState, affectCharStats, affectPhyStats

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

executeMsg, okMessage

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

amDestroyed, destroy, isSavable, setSavable

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

copyOf, ID, initializeClass, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

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

getSaveStatIndex, getStat, getStatCodes, isStat, setStat

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

addEffect, addNonUninvokableEffect, basePhyStats, delAllEffects, delEffect, eachEffect, effects, fetchEffect, fetchEffect, numEffects, phyStats, recoverPhyStats, setBasePhyStats

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

addBehavior, addScript, behaviors, delAllBehaviors, delAllScripts, delBehavior, delScript, eachBehavior, eachScript, fetchBehavior, fetchBehavior, fetchScript, numBehaviors, numScripts, scripts

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

canSaveDatabaseID, databaseID, setDatabaseID

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

amBeingWornProperly, amWearingAt, canWear, compareProperLocations, fitsOn, rawLogicalAnd, rawProperLocationBitmap, rawWornCode, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, unWear, wearAt, wearEvenIfImpossible, wearIfPossible, wearIfPossible, whereCantWear

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

isReadable, readableText, setReadable, setReadableText

Field Detail

suits

static final int[] suits

A static list of bitmap values, one for each suit. In order, spades, clubs, hearts, diamonds. Needs to be enumified.

cards

static final int[] cards

A static list of card values, 2 through 14, with the ace as 14.

Method Detail

getBitEncodedSuit

int getBitEncodedSuit()

Returns the bitmap value that represents the suit of this card.

Returns:

the bitmap value that represents the suit of this card

See Also:

suits

getBitEncodedValue

int getBitEncodedValue()

Returns the full bit-encoded value of this card, with suit | value.

Returns:

the full bit-encoded value of this card

See Also:

suits, The card values are 2-14, the suit bitmasks are 0, 16, 32, and 48. Face up is bit 64.

isFaceUp

boolean isFaceUp()

Gets whether the card is face up

Returns:

true if the card is face up, false if down

See Also:

turnFaceUp(), Face up is bit 64.

turnFaceUp

void turnFaceUp()

Sets the card as face up

See Also:

isFaceUp(), Face up is bit 64.

turnFaceDown

void turnFaceDown()

Sets the card as face down

See Also:

isFaceUp(), Face up is bit 64.

getStringEncodedSuit

java.lang.String getStringEncodedSuit()

Returns the suit of this card as a single letter string

Returns:

the suit of this card as a single letter string

getStringEncodedValue

java.lang.String getStringEncodedValue()

Return the value of this card as a short string face cards are only a single letter

Returns:

the value of this card as a short string

getCardValueLongDescription

java.lang.String getCardValueLongDescription(int value)

Returns the english-word representation of the value passed to this method. Since this method is static, it may be called as a utility function and does not necessarily represent THIS card object.

Parameters:

value - the value to return a description of

Returns:

the value passed in as a string

getCardValueShortDescription

java.lang.String getCardValueShortDescription(int value)

Returns partial english-word representation of the value passed to this method. By partial I mean numeric for number cards and words otherwise. Since this method is static, it may be called as a utility function and does not necessarily represent THIS card object.

Parameters:

value - the value to return a description of

Returns:

the value passed in as a string

getSuitDescription

java.lang.String getSuitDescription(int suit)

Returns an english-word, color-coded representation of the suit passed to this method. Since this method is static, it may be called as a utility function and does not necessarily represent THIS card object.

Parameters:

suit - the suit to return a description of

Returns:

the suit passed in as a string