diff options
| author | Andrew Lee <alee14498@protonmail.com> | 2020-04-19 17:19:32 -0400 |
|---|---|---|
| committer | Andrew Lee <alee14498@protonmail.com> | 2020-04-19 17:19:32 -0400 |
| commit | c55fba8ab2a1c9d3df65eda4a5a1e957f4aa1f78 (patch) | |
| tree | ee4d51c7c1d633e11f46453ef1edd3c77c4ef9f7 /Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/reference-custom-yield-instructions.md | |
| download | Project-Sandbox-c55fba8ab2a1c9d3df65eda4a5a1e957f4aa1f78.tar.gz Project-Sandbox-c55fba8ab2a1c9d3df65eda4a5a1e957f4aa1f78.tar.bz2 Project-Sandbox-c55fba8ab2a1c9d3df65eda4a5a1e957f4aa1f78.zip | |
Inital commit
Diffstat (limited to 'Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/reference-custom-yield-instructions.md')
| -rw-r--r-- | Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/reference-custom-yield-instructions.md | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/reference-custom-yield-instructions.md b/Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/reference-custom-yield-instructions.md new file mode 100644 index 0000000..60f22e4 --- /dev/null +++ b/Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/reference-custom-yield-instructions.md @@ -0,0 +1,60 @@ +# Custom yield instructions
+
+By implementing this interface below, you can define custom yield instructions in **Edit Mode** tests.
+
+## IEditModeTestYieldInstruction
+
+In an Edit Mode test, you can use `IEditModeTestYieldInstruction` interface to implement your own instruction. There are also a couple of commonly used implementations available:
+
+- [EnterPlayMode](#enterplaymode)
+- [ExitPlayMode](#exitplaymode)
+- [RecompileScripts](./reference-recompile-scripts.md)
+- [WaitForDomainReload](./reference-wait-for-domain-reload.md)
+
+## Example
+
+```c#
+[UnityTest]
+
+public IEnumerator PlayOnAwakeDisabled_DoesntPlayWhenEnteringPlayMode()
+
+{
+ var videoPlayer = PrefabUtility.InstantiatePrefab(m_VideoPlayerPrefab.GetComponent<VideoPlayer>()) as VideoPlayer;
+
+ videoPlayer.playOnAwake = false;
+
+ yield return new EnterPlayMode();
+
+ var videoPlayerGO = GameObject.Find(m_VideoPlayerPrefab.name);
+
+ Assert.IsFalse(videoPlayerGO.GetComponent<VideoPlayer>().isPlaying);
+
+ yield return new ExitPlayMode();
+
+ Object.DestroyImmediate(GameObject.Find(m_VideoPlayerPrefab.name));
+}
+```
+
+## Properties
+
+| Syntax | Description |
+| ---------------------------- | ------------------------------------------------------------ |
+| `bool ExpectDomainReload` | Returns `true` if the instruction expects a domain reload to occur. |
+| `bool ExpectedPlaymodeState` | Returns `true` if the instruction expects the Unity Editor to be in **Play Mode**. |
+
+## Methods
+
+| Syntax | Description |
+| ----------------------- | ------------------------------------------------------------ |
+| `IEnumerator Perform()` | Used to define multi-frame operations performed when instantiating a yield instruction. |
+
+## EnterPlayMode
+
+* Implements `IEditModeTestYieldInstruction`. Creates a yield instruction to enter Play Mode.
+* When creating an Editor test that uses the `UnityTest` attribute, use this to trigger the Editor to enter Play Mode.
+* Throws an exception if the Editor is already in Play Mode or if there is a [script compilation error](https://support.unity3d.com/hc/en-us/articles/205930539-How-do-I-interpret-a-compiler-error-).
+
+## ExitPlayMode
+
+* Implements `IEditModeTestYieldInstruction`. A new instance of the class is a yield instruction to exit Play Mode.
+* Throws an exception if the Editor is not in Play Mode.
|