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

An interface defining a word game agent. Implementations must derive from MonoBehaviour in some form. More...

+ Inheritance diagram for IWordGameAgent:
+ Collaboration diagram for IWordGameAgent:

Public Member Functions

AsyncTask FindWords ()
 Finds a set of words, based on the player's current held tiles. More...
 
AsyncTask FindWords (IList< ILetterTile > tiles)
 Finds a set of words, based on a list of letter tiles. More...
 
void Stop ()
 Stops all actions currently in progress by the agent. 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

AgentSearchInfo lastSearchInfo [get]
 Gets the most recent search information found from the agent. More...
 
WGBEvent onFindWords [get, set]
 This event should fire whenever the agent has found a set of words. 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 word game agent. Implementations must derive from MonoBehaviour in some form.

Any implementation of this interface will work with other Word Game Builder classes. However, it is recommended to use the WordGameAgent class instead.

Member Function Documentation

AsyncTask FindWords ( )

Finds a set of words, based on the player's current held tiles.

Returns
An object representing an asynchronous task.

Implemented in WordGameAgent.

+ Here is the caller graph for this function:

AsyncTask FindWords ( IList< ILetterTile tiles)

Finds a set of words, based on a list of letter tiles.

Parameters
tilesA list of letter tiles to use when searching for words.
Returns
An object representing an asynchronous task.

Implemented in WordGameAgent.

void Stop ( )

Stops all actions currently in progress by the agent.

Implemented in WordGameAgent.

+ Here is the caller graph for this function:

Property Documentation

AgentSearchInfo lastSearchInfo
get

Gets the most recent search information found from the agent.

WGBEvent onFindWords
getset

This event should fire whenever the agent has found a set of words.