Interface 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
• ExitPlayMode
• RecompileScripts
• WaitForDomainReload

Namespace: UnityEngine.TestTools

Syntax

public interface IEditModeTestYieldInstruction

Examples

[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

ExpectDomainReload

Whether or not the instruction expects a domain reload to occur.

Declaration

bool ExpectDomainReload { get; }

Property Value

Type	Description
Boolean

ExpectedPlaymodeState

Whether or not the instruction expects the Unity Editor to be in Play Mode.

Declaration

bool ExpectedPlaymodeState { get; }

Property Value

Type	Description
Boolean

Methods

Perform()

Used to define multi-frame operations performed when instantiating a yield instruction.

Declaration

IEnumerator Perform()

Returns

Type	Description
IEnumerator	Enumerable collection of operations to perform.