ILetterTileDisplay Interface Reference

An interface defining letter tile colors and labels. More...

Inheritance diagram for ILetterTileDisplay:

Collaboration diagram for ILetterTileDisplay:

Properties
Color	currentBackgroundColor [get]
	The current background color for the tile. More...
string	currentLetterLabel [get]
	The current letter label for the tile. More...
string	currentScoreLabel [get]
	The current score label for the tile. More...
Color	currentTextColor [get]
	The current text color for the tile. More...
bool	shouldAnimate [get]
	Returns true if a tile should animate. This should only be set during change events. More...
bool	shouldChangeColor [get]
	Returns true if a tile should change color. This should only be set during change events. More...
bool	shouldChangeLabel [get]
	Returns true if a tile should change any label text. This should only be set during change events. More...
Properties inherited from ILetterTile
Letter	currentLetter [get]
	The current letter represented by the tile. More...
int	currentPointValue [get]
	The current point value of the tile. More...
Letter	defaultLetter [get]
	The default letter represented by the tile. More...
int	defaultPointValue [get]
	The default point value of the tile. More...
bool	isActive [get]
	Is the tile currently active (spawned)? More...
WGBEvent	onTileChange [get, set]
	This event should fire when a tile's display should change in any way. More...
WGBEvent	onTileSpawn [get, set]
	This event should fire when a tile is spawned or despawned. More...
Letter	wildcardLetter [get]
	The wildcard letter represented by the tile. More...
Properties inherited from IMonoBehaviour
bool	enabled [get, set]
	Enabled Behaviours are Updated, disabled Behaviours are not. More...
GameObject	gameObject [get]
	The game object this component is attached to. A component is always attached to a game object. More...
HideFlags	hideFlags [get, set]
	Should the object be hidden, saved with the scene or modifiable by the user? More...
string	name [get, set]
	The name of the object. More...
string	tag [get, set]
	The tag of this game object. More...
Transform	transform [get]
	The Transform attached to this GameObject. A component is always attached to a transform. More...
object	userData [get, set]
	Additional user data associated with this object. This is unused by default. More...

Additional Inherited Members
Public Member Functions inherited from ILetterTile
void	ChangeDefaultLetter (Letter letter)
	Changes the default letter on a tile. More...
void	DespawnTile ()
	This should control tile visibility, colliders, and triggers. More...
void	RemoveWildcard ()
	Remove the wildcard letter on a tile. More...
void	SetWildcard (Letter letter)
	Sets the wildcard letter on a tile. More...
void	SetWildcard (Letter letter, int score)
	Sets the wildcard letter on a tile, and changes its score to the specified score. More...
void	SpawnTile ()
	This should control tile visibility, colliders, and triggers. More...
Public Member Functions inherited from IMonoBehaviour
void	CancelInvoke ()
	Cancels all Invoke calls on this MonoBehaviour. More...
void	CancelInvoke (string methodName)
	Cancels all Invoke calls with name methodName on this behaviour. More...
int	GetInstanceID ()
	Returns the instance id of the object. More...
void	Invoke (string methodName, float time)
	Invokes the method methodName in time seconds. More...
void	InvokeRepeating (string methodName, float time, float repeatRate)
	Invokes the method methodName in time seconds. More...
bool	IsInvoking ()
	Is any invoke pending on this MonoBehaviour? More...
bool	IsInvoking (string methodName)
	Is any invoke on methodName pending? More...
Coroutine	StartCoroutine (IEnumerator routine)
	Starts a coroutine. More...
Coroutine	StartCoroutine (string methodName)
	Starts a coroutine named methodName. More...
Coroutine	StartCoroutine (string methodName, object value)
	Starts a coroutine named methodName. More...
void	StopAllCoroutines ()
	Stops all coroutines running on this behaviour. More...
void	StopCoroutine (string methodName)
	Stops all coroutines named methodName running on this behaviour. More...
string	ToString ()
	Returns the name of the game object. More...

Detailed Description

An interface defining letter tile colors and labels.

Any implementation of this interface will work with other Word Game Builder classes. It is recommended to use the LetterTile class instead.

Property Documentation

Color currentBackgroundColor

get

The current background color for the tile.

string currentLetterLabel

get

The current letter label for the tile.

string currentScoreLabel

get

The current score label for the tile.

Color currentTextColor

get

The current text color for the tile.

bool shouldAnimate

get

Returns true if a tile should animate. This should only be set during change events.

bool shouldChangeColor

get

Returns true if a tile should change color. This should only be set during change events.

bool shouldChangeLabel

get

Returns true if a tile should change any label text. This should only be set during change events.