51 lines
2.0 KiB
Markdown
51 lines
2.0 KiB
Markdown
# MonoBehaviour tests
|
||
|
||
`MonoBehaviourTest` is a [coroutine](https://docs.unity3d.com/ScriptReference/Coroutine.html) and a helper for writing [MonoBehaviour](https://docs.unity3d.com/ScriptReference/MonoBehaviour.html) tests.
|
||
|
||
Yield a `MonoBehaviourTest` when using the `UnityTest` attribute to instantiate the `MonoBehaviour` you wish to test and wait for it to finish running. Implement the `IMonoBehaviourTest` interface on the `MonoBehaviour` to state when the test completes.
|
||
|
||
## Example
|
||
|
||
```c#
|
||
[UnityTest]
|
||
public IEnumerator MonoBehaviourTest_Works()
|
||
{
|
||
yield return new MonoBehaviourTest<MyMonoBehaviourTest>();
|
||
}
|
||
|
||
public class MyMonoBehaviourTest : MonoBehaviour, IMonoBehaviourTest
|
||
{
|
||
private int frameCount;
|
||
public bool IsTestFinished
|
||
{
|
||
get { return frameCount > 10; }
|
||
}
|
||
|
||
void Update()
|
||
{
|
||
frameCount++;
|
||
}
|
||
}
|
||
```
|
||
|
||
## MonoBehaviourTest<T>
|
||
|
||
This is a wrapper that allows running tests on `MonoBehaviour` scripts. Inherits from [CustomYieldInstruction](https://docs.unity3d.com/ScriptReference/CustomYieldInstruction.html).
|
||
|
||
### Properties
|
||
|
||
| Syntax | Description |
|
||
| ----------------------- | ------------------------------------------------------------ |
|
||
| `T component` | A `MonoBehaviour` component created for the test and attached to the test’s [GameObject](https://docs.unity3d.com/ScriptReference/GameObject.html). |
|
||
| `GameObject gameObject` | A `GameObject` created as a container for the test component. |
|
||
| `bool keepWaiting` | (Inherited) Returns `true` if the test is not finished yet, which keeps the coroutine suspended. |
|
||
|
||
## IMonoBehaviourTest
|
||
|
||
An interface implemented by a `MonoBehaviour` test.
|
||
|
||
### Properties
|
||
|
||
| Syntax | Description |
|
||
| --------------------- | ----------------------------------------------- |
|
||
| `bool IsTestFinished` | Indicates when the test is considered finished. | |