The Device Simulator supports plugins to extend its functionality and change the UI(User Interface) Allows a user to interact with your application. Unity currently supports three UI systems. More info
See in Glossary of the Control Panel in the Simulator view.
To create a Device Simulator plugin, extend the DeviceSimulatorPlugin class.
To insert UI into the Device Simulator view, your plugin must:
title
property to return a non-empty string.OnCreateUI
method to return a VisualElement that contains the UI.If your plugin doesn’t meet these conditions, the Device Simulator instantiates the plugin but doesn’t display its UI in the Simulator view.
The following example demonstrates how to create a plugin that overrides the title property and adds UI to the Simulator view.
public class TouchInfoPlugin : DeviceSimulatorPlugin
{
public override string title => "Touch Info";
private Label m_TouchCountLabel;
private Label m_LastTouchEvent;
private Button m_ResetCountButton;
[SerializeField]
private int m_TouchCount = 0;
public override void OnCreate()
{
deviceSimulator.touchScreenInput += touchEvent =>
{
m_TouchCount += 1;
UpdateTouchCounterText();
m_LastTouchEvent.text = $"Last touch event: {touchEvent.phase.ToString()}";
};
}
public override VisualElement OnCreateUI()
{
VisualElement root = new VisualElement();
m_LastTouchEvent = new Label("Last touch event: None");
m_TouchCountLabel = new Label();
UpdateTouchCounterText();
m_ResetCountButton = new Button {text = "Reset Count" };
m_ResetCountButton.clicked += () =>
{
m_TouchCount = 0;
UpdateTouchCounterText();
};
root.Add(m_LastTouchEvent);
root.Add(m_TouchCountLabel);
root.Add(m_ResetCountButton);
return root;
}
private void UpdateTouchCounterText()
{
if (m_TouchCount > 0)
m_TouchCountLabel.text = $"Touches recorded: {m_TouchCount}";
else
m_TouchCountLabel.text = "No taps recorded";
}
}
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.