Eamon CS  3.1.0
Eamon.Framework.ICharacter Interface Reference

More...

Inheritance diagram for Eamon.Framework.ICharacter:
Eamon.Framework.IGameBase Eamon.Game.Character

Public Member Functions

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

Properties

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

Detailed Description

Member Function Documentation

◆ AddUniqueCharsToWeaponNames()

bool Eamon.Framework.ICharacter.AddUniqueCharsToWeaponNames ( )

Returns

Implemented in Eamon.Game.Character.

◆ EvalGender< T >()

T Eamon.Framework.ICharacter.EvalGender< T > ( maleValue,
femaleValue,
neutralValue 
)

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

Parameters
maleValue
femaleValue
neutralValue
Returns

Implemented in Eamon.Game.Character.

◆ GetBaseOddsToHit()

RetCode Eamon.Framework.ICharacter.GetBaseOddsToHit ( IArtifact  weapon,
ref long  baseOddsToHit 
)

Parameters
weapon
baseOddsToHit
Returns

Implemented in Eamon.Game.Character.

◆ GetCarriedList()

IList<IArtifact> Eamon.Framework.ICharacter.GetCarriedList ( Func< IArtifact, bool >  characterFindFunc = null)

Parameters
characterFindFunc
Returns

Implemented in Eamon.Game.Character.

◆ GetCharmMonsterPct()

long Eamon.Framework.ICharacter.GetCharmMonsterPct ( )

Returns

Implemented in Eamon.Game.Character.

◆ GetContainedList()

IList<IArtifact> Eamon.Framework.ICharacter.GetContainedList ( Func< IArtifact, bool >  characterFindFunc = null)

Parameters
characterFindFunc
Returns

Implemented in Eamon.Game.Character.

◆ GetFullInventoryWeight()

RetCode Eamon.Framework.ICharacter.GetFullInventoryWeight ( ref long  weight,
Func< IArtifact, bool >  characterFindFunc = null 
)

Parameters
weight
characterFindFunc
Returns

Implemented in Eamon.Game.Character.

◆ GetIntellectBonusPct()

long Eamon.Framework.ICharacter.GetIntellectBonusPct ( )

Returns

Implemented in Eamon.Game.Character.

◆ GetMerchantAdjustedCharisma()

long Eamon.Framework.ICharacter.GetMerchantAdjustedCharisma ( )

Returns

Implemented in Eamon.Game.Character.

◆ GetSpellAbility() [1/2]

long Eamon.Framework.ICharacter.GetSpellAbility ( long  index)

Parameters
index
Returns

Implemented in Eamon.Game.Character.

◆ GetSpellAbility() [2/2]

long Eamon.Framework.ICharacter.GetSpellAbility ( Spell  spell)

Parameters
spell
Returns

Implemented in Eamon.Game.Character.

◆ GetStat() [1/2]

long Eamon.Framework.ICharacter.GetStat ( long  index)

Parameters
index
Returns

Implemented in Eamon.Game.Character.

◆ GetStat() [2/2]

long Eamon.Framework.ICharacter.GetStat ( Stat  stat)

Parameters
stat
Returns

Implemented in Eamon.Game.Character.

◆ GetSynonym()

string Eamon.Framework.ICharacter.GetSynonym ( long  index)

Parameters
index
Returns

Implemented in Eamon.Game.Character.

◆ GetWeaponAbility() [1/2]

long Eamon.Framework.ICharacter.GetWeaponAbility ( long  index)

Parameters
index
Returns

Implemented in Eamon.Game.Character.

◆ GetWeaponAbility() [2/2]

long Eamon.Framework.ICharacter.GetWeaponAbility ( Weapon  weapon)

Parameters
weapon
Returns

Implemented in Eamon.Game.Character.

◆ GetWeightCarryableDos()

long Eamon.Framework.ICharacter.GetWeightCarryableDos ( )

Returns

Implemented in Eamon.Game.Character.

◆ GetWeightCarryableGronds()

long Eamon.Framework.ICharacter.GetWeightCarryableGronds ( )

Returns

Implemented in Eamon.Game.Character.

◆ GetWornList()

IList<IArtifact> Eamon.Framework.ICharacter.GetWornList ( Func< IArtifact, bool >  characterFindFunc = null)

Parameters
characterFindFunc
Returns

Implemented in Eamon.Game.Character.

◆ ListWeapons()

RetCode Eamon.Framework.ICharacter.ListWeapons ( StringBuilder  buf,
bool  capitalize = true 
)

Parameters
buf
capitalize
Returns

Implemented in Eamon.Game.Character.

◆ ModSpellAbility() [1/2]

void Eamon.Framework.ICharacter.ModSpellAbility ( long  index,
long  value 
)

Parameters
index
value

Implemented in Eamon.Game.Character.

◆ ModSpellAbility() [2/2]

void Eamon.Framework.ICharacter.ModSpellAbility ( Spell  spell,
long  value 
)

Parameters
spell
value

Implemented in Eamon.Game.Character.

◆ ModStat() [1/2]

void Eamon.Framework.ICharacter.ModStat ( long  index,
long  value 
)

Parameters
index
value

Implemented in Eamon.Game.Character.

◆ ModStat() [2/2]

void Eamon.Framework.ICharacter.ModStat ( Stat  stat,
long  value 
)

Parameters
stat
value

Implemented in Eamon.Game.Character.

◆ ModWeaponAbility() [1/2]

void Eamon.Framework.ICharacter.ModWeaponAbility ( long  index,
long  value 
)

Parameters
index
value

Implemented in Eamon.Game.Character.

◆ ModWeaponAbility() [2/2]

void Eamon.Framework.ICharacter.ModWeaponAbility ( Weapon  weapon,
long  value 
)

Parameters
weapon
value

Implemented in Eamon.Game.Character.

◆ SetSpellAbility() [1/2]

void Eamon.Framework.ICharacter.SetSpellAbility ( long  index,
long  value 
)

Parameters
index
value

Implemented in Eamon.Game.Character.

◆ SetSpellAbility() [2/2]

void Eamon.Framework.ICharacter.SetSpellAbility ( Spell  spell,
long  value 
)

Parameters
spell
value

Implemented in Eamon.Game.Character.

◆ SetStat() [1/2]

void Eamon.Framework.ICharacter.SetStat ( long  index,
long  value 
)

Parameters
index
value

Implemented in Eamon.Game.Character.

◆ SetStat() [2/2]

void Eamon.Framework.ICharacter.SetStat ( Stat  stat,
long  value 
)

Parameters
stat
value

Implemented in Eamon.Game.Character.

◆ SetSynonym()

void Eamon.Framework.ICharacter.SetSynonym ( long  index,
string  value 
)

Parameters
index
value

Implemented in Eamon.Game.Character.

◆ SetWeaponAbility() [1/2]

void Eamon.Framework.ICharacter.SetWeaponAbility ( long  index,
long  value 
)

Parameters
index
value

Implemented in Eamon.Game.Character.

◆ SetWeaponAbility() [2/2]

void Eamon.Framework.ICharacter.SetWeaponAbility ( Weapon  weapon,
long  value 
)

Parameters
weapon
value

Implemented in Eamon.Game.Character.

◆ StripUniqueCharsFromWeaponNames()

bool Eamon.Framework.ICharacter.StripUniqueCharsFromWeaponNames ( )

Returns

Implemented in Eamon.Game.Character.

Property Documentation

◆ ArmorClass

Armor Eamon.Framework.ICharacter.ArmorClass
get

◆ ArmorExpertise

long Eamon.Framework.ICharacter.ArmorExpertise
getset

◆ BankGold

long Eamon.Framework.ICharacter.BankGold
getset

◆ Gender

Gender Eamon.Framework.ICharacter.Gender
getset

Gets or sets this Character's gender.

◆ HeldGold

long Eamon.Framework.ICharacter.HeldGold
getset

◆ SpellAbilities

long [] Eamon.Framework.ICharacter.SpellAbilities
getset

◆ Stats

long [] Eamon.Framework.ICharacter.Stats
getset

◆ Status

Status Eamon.Framework.ICharacter.Status
getset

◆ WeaponAbilities

long [] Eamon.Framework.ICharacter.WeaponAbilities
getset


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