いまさらだけど確認しておこう Coroutine

2019/09/15に開催された「Unity非同期完全に理解した」勉強会のLT資料です。

https://connpass.com/event/95696/

1. いまさらだけど確認しておこう Coroutine @RyotaMurohoshi 2018/09/15(土) Unity非同期完全に理解した勉強会
2. 2015年3月21日
4. いやぁ～～っ！ 未来、ついに来ましたね！
5. async/await、最高ですね！ ガンガン使っていきましょう！
6. ところでちょっと 現実に、そして日常に戻りましょう
7. Unityのバージョン何ですか？ 2018系？2017系？5系？もしかして4系？
8. 『最新作を作っているバージョン』だけじゃないですよ！ 『利益を生み出しているゲームのバージョン』は何ですか！？
9. 世の中のすべてのUnityプロジェクトが （特になんの工夫もせず） async/awaitが使えるわけじゃない・・・ 使えるけれど、大人のあれで使わないってこともあるよね
10. ある程度利益を出していて大きく変更予定のないヤツ 大人の事情でUnityをアップデートできないヤツ こういうプロジェクト、まれによくある
11. 世の中の全てのUnityプロジェクトで async/awaitが使えるわけじゃない・・・
12. というわけで・・・
13. いまさらだけど確認しておこう Coroutine @RyotaMurohoshi 2018/09/15(土) Unity非同期完全に理解した勉強会
14. ※ 私の勤め先や個人ではUnity 2018やasync/await 使えますよ！
15. Coroutineがasync/awaitの代わりになるわけじゃない async/awaitが使える場所ではそっち使おう！ Rxが適切な時もあるよ！
16. けれど、それでも・・・
17. 古いプロジェクトをメンテ・改善していると Coroutineが助けてくれること、ある！ Coroutineのデバックで嵌ることも、あるかも！ 今更だけど、このタイミングで確認しておきましょう！
18. 基本的なCoroutineの使い方は 知っている前提で いくつか（みんなが知っているかもしれないけど）Tipsを話します
19. public void StartLaunchLoop() { StartCoroutine(LaunchCoroutine()); } private IEnumerator LaunchCoroutine() { // 1秒に一回 Launch が呼び出される while (true) { Launch(); yield return new WaitForSeconds(1.0F); } } private void Launch() { // 略 }
20. 「当たり前」って大切 確認していきましょう
21. その1
22. void Start() { // 入れ子のコルーチンを呼び出す StartCoroutine(ParentRoutine()); } IEnumerator ParentRoutine() { Debug.Log("start parent"); // 子コルーチンの呼び出し yield return ChildRoutine(); Debug.Log("end parent"); } IEnumerator ChildRoutine() { Debug.Log("start child"); yield return new WaitForSeconds(1.0F); Debug.Log("end child"); } 実行結果 start parent start child end child end parent ※ Unity 5.3 以降
23. その1 Coroutineの入れ子でStartCoroutineがいらないのはUnity 5.3から！ Unity 5.2とそれより前ではStartCoroutineが必要！ コンパイルエラーにならないからこそ、気を付けよう！
24. void Start() { // 入れ子のコルーチンを呼び出す StartCoroutine(ParentRoutine()); } IEnumerator ParentRoutine() { Debug.Log("start parent"); // 子コルーチンの呼び出し yield return ChildRoutine(); Debug.Log("end parent"); } IEnumerator ChildRoutine() { Debug.Log("start child"); yield return new WaitForSeconds(1.0F); Debug.Log("end child"); } 実行結果 Unity 5.3 以降 start parent start child end child end parent 実行結果 Unity 5.2 以前 start parent end parent
25. void Start() { // 入れ子のコルーチンを呼び出す StartCoroutine(ParentRoutine()); } IEnumerator ParentRoutine() { Debug.Log("start parent"); // Unity 5.2以前で子コルーチンの呼び出し // StartCoroutineが必要！ yield return StartCoroutine(ChildRoutine()); Debug.Log("end parent"); } IEnumerator ChildRoutine() { Debug.Log("start child"); yield return new WaitForSeconds(1.0F); Debug.Log("end child"); } 実行結果 start parent start child end child end parent
26. コンパイルエラーにならないからこそたちが悪い！ Unity 5.3以上になれている人が、古いプロジェクトを触って これに気が付かず、コンパイルは通るのに 「あれ、なんか思ってる挙動と違う！？」ってなるorz
27. その2
28. その2 WaitForSecondsはTime.timeScaleの影響を受ける 影響を受けたくないならば、WaitForSecondsRealtimeを使う！ 注) WaitForSecondsRealtimeはUnity 5.3から利用可能
29. IEnumerator WaitRoutine() { Debug.Log("start"); // ↓Time.timescaleの影響を受ける yield return new WaitForSeconds(1.0F); // ↓Time.timescaleの影響を受けない yield return new WaitForSecondsRealtime(1.0F); Debug.Log("end"); }
30. その3
31. その3 Unity 5.3からはWaitUntil、WaitWhile、 そしてCustomYieldInstructionを活用しよう！
32. IEnumerator BattleRoutine() { SetUiBeforeBattle(); yield return new WaitUntil(() => onReadyBattle); // onReadyBattleがtrueになったらここに到達 StartBattle(); // 略 }
33. CustomYieldInstructionを使えば、 自分でWaitUntil・WaitWhileみたいなクラスを 柔軟に作れる
34. その4
35. その4 Unity 5.2とそれより古いバージョンでも WaitUntil、WaitWhile、CustomYieldInstructionは作れる・使える ただしStartCoroutineとの併用が必要！
36. WaitUntil、WaitWhile、CustomYieldInstructionは Unity 5.3から導入された型。けどUnity 5.2以前でも自分で作れる。
37. public abstract class CustomYieldInstruction : IEnumerator { public abstract bool keepWaiting { get; } public object Current { get { return null; } } public bool MoveNext() { return keepWaiting; } public void Reset() { } } public sealed class WaitUntil : CustomYieldInstruction { Func<bool> m_Predicate; public override bool keepWaiting { get { return !m_Predicate(); } } public WaitUntil(Func<bool> predicate) { m_Predicate = predicate; } }
38. IEnumerator BattleRoutine() { SetUiBeforeBattle(); // StartCoroutineが必要なことに注意！ yield return new StartCoroutine(WaitUntil(() => onReadyBattle)); // onReadyBattleがtrueになったらここに到達 StartBattle(); // 略 }
39. その5
40. その5 StopCoroutine(Coroutine routine)が使えるのは、 Unity 2017.1から！
41. その6
42. その6 StartCoroutineしたコンポーネントがdisableになっても Coroutineは動き続ける
43. その7
44. その7 StartCoroutineしたコンポーネントが破壊されると Coroutineは止まる
45. その8
46. その8 StartCoroutineしたコンポーネントを 持つGameObjectが破壊されるとCoroutineは止まる
47. その9
48. その9 StartCoroutineしたコンポーネントを 持つGameObjectがSetActivate(false) されると Coroutineは止まる。再開もしない。
49. 「あれ何でCoroutine動かないの？」って思ったら、 コンポーネントが破壊されてないかも確認しましょう
50. その10
51. その10 StartCoroutine(IEnumerator)したCoroutineは、 StopCoroutine(string)じゃ止められない。
52. void Start() { StartCoroutine(SpawnRoutine()); } void StopSpawn() { // StartCoroutine(IEnumerator)で始めたCoroutineは、 // StopCoroutine(string)では止められない StopCoroutine("SpawnRoutine"); } IEnumerator SpawnRoutine() { // 略 }
53. その11
54. その11 あるコンポーネントにおいて StartCoroutine(string)したCoroutineが複数あって、 StopCoroutine(string) すると そのstring(メソッド名)のすべてのCoroutineが止まる
55. void Start() { // Coroutineは複数走っている StartCoroutine("SpawnRoutine"); StartCoroutine("SpawnRoutine"); } void StopSpawn() { // このコンポーネントのSpawnRoutine（文字列）がすべて止まる StopCoroutine("SpawnRoutine"); } IEnumerator SpawnRoutine() { // 略 }
56. ※ 文字列でのStartCoroutine・StopCoroutineの利用 おすすめしません
57. その12
58. その12 StopAllCoroutinesはそのコンポーネントがStartした Coroutineをすべて止める StartCoroutine(string)・StartCoroutine(IEnumerator)で始めたやつどちらもすべて。
59. その13
60. その13 StartやOnCollisionEnterなどのイベント関数も Coroutineライクに書ける
61. void OnCollisionEnter(Collision collision) { Debug.Log(collision.gameObject.name); // すぐに殺す Destroy(collision.gameObject); }
62. // voidじゃなくて、IEnumerator IEnumerator OnCollisionEnter(Collision collision) { Debug.Log(collision.gameObject.name); // 1秒待ってから殺す yield return new WaitForSeconds(1.0F); Destroy(collision.gameObject); }
63. その14
64. その14 Coroutineはコンポーネントのインスタンスに紐づく
65. その15
66. その15 Coroutineはメインスレッドで動く
67. まとめ
68. Coroutineがasync/awaitの代わりになるわけじゃない async/awaitが使える場所ではそっち使おう！ Rxが適切な時もあるよ！
69. けれど、それでも・・・
70. 古いプロジェクトをメンテ・改善していると Coroutineが助けてくれること、ある！ Coroutineのデバックで嵌ることも、あるかも！ 今更だけど、このタイミングで確認、大切ですね！
71. async / awaitはいいぞ！ Rxもいいぞ！ Coroutineもプロジェクトによっては、使う時があるよね！
72. いまさらだけど確認しておこう Coroutine @RyotaMurohoshi 2018/09/15(土) Unity非同期完全に理解した勉強会