Function.SqSignalBase.LeadThis - VCMP-SqMod/SqMod GitHub Wiki

Description

Move all occurrences of a slot with a speciffic environment to the front so they receive the signal first.

Specifications

  • Aliases:
SqSignalBase.LeadThis
  • Signature:
(environment);
(environment, one);
(environment, one, append);
  • Parameters:
    • environment object (optional) The object that represents the environment in the slot.
    • one bool (optional) Limit the operation to one slot.
    • append bool (optional) Append instead of push when shuffling slots.
  • Return:
    • integer The number of times there was a match for the specified environment.
  • Throws:
    • This function may throw errors if any of the given parameters are not valid.

Remarks

If the environment parameter is not specified. The current root table will be used instead.

Examples

No example available.

See also

References

No references available.

⚠️ **GitHub.com Fallback** ⚠️