Class Counter
Counter for a continuous incrementing number.
This class follows the pattern from Lua classes.
Metamethods
| Counter:__index (key) | Lookup of missing class members. |
| Counter:__call ([num=1]) | Call on instance. |
Methods
| Counter:create ([num=0]) | Create a new instance. |
| Counter:_init ([num=0]) | Initialize a new instance. |
| Counter:isInitialized () | Is the running count initialized. |
| Counter:num () | The current value. |
| Counter:inc ([num=1]) | Increment the value. |
| Counter:dec ([num=1]) | Decrement the value. |
Metamethods
- Counter:__index (key)
-
Lookup of missing class members.
Parameters:
- key string lookup of member
Returns:
anyRaises:
on wrong arguments - Counter:__call ([num=1])
-
Call on instance.
Update value, but return the old value.
Parameters:
- num nil or number increment value (default 1)
Returns:
number previous valueRaises:
on wrong arguments
Methods
- Counter:create ([num=0])
-
Create a new instance.
Parameters:
- num nil or number initial value (default 0)
Returns:
selfRaises:
on wrong arguments - Counter:_init ([num=0])
-
Initialize a new instance.
Parameters:
- num nil or number initial value (default 0)
Returns:
selfRaises:
on wrong arguments - Counter:isInitialized ()
-
Is the running count initialized.
Returns:
boolean has the internal structure been initialized - Counter:num ()
-
The current value.
Returns:
number current value - Counter:inc ([num=1])
-
Increment the value.
This method will always increment in positive direction.
Parameters:
- num nil or number increment value (default 1)
Returns:
number incremented valueRaises:
on wrong arguments - Counter:dec ([num=1])
-
Decrement the value.
This method will always decrement in negative direction.
Parameters:
- num nil or number decrement value (default 1)
Returns:
number incremented valueRaises:
on wrong arguments