Eamon CS  3.1.0
LandOfTheMountainKing.Game.Artifact Class Reference
Inheritance diagram for LandOfTheMountainKing.Game.Artifact:
Eamon.Game.Artifact Eamon.Framework.IArtifact Eamon.Game.GameBase Eamon.Framework.IArtifact Eamon.Framework.IGameBase Eamon.Framework.IGameBase Eamon.Framework.IGameBase

Public Member Functions

override RetCode BuildPrintedFullDesc (StringBuilder buf, bool showName, bool showVerboseName)
 
override bool ShouldExposeContentsToRoom (ContainerType containerType=ContainerType.In)
 
- Public Member Functions inherited from Eamon.Game.Artifact
override void Dispose (bool disposing)
 
override void SetParentReferences ()
 
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 (IArtifact artifact)
 
virtual IArtifactCategory GetCategory (long index)
 
virtual string GetSynonym (long index)
 
virtual void SetCategory (long index, IArtifactCategory value)
 
virtual void SetSynonym (long index, string value)
 
virtual bool HasMoved (long oldLocation, long newLocation)
 
virtual bool IsCarriedByCharacter ()
 
virtual bool IsCarriedByMonster (MonsterType monsterType=MonsterType.NonCharMonster, bool recurse=false)
 
virtual bool IsCarriedByContainer ()
 
virtual bool IsWornByCharacter ()
 
virtual bool IsWornByMonster (MonsterType monsterType=MonsterType.NonCharMonster, bool recurse=false)
 
virtual bool IsInRoom (bool recurse=false)
 
virtual bool IsEmbeddedInRoom (bool recurse=false)
 
virtual bool IsCarriedByContainerContainerTypeExposedToMonster (MonsterType monsterType=MonsterType.NonCharMonster, bool recurse=false)
 
virtual bool IsCarriedByContainerContainerTypeExposedToRoom (bool recurse=false)
 
virtual bool IsInLimbo (bool recurse=false)
 
virtual bool IsCarriedByCharacterUid (long characterUid)
 
virtual bool IsCarriedByMonsterUid (long monsterUid, bool recurse=false)
 
virtual bool IsCarriedByContainerUid (long containerUid, bool recurse=false)
 
virtual bool IsWornByCharacterUid (long characterUid)
 
virtual bool IsWornByMonsterUid (long monsterUid, bool recurse=false)
 
virtual bool IsReadyableByMonsterUid (long monsterUid)
 
virtual bool IsInRoomUid (long roomUid, bool recurse=false)
 
virtual bool IsEmbeddedInRoomUid (long roomUid, bool recurse=false)
 
virtual bool IsCarriedByContainerContainerTypeExposedToMonsterUid (long monsterUid, bool recurse=false)
 
virtual bool IsCarriedByContainerContainerTypeExposedToRoomUid (long roomUid, bool recurse=false)
 
virtual bool IsCarriedByCharacter (ICharacter character)
 
virtual bool IsCarriedByMonster (IMonster monster, bool recurse=false)
 
virtual bool IsCarriedByContainer (IArtifact container, bool recurse=false)
 
virtual bool IsWornByCharacter (ICharacter character)
 
virtual bool IsWornByMonster (IMonster monster, bool recurse=false)
 
virtual bool IsReadyableByMonster (IMonster monster)
 
virtual bool IsInRoom (IRoom room, bool recurse=false)
 
virtual bool IsEmbeddedInRoom (IRoom room, bool recurse=false)
 
virtual bool IsCarriedByContainerContainerTypeExposedToMonster (IMonster monster, bool recurse=false)
 
virtual bool IsCarriedByContainerContainerTypeExposedToRoom (IRoom room, bool recurse=false)
 
virtual long GetCarriedByCharacterUid ()
 
virtual long GetCarriedByMonsterUid (bool recurse=false)
 
virtual long GetCarriedByContainerUid (bool recurse=false)
 
virtual long GetWornByCharacterUid ()
 
virtual long GetWornByMonsterUid (bool recurse=false)
 
virtual long GetInRoomUid (bool recurse=false)
 
virtual long GetEmbeddedInRoomUid (bool recurse=false)
 
virtual ICharacter GetCarriedByCharacter ()
 
virtual IMonster GetCarriedByMonster (bool recurse=false)
 
virtual IArtifact GetCarriedByContainer (bool recurse=false)
 
virtual ICharacter GetWornByCharacter ()
 
virtual IMonster GetWornByMonster (bool recurse=false)
 
virtual IRoom GetInRoom (bool recurse=false)
 
virtual IRoom GetEmbeddedInRoom (bool recurse=false)
 
virtual ContainerType GetCarriedByContainerContainerType ()
 
virtual void SetCarriedByCharacterUid (long characterUid)
 
virtual void SetCarriedByMonsterUid (long monsterUid)
 
virtual void SetCarriedByContainerUid (long containerUid, ContainerType containerType=ContainerType.In)
 
virtual void SetWornByCharacterUid (long characterUid)
 
virtual void SetWornByMonsterUid (long monsterUid)
 
virtual void SetInRoomUid (long roomUid)
 
virtual void SetEmbeddedInRoomUid (long roomUid)
 
virtual void SetInLimbo ()
 
virtual void SetCarriedByCharacter (ICharacter character)
 
virtual void SetCarriedByMonster (IMonster monster)
 
virtual void SetCarriedByContainer (IArtifact container, ContainerType containerType=ContainerType.In)
 
virtual void SetWornByCharacter (ICharacter character)
 
virtual void SetWornByMonster (IMonster monster)
 
virtual void SetInRoom (IRoom room)
 
virtual void SetEmbeddedInRoom (IRoom room)
 
virtual bool IsInRoomLit ()
 
virtual bool IsInRoomViewable ()
 
virtual bool IsEmbeddedInRoomLit ()
 
virtual bool IsEmbeddedInRoomViewable ()
 
virtual bool IsFieldStrength (long value)
 
virtual long GetFieldStrength (long value)
 
virtual bool IsWeapon (Weapon weapon)
 
virtual bool IsAttackable (ref IArtifactCategory ac)
 
virtual bool IsRequestable ()
 
virtual bool IsUnmovable ()
 
virtual bool IsUnmovable01 ()
 
virtual bool IsArmor ()
 
virtual bool IsShield ()
 
virtual bool IsDisguisedMonster ()
 
virtual bool IsStateDescSideNotes ()
 
virtual bool IsInContainerOpenedFromTop ()
 
virtual bool IsDoorGateInObviousExitsList ()
 
virtual bool ShouldAllowBlastSkillGains ()
 
virtual bool ShouldExposeInContentsWhenClosed ()
 
virtual bool ShouldExposeContentsToMonster (MonsterType monsterType=MonsterType.NonCharMonster, ContainerType containerType=ContainerType.In)
 
virtual bool ShouldAddContentsWhenCarried (ContainerType containerType=ContainerType.In)
 
virtual bool ShouldAddContentsWhenWorn (ContainerType containerType=ContainerType.In)
 
virtual bool ShouldAddContents (IArtifact artifact, ContainerType containerType=ContainerType.In)
 
virtual bool ShouldRevealContentsWhenMoved (ContainerType containerType=ContainerType.In)
 
virtual bool ShouldRevealContentsWhenMovedIntoLimbo (ContainerType containerType=ContainerType.In)
 
virtual bool ShouldShowContentsWhenExamined ()
 
virtual bool ShouldShowContentsWhenOpened ()
 
virtual bool ShouldShowVerboseNameContentsNameList ()
 
virtual bool ShouldShowVerboseNameStateDesc ()
 
virtual long GetMaxContentsNameListCount (ContainerType containerType=ContainerType.In)
 
virtual string GetContainerSomethingDesc ()
 
virtual string GetContainerSomeStuffDesc ()
 
virtual string GetDoorGateFleeDesc ()
 
virtual string GetProvidingLightDesc ()
 
virtual string GetReadyWeaponDesc ()
 
virtual string GetBrokenDesc ()
 
virtual string GetEmptyDesc ()
 
virtual T EvalPlural< T > (T singularValue, T pluralValue)
 
virtual T EvalInRoomLightLevel< T > (T darkValue, T lightValue)
 
virtual T EvalInRoomViewability< T > (T nonviewableValue, T viewableValue)
 
virtual T EvalEmbeddedInRoomLightLevel< T > (T darkValue, T lightValue)
 
virtual T EvalEmbeddedInRoomViewability< T > (T nonviewableValue, T viewableValue)
 
virtual IArtifactCategory GetArtifactCategory (ArtifactType artifactType)
 
virtual IArtifactCategory GetArtifactCategory (ArtifactType[] artifactTypes, bool categoryArrayPrecedence=true)
 
virtual IList< IArtifactCategoryGetArtifactCategoryList (ArtifactType[] artifactTypes)
 
virtual RetCode SetArtifactCategoryCount (long count)
 
virtual RetCode AddStateDesc (string stateDesc, bool dupAllowed=false)
 
virtual RetCode RemoveStateDesc (string stateDesc)
 
virtual IList< IArtifactGetContainedList (Func< IArtifact, bool > artifactFindFunc=null, ContainerType containerType=ContainerType.In, bool recurse=false)
 
virtual void GetContainedList01 (IList< IArtifact > artifactList, Func< IArtifact, bool > artifactFindFunc=null, ContainerType containerType=ContainerType.In, bool recurse=false)
 
virtual RetCode GetContainerInfo (ref long count, ref long weight, ContainerType containerType=ContainerType.In, bool recurse=false)
 
virtual string GetContainerContentsDesc (IRecordNameListArgs recordNameListArgs=null)
 
virtual void SyncArtifactCategories (IArtifactCategory modifiedAc)
 
 Artifact ()
 
- Public Member Functions inherited from Eamon.Game.GameBase
void Dispose ()
 
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 ()
 

Additional Inherited Members

- Public Attributes inherited from Eamon.Game.Artifact
long _location
 
IArtifactCategory _lastArtifactCategory
 
- Properties inherited from Eamon.Game.Artifact
virtual string StateDesc [get, set]
 
virtual bool IsCharOwned [get, set]
 
virtual bool IsPlural [get, set]
 
virtual bool IsListed [get, set]
 
virtual PluralType PluralType [get, set]
 
virtual long Value [get, set]
 
virtual long Weight [get, set]
 
virtual long RecursiveWeight [get]
 
virtual long Location [get, set]
 
virtual ArtifactTypeType [get, set]
 
virtual long? Field1 [get, set]
 
virtual long? Field2 [get, set]
 
virtual long? Field3 [get, set]
 
virtual long? Field4 [get, set]
 
virtual long? Field5 [get, set]
 
virtual long? Field6 [get, set]
 
virtual long? Field7 [get, set]
 
virtual long? Field8 [get, set]
 
virtual long? Field9 [get, set]
 
virtual long? Field10 [get, set]
 
virtual long? Field11 [get, set]
 
virtual long? Field12 [get, set]
 
virtual long? Field13 [get, set]
 
virtual long? Field14 [get, set]
 
virtual long? Field15 [get, set]
 
virtual long? Field16 [get, set]
 
virtual long? Field17 [get, set]
 
virtual long? Field18 [get, set]
 
virtual long? Field19 [get, set]
 
virtual long? Field20 [get, set]
 
virtual IArtifactCategory Gold [get]
 
virtual IArtifactCategory Treasure [get]
 
virtual IArtifactCategory Weapon [get]
 
virtual IArtifactCategory MagicWeapon [get]
 
virtual IArtifactCategory GeneralWeapon [get]
 
virtual IArtifactCategory InContainer [get]
 
virtual IArtifactCategory OnContainer [get]
 
virtual IArtifactCategory UnderContainer [get]
 
virtual IArtifactCategory BehindContainer [get]
 
virtual IArtifactCategory GeneralContainer [get]
 
virtual IArtifactCategory LightSource [get]
 
virtual IArtifactCategory Drinkable [get]
 
virtual IArtifactCategory Readable [get]
 
virtual IArtifactCategory DoorGate [get]
 
virtual IArtifactCategory Edible [get]
 
virtual IArtifactCategory BoundMonster [get]
 
virtual IArtifactCategory Wearable [get]
 
virtual IArtifactCategory DisguisedMonster [get]
 
virtual IArtifactCategory DeadBody [get]
 
virtual IArtifactCategory User1 [get]
 
virtual IArtifactCategory User2 [get]
 
virtual IArtifactCategory User3 [get]
 
virtual IArtifactCategory[] Categories [get, set]
 
- 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.IArtifact
string StateDesc [get, set]
 Gets or sets a description shown after this Artifact's Name in various lists that indicates its state. More...
 
bool IsCharOwned [get, set]
 Gets or sets a value indicating whether this Artifact is owned by the player character. More...
 
bool IsPlural [get, set]
 Gets or sets a value indicating whether this Artifact represents a group of objects. More...
 
bool IsListed [get, set]
 Gets or sets a value indicating whether this Artifact should be displayed in various lists. More...
 
PluralType PluralType [get, set]
 Gets or sets a value indicating how this Artifact's singular Name is modified to produce its plural Name. More...
 
long Value [get, set]
 Gets or sets the base value of this Artifact in gold pieces. More...
 
long Weight [get, set]
 Gets or sets the weight of this Artifact in Gronds. More...
 
long RecursiveWeight [get]
 Gets the recursive weight of this Artifact in Gronds. More...
 
long Location [get, set]
 Gets or sets the location of this Artifact in the game (typically a Room Uid or a special code). More...
 
ArtifactType Type [get, set]
 Gets or sets the primary Type of this Artifact, a convenience to emulate Eamon Deluxe. More...
 
long Field1 [get, set]
 Gets or sets the primary Field1 of this Artifact, a convenience to emulate Eamon Deluxe. More...
 
long Field2 [get, set]
 Gets or sets the primary Field2 of this Artifact, a convenience to emulate Eamon Deluxe. More...
 
long Field3 [get, set]
 Gets or sets the primary Field3 of this Artifact, a convenience to emulate Eamon Deluxe. More...
 
long Field4 [get, set]
 Gets or sets the primary Field4 of this Artifact, a convenience to emulate Eamon Deluxe. More...
 
long Field5 [get, set]
 Gets or sets the primary Field5 of this Artifact, a convenience to emulate Eamon Deluxe. More...
 
long Field6 [get, set]
 Gets or sets the primary Field6 of this Artifact, a convenience to emulate Eamon Deluxe. More...
 
long Field7 [get, set]
 Gets or sets the primary Field7 of this Artifact, a convenience to emulate Eamon Deluxe. More...
 
long Field8 [get, set]
 Gets or sets the primary Field8 of this Artifact, a convenience to emulate Eamon Deluxe. More...
 
long Field9 [get, set]
 Gets or sets the primary Field9 of this Artifact, a convenience to emulate Eamon Deluxe. More...
 
long Field10 [get, set]
 Gets or sets the primary Field10 of this Artifact, a convenience to emulate Eamon Deluxe. More...
 
long Field11 [get, set]
 Gets or sets the primary Field11 of this Artifact, a convenience to emulate Eamon Deluxe. More...
 
long Field12 [get, set]
 Gets or sets the primary Field12 of this Artifact, a convenience to emulate Eamon Deluxe. More...
 
long Field13 [get, set]
 Gets or sets the primary Field13 of this Artifact, a convenience to emulate Eamon Deluxe. More...
 
long Field14 [get, set]
 Gets or sets the primary Field14 of this Artifact, a convenience to emulate Eamon Deluxe. More...
 
long Field15 [get, set]
 Gets or sets the primary Field15 of this Artifact, a convenience to emulate Eamon Deluxe. More...
 
long Field16 [get, set]
 Gets or sets the primary Field16 of this Artifact, a convenience to emulate Eamon Deluxe. More...
 
long Field17 [get, set]
 Gets or sets the primary Field17 of this Artifact, a convenience to emulate Eamon Deluxe. More...
 
long Field18 [get, set]
 Gets or sets the primary Field18 of this Artifact, a convenience to emulate Eamon Deluxe. More...
 
long Field19 [get, set]
 Gets or sets the primary Field19 of this Artifact, a convenience to emulate Eamon Deluxe. More...
 
long Field20 [get, set]
 Gets or sets the primary Field20 of this Artifact, a convenience to emulate Eamon Deluxe. More...
 
IArtifactCategory Gold [get]
 Gets the ArtifactCategory for this Artifact corresponding to Gold; intended as a convenience. More...
 
IArtifactCategory Treasure [get]
 Gets the ArtifactCategory for this Artifact corresponding to Treasure; intended as a convenience. More...
 
IArtifactCategory Weapon [get]
 Gets the ArtifactCategory for this Artifact corresponding to Weapon; intended as a convenience. More...
 
IArtifactCategory MagicWeapon [get]
 Gets the ArtifactCategory for this Artifact corresponding to MagicWeapon; intended as a convenience. More...
 
IArtifactCategory GeneralWeapon [get]
 Gets the ArtifactCategory for this Artifact corresponding to either Weapon or MagicWeapon; intended as a convenience. More...
 
IArtifactCategory InContainer [get]
 Gets the ArtifactCategory for this Artifact corresponding to InContainer; intended as a convenience. More...
 
IArtifactCategory OnContainer [get]
 Gets the ArtifactCategory for this Artifact corresponding to OnContainer; intended as a convenience. More...
 
IArtifactCategory UnderContainer [get]
 Gets the ArtifactCategory for this Artifact corresponding to UnderContainer; intended as a convenience. More...
 
IArtifactCategory BehindContainer [get]
 Gets the ArtifactCategory for this Artifact corresponding to BehindContainer; intended as a convenience. More...
 
IArtifactCategory GeneralContainer [get]
 Gets the first found ArtifactCategory for this Artifact corresponding to any of InContainer, OnContainer, UnderContainer or BehindContainer; intended as a convenience. More...
 
IArtifactCategory LightSource [get]
 Gets the ArtifactCategory for this Artifact corresponding to LightSource; intended as a convenience. More...
 
IArtifactCategory Drinkable [get]
 Gets the ArtifactCategory for this Artifact corresponding to Drinkable; intended as a convenience. More...
 
IArtifactCategory Readable [get]
 Gets the ArtifactCategory for this Artifact corresponding to Readable; intended as a convenience. More...
 
IArtifactCategory DoorGate [get]
 Gets the ArtifactCategory for this Artifact corresponding to DoorGate; intended as a convenience. More...
 
IArtifactCategory Edible [get]
 Gets the ArtifactCategory for this Artifact corresponding to Edible; intended as a convenience. More...
 
IArtifactCategory BoundMonster [get]
 Gets the ArtifactCategory for this Artifact corresponding to BoundMonster; intended as a convenience. More...
 
IArtifactCategory Wearable [get]
 Gets the ArtifactCategory for this Artifact corresponding to Wearable; intended as a convenience. More...
 
IArtifactCategory DisguisedMonster [get]
 Gets the ArtifactCategory for this Artifact corresponding to DisguisedMonster; intended as a convenience. More...
 
IArtifactCategory DeadBody [get]
 Gets the ArtifactCategory for this Artifact corresponding to DeadBody; intended as a convenience. More...
 
IArtifactCategory User1 [get]
 Gets the ArtifactCategory for this Artifact corresponding to User1; intended as a convenience. More...
 
IArtifactCategory User2 [get]
 Gets the ArtifactCategory for this Artifact corresponding to User2; intended as a convenience. More...
 
IArtifactCategory User3 [get]
 Gets the ArtifactCategory for this Artifact corresponding to User3; intended as a convenience. More...
 
IArtifactCategory[] Categories [get, set]
 Gets or sets an array of ArtifactCategory objects that define this Artifact's behavior in the game. More...
 

Member Function Documentation

◆ BuildPrintedFullDesc()

override RetCode LandOfTheMountainKing.Game.Artifact.BuildPrintedFullDesc ( StringBuilder  buf,
bool  showName,
bool  showVerboseName 
)

Parameters
buf
showName
showVerboseName
Returns

Implements Eamon.Framework.IGameBase.

◆ ShouldExposeContentsToRoom()

override bool LandOfTheMountainKing.Game.Artifact.ShouldExposeContentsToRoom ( ContainerType  containerType = ContainerType.In)

Parameters
containerType
Returns

Implements Eamon.Framework.IArtifact.


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