Adding Help Items (#35)

* Help Items

* Updated Changelog

* Factorized URLs

* Added More Help Items

CHANGELOG.md

 * Renamed **Call Tree Explorer** to **Ingredients Explorer** as it is more general purpose now. 
 * Added Rigs to **Ingredients Explorer** : that view summarizes currently loaded rigs, and groups them in update groups.
 * Added abstract `PingableEditor` class for MonoBehaviours that can be Pinged to stand out in the inspector.
+* Added Help items in Menu, Added HelpURL class attributes
 
 ## 2020.2.2
 

Editor/MenuItems.cs

         #endregion
 
         #region HELP
+        static string helpBaseURL => Help.URL;
-        [MenuItem("Help/Gameplay Ingredients/Documentation")]
-        static void Help()
+        static void OpenHelp(string page)
-            Application.OpenURL("https://peeweek.readthedocs.io/en/latest/gameplay-ingredients/");
+            Application.OpenURL($"{helpBaseURL}{page}/");
+        static void OpenHelp()
+        {
+            Application.OpenURL(helpBaseURL);
+        }
+
+        [MenuItem("Help/Gameplay Ingredients/Documentation/Table of Contents")]
+        static void Help_StartPage() { OpenHelp(); }
+
+        [MenuItem("Help/Gameplay Ingredients/Documentation/Installing")]
+        static void Help_Install() { OpenHelp("install"); }
+
+        [MenuItem("Help/Gameplay Ingredients/Documentation/Settings Asset")]
+        static void Help_Settings() { OpenHelp("settings"); }
+
+        [MenuItem("Help/Gameplay Ingredients/Documentation/Version Compatibility")]
+        static void Help_Versions() { OpenHelp("versions"); }
+
+        [MenuItem("Help/Gameplay Ingredients/Documentation/Getting Involved")]
+        static void Help_Contribute() { OpenHelp("engage"); }
+
+        [MenuItem("Help/Gameplay Ingredients/Documentation/Runtime/Events,Logic and Actions")]
+        static void Help_EventLogicActions() { OpenHelp("events-logic-actions"); }
+
+        [MenuItem("Help/Gameplay Ingredients/Documentation/Runtime/Callables")]
+        static void Help_Callables() { OpenHelp("callable"); }
+
+        [MenuItem("Help/Gameplay Ingredients/Documentation/Runtime/Managers")]
+        static void Help_Managers() { OpenHelp("managers"); }
+
+        [MenuItem("Help/Gameplay Ingredients/Documentation/Runtime/Messager")]
+        static void Help_Messager() { OpenHelp("messager"); }
+
+        [MenuItem("Help/Gameplay Ingredients/Documentation/Runtime/Rigs")]
+        static void Help_Rigs() { OpenHelp("rigs"); }
+
+        [MenuItem("Help/Gameplay Ingredients/Documentation/Runtime/State Machines")]
+        static void Help_StateMachines() { OpenHelp("state-machines"); }
+
+        [MenuItem("Help/Gameplay Ingredients/Documentation/Runtime/Factories")]
+        static void Help_Factories() { OpenHelp("factories"); }
+
+        [MenuItem("Help/Gameplay Ingredients/Documentation/Runtime/Timers")]
+        static void Help_Timers() { OpenHelp("timers"); }
+
+        [MenuItem("Help/Gameplay Ingredients/Documentation/Runtime/Global and Local Variables")]
+        static void Help_Globals() { OpenHelp("globals"); }
+
+        [MenuItem("Help/Gameplay Ingredients/Documentation/Runtime/Counters")]
+        static void Help_Counters() { OpenHelp("counters"); }
+
+        [MenuItem("Help/Gameplay Ingredients/Documentation/Runtime/Interactive")]
+        static void Help_Interactive() { OpenHelp("interactive"); }
+
+        [MenuItem("Help/Gameplay Ingredients/Documentation/Editor/Welcome Screen")]
+        static void Help_WelcomeScreen() { OpenHelp("welcome-screen"); }
+
+        [MenuItem("Help/Gameplay Ingredients/Documentation/Editor/Play from Here")]
+        static void Help_PlayFromHere() { OpenHelp("play-from-here"); }
+
+        [MenuItem("Help/Gameplay Ingredients/Documentation/Editor/Advanced Hierarchy View")]
+        static void Help_AdvHierarchy() { OpenHelp("hierarchy-hints"); }
+
+        [MenuItem("Help/Gameplay Ingredients/Documentation/Editor/Link Game View")]
+        static void Help_LinkGameView() { OpenHelp("link-game-view"); }
+
+        [MenuItem("Help/Gameplay Ingredients/Documentation/Editor/Scene Point-of-Views")]
+        static void Help_ScenePOV() { OpenHelp("scene-pov"); }
+
+        [MenuItem("Help/Gameplay Ingredients/Documentation/Editor/Scene Setups")]
+        static void Help_SceneSetups() { OpenHelp("scene-setups"); }
+
+        [MenuItem("Help/Gameplay Ingredients/Documentation/Editor/Find and Replace")]
+        static void Help_FindReplace() { OpenHelp("find-and-replace"); }
+
+        [MenuItem("Help/Gameplay Ingredients/Documentation/Editor/Callable tree Explorer")]
+        static void Help_CallableTreeExplorer() { OpenHelp("callable-tree-explorer"); }
+
+        [MenuItem("Help/Gameplay Ingredients/Documentation/Editor/Folders")]
+        static void Help_Folders() { OpenHelp("folders"); }
+
+        [MenuItem("Help/Gameplay Ingredients/Documentation/Editor/Discover")]
+        static void Help_Discover() { OpenHelp("discover"); }
+
+
         [MenuItem("Help/Gameplay Ingredients/GitHub Repository (Issues and Releases)")]
         static void GitHub()
         {
         {
             Application.OpenURL("https://openupm.com/packages/net.peeweek.gameplay-ingredients/");
         }
-
-
         #endregion
     }
 }

Runtime/Ingredients/Counter/Counter.cs

 
 namespace GameplayIngredients
 {
+    [HelpURL(Help.URL + "counters")]
     [AdvancedHierarchyIcon("Packages/net.peeweek.gameplay-ingredients/Icons/Misc/ic-counter.png")]
 
     public class Counter : MonoBehaviour

Runtime/Ingredients/Counter/CounterAction.cs

 
 namespace GameplayIngredients.Actions
 {
+    [HelpURL(Help.URL + "counters")]
     public class CounterAction : ActionBase
     {
         public enum CounterOperation

Runtime/Ingredients/Counter/CounterLogic.cs

 
 namespace GameplayIngredients.Logic
 {
+    [HelpURL(Help.URL + "counters")]
     public class CounterLogic : LogicBase
     {
         public enum ValueSourceType

Runtime/Ingredients/Factory/Factory.cs

 
 namespace GameplayIngredients
 {
+    [HelpURL(Help.URL + "factory")]
     [AdvancedHierarchyIcon("Packages/net.peeweek.gameplay-ingredients/Icons/Misc/ic-Factory.png")]
     public class Factory : MonoBehaviour
     {

Runtime/Ingredients/Factory/FactorySetTargetAction.cs

 
 namespace GameplayIngredients.Actions
 {
+    [HelpURL(Help.URL + "factory")]
     public class FactorySetTargetAction : ActionBase
     {
         [NonNullCheck]

Runtime/Ingredients/Factory/FactorySpawnAction.cs

 
 namespace GameplayIngredients.Actions
 {
+    [HelpURL(Help.URL + "factory")]
     public class FactorySpawnAction : ActionBase
     {
         [NonNullCheck]

Runtime/Ingredients/Interactions/Interaction.cs

 
 namespace GameplayIngredients.Interactions
 {
+    [HelpURL(Help.URL + "interactive")]
     public class Interaction : ActionBase
     {
         public InteractiveUser InteractiveUser;

Runtime/Ingredients/Interactions/Interactive.cs

 
 namespace GameplayIngredients.Interactions
 {
+    [HelpURL(Help.URL + "interactive")]
     [AdvancedHierarchyIcon("Packages/net.peeweek.gameplay-ingredients/Icons/Misc/ic-interactive.png")]
     public abstract class Interactive : EventBase
     {

Runtime/Ingredients/Interactions/InteractiveUser.cs

 
 namespace GameplayIngredients.Interactions
 {
+    [HelpURL(Help.URL + "interactive")]
     public abstract class InteractiveUser : MonoBehaviour
     {
         public abstract bool CanInteract(Interactive interactive);

Runtime/Ingredients/Pickup/PickupEffectBase.cs

 
 namespace GameplayIngredients.Pickup
 {
+    [HelpURL(Help.URL + "pickup")]
     public abstract class PickupEffectBase : MonoBehaviour
     {
         public abstract void ApplyPickupEffect(PickupOwnerBase owner);

Runtime/Ingredients/Pickup/PickupItem.cs

 
 namespace GameplayIngredients.Pickup
 {
+    [HelpURL(Help.URL + "pickup")]
     [RequireComponent(typeof(Collider))]
     public class PickupItem : MonoBehaviour
     {

Runtime/Ingredients/Pickup/PickupOwnerBase.cs

 
 namespace GameplayIngredients.Pickup
 {
+    [HelpURL(Help.URL + "pickup")]
     public abstract class PickupOwnerBase : MonoBehaviour
     {
         public bool PickUp(PickupItem pickup)

Runtime/Ingredients/Rigs/Rig.cs

 
 namespace GameplayIngredients.Rigs
 {
+    [HelpURL(Help.URL + "rigs")]
     public abstract class Rig : MonoBehaviour
     {
         public UpdateMode updateMode

Runtime/Ingredients/StateMachine/SetStateAction.cs

 
 namespace GameplayIngredients.Actions
 {
+    [HelpURL(Help.URL + "state-machines")]
     public class SetStateAction : ActionBase
     {
         [NonNullCheck]

Runtime/Ingredients/StateMachine/State.cs

 
 namespace GameplayIngredients.StateMachines
 {
+    [HelpURL(Help.URL + "state-machines")]
     [AdvancedHierarchyIcon("Packages/net.peeweek.gameplay-ingredients/Icons/Misc/ic-State.png")]
     public class State : MonoBehaviour
     {

Runtime/Ingredients/StateMachine/StateMachine.cs

 
 namespace GameplayIngredients.StateMachines
 {
+    [HelpURL(Help.URL + "state-machines")]
     [AdvancedHierarchyIcon("Packages/net.peeweek.gameplay-ingredients/Icons/Misc/ic-StateMachine.png")]
     public class StateMachine : MonoBehaviour
     {

Runtime/Ingredients/Timer/Timer.cs

 
 namespace GameplayIngredients
 {
+    [HelpURL(Help.URL + "timers")]
     [AdvancedHierarchyIcon("Packages/net.peeweek.gameplay-ingredients/Icons/Misc/ic-timer.png")]
     public class Timer : MonoBehaviour
     {

Runtime/Ingredients/Timer/TimerAction.cs

 
 namespace GameplayIngredients.Actions
 {
+    [HelpURL(Help.URL + "timers")]
     public class TimerAction : ActionBase
     {
         public enum Action

Runtime/Ingredients/Timer/TimerDisplayRig.cs

 
 namespace GameplayIngredients
 {
+    [HelpURL(Help.URL + "timers")]
     public class TimerDisplayRig : MonoBehaviour
     {
         [NonNullCheck]

Runtime/LevelScripting/Actions/ActionBase.cs

 
 namespace GameplayIngredients.Actions
 {
+    [HelpURL(Help.URL + "events-logic-actions")]
     public abstract class ActionBase : Callable
     {
         public override sealed string ToString()

Runtime/LevelScripting/Actions/SendMessageAction.cs

 
 namespace GameplayIngredients.Actions
 {
+    [HelpURL(Help.URL + "messager")]
     public class SendMessageAction : ActionBase
     {
         public string MessageToSend = "Message";

Runtime/LevelScripting/Events/EventBase.cs

 
 namespace GameplayIngredients.Events
 {
+    [HelpURL(Help.URL + "events-logic-actions")]
     public abstract class EventBase : MonoBehaviour
     {
         protected bool AllowUpdateCalls()

Runtime/LevelScripting/Events/OnMessageEvent.cs

 
 namespace GameplayIngredients.Events
 {
+    [HelpURL(Help.URL + "messager")]
     [AdvancedHierarchyIcon("Packages/net.peeweek.gameplay-ingredients/Icons/Events/ic-event-message.png")]
     public class OnMessageEvent : EventBase
     {

Runtime/LevelScripting/Logic/LogicBase.cs

 
 namespace GameplayIngredients.Logic
 {
+    [HelpURL(Help.URL + "events-logic-actions")]
     public abstract class LogicBase : Callable
     {
         public override sealed string ToString()

Runtime/Managers/Globals/GlobalLogic.cs

 
 namespace GameplayIngredients.Logic
 {
+    [HelpURL(Help.URL + "globals")]
     public class GlobalLogic : LogicBase
     {
         [Header("Base Value")]

Runtime/Managers/Globals/ResetGlobalAction.cs

 
 namespace GameplayIngredients.Actions
 {
+    [HelpURL(Help.URL + "globals")]
     public class ResetGlobalAction : ActionBase
     {
         public ResetType resetType = ResetType.Locals;

Runtime/Managers/Globals/SetGlobalAction.cs

 
 namespace GameplayIngredients.Actions
 {
+    [HelpURL(Help.URL + "globals")]
     public class SetGlobalAction : ActionBase
     {
         public Globals.Scope scope = Globals.Scope.Global;

Runtime/Managers/Manager.cs

 
 namespace GameplayIngredients
 {
+    
+    [HelpURL(Help.URL + "managers")]
     public abstract class Manager : MonoBehaviour
     {
         private static Dictionary<Type, Manager> s_Managers = new Dictionary<Type, Manager>();

Runtime/Settings/GameplayIngredientsSettings.cs

 
 namespace GameplayIngredients
 {
+    [HelpURL(Help.URL + "settings")]
     public class GameplayIngredientsSettings : ScriptableObject
     {
         public string[] excludedeManagers { get { return m_ExcludedManagers; } }

Runtime/Help.cs

+using System.Collections;
+using System.Collections.Generic;
+using UnityEngine;
+
+namespace GameplayIngredients
+{
+    public static class Help
+    {
+        public const string URL = "https://peeweek.readthedocs.io/en/latest/gameplay-ingredients/";
+    }
+}
+

Runtime/Help.cs.meta

+fileFormatVersion: 2
+guid: a4d7142cf3911f846895d311283a3b19
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: