Eamon CS  3.1.0
Eamon.Game.Character Class Reference
Inheritance diagram for Eamon.Game.Character:
Eamon.Game.GameBase Eamon.Framework.ICharacter Eamon.Framework.IGameBase Eamon.Framework.IGameBase

Public Member Functions

override void Dispose (bool disposing)
 
override string GetPluralName (string fieldName)
 
override string GetDecoratedName (string fieldName, ArticleType articleType, bool upshift=false, bool showCharOwned=true, bool showStateDesc=false, bool showContents=false, bool groupCountOne=false)
 
override RetCode BuildPrintedFullDesc (StringBuilder buf, bool showName, bool showVerboseName)
 
virtual int CompareTo (ICharacter character)
 
virtual long GetStat (long index)
 
virtual long GetStat (Stat stat)
 
virtual long GetSpellAbility (long index)
 
virtual long GetSpellAbility (Spell spell)
 
virtual long GetWeaponAbility (long index)
 
virtual long GetWeaponAbility (Weapon weapon)
 
virtual string GetSynonym (long index)
 
virtual void SetStat (long index, long value)
 
virtual void SetStat (Stat stat, long value)
 
virtual void SetSpellAbility (long index, long value)
 
virtual void SetSpellAbility (Spell spell, long value)
 
virtual void SetWeaponAbility (long index, long value)
 
virtual void SetWeaponAbility (Weapon weapon, long value)
 
virtual void SetSynonym (long index, string value)
 
virtual void ModStat (long index, long value)
 
virtual void ModStat (Stat stat, long value)
 
virtual void ModSpellAbility (long index, long value)
 
virtual void ModSpellAbility (Spell spell, long value)
 
virtual void ModWeaponAbility (long index, long value)
 
virtual void ModWeaponAbility (Weapon weapon, long value)
 
virtual long GetWeightCarryableGronds ()
 
virtual long GetWeightCarryableDos ()
 
virtual long GetIntellectBonusPct ()
 
virtual long GetCharmMonsterPct ()
 
virtual long GetMerchantAdjustedCharisma ()
 
virtual T EvalGender< T > (T maleValue, T femaleValue, T neutralValue)
 Evaluates this Character's Gender, returning a value of type T. More...
 
virtual IList< IArtifactGetCarriedList (Func< IArtifact, bool > characterFindFunc=null)
 
virtual IList< IArtifactGetWornList (Func< IArtifact, bool > characterFindFunc=null)
 
virtual IList< IArtifactGetContainedList (Func< IArtifact, bool > characterFindFunc=null)
 
virtual RetCode GetFullInventoryWeight (ref long weight, Func< IArtifact, bool > characterFindFunc=null)
 
virtual RetCode GetBaseOddsToHit (IArtifact weapon, ref long baseOddsToHit)
 
virtual RetCode ListWeapons (StringBuilder buf, bool capitalize=true)
 
virtual bool StripUniqueCharsFromWeaponNames ()
 
virtual bool AddUniqueCharsToWeaponNames ()
 
virtual void NormalizeGoldValues ()
 
 Character ()
 
- Public Member Functions inherited from Eamon.Game.GameBase
void Dispose ()
 
virtual void SetParentReferences ()
 
virtual string GetPluralName01 ()
 
virtual string GetNoneName (bool upshift=false, bool showCharOwned=true, bool showStateDesc=false, bool showContents=false, bool groupCountOne=false)
 
virtual string GetArticleName (bool upshift=false, bool showCharOwned=true, bool showStateDesc=false, bool showContents=false, bool groupCountOne=false)
 
virtual string GetTheName (bool upshift=false, bool showCharOwned=true, bool showStateDesc=false, bool showContents=false, bool groupCountOne=false)
 
 GameBase ()
 

Public Attributes

long _heldGold
 
long _bankGold
 

Properties

virtual Gender Gender [get, set]
 
virtual Status Status [get, set]
 
virtual long[] Stats [get, set]
 
virtual long[] SpellAbilities [get, set]
 
virtual long[] WeaponAbilities [get, set]
 
virtual long ArmorExpertise [get, set]
 
virtual long HeldGold [get, set]
 
virtual long BankGold [get, set]
 
virtual Armor?? ArmorClass [get]
 
- Properties inherited from Eamon.Game.GameBase
virtual long Uid [get, set]
 
virtual string Name [get, set]
 
virtual string Desc [get, set]
 
virtual string[] Synonyms [get, set]
 
virtual bool Seen [get, set]
 
virtual bool Moved [get, set]
 
virtual ArticleType ArticleType [get, set]
 
virtual string ParserMatchName [get, set]
 
- Properties inherited from Eamon.Framework.IGameBase
long Uid [get, set]
 Gets or sets a unique Id that distinguishes this Record from others of its type. More...
 
string Name [get, set]
 Gets or sets the name of this Record as shown in various lists or the Record's full description. More...
 
string Desc [get, set]
 Gets or sets the detailed description of this Record shown when the Record is first Seen or later examined. More...
 
string[] Synonyms [get, set]
 Gets or sets a string array containing Name synonyms for this Record (may be null). More...
 
bool Seen [get, set]
 Gets or sets a value indicating whether this Record has been seen by the player character. More...
 
bool Moved [get, set]
 Gets or sets a value indicating whether this Record has been moved from its original Location. More...
 
ArticleType ArticleType [get, set]
 Gets or sets a value indicating how this Record's Name is prefixed to produce its listed Name. More...
 
string ParserMatchName [get, set]
 Gets or sets the name or synonym of this Record matched in the FilterRecordList method. More...
 
- Properties inherited from Eamon.Framework.ICharacter
Gender Gender [get, set]
 Gets or sets this Character's gender. More...
 
Status Status [get, set]
 
long[] Stats [get, set]
 
long[] SpellAbilities [get, set]
 
long[] WeaponAbilities [get, set]
 
long ArmorExpertise [get, set]
 
long HeldGold [get, set]
 
long BankGold [get, set]
 
Armor ArmorClass [get]
 

Constructor & Destructor Documentation

◆ Character()

Eamon.Game.Character.Character ( )

Member Function Documentation

◆ AddUniqueCharsToWeaponNames()

virtual bool Eamon.Game.Character.AddUniqueCharsToWeaponNames ( )
virtual

Returns

Implements Eamon.Framework.ICharacter.

◆ BuildPrintedFullDesc()

override RetCode Eamon.Game.Character.BuildPrintedFullDesc ( StringBuilder  buf,
bool  showName,
bool  showVerboseName 
)
virtual

Parameters
buf
showName
showVerboseName
Returns

Reimplemented from Eamon.Game.GameBase.

◆ CompareTo()

virtual int Eamon.Game.Character.CompareTo ( ICharacter  character)
virtual

◆ Dispose()

override void Eamon.Game.Character.Dispose ( bool  disposing)
virtual

Implements Eamon.Game.GameBase.

◆ EvalGender< T >()

virtual T Eamon.Game.Character.EvalGender< T > ( maleValue,
femaleValue,
neutralValue 
)
virtual

Evaluates this Character's Gender, returning a value of type T.

Parameters
maleValue
femaleValue
neutralValue
Returns

Implements Eamon.Framework.ICharacter.

◆ GetBaseOddsToHit()

virtual RetCode Eamon.Game.Character.GetBaseOddsToHit ( IArtifact  weapon,
ref long  baseOddsToHit 
)
virtual

Parameters
weapon
baseOddsToHit
Returns

Implements Eamon.Framework.ICharacter.

◆ GetCarriedList()

virtual IList<IArtifact> Eamon.Game.Character.GetCarriedList ( Func< IArtifact, bool >  characterFindFunc = null)
virtual

Parameters
characterFindFunc
Returns

Implements Eamon.Framework.ICharacter.

◆ GetCharmMonsterPct()

virtual long Eamon.Game.Character.GetCharmMonsterPct ( )
virtual

Returns

Implements Eamon.Framework.ICharacter.

◆ GetContainedList()

virtual IList<IArtifact> Eamon.Game.Character.GetContainedList ( Func< IArtifact, bool >  characterFindFunc = null)
virtual

Parameters
characterFindFunc
Returns

Implements Eamon.Framework.ICharacter.

◆ GetDecoratedName()

override string Eamon.Game.Character.GetDecoratedName ( string  fieldName,
ArticleType  articleType,
bool  upshift = false,
bool  showCharOwned = true,
bool  showStateDesc = false,
bool  showContents = false,
bool  groupCountOne = false 
)
virtual

Parameters
fieldName
articleType
upshift
showCharOwned
showStateDesc
showContents
groupCountOne
Returns

Reimplemented from Eamon.Game.GameBase.

◆ GetFullInventoryWeight()

virtual RetCode Eamon.Game.Character.GetFullInventoryWeight ( ref long  weight,
Func< IArtifact, bool >  characterFindFunc = null 
)
virtual

Parameters
weight
characterFindFunc
Returns

Implements Eamon.Framework.ICharacter.

◆ GetIntellectBonusPct()

virtual long Eamon.Game.Character.GetIntellectBonusPct ( )
virtual

Returns

Implements Eamon.Framework.ICharacter.

◆ GetMerchantAdjustedCharisma()

virtual long Eamon.Game.Character.GetMerchantAdjustedCharisma ( )
virtual

Returns

Implements Eamon.Framework.ICharacter.

◆ GetPluralName()

override string Eamon.Game.Character.GetPluralName ( string  fieldName)
virtual

Parameters
fieldName
Returns

Reimplemented from Eamon.Game.GameBase.

◆ GetSpellAbility() [1/2]

virtual long Eamon.Game.Character.GetSpellAbility ( long  index)
virtual

Parameters
index
Returns

Implements Eamon.Framework.ICharacter.

◆ GetSpellAbility() [2/2]

virtual long Eamon.Game.Character.GetSpellAbility ( Spell  spell)
virtual

Parameters
spell
Returns

Implements Eamon.Framework.ICharacter.

◆ GetStat() [1/2]

virtual long Eamon.Game.Character.GetStat ( long  index)
virtual

Parameters
index
Returns

Implements Eamon.Framework.ICharacter.

◆ GetStat() [2/2]

virtual long Eamon.Game.Character.GetStat ( Stat  stat)
virtual

Parameters
stat
Returns

Implements Eamon.Framework.ICharacter.

◆ GetSynonym()

virtual string Eamon.Game.Character.GetSynonym ( long  index)
virtual

Parameters
index
Returns

Implements Eamon.Framework.ICharacter.

◆ GetWeaponAbility() [1/2]

virtual long Eamon.Game.Character.GetWeaponAbility ( long  index)
virtual

Parameters
index
Returns

Implements Eamon.Framework.ICharacter.

◆ GetWeaponAbility() [2/2]

virtual long Eamon.Game.Character.GetWeaponAbility ( Weapon  weapon)
virtual

Parameters
weapon
Returns

Implements Eamon.Framework.ICharacter.

◆ GetWeightCarryableDos()

virtual long Eamon.Game.Character.GetWeightCarryableDos ( )
virtual

Returns

Implements Eamon.Framework.ICharacter.

◆ GetWeightCarryableGronds()

virtual long Eamon.Game.Character.GetWeightCarryableGronds ( )
virtual

Returns

Implements Eamon.Framework.ICharacter.

◆ GetWornList()

virtual IList<IArtifact> Eamon.Game.Character.GetWornList ( Func< IArtifact, bool >  characterFindFunc = null)
virtual

Parameters
characterFindFunc
Returns

Implements Eamon.Framework.ICharacter.

◆ ListWeapons()

virtual RetCode Eamon.Game.Character.ListWeapons ( StringBuilder  buf,
bool  capitalize = true 
)
virtual

Parameters
buf
capitalize
Returns

Implements Eamon.Framework.ICharacter.

◆ ModSpellAbility() [1/2]

virtual void Eamon.Game.Character.ModSpellAbility ( long  index,
long  value 
)
virtual

Parameters
index
value

Implements Eamon.Framework.ICharacter.

◆ ModSpellAbility() [2/2]

virtual void Eamon.Game.Character.ModSpellAbility ( Spell  spell,
long  value 
)
virtual

Parameters
spell
value

Implements Eamon.Framework.ICharacter.

◆ ModStat() [1/2]

virtual void Eamon.Game.Character.ModStat ( long  index,
long  value 
)
virtual

Parameters
index
value

Implements Eamon.Framework.ICharacter.

◆ ModStat() [2/2]

virtual void Eamon.Game.Character.ModStat ( Stat  stat,
long  value 
)
virtual

Parameters
stat
value

Implements Eamon.Framework.ICharacter.

◆ ModWeaponAbility() [1/2]

virtual void Eamon.Game.Character.ModWeaponAbility ( long  index,
long  value 
)
virtual

Parameters
index
value

Implements Eamon.Framework.ICharacter.

◆ ModWeaponAbility() [2/2]

virtual void Eamon.Game.Character.ModWeaponAbility ( Weapon  weapon,
long  value 
)
virtual

Parameters
weapon
value

Implements Eamon.Framework.ICharacter.

◆ NormalizeGoldValues()

virtual void Eamon.Game.Character.NormalizeGoldValues ( )
virtual

◆ SetSpellAbility() [1/2]

virtual void Eamon.Game.Character.SetSpellAbility ( long  index,
long  value 
)
virtual

Parameters
index
value

Implements Eamon.Framework.ICharacter.

◆ SetSpellAbility() [2/2]

virtual void Eamon.Game.Character.SetSpellAbility ( Spell  spell,
long  value 
)
virtual

Parameters
spell
value

Implements Eamon.Framework.ICharacter.

◆ SetStat() [1/2]

virtual void Eamon.Game.Character.SetStat ( long  index,
long  value 
)
virtual

Parameters
index
value

Implements Eamon.Framework.ICharacter.

◆ SetStat() [2/2]

virtual void Eamon.Game.Character.SetStat ( Stat  stat,
long  value 
)
virtual

Parameters
stat
value

Implements Eamon.Framework.ICharacter.

◆ SetSynonym()

virtual void Eamon.Game.Character.SetSynonym ( long  index,
string  value 
)
virtual

Parameters
index
value

Implements Eamon.Framework.ICharacter.

◆ SetWeaponAbility() [1/2]

virtual void Eamon.Game.Character.SetWeaponAbility ( long  index,
long  value 
)
virtual

Parameters
index
value

Implements Eamon.Framework.ICharacter.

◆ SetWeaponAbility() [2/2]

virtual void Eamon.Game.Character.SetWeaponAbility ( Weapon  weapon,
long  value 
)
virtual

Parameters
weapon
value

Implements Eamon.Framework.ICharacter.

◆ StripUniqueCharsFromWeaponNames()

virtual bool Eamon.Game.Character.StripUniqueCharsFromWeaponNames ( )
virtual

Returns

Implements Eamon.Framework.ICharacter.

Member Data Documentation

◆ _bankGold

long Eamon.Game.Character._bankGold

◆ _heldGold

long Eamon.Game.Character._heldGold

Property Documentation

◆ ArmorClass

virtual Armor?? Eamon.Game.Character.ArmorClass
get

◆ ArmorExpertise

virtual long Eamon.Game.Character.ArmorExpertise
getset

◆ BankGold

virtual long Eamon.Game.Character.BankGold
getset

◆ Gender

virtual Gender Eamon.Game.Character.Gender
getset

◆ HeldGold

virtual long Eamon.Game.Character.HeldGold
getset

◆ SpellAbilities

virtual long [] Eamon.Game.Character.SpellAbilities
getset

◆ Stats

virtual long [] Eamon.Game.Character.Stats
getset

◆ Status

virtual Status Eamon.Game.Character.Status
getset

◆ WeaponAbilities

virtual long [] Eamon.Game.Character.WeaponAbilities
getset

The documentation for this class was generated from the following file: