The HelpString class represents a help string shown in !help.
Hex.HelpString(iSection, sLanguage) returns a new object of type HelpString.
The HelpString class is initialized with two parameters:
iSection: 0 = Hub information, 1 = Commands for messages, 2 = Operator commands, 3 = reserved, 4 = Profile management, 5 = DC++ commands, 6 = Extra
sLanguage: a 2-letter language identifier (e.g. "EN", "RO", "DE", ect.).
The help string will only remain registered with the hub (visible to users), as long as the HelpString object you created is valid.
This function adds (or changes a prev. string) to the hubs !help menu.
Once the object gets collected by the lua garbage collector then the help string will automatically be unregistered.
This function does not return a value.
sHelpString = the text you want to show in !help
hlpstr = Hex.HelpString(2, "EN")
Generated on Thu Aug 21 11:24:07 2008 for HeXHub/HexScript by
Site hosted by