Word Game Builder 2.0.1f2
Reference Manual
Public Member Functions | Properties | List of all members
ISelectableLetterTile Interface Reference

An interface defining a letter tile that can be selected and deselected. Implementations must derive from MonoBehaviour in some form. More...

+ Inheritance diagram for ISelectableLetterTile:
+ Collaboration diagram for ISelectableLetterTile:

Public Member Functions

bool CanSelectTile (IList< ILetterTile > tiles, out bool shouldDeselect)
 Returns true if this tile can be selected based on a list of currently selected tiles. More...
 
bool CanSelectTile (IWordGamePlayer player, out bool shouldDeselect)
 Returns true if the specified player can select this tile. More...
 
bool DeselectTile (IList< ILetterTile > tiles)
 Deselects the tile from a list of currently selected tiles, obeying rules for tile selection. More...
 
bool DeselectTile (IWordGamePlayer player)
 Deselects the tile for a player, obeying rules for tile selection. More...
 
void ForceDeselectTile ()
 Deselects the tile, ignoring tile selection rules. More...
 
void ForceSelectTile ()
 Selects the tile, ignoring tile selection rules. More...
 
void ModifyTileSelection (IList< ILetterTile > tiles)
 Modifies a list of selected tiles to include/remove the current tile, based on tile selection rules. More...
 
bool SelectTile (IList< ILetterTile > tiles)
 Selects the tile from a list of currently selected tiles, obeying rules for tile selection. More...
 
bool SelectTile (IWordGamePlayer player)
 Selects the tile for a player, obeying rules for tile selection. More...
 
- 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...
 

Properties

bool isSelected [get]
 Is this tile currently selected? More...
 
WGBEvent onTileSelect [get, set]
 This event should fire when a tile is selected or deselected and can be used to override a selection. 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...
 

Detailed Description

An interface defining a letter tile that can be selected and deselected. Implementations must derive from MonoBehaviour in some form.

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

Member Function Documentation

bool CanSelectTile ( IList< ILetterTile tiles,
out bool  shouldDeselect 
)

Returns true if this tile can be selected based on a list of currently selected tiles.

Parameters
tilesA list representing currently selected tiles.
shouldDeselectIf true, this tile should be deselected.
Returns
true if the tile can be selected, otherwise false

Implemented in LetterTile.

bool CanSelectTile ( IWordGamePlayer  player,
out bool  shouldDeselect 
)

Returns true if the specified player can select this tile.

Parameters
playerThe player to check, to see if this tile can be selected.
shouldDeselectIf true, this tile should be deselected.
Returns
true if the tile can be selected, otherwise false

Implemented in LetterTile.

bool DeselectTile ( IList< ILetterTile tiles)

Deselects the tile from a list of currently selected tiles, obeying rules for tile selection.

Parameters
tilesA list of tiles to modify.
Returns
true if the operation was successful; otherwise false.

Implemented in LetterTile.

+ Here is the caller graph for this function:

bool DeselectTile ( IWordGamePlayer  player)

Deselects the tile for a player, obeying rules for tile selection.

Parameters
playerThe player to check, to see if this tile can be deselected.
Returns
true if the operation was successful; otherwise false.

Implemented in LetterTile.

void ForceDeselectTile ( )

Deselects the tile, ignoring tile selection rules.

Implemented in LetterTile.

+ Here is the caller graph for this function:

void ForceSelectTile ( )

Selects the tile, ignoring tile selection rules.

Implemented in LetterTile.

void ModifyTileSelection ( IList< ILetterTile tiles)

Modifies a list of selected tiles to include/remove the current tile, based on tile selection rules.

Parameters
tilesA list of tiles to modify.

Selecting a tile would add to the list, while deselecting a tile would remove the tile from the list. Other tiles may also be modified.

Implemented in LetterTile.

bool SelectTile ( IList< ILetterTile tiles)

Selects the tile from a list of currently selected tiles, obeying rules for tile selection.

Parameters
tilesA list of tiles to modify.
Returns
true if the operation was successful; otherwise false.

Implemented in LetterTile.

+ Here is the caller graph for this function:

bool SelectTile ( IWordGamePlayer  player)

Selects the tile for a player, obeying rules for tile selection.

Parameters
playerThe player to check, to see if this tile can be selected.
Returns
true if the operation was successful; otherwise false.

Implemented in LetterTile.

Property Documentation

bool isSelected
get

Is this tile currently selected?

WGBEvent onTileSelect
getset

This event should fire when a tile is selected or deselected and can be used to override a selection.