Function.SqSignalBase.Lead - VCMP-SqMod/SqMod GitHub Wiki
Move all occurrences of a speciffic slot to the front so they receive the signal first.
- Aliases:
SqSignalBase.Lead
- Signature:
(callback);
(environment, callback);
(environment, callback, one);
(environment, callback, one, append);
-
Parameters:
-
environment
object
(optional) The object that represents the environment in the slot. -
callback
function
The function that represents the callback in the slot. -
one
bool
(optional) Limit the operation to one slot. -
append
bool
(optional) Append instead of push when shuffling slots.
-
environment
-
Return:
-
integer
The number of times there was a match for the specified slot.
-
-
Throws:
- This function may throw errors if any of the given parameters are not valid.
If the environment parameter is not specified. The current root table will be used instead.
No example available.
-
function
SqSignalBase.LeadThis -
function
SqSignalBase.LeadFunc
No references available.