Inheritance diagram for Eamon.Framework.IMonster:

Public Member Functions
bool	IsDead ()
	Indicates whether this Monster is dead. More...

bool	IsCarryingWeapon ()

bool	IsWeaponless (bool includeWeaponFumble)

bool	HasDeadBody ()

bool	HasWornInventory ()

bool	HasCarriedInventory ()

bool	HasHumanNaturalAttackDescs ()

bool	HasMoved (long oldLocation, long newLocation)

bool	IsInRoom ()

bool	IsInLimbo ()

bool	IsInRoomUid (long roomUid)

bool	IsInRoom (IRoom room)

bool	IsAttackable (IMonster monster)

bool	CanMoveToRoomUid (long roomUid, bool fleeing)

bool	CanMoveToRoom (IRoom room, bool fleeing)

bool	CanMoveInDirection (Direction dir, bool fleeing)

bool	CanAttackWithMultipleWeapons ()
	Indicates whether this Monster is allowed to attack with multiple Artifact weapons in a single combat round, if certain other conditions are met. More...

bool	CanCarryArtifactWeight (IArtifact artifact)

long	GetCarryingWeaponUid ()

long	GetDeadBodyUid ()

long	GetInRoomUid ()

IRoom	GetInRoom ()

void	SetInRoomUid (long roomUid)

void	SetInLimbo ()

void	SetInRoom (IRoom room)

bool	IsInRoomLit ()

bool	IsInRoomViewable ()

bool	ShouldFleeRoom ()

bool	ShouldCastSpell (ref Enums.Spell spellCast, ref IGameBase spellTarget)

bool	ShouldReadyWeapon ()

bool	ShouldShowContentsWhenExamined ()

bool	ShouldShowHealthStatusWhenExamined ()

bool	ShouldShowHealthStatusWhenInventoried ()

bool	ShouldShowVerboseNameStateDesc ()

bool	ShouldCheckToAttackNonEnemy ()

bool	ShouldProcessInGameLoop ()

bool	ShouldRefuseToAcceptGold ()

bool	ShouldRefuseToAcceptGift (IArtifact artifact)

bool	ShouldRefuseToAcceptDeadBody (IArtifact artifact)

bool	ShouldPreferNaturalWeaponsToWeakerWeapon (IArtifact artifact)

bool	ShouldCombatStanceChangedConsumeTurn (long oldParry, long newParry)

bool	ShouldPrintCombatStanceChanged (long oldParry, long newParry)

bool	CheckNBTLHostility ()

bool	CheckCourage ()

bool	CheckParryAdjustment ()

T	EvalReaction< T > (T enemyValue, T neutralValue, T friendValue)
	Evaluates this Monster's Reaction, returning a value of type T. More...

T	EvalGender< T > (T maleValue, T femaleValue, T neutralValue)
	Evaluates this Monster's Gender, returning a value of type T. More...

T	EvalPlural< T > (T singularValue, T pluralValue)
	Evaluates this Monster's CurrGroupCount, returning a value of type T. More...

T	EvalInRoomLightLevel< T > (T darkValue, T lightValue)
	Evaluates the LightLvl of this Monster's Room (as determined by its Location), returning a value of type T. More...

T	EvalInRoomViewability< T > (T nonviewableValue, T viewableValue)

void	ResolveReaction (long charisma)

void	ResolveReaction (ICharacter character)

void	CalculateGiftFriendliness (long value, bool isArtifactValue)

bool	IsCharacterMonster ()
	Indicates whether this Monster represents the player character. More...

bool	IsStateDescSideNotes ()

long	GetWeightCarryableGronds ()

long	GetFleeingMemberCount ()

long	GetMaxMemberActionCount ()

long	GetMaxMemberAttackCount ()

long	GetInitParryResetOdds ()

long	GetCombatStanceIndex (long parry)

long	GetTrendToPreferredOdds ()

long	GetTrendToPreferredRange ()

double	GetTrendToPreferredMultiplier ()

long	GetCrowdAwareBonus ()

long	GetProgressivelyAggressiveModifier ()

bool	GetAbilityDependentReady ()

long	GetParryAdjustment ()

IMonsterSpell	GetMonsterSpell (Enums.Spell spell)

IList< IArtifact >	GetCarriedList (Func< IArtifact, bool > monsterFindFunc=null, Func< IArtifact, bool > artifactFindFunc=null, bool recurse=false)

IList< IArtifact >	GetWornList (Func< IArtifact, bool > monsterFindFunc=null, Func< IArtifact, bool > artifactFindFunc=null, bool recurse=false)

IList< IArtifact >	GetContainedList (Func< IArtifact, bool > monsterFindFunc=null, Func< IArtifact, bool > artifactFindFunc=null, bool recurse=false)

RetCode	EnforceFullInventoryWeightLimits (Func< IArtifact, bool > monsterFindFunc=null, Func< IArtifact, bool > artifactFindFunc=null, bool recurse=false)

RetCode	GetFullInventoryWeight (ref long weight, Func< IArtifact, bool > monsterFindFunc=null, Func< IArtifact, bool > artifactFindFunc=null, bool recurse=false)

void	AddHealthStatus (StringBuilder buf, bool appendNewLine=true)

string[]	GetWeaponAttackDescs (IArtifact artifact)

string[]	GetHumanAttackDescs ()

string[]	GetNaturalAttackDescs ()

string	GetAttackDescString (IRoom room, IArtifact artifact)

string[]	GetWeaponMissDescs (IArtifact artifact)

string[]	GetNaturalMissDescs ()

string	GetMissDescString (IArtifact artifact)

string	GetArmorDescString ()

string	GetCantFindExitDescString (IRoom room, string monsterName, bool isPlural, bool fleeing)

string	GetMembersExitRoomDescString (IRoom room, string monsterName, bool isPlural, bool fleeing)

string	GetExitRoomDescString (IRoom room, string monsterName, bool isPlural, bool fleeing, Direction exitDirection)

string	GetEnterRoomDescString (IRoom room, string monsterName, bool isPlural, bool fleeing, Direction enterDirection)

string	GetParryCombatStanceString ()

string	GetAssumeCombatStanceString ()

string	GetAssumeCombatStanceString01 ()

string	GetCombatStanceString ()

string	GetPovString (string youString, string maleString, string femaleString, string neutralString, string groupString)

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
string	StateDesc `[get, set]`
	Gets or sets a description shown after this Monster's Name in various lists that indicates its state. More...

bool	IsListed `[get, set]`
	Gets or sets a value indicating whether this Monster should be displayed in various lists. More...

PluralType	PluralType `[get, set]`
	Gets or sets a value indicating how this Monster's singular Name is modified to produce its plural Name. More...

long	Hardiness `[get, set]`
	Gets or sets this Monster's Hardiness Stat. More...

long	Agility `[get, set]`
	Gets or sets this Monster's Agility Stat. More...

long	GroupCount `[get, set]`
	Gets or sets the original number of members in this Monster's group at the beginning of the game (will be 1 for individuals). More...

long	AttackCount `[get, set]`
	Gets or sets the number of attacks each member in this Monster's group can make every combat round. More...

long	Courage `[get, set]`

long	Location `[get, set]`
	Gets or sets the location of this Monster in the game (typically a Room Uid). More...

CombatCode	CombatCode `[get, set]`
	Gets or sets a value indicating this Monster's behavior when in combat. More...

ParryCode	ParryCode `[get, set]`
	Gets or sets a value indicating this Monster's parrying behavior in combat. More...

long	Parry `[get, set]`

long	ParryOdds `[get, set]`

long	ParryTurns `[get, set]`

long	Armor `[get, set]`

long	Weapon `[get, set]`
	Gets or sets the Artifact Uid for this Monster's readied weapon (may be 0 or negative if none exists). More...

long	NwDice `[get, set]`
	Gets or sets the hit dice done per attack, for Monsters that can use natural attacks (based on CombatCode). More...

long	NwSides `[get, set]`
	Gets or sets the hit dice sides done per attack, for Monsters that can use natural attacks (based on CombatCode). More...

long	DeadBody `[get, set]`
	Gets or sets the Artifact Uid for this Monster's dead body (may be 0 if none exists). More...

Friendliness	Friendliness `[get, set]`

Gender	Gender `[get, set]`
	Gets or sets this Monster's gender. More...

long	InitGroupCount `[get, set]`
	Gets or sets the initial number of members in this Monster's group at the beginning of the current combat round (will be 1 for individuals). More...

long	CurrGroupCount `[get, set]`
	Gets or sets the current number of members in this Monster's group (will be 1 for individuals). More...

long	InitParry `[get, set]`

Friendliness	Reaction `[get, set]`

long	DmgTaken `[get, set]`
	Gets or sets the number of hit points of damage taken by this Monster, either in combat or otherwise. More...

long	Field1 `[get, set]`
	Gets or sets a value that is unused by Eamon CS, but provided for game developer usage. More...

long	Field2 `[get, set]`
	Gets or sets a value that is unused by Eamon CS, but provided for game developer usage. More...

IMonsterSpell[]	Spells `[get, set]`
	Gets or sets an array of MonsterSpell objects that define this Monster's spellcasting ability (NPC only). More...

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

◆ AddHealthStatus()

void Eamon.Framework.IMonster.AddHealthStatus	(	StringBuilder	buf,
		bool	appendNewLine = `true`
	)

Parameters

buf
appendNewLine

Implemented in Eamon.Game.Monster, TheBeginnersCave.Game.Monster, StrongholdOfKahrDur.Game.Monster, WrenholdsSecretVigil.Game.Monster, ThePyramidOfAnharos.Game.Monster, and TheTempleOfNgurct.Game.Monster.

◆ CalculateGiftFriendliness()

void Eamon.Framework.IMonster.CalculateGiftFriendliness	(	long	value,
		bool	isArtifactValue
	)

Parameters

value
isArtifactValue

Implemented in Eamon.Game.Monster, TheVileGrimoireOfJaldial.Game.Monster, and TheDeepCanyon.Game.Monster.

◆ CanAttackWithMultipleWeapons()

bool Eamon.Framework.IMonster.CanAttackWithMultipleWeapons ( )

Indicates whether this Monster is allowed to attack with multiple Artifact weapons in a single combat round, if certain other conditions are met.

This method allows support for Monsters that can multi-attack and also multi-wield. The conditions that need to be met to trigger this behavior include: the Monster is an individual, it is armed and carrying more than one Artifact weapon and this method must return true. By default, it returns false.

Returns: If so then true, otherwise false.

bool Eamon.Framework.IMonster.CanMoveInDirection	(	Direction	dir,
		bool	fleeing
	)

bool Eamon.Framework.IMonster.CanMoveToRoom	(	IRoom	room,
		bool	fleeing
	)

bool Eamon.Framework.IMonster.CanMoveToRoomUid	(	long	roomUid,
		bool	fleeing
	)

RetCode Eamon.Framework.IMonster.EnforceFullInventoryWeightLimits	(	Func< IArtifact, bool >	monsterFindFunc = `null`,
		Func< IArtifact, bool >	artifactFindFunc = `null`,
		bool	recurse = `false`
	)

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

T Eamon.Framework.IMonster.EvalInRoomLightLevel< T >	(	T	darkValue,
		T	lightValue
	)

T Eamon.Framework.IMonster.EvalInRoomViewability< T >	(	T	nonviewableValue,
		T	viewableValue
	)

T Eamon.Framework.IMonster.EvalPlural< T >	(	T	singularValue,
		T	pluralValue
	)

T Eamon.Framework.IMonster.EvalReaction< T >	(	T	enemyValue,
		T	neutralValue,
		T	friendValue
	)

string Eamon.Framework.IMonster.GetAttackDescString	(	IRoom	room,
		IArtifact	artifact
	)

dir
fleeing

room
fleeing

roomUid
fleeing

monsterFindFunc
artifactFindFunc
recurse

string Eamon.Framework.IMonster.GetCantFindExitDescString	(	IRoom	room,
		string	monsterName,
		bool	isPlural,
		bool	fleeing
	)

IList<IArtifact> Eamon.Framework.IMonster.GetCarriedList	(	Func< IArtifact, bool >	monsterFindFunc = `null`,
		Func< IArtifact, bool >	artifactFindFunc = `null`,
		bool	recurse = `false`
	)

string Eamon.Framework.IMonster.GetEnterRoomDescString	(	IRoom	room,
		string	monsterName,
		bool	isPlural,
		bool	fleeing,
		Direction	enterDirection
	)

string Eamon.Framework.IMonster.GetExitRoomDescString	(	IRoom	room,
		string	monsterName,
		bool	isPlural,
		bool	fleeing,
		Direction	exitDirection
	)

RetCode Eamon.Framework.IMonster.GetFullInventoryWeight	(	ref long	weight,
		Func< IArtifact, bool >	monsterFindFunc = `null`,
		Func< IArtifact, bool >	artifactFindFunc = `null`,
		bool	recurse = `false`
	)

string Eamon.Framework.IMonster.GetMembersExitRoomDescString	(	IRoom	room,
		string	monsterName,
		bool	isPlural,
		bool	fleeing
	)

string Eamon.Framework.IMonster.GetPovString	(	string	youString,
		string	maleString,
		string	femaleString,
		string	neutralString,
		string	groupString
	)

bool Eamon.Framework.IMonster.HasMoved	(	long	oldLocation,
		long	newLocation
	)

bool Eamon.Framework.IMonster.ShouldCastSpell	(	ref Enums.Spell	spellCast,
		ref IGameBase	spellTarget
	)

bool Eamon.Framework.IMonster.ShouldCombatStanceChangedConsumeTurn	(	long	oldParry,
		long	newParry
	)

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ AddHealthStatus()

◆ CalculateGiftFriendliness()

◆ CanAttackWithMultipleWeapons()

◆ CanCarryArtifactWeight()

◆ CanMoveInDirection()

◆ CanMoveToRoom()

◆ CanMoveToRoomUid()

◆ CheckCourage()

◆ CheckNBTLHostility()

◆ CheckParryAdjustment()

◆ EnforceFullInventoryWeightLimits()

◆ EvalGender< T >()

◆ EvalInRoomLightLevel< T >()

◆ EvalInRoomViewability< T >()

◆ EvalPlural< T >()

◆ EvalReaction< T >()

◆ GetAbilityDependentReady()

◆ GetArmorDescString()

◆ GetAssumeCombatStanceString()

◆ GetAssumeCombatStanceString01()

◆ GetAttackDescString()

◆ GetCantFindExitDescString()

◆ GetCarriedList()

◆ GetCarryingWeaponUid()

◆ GetCombatStanceIndex()

◆ GetCombatStanceString()

◆ GetContainedList()

◆ GetCrowdAwareBonus()

◆ GetDeadBodyUid()

◆ GetEnterRoomDescString()

◆ GetExitRoomDescString()

◆ GetFleeingMemberCount()

◆ GetFullInventoryWeight()

◆ GetHumanAttackDescs()

◆ GetInitParryResetOdds()

◆ GetInRoom()

◆ GetInRoomUid()

◆ GetMaxMemberActionCount()

◆ GetMaxMemberAttackCount()

◆ GetMembersExitRoomDescString()

◆ GetMissDescString()

◆ GetMonsterSpell()

◆ GetNaturalAttackDescs()

◆ GetNaturalMissDescs()

◆ GetParryAdjustment()

◆ GetParryCombatStanceString()

◆ GetPovString()

◆ GetProgressivelyAggressiveModifier()

◆ GetTrendToPreferredMultiplier()

◆ GetTrendToPreferredOdds()

◆ GetTrendToPreferredRange()

◆ GetWeaponAttackDescs()

◆ GetWeaponMissDescs()

◆ GetWeightCarryableGronds()

◆ GetWornList()

◆ HasCarriedInventory()

◆ HasDeadBody()

◆ HasHumanNaturalAttackDescs()

◆ HasMoved()

◆ HasWornInventory()

◆ IsAttackable()

◆ IsCarryingWeapon()

◆ IsCharacterMonster()

◆ IsDead()

◆ IsInLimbo()

◆ IsInRoom() [1/2]

◆ IsInRoom() [2/2]

◆ IsInRoomLit()

◆ IsInRoomUid()

◆ IsInRoomViewable()

◆ IsStateDescSideNotes()

◆ IsWeaponless()

◆ ResolveReaction() [1/2]

◆ ResolveReaction() [2/2]

◆ SetInLimbo()

◆ SetInRoom()

bool Eamon.Framework.IMonster.ShouldPrintCombatStanceChanged	(	long	oldParry,
		long	newParry
	)