WrenholdsSecretVigil.Framework.IArtifact Interface Reference

More...

Inheritance diagram for WrenholdsSecretVigil.Framework.IArtifact:

Public Member Functions
bool	IsBuriedInRoomUid (long roomUid)
	Indicates whether this Artifact is buried in a given Room. More...
bool	IsBuriedInRoom (Eamon.Framework.IRoom room)
	Indicates whether this Artifact is buried in a given Room. More...
Public Member Functions inherited from Eamon.Framework.IArtifact
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)

Additional Inherited Members
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...
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

IsBuriedInRoom()

bool WrenholdsSecretVigil.Framework.IArtifact.IsBuriedInRoom

(

Eamon.Framework.IRoom

room

)

Indicates whether this Artifact is buried in a given Room.

Parameters

room	The Room to check.

Returns

If so then true, otherwise false.

IsBuriedInRoomUid()

bool WrenholdsSecretVigil.Framework.IArtifact.IsBuriedInRoomUid

(

long

roomUid

)

Indicates whether this Artifact is buried in a given Room.

Parameters

roomUid

The Uid of the Room to check.

Returns

If so then true, otherwise false.

Implemented in WrenholdsSecretVigil.Game.Artifact.

---

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

• C:/Eamon-CS/Adventures/WrenholdsSecretVigil/Framework/IArtifact.cs