In this exercise, you will learn how to test content that is stored in a sceneA Scene contains the environments and menus of your game. Think of each unique Scene file as a unique level. In each Scene, you place your environments, obstacles, and decorations, essentially designing and building your game in pieces. More info
See in Glossary.
A useful scenario for our customers is using the test framework for verifying the content of a scene. That could be checking for certain GameObjectsThe fundamental object in Unity scenes, which can represent characters, props, scenery, cameras, waypoints, and more. A GameObject’s functionality is defined by the Components attached to it. More info
See in Glossary and MonoBehaviors.
The EditorSceneManager allows for loading and saving scenes. In combination with the test framework, this allows for the implementation of tests that verify a scene.
When changing the state of the Editor in a test, such as loading a scene, it’s good practice to clean up afterward. This can be done in a method with the [TearDown] attribute.
Import the sample 11_SceneBasedTests, which contains a scene named MyGameScene and an assembly for Edit Mode tests.
The task is to create a test that opens the scene, verifies that the scene contains a game object named GameObjectToTestFor.
As cleanup, it should open a new empty scene, which is the default for Edit Mode tests. It is recommended to put that in a [TearDown], which ensures that the cleanup code is run, even if the test fails.
EditorSceneManager.OpenScene("Assets\\MyGameScene.unity"); loads the sceneEditorSceneManager.NewScene(NewSceneSetup.DefaultGameObjects, NewSceneMode.Single); cleans up by changing back to an empty scene.A full solution is available in the sample 11_SceneBasedTests_Solution.
The test implementation can look like this:
public class SceneTests
{
[SetUp]
public void Setup()
{
EditorSceneManager.OpenScene("Assets\\MyGameScene.unity");
}
[Test]
public void VerifyScene()
{
var gameObject = GameObject.Find("GameObjectToTestFor");
Assert.That(gameObject, Is.Not.Null);
}
[TearDown]
public void Teardown()
{
EditorSceneManager.NewScene(NewSceneSetup.DefaultGameObjects, NewSceneMode.Single);
}
}
API reference for EditorSceneManager
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.