Represents selection information for a letter tile. More...

Collaboration diagram for LetterTile.SelectionInfo:

Public Member Functions
void	AddAllPlayers ()
	Adds all active players in the scene to this tile. More...

bool	AddPlayer (IWordGamePlayer player)
	Adds a player that can select this tile, and that will be affected by a tile's selection. More...

bool	AddPlayer (string name)
	Adds a player that can select this tile, and that will be affected by a tile's selection (by name). More...

void	ClearPlayers ()
	Clears all players that can select this tile, and that are currently affected by a tile's selection. More...

bool	ContainsPlayer (IWordGamePlayer player)
	Checks to see if a player can select this tile, and will affect a tile's selection. More...

bool	ContainsPlayer (string name)
	Checks to see if a player can select this tile, and will affect a tile's selection (by name). More...

IWordGamePlayer[]	GetPlayers ()
	Gets all players that can select this tile, and that will be affected by a tile's selection. More...

bool	RemovePlayer (IWordGamePlayer player)
	Removes a player that can select this tile, and that is currently affected by a tile's selection. More...

Properties
DistanceSpace	distanceSpace `[get, set]`
	Controls how distance is calculated (pixel, local, or world space). More...

float	maxDistance `[get, set]`
	The maximum distance between tiles for selection. More...

bool	processWildcards `[get, set]`
	Whether or not the wildcard tile manager should be ignored when selecting a blank tile. More...

Camera	referenceCamera `[get, set]`
	The reference camera for calculating tile distances in pixels. If not set, this defaults to the main camera. More...

bool	selectAnyTile `[get, set]`
	If true, any tile can be selected in any order. If false, only tiles within maxDistance of the last tile can be selected. More...

SelectionMode	selectionMode `[get, set]`
	Controls how the tile is selected. More...

IWildcardTileManager	wildcardTileManager `[get, set]`
	Gets or sets the current wildcard tile manager, used for selecting wildcard tiles. More...

Detailed Description

Represents selection information for a letter tile.

Member Function Documentation

void AddAllPlayers ( )

inline

Adds all active players in the scene to this tile.

Here is the call graph for this function:

Here is the caller graph for this function:

bool AddPlayer ( IWordGamePlayer player )

inline

Adds a player that can select this tile, and that will be affected by a tile's selection.

Parameters

player The player to add.

Letter tiles initialize with all active players by default.

Parameters

player The player to add.

Returns: true if the operation was successful, otherwise false.

bool AddPlayer ( string name )

inline

Adds a player that can select this tile, and that will be affected by a tile's selection (by name).

Parameters

name	The player name to add.

Returns: true if the operation was successful, otherwise false.

Here is the call graph for this function:

void ClearPlayers ( )

inline

Clears all players that can select this tile, and that are currently affected by a tile's selection.

bool ContainsPlayer ( IWordGamePlayer player )

inline

Checks to see if a player can select this tile, and will affect a tile's selection.

Parameters

player The player to check.

Returns: true if the player will affect a tile's selection, otherwise false.

bool ContainsPlayer ( string name )

inline

Checks to see if a player can select this tile, and will affect a tile's selection (by name).

Parameters

name	The player name to check.

Returns: true if the player will affect a tile's selection, otherwise false.

IWordGamePlayer [] GetPlayers ( )

inline

Gets all players that can select this tile, and that will be affected by a tile's selection.

This allocates a new array.

Returns: An array containing all players affected by tile selection.

bool RemovePlayer ( IWordGamePlayer player )

inline

Removes a player that can select this tile, and that is currently affected by a tile's selection.

Parameters

player The player to remove.

Returns: true if the operation was successful, otherwise false.

Property Documentation

DistanceSpace distanceSpace

getset

Controls how distance is calculated (pixel, local, or world space).

float maxDistance

getset

The maximum distance between tiles for selection.

If selectAnyTile = false, only tiles within maxDistance of the last tile can be selected.

bool processWildcards

getset

Whether or not the wildcard tile manager should be ignored when selecting a blank tile.

If true, then blank tiles will be selected normally.

Camera referenceCamera

getset

The reference camera for calculating tile distances in pixels. If not set, this defaults to the main camera.

This value is ignored if distances are calculated in world space.

bool selectAnyTile

getset

If true, any tile can be selected in any order. If false, only tiles within maxDistance of the last tile can be selected.

SelectionMode selectionMode

getset

Controls how the tile is selected.

IWildcardTileManager wildcardTileManager

getset

Gets or sets the current wildcard tile manager, used for selecting wildcard tiles.

If there is only one wildcard tile manager in the scene, this value does not have to be set.

Public Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation