Merge pull request #16 from k-okawa/develop/add_transition_id_generator

Develop/add transition id generator

Author: k-okawa

Assets/Bg/UniTaskStateMachine/Editor/EditorWindow/SubWindow.meta

@@ -0,0 +1,37 @@
+using UnityEditor;
+using UnityEngine;
+
+namespace Bg.UniTaskStateMachine.Editor.SubWindow
+{
+    public class CodeGenerationResultWindow : EditorWindow
+    {
+        private Vector2 _scroll;
+        private string text;
+
+        public static void Open(string title, string code)
+        {
+            var window = GetWindow<CodeGenerationResultWindow>(title);
+            window.text = code;
+        }
+
+        void OnGUI()
+        {
+            EditorGUILayout.BeginVertical();
+
+            EditorGUILayout.BeginHorizontal();
+            EditorGUILayout.LabelField("GenerationResult");
+            if (GUILayout.Button("Copy"))
+            {
+                EditorGUIUtility.systemCopyBuffer = text;
+            }
+            EditorGUILayout.EndHorizontal();
+
+            _scroll = EditorGUILayout.BeginScrollView(_scroll);
+            text = EditorGUILayout.TextArea(text, EditorStyles.textArea);
+            EditorGUILayout.EndScrollView();
+            
+            
+            EditorGUILayout.EndVertical();
+        }
+    }
+}

Assets/Bg/UniTaskStateMachine/Editor/EditorWindow/SubWindow/CodeGenerationResultWindow.cs

@@ -13,6 +13,7 @@ public Toolbar(EditorWindow editorWindow)
             this.elements = new List<ToolbarElement>()
             {
                 new StateMachineField(editorWindow),
+                new TransitionIdConstantGenerator(editorWindow),
                 new ZoomSlider(editorWindow)
             };
         }

Assets/Bg/UniTaskStateMachine/Editor/EditorWindow/SubWindow/CodeGenerationResultWindow.cs.meta

@@ -0,0 +1,44 @@
+using System.Text;
+using Bg.UniTaskStateMachine.Editor.SubWindow;
+using UnityEngine;
+
+namespace Bg.UniTaskStateMachine.Editor
+{
+    public class TransitionIdConstantGenerator : ToolbarElement
+    {
+        public TransitionIdConstantGenerator(EditorWindow window) : base(window) 
+        {
+            
+        }
+        
+        public override void OnGUI(Rect rect) 
+        {
+            if (!Context.IsStateMachineLoaded)
+            {
+                return;
+            }
+
+            if (GUI.Button(new Rect(270, rect.y + 1, 180, 16), 
+                    new GUIContent("GenerateTransitionIdConst", "Generate transitionId constant code")))
+            {
+                var result = GenerateConst();
+                CodeGenerationResultWindow.Open("TransitionIdConstant", result);
+            }
+        }
+
+        private string GenerateConst()
+        {
+            var transitions = EditorWindow.Context.Graph.Cache.Transitions;
+            StringBuilder sb = new StringBuilder();
+            sb.AppendLine($"public static class {EditorWindow.Context.StateMachine.name}Const");
+            sb.AppendLine("{");
+            foreach (var transition in transitions)
+            {
+                sb.AppendLine($"    public static readonly string {transition.ID} = \"{transition.ID}\";");
+            }
+            sb.AppendLine("}");
+
+            return sb.ToString();
+        }
+    }
+}

Assets/Bg/UniTaskStateMachine/Editor/EditorWindow/Toolbar.cs

@@ -1,7 +1,7 @@
 {
     "name": "com.bg.unitaskstatemachine",
     "displayName": "UniTaskStateMachine",
-    "version": "1.0.4",
+    "version": "1.1.0",
     "unity": "2019.4",
     "description": "UniTaskStateMachine",
     "author": {

Assets/Bg/UniTaskStateMachine/Editor/EditorWindow/ToolbarElements/TransitionIdConstantGenerator.cs

@@ -43,7 +43,7 @@ RenderSettings:
 --- !u!157 &3
 LightmapSettings:
   m_ObjectHideFlags: 0
-  serializedVersion: 11
+  serializedVersion: 12
   m_GIWorkflowMode: 1
   m_GISettings:
     serializedVersion: 2
@@ -98,7 +98,8 @@ LightmapSettings:
     m_TrainingDataDestination: TrainingData
     m_LightProbeSampleCountMultiplier: 4
   m_LightingDataAsset: {fileID: 0}
-  m_UseShadowmask: 1
+  m_LightingSettings: {fileID: 4890085278179872738, guid: acfab88974ea1433caf0b01db05be33e,
+    type: 2}
 --- !u!196 &4
 NavMeshSettings:
   serializedVersion: 2
@@ -118,6 +119,8 @@ NavMeshSettings:
     manualTileSize: 0
     tileSize: 256
     accuratePlacement: 0
+    maxJobWorkers: 0
+    preserveTilesOutsideBounds: 0
     debug:
       m_Flags: 0
   m_NavMeshData: {fileID: 0}
@@ -197,6 +200,7 @@ Light:
   m_UseColorTemperature: 0
   m_BoundingSphereOverride: {x: 0, y: 0, z: 0, w: 0}
   m_UseBoundingSphereOverride: 0
+  m_UseViewFrustumForShadowCasterCull: 1
   m_ShadowRadius: 0
   m_ShadowAngle: 0
 --- !u!4 &705507995
@@ -258,13 +262,13 @@ MonoBehaviour:
       id: End
       stateComponent: {fileID: 854791544}
     transitions:
-    - id: Transition
+    - id: ToPlay
       description: 
       originStateID: Start
       targetStateID: Play
       conditionMethodName: Bg.UniTaskStateMachine.Tests.BasicSceneTest.ConditionComponent/IsInitEnd
       isNegative: 0
-    - id: Transition(3)
+    - id: ToEnd
       description: 
       originStateID: Play
       targetStateID: End
@@ -470,6 +474,7 @@ MeshRenderer:
   m_LightProbeUsage: 1
   m_ReflectionProbeUsage: 1
   m_RayTracingMode: 2
+  m_RayTraceProcedural: 0
   m_RenderingLayerMask: 1
   m_RendererPriority: 0
   m_Materials:
@@ -494,6 +499,7 @@ MeshRenderer:
   m_SortingLayerID: 0
   m_SortingLayer: 0
   m_SortingOrder: 0
+  m_AdditionalVertexStreams: {fileID: 0}
 --- !u!33 &1161249409
 MeshFilter:
   m_ObjectHideFlags: 0

Assets/Bg/UniTaskStateMachine/Editor/EditorWindow/ToolbarElements/TransitionIdConstantGenerator.cs.meta

@@ -29,7 +29,7 @@ Editorツールも提供しているので、簡単にステートを組むこ
 
 (スクリプト上で組むことも可能です)
 
-![image](https://user-images.githubusercontent.com/49301086/137613577-d510a77c-0231-4e76-bf0f-a6f16a2ae506.png)
+![image](https://user-images.githubusercontent.com/49301086/183348165-6042c870-ac33-479a-b5fa-af210f345352.png)
 
 
 ## インストール
@@ -64,6 +64,10 @@ https://github.com/k-okawa/UniTaskStateMachine.git?path=Assets/Bg/UniTaskStateMa
 openupm add com.bg.unitaskstatemachine
 ```
 
+### UnityPackage
+
+[リリースページ](https://github.com/k-okawa/UniTaskStateMachine/releases)からダウンロード可能です。
+
 ## 使い方
 ### 1.StateMachineBehaviour追加
 StateMachineBehaviourをAddComponentします。
@@ -75,7 +79,7 @@ StateMachineBehaviourをAddComponentします。
 
 またはWindow/BG UniTaskStateMachine/StateMachineGraphでグラフエディタを開くことができます。
 
-![image](https://user-images.githubusercontent.com/49301086/143770686-8efd36c8-35fc-40a5-a1ec-4862a2dda9e3.png)
+![image](https://user-images.githubusercontent.com/49301086/183349573-556b2bfb-968c-40ef-91b9-acde45bf5f65.png)
 
 ### 3.State追加方法
 #### 3-1.StateBehaviourを追加
@@ -85,6 +89,8 @@ StateMachineBehaviourがアタッチされているGameObjectにBaseStateCompone
 
 ※BaseStateComponentを直接AddComponentしないでください。
 
+※同じStateComponentを同じゲームオブジェクトにAddComponentしないでください。
+
 **例**
 ```c#
 namespace Bg.UniTaskStateMachine.Tests.BasicSceneTest
@@ -115,7 +121,7 @@ namespace Bg.UniTaskStateMachine.Tests.BasicSceneTest
 
 Graphエディタ上で右クリックし、CreateStateでState追加
 
-![image](https://user-images.githubusercontent.com/49301086/143770989-faa1a688-2ecd-4407-87d7-3e9b2a4c570a.png)
+![image](https://user-images.githubusercontent.com/49301086/183352350-6de6bec5-b304-4a1a-b668-049c6841a9eb.png)
 
 追加されているクラス名が表示され選択可能になります。
 
@@ -148,6 +154,20 @@ Stateを右クリックし、Set as Entryを選択することで設定するこ
 
 ![image](https://user-images.githubusercontent.com/49301086/143771406-b0e40166-fd07-4091-8e98-a5cac1ba83f2.png)
 
+### TriggerNextTransition
+
+トランジションに条件を指定する以外にも、IDを指定してステートを遷移させることが可能です。
+
+トランジションIDはC#のフィールド名で使用可能なアッパーキャメルケースを推奨します。
+
+すべてのトランジションIDを決めた後、GenerateTransitionIdConstボタンを使用して定数のテンプレートコードを生成できます。
+
+![image](https://user-images.githubusercontent.com/49301086/183354384-8c33ea1d-53a3-4bae-95f1-2011c0ddd660.png)
+
+最後に、"StateMachine.TriggerNextTransition(string transitionId)"を呼び出すだけで好きなタイミングでステート遷移が可能です
+
+引数に文字列を直接渡すことができますが、生成されたクラスの読み取り専用のフィールドで渡すことを推奨します。
+
 ## API Reference
 ### StateMachine
 StateMachineBehaviourのStateMachineプロパティからアクセスできます。

Assets/Bg/UniTaskStateMachine/package.json

@@ -27,7 +27,7 @@ In addition, the state transition method corresponds to the following.
 
 This package also provide an Editor tool, so you can easily create states.
 
-![image](https://user-images.githubusercontent.com/49301086/137613577-d510a77c-0231-4e76-bf0f-a6f16a2ae506.png)
+![image](https://user-images.githubusercontent.com/49301086/183348165-6042c870-ac33-479a-b5fa-af210f345352.png)
 
 
 ## Installation
@@ -60,6 +60,10 @@ https://github.com/k-okawa/UniTaskStateMachine.git?path=Assets/Bg/UniTaskStateMa
 openupm add com.bg.unitaskstatemachine
 ```
 
+### UnityPackage
+
+You can download unity package in [release page](https://github.com/k-okawa/UniTaskStateMachine/releases).
+
 ## How to use
 ### 1.Add StateMachineBehaviour Component
 
@@ -71,7 +75,7 @@ GraphEditorOpen of StateMachineBehaviour added in 1
 
 Or you can open the graph editor with Window / BG UniTaskStateMachine / StateMachineGraph.
 
-![image](https://user-images.githubusercontent.com/49301086/143770686-8efd36c8-35fc-40a5-a1ec-4862a2dda9e3.png)
+![image](https://user-images.githubusercontent.com/49301086/183349573-556b2bfb-968c-40ef-91b9-acde45bf5f65.png)
 
 ### 3.How to add state
 #### 3-1.Add StateBehaviour
@@ -83,6 +87,8 @@ Add a Component that inherits BaseStateComponent to the GameObject to which Stat
 
 * Do not addBaseStateComponent directly.
 
+* Do not add same state component
+
 **Example**
 ```c#
 namespace Bg.UniTaskStateMachine.Tests.BasicSceneTest
@@ -113,7 +119,7 @@ namespace Bg.UniTaskStateMachine.Tests.BasicSceneTest
 
 Right-click on the Graph editor and select Create State to add State.
 
-![image](https://user-images.githubusercontent.com/49301086/143770989-faa1a688-2ecd-4407-87d7-3e9b2a4c570a.png)
+![image](https://user-images.githubusercontent.com/49301086/183352350-6de6bec5-b304-4a1a-b668-049c6841a9eb.png)
 
 The added class name will be displayed and can be selected.
 
@@ -149,6 +155,20 @@ It can be set by right-clicking on the State and selecting Set as Entry.
 
 ![image](https://user-images.githubusercontent.com/49301086/143771406-b0e40166-fd07-4091-8e98-a5cac1ba83f2.png)
 
+### TriggerNextTransition
+
+It is possible to translate state manually by transition id without specify condition method.
+
+Transition id is recommended upper camel case that can use in C# field name.
+
+After define transition id, you can generate transition id constant template code by GenerateTransitionIdConst button.
+
+![image](https://user-images.githubusercontent.com/49301086/183354384-8c33ea1d-53a3-4bae-95f1-2011c0ddd660.png)
+
+Finally, call "StateMachine.TriggerNextTransition(string transitionId)" for manual state transition.
+
+It is able to call with string direct writing, but recommend with readonly string field in the generated template class.
+
 ## API Reference
 ### StateMachine
 It can be accessed from the StateMachine property of the StateMachineBehaviour.