Differences

This shows you the differences between two versions of the page.

--- cw4:wiki_help [2021/01/28 13:35] – created Karsten75
+++ cw4:wiki_help [2025/02/14 14:57] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
 <- [[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.
-===== Overview =====
+===== 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.
-===== CMOD documentation =====
+==== Build Menu Help ====
-==== Where ====
+<WRAP group>
-==== How ====
+<WRAP column>
 {{cw4:build_panel_wiki.png}}
+</WRAP>
+<WRAP column twothirds>
+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.
+</WRAP>
+</WRAP>
+<WRAP clear/>
+----
+==== Tooltip Help ====
+<WRAP group>
+<WRAP column twothirds>
 {{tooltip_wiki.png}}
+</WRAP>
+<WRAP column third>
+When the unit has a tooltip enabled, then the same Help link will appear in the bottom right of the tooltip pop-up.
+</WRAP>
+</WRAP>
+<WRAP group>
+<WRAP column twothirds>
 {{cmod_wiki_tooltip.png}}
+</WRAP>
+<WRAP column third>
+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 <color #00ff00ff>popup line 0</color> field. Adding additional text via the second pop field is optional.
+Tooltips can also be enabled via 4RPL - [[4rpl:commands:SetUnitPopupEnabled]] and [[4rpl:commands:SetUnitPopupText0]]
+</WRAP>
+</WRAP>
+----
+----
+===== Map Maker Help =====
+Map makers can access unit help through a link  adjacent to the build button for the unit. For more extensive help on the overall system, there is also a link to a Help button for the CPACK. This help may be more specific to information only relevant to the map maker and is not accessible in-game by the player.
+==== Editor Help ====
+<WRAP group>
+<WRAP column twothirds>
 {{editor_wiki.png}}
+</WRAP>
+<WRAP column third>
+For custom units that must be placed via the Map Editor, there is a link in the selection button for each unit. These links have the same URL as the player help links.
+</WRAP>
+</WRAP>
+----
+----
+===== CPACK Editor Help =====
+These links are available in the CPACK Editor and is also intended as the method for CPACK creators to access and create the documentation in the first instance. Note that when creating information in the wiki, a suggested template will be provided.
+==== CMOD (unit) Help ====
 {{cmod_wiki.png}}
+==== CPACK (package) Help ====
 {{cpack_wiki.png}}
-===== CPACK documentation =====
 <- [[Custom Units]]

Knuckle Cracker Wiki

User Tools

Site Tools

Differences

Page Tools