unity-flash-tools/Assets/FlashTools/Scripts/FTRuntime/Yields/SwfWaitExtensions.cs

namespace FTRuntime.Yields {
	public static class SwfWaitExtensions {

		// ---------------------------------------------------------------------
		//
		// WaitFor[Event]
		//
		// ---------------------------------------------------------------------

		/// <summary>Yield instruction for wait animation stop event</summary>
		/// <returns>Yield instruction for wait animation stop event</returns>
		/// <param name="ctrl">The controller</param>
		public static SwfWaitStopPlaying WaitForStopPlaying(
			this SwfClipController ctrl)
		{
			return new SwfWaitStopPlaying(ctrl);
		}

		/// <summary>Yield instruction for wait animation rewind event</summary>
		/// <returns>Yield instruction for wait animation rewind event</returns>
		/// <param name="ctrl">The controller</param>
		public static SwfWaitRewindPlaying WaitForRewindPlaying(
			this SwfClipController ctrl)
		{
			return new SwfWaitRewindPlaying(ctrl);
		}

		/// <summary>Yield instruction for wait animation stop or rewind event</summary>
		/// <returns>Yield instruction for wait animation stop or rewind event</returns>
		/// <param name="ctrl">The controller</param>
		public static SwfWaitStopOrRewindPlaying WaitForStopOrRewindPlaying(
			this SwfClipController ctrl)
		{
			return new SwfWaitStopOrRewindPlaying(ctrl);
		}

		/// <summary>Yield instruction for wait animation play event</summary>
		/// <returns>Yield instruction for wait animation play event</returns>
		/// <param name="ctrl">The controller</param>
		public static SwfWaitPlayStopped WaitForPlayStopped(
			this SwfClipController ctrl)
		{
			return new SwfWaitPlayStopped(ctrl);
		}

		// ---------------------------------------------------------------------
		//
		// PlayAndWait[Event]
		//
		// ---------------------------------------------------------------------

		/// <summary>Play with specified rewind action</summary>
		/// <returns>Yield instruction for wait animation stop event</returns>
		/// <param name="ctrl">The clip controller</param>
		/// <param name="rewind">If set to <c>true</c> rewind animation to begin frame</param>
		public static SwfWaitStopPlaying PlayAndWaitStop(
			this SwfClipController ctrl, bool rewind)
		{
			ctrl.Play(rewind);
			return WaitForStopPlaying(ctrl);
		}

		/// <summary>Changes the animation sequence and play controller with rewind</summary>
		/// <returns>Yield instruction for wait animation stop event</returns>
		/// <param name="ctrl">The clip controller</param>
		/// <param name="sequence">The new sequence</param>
		public static SwfWaitStopPlaying PlayAndWaitStop(
			this SwfClipController ctrl, string sequence)
		{
			ctrl.Play(sequence);
			return WaitForStopPlaying(ctrl);
		}

		/// <summary>Play with specified rewind action</summary>
		/// <returns>Yield instruction for wait animation rewind event</returns>
		/// <param name="ctrl">The clip controller</param>
		/// <param name="rewind">If set to <c>true</c> rewind animation to begin frame</param>
		public static SwfWaitRewindPlaying PlayAndWaitRewind(
			this SwfClipController ctrl, bool rewind)
		{
			ctrl.Play(rewind);
			return WaitForRewindPlaying(ctrl);
		}

		/// <summary>Changes the animation sequence and play controller with rewind</summary>
		/// <returns>Yield instruction for wait animation rewind event</returns>
		/// <param name="ctrl">The clip controller</param>
		/// <param name="sequence">The new sequence</param>
		public static SwfWaitRewindPlaying PlayAndWaitRewind(
			this SwfClipController ctrl, string sequence)
		{
			ctrl.Play(sequence);
			return WaitForRewindPlaying(ctrl);
		}

		/// <summary>Play with specified rewind action</summary>
		/// <returns>Yield instruction for wait animation stop or rewind event</returns>
		/// <param name="ctrl">The clip controller</param>
		/// <param name="rewind">If set to <c>true</c> rewind animation to begin frame</param>
		public static SwfWaitStopOrRewindPlaying PlayAndWaitStopOrRewind(
			this SwfClipController ctrl, bool rewind)
		{
			ctrl.Play(rewind);
			return WaitForStopOrRewindPlaying(ctrl);
		}

		/// <summary>Changes the animation sequence and play controller with rewind</summary>
		/// <returns>Yield instruction for wait animation stop or rewind event</returns>
		/// <param name="ctrl">The clip controller</param>
		/// <param name="sequence">The new sequence</param>
		public static SwfWaitStopOrRewindPlaying PlayAndWaitStopOrRewind(
			this SwfClipController ctrl, string sequence)
		{
			ctrl.Play(sequence);
			return WaitForStopOrRewindPlaying(ctrl);
		}

		// ---------------------------------------------------------------------
		//
		// GotoAndPlayAndWait[Event]
		//
		// ---------------------------------------------------------------------

		/// <summary>Changes the animation frame with plays it</summary>
		/// <returns>Yield instruction for wait animation stop event</returns>
		/// <param name="ctrl">The clip controller</param>
		/// <param name="frame">The new current frame</param>
		public static SwfWaitStopPlaying GotoAndPlayAndWaitStop(
			this SwfClipController ctrl, int frame)
		{
			ctrl.GotoAndPlay(frame);
			return WaitForStopPlaying(ctrl);
		}

		/// <summary>Changes the animation sequence and frame with plays it</summary>
		/// <returns>Yield instruction for wait animation stop event</returns>
		/// <param name="ctrl">The clip controller</param>
		/// <param name="sequence">The new sequence</param>
		/// <param name="frame">The new current frame</param>
		public static SwfWaitStopPlaying GotoAndPlayAndWaitStop(
			this SwfClipController ctrl, string sequence, int frame)
		{
			ctrl.GotoAndPlay(sequence, frame);
			return WaitForStopPlaying(ctrl);
		}

		/// <summary>Changes the animation frame with plays it</summary>
		/// <returns>Yield instruction for wait animation rewind event</returns>
		/// <param name="ctrl">The clip controller</param>
		/// <param name="frame">The new current frame</param>
		public static SwfWaitRewindPlaying GotoAndPlayAndWaitRewind(
			this SwfClipController ctrl, int frame)
		{
			ctrl.GotoAndPlay(frame);
			return WaitForRewindPlaying(ctrl);
		}

		/// <summary>Changes the animation sequence and frame with plays it</summary>
		/// <returns>Yield instruction for wait animation rewind event</returns>
		/// <param name="ctrl">The clip controller</param>
		/// <param name="sequence">The new sequence</param>
		/// <param name="frame">The new current frame</param>
		public static SwfWaitRewindPlaying GotoAndPlayAndWaitRewind(
			this SwfClipController ctrl, string sequence, int frame)
		{
			ctrl.GotoAndPlay(sequence, frame);
			return WaitForRewindPlaying(ctrl);
		}

		/// <summary>Changes the animation frame with plays it</summary>
		/// <returns>Yield instruction for wait animation stop and rewind event</returns>
		/// <param name="ctrl">The clip controller</param>
		/// <param name="frame">The new current frame</param>
		public static SwfWaitStopOrRewindPlaying GotoAndPlayAndWaitStopOrRewind(
			this SwfClipController ctrl, int frame)
		{
			ctrl.GotoAndPlay(frame);
			return WaitForStopOrRewindPlaying(ctrl);
		}

		/// <summary>Changes the animation sequence and frame with plays it</summary>
		/// <returns>Yield instruction for wait animation stop and rewind event</returns>
		/// <param name="ctrl">The clip controller</param>
		/// <param name="sequence">The new sequence</param>
		/// <param name="frame">The new current frame</param>
		public static SwfWaitStopOrRewindPlaying GotoAndPlayAndWaitStopOrRewind(
			this SwfClipController ctrl, string sequence, int frame)
		{
			ctrl.GotoAndPlay(sequence, frame);
			return WaitForStopOrRewindPlaying(ctrl);
		}

		// ---------------------------------------------------------------------
		//
		// StopAndWait[Event]
		//
		// ---------------------------------------------------------------------

		/// <summary>Stop with specified rewind action</summary>
		/// <returns>Yield instruction for wait animation play event</returns>
		/// <param name="ctrl">The clip controller</param>
		/// <param name="rewind">If set to <c>true</c> rewind animation to begin frame</param>
		public static SwfWaitPlayStopped StopAndWaitPlay(
			this SwfClipController ctrl, bool rewind)
		{
			ctrl.Stop(rewind);
			return WaitForPlayStopped(ctrl);
		}

		/// <summary>Changes the animation sequence and stop controller with rewind</summary>
		/// <returns>Yield instruction for wait animation play event</returns>
		/// <param name="ctrl">The clip controller</param>
		/// <param name="sequence">The new sequence</param>
		public static SwfWaitPlayStopped StopAndWaitPlay(
			this SwfClipController ctrl, string sequence)
		{
			ctrl.Stop(sequence);
			return WaitForPlayStopped(ctrl);
		}

		// ---------------------------------------------------------------------
		//
		// GotoAndStopAndWait[Event]
		//
		// ---------------------------------------------------------------------

		/// <summary>Changes the animation frame with stops it</summary>
		/// <returns>Yield instruction for wait animation play event</returns>
		/// <param name="ctrl">The clip controller</param>
		/// <param name="frame">The new current frame</param>
		public static SwfWaitPlayStopped GotoAndStopAndWaitPlay(
			this SwfClipController ctrl, int frame)
		{
			ctrl.GotoAndStop(frame);
			return WaitForPlayStopped(ctrl);
		}

		/// <summary>Changes the animation sequence and frame with stops it</summary>
		/// <returns>Yield instruction for wait animation play event</returns>
		/// <param name="ctrl">The clip controller</param>
		/// <param name="sequence">The new sequence</param>
		/// <param name="frame">The new current frame</param>
		public static SwfWaitPlayStopped GotoAndStopAndWaitPlay(
			this SwfClipController ctrl, string sequence, int frame)
		{
			ctrl.GotoAndStop(sequence, frame);
			return WaitForPlayStopped(ctrl);
		}
	}
}