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

An interface representation of a MonoBehaviour. More...

+ Inheritance diagram for IMonoBehaviour:
+ Collaboration diagram for IMonoBehaviour:

Public Member Functions

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 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 representation of a MonoBehaviour.

Also includes an additional user data property, that is not used by Word Game Builder. Allows easy access to some MonoBehaviour properties and components from an interface.

See also
https://docs.unity3d.com/Documentation/ScriptReference/MonoBehaviour.html
https://docs.unity3d.com/Documentation/ScriptReference/Behaviour.html
https://docs.unity3d.com/Documentation/ScriptReference/Component.html
https://docs.unity3d.com/Documentation/ScriptReference/Object.html

Member Function Documentation

void CancelInvoke ( )

Cancels all Invoke calls on this MonoBehaviour.

void CancelInvoke ( string  methodName)

Cancels all Invoke calls with name methodName on this behaviour.

Parameters
methodNameThe method to cancel.
int GetInstanceID ( )

Returns the instance id of the object.

Returns
The instance id of this object.
void Invoke ( string  methodName,
float  time 
)

Invokes the method methodName in time seconds.

Parameters
methodNameThe method to invoke.
timeThe amount of time to wait, in seconds, before invoking the method.
void InvokeRepeating ( string  methodName,
float  time,
float  repeatRate 
)

Invokes the method methodName in time seconds.

After the first invocation repeats calling that function every repeatRate seconds.

Parameters
methodNameThe method to invoke.
timeThe amount of time to wait, in seconds, before invoking the method.
repeatRateThe amount of time to wait between repeat calls.
bool IsInvoking ( )

Is any invoke pending on this MonoBehaviour?

Returns
true if the method is invoking, otherwise false.
bool IsInvoking ( string  methodName)

Is any invoke on methodName pending?

Parameters
methodNameThe method to check.
Returns
true if the method is invoking, otherwise false.
Coroutine StartCoroutine ( IEnumerator  routine)

Starts a coroutine.

Parameters
routineThe coroutine to start.
Returns
StartCoroutine always returns immediately, however you can yield the result. This will wait until the coroutine has finished execution.
Coroutine StartCoroutine ( string  methodName)

Starts a coroutine named methodName.

Parameters
methodNameThe method to start.
Returns
StartCoroutine always returns immediately, however you can yield the result. This will wait until the coroutine has finished execution.
Coroutine StartCoroutine ( string  methodName,
object  value 
)

Starts a coroutine named methodName.

Parameters
methodNameThe method to check.
valueAn argument to pass to the method.
Returns
StartCoroutine always returns immediately, however you can yield the result. This will wait until the coroutine has finished execution.
void StopAllCoroutines ( )

Stops all coroutines running on this behaviour.

void StopCoroutine ( string  methodName)

Stops all coroutines named methodName running on this behaviour.

Parameters
methodNameThe method to stop.
string ToString ( )

Returns the name of the game object.

Returns
The name of the game object.

Property Documentation

bool enabled
getset

Enabled Behaviours are Updated, disabled Behaviours are not.

GameObject gameObject
get

The game object this component is attached to. A component is always attached to a game object.

HideFlags hideFlags
getset

Should the object be hidden, saved with the scene or modifiable by the user?

string name
getset

The name of the object.

string tag
getset

The tag of this game object.

Transform transform
get

The Transform attached to this GameObject. A component is always attached to a transform.

object userData
getset

Additional user data associated with this object. This is unused by default.