{"id":13663751,"url":"https://github.com/mkmarek/unity-sagas","last_synced_at":"2025-04-25T17:33:02.323Z","repository":{"id":118803926,"uuid":"92627261","full_name":"mkmarek/unity-sagas","owner":"mkmarek","description":"Port of https://github.com/redux-saga/redux-saga to C# for Unity3d coroutines","archived":true,"fork":false,"pushed_at":"2017-05-29T20:52:08.000Z","size":62,"stargazers_count":12,"open_issues_count":1,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-08-03T05:19:31.523Z","etag":null,"topics":["effects","sagas","unity3d"],"latest_commit_sha":null,"homepage":null,"language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mkmarek.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2017-05-27T22:23:28.000Z","updated_at":"2023-05-28T21:31:25.000Z","dependencies_parsed_at":null,"dependency_job_id":"31a1070a-4a41-48ff-8eaa-97c3d84eb601","html_url":"https://github.com/mkmarek/unity-sagas","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkmarek%2Funity-sagas","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkmarek%2Funity-sagas/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkmarek%2Funity-sagas/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkmarek%2Funity-sagas/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mkmarek","download_url":"https://codeload.github.com/mkmarek/unity-sagas/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224011654,"owners_count":17240983,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["effects","sagas","unity3d"],"created_at":"2024-08-02T05:02:36.115Z","updated_at":"2025-04-25T17:33:02.316Z","avatar_url":"https://github.com/mkmarek.png","language":"C#","funding_links":[],"categories":["C\\#"],"sub_categories":[],"readme":"# unity-sagas\nPort of https://github.com/redux-saga/redux-saga to C# for Unity3d coroutines. This project is currently in POC phase. Any contributions or ideas are welcomed!\n\n## Examples\n\n### Put\n\nAllows to invoke SagaAction that can be received by multiple other sagas\n\n```csharp\nprivate IEnumerator RootSaga()\n{\n  yield return Do.Put(new SagaAction\u003cint\u003e(\"ACTION_NAME\", 42));\n}\n\nvoid Start ()\n{\n  var saga = new Saga();\n\n  saga.OnActionEvent += Saga_OnActionEvent;\n\n  this.StartCoroutine(saga.Run(this.RootSaga()));\n}\n\nprivate void Saga_OnActionEvent(SagaAction data)\n{\n  Debug.Log(\"The answer is: \" + data.GetPayload\u003cint\u003e());\n}\n```\n\n### Take\n\nAllows to wait for SagaAction to be invoked and then continues execution\n\n```csharp\nprivate IEnumerator RootSaga()\n{\n  yield return Do.Take(\"START\", action);\n}\n\nvoid Start ()\n{\n  var saga = new Saga();\n  \n  this.StartCoroutine(saga.Run(this.RootSaga()));\n  \n  //nothing happens until following line executes\n  saga.OnAction(new SagaAction\u003cint\u003e(\"START\", 11));\n}\n```\n\n### Call\n\nInvokes method with a set of parameters\n\n```csharp\nprivate int TestCallMethod(params object[] args)\n{\n  return 1;\n}\n\nprivate IEnumerator RootSaga()\n{\n  var returnData = new Ref\u003cint\u003e();\n\n  yield return Do.Call(TestCallMethod, returnData);\n}\n\nvoid Start ()\n{\n  var saga = new Saga();\n  \n  this.StartCoroutine(saga.Run(this.RootSaga()));\n}\n```\n\n### ThreadCall\n\nInvokes method with a set of parameters in a separate thread and waits for the result in a non-blocking manner\n\n```csharp\nprivate int TestCallMethod(params object[] args)\n{\n  Thread.Sleep(4000);\n  return 1;\n}\n\nprivate IEnumerator RootSaga()\n{\n  var returnData = new Ref\u003cint\u003e();\n\n  yield return Do.ThreadCall(TestCallMethod, returnData);\n}\n\nvoid Start ()\n{\n  var saga = new Saga();\n  \n  this.StartCoroutine(saga.Run(this.RootSaga()));\n}\n```\n\n### Try\n\nYields in try/catch can be tricky. This methods tries to solve that.\n\n```csharp\nprivate int TestCallMethod(params object[] args)\n{\n  throw new NotImplementedException();\n}\n\nprivate IEnumerator DoStuff()\n{\n  var data = new Ref\u003cint\u003e();\n\n  yield return Do.Call(TestCallMethod, data);\n\n  yield return Do.Put\u003cint\u003e(new SagaAction\u003cint\u003e(\"SUCCESS\", data.Value));\n}\n\nprivate IEnumerator CatchRoutine(Exception exception)\n{\n  yield return Do.Put(new SagaAction\u003cException\u003e(\"ERROR\", exception));\n}\n\nprivate IEnumerator FinallyRoutine()\n{\n  yield return Do.Put(new SagaAction\u003cint\u003e(\"FINALLY\", 1));\n}\n\nprivate IEnumerator RootSaga()\n{\n  yield return Do.Try(DoStuff(), CatchRoutine, FinallyRoutine());\n}\n\nvoid Start ()\n{\n  var saga = new Saga();\n  \n  saga.OnActionEvent += Saga_OnActionEvent;\n  \n  this.StartCoroutine(saga.Run(this.RootSaga()));\n}\n\nprivate void Saga_OnActionEvent(SagaAction data)\n{\n  Debug.Log(\"INVOKED_ACTION: \" + data.Type);\n  // prints out:\n  // \"INVOKED_ACTION: ERROR\"\n  // \"INVOKED_ACTION: FINALLY\"\n}\n\n```\n\n### Fork\n\nForks saga into a separate \"subprocess\" allowing to run multiple sagas simultaneously.\n\n```csharp\nprivate IEnumerator SagaWithTake()\n{\n  var action = new Ref\u003cSagaAction\u003e();\n  yield return Do.Take(\"TEST\", action);\n\n  yield return Do.Put(new SagaAction\u003cint\u003e(\"RESULT\", action.Value.GetPayload\u003cint\u003e()));\n}\n\nprivate IEnumerator SagaWithPut()\n{\n  yield return Do.Put(new SagaAction\u003cint\u003e(\"TEST\", 123));\n}\n\nprivate IEnumerator RootSaga()\n{\n  yield return Do.Fork(SagaWithTake());\n\n  yield return Do.Fork(SagaWithPut());\n}\n\nvoid Start ()\n{\n  var saga = new Saga();\n  \n  this.StartCoroutine(saga.Run(this.RootSaga()));\n}\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkmarek%2Funity-sagas","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmkmarek%2Funity-sagas","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkmarek%2Funity-sagas/lists"}