WordGameResult Struct Reference

Represents a result from a word game lookup operation (WordChecker methods). More...

Collaboration diagram for WordGameResult:

Properties
IList< string >	allWords [get]
	All words returned from the lookup operation. More...
static WordGameResult	empty [get]
	Represents an empty WordGameResult. More...
bool	hasValue [get]
	Whether or not the result is empty. More...
string	input [get]
	The input string for the lookup operation. More...
bool	isValid [get]
	Whether or not the result is valid (at least one word was found). More...
IList< ILetterTile >	letterTiles [get]
	A list of the input letter tiles for the lookup operation. More...
int	score [get]
	Gets the score total of the result. More...
bool	wasOrdered [get]
	Whether or not the word lookup was an ordered search. More...
string	word [get]
	The first word found in the lookup operation. Included for convenience. More...

Detailed Description

Represents a result from a word game lookup operation (WordChecker methods).

Note that this type is passed by value for performance reasons.

Property Documentation

IList<string> allWords

get

All words returned from the lookup operation.

WordGameResult empty

staticget

Represents an empty WordGameResult.

This is only created as a result of an invalid word lookup operation. Assigning a WordGameResult to this value is useful to invalidate previous results.

bool hasValue

get

Whether or not the result is empty.

This only returns false as a result of an invalid word lookup operation.

string input

get

The input string for the lookup operation.

If the input is truncated, this still ruturns the full input string.

bool isValid

get

Whether or not the result is valid (at least one word was found).

IList<ILetterTile> letterTiles

get

A list of the input letter tiles for the lookup operation.

If the input is truncated, this still returns all input letter tiles.

int score

get

Gets the score total of the result.

bool wasOrdered

get

Whether or not the word lookup was an ordered search.

string word

get

The first word found in the lookup operation. Included for convenience.