Jump to content


ModifiersPlugin helper functions

Warning: Please note

This thread was started before GSAP 3 was released. Some information, especially the syntax, may be out of date for GSAP 3. Please see the GSAP 3 migration guide and release notes for more information about how to update the code to GSAP 3's syntax. 

Recommended Posts

Just wanted to share some nice functions I came across that can be used with the ModifiersPlugin.


Doing a normal modulus calculation restarts the value at 0, which may not be what you want.

500 % 500 // => 0

This function will allow you to do a modulus operation for a min/max range.

wrap(500, -100, 500); // => -100

function wrap(value, min, max) {
  var v = value - min;
  var r = max - min;

  return ((r + v % r) % r) + min;

And this is a modified version of that function that will make the modulus value "yoyo".


mirroredWrap(600, -100, 500); // => 400

function mirroredWrap(value, min, max) {
  var v  = value - min;
  var r1 = max - min;
  var r2 = r1 * 2;
  v = (r2 + v % r2) % r2;
  return v > r1 ? (r2 - v) + min : v + min;

With the first wrap function you can do some interesting stuff, like making an object appear in two different places, kind of like in those old asteroid games.


And with the mirroredWrap, you can do stuff like creating multiple bounces with a single tween.

See the Pen ?editors=0010 by osublake (@osublake) on CodePen



See the Pen ?editors=0010 by osublake (@osublake) on CodePen

  • Like 12
Link to comment
Share on other sites

Slick stuff, Blake! Thanks for sharing. 

  • Like 1
Link to comment
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
  • Recently Browsing   0 members

    • No registered users viewing this page.