This is an old revision of the document!
Table of Contents
<- Custom Units
Wiki Help/Documentation for Custom Units
This page provides an overview of both how to access the Help system, and how to enable the Help system when a custom unit is created.
Player Access to the Help system
There are two ways for players to access the help - through the build menu or, when enabled, through the tooltip pop-up. This method is especially useful to provide information on pre-built units on the map and is functional for both friendly and enemy units.
Build Menu Help
Players can access the help system for custom units in the same manner as they can for built-in units. At the bottom of the build menu, there is an indicator of which key is linked to the Help system (default is “H”). When a unit is selected, the help is active. It will link to the wiki, with the URL for the custom unit UID.
Tooltip Help
When the unit has a tooltip enabled, then the same Help link will appear in the bottom right of the tooltip pop-up.
To enable the tooltip pop-up (and the help link), the tooltip must be enabled.
This can be done in the CPACK editor in the Settings Interface. Fill in at test for at least the popup line 0 field. Adding additional text via the second pop field is optional.
Tooltips can also be enabled via 4RPL - SetUnitPopupEnabled and SetUnitPopupText0
CMOD documentation
Where
How
CPACK documentation
<- Custom Units
