Method

Operator_Modulo

---

Description

Used to overload the Mod function, providing custom functionality.

Notes

Create an Operator_Modulo function in a class to specify the functionality of the Mod operator for that class.

In the function, the Self instance the left operand and the other operand is passed as a parameter.

Sample code

Using the Vector class (see Operator Add) with two Integer elements, x and y, we define an Operator_Modulo function that returns the remainder of the division of the sum of the Self instance by the passed instance.

Function Operator_Modulo(rhs As Vector) As Integer
  Var a, b As Integer
  a = Self.x + Self.y
  b = rhs.x + rhs.y

  Return a Mod b
End Function

Compatibility

All project types on all supported operating systems.

See also

Mod operator; Operator ModuloRight function.