{"id":893,"date":"2024-09-14T19:53:59","date_gmt":"2024-09-14T11:53:59","guid":{"rendered":"https:\/\/www.huangjiaqi-mise.site\/?p=893"},"modified":"2024-09-14T23:34:16","modified_gmt":"2024-09-14T15:34:16","slug":"building-a-simulation-system-with-unity-coroutines","status":"publish","type":"post","link":"https:\/\/www.huangjiaqi-mise.site\/?p=893","title":{"rendered":"Building a Simulation System with Unity: Coroutines"},"content":{"rendered":"\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t
\n\t\t\t\n\t\t\t\t\t\t<\/span>\n\t\t<\/div>\n\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t

1. What is a Coroutine?<\/h4>

A coroutine is a special type of function that can be paused and resumed during execution, making it ideal for scenarios where you need to wait for a condition or a certain amount of time. In Unity, coroutines are commonly used to handle time delays, animations, network requests, and other tasks that shouldn\u2019t block the main thread.<\/p>

2. Basic Usage<\/h4>

(1) Starting a Coroutine:\u00a0<\/span><\/h6>

To start a coroutine, use the <\/span>StartCoroutine()<\/b>\u00a0method. Coroutines typically return an <\/span>IEnumerator<\/b>\u00a0type.<\/span><\/p>

Example: <\/span>StartCoroutine( MyCoroutine() )<\/b>;<\/span><\/p>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t

\n\t\t\t\t
\n\t\t\t\t\t
\r\n\r\nIEnumerator MyCoroutine()<\/strong>\r\n{\r\n    print(\"Starting\");\r\n    yield return new WaitForSeconds(2); \/\/ Wait for 2 seconds\r\n    print(\"Finished\");\r\n}\r\n<\/code>\r\n<\/pre>\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t
(2) Defin<\/span>ing<\/span> a Coroutine:<\/span><\/h6>
Inside a coroutine, you can use the <\/span>yield<\/b>\u00a0statement to pause execution until a condition is met or a specified time has passed.<\/span><\/p>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/section>\n\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t
3. Different yield Options:<\/h4>
Unity provides several types of yield<\/b>\u00a0instructions, the most common being:<\/p>
– yield return null;<\/b> : Continues execution in the next frame.
– yield return new WaitForSeconds(float seconds);<\/b> : Waits for the specified amount of time.
– yield return new WaitForEndOfFrame();<\/b> : Continues execution after the current frame ends.
– yield return new WaitUntil(Func predicate);<\/b> : Waits until a specified condition is true.<\/p>
4. Advantages of Coroutines<\/h4>
(a) Non-blocking Execution:<\/h6>
Coroutines allow you to run long tasks, like waiting or animations, without blocking the main thread, keeping the game running smoothly.<\/p>
(b) Easy to Write and Understand:<\/h6>
Using coroutines makes code cleaner and avoids callback hell, with logic that closely resembles sequential execution.<\/p>
(c) Flexibility:<\/h6>
Coroutines can distribute tasks across multiple frames, making them suitable for handling complex asynchronous logic.<\/p>
5. Important Considerations<\/h4>
(a) Lifecycle:<\/h6>
The coroutine\u2019s lifecycle is tied to the MonoBehaviour component that starts it. If the component is disabled or destroyed, the coroutine will automatically stop.<\/p>
(b) Performance:<\/h6>
Although coroutines are efficient, having too many running at once may impact performance, especially when a large number of coroutines are updated every frame.<\/p>
6. Example Application<\/h4>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t
\n\nusing System.Collections;<\/strong>\nusing System.Collections.Generic;<\/strong>\nusing Unity.VisualScripting;<\/strong>\nusing UnityEngine;<\/strong>\n\npublic class Test : MonoBehaviour\n{\n    bool IsWaitingA;\n    bool IsWaitingB;\n\n\n    \/\/ Start is called before the first frame update\n    void Start()\n    {\n        IsWaitingA = true;\n        IsWaitingB = true;\n        StartCoroutine(Task());\n    }\n\n    \/\/ Update is called once per frame\n    void Update()\n    {\n        if (Input.GetKeyDown(KeyCode.A))\n        {\n            IsWaitingA = false;\n        }\n\n        if (Input.GetKeyDown(KeyCode.B))\n        {\n            IsWaitingB = false;\n        }\n    }\n\n    IEnumerator Task()\n    {\n        while (IsWaitingA)\n        {\n            print(\"Waiting A\");\n            yield return null;\n        }\n        print(\"IsWaitingA ------ > OK\");\n\n        while (IsWaitingB)\n        {\n            print(\"Waiting B\");\n            yield return null;\n        }\n        print(\"IsWaitingB ------ > OK\");\n    }\n}\n<\/code>\n<\/pre>\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t
The above code demonstrates how to use coroutines to manage multiple waiting states. User input controls the flow of the coroutine, making the logic in the game more responsive.<\/p>
7. Code Breakdown<\/h4>
(1) Field Definitions:<\/h6>
bool IsWaitingA<\/b>: Controls whether the coroutine is waiting for event A.
bool IsWaitingB<\/b>: Controls whether the coroutine is waiting for event B.<\/p>
(2) Start Method:<\/h6>
\u00a0When the game starts, both IsWaitingA<\/b>\u00a0and IsWaitingB<\/b>\u00a0are initialized to true<\/b>, indicating that both events are in a waiting state.
The Task <\/b>coroutine is started.<\/p>
(3) Update Method:<\/h6>
Each frame checks whether the A or B keys are pressed.
If the A key is pressed, IsWaitingA<\/b>\u00a0is set to false<\/b>, meaning it no longer waits for event A.
If the B key is pressed, IsWaitingB<\/b>\u00a0is set to false<\/b>, meaning it no longer waits for event B.<\/p>
(4) Task Coroutine:<\/h6>
– First, it enters the while (IsWaitingA<\/b>) loop:
– As long as IsWaitingA<\/b>\u00a0is true<\/b>, it prints “Waiting A<\/b>“.
– yield return null;<\/b>\u00a0pauses execution, waiting for the next frame.
– Once the A key<\/b> is pressed and IsWaitingA<\/b>\u00a0is set to false<\/b>, the loop ends, and it prints “IsWaitingA —— > OK”<\/b><\/i>.
– Next, it enters the while (IsWaitingB)<\/b>\u00a0loop:
– As long as IsWaitingB<\/b>\u00a0is true<\/b>, it prints “Waiting B<\/b>“.
– Again, yield return null;<\/b>\u00a0pauses execution until the next frame.
– Once the B key<\/b> is pressed and IsWaitingB<\/b>\u00a0is set to false<\/b>, the loop ends, and it prints “IsWaitingB —— > OK”<\/b><\/i>.<\/p>
8. Execution Summary<\/strong><\/h4>
(1) On Start:<\/h6>
The script initializes both waiting states to true<\/b>\u00a0and starts the Task<\/b>\u00a0coroutine.<\/p>
(2) Waiting for A:<\/h6>
– The coroutine first enters the while (IsWaitingA)<\/b>\u00a0loop, continuously printing “Waiting A”<\/b>.
– Once the A key is pressed, IsWaitingA<\/b>\u00a0becomes false<\/b>, and the coroutine exits the loop, printing “IsWaitingA —— > OK”<\/b><\/i>.<\/p>
(3) Waiting for B:<\/h6>
– The coroutine then enters the while (IsWaitingB)<\/b>\u00a0loop, continuously printing “Waiting B”<\/b>.
– Once the B key is pressed, IsWaitingB<\/b>\u00a0becomes false<\/b>, and the coroutine exits the loop, printing “IsWaitingB —— > OK”<\/b><\/i>.<\/p>
This example illustrates how coroutines can be used to manage asynchronous state transitions in a game, controlled by user input. The logic is clean, sequential, and easy to follow, making coroutines a powerful tool for handling non-blocking tasks in Unity.<\/b><\/p>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t
\u3010\u4e2d\u6587\u7248\u8bf7\u70b9\u51fb\u8fd9\u91cc\u3011<\/a>
<\/p>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t
\n\t\t\t\n\t\t\t\t\t\t<\/span>\n\t\t<\/div>\n\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/section>\n\t\t\t\t<\/div>\n\t\t","protected":false},"excerpt":{"rendered":"
This example illustrates how coroutines can be used to manage asynchronous state transitions in a game, controlled by user input. The logic is clean, sequential, and easy to follow, making coroutines a powerful tool for handling non-blocking tasks in Unity.<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"site-sidebar-layout":"default","site-content-layout":"","ast-site-content-layout":"default","site-content-style":"default","site-sidebar-style":"default","ast-global-header-display":"","ast-banner-title-visibility":"","ast-main-header-display":"","ast-hfb-above-header-display":"","ast-hfb-below-header-display":"","ast-hfb-mobile-header-display":"","site-post-title":"","ast-breadcrumbs-content":"","ast-featured-img":"","footer-sml-layout":"","theme-transparent-header-meta":"default","adv-header-id-meta":"","stick-header-meta":"","header-above-stick-meta":"","header-main-stick-meta":"","header-below-stick-meta":"","astra-migrate-meta-layouts":"set","ast-page-background-enabled":"default","ast-page-background-meta":{"desktop":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"ast-content-background-meta":{"desktop":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"footnotes":""},"categories":[18],"tags":[],"class_list":["post-893","post","type-post","status-publish","format-standard","hentry","category-unity"],"_links":{"self":[{"href":"https:\/\/www.huangjiaqi-mise.site\/index.php?rest_route=\/wp\/v2\/posts\/893","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.huangjiaqi-mise.site\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.huangjiaqi-mise.site\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.huangjiaqi-mise.site\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.huangjiaqi-mise.site\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=893"}],"version-history":[{"count":28,"href":"https:\/\/www.huangjiaqi-mise.site\/index.php?rest_route=\/wp\/v2\/posts\/893\/revisions"}],"predecessor-version":[{"id":934,"href":"https:\/\/www.huangjiaqi-mise.site\/index.php?rest_route=\/wp\/v2\/posts\/893\/revisions\/934"}],"wp:attachment":[{"href":"https:\/\/www.huangjiaqi-mise.site\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=893"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.huangjiaqi-mise.site\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=893"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.huangjiaqi-mise.site\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=893"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}