{"id":"dolphin.authoring--dolphinAuthoringSession","name":"dolphinAuthoringSession","owner":"dolphin","package":"dolphin.authoring","kind":"class","signature":"external class dolphinAuthoringSession","description":"A dolphin authoring session record carrying document, runtime, undo, selection, mode, and related state.","context":"Represent editable scenes and graph canvases, validate edits, and manage undoable transactions.","parameters":[],"returns":"void","members":[{"name":"document","kind":"field","type":"dolphinSceneDocument","description":"Stores document as dolphinSceneDocument.","signature":"dolphinSceneDocument document","tags":["class","field","dolphin.authoring"],"updated":"2026-09-09"},{"name":"runtime","kind":"field","type":"dolphinSceneDocument","description":"Stores runtime as dolphinSceneDocument.","signature":"dolphinSceneDocument runtime","tags":["class","field","dolphin.authoring"],"updated":"2026-09-09"},{"name":"undo","kind":"field","type":"list of dolphinSceneDocument","description":"Stores undo as list of dolphinSceneDocument.","signature":"list of dolphinSceneDocument undo","tags":["class","field","dolphin.authoring"],"updated":"2026-09-09"},{"name":"selection","kind":"field","type":"list of int","description":"Stores selection as list of int.","signature":"list of int selection","tags":["class","field","dolphin.authoring"],"updated":"2026-09-09"},{"name":"mode","kind":"field","type":"int","description":"Stores mode as int.","signature":"int mode","tags":["class","field","dolphin.authoring"],"updated":"2026-09-09"},{"name":"status","kind":"field","type":"text","description":"Stores status as text.","signature":"text status","tags":["class","field","dolphin.authoring"],"updated":"2026-09-09"},{"name":"dolphinAuthoringSession","kind":"constructor","parameters":[{"name":"document","type":"dolphinSceneDocument","description":"Document."}],"returns":"void","signature":"dolphinAuthoringSession(dolphinSceneDocument document)","description":"Dolphin authoring session.","tags":["class","constructor","dolphin.authoring"],"updated":"2026-09-09"},{"name":"Selected","kind":"method","parameters":[{"name":"id","type":"int","description":"Id."}],"returns":"bool","signature":"Selected(int id) returns bool","description":"Selected.","tags":["class","method","dolphin.authoring"],"exampleId":"method-Selected-7","updated":"2026-09-09"},{"name":"Select","kind":"method","parameters":[{"name":"id","type":"int","description":"Id."},{"name":"additive","type":"bool","description":"Additive."}],"returns":"void","signature":"Select(int id,bool additive)","description":"Select.","tags":["class","method","dolphin.authoring"],"exampleId":"method-Select-8","updated":"2026-09-09"},{"name":"Commit","kind":"method","parameters":[{"name":"next","type":"dolphinSceneDocument","description":"Next."},{"name":"action","type":"text","description":"Action."}],"returns":"bool","signature":"Commit(dolphinSceneDocument next,text action) returns bool","description":"Commit.","tags":["class","method","dolphin.authoring"],"exampleId":"method-Commit-9","updated":"2026-09-09"},{"name":"Undo","kind":"method","parameters":[],"returns":"void","signature":"Undo()","description":"Undo.","tags":["class","method","dolphin.authoring"],"exampleId":"method-Undo-10","updated":"2026-09-09"},{"name":"Redo","kind":"method","parameters":[],"returns":"void","signature":"Redo()","description":"Redo.","tags":["class","method","dolphin.authoring"],"exampleId":"method-Redo-11","updated":"2026-09-09"},{"name":"Attach","kind":"method","parameters":[{"name":"component","type":"int","description":"Component."}],"returns":"bool","signature":"Attach(int component) returns bool","description":"Attach.","tags":["class","method","dolphin.authoring"],"exampleId":"method-Attach-12","updated":"2026-09-09"},{"name":"Reference","kind":"method","parameters":[{"name":"target","type":"int","description":"Target."}],"returns":"bool","signature":"Reference(int target) returns bool","description":"Reference.","tags":["class","method","dolphin.authoring"],"exampleId":"method-Reference-13","updated":"2026-09-09"},{"name":"Play","kind":"method","parameters":[],"returns":"void","signature":"Play()","description":"Play.","tags":["class","method","dolphin.authoring"],"exampleId":"method-Play-14","updated":"2026-09-09"},{"name":"Pause","kind":"method","parameters":[],"returns":"void","signature":"Pause()","description":"Pause.","tags":["class","method","dolphin.authoring"],"exampleId":"method-Pause-15","updated":"2026-09-09"},{"name":"Stop","kind":"method","parameters":[],"returns":"void","signature":"Stop()","description":"Stop.","tags":["class","method","dolphin.authoring"],"exampleId":"method-Stop-16","updated":"2026-09-09"},{"name":"Step","kind":"method","parameters":[],"returns":"void","signature":"Step()","description":"Step.","tags":["class","method","dolphin.authoring"],"exampleId":"method-Step-17","updated":"2026-09-09"}],"tags":["authoring","class","cpu","dolphin","dolphin.authoring","method","source-example"],"updated":"2026-09-09","source":{"repository":"dolphin","path":"packages/authoring/src/authoring.yh","line":160,"sha256":"f1b04c15647d6b2cca9605baa22ec4280b12cd59472c9ead754eb6ebcc4a99cc"},"status":"source-declared","notes":["Package presence and a declaration do not establish support on every host. Host services need their platform and lifecycle setup."],"examples":[{"id":"usage","title":"Use dolphinAuthoringSession","description":"A complete small caller. Values are illustrative; check the returned result and package requirements before connecting live resources.","code":"using dolphin.authoring\n\n// Represent editable scenes and graph canvases, validate edits, and manage undoable transactions.\ndolphinAuthoringSession sample = dolphinAuthoringSession(dolphinSceneDocument())\nConsole.Log(Text.From(sample.mode))\n","manifest":"manifestVersion = \"2\"\npackage = \"api.example.dolphin_authoring__dolphinauthoringsession\"\nversion = \"0.1.0\"\nlanguageEdition = \"yeho-core-2026.1\"\n\n[app]\nkind = \"headless\"\n\n[[dependencies]]\npackage = \"dolphin.authoring\"\nversion = \"0.1.0\"\npath = \"../../../dolphin/packages/authoring\"\n\n[[dependencies]]\npackage = \"dolphin.math\"\nversion = \"0.1.0\"\npath = \"../../../dolphin/packages/math\"\n\n[[dependencies]]\npackage = \"dolphin.spatial3d\"\nversion = \"0.1.0\"\npath = \"../../../dolphin/packages/spatial3d\"\n","tags":["cpu","source-example"],"verification":"type checked","run":"cpu-oracle","sha256":"7a616942fd506609c9ab1b3aee08cb3e2119268efe4089c14dfc1c4daaf4a5bc","checked":"2026-09-09","diagnostic":"","observedOutput":null,"checkedBackend":null},{"id":"method-Selected-7","title":"dolphinAuthoringSession.Selected","description":"A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.","code":"using dolphin.authoring\n\n// Selected.\ndolphinAuthoringSession instance = dolphinAuthoringSession(dolphinSceneDocument())\nint argument_id = 1\nbool result = instance.Selected(argument_id)\nConsole.Log(Text.From(result))\n","manifest":"manifestVersion = \"2\"\npackage = \"api.example.dolphin_authoring__dolphinauthoringsession\"\nversion = \"0.1.0\"\nlanguageEdition = \"yeho-core-2026.1\"\n\n[app]\nkind = \"headless\"\n\n[[dependencies]]\npackage = \"dolphin.authoring\"\nversion = \"0.1.0\"\npath = \"../../../dolphin/packages/authoring\"\n\n[[dependencies]]\npackage = \"dolphin.math\"\nversion = \"0.1.0\"\npath = \"../../../dolphin/packages/math\"\n\n[[dependencies]]\npackage = \"dolphin.spatial3d\"\nversion = \"0.1.0\"\npath = \"../../../dolphin/packages/spatial3d\"\n","tags":["cpu","method","source-example"],"run":"cpu-oracle","verification":"type checked","sha256":"f3b6d3893e7df1efa620ce86bc6e47a46d2edaa3b0b5971faf5d65431df59991","checked":"2026-09-09","diagnostic":"","observedOutput":null,"checkedBackend":null},{"id":"method-Select-8","title":"dolphinAuthoringSession.Select","description":"A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.","code":"using dolphin.authoring\n\n// Select.\ndolphinAuthoringSession instance = dolphinAuthoringSession(dolphinSceneDocument())\nint argument_id = 1\nbool argument_additive = true\ninstance.Select(argument_id, argument_additive)\nConsole.Log(\"Select completed\")\n","manifest":"manifestVersion = \"2\"\npackage = \"api.example.dolphin_authoring__dolphinauthoringsession\"\nversion = \"0.1.0\"\nlanguageEdition = \"yeho-core-2026.1\"\n\n[app]\nkind = \"headless\"\n\n[[dependencies]]\npackage = \"dolphin.authoring\"\nversion = \"0.1.0\"\npath = \"../../../dolphin/packages/authoring\"\n\n[[dependencies]]\npackage = \"dolphin.math\"\nversion = \"0.1.0\"\npath = \"../../../dolphin/packages/math\"\n\n[[dependencies]]\npackage = \"dolphin.spatial3d\"\nversion = \"0.1.0\"\npath = \"../../../dolphin/packages/spatial3d\"\n","tags":["cpu","method","source-example"],"run":"cpu-oracle","verification":"type checked","sha256":"613da28eaac39f3e6f515aa07167b0b8e4919e1787d35b4f876cbd3daa3ce42e","checked":"2026-09-09","diagnostic":"","observedOutput":null,"checkedBackend":null},{"id":"method-Commit-9","title":"dolphinAuthoringSession.Commit","description":"A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.","code":"using dolphin.authoring\n\n// Commit.\ndolphinAuthoringSession instance = dolphinAuthoringSession(dolphinSceneDocument())\ndolphinSceneDocument argument_next = dolphinSceneDocument()\ntext argument_action = \"argument action\"\nbool result = instance.Commit(argument_next, argument_action)\nConsole.Log(Text.From(result))\n","manifest":"manifestVersion = \"2\"\npackage = \"api.example.dolphin_authoring__dolphinauthoringsession\"\nversion = \"0.1.0\"\nlanguageEdition = \"yeho-core-2026.1\"\n\n[app]\nkind = \"headless\"\n\n[[dependencies]]\npackage = \"dolphin.authoring\"\nversion = \"0.1.0\"\npath = \"../../../dolphin/packages/authoring\"\n\n[[dependencies]]\npackage = \"dolphin.math\"\nversion = \"0.1.0\"\npath = \"../../../dolphin/packages/math\"\n\n[[dependencies]]\npackage = \"dolphin.spatial3d\"\nversion = \"0.1.0\"\npath = \"../../../dolphin/packages/spatial3d\"\n","tags":["cpu","method","source-example"],"run":"cpu-oracle","verification":"type checked","sha256":"9aded48c1ef55d359c34fc165fbd4cd21c8232b45a1282e8d975e69744aaf130","checked":"2026-09-09","diagnostic":"","observedOutput":null,"checkedBackend":null},{"id":"method-Undo-10","title":"dolphinAuthoringSession.Undo","description":"A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.","code":"using dolphin.authoring\n\n// Undo.\ndolphinAuthoringSession instance = dolphinAuthoringSession(dolphinSceneDocument())\ninstance.Undo()\nConsole.Log(\"Undo completed\")\n","manifest":"manifestVersion = \"2\"\npackage = \"api.example.dolphin_authoring__dolphinauthoringsession\"\nversion = \"0.1.0\"\nlanguageEdition = \"yeho-core-2026.1\"\n\n[app]\nkind = \"headless\"\n\n[[dependencies]]\npackage = \"dolphin.authoring\"\nversion = \"0.1.0\"\npath = \"../../../dolphin/packages/authoring\"\n\n[[dependencies]]\npackage = \"dolphin.math\"\nversion = \"0.1.0\"\npath = \"../../../dolphin/packages/math\"\n\n[[dependencies]]\npackage = \"dolphin.spatial3d\"\nversion = \"0.1.0\"\npath = \"../../../dolphin/packages/spatial3d\"\n","tags":["cpu","method","source-example"],"run":"cpu-oracle","verification":"type checked","sha256":"ea9b4f5a8b912434b3d3d9c41c96e32c2a8dba1651878cc559086051c3d65d35","checked":"2026-09-09","diagnostic":"","observedOutput":null,"checkedBackend":null},{"id":"method-Redo-11","title":"dolphinAuthoringSession.Redo","description":"A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.","code":"using dolphin.authoring\n\n// Redo.\ndolphinAuthoringSession instance = dolphinAuthoringSession(dolphinSceneDocument())\ninstance.Redo()\nConsole.Log(\"Redo completed\")\n","manifest":"manifestVersion = \"2\"\npackage = \"api.example.dolphin_authoring__dolphinauthoringsession\"\nversion = \"0.1.0\"\nlanguageEdition = \"yeho-core-2026.1\"\n\n[app]\nkind = \"headless\"\n\n[[dependencies]]\npackage = \"dolphin.authoring\"\nversion = \"0.1.0\"\npath = \"../../../dolphin/packages/authoring\"\n\n[[dependencies]]\npackage = \"dolphin.math\"\nversion = \"0.1.0\"\npath = \"../../../dolphin/packages/math\"\n\n[[dependencies]]\npackage = \"dolphin.spatial3d\"\nversion = \"0.1.0\"\npath = \"../../../dolphin/packages/spatial3d\"\n","tags":["cpu","method","source-example"],"run":"cpu-oracle","verification":"type checked","sha256":"0ec0e3925eabba5d2c07fc8f83adb61d21e73cd1a462153ea28d42fd5da1881a","checked":"2026-09-09","diagnostic":"","observedOutput":null,"checkedBackend":null},{"id":"method-Attach-12","title":"dolphinAuthoringSession.Attach","description":"A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.","code":"using dolphin.authoring\n\n// Attach.\ndolphinAuthoringSession instance = dolphinAuthoringSession(dolphinSceneDocument())\nint argument_component = 1\nbool result = instance.Attach(argument_component)\nConsole.Log(Text.From(result))\n","manifest":"manifestVersion = \"2\"\npackage = \"api.example.dolphin_authoring__dolphinauthoringsession\"\nversion = \"0.1.0\"\nlanguageEdition = \"yeho-core-2026.1\"\n\n[app]\nkind = \"headless\"\n\n[[dependencies]]\npackage = \"dolphin.authoring\"\nversion = \"0.1.0\"\npath = \"../../../dolphin/packages/authoring\"\n\n[[dependencies]]\npackage = \"dolphin.math\"\nversion = \"0.1.0\"\npath = \"../../../dolphin/packages/math\"\n\n[[dependencies]]\npackage = \"dolphin.spatial3d\"\nversion = \"0.1.0\"\npath = \"../../../dolphin/packages/spatial3d\"\n","tags":["cpu","method","source-example"],"run":"cpu-oracle","verification":"type checked","sha256":"a5df7663ec96d9c8e7ef8b1d49e7ac43422a4a2cf5b760883c34194aac4be9e7","checked":"2026-09-09","diagnostic":"","observedOutput":null,"checkedBackend":null},{"id":"method-Reference-13","title":"dolphinAuthoringSession.Reference","description":"A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.","code":"using dolphin.authoring\n\n// Reference.\ndolphinAuthoringSession instance = dolphinAuthoringSession(dolphinSceneDocument())\nint argument_target = 1\nbool result = instance.Reference(argument_target)\nConsole.Log(Text.From(result))\n","manifest":"manifestVersion = \"2\"\npackage = \"api.example.dolphin_authoring__dolphinauthoringsession\"\nversion = \"0.1.0\"\nlanguageEdition = \"yeho-core-2026.1\"\n\n[app]\nkind = \"headless\"\n\n[[dependencies]]\npackage = \"dolphin.authoring\"\nversion = \"0.1.0\"\npath = \"../../../dolphin/packages/authoring\"\n\n[[dependencies]]\npackage = \"dolphin.math\"\nversion = \"0.1.0\"\npath = \"../../../dolphin/packages/math\"\n\n[[dependencies]]\npackage = \"dolphin.spatial3d\"\nversion = \"0.1.0\"\npath = \"../../../dolphin/packages/spatial3d\"\n","tags":["cpu","method","source-example"],"run":"cpu-oracle","verification":"type checked","sha256":"0d4dc304fc6bd8c8d8256b931c7c573e8bc859b081238c9abc8130885011829f","checked":"2026-09-09","diagnostic":"","observedOutput":null,"checkedBackend":null},{"id":"method-Play-14","title":"dolphinAuthoringSession.Play","description":"A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.","code":"using dolphin.authoring\n\n// Play.\ndolphinAuthoringSession instance = dolphinAuthoringSession(dolphinSceneDocument())\ninstance.Play()\nConsole.Log(\"Play completed\")\n","manifest":"manifestVersion = \"2\"\npackage = \"api.example.dolphin_authoring__dolphinauthoringsession\"\nversion = \"0.1.0\"\nlanguageEdition = \"yeho-core-2026.1\"\n\n[app]\nkind = \"headless\"\n\n[[dependencies]]\npackage = \"dolphin.authoring\"\nversion = \"0.1.0\"\npath = \"../../../dolphin/packages/authoring\"\n\n[[dependencies]]\npackage = \"dolphin.math\"\nversion = \"0.1.0\"\npath = \"../../../dolphin/packages/math\"\n\n[[dependencies]]\npackage = \"dolphin.spatial3d\"\nversion = \"0.1.0\"\npath = \"../../../dolphin/packages/spatial3d\"\n","tags":["cpu","method","source-example"],"run":"cpu-oracle","verification":"type checked","sha256":"5a9574b4e51ca118733799ac2d864e17f59d4a2fe233e4fa19bd8553b470195a","checked":"2026-09-09","diagnostic":"","observedOutput":null,"checkedBackend":null},{"id":"method-Pause-15","title":"dolphinAuthoringSession.Pause","description":"A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.","code":"using dolphin.authoring\n\n// Pause.\ndolphinAuthoringSession instance = dolphinAuthoringSession(dolphinSceneDocument())\ninstance.Pause()\nConsole.Log(\"Pause completed\")\n","manifest":"manifestVersion = \"2\"\npackage = \"api.example.dolphin_authoring__dolphinauthoringsession\"\nversion = \"0.1.0\"\nlanguageEdition = \"yeho-core-2026.1\"\n\n[app]\nkind = \"headless\"\n\n[[dependencies]]\npackage = \"dolphin.authoring\"\nversion = \"0.1.0\"\npath = \"../../../dolphin/packages/authoring\"\n\n[[dependencies]]\npackage = \"dolphin.math\"\nversion = \"0.1.0\"\npath = \"../../../dolphin/packages/math\"\n\n[[dependencies]]\npackage = \"dolphin.spatial3d\"\nversion = \"0.1.0\"\npath = \"../../../dolphin/packages/spatial3d\"\n","tags":["cpu","method","source-example"],"run":"cpu-oracle","verification":"type checked","sha256":"51649c97686fb2417e1518087a123f54237ef058b35815e4338efc02bcab641a","checked":"2026-09-09","diagnostic":"","observedOutput":null,"checkedBackend":null},{"id":"method-Stop-16","title":"dolphinAuthoringSession.Stop","description":"A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.","code":"using dolphin.authoring\n\n// Stop.\ndolphinAuthoringSession instance = dolphinAuthoringSession(dolphinSceneDocument())\ninstance.Stop()\nConsole.Log(\"Stop completed\")\n","manifest":"manifestVersion = \"2\"\npackage = \"api.example.dolphin_authoring__dolphinauthoringsession\"\nversion = \"0.1.0\"\nlanguageEdition = \"yeho-core-2026.1\"\n\n[app]\nkind = \"headless\"\n\n[[dependencies]]\npackage = \"dolphin.authoring\"\nversion = \"0.1.0\"\npath = \"../../../dolphin/packages/authoring\"\n\n[[dependencies]]\npackage = \"dolphin.math\"\nversion = \"0.1.0\"\npath = \"../../../dolphin/packages/math\"\n\n[[dependencies]]\npackage = \"dolphin.spatial3d\"\nversion = \"0.1.0\"\npath = \"../../../dolphin/packages/spatial3d\"\n","tags":["cpu","method","source-example"],"run":"cpu-oracle","verification":"type checked","sha256":"cbbc6bf876b0a1ab80b9a3e5c60fa3f52c3bd5097356a6a04af596c0c3165ce0","checked":"2026-09-09","diagnostic":"","observedOutput":null,"checkedBackend":null},{"id":"method-Step-17","title":"dolphinAuthoringSession.Step","description":"A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.","code":"using dolphin.authoring\n\n// Step.\ndolphinAuthoringSession instance = dolphinAuthoringSession(dolphinSceneDocument())\ninstance.Step()\nConsole.Log(\"Step completed\")\n","manifest":"manifestVersion = \"2\"\npackage = \"api.example.dolphin_authoring__dolphinauthoringsession\"\nversion = \"0.1.0\"\nlanguageEdition = \"yeho-core-2026.1\"\n\n[app]\nkind = \"headless\"\n\n[[dependencies]]\npackage = \"dolphin.authoring\"\nversion = \"0.1.0\"\npath = \"../../../dolphin/packages/authoring\"\n\n[[dependencies]]\npackage = \"dolphin.math\"\nversion = \"0.1.0\"\npath = \"../../../dolphin/packages/math\"\n\n[[dependencies]]\npackage = \"dolphin.spatial3d\"\nversion = \"0.1.0\"\npath = \"../../../dolphin/packages/spatial3d\"\n","tags":["cpu","method","source-example"],"run":"cpu-oracle","verification":"type checked","sha256":"3999488fc97c0b96f7e6adb0a456bcb386185c136c11d0aa3965b01aa9e67d2f","checked":"2026-09-09","diagnostic":"","observedOutput":null,"checkedBackend":null}],"searchTerms":["document","runtime","undo","selection","mode","status","dolphinAuthoringSession","Selected","Select","Commit","Undo","Redo","Attach","Reference","Play","Pause","Stop","Step"],"url":"https://demonhunterlabs.com/academy/api?item=dolphin.authoring--dolphinAuthoringSession","json":"https://demonhunterlabs.com/reference/items/dolphin.authoring--dolphinAuthoringSession.json","markdown":"https://demonhunterlabs.com/reference/text/dolphin.authoring--dolphinAuthoringSession.md"}