SetCModPlayerMenuName(<-CModUID <-name <-section)

Causes the unit to be added to the player build menu with the specified name. The CModUID (a unit template defined in a CPACK) references the unit definition. You can get the CMOD UID from within the CPACK manager. CMOD UIDs are unique and never change. Once added, the player can click on the button that contains the name and build the specified unit. The section is a number that specified which menu the name is added to. It can be 0,1,2,3,4. 0 means the Struct menu, 1 means the Weapons menu, 2 is the Air menu, 3 is the Special menu, and 4 is the Custom menu.

SetCModPlayerMenuName rebuilds the entire unit menu on the left. So it will be expensive in terms of CPU cycles. It is not intended that it be be called frequently (just when adding something to the menu).

This API can be used to circumvent the heavy limit of characters in custom player unit names in the unit editor.
However, although the number of characters that can be used using this circumvention are much greater than in the unit editor, the unit build box will not wrap to fit the length of text.
The amount of characters that can fit within the build menu is about 12 characters maximum, depending on capitalization and what characters where used. Any more and the text will be larger than the box and even go off screen.
Additional Note: If enough characters are used, a new line will be created. Sadly this pushes text upwards and behind the unit image while still going off screen, making this feature unhelpful. Formatting is also unsupported.

SetCModPlayerMenuName(<-CModUID "TestUnit" 4)

⇐ Index