Eamon CS  3.1.0
Public Member Functions | Properties | List of all members
Eamon.Framework.IArtifact Interface Reference

More...

Inheritance diagram for Eamon.Framework.IArtifact:
Eamon.Framework.IGameBase ARuncibleCargo.Game.Artifact Dharmaquest.Game.Artifact Eamon.Game.Artifact LandOfTheMountainKing.Game.Artifact StrongholdOfKahrDur.Game.Artifact TheDeepCanyon.Game.Artifact ThePyramidOfAnharos.Game.Artifact TheSubAquanLaboratory.Game.Artifact TheTempleOfNgurct.Game.Artifact TheVileGrimoireOfJaldial.Framework.IArtifact TheWayfarersInn.Framework.IArtifact WrenholdsSecretVigil.Framework.IArtifact

Public Member Functions

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

◆ AddStateDesc()

RetCode Eamon.Framework.IArtifact.AddStateDesc ( string  stateDesc,
bool  dupAllowed = false 
)

Parameters
stateDesc
dupAllowed
Returns

Implemented in Eamon.Game.Artifact.

◆ EvalEmbeddedInRoomLightLevel< T >()

T Eamon.Framework.IArtifact.EvalEmbeddedInRoomLightLevel< T > ( T  darkValue,
T  lightValue 
)

Parameters
darkValue
lightValue
Returns

Implemented in Eamon.Game.Artifact.

◆ EvalEmbeddedInRoomViewability< T >()

T Eamon.Framework.IArtifact.EvalEmbeddedInRoomViewability< T > ( T  nonviewableValue,
T  viewableValue 
)

Parameters
nonviewableValue
viewableValue
Returns

Implemented in Eamon.Game.Artifact.

◆ EvalInRoomLightLevel< T >()

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

Parameters
darkValue
lightValue
Returns

Implemented in Eamon.Game.Artifact.

◆ EvalInRoomViewability< T >()

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

Parameters
nonviewableValue
viewableValue
Returns

Implemented in Eamon.Game.Artifact.

◆ EvalPlural< T >()

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

Parameters
singularValue
pluralValue
Returns

Implemented in Eamon.Game.Artifact.

◆ GetArtifactCategory() [1/2]

IArtifactCategory Eamon.Framework.IArtifact.GetArtifactCategory ( ArtifactType  artifactType)

Parameters
artifactType
Returns

Implemented in Eamon.Game.Artifact.

◆ GetArtifactCategory() [2/2]

IArtifactCategory Eamon.Framework.IArtifact.GetArtifactCategory ( ArtifactType[]  artifactTypes,
bool  categoryArrayPrecedence = true 
)

Parameters
artifactTypes
categoryArrayPrecedence
Returns

Implemented in Eamon.Game.Artifact.

◆ GetArtifactCategoryList()

IList<IArtifactCategory> Eamon.Framework.IArtifact.GetArtifactCategoryList ( ArtifactType[]  artifactTypes)

Parameters
artifactTypes
Returns

Implemented in Eamon.Game.Artifact.

◆ GetBrokenDesc()

string Eamon.Framework.IArtifact.GetBrokenDesc ( )

Returns

Implemented in Eamon.Game.Artifact, and WrenholdsSecretVigil.Game.Artifact.

◆ GetCarriedByCharacter()

ICharacter Eamon.Framework.IArtifact.GetCarriedByCharacter ( )

Returns

Implemented in Eamon.Game.Artifact.

◆ GetCarriedByCharacterUid()

long Eamon.Framework.IArtifact.GetCarriedByCharacterUid ( )

Returns

Implemented in Eamon.Game.Artifact.

◆ GetCarriedByContainer()

IArtifact Eamon.Framework.IArtifact.GetCarriedByContainer ( bool  recurse = false)

Parameters
recurse
Returns

Implemented in Eamon.Game.Artifact.

◆ GetCarriedByContainerContainerType()

ContainerType Eamon.Framework.IArtifact.GetCarriedByContainerContainerType ( )

Returns

Implemented in Eamon.Game.Artifact.

◆ GetCarriedByContainerUid()

long Eamon.Framework.IArtifact.GetCarriedByContainerUid ( bool  recurse = false)

Parameters
recurse
Returns

Implemented in Eamon.Game.Artifact.

◆ GetCarriedByMonster()

IMonster Eamon.Framework.IArtifact.GetCarriedByMonster ( bool  recurse = false)

Parameters
recurse
Returns

Implemented in Eamon.Game.Artifact.

◆ GetCarriedByMonsterUid()

long Eamon.Framework.IArtifact.GetCarriedByMonsterUid ( bool  recurse = false)

Parameters
recurse
Returns

Implemented in Eamon.Game.Artifact.

◆ GetCategory()

IArtifactCategory Eamon.Framework.IArtifact.GetCategory ( long  index)

Parameters
index
Returns

Implemented in Eamon.Game.Artifact.

◆ GetContainedList()

IList<IArtifact> Eamon.Framework.IArtifact.GetContainedList ( Func< IArtifact, bool >  artifactFindFunc = null,
ContainerType  containerType = ContainerType.In,
bool  recurse = false 
)

Parameters
artifactFindFunc
containerType
recurse
Returns

Implemented in Eamon.Game.Artifact.

◆ GetContainedList01()

void Eamon.Framework.IArtifact.GetContainedList01 ( IList< IArtifact >  artifactList,
Func< IArtifact, bool >  artifactFindFunc = null,
ContainerType  containerType = ContainerType.In,
bool  recurse = false 
)

Parameters
artifactList
artifactFindFunc
containerType
recurse

Implemented in Eamon.Game.Artifact.

◆ GetContainerContentsDesc()

string Eamon.Framework.IArtifact.GetContainerContentsDesc ( IRecordNameListArgs  recordNameListArgs = null)

Parameters
recordNameListArgs
Returns

Implemented in Eamon.Game.Artifact.

◆ GetContainerInfo()

RetCode Eamon.Framework.IArtifact.GetContainerInfo ( ref long  count,
ref long  weight,
ContainerType  containerType = ContainerType.In,
bool  recurse = false 
)

Parameters
count
weight
containerType
recurse
Returns

Implemented in Eamon.Game.Artifact.

◆ GetContainerSomeStuffDesc()

string Eamon.Framework.IArtifact.GetContainerSomeStuffDesc ( )

Returns

Implemented in Eamon.Game.Artifact.

◆ GetContainerSomethingDesc()

string Eamon.Framework.IArtifact.GetContainerSomethingDesc ( )

Returns

Implemented in Eamon.Game.Artifact, and TheWayfarersInn.Game.Artifact.

◆ GetDoorGateFleeDesc()

string Eamon.Framework.IArtifact.GetDoorGateFleeDesc ( )

Returns

Implemented in Eamon.Game.Artifact.

◆ GetEmbeddedInRoom()

IRoom Eamon.Framework.IArtifact.GetEmbeddedInRoom ( bool  recurse = false)

Parameters
recurse
Returns

Implemented in Eamon.Game.Artifact.

◆ GetEmbeddedInRoomUid()

long Eamon.Framework.IArtifact.GetEmbeddedInRoomUid ( bool  recurse = false)

Parameters
recurse
Returns

Implemented in Eamon.Game.Artifact.

◆ GetEmptyDesc()

string Eamon.Framework.IArtifact.GetEmptyDesc ( )

Returns

Implemented in Eamon.Game.Artifact.

◆ GetFieldStrength()

long Eamon.Framework.IArtifact.GetFieldStrength ( long  value)

Parameters
value
Returns

Implemented in Eamon.Game.Artifact.

◆ GetInRoom()

IRoom Eamon.Framework.IArtifact.GetInRoom ( bool  recurse = false)

Parameters
recurse
Returns

Implemented in Eamon.Game.Artifact.

◆ GetInRoomUid()

long Eamon.Framework.IArtifact.GetInRoomUid ( bool  recurse = false)

Parameters
recurse
Returns

Implemented in Eamon.Game.Artifact.

◆ GetMaxContentsNameListCount()

long Eamon.Framework.IArtifact.GetMaxContentsNameListCount ( ContainerType  containerType = ContainerType.In)

Parameters
containerType
Returns

Implemented in Eamon.Game.Artifact.

◆ GetProvidingLightDesc()

string Eamon.Framework.IArtifact.GetProvidingLightDesc ( )

Returns

Implemented in Eamon.Game.Artifact.

◆ GetReadyWeaponDesc()

string Eamon.Framework.IArtifact.GetReadyWeaponDesc ( )

Returns

Implemented in Eamon.Game.Artifact.

◆ GetSynonym()

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

Parameters
index
Returns

Implemented in Eamon.Game.Artifact.

◆ GetWornByCharacter()

ICharacter Eamon.Framework.IArtifact.GetWornByCharacter ( )

Returns

Implemented in Eamon.Game.Artifact.

◆ GetWornByCharacterUid()

long Eamon.Framework.IArtifact.GetWornByCharacterUid ( )

Returns

Implemented in Eamon.Game.Artifact.

◆ GetWornByMonster()

IMonster Eamon.Framework.IArtifact.GetWornByMonster ( bool  recurse = false)

Parameters
recurse
Returns

Implemented in Eamon.Game.Artifact.

◆ GetWornByMonsterUid()

long Eamon.Framework.IArtifact.GetWornByMonsterUid ( bool  recurse = false)

Parameters
recurse
Returns

Implemented in Eamon.Game.Artifact.

◆ HasMoved()

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

Parameters
oldLocation
newLocation
Returns

Implemented in Eamon.Game.Artifact, and TheWayfarersInn.Game.Artifact.

◆ IsArmor()

bool Eamon.Framework.IArtifact.IsArmor ( )

Returns

Implemented in Eamon.Game.Artifact.

◆ IsAttackable()

bool Eamon.Framework.IArtifact.IsAttackable ( ref IArtifactCategory  ac)

Parameters
ac
Returns

Implemented in Eamon.Game.Artifact, TheWayfarersInn.Game.Artifact, TheVileGrimoireOfJaldial.Game.Artifact, WrenholdsSecretVigil.Game.Artifact, TheTempleOfNgurct.Game.Artifact, TheSubAquanLaboratory.Game.Artifact, and TheDeepCanyon.Game.Artifact.

◆ IsCarriedByCharacter() [1/2]

bool Eamon.Framework.IArtifact.IsCarriedByCharacter ( )

Returns

Implemented in Eamon.Game.Artifact.

◆ IsCarriedByCharacter() [2/2]

bool Eamon.Framework.IArtifact.IsCarriedByCharacter ( ICharacter  character)

Parameters
character
Returns

Implemented in Eamon.Game.Artifact.

◆ IsCarriedByCharacterUid()

bool Eamon.Framework.IArtifact.IsCarriedByCharacterUid ( long  characterUid)

Parameters
characterUid
Returns

Implemented in Eamon.Game.Artifact.

◆ IsCarriedByContainer() [1/2]

bool Eamon.Framework.IArtifact.IsCarriedByContainer ( )

Returns

Implemented in Eamon.Game.Artifact.

◆ IsCarriedByContainer() [2/2]

bool Eamon.Framework.IArtifact.IsCarriedByContainer ( IArtifact  container,
bool  recurse = false 
)

Parameters
container
recurse
Returns

Implemented in Eamon.Game.Artifact.

◆ IsCarriedByContainerContainerTypeExposedToMonster() [1/2]

bool Eamon.Framework.IArtifact.IsCarriedByContainerContainerTypeExposedToMonster ( IMonster  monster,
bool  recurse = false 
)

Parameters
monster
recurse
Returns

Implemented in Eamon.Game.Artifact.

◆ IsCarriedByContainerContainerTypeExposedToMonster() [2/2]

bool Eamon.Framework.IArtifact.IsCarriedByContainerContainerTypeExposedToMonster ( MonsterType  monsterType = MonsterType.NonCharMonster,
bool  recurse = false 
)

Parameters
monsterType
recurse
Returns

Implemented in Eamon.Game.Artifact.

◆ IsCarriedByContainerContainerTypeExposedToMonsterUid()

bool Eamon.Framework.IArtifact.IsCarriedByContainerContainerTypeExposedToMonsterUid ( long  monsterUid,
bool  recurse = false 
)

Parameters
monsterUid
recurse
Returns

Implemented in Eamon.Game.Artifact.

◆ IsCarriedByContainerContainerTypeExposedToRoom() [1/2]

bool Eamon.Framework.IArtifact.IsCarriedByContainerContainerTypeExposedToRoom ( bool  recurse = false)

Parameters
recurse
Returns

Implemented in Eamon.Game.Artifact.

◆ IsCarriedByContainerContainerTypeExposedToRoom() [2/2]

bool Eamon.Framework.IArtifact.IsCarriedByContainerContainerTypeExposedToRoom ( IRoom  room,
bool  recurse = false 
)

Parameters
room
recurse
Returns

Implemented in Eamon.Game.Artifact.

◆ IsCarriedByContainerContainerTypeExposedToRoomUid()

bool Eamon.Framework.IArtifact.IsCarriedByContainerContainerTypeExposedToRoomUid ( long  roomUid,
bool  recurse = false 
)

Parameters
roomUid
recurse
Returns

Implemented in Eamon.Game.Artifact.

◆ IsCarriedByContainerUid()

bool Eamon.Framework.IArtifact.IsCarriedByContainerUid ( long  containerUid,
bool  recurse = false 
)

Parameters
containerUid
recurse
Returns

Implemented in Eamon.Game.Artifact.

◆ IsCarriedByMonster() [1/2]

bool Eamon.Framework.IArtifact.IsCarriedByMonster ( IMonster  monster,
bool  recurse = false 
)

Parameters
monster
recurse
Returns

Implemented in Eamon.Game.Artifact.

◆ IsCarriedByMonster() [2/2]

bool Eamon.Framework.IArtifact.IsCarriedByMonster ( MonsterType  monsterType = MonsterType.NonCharMonster,
bool  recurse = false 
)

Parameters
monsterType
recurse
Returns

Implemented in Eamon.Game.Artifact.

◆ IsCarriedByMonsterUid()

bool Eamon.Framework.IArtifact.IsCarriedByMonsterUid ( long  monsterUid,
bool  recurse = false 
)

Parameters
monsterUid
recurse
Returns

Implemented in Eamon.Game.Artifact.

◆ IsDisguisedMonster()

bool Eamon.Framework.IArtifact.IsDisguisedMonster ( )

Returns

Implemented in Eamon.Game.Artifact, and ARuncibleCargo.Game.Artifact.

◆ IsDoorGateInObviousExitsList()

bool Eamon.Framework.IArtifact.IsDoorGateInObviousExitsList ( )

Returns

Implemented in Eamon.Game.Artifact.

◆ IsEmbeddedInRoom() [1/2]

bool Eamon.Framework.IArtifact.IsEmbeddedInRoom ( bool  recurse = false)

Parameters
recurse
Returns

Implemented in Eamon.Game.Artifact.

◆ IsEmbeddedInRoom() [2/2]

bool Eamon.Framework.IArtifact.IsEmbeddedInRoom ( IRoom  room,
bool  recurse = false 
)

Parameters
room
recurse
Returns

Implemented in Eamon.Game.Artifact.

◆ IsEmbeddedInRoomLit()

bool Eamon.Framework.IArtifact.IsEmbeddedInRoomLit ( )

Returns

Implemented in Eamon.Game.Artifact.

◆ IsEmbeddedInRoomUid()

bool Eamon.Framework.IArtifact.IsEmbeddedInRoomUid ( long  roomUid,
bool  recurse = false 
)

Parameters
roomUid
recurse
Returns

Implemented in Eamon.Game.Artifact.

◆ IsEmbeddedInRoomViewable()

bool Eamon.Framework.IArtifact.IsEmbeddedInRoomViewable ( )

Returns

Implemented in Eamon.Game.Artifact.

◆ IsFieldStrength()

bool Eamon.Framework.IArtifact.IsFieldStrength ( long  value)

Parameters
value
Returns

Implemented in Eamon.Game.Artifact.

◆ IsInContainerOpenedFromTop()

bool Eamon.Framework.IArtifact.IsInContainerOpenedFromTop ( )

Returns

Implemented in Eamon.Game.Artifact, and TheWayfarersInn.Game.Artifact.

◆ IsInLimbo()

bool Eamon.Framework.IArtifact.IsInLimbo ( bool  recurse = false)

Parameters
recurse
Returns

Implemented in Eamon.Game.Artifact.

◆ IsInRoom() [1/2]

bool Eamon.Framework.IArtifact.IsInRoom ( bool  recurse = false)

Parameters
recurse
Returns

Implemented in Eamon.Game.Artifact.

◆ IsInRoom() [2/2]

bool Eamon.Framework.IArtifact.IsInRoom ( IRoom  room,
bool  recurse = false 
)

Parameters
room
recurse
Returns

Implemented in Eamon.Game.Artifact.

◆ IsInRoomLit()

bool Eamon.Framework.IArtifact.IsInRoomLit ( )

Returns

Implemented in Eamon.Game.Artifact.

◆ IsInRoomUid()

bool Eamon.Framework.IArtifact.IsInRoomUid ( long  roomUid,
bool  recurse = false 
)

Parameters
roomUid
recurse
Returns

Implemented in Eamon.Game.Artifact.

◆ IsInRoomViewable()

bool Eamon.Framework.IArtifact.IsInRoomViewable ( )

Returns

Implemented in Eamon.Game.Artifact.

◆ IsReadyableByMonster()

bool Eamon.Framework.IArtifact.IsReadyableByMonster ( IMonster  monster)

Parameters
monster
Returns

Implemented in Eamon.Game.Artifact.

◆ IsReadyableByMonsterUid()

bool Eamon.Framework.IArtifact.IsReadyableByMonsterUid ( long  monsterUid)

Parameters
monsterUid
Returns

Implemented in Eamon.Game.Artifact, WrenholdsSecretVigil.Game.Artifact, and TheTempleOfNgurct.Game.Artifact.

◆ IsRequestable()

bool Eamon.Framework.IArtifact.IsRequestable ( )

Returns

Implemented in Eamon.Game.Artifact, and TheWayfarersInn.Game.Artifact.

◆ IsShield()

bool Eamon.Framework.IArtifact.IsShield ( )

Returns

Implemented in Eamon.Game.Artifact.

◆ IsStateDescSideNotes()

bool Eamon.Framework.IArtifact.IsStateDescSideNotes ( )

Returns

Implemented in Eamon.Game.Artifact.

◆ IsUnmovable()

bool Eamon.Framework.IArtifact.IsUnmovable ( )

Returns

Implemented in Eamon.Game.Artifact.

◆ IsUnmovable01()

bool Eamon.Framework.IArtifact.IsUnmovable01 ( )

Returns

Implemented in Eamon.Game.Artifact.

◆ IsWeapon()

bool Eamon.Framework.IArtifact.IsWeapon ( Weapon  weapon)

Parameters
weapon
Returns

Implemented in Eamon.Game.Artifact.

◆ IsWornByCharacter() [1/2]

bool Eamon.Framework.IArtifact.IsWornByCharacter ( )

Returns

Implemented in Eamon.Game.Artifact.

◆ IsWornByCharacter() [2/2]

bool Eamon.Framework.IArtifact.IsWornByCharacter ( ICharacter  character)

Parameters
character
Returns

Implemented in Eamon.Game.Artifact.

◆ IsWornByCharacterUid()

bool Eamon.Framework.IArtifact.IsWornByCharacterUid ( long  characterUid)

Parameters
characterUid
Returns

Implemented in Eamon.Game.Artifact.

◆ IsWornByMonster() [1/2]

bool Eamon.Framework.IArtifact.IsWornByMonster ( IMonster  monster,
bool  recurse = false 
)

Parameters
monster
recurse
Returns

Implemented in Eamon.Game.Artifact.

◆ IsWornByMonster() [2/2]

bool Eamon.Framework.IArtifact.IsWornByMonster ( MonsterType  monsterType = MonsterType.NonCharMonster,
bool  recurse = false 
)

Parameters
monsterType
recurse
Returns

Implemented in Eamon.Game.Artifact.

◆ IsWornByMonsterUid()

bool Eamon.Framework.IArtifact.IsWornByMonsterUid ( long  monsterUid,
bool  recurse = false 
)

Parameters
monsterUid
recurse
Returns

Implemented in Eamon.Game.Artifact.

◆ RemoveStateDesc()

RetCode Eamon.Framework.IArtifact.RemoveStateDesc ( string  stateDesc)

Parameters
stateDesc
Returns

Implemented in Eamon.Game.Artifact.

◆ SetArtifactCategoryCount()

RetCode Eamon.Framework.IArtifact.SetArtifactCategoryCount ( long  count)

Parameters
count
Returns

Implemented in Eamon.Game.Artifact.

◆ SetCarriedByCharacter()

void Eamon.Framework.IArtifact.SetCarriedByCharacter ( ICharacter  character)

Parameters
character

Implemented in Eamon.Game.Artifact.

◆ SetCarriedByCharacterUid()

void Eamon.Framework.IArtifact.SetCarriedByCharacterUid ( long  characterUid)

Parameters
characterUid

Implemented in Eamon.Game.Artifact.

◆ SetCarriedByContainer()

void Eamon.Framework.IArtifact.SetCarriedByContainer ( IArtifact  container,
ContainerType  containerType = ContainerType.In 
)

Parameters
container
containerType

Implemented in Eamon.Game.Artifact.

◆ SetCarriedByContainerUid()

void Eamon.Framework.IArtifact.SetCarriedByContainerUid ( long  containerUid,
ContainerType  containerType = ContainerType.In 
)

Parameters
containerUid
containerType

Implemented in Eamon.Game.Artifact.

◆ SetCarriedByMonster()

void Eamon.Framework.IArtifact.SetCarriedByMonster ( IMonster  monster)

Parameters
monster

Implemented in Eamon.Game.Artifact.

◆ SetCarriedByMonsterUid()

void Eamon.Framework.IArtifact.SetCarriedByMonsterUid ( long  monsterUid)

Parameters
monsterUid

Implemented in Eamon.Game.Artifact.

◆ SetCategory()

void Eamon.Framework.IArtifact.SetCategory ( long  index,
IArtifactCategory  value 
)

Parameters
index
value

Implemented in Eamon.Game.Artifact.

◆ SetEmbeddedInRoom()

void Eamon.Framework.IArtifact.SetEmbeddedInRoom ( IRoom  room)

Parameters
room

Implemented in Eamon.Game.Artifact.

◆ SetEmbeddedInRoomUid()

void Eamon.Framework.IArtifact.SetEmbeddedInRoomUid ( long  roomUid)

Parameters
roomUid

Implemented in Eamon.Game.Artifact.

◆ SetInLimbo()

void Eamon.Framework.IArtifact.SetInLimbo ( )

Implemented in Eamon.Game.Artifact.

◆ SetInRoom()

void Eamon.Framework.IArtifact.SetInRoom ( IRoom  room)

Parameters
room

Implemented in Eamon.Game.Artifact.

◆ SetInRoomUid()

void Eamon.Framework.IArtifact.SetInRoomUid ( long  roomUid)

Parameters
roomUid

Implemented in Eamon.Game.Artifact.

◆ SetSynonym()

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

Parameters
index
value

Implemented in Eamon.Game.Artifact.

◆ SetWornByCharacter()

void Eamon.Framework.IArtifact.SetWornByCharacter ( ICharacter  character)

Parameters
character

Implemented in Eamon.Game.Artifact.

◆ SetWornByCharacterUid()

void Eamon.Framework.IArtifact.SetWornByCharacterUid ( long  characterUid)

Parameters
characterUid

Implemented in Eamon.Game.Artifact.

◆ SetWornByMonster()

void Eamon.Framework.IArtifact.SetWornByMonster ( IMonster  monster)

Parameters
monster

Implemented in Eamon.Game.Artifact.

◆ SetWornByMonsterUid()

void Eamon.Framework.IArtifact.SetWornByMonsterUid ( long  monsterUid)

Parameters
monsterUid

Implemented in Eamon.Game.Artifact.

◆ ShouldAddContents()

bool Eamon.Framework.IArtifact.ShouldAddContents ( IArtifact  artifact,
ContainerType  containerType = ContainerType.In 
)

Parameters
artifact
containerType
Returns

Implemented in Eamon.Game.Artifact, and TheWayfarersInn.Game.Artifact.

◆ ShouldAddContentsWhenCarried()

bool Eamon.Framework.IArtifact.ShouldAddContentsWhenCarried ( ContainerType  containerType = ContainerType.In)

Parameters
containerType
Returns

Implemented in Eamon.Game.Artifact.

◆ ShouldAddContentsWhenWorn()

bool Eamon.Framework.IArtifact.ShouldAddContentsWhenWorn ( ContainerType  containerType = ContainerType.In)

Parameters
containerType
Returns

Implemented in Eamon.Game.Artifact.

◆ ShouldAllowBlastSkillGains()

bool Eamon.Framework.IArtifact.ShouldAllowBlastSkillGains ( )

Returns

Implemented in Eamon.Game.Artifact, WrenholdsSecretVigil.Game.Artifact, TheTempleOfNgurct.Game.Artifact, TheSubAquanLaboratory.Game.Artifact, and StrongholdOfKahrDur.Game.Artifact.

◆ ShouldExposeContentsToMonster()

bool Eamon.Framework.IArtifact.ShouldExposeContentsToMonster ( MonsterType  monsterType = MonsterType.NonCharMonster,
ContainerType  containerType = ContainerType.In 
)

Parameters
monsterType
containerType
Returns

Implemented in Eamon.Game.Artifact, and TheWayfarersInn.Game.Artifact.

◆ ShouldExposeContentsToRoom()

bool Eamon.Framework.IArtifact.ShouldExposeContentsToRoom ( ContainerType  containerType = ContainerType.In)

Parameters
containerType
Returns

Implemented in Eamon.Game.Artifact, TheWayfarersInn.Game.Artifact, LandOfTheMountainKing.Game.Artifact, and ARuncibleCargo.Game.Artifact.

◆ ShouldExposeInContentsWhenClosed()

bool Eamon.Framework.IArtifact.ShouldExposeInContentsWhenClosed ( )

Returns

Implemented in Eamon.Game.Artifact.

◆ ShouldRevealContentsWhenMoved()

bool Eamon.Framework.IArtifact.ShouldRevealContentsWhenMoved ( ContainerType  containerType = ContainerType.In)

Returns

Implemented in Eamon.Game.Artifact.

◆ ShouldRevealContentsWhenMovedIntoLimbo()

bool Eamon.Framework.IArtifact.ShouldRevealContentsWhenMovedIntoLimbo ( ContainerType  containerType = ContainerType.In)

Returns

Implemented in Eamon.Game.Artifact, and TheWayfarersInn.Game.Artifact.

◆ ShouldShowContentsWhenExamined()

bool Eamon.Framework.IArtifact.ShouldShowContentsWhenExamined ( )

Returns

Implemented in Eamon.Game.Artifact.

◆ ShouldShowContentsWhenOpened()

bool Eamon.Framework.IArtifact.ShouldShowContentsWhenOpened ( )

Returns

Implemented in Eamon.Game.Artifact, and ARuncibleCargo.Game.Artifact.

◆ ShouldShowVerboseNameContentsNameList()

bool Eamon.Framework.IArtifact.ShouldShowVerboseNameContentsNameList ( )

Returns

Implemented in Eamon.Game.Artifact.

◆ ShouldShowVerboseNameStateDesc()

bool Eamon.Framework.IArtifact.ShouldShowVerboseNameStateDesc ( )

Returns

Implemented in Eamon.Game.Artifact.

◆ SyncArtifactCategories()

void Eamon.Framework.IArtifact.SyncArtifactCategories ( IArtifactCategory  modifiedAc)

Parameters
modifiedAc

Implemented in Eamon.Game.Artifact.

Property Documentation

◆ BehindContainer

IArtifactCategory Eamon.Framework.IArtifact.BehindContainer
get

Gets the ArtifactCategory for this Artifact corresponding to BehindContainer; intended as a convenience.

◆ BoundMonster

IArtifactCategory Eamon.Framework.IArtifact.BoundMonster
get

Gets the ArtifactCategory for this Artifact corresponding to BoundMonster; intended as a convenience.

◆ Categories

IArtifactCategory [] Eamon.Framework.IArtifact.Categories
getset

Gets or sets an array of ArtifactCategory objects that define this Artifact's behavior in the game.

◆ DeadBody

IArtifactCategory Eamon.Framework.IArtifact.DeadBody
get

Gets the ArtifactCategory for this Artifact corresponding to DeadBody; intended as a convenience.

◆ DisguisedMonster

IArtifactCategory Eamon.Framework.IArtifact.DisguisedMonster
get

Gets the ArtifactCategory for this Artifact corresponding to DisguisedMonster; intended as a convenience.

◆ DoorGate

IArtifactCategory Eamon.Framework.IArtifact.DoorGate
get

Gets the ArtifactCategory for this Artifact corresponding to DoorGate; intended as a convenience.

◆ Drinkable

IArtifactCategory Eamon.Framework.IArtifact.Drinkable
get

Gets the ArtifactCategory for this Artifact corresponding to Drinkable; intended as a convenience.

◆ Edible

IArtifactCategory Eamon.Framework.IArtifact.Edible
get

Gets the ArtifactCategory for this Artifact corresponding to Edible; intended as a convenience.

◆ Field1

long Eamon.Framework.IArtifact.Field1
getset

Gets or sets the primary Field1 of this Artifact, a convenience to emulate Eamon Deluxe.

◆ Field10

long Eamon.Framework.IArtifact.Field10
getset

Gets or sets the primary Field10 of this Artifact, a convenience to emulate Eamon Deluxe.

◆ Field11

long Eamon.Framework.IArtifact.Field11
getset

Gets or sets the primary Field11 of this Artifact, a convenience to emulate Eamon Deluxe.

◆ Field12

long Eamon.Framework.IArtifact.Field12
getset

Gets or sets the primary Field12 of this Artifact, a convenience to emulate Eamon Deluxe.

◆ Field13

long Eamon.Framework.IArtifact.Field13
getset

Gets or sets the primary Field13 of this Artifact, a convenience to emulate Eamon Deluxe.

◆ Field14

long Eamon.Framework.IArtifact.Field14
getset

Gets or sets the primary Field14 of this Artifact, a convenience to emulate Eamon Deluxe.

◆ Field15

long Eamon.Framework.IArtifact.Field15
getset

Gets or sets the primary Field15 of this Artifact, a convenience to emulate Eamon Deluxe.

◆ Field16

long Eamon.Framework.IArtifact.Field16
getset

Gets or sets the primary Field16 of this Artifact, a convenience to emulate Eamon Deluxe.

◆ Field17

long Eamon.Framework.IArtifact.Field17
getset

Gets or sets the primary Field17 of this Artifact, a convenience to emulate Eamon Deluxe.

◆ Field18

long Eamon.Framework.IArtifact.Field18
getset

Gets or sets the primary Field18 of this Artifact, a convenience to emulate Eamon Deluxe.

◆ Field19

long Eamon.Framework.IArtifact.Field19
getset

Gets or sets the primary Field19 of this Artifact, a convenience to emulate Eamon Deluxe.

◆ Field2

long Eamon.Framework.IArtifact.Field2
getset

Gets or sets the primary Field2 of this Artifact, a convenience to emulate Eamon Deluxe.

◆ Field20

long Eamon.Framework.IArtifact.Field20
getset

Gets or sets the primary Field20 of this Artifact, a convenience to emulate Eamon Deluxe.

◆ Field3

long Eamon.Framework.IArtifact.Field3
getset

Gets or sets the primary Field3 of this Artifact, a convenience to emulate Eamon Deluxe.

◆ Field4

long Eamon.Framework.IArtifact.Field4
getset

Gets or sets the primary Field4 of this Artifact, a convenience to emulate Eamon Deluxe.

◆ Field5

long Eamon.Framework.IArtifact.Field5
getset

Gets or sets the primary Field5 of this Artifact, a convenience to emulate Eamon Deluxe.

◆ Field6

long Eamon.Framework.IArtifact.Field6
getset

Gets or sets the primary Field6 of this Artifact, a convenience to emulate Eamon Deluxe.

◆ Field7

long Eamon.Framework.IArtifact.Field7
getset

Gets or sets the primary Field7 of this Artifact, a convenience to emulate Eamon Deluxe.

◆ Field8

long Eamon.Framework.IArtifact.Field8
getset

Gets or sets the primary Field8 of this Artifact, a convenience to emulate Eamon Deluxe.

◆ Field9

long Eamon.Framework.IArtifact.Field9
getset

Gets or sets the primary Field9 of this Artifact, a convenience to emulate Eamon Deluxe.

◆ GeneralContainer

IArtifactCategory Eamon.Framework.IArtifact.GeneralContainer
get

Gets the first found ArtifactCategory for this Artifact corresponding to any of InContainer, OnContainer, UnderContainer or BehindContainer; intended as a convenience.

◆ GeneralWeapon

IArtifactCategory Eamon.Framework.IArtifact.GeneralWeapon
get

Gets the ArtifactCategory for this Artifact corresponding to either Weapon or MagicWeapon; intended as a convenience.

◆ Gold

IArtifactCategory Eamon.Framework.IArtifact.Gold
get

Gets the ArtifactCategory for this Artifact corresponding to Gold; intended as a convenience.

◆ InContainer

IArtifactCategory Eamon.Framework.IArtifact.InContainer
get

Gets the ArtifactCategory for this Artifact corresponding to InContainer; intended as a convenience.

◆ IsCharOwned

bool Eamon.Framework.IArtifact.IsCharOwned
getset

Gets or sets a value indicating whether this Artifact is owned by the player character.

◆ IsListed

bool Eamon.Framework.IArtifact.IsListed
getset

Gets or sets a value indicating whether this Artifact should be displayed in various lists.

◆ IsPlural

bool Eamon.Framework.IArtifact.IsPlural
getset

Gets or sets a value indicating whether this Artifact represents a group of objects.

◆ LightSource

IArtifactCategory Eamon.Framework.IArtifact.LightSource
get

Gets the ArtifactCategory for this Artifact corresponding to LightSource; intended as a convenience.

◆ Location

long Eamon.Framework.IArtifact.Location
getset

Gets or sets the location of this Artifact in the game (typically a Room Uid or a special code).

◆ MagicWeapon

IArtifactCategory Eamon.Framework.IArtifact.MagicWeapon
get

Gets the ArtifactCategory for this Artifact corresponding to MagicWeapon; intended as a convenience.

◆ OnContainer

IArtifactCategory Eamon.Framework.IArtifact.OnContainer
get

Gets the ArtifactCategory for this Artifact corresponding to OnContainer; intended as a convenience.

◆ PluralType

PluralType Eamon.Framework.IArtifact.PluralType
getset

Gets or sets a value indicating how this Artifact's singular Name is modified to produce its plural Name.

◆ Readable

IArtifactCategory Eamon.Framework.IArtifact.Readable
get

Gets the ArtifactCategory for this Artifact corresponding to Readable; intended as a convenience.

◆ RecursiveWeight

long Eamon.Framework.IArtifact.RecursiveWeight
get

Gets the recursive weight of this Artifact in Gronds.

◆ StateDesc

string Eamon.Framework.IArtifact.StateDesc
getset

Gets or sets a description shown after this Artifact's Name in various lists that indicates its state.

◆ Treasure

IArtifactCategory Eamon.Framework.IArtifact.Treasure
get

Gets the ArtifactCategory for this Artifact corresponding to Treasure; intended as a convenience.

◆ Type

ArtifactType Eamon.Framework.IArtifact.Type
getset

Gets or sets the primary Type of this Artifact, a convenience to emulate Eamon Deluxe.

◆ UnderContainer

IArtifactCategory Eamon.Framework.IArtifact.UnderContainer
get

Gets the ArtifactCategory for this Artifact corresponding to UnderContainer; intended as a convenience.

◆ User1

IArtifactCategory Eamon.Framework.IArtifact.User1
get

Gets the ArtifactCategory for this Artifact corresponding to User1; intended as a convenience.

◆ User2

IArtifactCategory Eamon.Framework.IArtifact.User2
get

Gets the ArtifactCategory for this Artifact corresponding to User2; intended as a convenience.

◆ User3

IArtifactCategory Eamon.Framework.IArtifact.User3
get

Gets the ArtifactCategory for this Artifact corresponding to User3; intended as a convenience.

◆ Value

long Eamon.Framework.IArtifact.Value
getset

Gets or sets the base value of this Artifact in gold pieces.

◆ Weapon

IArtifactCategory Eamon.Framework.IArtifact.Weapon
get

Gets the ArtifactCategory for this Artifact corresponding to Weapon; intended as a convenience.

◆ Wearable

IArtifactCategory Eamon.Framework.IArtifact.Wearable
get

Gets the ArtifactCategory for this Artifact corresponding to Wearable; intended as a convenience.

◆ Weight

long Eamon.Framework.IArtifact.Weight
getset

Gets or sets the weight of this Artifact in Gronds.

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