Eamon.Framework.IHint Interface Reference

More...

Inheritance diagram for Eamon.Framework.IHint:

Public Member Functions
string	GetAnswer (long index)
void	SetAnswer (long index, string value)
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
bool	Active [get, set]
	Gets or sets whether this Hint is available to the player. More...
string	Question [get, set]
	Gets or sets the Question answered or topic addressed by this Hint. More...
long	NumAnswers [get, set]
	Gets or sets the number of Answers for the Hint's Question. More...
string[]	Answers [get, set]
	Gets or sets an array of Hint Answers. 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

GetAnswer()

string Eamon.Framework.IHint.GetAnswer

(

long

index

)

Parameters

index

Returns

Implemented in Eamon.Game.Hint.

SetAnswer()

void Eamon.Framework.IHint.SetAnswer	(	long	index,
		string	value
	)

Parameters

index
value

Implemented in Eamon.Game.Hint.

Property Documentation

Active

bool Eamon.Framework.IHint.Active

getset

Gets or sets whether this Hint is available to the player.

Hints can be active at all times or, if necessary, deactivated initially and later activated (or vice versa) when certain arbitrary conditions are met.

Answers

string [] Eamon.Framework.IHint.Answers

getset

Gets or sets an array of Hint Answers.

The array always contains the same number of elements. The first NumAnswers elements contain increasingly explicit Answers to the Question, while the remaining unused elements are set to an empty string. Avoid accessing array elements directly in favor of using Getter/Setter methods to ensure games can override when necessary.

See also

GetAnswer(long), SetAnswer(long, string)

NumAnswers

long Eamon.Framework.IHint.NumAnswers

getset

Gets or sets the number of Answers for the Hint's Question.

Question

string Eamon.Framework.IHint.Question

getset

Gets or sets the Question answered or topic addressed by this Hint.

---

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

• C:/Eamon-CS/System/Eamon/Framework/IHint.cs