HelpString class

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:

The help string will only remain registered with the hub (visible to users), as long as the HelpString object you created is valid.
Once the object gets collected by the lua garbage collector then the help string will automatically be unregistered.


This function adds (or changes a prev. string) to the hubs !help menu.
This function does not return a value.

Lua script sample

	hlpstr = Hex.HelpString(2, "EN")

Generated on Thu Aug 21 11:24:07 2008 for HeXHub/HexScript by  doxygen 1.5.4
Site hosted by Logo