Trigger class

The Trigger class represents a trigger registered with the hub.
When ever a user typed !triggername your script will be called, for more information read the The OnTrigger(iTriggerId, iUserId, bIsPm, sParameters) callback section.
Hex.Trigger() returns a new object of type Trigger.

Trigger:SetTrigger(sTrigger)

This function sets the trigger name.

Remarks:
In Hex Script versions < 1.2.0.0 the length of sTrigger is limited to 40 chars

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:

Trigger:GetTriggerId()

This function returns the identifier of the trigger.

Lua sample code

mytrigger = Hex.Trigger()
mytrigger:SetTrigger("trigger")

-- fired when some one types "!trigger" in mainchat or in pm to hub bot
function OnTrigger(iTriggerId, iUserId, bIsPm, sParameters)
	if mytrigger:GetTriggerId() == iTriggerId then
		-- a trigger we registered is being used
		print("Lua: TrigId="..iTriggerId.." UserId="..iUserId.."Parameters="..sParameters)
	end
end

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