Mirror/doc/Articles/General/ScriptTemplates.md

23 lines
1.3 KiB
Markdown
Raw Normal View History

2019-12-22 22:09:51 +00:00
# Script Templates
We've added Script Templates to make it easier to create derived class scripts that inherit from our base classes.
2020-10-22 12:25:18 +00:00
- All possible overrides are already made for you and organized.
- They're all fully commented as to what they all do.
2019-12-22 22:09:51 +00:00
- Base method calls are all in place where needed so you can see what they already do.
2020-10-22 12:25:18 +00:00
- Each has links at the top to their doc page(s).
2019-12-22 22:09:51 +00:00
Import [this package](ScriptTemplates.unitypackage) to add Script Templates to your project.
2020-10-22 12:25:18 +00:00
2020-10-26 15:49:20 +00:00
> **Restart Required:** You must restart Unity after importing this package!
2020-10-27 00:07:28 +00:00
> **Root Folder Required:** ScriptTemplates is a special folder to Unity and must remain in the Assets root...don't move it.
2020-10-26 15:49:20 +00:00
> **Mirror Version Compatibility:** This package is made for the current Asset Store release of Mirror. It may not be compatible with older versions of Mirror.
2020-10-22 12:25:18 +00:00
After importing and restarting Unity, the Mirror section will appear under the Assets > Create menu, as well as the context menu that comes up when you right-click on any folder in your project. You'll be prompted for the file name like any other asset creation.
2019-12-22 22:09:51 +00:00
Hopefully these templates will be helpful to new users of Mirror to learn what methods are available in various classes, as well as just being more convenient for everyone.
![Script Templates](ScriptTemplates.png)