This client export adds a command suggestion to the local player’s chat —
the export equivalent of triggering chat:addSuggestion.
Export Name
addSuggestionParameters
- string commandName: The command to suggest, including the leading
/ - string commandDescription: Help text shown for the command
- object commandParameters: Array of
{ name, help }objects describing each argument
Example
-- Note, the command has to start with `/`.
exports.chat:addSuggestion('/command', 'help text', {
{ name = 'paramName1', help = 'param description 1' },
{ name = 'paramName2', help = 'param description 2' }
})