UserCommand class

The UserCommand class represents a $UserCommand that is sent to all users by hexhub during login.
Hex.UserCommand() returns a new object of type UserCommand.
For more information about how to create an instance of this object read Hex.UserCommand() section.

The usercommand will be sent as long as this object is valid.
Once the lua garbage collector collects this object it will be automatically unregistered with hexhub.

Remarks:
If you intend to register many user menus, you should use the newer UserCommandEx class

Object:SetUserCommandString(sUserCommand)

This function sets the user menu sent during login.
The user menu can be changed after its registered with another call to this function.

Hex Script versions < 1.2.0.1:
This function does not return a value
Hex Script versions >= 1.2.0.1:
This function returns false on error, and true on success.

Parameters:

usrcmd = Hex.UserCommand()
usrcmd:SetUserCommandString("$UserCommand ....")

Generated on Sat Aug 22 21:09:31 2009 for Hex Script by  doxygen 1.5.8