chore: add demo script which follows README

2021-04-27 10:43:58 +09:00 · 2021-04-27 10:43:58 +09:00 · 51cc6e71e9
parent 958a8e11ab
commit 51cc6e71e9
15 changed files with 1509 additions and 0 deletions
--- a/src/UniTask/Assets/Resources.meta
+++ b/src/UniTask/Assets/Resources.meta
@ -0,0 +1,8 @@
+fileFormatVersion: 2
+guid: 8fb84ce71736dab41b0cca7ea3f5b313
+folderAsset: yes
+DefaultImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 
--- a/src/UniTask/Assets/Resources/bar.txt
+++ b/src/UniTask/Assets/Resources/bar.txt
@ -0,0 +1 @@
+bar
--- a/src/UniTask/Assets/Resources/bar.txt.meta
+++ b/src/UniTask/Assets/Resources/bar.txt.meta
@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: 9df64c494bee73b40ad3679f44bbc8c5
+TextScriptImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 
--- a/src/UniTask/Assets/Resources/baz.txt
+++ b/src/UniTask/Assets/Resources/baz.txt
@ -0,0 +1 @@
+baz
--- a/src/UniTask/Assets/Resources/baz.txt.meta
+++ b/src/UniTask/Assets/Resources/baz.txt.meta
@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: 1b9e797ec5aa031408d06d42830c6709
+TextScriptImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 
--- a/src/UniTask/Assets/Resources/foo.txt
+++ b/src/UniTask/Assets/Resources/foo.txt
@ -0,0 +1 @@
+foo
--- a/src/UniTask/Assets/Resources/foo.txt.meta
+++ b/src/UniTask/Assets/Resources/foo.txt.meta
@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: b28aa61554c736c4887674883ac049f2
+TextScriptImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 
--- a/src/UniTask/Assets/Scenes/DemoScript.cs
+++ b/src/UniTask/Assets/Scenes/DemoScript.cs
@ -0,0 +1,129 @@
+using Cysharp.Threading.Tasks;
+using System;
+using System.Collections;
+using System.Threading.Tasks;
+using UnityEngine;
+using UnityEngine.Networking;
+using UnityEngine.SceneManagement;
+using UnityEngine.UI;
+
+public class DemoScript : MonoBehaviour
+{
+    public Toggle toggle = null;
+    public Text text = null;
+
+    async Task Start()
+    {
+        text.text = "";
+        var result = await DemoAsync();
+        text.text = $"RESULT is: {result}";
+    }
+
+    async UniTask<string> DemoAsync()
+    {
+        // You can await Unity's AsyncObject
+        text.text = "loading assets";
+        var asset = await Resources.LoadAsync<TextAsset>("foo");
+        text.text = "get data from github.com";
+        var txt = (await UnityWebRequest.Get("https://github.com").SendWebRequest()).downloadHandler.text;
+        text.text = "load scene2";
+        await SceneManager.LoadSceneAsync("scene2", LoadSceneMode.Additive);
+
+        // .WithCancellation enables Cancel, GetCancellationTokenOnDestroy synchornizes with lifetime of GameObject
+        text.text = "load text asset bar";
+        var asset2 = await Resources.LoadAsync<TextAsset>("bar").WithCancellation(this.GetCancellationTokenOnDestroy());
+
+        // .ToUniTask accepts progress callback(and all options), Progress.Create is a lightweight alternative of IProgress<T>
+        text.text = "load text asset baz";
+        var asset3 = await Resources.LoadAsync<TextAsset>("baz").ToUniTask(Progress.Create<float>(x => Debug.Log(x)));
+
+        // await frame-based operation like a coroutine
+        text.text = "delay frame";
+        await UniTask.DelayFrame(100);
+
+        // replacement of yield return new WaitForSeconds/WaitForSecondsRealtime
+        text.text = "wait 3sec.";
+        await UniTask.Delay(TimeSpan.FromSeconds(3), ignoreTimeScale: false);
+
+        // yield any playerloop timing(PreUpdate, Update, LateUpdate, etc...)
+        text.text = "wait for PreLateUpdate";
+        await UniTask.Yield(PlayerLoopTiming.PreLateUpdate);
+
+        // replacement of yield return null
+        text.text = "yield";
+        await UniTask.Yield();
+        text.text = "wait nextframe";
+        await UniTask.NextFrame();
+
+        // replacement of WaitForEndOfFrame(same as UniTask.Yield(PlayerLoopTiming.LastPostLateUpdate))
+        text.text = "wait end of frame";
+        await UniTask.WaitForEndOfFrame();
+
+        // replacement of yield return new WaitForFixedUpdate(same as UniTask.Yield(PlayerLoopTiming.FixedUpdate))
+        text.text = "wait fixed update";
+        await UniTask.WaitForFixedUpdate();
+
+        // replacement of yield return WaitUntil
+        text.text = "wait for toggle => false";
+        await UniTask.WaitUntil(() => toggle.isOn == false);
+
+        // special helper of WaitUntil
+        text.text = "wait for toggle";
+        await UniTask.WaitUntilValueChanged(this, x => toggle.isOn);
+
+        // You can await IEnumerator coroutines
+        text.text = "corouting";
+        await FooCoroutineEnumerator();
+
+        // You can await a standard task
+        text.text = "run standard task";
+        await Task.Run(() => 100);
+
+        // Multithreading, run on ThreadPool under this code
+        text.text = "switch to thread pool";
+        await UniTask.SwitchToThreadPool();
+
+        /* work on ThreadPool */
+
+        // return to MainThread(same as `ObserveOnMainThread` in UniRx)
+        await UniTask.SwitchToMainThread();
+        text.text = "switch to main pool";
+
+        // get async webrequest
+        async UniTask<string> GetTextAsync(UnityWebRequest req)
+        {
+            var op = await req.SendWebRequest();
+            return op.downloadHandler.text;
+        }
+
+        var task1 = GetTextAsync(UnityWebRequest.Get("https://google.com/"));
+        var task2 = GetTextAsync(UnityWebRequest.Get("https://bing.com/"));
+        var task3 = GetTextAsync(UnityWebRequest.Get("https://yahoo.com/"));
+
+        // concurrent async-wait and get results easily by tuple syntax
+        text.text = "get data from google,bing,yahoo (concurrent)";
+        var (google, bing, yahoo) = await UniTask.WhenAll(task1, task2, task3);
+
+        // can not call same task twice. let's define again for simple demo.
+        var tasknew1 = GetTextAsync(UnityWebRequest.Get("https://google.com/"));
+        var tasknew2 = GetTextAsync(UnityWebRequest.Get("https://bing.com/"));
+        var tasknew3 = GetTextAsync(UnityWebRequest.Get("https://yahoo.com/"));
+
+        // shorthand of WhenAll, tuple can await directly.
+        text.text = "get data from google,bing,yahoo (shorthand)";
+        var (google2, bing2, yahoo2) = await (tasknew1, tasknew2, tasknew3);
+
+        // return async-value.(or you can use `UniTask`(no result), `UniTaskVoid`(fire and forget)).
+        text.text = "return asset result";
+        return (asset as TextAsset)?.text ?? throw new InvalidOperationException("Asset not found");
+    }
+
+    private IEnumerator FooCoroutineEnumerator()
+    {
+        Debug.Log("cotoutine 1");
+        yield return new WaitForSeconds(1);
+        Debug.Log("cotoutine 2");
+        yield return new WaitForSeconds(1);
+        Debug.Log("cotoutine end");
+    }
+}
--- a/src/UniTask/Assets/Scenes/DemoScript.cs.meta
+++ b/src/UniTask/Assets/Scenes/DemoScript.cs.meta
@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: 3defd278e9f50124396082efc492cb81
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 
--- a/src/UniTask/Assets/Scenes/SampleScene.unity
+++ b/src/UniTask/Assets/Scenes/SampleScene.unity
--- a/src/UniTask/Assets/Scenes/SampleScene.unity.meta
+++ b/src/UniTask/Assets/Scenes/SampleScene.unity.meta
@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: edc485cde0ff14046a21a7c2a51bb0ac
+DefaultImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 
--- a/src/UniTask/Assets/Scenes/scene2.unity
+++ b/src/UniTask/Assets/Scenes/scene2.unity
@ -0,0 +1,299 @@
+%YAML 1.1
+%TAG !u! tag:unity3d.com,2011:
+--- !u!29 &1
+OcclusionCullingSettings:
+  m_ObjectHideFlags: 0
+  serializedVersion: 2
+  m_OcclusionBakeSettings:
+    smallestOccluder: 5
+    smallestHole: 0.25
+    backfaceThreshold: 100
+  m_SceneGUID: 00000000000000000000000000000000
+  m_OcclusionCullingData: {fileID: 0}
+--- !u!104 &2
+RenderSettings:
+  m_ObjectHideFlags: 0
+  serializedVersion: 9
+  m_Fog: 0
+  m_FogColor: {r: 0.5, g: 0.5, b: 0.5, a: 1}
+  m_FogMode: 3
+  m_FogDensity: 0.01
+  m_LinearFogStart: 0
+  m_LinearFogEnd: 300
+  m_AmbientSkyColor: {r: 0.212, g: 0.227, b: 0.259, a: 1}
+  m_AmbientEquatorColor: {r: 0.114, g: 0.125, b: 0.133, a: 1}
+  m_AmbientGroundColor: {r: 0.047, g: 0.043, b: 0.035, a: 1}
+  m_AmbientIntensity: 1
+  m_AmbientMode: 0
+  m_SubtractiveShadowColor: {r: 0.42, g: 0.478, b: 0.627, a: 1}
+  m_SkyboxMaterial: {fileID: 10304, guid: 0000000000000000f000000000000000, type: 0}
+  m_HaloStrength: 0.5
+  m_FlareStrength: 1
+  m_FlareFadeSpeed: 3
+  m_HaloTexture: {fileID: 0}
+  m_SpotCookie: {fileID: 10001, guid: 0000000000000000e000000000000000, type: 0}
+  m_DefaultReflectionMode: 0
+  m_DefaultReflectionResolution: 128
+  m_ReflectionBounces: 1
+  m_ReflectionIntensity: 1
+  m_CustomReflection: {fileID: 0}
+  m_Sun: {fileID: 0}
+  m_IndirectSpecularColor: {r: 0, g: 0, b: 0, a: 1}
+  m_UseRadianceAmbientProbe: 0
+--- !u!157 &3
+LightmapSettings:
+  m_ObjectHideFlags: 0
+  serializedVersion: 11
+  m_GIWorkflowMode: 1
+  m_GISettings:
+    serializedVersion: 2
+    m_BounceScale: 1
+    m_IndirectOutputScale: 1
+    m_AlbedoBoost: 1
+    m_EnvironmentLightingMode: 0
+    m_EnableBakedLightmaps: 1
+    m_EnableRealtimeLightmaps: 0
+  m_LightmapEditorSettings:
+    serializedVersion: 12
+    m_Resolution: 2
+    m_BakeResolution: 40
+    m_AtlasSize: 1024
+    m_AO: 0
+    m_AOMaxDistance: 1
+    m_CompAOExponent: 1
+    m_CompAOExponentDirect: 0
+    m_ExtractAmbientOcclusion: 0
+    m_Padding: 2
+    m_LightmapParameters: {fileID: 0}
+    m_LightmapsBakeMode: 1
+    m_TextureCompression: 1
+    m_FinalGather: 0
+    m_FinalGatherFiltering: 1
+    m_FinalGatherRayCount: 256
+    m_ReflectionCompression: 2
+    m_MixedBakeMode: 2
+    m_BakeBackend: 1
+    m_PVRSampling: 1
+    m_PVRDirectSampleCount: 32
+    m_PVRSampleCount: 512
+    m_PVRBounces: 2
+    m_PVREnvironmentSampleCount: 256
+    m_PVREnvironmentReferencePointCount: 2048
+    m_PVRFilteringMode: 1
+    m_PVRDenoiserTypeDirect: 1
+    m_PVRDenoiserTypeIndirect: 1
+    m_PVRDenoiserTypeAO: 1
+    m_PVRFilterTypeDirect: 0
+    m_PVRFilterTypeIndirect: 0
+    m_PVRFilterTypeAO: 0
+    m_PVREnvironmentMIS: 1
+    m_PVRCulling: 1
+    m_PVRFilteringGaussRadiusDirect: 1
+    m_PVRFilteringGaussRadiusIndirect: 5
+    m_PVRFilteringGaussRadiusAO: 2
+    m_PVRFilteringAtrousPositionSigmaDirect: 0.5
+    m_PVRFilteringAtrousPositionSigmaIndirect: 2
+    m_PVRFilteringAtrousPositionSigmaAO: 1
+    m_ExportTrainingData: 0
+    m_TrainingDataDestination: TrainingData
+    m_LightProbeSampleCountMultiplier: 4
+  m_LightingDataAsset: {fileID: 0}
+  m_UseShadowmask: 1
+--- !u!196 &4
+NavMeshSettings:
+  serializedVersion: 2
+  m_ObjectHideFlags: 0
+  m_BuildSettings:
+    serializedVersion: 2
+    agentTypeID: 0
+    agentRadius: 0.5
+    agentHeight: 2
+    agentSlope: 45
+    agentClimb: 0.4
+    ledgeDropHeight: 0
+    maxJumpAcrossDistance: 0
+    minRegionArea: 2
+    manualCellSize: 0
+    cellSize: 0.16666667
+    manualTileSize: 0
+    tileSize: 256
+    accuratePlacement: 0
+    debug:
+      m_Flags: 0
+  m_NavMeshData: {fileID: 0}
+--- !u!1 &386714
+GameObject:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  serializedVersion: 6
+  m_Component:
+  - component: {fileID: 386717}
+  - component: {fileID: 386716}
+  - component: {fileID: 386715}
+  m_Layer: 0
+  m_Name: Main Camera
+  m_TagString: MainCamera
+  m_Icon: {fileID: 0}
+  m_NavMeshLayer: 0
+  m_StaticEditorFlags: 0
+  m_IsActive: 0
+--- !u!81 &386715
+AudioListener:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 386714}
+  m_Enabled: 1
+--- !u!20 &386716
+Camera:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 386714}
+  m_Enabled: 1
+  serializedVersion: 2
+  m_ClearFlags: 1
+  m_BackGroundColor: {r: 0.19215687, g: 0.3019608, b: 0.4745098, a: 0}
+  m_projectionMatrixMode: 1
+  m_GateFitMode: 2
+  m_FOVAxisMode: 0
+  m_SensorSize: {x: 36, y: 24}
+  m_LensShift: {x: 0, y: 0}
+  m_FocalLength: 50
+  m_NormalizedViewPortRect:
+    serializedVersion: 2
+    x: 0
+    y: 0
+    width: 1
+    height: 1
+  near clip plane: 0.3
+  far clip plane: 1000
+  field of view: 60
+  orthographic: 0
+  orthographic size: 5
+  m_Depth: -1
+  m_CullingMask:
+    serializedVersion: 2
+    m_Bits: 4294967295
+  m_RenderingPath: -1
+  m_TargetTexture: {fileID: 0}
+  m_TargetDisplay: 0
+  m_TargetEye: 3
+  m_HDR: 1
+  m_AllowMSAA: 1
+  m_AllowDynamicResolution: 0
+  m_ForceIntoRT: 0
+  m_OcclusionCulling: 1
+  m_StereoConvergence: 10
+  m_StereoSeparation: 0.022
+--- !u!4 &386717
+Transform:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 386714}
+  m_LocalRotation: {x: 0, y: 0, z: 0, w: 1}
+  m_LocalPosition: {x: 0, y: 1, z: -10}
+  m_LocalScale: {x: 1, y: 1, z: 1}
+  m_Children: []
+  m_Father: {fileID: 0}
+  m_RootOrder: 0
+  m_LocalEulerAnglesHint: {x: 0, y: 0, z: 0}
+--- !u!1 &172792889
+GameObject:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  serializedVersion: 6
+  m_Component:
+  - component: {fileID: 172792893}
+  - component: {fileID: 172792892}
+  - component: {fileID: 172792891}
+  - component: {fileID: 172792890}
+  m_Layer: 0
+  m_Name: Cube
+  m_TagString: Untagged
+  m_Icon: {fileID: 0}
+  m_NavMeshLayer: 0
+  m_StaticEditorFlags: 0
+  m_IsActive: 1
+--- !u!65 &172792890
+BoxCollider:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 172792889}
+  m_Material: {fileID: 0}
+  m_IsTrigger: 0
+  m_Enabled: 1
+  serializedVersion: 2
+  m_Size: {x: 1, y: 1, z: 1}
+  m_Center: {x: 0, y: 0, z: 0}
+--- !u!23 &172792891
+MeshRenderer:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 172792889}
+  m_Enabled: 1
+  m_CastShadows: 1
+  m_ReceiveShadows: 1
+  m_DynamicOccludee: 1
+  m_MotionVectors: 1
+  m_LightProbeUsage: 1
+  m_ReflectionProbeUsage: 1
+  m_RayTracingMode: 2
+  m_RenderingLayerMask: 1
+  m_RendererPriority: 0
+  m_Materials:
+  - {fileID: 10303, guid: 0000000000000000f000000000000000, type: 0}
+  m_StaticBatchInfo:
+    firstSubMesh: 0
+    subMeshCount: 0
+  m_StaticBatchRoot: {fileID: 0}
+  m_ProbeAnchor: {fileID: 0}
+  m_LightProbeVolumeOverride: {fileID: 0}
+  m_ScaleInLightmap: 1
+  m_ReceiveGI: 1
+  m_PreserveUVs: 0
+  m_IgnoreNormalsForChartDetection: 0
+  m_ImportantGI: 0
+  m_StitchLightmapSeams: 1
+  m_SelectedEditorRenderState: 3
+  m_MinimumChartSize: 4
+  m_AutoUVMaxDistance: 0.5
+  m_AutoUVMaxAngle: 89
+  m_LightmapParameters: {fileID: 0}
+  m_SortingLayerID: 0
+  m_SortingLayer: 0
+  m_SortingOrder: 0
+--- !u!33 &172792892
+MeshFilter:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 172792889}
+  m_Mesh: {fileID: 10202, guid: 0000000000000000e000000000000000, type: 0}
+--- !u!4 &172792893
+Transform:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 172792889}
+  m_LocalRotation: {x: 0, y: 0, z: 0, w: 1}
+  m_LocalPosition: {x: 0, y: 0, z: 0}
+  m_LocalScale: {x: 1, y: 1, z: 1}
+  m_Children: []
+  m_Father: {fileID: 0}
+  m_RootOrder: 1
+  m_LocalEulerAnglesHint: {x: 0, y: 0, z: 0}
--- a/src/UniTask/Assets/Scenes/scene2.unity.meta
+++ b/src/UniTask/Assets/Scenes/scene2.unity.meta
@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: 84d1cc7b4b33fa54f98a29e843b1db30
+DefaultImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 
--- a/src/UniTask/ProjectSettings/EditorBuildSettings.asset
+++ b/src/UniTask/ProjectSettings/EditorBuildSettings.asset
@ -11,4 +11,10 @@ EditorBuildSettings:
  - enabled: 1
    path: Assets/Scenes/ExceptionExamples.unity
    guid: b5fed17e3ece238439bc796d8747df5d
+  - enabled: 1
+    path: Assets/Scenes/SampleScene.unity
+    guid: edc485cde0ff14046a21a7c2a51bb0ac
+  - enabled: 1
+    path: Assets/Scenes/scene2.unity
+    guid: 84d1cc7b4b33fa54f98a29e843b1db30
  m_configObjects: {}
--- a/src/UniTask/UserSettings/EditorUserSettings.asset
+++ b/src/UniTask/UserSettings/EditorUserSettings.asset
@ -8,6 +8,9 @@ EditorUserSettings:
    RecentlyUsedScenePath-0:
      value: 22424703114646680e0b0227036c6c1118131a25340527392367083debf42d
      flags: 0
+    RecentlyUsedScenePath-1:
+      value: 22424703114646680e0b0227036c6c111b07142f1f2b233e2867083debf42d
+      flags: 0
    vcSharedLogLevel:
      value: 0d5e400f0650
      flags: 0