Package com.planet_ink.coffee_mud.Abilities.Properties

Class Prop_LangTranslator

java.lang.Object

com.planet_ink.coffee_mud.Abilities.ThinAbility

com.planet_ink.coffee_mud.Abilities.Properties.Property

com.planet_ink.coffee_mud.Abilities.Properties.Prop_LangTranslator

All Implemented Interfaces:

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

public class Prop_LangTranslator
extends Property
implements Language

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.Set<java.lang.String>	ints
protected java.util.Map<java.lang.String,Pair<java.lang.Integer,java.util.List<java.lang.String>>>	langs
protected java.lang.String[]	lastLang
protected boolean	passive
protected java.util.Set<java.lang.String>	trusted

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 class com.planet_ink.coffee_mud.Abilities.ThinAbility

affected, amDestroyed, empty, miscText, savable

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

Constructor Summary

Constructors

Constructor	Description
Prop_LangTranslator()

Method Summary

Modifier and Type	Method	Description
int	abstractQuality()	Returns a constant value notifying the system of the general quality of the skill, whether it is malicious, beneficial, indifferent, or qualifiably beneficial (ok), as well as whether it is intended to target the invoker (self) or others.
java.lang.String	accountForYourself()	For use by the identify spell, this should return a nice description of any properties incorporated by this effect.
boolean	beingSpoken(java.lang.String language)	Returns whether this language is currently being spoken
protected int	canAffectCode()	Designates whether, when used as a property/effect, what sort of objects this ability can affect.
void	executeMsg(Environmental myHost, CMMsg msg)	The general message event handler for the object.
int	getProficiency(java.lang.String language)	Returns the understanding proficiency in the given supported language
java.lang.String	getStat(java.lang.String code)	An alternative means of retreiving the values of those fields on this object which are modifiable at run-time by builders.
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).
java.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
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.
protected void	logError(java.lang.String msg)
java.lang.String	name()	The nice displayable name of this instance of this object
Pair<java.lang.Integer,java.util.List<java.lang.String>>	parseEquate(java.lang.Integer defI, java.lang.String arg)
protected java.lang.String[]	parseParms(java.lang.String code, java.lang.String val)
void	rebuildMiscText()
void	setBeingSpoken(java.lang.String language, boolean beingSpoken)	Changes whether this language is currently being spoken
void	setMiscText(java.lang.String text)	For objects which have false for their isGeneric method, this is used to set any internally coded strings to change the nature or behavior of the object.
void	setStat(java.lang.String code, java.lang.String val)	An alternative means of setting the values of those fields on this object which are modifiable at run-time by builders.
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.
protected boolean	wordMatch(java.lang.String words, java.util.List<java.lang.String> allMatchWords)
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, 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, 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, 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, getStatCodes, isStat

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

okMessage

Methods inherited from class java.lang.Object

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

Methods inherited from class com.planet_ink.coffee_mud.Abilities.Properties.Property

canAffect, canAffect, canTarget, canTargetCode, classificationCode, copyOf, newInstance, sameAs, setDescription, setDisplayText

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

affectCharState, affectCharStats, affectPhyStats

Methods inherited from class com.planet_ink.coffee_mud.Abilities.ThinAbility

abilityCode, adjustedLevel, affectCharState, affectCharStats, affecting, affectPhyStats, amDestroyed, appropriateToMyFactions, autoInvocation, bubbleAffect, canBeLearnedBy, canBePracticedBy, canBeTaughtBy, canBeUninvoked, canTarget, castingQuality, castingTime, checkedCastingCost, combatCastingTime, compareTo, description, destroy, displayText, enchantQuality, expirationDate, externalFiles, flags, getCodeNum, getSaveStatIndex, getStatCodes, getTickStatus, getTrainingCost, helpProficiency, image, initializeClass, invoke, invoke, invoker, isAutoInvoked, isGeneric, isNowAnAutoEffect, isSavable, isStat, L, makeLongLasting, makeNonUninvokable, maxRange, mayBeEnchanted, minRange, miscTextFormat, Name, okMessage, practice, preInvoke, proficiency, proficiencyCheck, putInCommandlist, rawImage, requirements, setAbilityCode, setAffectedOne, setExpirationDate, setImage, setInvoker, setName, setProficiency, setSavable, startTickDown, teach, text, tick, triggerStrings, unInvoke, unlearn, usageCost, usageType

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

getTickStatus, tick

Field Detail

langs

protected java.util.Map<java.lang.String,Pair<java.lang.Integer,java.util.List<java.lang.String>>> langs

trusted

protected final java.util.Set<java.lang.String> trusted

ints

protected java.util.Set<java.lang.String> ints

passive

protected boolean passive

lastLang

protected final java.lang.String[] lastLang

Constructor Detail

Prop_LangTranslator

public Prop_LangTranslator()

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, Tech. The name is typically identical to the class name.

Specified by:

ID in interface CMObject

Overrides:

ID in class Property

Returns:

the name of this class

name

public java.lang.String name()

Description copied from interface: Tickable

The nice displayable name of this instance of this object

Specified by:

name in interface CMObject

Specified by:

name in interface Tickable

Overrides:

name in class Property

Returns:

the displayable name of this object instance

See Also:

Environmental.Name()

writtenName

public java.lang.String writtenName()

Description copied from interface: Language

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

Specified by:

writtenName in interface Language

Returns:

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

abstractQuality

public int abstractQuality()

Description copied from interface: Ability

Returns a constant value notifying the system of the general quality of the skill, whether it is malicious, beneficial, indifferent, or qualifiably beneficial (ok), as well as whether it is intended to target the invoker (self) or others. These constants are defined in the Ability interface and called QUALITY_*

Specified by:

abstractQuality in interface Ability

Overrides:

abstractQuality in class ThinAbility

Returns:

Ability.QUALITY_* constant classification

See Also:

Ability

canAffectCode

protected int canAffectCode()

Description copied from class: Property

Designates whether, when used as a property/effect, what sort of objects this ability can affect. Uses the Ability.CAN_* constants.

Overrides:

canAffectCode in class Property

Returns:

a mask showing the type of objects this ability can affect

See Also:

Ability

accountForYourself

public java.lang.String accountForYourself()

Description copied from interface: Ability

For use by the identify spell, this should return a nice description of any properties incorporated by this effect.

Specified by:

accountForYourself in interface Ability

Overrides:

accountForYourself in class ThinAbility

Returns:

a description of properties incorporated

isANaturalLanguage

public boolean isANaturalLanguage()

Description copied from interface: Language

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.

Specified by:

isANaturalLanguage in interface Language

Returns:

whether this is a natural sentient language

logError

protected void logError(java.lang.String msg)

setMiscText

public void setMiscText(java.lang.String text)

Description copied from interface: Environmental

For objects which have false for their isGeneric method, this is used to set any internally coded strings to change the nature or behavior of the object. For objects which have true for their isGeneric method, this is used to set and parse the XML which will be used to fill out the fields in this object. Since Ability objects are never Generic, this will always be where parameters are read from an Ability instance.

Specified by:

setMiscText in interface Environmental

Overrides:

setMiscText in class ThinAbility

Parameters:

text - either an open internal text string, or XML

languagesSupported

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

Description copied from interface: Language

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

Specified by:

languagesSupported in interface Language

Returns:

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

getVerb

public java.lang.String getVerb()

Description copied from interface: Language

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

Specified by:

getVerb in interface Language

Returns:

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

getTranslationVerb

public java.lang.String getTranslationVerb()

Description copied from interface: Language

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

Specified by:

getTranslationVerb in interface Language

Returns:

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

wordMatch

protected boolean wordMatch(java.lang.String words,
                            java.util.List<java.lang.String> allMatchWords)

translatesLanguage

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

Description copied from interface: Language

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

Specified by:

translatesLanguage in interface Language

Parameters:

language - the language to test

words - null, or the words to be translated

Returns:

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

getProficiency

public int getProficiency(java.lang.String language)

Description copied from interface: Language

Returns the understanding proficiency in the given supported language

Specified by:

getProficiency in interface Language

Parameters:

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

Returns:

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

beingSpoken

public boolean beingSpoken(java.lang.String language)

Description copied from interface: Language

Returns whether this language is currently being spoken

Specified by:

beingSpoken in interface Language

Parameters:

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

Returns:

true if spoken

setBeingSpoken

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

Description copied from interface: Language

Changes whether this language is currently being spoken

Specified by:

setBeingSpoken in interface Language

Parameters:

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

beingSpoken - whether it is being spoken

translationHash

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

Description copied from interface: Language

Returns the direct word to word translation hashtable

Specified by:

translationHash in interface Language

Parameters:

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

Returns:

the hashtable of word-word translations

translationLists

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

Description copied from interface: 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.

Specified by:

translationLists in interface Language

Parameters:

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

Returns:

the vector of word-length rough translation string arrays

translate

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

Description copied from interface: Language

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

Specified by:

translate in interface Language

Parameters:

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

word - the word to translate

Returns:

the translated word

executeMsg

public void executeMsg(Environmental myHost,
                       CMMsg msg)

Description copied from interface: MsgListener

The general message event handler for the object. Messages passed herein may not necessarily be FOR this object, or from it, but will almost always represent events happening in the same room. The messages have already been through an approval process, so this method is called only to affect the final execution of the meaning of the message. Every game event goes through these methods.

Specified by:

executeMsg in interface MsgListener

Overrides:

executeMsg in class ThinAbility

Parameters:

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

msg - the CMMsg that needs to be executed

See Also:

CMMsg

parseParms

protected java.lang.String[] parseParms(java.lang.String code,
                                        java.lang.String val)

parseEquate

public Pair<java.lang.Integer,java.util.List<java.lang.String>> parseEquate(java.lang.Integer defI,
                                                                            java.lang.String arg)

rebuildMiscText

public void rebuildMiscText()

getStat

public java.lang.String getStat(java.lang.String code)

Description copied from interface: Modifiable

An alternative means of retreiving the values of those fields on this object which are modifiable at run-time by builders. See getStatCodes() for possible values for the code passed to this method. Values returned are always strings, even if the field itself is numeric or a list.

Specified by:

getStat in interface Modifiable

Overrides:

getStat in class ThinAbility

Parameters:

code - the name of the field to read.

Returns:

the value of the field read

See Also:

Modifiable.getStatCodes()

setStat

public void setStat(java.lang.String code,
                    java.lang.String val)

Description copied from interface: Modifiable

An alternative means of setting the values of those fields on this object which are modifiable at run-time by builders. See getStatCodes() for possible values for the code passed to this method. The value passed in is always a string, even if the field itself is numeric or a list.

Specified by:

setStat in interface Modifiable

Overrides:

setStat in class ThinAbility

Parameters:

code - the name of the field to set

val - the value to set the field to

See Also:

Modifiable.getStatCodes()