Package com.planet_ink.coffee_mud.Abilities.interfaces

Interface Language

All Superinterfaces:

Ability, java.lang.Cloneable, CMObject, java.lang.Comparable<CMObject>, Contingent, Environmental, Expireable, Modifiable, MsgListener, StatsAffecting, Tickable

All Known Implementing Classes:

AlligatorSpeak, AnimalSpeak, ApeSpeak, Aquan, BatSpeak, BearSpeak, BigCatSpeak, BirdSpeak, Blah, CatSpeak, Chant_Burrowspeak, Chant_SpeakWithAnimals, ChickenSpeak, ChimpSpeak, Common, CowSpeak, DeerSpeak, DogSpeak, Draconic, Drowish, Druidic, Drunken, DuckSpeak, Dwarven, ElephantSpeak, Elvish, Encrypto, Fey, FowlSpeak, FoxSpeak, FrogSpeak, GenLanguage, Gigantic, Gnomish, GoatSpeak, Goblinese, GooseSpeak, GreatBirdSpeak, HorseSpeak, Ignan, InvisibleInk, Krakenspeak, MonkeySpeak, MooseSpeak, Orcish, OwlSpeak, PigLatin, PigSpeak, PirateTalk, Prop_LangTranslator, RabbitSpeak, RavenSpeak, RodentSpeak, Semaphore, SheepSpeak, SignLanguage, SnakeSpeak, StdLanguage, ThievesCant, Undercommon, WolfSpeak, WormSpeak

public interface Language
extends Ability

A Language ability represents both the ability to understand one or more spoken or written languages, and the ability to speak one or more spoken languages. A single ability usually represents a single language, but may support multiple simultaneously.

Field Summary

Fields inherited from interface com.planet_ink.coffee_mud.Abilities.interfaces.Ability

ACODE_CHANT, ACODE_COMMON_SKILL, ACODE_DESCS, ACODE_DESCS_, ACODE_DISEASE, ACODE_LANGUAGE, ACODE_POISON, ACODE_PRAYER, ACODE_PROPERTY, ACODE_SKILL, ACODE_SONG, ACODE_SPELL, ACODE_SUPERPOWER, ACODE_TECH, ACODE_THIEF_SKILL, ACODE_TRAP, ALL_ACODES, ALL_DOMAINS, CACHEINDEX_CLASSLESS, CACHEINDEX_EXPERTISE, CACHEINDEX_LASTTIME, CACHEINDEX_NORMAL, CACHEINDEX_TOTAL, CAN_AREAS, CAN_DESCS, CAN_EXITS, CAN_ITEMS, CAN_MOBS, CAN_ROOMS, COST_ALL, COST_NORMAL, COST_PCT, DOMAIN_ABJURATION, DOMAIN_ACROBATIC, DOMAIN_ALERT, DOMAIN_ALTERATION, DOMAIN_ANATOMY, DOMAIN_ANIMALAFFINITY, DOMAIN_ARCANELORE, DOMAIN_ARCHON, DOMAIN_ARMORUSE, DOMAIN_ARTISTIC, DOMAIN_BINDING, DOMAIN_BLESSING, DOMAIN_BREEDING, DOMAIN_BUILDINGSKILL, DOMAIN_CALLIGRAPHY, DOMAIN_COMBATFLUIDITY, DOMAIN_COMBATLORE, DOMAIN_COMMUNING, DOMAIN_CONJURATION, DOMAIN_CORRUPTION, DOMAIN_COSMOLOGY, DOMAIN_CRAFTINGSKILL, DOMAIN_CREATION, DOMAIN_CRIMINAL, DOMAIN_CURSING, DOMAIN_DANCING, DOMAIN_DEATHLORE, DOMAIN_DECEPTIVE, DOMAIN_DEEPMAGIC, DOMAIN_DESCS, DOMAIN_DETRAP, DOMAIN_DIRTYFIGHTING, DOMAIN_DIVINATION, DOMAIN_EDUCATIONLORE, DOMAIN_ENCHANTMENT, DOMAIN_ENDURING, DOMAIN_EPICUREAN, DOMAIN_EVANGELISM, DOMAIN_EVASIVE, DOMAIN_EVOCATION, DOMAIN_FITNESS, DOMAIN_FOOLISHNESS, DOMAIN_GATHERINGSKILL, DOMAIN_GRAPPLING, DOMAIN_HEALING, DOMAIN_HOLYPROTECTION, DOMAIN_ILLUSION, DOMAIN_INFLUENTIAL, DOMAIN_KICKING, DOMAIN_LEGAL, DOMAIN_MARTIALLORE, DOMAIN_MOONALTERING, DOMAIN_MOONSUMMONING, DOMAIN_NATURELORE, DOMAIN_NEUTRALIZATION, DOMAIN_PLANTCONTROL, DOMAIN_PLANTGROWTH, DOMAIN_PLAYING, DOMAIN_POISONING, DOMAIN_PRESERVING, DOMAIN_PUNCHING, DOMAIN_RACIALABILITY, DOMAIN_RESTORATION, DOMAIN_ROCKCONTROL, DOMAIN_ROPEUSE, DOMAIN_SEATRAVEL, DOMAIN_SHAPE_SHIFTING, DOMAIN_SHIELDUSE, DOMAIN_SINGING, DOMAIN_STEALING, DOMAIN_STEALTHY, DOMAIN_STREETSMARTS, DOMAIN_THEATRE, DOMAIN_TRANSMUTATION, DOMAIN_TRAPPING, DOMAIN_TRAVEL, DOMAIN_VERBS, DOMAIN_VEXING, DOMAIN_WARDING, DOMAIN_WATERCONTROL, DOMAIN_WATERLORE, DOMAIN_WEAPON_USE, DOMAIN_WEATHER_MASTERY, FLAG_ADJUSTER, FLAG_AGGROFYING, FLAG_AIRBASED, FLAG_BINDING, FLAG_CASTER, FLAG_CHAOS, FLAG_CHARMING, FLAG_CLANMAGIC, FLAG_DESCS, FLAG_EARTHBASED, FLAG_ELECTRICBASED, FLAG_ENABLER, FLAG_FEARING, FLAG_FIREBASED, FLAG_HEALINGMAGIC, FLAG_HEATING, FLAG_HOLY, FLAG_IMMUNER, FLAG_INTOXICATING, FLAG_LAW, FLAG_MINDALTERING, FLAG_MODERATE, FLAG_MOVING, FLAG_NEUTRAL, FLAG_NODISENCHANT, FLAG_NONENCHANTMENT, FLAG_NOORDERING, FLAG_NOUNINVOKING, FLAG_PARALYZING, FLAG_POTENTIALLY_DEADLY, FLAG_RESISTER, FLAG_STEALING, FLAG_SUMMONING, FLAG_SUNSUMMONING, FLAG_TIDEALTERING, FLAG_TORTURING, FLAG_TRACKING, FLAG_TRANSPORTING, FLAG_UNCRAFTABLE, FLAG_UNHOLY, FLAG_WATERBASED, FLAG_WEATHERAFFECTING, FLAG_ZAPPER, POWER_COST_THRESHOLD, POWER_LEVEL_THRESHOLD, POWER_OVERRIDE_THRESHOLD, QUALITY_BENEFICIAL_OTHERS, QUALITY_BENEFICIAL_SELF, QUALITY_DESCS, QUALITY_INDIFFERENT, QUALITY_MALICIOUS, QUALITY_OK_OTHERS, QUALITY_OK_SELF, RANGE_CHOICES, TICKS_ALMOST_FOREVER, TICKS_FOREVER, USAGE_DESCS, USAGE_HITPOINTS, USAGE_MANA, USAGE_MOVEMENT, USAGE_NADA, USAGEINDEX_COUNT, USAGEINDEX_HITPOINTS, USAGEINDEX_MANA, USAGEINDEX_MOVEMENT, USAGEINDEX_TIMELSW, USAGEINDEX_TOTAL

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

idConverter

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_BALLISTICK, TICKID_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_ELECTRONICS, TICKID_EMAIL, TICKID_EVENT, 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_SHORTERMASK, TICKID_SOLITARYMASK, TICKID_SPECIALCOMBAT, TICKID_SPECIALMANEUVER, TICKID_SPELL_AFFECT, TICKID_SUPPORT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET

Method Summary

Modifier and Type	Method	Description
boolean	beingSpoken(java.lang.String language)	Returns whether this language is currently being spoken
int	getProficiency(java.lang.String language)	Returns the understanding proficiency in the given supported language
java.lang.String	getTranslationVerb()	When someone who doest speak a language hears it spoken, the verb say(s) is replaced with this verb (if it exists).
java.lang.String	getVerb()	When someone who doesn't speak a language hears it spoken, the verb say(s) is replaced with this verb (if it exists).
boolean	isANaturalLanguage()	Returns whether this language can be translated by normal replacement means, and is a natural language of a sentient creature.
java.util.Set<java.lang.String>	languagesSupported()	Returns a list of the languages understood by this ability.
void	setBeingSpoken(java.lang.String language, boolean beingSpoken)	Changes whether this language is currently being spoken
java.lang.String	translate(java.lang.String language, java.lang.String word)	Returns a language translation of the given word in the given language
boolean	translatesLanguage(java.lang.String language, java.lang.String words)	Returns whether the given language is translated by this one, possibly given the words that would be translated.
java.util.Map<java.lang.String,java.lang.String>	translationHash(java.lang.String language)	Returns the direct word to word translation hashtable
java.util.List<java.lang.String[]>	translationLists(java.lang.String language)	Returns the word-length rough-translation vector of string arrays for the given language The first string array in the vector represents 1 letter words, the second 2, and so forth.
java.lang.String	writtenName()	Returns the name of this language when it is in written form.

Methods inherited from interface com.planet_ink.coffee_mud.Abilities.interfaces.Ability

abilityCode, abstractQuality, accountForYourself, adjustedLevel, affecting, appropriateToMyFactions, autoInvocation, bubbleAffect, canAffect, canAffect, canBeLearnedBy, canBePracticedBy, canBeTaughtBy, canBeUninvoked, canTarget, canTarget, castingQuality, castingTime, checkedCastingCost, classificationCode, combatCastingTime, enchantQuality, externalFiles, flags, getTrainingCost, helpProficiency, invoke, invoke, invoker, isAutoInvoked, isNowAnAutoEffect, makeLongLasting, makeNonUninvokable, mayBeEnchanted, practice, preInvoke, proficiency, proficiencyCheck, putInCommandlist, requirements, setAbilityCode, setAffectedOne, setInvoker, setProficiency, startTickDown, teach, triggerStrings, unInvoke, unlearn, usageCost, usageType

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.Contingent

amDestroyed, destroy, isSavable, setSavable

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

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

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

expirationDate, setExpirationDate

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.MsgListener

executeMsg, okMessage

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.Tickable

getTickStatus, name, tick

Method Detail

writtenName

java.lang.String writtenName()

Returns the name of this language when it is in written form. This is usually the same as the spoken form.

Returns:

the name of this language when it is in written form.

languagesSupported

java.util.Set<java.lang.String> languagesSupported()

Returns a list of the languages understood by this ability. Narrowly used to allow this language to translate others, including Common.

Returns:

vector of language ids supported (usually 1 element == ID())

translatesLanguage

boolean translatesLanguage(java.lang.String language,
                           java.lang.String words)

Returns whether the given language is translated by this one, possibly given the words that would be translated. Does not use languagesSupported()

Parameters:

language - the language to test

words - null, or the words to be translated

Returns:

true if this language translates (usually ID() == language)

getProficiency

int getProficiency(java.lang.String language)

Returns the understanding proficiency in the given supported language

Parameters:

language - the language to test for (usually ID())

Returns:

the proficiency of this ability in the language (0-100)

beingSpoken

boolean beingSpoken(java.lang.String language)

Returns whether this language is currently being spoken

Parameters:

language - the language to test for (usually ID())

Returns:

true if spoken

setBeingSpoken

void setBeingSpoken(java.lang.String language,
                    boolean beingSpoken)

Changes whether this language is currently being spoken

Parameters:

language - the language to set (usually ID())

beingSpoken - whether it is being spoken

translationHash

java.util.Map<java.lang.String,java.lang.String> translationHash(java.lang.String language)

Returns the direct word to word translation hashtable

Parameters:

language - the language to translate directory (usually ID())

Returns:

the hashtable of word-word translations

translationLists

java.util.List<java.lang.String[]> translationLists(java.lang.String language)

Returns the word-length rough-translation vector of string arrays for the given language The first string array in the vector represents 1 letter words, the second 2, and so forth.

Parameters:

language - the language to return the vector for (usually ID())

Returns:

the vector of word-length rough translation string arrays

translate

java.lang.String translate(java.lang.String language,
                           java.lang.String word)

Returns a language translation of the given word in the given language

Parameters:

language - the language to use (usually ID())

word - the word to translate

Returns:

the translated word

isANaturalLanguage

boolean isANaturalLanguage()

Returns whether this language can be translated by normal replacement means, and is a natural language of a sentient creature. This would differentiate it from Language class things like encryption, invisible ink, or animal noises.

Returns:

whether this is a natural sentient language

getVerb

java.lang.String getVerb()

When someone who doesn't speak a language hears it spoken, the verb say(s) is replaced with this verb (if it exists).

Returns:

empty string, of a verb that replaces "say(s)"

getTranslationVerb

java.lang.String getTranslationVerb()

When someone who doest speak a language hears it spoken, the verb say(s) is replaced with this verb (if it exists).

Returns:

empty string, of a verb that replaces "say(s)" in the translation