Flipbook.play() should return a Future<Event>

[mnordine]

current play() returns void. I think it'd be helpful to return a Future<Event> here. It would return _completeEvent.

Then, you could do something like:

await ani.play();

// Do next thing

as opposed to:

ani.addEventListener(Event.COMPLETE, doNextThing);
ani.play();

doNextThing(Event e)
{
  // Do next thing
}

[bp74]

Thanks for the proposal. Getting a future from the play method looks natural.
But there is also a third way to write the code:

ani.play();
await ani.onComplete.first;

The "onComplete" getter returns the Event.Complete stream.
Every stream has a "first" getter to convert the stream in a future.

But still, your proposal is the easiest way to write this code. And it's not a breaking change!

[mnordine]

Yep, I was actually already doing this in my code. If we return that future it would make it even more readable.

[bp74]

I did some changes to the FlipBook class, please take a look at the new method playWith:
https://github.com/bp74/StageXL/blob/master/lib/src/display_ex/flip_book.dart#L96

Would be great if you could give it a try!

[mnordine]

lgtm. Only gripe you may get is that some people may expect juggler to be named parameter there as well, i.e.

ani.playWith(juggler: stage.juggler);

Personally, I think it's fine the way you have it, and a nice convenience function.

[bp74]

I'm still thinking about the named parameters. This is not only a thing of the Flipbook class but also all over the StageXL code. Have to think about the best way to fix or solve this.