Documentation for Unity Asset Store version v1.20
Add Help Content
Since version v1.20 the level editor is completely independent of the UI implementation. You do not need to use any rigid UI extension system. Simply add the needed UI to the scene. To extend the help popup of the built-in example UI add your help UI to the help popup's page root 'ImageRect' (search for it). Then duplicate the 'Touch-Screen' toggle button (search for 'ToggleTouch'), rearrange it, update its text and change its 'OnValueChanged(bool)' function to activate the UI that you have added to the popup. If you want to use a custom UI, then you can find more information in
this article.
Documentation for Unity Asset Store versions v1.01 and v1.10
Summary
It might be necessary to add some help pages and topics to your game's level editor. For example if you want to explain the player which objects he has to place in order to produce a playable level. The level editor help has topics and pages. Each topic can have multiple pages. For example the controls topic has two pages one for touch devices and one for mouse and keyboard. Help pages are scripts that you can create yourself. An example script that draws an image as a help page is provided in '
LE_GUIHelpPageSingleImage'.
Step 1: Choose A Help Page Script
Help page classes must derive from the abstract '
LE_GUIHelpPageBase' class. A very simple example for a help page that shows an image is provided in the '
LE_GUIHelpPageSingleImage' class. If you want to use images for help pages like it is done for the controls help pages then your are good to go with '
LE_GUIHelpPageSingleImage' class otherwise you will need to write your own help page class and present text and images as you need them.
Step 2: Setup Page Scriptable Object
Each help page is represented with a single scriptable object. Create a scriptable object with your help page script. If you use the '
LE_GUIHelpPageSingleImage' script this means that you need to setup the page title and add an image reference.
Step 3: Create A Help Topic
A help topic is a scriptable object of type '
LE_HelpTopic' you have to create one now (you can duplicate the existing ones and clear their values). A help topic consists of one or more pages. You have to add all your pages to the 'Pages' array of the new help topic.
Step 4: Add Your Topic To The Help Menu
To make your help topic show up in the level editor you have to add it to the '
LE_HelpMenu' scriptable object, which is references in the instance of '
LE_GUILevelEditor' in the level editor scene. Simply add it to the 'Topics' array property of the menu.
