Editing Psai Music Engine Integration (Action)

Note: this is an integration action which will allow you to control Psai Music Engine from inside AC actionlists.

Here is the code:
 using UnityEngine;
 using psai.net;
 
 <nowiki>#</nowiki>if UNITY_EDITOR
 using UnityEditor;
 <nowiki>#endif
 
 /* Adventure Creator action class for selected Psai music engine methods */
 
 namespace AC
 {
  </nowiki>   [System.Serializable]
 <nowiki> </nowiki>   public class ActionPsai<nowiki> : Action
     {
  </nowiki>       public enum PsaiMethod
 <nowiki>        {
  </nowiki>           AddToCurrentIntensity,
 <nowiki> </nowiki>           CutSceneEnter,
 <nowiki> </nowiki>           CutSceneLeave,
 <nowiki> </nowiki>           GoToRest,
 <nowiki> </nowiki>           HoldCurrentIntensity,
 <nowiki> </nowiki>           MenuModeEnter,
 <nowiki> </nowiki>           MenuModeLeave,
 <nowiki> </nowiki>           ReturnToLastBasicMood,
 <nowiki> </nowiki>           SetPaused,
 <nowiki> </nowiki>           SetVolume,
 <nowiki> </nowiki>           StopMusic,
 <nowiki> </nowiki>           TriggerMusicTheme
 <nowiki>        }
 
  </nowiki>       public PsaiMethod selected_psai_method = PsaiMethod.AddToCurrentIntensity;
 
 <nowiki> </nowiki>       // Parameters for Psai methods
 <nowiki> </nowiki>       public float DeltaIntensity = 0f;
 <nowiki> </nowiki>       public int ThemeId = 1;
 <nowiki> </nowiki>       public float Intensity = 1f;
 <nowiki> </nowiki>       public bool Immediately = true;
 <nowiki> </nowiki>       public bool Reset = false;
 <nowiki> </nowiki>       public float FadeOutSeconds = 3f;
 <nowiki> </nowiki>       public bool HoldIntensity = true;
 <nowiki> </nowiki>       public bool Paused = true;
 <nowiki> </nowiki>       public float Volume = 1f;
 <nowiki> </nowiki>       public bool SetDuration = false;
 <nowiki> </nowiki>       public int MusicDurationInSeconds = 30;
 
 <nowiki> </nowiki>       public ActionPsai()
 <nowiki>        {
  </nowiki>           this.isDisplayed = true;
 <nowiki> </nowiki>           category = ActionCategory.ThirdParty;
 <nowiki> </nowiki>           title = "Psai";
 <nowiki> </nowiki>           description = "Run a Psai method";
 <nowiki>        }
 
  </nowiki>       override public float Run()
 <nowiki>        {
  </nowiki>           if (!PsaiCore.IsInstanceInitialized())
 <nowiki>            {
  </nowiki>               Debug.LogError("Psai instance is not initialized");
 <nowiki> </nowiki>               return 0f;
 <nowiki>            }
 
  </nowiki>           switch (selected_psai_method)
 <nowiki>            {
  </nowiki>               case PsaiMethod.AddToCurrentIntensity:
 <nowiki> </nowiki>                   return Run_AddToCurrentIntensity();
 
 <nowiki> </nowiki>               case PsaiMethod.CutSceneEnter:
 <nowiki> </nowiki>                   return Run_CutSceneEnter();
 
 <nowiki> </nowiki>               case PsaiMethod.CutSceneLeave:
 <nowiki> </nowiki>                   return Run_CutSceneLeave();
 
 <nowiki> </nowiki>               case PsaiMethod.GoToRest:
 <nowiki> </nowiki>                   return Run_GoToRest();
 
 <nowiki> </nowiki>               case PsaiMethod.HoldCurrentIntensity:
 <nowiki> </nowiki>                   return Run_HoldCurrentIntensity();
 
 <nowiki> </nowiki>               case PsaiMethod.MenuModeEnter:
 <nowiki> </nowiki>                   return Run_MenuModeEnter();
 
 <nowiki> </nowiki>               case PsaiMethod.MenuModeLeave:
 <nowiki> </nowiki>                   return Run_MenuModeLeave();
 
 <nowiki> </nowiki>               case PsaiMethod.ReturnToLastBasicMood:
 <nowiki> </nowiki>                   return Run_ReturnToLastBasicMood();
 
 <nowiki> </nowiki>               case PsaiMethod.SetPaused:
 <nowiki> </nowiki>                   return Run_SetPaused();
 
 <nowiki> </nowiki>               case PsaiMethod.SetVolume:
 <nowiki> </nowiki>                   return Run_SetVolume();
 
 <nowiki> </nowiki>               case PsaiMethod.StopMusic:
 <nowiki> </nowiki>                   return Run_StopMusic();
 
 <nowiki> </nowiki>               case PsaiMethod.TriggerMusicTheme:
 <nowiki> </nowiki>                   return Run_TriggerMusicTheme();
 
 <nowiki> </nowiki>               default:
 <nowiki> </nowiki>                   Debug.LogError("ActionPsai.cs: unknown PsaiMethod in Run");
 <nowiki> </nowiki>                   return 0f;
 <nowiki>            }
         }
 
  </nowiki>       private float Run_AddToCurrentIntensity()
 <nowiki>        {
  </nowiki>           PsaiResult result = PsaiCore.Instance.AddToCurrentIntensity(DeltaIntensity);
 
 <nowiki> </nowiki>           if (result != PsaiResult.OK)
 <nowiki>            {
  </nowiki>               Debug.LogWarning("PsaiCore.Instance.AddToCurrentIntensity returned unexpected result: " + result.ToString());
 <nowiki>            }
 
  </nowiki>           return 0f;
 <nowiki>        }
 
  </nowiki>       private float Run_CutSceneEnter()
 <nowiki>        {
  </nowiki>           PsaiResult result = PsaiCore.Instance.CutSceneEnter(ThemeId, Intensity);
 
 <nowiki> </nowiki>           switch (result)
 <nowiki>            {
  </nowiki>               case PsaiResult.OK:
 <nowiki> </nowiki>                   break;
 
 <nowiki> </nowiki>               case PsaiResult.commandIgnoredMenuModeActive:
 <nowiki> </nowiki>                   Debug.LogWarning("PsaiCore.Instance.CutSceneEnter: the command was ignored, call MenuModeLeave() first.");
 <nowiki> </nowiki>                   break;
 
 <nowiki> </nowiki>               case PsaiResult.commandIgnoredCutsceneActive:
 <nowiki> </nowiki>                   Debug.LogWarning("PsaiCore.Instance.CutSceneEnter: the command was ignored, psai is already in Cutscene Mode.");
 <nowiki> </nowiki>                   break;
 
 <nowiki> </nowiki>               default:
 <nowiki> </nowiki>                   Debug.LogWarning("PsaiCore.Instance.CutSceneEnter returned unexpected result: " + result.ToString());
 <nowiki> </nowiki>                   break;
 <nowiki>            }
 
  </nowiki>           return 0f;
 <nowiki>        }
 
  </nowiki>       private float Run_CutSceneLeave()
 <nowiki>        {
  </nowiki>           PsaiResult result = PsaiCore.Instance.CutSceneLeave(Immediately, Reset);
 
 <nowiki> </nowiki>           if (result != PsaiResult.OK)
 <nowiki>            {
  </nowiki>               Debug.LogWarning("PsaiCore.Instance.CutSceneLeave returned unexpected result: " + result.ToString());
 <nowiki>            }
 
  </nowiki>           return 0f;
 <nowiki>        }
 
  </nowiki>       private float Run_GoToRest()
 <nowiki>        {
  </nowiki>           PsaiResult result = PsaiCore.Instance.GoToRest(Immediately, FadeOutSeconds);
 
 <nowiki> </nowiki>           if (result != PsaiResult.OK)
 <nowiki>            {
  </nowiki>               Debug.LogWarning("PsaiCore.Instance.GoToRest returned unexpected result: " + result.ToString());
 <nowiki>            }
 
  </nowiki>           return 0f;
 <nowiki>        }
 
  </nowiki>       private float Run_HoldCurrentIntensity()
 <nowiki>        {
  </nowiki>           PsaiResult result = PsaiCore.Instance.HoldCurrentIntensity(HoldIntensity);
 
 <nowiki> </nowiki>           switch (result)
 <nowiki>            {
  </nowiki>               case PsaiResult.OK:
 <nowiki> </nowiki>                   break;
 
 <nowiki> </nowiki>               case PsaiResult.commandIgnored:
 <nowiki> </nowiki>                   Debug.LogWarning("PsaiCore.Instance.HoldCurrentIntensity: ignored because the intensity is already being held.");
 <nowiki> </nowiki>                   break;
 
 <nowiki> </nowiki>               case PsaiResult.commandIgnoredMenuModeActive:
 <nowiki> </nowiki>                   Debug.LogWarning("PsaiCore.Instance.HoldCurrentIntensity: the command was ignored, call MenuModeLeave() first.");
 <nowiki> </nowiki>                   break;
 
 <nowiki> </nowiki>               case PsaiResult.commandIgnoredCutsceneActive:
 <nowiki> </nowiki>                   Debug.LogWarning("PsaiCore.Instance.HoldCurrentIntensity: the command was ignored, call CutSceneLeave() first.");
 <nowiki> </nowiki>                   break;
 
 <nowiki> </nowiki>               default:
 <nowiki> </nowiki>                   Debug.LogWarning("PsaiCore.Instance.HoldCurrentIntensity returned unexpected result: " + result.ToString());
 <nowiki> </nowiki>                   break;
 <nowiki>            }
 
  </nowiki>           return 0f;
 <nowiki>        }
 
  </nowiki>       private float Run_MenuModeEnter()
 <nowiki>        {
  </nowiki>           PsaiResult result = PsaiCore.Instance.MenuModeEnter(ThemeId, Intensity);
 
 <nowiki> </nowiki>           if (result != PsaiResult.OK)
 <nowiki>            {
  </nowiki>               Debug.LogWarning("PsaiCore.Instance.MenuModeEnter returned unexpected result: " + result.ToString());
 <nowiki>            }
 
  </nowiki>           return 0f;
 <nowiki>        }
 
  </nowiki>       private float Run_MenuModeLeave()
 <nowiki>        {
  </nowiki>           PsaiResult result = PsaiCore.Instance.MenuModeLeave();
 
 <nowiki> </nowiki>           if (result != PsaiResult.OK)
 <nowiki>            {
  </nowiki>               Debug.LogWarning("PsaiCore.Instance.MenuModeLeave returned unexpected result: " + result.ToString());
 <nowiki>            }
 
  </nowiki>           return 0f;
 <nowiki>        }
 
  </nowiki>       private float Run_ReturnToLastBasicMood()
 <nowiki>        {
  </nowiki>           PsaiResult result = PsaiCore.Instance.ReturnToLastBasicMood(Immediately);
 
 <nowiki> </nowiki>           switch (result)
 <nowiki>            {
  </nowiki>               case PsaiResult.OK:
 <nowiki> </nowiki>                   break;
 
 <nowiki> </nowiki>               case PsaiResult.commandIgnoredMenuModeActive:
 <nowiki> </nowiki>                   Debug.LogWarning("PsaiCore.Instance.ReturnToLastBasicMood: the command was ignored, call MenuModeLeave() first.");
 <nowiki> </nowiki>                   break;
 
 <nowiki> </nowiki>               case PsaiResult.commandIgnored:
 <nowiki> </nowiki>                   Debug.LogWarning("PsaiCore.Instance.ReturnToLastBasicMood: the Basic Mood is already playing.");
 <nowiki> </nowiki>                   break;
 
 <nowiki> </nowiki>               default:
 <nowiki> </nowiki>                   Debug.LogWarning("PsaiCore.Instance.ReturnToLastBasicMood returned unexpected result: " + result.ToString());
 <nowiki> </nowiki>                   break;
 <nowiki>            }
 
  </nowiki>           return 0f;
 <nowiki>        }
 
  </nowiki>       private float Run_SetPaused()
 <nowiki>        {
  </nowiki>           PsaiCore.Instance.SetPaused(Paused);
 <nowiki> </nowiki>           return 0f;
 <nowiki>        }
 
  </nowiki>       private float Run_SetVolume()
 <nowiki>        {
  </nowiki>           PsaiCore.Instance.SetVolume(Volume);
 <nowiki> </nowiki>           return 0f;
 <nowiki>        }
 
  </nowiki>       private float Run_StopMusic()
 <nowiki>        {
  </nowiki>           PsaiResult result = PsaiCore.Instance.StopMusic(Immediately);
 
 <nowiki> </nowiki>           if (result != PsaiResult.OK)
 <nowiki>            {
  </nowiki>               Debug.LogWarning("PsaiCore.Instance.StopMusic returned unexpected result: " + result.ToString());
 <nowiki>            }
 
  </nowiki>           return 0f;
 <nowiki>        }
 
  </nowiki>       private float Run_TriggerMusicTheme()
 <nowiki>        {
  </nowiki>           PsaiResult result;
 
 <nowiki> </nowiki>           if (SetDuration)
 <nowiki>            {
  </nowiki>               result = PsaiCore.Instance.TriggerMusicTheme(ThemeId, Intensity, MusicDurationInSeconds);
 <nowiki>            }
  </nowiki>           else
 <nowiki>            {
  </nowiki>               result = PsaiCore.Instance.TriggerMusicTheme(ThemeId, Intensity);
 <nowiki>            }
 
  </nowiki>           switch (result)
 <nowiki>            {
  </nowiki>               case PsaiResult.OK:
 <nowiki> </nowiki>                   break;
 
 <nowiki> </nowiki>               case PsaiResult.unknown_theme:
 <nowiki> </nowiki>                   Debug.LogWarning("PsaiCore.Instance.TriggerMusicTheme: the requested Theme does not exist in the current soundtrack.");
 <nowiki> </nowiki>                   break;
 
 <nowiki> </nowiki>               case PsaiResult.commandIgnoredMenuModeActive:
 <nowiki> </nowiki>                   Debug.LogWarning("PsaiCore.Instance.TriggerMusicTheme: the command was ignored, call MenuModeLeave() first.");
 <nowiki> </nowiki>                   break;
 
 <nowiki> </nowiki>               default:
 <nowiki> </nowiki>                   Debug.LogWarning("PsaiCore.Instance.ReturnToLastBasicMood returned unexpected result: " + result.ToString());
 <nowiki> </nowiki>                   break;
 <nowiki>            }
 
  </nowiki>           return 0f;
 <nowiki>        }
 
 #</nowiki> if UNITY_EDITOR
 
 <nowiki> </nowiki>       override public void ShowGUI()
 <nowiki>        {
  </nowiki>           selected_psai_method = (PsaiMethod)EditorGUILayout.EnumPopup("Psai method", selected_psai_method);
 
 <nowiki> </nowiki>           switch (selected_psai_method)
 <nowiki>            {
  </nowiki>               case PsaiMethod.AddToCurrentIntensity:
 <nowiki> </nowiki>                   ShowGUI_AddToCurrentIntensity();
 <nowiki> </nowiki>                   break;
 
 <nowiki> </nowiki>               case PsaiMethod.CutSceneEnter:
 <nowiki> </nowiki>                   ShowGUI_CutSceneEnter();
 <nowiki> </nowiki>                   break;
 
 <nowiki> </nowiki>               case PsaiMethod.CutSceneLeave:
 <nowiki> </nowiki>                   ShowGUI_CutSceneLeave();
 <nowiki> </nowiki>                   break;
 
 <nowiki> </nowiki>               case PsaiMethod.GoToRest:
 <nowiki> </nowiki>                   ShowGUI_GoToRest();
 <nowiki> </nowiki>                   break;
 
 <nowiki> </nowiki>               case PsaiMethod.HoldCurrentIntensity:
 <nowiki> </nowiki>                   ShowGUI_HoldCurrentIntensity();
 <nowiki> </nowiki>                   break;
 
 <nowiki> </nowiki>               case PsaiMethod.MenuModeEnter:
 <nowiki> </nowiki>                   ShowGUI_MenuModeEnter();
 <nowiki> </nowiki>                   break;
 
 <nowiki> </nowiki>               case PsaiMethod.MenuModeLeave:
 <nowiki> </nowiki>                   ShowGUI_MenuModeLeave();
 <nowiki> </nowiki>                   break;
 
 <nowiki> </nowiki>               case PsaiMethod.ReturnToLastBasicMood:
 <nowiki> </nowiki>                   ShowGUI_ReturnToLastBasicMood();
 <nowiki> </nowiki>                   break;
 
 <nowiki> </nowiki>               case PsaiMethod.SetPaused:
 <nowiki> </nowiki>                   ShowGUI_SetPaused();
 <nowiki> </nowiki>                   break;
 
 <nowiki> </nowiki>               case PsaiMethod.SetVolume:
 <nowiki> </nowiki>                   ShowGUI_SetVolume();
 <nowiki> </nowiki>                   break;
 
 <nowiki> </nowiki>               case PsaiMethod.StopMusic:
 <nowiki> </nowiki>                   ShowGUI_StopMusic();
 <nowiki> </nowiki>                   break;
 
 <nowiki> </nowiki>               case PsaiMethod.TriggerMusicTheme:
 <nowiki> </nowiki>                   ShowGUI_TriggerMusicTheme();
 <nowiki> </nowiki>                   break;
 
 <nowiki> </nowiki>               default:
 <nowiki> </nowiki>                   Debug.LogError("ActionPsai.cs: unknown PsaiMethod in ShowGUI");
 <nowiki> </nowiki>                   break;
 <nowiki>            }
 
  </nowiki>           AfterRunningOption();
 <nowiki>        }
 
  </nowiki>       public override string SetLabel ()
 <nowiki>        {
  </nowiki>           string labelAdd = "Run a Psai action";
 <nowiki> </nowiki>           return labelAdd;
 <nowiki>        }
 
  </nowiki>       private void ShowGUI_AddToCurrentIntensity()
 <nowiki>        {
  </nowiki>           DeltaIntensity = EditorGUILayout.Slider("Intensity change", DeltaIntensity, -1f, 1f);
 <nowiki>        }
 
  </nowiki>       private void ShowGUI_CutSceneEnter()
 <nowiki>        {
  </nowiki>           ThemeId = EditorGUILayout.IntField("Theme id", ThemeId);
 <nowiki> </nowiki>           Intensity = EditorGUILayout.Slider("Intensity", Intensity, 0f, 1f);
 <nowiki>        }
 
  </nowiki>       private void ShowGUI_CutSceneLeave()
 <nowiki>        {
  </nowiki>           Immediately = EditorGUILayout.Toggle("Leave immediately", Immediately);
 <nowiki> </nowiki>           Reset = EditorGUILayout.Toggle("Clear theme queue", Reset);
 <nowiki>        }
 
  </nowiki>       private void ShowGUI_GoToRest()
 <nowiki>        {
  </nowiki>           Immediately = EditorGUILayout.Toggle("Go to rest immediately", Immediately);
 
 <nowiki> </nowiki>           if (!Immediately)
 <nowiki>            {
  </nowiki>               FadeOutSeconds = EditorGUILayout.FloatField("Fade-out time (secs)", FadeOutSeconds);
 <nowiki>            }
         }
 
  </nowiki>       private void ShowGUI_HoldCurrentIntensity()
 <nowiki>        {
  </nowiki>           HoldIntensity = EditorGUILayout.Toggle("Hold intensity", HoldIntensity);
 <nowiki>        }
 
  </nowiki>       private void ShowGUI_MenuModeEnter()
 <nowiki>        {
  </nowiki>           ThemeId = EditorGUILayout.IntField("Theme id", ThemeId);
 <nowiki> </nowiki>           Intensity = EditorGUILayout.Slider("Intensity", Intensity, 0f, 1f);
 <nowiki>        }
 
  </nowiki>       private void ShowGUI_MenuModeLeave()
 <nowiki>        {
  </nowiki>           // Nothing to set - but included for code consistency
 <nowiki>        }
 
  </nowiki>       private void ShowGUI_ReturnToLastBasicMood()
 <nowiki>        {
  </nowiki>           Immediately = EditorGUILayout.Toggle("Immediate return", Immediately);
 <nowiki>        }
 
  </nowiki>       private void ShowGUI_SetPaused()
 <nowiki>        {
  </nowiki>           Paused = EditorGUILayout.Toggle("Paused", Paused);
 <nowiki>        }
 
  </nowiki>       private void ShowGUI_SetVolume()
 <nowiki>        {
  </nowiki>           Volume = EditorGUILayout.Slider("Volume", Volume, 0f, 1f);
 <nowiki>        }
 
  </nowiki>       private void ShowGUI_StopMusic()
 <nowiki>        {
  </nowiki>           Immediately = EditorGUILayout.Toggle("Stop immediately", Immediately);
 <nowiki>        }
 
  </nowiki>       private void ShowGUI_TriggerMusicTheme()
 <nowiki>        {
  </nowiki>           ThemeId = EditorGUILayout.IntField("Theme id", ThemeId);
 <nowiki> </nowiki>           Intensity = EditorGUILayout.Slider("Intensity", Intensity, 0f, 1f);
 <nowiki> </nowiki>           SetDuration = EditorGUILayout.Toggle("Set duration", SetDuration);
 
 <nowiki> </nowiki>           if (SetDuration)
 <nowiki>            {
  </nowiki>               MusicDurationInSeconds = EditorGUILayout.IntField("Music duration (secs)", MusicDurationInSeconds);
 <nowiki>            }
         }
 #endif
     }
 }</nowiki>

[Code provided by user: Snebjorn]
[[Category:Integrations]]
@@ Line 1: / Line 1: @@
 Note: this is an integration action which will allow you to control Psai Music Engine from inside AC actionlists.
-There are two ways to create the script:
-Create a blank text file, paste the code, then rename the file to the name of the class and change the extension to .cs (ActionPsai.cs).
-Or
-. Create a script inside unity in the library tab named as mentioned before, then just replace the whole text in the file.
-Then, just drop this in the Actions folder in AC or make your own custom Action folder, go to the Actions manager in AC and then set the folder for custom action in there.
 Here is the code: