DaNike
/
BeatSaber-IPA-Reloaded
mirror of https://github.com/bsmg/BeatSaber-IPA-Reloaded.git

﻿<!DOCTYPE html><!--[if IE]><![endif]--><html>    <head>    <meta charset="utf-8">    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">    <title>Class Coroutines   </title>    <meta name="viewport" content="width=device-width">    <meta name="title" content="Class Coroutines   ">    <meta name="generator" content="docfx 2.59.4.0">        <link rel="shortcut icon" href="../favicon.ico">    <link rel="stylesheet" href="../styles/docfx.vendor.css">    <link rel="stylesheet" href="../styles/docfx.css">    <link rel="stylesheet" href="../styles/main.css">    <link rel="stylesheet" href="../styles/fix.css">    <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">     <meta property="docfx:navrel" content="../toc.html">    <meta property="docfx:tocrel" content="toc.html">        <meta property="docfx:rel" content="../">    <meta property="docfx:newtab" content="true">  </head>  <body data-spy="scroll" data-target="#affix" data-offset="120">    <div id="wrapper">      <header>                <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">          <div class="container">            <div class="navbar-header">              <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">                <span class="sr-only">Toggle navigation</span>                <span class="icon-bar"></span>                <span class="icon-bar"></span>                <span class="icon-bar"></span>              </button>                            <a class="navbar-brand" href="../index.html">                <img id="logo" class="svg" src="../logo.svg" alt="">              </a>            </div>            <div class="collapse navbar-collapse" id="navbar">              <form class="navbar-form navbar-right" role="search" id="search">                <div class="form-group">                  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">                </div>              </form>            </div>          </div>        </nav>                <div class="subnav navbar navbar-default">          <div class="container hide-when-search" id="breadcrumb">            <ul class="breadcrumb">              <li></li>            </ul>          </div>        </div>      </header>      <div class="container body-content">                <div id="search-results">          <div class="search-list">Search Results for <span></span></div>          <div class="sr-items">            <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>          </div>          <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>        </div>      </div>      <div role="main" class="container body-content hide-when-search">                <div class="sidenav hide-when-search">          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>          <div class="sidetoggle collapse" id="sidetoggle">            <div id="sidetoc"></div>          </div>        </div>        <div class="article row grid-right">          <div class="col-md-10">            <article class="content wrap" id="_content" data-uid="IPA.Utilities.Async.Coroutines">      <h1 id="IPA_Utilities_Async_Coroutines" data-uid="IPA.Utilities.Async.Coroutines" class="text-break">Class Coroutines  </h1>  <div class="markdown level0 summary"><p>A class providing coroutine helpers.</p></div>  <div class="markdown level0 conceptual"></div>  <div class="inheritance">    <h5>Inheritance</h5>    <div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">Object</a></div>    <div class="level1"><span class="xref">Coroutines</span></div>  </div>  <div class="inheritedMembers">    <h5>Inherited Members</h5>    <div>      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring#system-object-tostring">Object.ToString()</a>    </div>    <div>      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">Object.Equals(Object)</a>    </div>    <div>      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">Object.Equals(Object, Object)</a>    </div>    <div>      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals#system-object-referenceequals(system-object-system-object)">Object.ReferenceEquals(Object, Object)</a>    </div>    <div>      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode#system-object-gethashcode">Object.GetHashCode()</a>    </div>    <div>      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype#system-object-gettype">Object.GetType()</a>    </div>    <div>      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone#system-object-memberwiseclone">Object.MemberwiseClone()</a>    </div>  </div>  <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Utilities.Async.html">IPA.Utilities.Async</a></h6>  <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>  <h5 id="IPA_Utilities_Async_Coroutines_syntax">Syntax</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">public static class Coroutines</code></pre>  </div>  <h3 id="methods">Methods  </h3>  <span class="small pull-right mobile-hide">    <span class="divider">|</span>    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/monomod-reorg/docs/override/new?filename=IPA_Utilities_Async_Coroutines_AsTask_System_Collections_IEnumerator_.md&amp;value=---%0Auid%3A%20IPA.Utilities.Async.Coroutines.AsTask(System.Collections.IEnumerator)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>  </span>  <span class="small pull-right mobile-hide">    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/5ed3539fe441d41c55415a69f54e7b359ebb30db/IPA.Loader/Utilities/Async/Coroutines.cs/#L54">View Source</a>  </span>  <a id="IPA_Utilities_Async_Coroutines_AsTask_" data-uid="IPA.Utilities.Async.Coroutines.AsTask*"></a>  <h4 id="IPA_Utilities_Async_Coroutines_AsTask_System_Collections_IEnumerator_" data-uid="IPA.Utilities.Async.Coroutines.AsTask(System.Collections.IEnumerator)">AsTask(IEnumerator)</h4>  <div class="markdown level1 summary"><p>Binds a <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a> to a Unity coroutine, capturing exceptions as well as the coroutine call stack.</p></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">public static Task AsTask(IEnumerator coroutine)</code></pre>  </div>  <h5 class="parameters">Parameters</h5>  <table class="table table-bordered table-striped table-condensed">    <thead>      <tr>        <th>Type</th>        <th>Name</th>        <th>Description</th>      </tr>    </thead>    <tbody>      <tr>        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.ienumerator">IEnumerator</a></td>        <td><span class="parametername">coroutine</span></td>        <td><p>the coroutine to bind to a task</p></td>      </tr>    </tbody>  </table>  <h5 class="returns">Returns</h5>  <table class="table table-bordered table-striped table-condensed">    <thead>      <tr>        <th>Type</th>        <th>Description</th>      </tr>    </thead>    <tbody>      <tr>        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a></td>        <td><p>a <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a> that completes when <code data-dev-comment-type="paramref" class="paramref">coroutine</code> completes, and fails when it throws</p></td>      </tr>    </tbody>  </table>  <h5 id="IPA_Utilities_Async_Coroutines_AsTask_System_Collections_IEnumerator__remarks">Remarks</h5>  <div class="markdown level1 remarks"><p>This may be called off of the Unity main thread. If it is, the coroutine start will be scheduled using the default<a class="xref" href="IPA.Utilities.Async.UnityMainThreadTaskScheduler.html">UnityMainThreadTaskScheduler</a> and will be run on the main thread as required by Unity.</p><p>Unity provides a handful of coroutine helpers that are not <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.ienumerable">IEnumerable</a>s. Most of these are not terriblyhelpful on their own, however <span class="xref">UnityEngine.WaitForSeconds</span> may be. Instead, prefer to use the typical .NET<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task.wait#system-threading-tasks-task-wait(system-timespan)">Wait(TimeSpan)</a> or similar overloads, or use <span class="xref">UnityEngine.WaitForSecondsRealtime</span>.</p></div>  <span class="small pull-right mobile-hide">    <span class="divider">|</span>    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/monomod-reorg/docs/override/new?filename=IPA_Utilities_Async_Coroutines_WaitForTask_System_Threading_Tasks_Task_.md&amp;value=---%0Auid%3A%20IPA.Utilities.Async.Coroutines.WaitForTask(System.Threading.Tasks.Task)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>  </span>  <span class="small pull-right mobile-hide">    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/5ed3539fe441d41c55415a69f54e7b359ebb30db/IPA.Loader/Utilities/Async/Coroutines.cs/#L21">View Source</a>  </span>  <a id="IPA_Utilities_Async_Coroutines_WaitForTask_" data-uid="IPA.Utilities.Async.Coroutines.WaitForTask*"></a>  <h4 id="IPA_Utilities_Async_Coroutines_WaitForTask_System_Threading_Tasks_Task_" data-uid="IPA.Utilities.Async.Coroutines.WaitForTask(System.Threading.Tasks.Task)">WaitForTask(Task)</h4>  <div class="markdown level1 summary"><p>Stalls the coroutine until <code data-dev-comment-type="paramref" class="paramref">task</code> completes, faults, or is canceled.</p></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">public static IEnumerator WaitForTask(Task task)</code></pre>  </div>  <h5 class="parameters">Parameters</h5>  <table class="table table-bordered table-striped table-condensed">    <thead>      <tr>        <th>Type</th>        <th>Name</th>        <th>Description</th>      </tr>    </thead>    <tbody>      <tr>        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a></td>        <td><span class="parametername">task</span></td>        <td><p>the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a> to wait for</p></td>      </tr>    </tbody>  </table>  <h5 class="returns">Returns</h5>  <table class="table table-bordered table-striped table-condensed">    <thead>      <tr>        <th>Type</th>        <th>Description</th>      </tr>    </thead>    <tbody>      <tr>        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.ienumerator">IEnumerator</a></td>        <td><p>a coroutine waiting for the given task</p></td>      </tr>    </tbody>  </table>  <span class="small pull-right mobile-hide">    <span class="divider">|</span>    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/monomod-reorg/docs/override/new?filename=IPA_Utilities_Async_Coroutines_WaitForTask_System_Threading_Tasks_Task_System_Boolean_.md&amp;value=---%0Auid%3A%20IPA.Utilities.Async.Coroutines.WaitForTask(System.Threading.Tasks.Task%2CSystem.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>  </span>  <span class="small pull-right mobile-hide">    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/5ed3539fe441d41c55415a69f54e7b359ebb30db/IPA.Loader/Utilities/Async/Coroutines.cs/#L30">View Source</a>  </span>  <a id="IPA_Utilities_Async_Coroutines_WaitForTask_" data-uid="IPA.Utilities.Async.Coroutines.WaitForTask*"></a>  <h4 id="IPA_Utilities_Async_Coroutines_WaitForTask_System_Threading_Tasks_Task_System_Boolean_" data-uid="IPA.Utilities.Async.Coroutines.WaitForTask(System.Threading.Tasks.Task,System.Boolean)">WaitForTask(Task, Boolean)</h4>  <div class="markdown level1 summary"><p>Stalls the coroutine until <code data-dev-comment-type="paramref" class="paramref">task</code> completes, faults, or is canceled.</p></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">public static IEnumerator WaitForTask(Task task, bool throwOnFault = false)</code></pre>  </div>  <h5 class="parameters">Parameters</h5>  <table class="table table-bordered table-striped table-condensed">    <thead>      <tr>        <th>Type</th>        <th>Name</th>        <th>Description</th>      </tr>    </thead>    <tbody>      <tr>        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a></td>        <td><span class="parametername">task</span></td>        <td><p>the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a> to wait for</p></td>      </tr>      <tr>        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>        <td><span class="parametername">throwOnFault</span></td>        <td><p>whether or not to throw if the task faulted</p></td>      </tr>    </tbody>  </table>  <h5 class="returns">Returns</h5>  <table class="table table-bordered table-striped table-condensed">    <thead>      <tr>        <th>Type</th>        <th>Description</th>      </tr>    </thead>    <tbody>      <tr>        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.ienumerator">IEnumerator</a></td>        <td><p>a coroutine waiting for the given task</p></td>      </tr>    </tbody>  </table></article>          </div>                    <div class="hidden-sm col-md-2" role="complementary">            <div class="sideaffix">              <div class="contribution">                <ul class="nav">                  <li>                    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/monomod-reorg/docs/override/new?filename=IPA_Utilities_Async_Coroutines.md&amp;value=---%0Auid%3A%20IPA.Utilities.Async.Coroutines%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>                  </li>                  <li>                    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/5ed3539fe441d41c55415a69f54e7b359ebb30db/IPA.Loader/Utilities/Async/Coroutines.cs/#L14" class="contribution-link">View Source</a>                  </li>                </ul>              </div>              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">                <h5>In This Article</h5>                <div></div>              </nav>            </div>          </div>        </div>      </div>            <footer>        <div class="grad-bottom"></div>        <div class="footer">          <div class="container">            <span class="pull-right">              <a href="#top">Back to top</a>            </span>                        <span>Generated by <strong>DocFX</strong></span>          </div>        </div>      </footer>    </div>        <script type="text/javascript" src="../styles/docfx.vendor.js"></script>    <script type="text/javascript" src="../styles/docfx.js"></script>    <script type="text/javascript" src="../styles/main.js"></script>  </body></html>