dec()

Decrements the passed integer variable by one and returns the decremented value. Accordingly you may only pass script variables of type integer which are allowed to modified (i.e. they may not be declared as const).

Function Prototype

dec(??variable??)

Arguments

Argument Name Data Type Description
??variable?? Integer Variable The integer variable to be decremented by one.
[required]

Return Value

Description Data Type
Value of the passed variable after the decrementation. Integer Number
The return value of this function is an extension by NKSP to allow inline decrementation (like shown in the example below). However if you want to preserve compatibility with KSP then you should not rely on having a return value.

Examples

on init declare $i message("inc(" & $i & ") = " & inc($i)) message("inc(" & $i & ") = " & inc($i)) message("inc(" & $i & ") = " & inc($i)) message("dec(" & $i & ") = " & dec($i)) message("dec(" & $i & ") = " & dec($i)) message("dec(" & $i & ") = " & dec($i)) end on

See also

inc()

Availability

Since LinuxSampler 2.0.0.svn15.