Right class

The Right class represents a users rights.
Hex.Right(iUserId) returns a new object of type Right.
For more information about how to create an instance of this object read Hex.Right(iUserId) section.

The rights system is hexhub is based on wich bits are set in a 64 bit number.
If you know nothing about the binary system, you should use the *ByName functions.
For more information about what rights exist in hexhub read the hexhub documentation.

• Right:CheckRight(iBitNumber)
• Right:CheckRightByName(sRightName)
• Right:RemoveRight(iBitNumber)
• Right:AddRight(iBitNumber)
• Right:RemoveRightByName(sRightName)
• Right:AddRightByName(sRightName)
• Lua code sample: Checking for a right
• Lua code sample: Removing and adding a right

Right:CheckRight(iBitNumber)

This function returns true if the iBitNumber is set, otherwise it returns false.
Parameters:

• iBitNumber = Range 0-63 where 0 is the first bit and 63 the last.

Right:CheckRightByName(sRightName)

This function returns true if the has the right checked, otherwise it returns false.
Parameters:

• sRightName = a string with the rights name (e.g. "connect1")

Right:RemoveRight(iBitNumber)

This function removes the iBitNumber right.
This function does not return a value.

Parameters:

• iBitNumber = Range 0-63 where 0 is the first bit and 63 the last.

Right:AddRight(iBitNumber)

This function adds the iBitNumber right.
This function does not return a value.
Parameters:

• iBitNumber = Range 0-63 where 0 is the first bit and 63 the last.

Right:RemoveRightByName(sRightName)

This function removes a right.
This function does not return a value.

Parameters:

• sRightName = The name of the right to remove.

Right:AddRightByName(sRightName)

This function adds a right.
This function does not return a value.

Parameters:

• sRightName = The name of the right to add.

Lua code sample: Checking for a right

local rights = Hex.Right(iUserId)
local bResult = rights:CheckRightByName("connect0")
if (bResult == true) then
	-- user got the right					
end

Lua code sample: Removing and adding a right

local rights = Hex.Right(iUserId)
rights:RemoveRightByName("connect0")
rights:AddRightByName("connect0")

---