Awesome

GMTimeLine

A pure code approach to timelines in Game Maker

Examples

Live examples here!

GMTimeline allows you to create timelines by simply chaining events, like so:

timer = 0;

/// @param {Real} msLeft
var updateTime = function (msLeft) {
  timer = msLeft;
};

timeline = new Timeline()
  .keyPress(vk_enter) // Wait till the Enter key is pressed
  .delay(2, updateTime) // Wait 2 seconds, pass time passed to updateTime function
  // Instantiate 5 instances of OMonster in intervals of 1 second, wait for the instances to be destroyed
  // before considering the event to be finished
  .instantiate(room_width / 2, 500, 5, 1, OMonster, WaitingMode.Destroy, {
    direction: 0, // Pass properties that will be applied to the instances
  })
  .await() // Wait for the previous event to finish
  .delay(2, updateTime) // Wait for 2 seconds
  .instantiate(room_width / 2, 500, 10, 0.5, OMonster, WaitingMode.Destroy, {
    direction: 180,
  })
  .await()
  // Run custom logic once
  .once(
    function (done, data) {
      show_debug_message(data.foo);

      done();
    },
    {
      foo: "bar",
    }
  )
  // Run custom logic every step, until done() is called or timeline is released
  .every(
    function (done, data) {
      var seconds = floor(data._secondsPassed);

      // Every second
      if (data.seconds < seconds) {
        effect_create_above(
          ef_firework,
          random(room_width),
          random(room_height),
          10,
          random(c_white)
        );

        data.seconds = seconds;
      }

      // Stop after 5 seconds
      if (seconds == 5) {
        done();
      }
    },
    {
      seconds: 0,
    }
  )
  .await(); // Wait for the previous event to finish

timeline.onFinish(function () {
  // Timeline is finished, stop processing any logic left behind by "every"
  timeline.release();
});

timeline.start();

Or how about a sequence of timelines:

sequence = new Sequence([
  new Timeline()
    .once(function (done) {
      OLog.logString("Starting a sequence of timelines");

      done();
    })
    .delay(3, updateTime)
    .await(),

  new Timeline()
    .once(function (done) {
      OLog.logString(
        "First timeline in sequence finished, second timeline started"
      );

      done();
    })
    .delay(3, updateTime)
    .await(),
]);

sequence.onFinish(function (data) {
  show_debug_message(
    "Sequence complete in " + string(data.duration / 1000) + " seconds"
  );
});

sequence.start();

Installing

Simply download GMTimeLine.yyp and drag it over to your project. A Marketplace link will come soon!

Documentation

Classes

<a name="Timeline"></a>

Timeline() ⇒ <code>Struct.Timeline</code>

Creates a new timeline

<a name="Timeline"></a>

Sequence(timelines) ⇒ <code>Struct.Sequence</code>

Creates a new sequence of timelines

Timescale

Timelines take global.timeScale into account. 1 is normal speed, 0.5 is half speed, 2 is double speed, etc.

Timeline Functions

<a name="Timeline"></a>

Timeline() ⇒ <code>Struct.Timeline</code>

Creates a new timeline

<a name="start"></a>

start() ⇒ <code>Struct.Timeline</code>

Starts/continues the timeline

<a name="await"></a>

await() ⇒ <code>Struct.Timeline</code>

Waits for previous events to finish

<a name="delay"></a>

delay(seconds, [onProgress]) ⇒ <code>Struct.Timeline</code>

Allows for a delay between events

<a name="limit"></a>

limit(seconds) ⇒ <code>Struct.Timeline</code>

Sets a time limit in seconds for a batch of events to finish

<a name="keyPress"></a>

keyPress(key) ⇒ <code>Struct.Timeline</code>

Waits for a key to be pressed

<a name="keyReleased"></a>

keyReleased(key) ⇒ <code>Struct.Timeline</code>

Waits for a key to be released

<a name="instantiate"></a>

instantiate(x, y, amount, interval, obj, mode, properties, callback) ⇒ <code>Struct.Timeline</code>

Will instantiate objects at the specified interval

WaitingMode is an enum with the following values:

Default - Will simply create the instances and consider the event finished

Destroy - Will consider the event finished when all instances are destroyed

Attention!

If you want to use the Destroy mode, you must call destroy(id) on your instances to signal the timeline that they are destroyed. The function will destroy the instance.

<a name="every"></a>

every(func, data) ⇒ <code>Struct.Timeline</code>

Allows for a function to be run every step

<a name="once"></a>

once(callback, data) ⇒ <code>Struct.Timeline</code>

Allows for a custom function to be called in between events, the function gets called back a with callback function that can be called to proceed with the timeline

<a name="onFinish"></a>

onFinish(callback) ⇒ <code>void</code>

Allow you to pass a function to be called when the timeline is finished