SetMapDescription

Parameters

description

string

comment

Sets the map description.

note

This function shall only be used within the scope of function config in war3map.j, it is executed by the game when you load the lobby/selected the map for preview.

note

The map description is saved to "war3map.w3i" too, but this field is unused.

note

Supports color codes.

note

Length limits:

• Classic (1.0): Limited by total text width, approx. 40 latin characters per line. Automatic line breaks.
• Reforged: Seemingly no limit, the description box gets (bugged) vertical & horizontal scroll bars along with automatic line-breaking.

note

Line limits:

• Classic (1.0): Maximum 9 lines.
• Reforged (1.32.10): Seemingly no limit.

patch

1.00

Source

common.j

return type

nothing

Source code

native SetMapDescription    takes string description returns nothing