You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

54 lines
1.8 KiB

5 years ago
5 years ago
5 years ago
  1. using UnityEngine.SceneManagement;
  2. // ReSharper disable CheckNamespace
  3. namespace IPA
  4. {
  5. /// <summary>
  6. /// Interface for Beat Saber plugins. Every class that implements this will be loaded if the DLL is placed at
  7. /// data/Managed/Plugins.
  8. /// </summary>
  9. public interface IBeatSaberPlugin
  10. {
  11. /// <summary>
  12. /// Gets invoked when the application is started.
  13. ///
  14. /// THIS EVENT WILL NOT BE GUARANTEED TO FIRE. USE Init OR <see cref="IDisablablePlugin.OnEnable"/> INSTEAD.
  15. /// </summary>
  16. void OnApplicationStart();
  17. /// <summary>
  18. /// Gets invoked when the application is closed.
  19. /// </summary>
  20. void OnApplicationQuit();
  21. /// <summary>
  22. /// Gets invoked on every graphic update.
  23. /// </summary>
  24. void OnUpdate();
  25. /// <summary>
  26. /// Gets invoked on ever physics update.
  27. /// </summary>
  28. void OnFixedUpdate();
  29. /// <summary>
  30. /// Gets invoked whenever a scene is loaded.
  31. /// </summary>
  32. /// <param name="scene">The scene currently loaded</param>
  33. /// <param name="sceneMode">The type of loading</param>
  34. void OnSceneLoaded(Scene scene, LoadSceneMode sceneMode);
  35. /// <summary>
  36. /// Gets invoked whenever a scene is unloaded
  37. /// </summary>
  38. /// <param name="scene">The unloaded scene</param>
  39. void OnSceneUnloaded(Scene scene);
  40. /// <summary>
  41. /// Gets invoked whenever a scene is changed
  42. /// </summary>
  43. /// <param name="prevScene">The Scene that was previously loaded</param>
  44. /// <param name="nextScene">The Scene being loaded</param>
  45. void OnActiveSceneChanged(Scene prevScene, Scene nextScene);
  46. }
  47. }