Skip to content

burning-laboratory/unity-actions-pipeline

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

42 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Project Logo

Build Status Roadmap Link Unity Version Game Version License

About

An action management system for Unity projects.

Installation

  1. Add Burning-Lab registry to Unity Project.
  2. Add Open UPM Registry to Unity Project for importing external dependencies.
  3. Install Actions Pipeline Engine package via Unity Package Manager.

Burning-Lab Registry:

    {
      "name": "Burning-Lab Registry",
      "url": "https://packages.burning-lab.com",
      "scopes": [
        "com.burning-lab"
      ]
    }

Open UPM Registry:

    {
      "name": "Open UPM Registry",
      "url": "https://package.openupm.com",
      "scopes": [
        "com.mackysoft.serializereference-extensions"
      ]
    }

Usage Example

Typing SVG

Get more usage examples in package samples.

Custom stage example

    /// <summary>
    /// Set parent class ActionPipelineStage for any your custom actions pipeline stages.
    ///
    /// Be sure to add the Serializable attribute.
    ///
    /// If you need to specify your own path to an action in Type Menu, you can do this using the Add Type Menu attribute.
    /// </summary>
    [System.Serializable]
    [AddTypeMenu("RootFolderName/SubFolderName/Custom Action Name")]
    public class SimpleStage : ActionPipelineStage
    {
        protected override void OnInit()
        {
            base.OnInit();
            
            // Write preparing code for action running here.
        }

        protected override void OnDeInit()
        {
            base.OnDeInit();
            
            // Write the code that will be executed after the completion of the action step.
        }

        protected override void OnStart()
        {
            base.OnStart();
            
            // Write custom action logic here.
        }
    }

Distribute

Developers

License

Project Burning-Lab.ActionsPipeline is distributed under the MIT license.