2020-05-13 10:07:22 +08:00
<!DOCTYPE html>
<!-- [if IE]><![endif] -->
< html >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge,chrome=1" >
< title > CancellationTokenSourceExtensions Class
| UniTask < / title >
< meta name = "viewport" content = "width=device-width" >
< meta name = "title" content = "CancellationTokenSourceExtensions Class
| UniTask ">
< meta name = "generator" content = "docfx 2.51.0.0" >
< link rel = "shortcut icon" href = "../img/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/cysharp.css" >
< meta property = "docfx:navrel" content = "../toc.html" >
< meta property = "docfx:tocrel" content = "toc.html" >
< / head >
< body data-spy = "scroll" data-target = "#affix" data-offset = "120" >
< div id = "wrapper" >
< header >
< nav id = "autocollapse" class = "navbar navbar-default 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 >
< div class = "navbar-brand" >
< a href = "../" >
< img id = "logo" src = "../img/Icon.png" alt = "" >
< span > UniTask< / span >
< / a >
< / div >
< / 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 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 = "Cysharp.Threading.Tasks.CancellationTokenSourceExtensions" >
< h1 id = "Cysharp_Threading_Tasks_CancellationTokenSourceExtensions" data-uid = "Cysharp.Threading.Tasks.CancellationTokenSourceExtensions" class = "text-break" > CancellationTokenSourceExtensions Class
< / h1 >
< h6 > < strong > Namespace< / strong > : < a class = "xref" href = "Cysharp.Threading.Tasks.html" > Cysharp.Threading.Tasks< / a > < / h6 >
< h6 > < strong > Assembly< / strong > : cs.temp.dll.dll< / h6 >
< div class = "markdown level0 summary" > < / div >
< div class = "markdown level0 conceptual" > < / div >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public static class CancellationTokenSourceExtensions< / code > < / pre >
< / div >
< div class = "inheritance" >
< h5 > Inheritance< / h5 >
< span > < span class = "xref" > System.Object< / span > < / span > →
< span class = "xref" > CancellationTokenSourceExtensions< / span >
< / div >
< h3 id = "members" > Members< / h3 >
< h4 > Methods
< / h4 >
< table class = "table table-condensed" >
< thead >
< tr >
< th > Name< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
2021-02-26 15:44:25 +08:00
< a class = "xref" href = "Cysharp.Threading.Tasks.CancellationTokenSourceExtensions.html#Cysharp_Threading_Tasks_CancellationTokenSourceExtensions_CancelAfterSlim_CancellationTokenSource_System_Int32_Cysharp_Threading_Tasks_DelayType_Cysharp_Threading_Tasks_PlayerLoopTiming_" > CancelAfterSlim(CancellationTokenSource, Int32, DelayType, PlayerLoopTiming)< / a >
2020-05-13 10:07:22 +08:00
< / td >
< td class = "markdown level1 summary" > < / td >
< / tr >
< tr >
< td >
2021-02-26 15:44:25 +08:00
< a class = "xref" href = "Cysharp.Threading.Tasks.CancellationTokenSourceExtensions.html#Cysharp_Threading_Tasks_CancellationTokenSourceExtensions_CancelAfterSlim_CancellationTokenSource_System_TimeSpan_Cysharp_Threading_Tasks_DelayType_Cysharp_Threading_Tasks_PlayerLoopTiming_" > CancelAfterSlim(CancellationTokenSource, TimeSpan, DelayType, PlayerLoopTiming)< / a >
2020-05-13 10:07:22 +08:00
< / td >
< td class = "markdown level1 summary" > < / td >
< / tr >
< tr >
< td >
2021-02-26 15:44:25 +08:00
< a class = "xref" href = "Cysharp.Threading.Tasks.CancellationTokenSourceExtensions.html#Cysharp_Threading_Tasks_CancellationTokenSourceExtensions_RegisterRaiseCancelOnDestroy_CancellationTokenSource_Component_" > RegisterRaiseCancelOnDestroy(CancellationTokenSource, Component)< / a >
2020-05-13 10:07:22 +08:00
< / td >
< td class = "markdown level1 summary" > < / td >
< / tr >
< tr >
< td >
2021-02-26 15:44:25 +08:00
< a class = "xref" href = "Cysharp.Threading.Tasks.CancellationTokenSourceExtensions.html#Cysharp_Threading_Tasks_CancellationTokenSourceExtensions_RegisterRaiseCancelOnDestroy_CancellationTokenSource_GameObject_" > RegisterRaiseCancelOnDestroy(CancellationTokenSource, GameObject)< / a >
2020-05-13 10:07:22 +08:00
< / td >
< td class = "markdown level1 summary" > < / td >
< / tr >
< / tbody >
< / table >
< h3 id = "methods" > Methods
< / h3 >
< section >
< a id = "Cysharp_Threading_Tasks_CancellationTokenSourceExtensions_CancelAfterSlim_" data-uid = "Cysharp.Threading.Tasks.CancellationTokenSourceExtensions.CancelAfterSlim*" > < / a >
2021-02-26 15:44:25 +08:00
< h4 id = "Cysharp_Threading_Tasks_CancellationTokenSourceExtensions_CancelAfterSlim_CancellationTokenSource_System_Int32_Cysharp_Threading_Tasks_DelayType_Cysharp_Threading_Tasks_PlayerLoopTiming_" data-uid = "Cysharp.Threading.Tasks.CancellationTokenSourceExtensions.CancelAfterSlim(CancellationTokenSource,System.Int32,Cysharp.Threading.Tasks.DelayType,Cysharp.Threading.Tasks.PlayerLoopTiming)" > CancelAfterSlim(CancellationTokenSource, Int32, DelayType, PlayerLoopTiming)< / h4 >
2020-05-13 10:07:22 +08:00
< div class = "markdown level1 summary" > < / div >
< div class = "markdown level1 conceptual" > < / div >
< div class = "codewrapper" >
2020-06-25 22:04:27 +08:00
< pre > < code class = "lang-csharp hljs" > public static void CancelAfterSlim(this CancellationTokenSource cts, int millisecondsDelay, DelayType delayType = DelayType.DeltaTime, PlayerLoopTiming delayTiming = PlayerLoopTiming.Update)< / code > < / pre >
2020-05-13 10:07:22 +08:00
< / div >
< section >
< h5 class = "parameters" > Parameters< / h5 >
< dl class = "cysharpdocfx-valuedefinition" >
2021-02-26 15:44:25 +08:00
< dt > < span class = "parametername" > < code > cts< / code > < / span > < span class = "xref" > CancellationTokenSource< / span > < / dt >
2020-05-13 10:07:22 +08:00
< dd > < / dd >
< dt > < span class = "parametername" > < code > millisecondsDelay< / code > < / span > < span class = "xref" > System.Int32< / span > < / dt >
< dd > < / dd >
2020-06-25 22:04:27 +08:00
< dt > < span class = "parametername" > < code > delayType< / code > < / span > < a class = "xref" href = "Cysharp.Threading.Tasks.DelayType.html" > DelayType< / a > < / dt >
2020-05-13 10:07:22 +08:00
< dd > < / dd >
< dt > < span class = "parametername" > < code > delayTiming< / code > < / span > < a class = "xref" href = "Cysharp.Threading.Tasks.PlayerLoopTiming.html" > PlayerLoopTiming< / a > < / dt >
< dd > < / dd >
< / dl >
< / section >
< / section >
< section >
< a id = "Cysharp_Threading_Tasks_CancellationTokenSourceExtensions_CancelAfterSlim_" data-uid = "Cysharp.Threading.Tasks.CancellationTokenSourceExtensions.CancelAfterSlim*" > < / a >
2021-02-26 15:44:25 +08:00
< h4 id = "Cysharp_Threading_Tasks_CancellationTokenSourceExtensions_CancelAfterSlim_CancellationTokenSource_System_TimeSpan_Cysharp_Threading_Tasks_DelayType_Cysharp_Threading_Tasks_PlayerLoopTiming_" data-uid = "Cysharp.Threading.Tasks.CancellationTokenSourceExtensions.CancelAfterSlim(CancellationTokenSource,System.TimeSpan,Cysharp.Threading.Tasks.DelayType,Cysharp.Threading.Tasks.PlayerLoopTiming)" > CancelAfterSlim(CancellationTokenSource, TimeSpan, DelayType, PlayerLoopTiming)< / h4 >
2020-05-13 10:07:22 +08:00
< div class = "markdown level1 summary" > < / div >
< div class = "markdown level1 conceptual" > < / div >
< div class = "codewrapper" >
2020-06-25 22:04:27 +08:00
< pre > < code class = "lang-csharp hljs" > public static void CancelAfterSlim(this CancellationTokenSource cts, TimeSpan delayTimeSpan, DelayType delayType = DelayType.DeltaTime, PlayerLoopTiming delayTiming = PlayerLoopTiming.Update)< / code > < / pre >
2020-05-13 10:07:22 +08:00
< / div >
< section >
< h5 class = "parameters" > Parameters< / h5 >
< dl class = "cysharpdocfx-valuedefinition" >
2021-02-26 15:44:25 +08:00
< dt > < span class = "parametername" > < code > cts< / code > < / span > < span class = "xref" > CancellationTokenSource< / span > < / dt >
2020-05-13 10:07:22 +08:00
< dd > < / dd >
2020-06-18 02:41:38 +08:00
< dt > < span class = "parametername" > < code > delayTimeSpan< / code > < / span > < span class = "xref" > System.TimeSpan< / span > < / dt >
2020-05-13 10:07:22 +08:00
< dd > < / dd >
2020-06-25 22:04:27 +08:00
< dt > < span class = "parametername" > < code > delayType< / code > < / span > < a class = "xref" href = "Cysharp.Threading.Tasks.DelayType.html" > DelayType< / a > < / dt >
2020-05-13 10:07:22 +08:00
< dd > < / dd >
< dt > < span class = "parametername" > < code > delayTiming< / code > < / span > < a class = "xref" href = "Cysharp.Threading.Tasks.PlayerLoopTiming.html" > PlayerLoopTiming< / a > < / dt >
< dd > < / dd >
< / dl >
< / section >
< / section >
< section >
< a id = "Cysharp_Threading_Tasks_CancellationTokenSourceExtensions_RegisterRaiseCancelOnDestroy_" data-uid = "Cysharp.Threading.Tasks.CancellationTokenSourceExtensions.RegisterRaiseCancelOnDestroy*" > < / a >
2021-02-26 15:44:25 +08:00
< h4 id = "Cysharp_Threading_Tasks_CancellationTokenSourceExtensions_RegisterRaiseCancelOnDestroy_CancellationTokenSource_Component_" data-uid = "Cysharp.Threading.Tasks.CancellationTokenSourceExtensions.RegisterRaiseCancelOnDestroy(CancellationTokenSource,Component)" > RegisterRaiseCancelOnDestroy(CancellationTokenSource, Component)< / h4 >
2020-05-13 10:07:22 +08:00
< div class = "markdown level1 summary" > < / div >
< div class = "markdown level1 conceptual" > < / div >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public static void RegisterRaiseCancelOnDestroy(this CancellationTokenSource cts, Component component)< / code > < / pre >
< / div >
< section >
< h5 class = "parameters" > Parameters< / h5 >
< dl class = "cysharpdocfx-valuedefinition" >
2021-02-26 15:44:25 +08:00
< dt > < span class = "parametername" > < code > cts< / code > < / span > < span class = "xref" > CancellationTokenSource< / span > < / dt >
2020-05-13 10:07:22 +08:00
< dd > < / dd >
< dt > < span class = "parametername" > < code > component< / code > < / span > < span class = "xref" > Component< / span > < / dt >
< dd > < / dd >
< / dl >
< / section >
< / section >
< section >
< a id = "Cysharp_Threading_Tasks_CancellationTokenSourceExtensions_RegisterRaiseCancelOnDestroy_" data-uid = "Cysharp.Threading.Tasks.CancellationTokenSourceExtensions.RegisterRaiseCancelOnDestroy*" > < / a >
2021-02-26 15:44:25 +08:00
< h4 id = "Cysharp_Threading_Tasks_CancellationTokenSourceExtensions_RegisterRaiseCancelOnDestroy_CancellationTokenSource_GameObject_" data-uid = "Cysharp.Threading.Tasks.CancellationTokenSourceExtensions.RegisterRaiseCancelOnDestroy(CancellationTokenSource,GameObject)" > RegisterRaiseCancelOnDestroy(CancellationTokenSource, GameObject)< / h4 >
2020-05-13 10:07:22 +08:00
< div class = "markdown level1 summary" > < / div >
< div class = "markdown level1 conceptual" > < / div >
< div class = "codewrapper" >
< pre > < code class = "lang-csharp hljs" > public static void RegisterRaiseCancelOnDestroy(this CancellationTokenSource cts, GameObject gameObject)< / code > < / pre >
< / div >
< section >
< h5 class = "parameters" > Parameters< / h5 >
< dl class = "cysharpdocfx-valuedefinition" >
2021-02-26 15:44:25 +08:00
< dt > < span class = "parametername" > < code > cts< / code > < / span > < span class = "xref" > CancellationTokenSource< / span > < / dt >
2020-05-13 10:07:22 +08:00
< dd > < / dd >
< dt > < span class = "parametername" > < code > gameObject< / code > < / span > < span class = "xref" > GameObject< / span > < / dt >
< dd > < / dd >
< / dl >
< / section >
< / section >
< / article >
< / div >
< div class = "hidden-sm col-md-2" role = "complementary" >
< div class = "sideaffix" >
< nav class = "bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id = "affix" >
<!-- <p><a class="back - to - top" href="#top">Back to top</a><p> -->
< / nav >
< / div >
< / div >
< / div >
< / div >
< footer >
< div class = "footer" >
< div class = "container" >
< span class = "pull-right" >
< a href = "#top" > Back to top< / a >
< / span >
Copyright © < a href = "https://cysharp.co.jp/" > Cysharp< / a > , Inc. | < 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/docfx.override.js" > < / script >
< script type = "text/javascript" src = "../styles/main.js" > < / script >
< / body >
< / html >
