Documentation

Author: Guillemsc

Editor/Documentation/GenericsDocumentation.cs

@@ -13,27 +13,27 @@ public static void SameTimeSequencingDocumentation()
 
         public static void EasingDocumentation()
         {
-            GUILayout.Label("- Use Animation Curve: Allows for the choosing of a predefined Easing, or to use an Animation Curve", EditorStyles.wordWrappedLabel);
-            GUILayout.Label("- Ease: (If enabled) Predefined easing used to interpolate", EditorStyles.wordWrappedLabel);
-            GUILayout.Label("- Animation Curve: (If enabled) To set custom easings", EditorStyles.wordWrappedLabel);
+            GUILayout.Label("- Use Animation Curve: allows for the choosing of a predefined Easing, or to use an Animation Curve", EditorStyles.wordWrappedLabel);
+            GUILayout.Label("- Ease: (if enabled) predefined easing used to interpolate", EditorStyles.wordWrappedLabel);
+            GUILayout.Label("- Animation Curve: (if enabled) to set custom easings", EditorStyles.wordWrappedLabel);
         }
 
         public static void LoopDocumentation()
         {
             GUILayout.Label("- Loop:", EditorStyles.wordWrappedLabel);
-            GUILayout.Label("   Disabled: Does not loop", EditorStyles.wordWrappedLabel);
-            GUILayout.Label("   X Times: Loops an x number of times", EditorStyles.wordWrappedLabel);
-            GUILayout.Label("   Until Manually Stoped: Loops until Complete or Kill is called on the feedback", EditorStyles.wordWrappedLabel);
+            GUILayout.Label("   Disabled: does not loop", EditorStyles.wordWrappedLabel);
+            GUILayout.Label("   X Times: loops an x number of times", EditorStyles.wordWrappedLabel);
+            GUILayout.Label("   Until Manually Stoped: loops until Complete or Kill is called on the feedback", EditorStyles.wordWrappedLabel);
         }
 
         public static void DelayDocumentation()
         {
-            GUILayout.Label("- Delay: Delay to start the feedback", EditorStyles.wordWrappedLabel);
+            GUILayout.Label("- Delay: delay to start the feedback", EditorStyles.wordWrappedLabel);
         }
 
         public static void DurationDocumentation()
         {
-            GUILayout.Label("- Duration: Time it will take to reach the end", EditorStyles.wordWrappedLabel);
+            GUILayout.Label("- Duration: time it will take to reach the final value", EditorStyles.wordWrappedLabel);
         }
     }
 }

Editor/Documentation/SpriteRenderer.meta

@@ -0,0 +1,54 @@
+using System;
+using UnityEditor;
+using UnityEngine;
+
+namespace Juce.Feedbacks
+{
+    public class SpriteRendererColorDocumentation : IFeedbackDocumentation
+    {
+        public Type FeedbackType => typeof(SpriteRendererColorFeedback);
+
+        public void DrawDocumentation()
+        {
+            GUILayout.Label("Changes the target SpriteRenderer to a certain color", EditorStyles.wordWrappedLabel);
+
+            EditorGUILayout.Space(2);
+
+            using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
+            {
+                GUILayout.Label("- Target: SpriteRenderer component that is going to be affected", EditorStyles.wordWrappedLabel);
+            }
+
+            using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
+            {
+                GUILayout.Label("- Use Starting Value: enables the starting color", EditorStyles.wordWrappedLabel);
+                GUILayout.Label("- Start: (if enabled) starting color value", EditorStyles.wordWrappedLabel);
+                GUILayout.Label("- End: end color value to reach", EditorStyles.wordWrappedLabel);
+            }
+
+            using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
+            {
+                GenericsDocumentation.DelayDocumentation();
+                GenericsDocumentation.DurationDocumentation();
+            }
+
+            using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
+            {
+                GenericsDocumentation.EasingDocumentation();
+            }
+
+            using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
+            {
+                GenericsDocumentation.LoopDocumentation();
+            }
+
+            EditorGUILayout.Space(2);
+
+            using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
+            {
+                GUILayout.Label("Sequencing:");
+                GenericsDocumentation.SameTimeSequencingDocumentation();
+            }
+        }
+    }
+}

Editor/Documentation/SpriteRenderer/SpriteRendererColorDocumentation.cs

@@ -0,0 +1,42 @@
+using System;
+using UnityEditor;
+using UnityEngine;
+
+namespace Juce.Feedbacks
+{
+    public class SpriteRendererFlipDocumentation : IFeedbackDocumentation
+    {
+        public Type FeedbackType => typeof(SpriteRendererFlipFeedback);
+
+        public void DrawDocumentation()
+        {
+            GUILayout.Label("Changes the target SpriteRenderer flipX and flipY values", EditorStyles.wordWrappedLabel);
+
+            EditorGUILayout.Space(2);
+
+            using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
+            {
+                GUILayout.Label("- Target: SpriteRenderer component that is going to be affected", EditorStyles.wordWrappedLabel);
+            }
+
+            using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
+            {
+                GUILayout.Label("- FlipX: enable or disable flip x value", EditorStyles.wordWrappedLabel);
+                GUILayout.Label("- FlipY: enable or disable flip y value", EditorStyles.wordWrappedLabel);
+              }
+
+            using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
+            {
+                GenericsDocumentation.DelayDocumentation();
+            }
+
+            EditorGUILayout.Space(2);
+
+            using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
+            {
+                GUILayout.Label("Sequencing:");
+                GenericsDocumentation.SameTimeSequencingDocumentation();
+            }
+        }
+    }
+}

Editor/Documentation/SpriteRenderer/SpriteRendererColorDocumentation.cs.meta

@@ -0,0 +1,41 @@
+using System;
+using UnityEditor;
+using UnityEngine;
+
+namespace Juce.Feedbacks
+{
+    public class SpriteRendererSpriteDocumentation : IFeedbackDocumentation
+    {
+        public Type FeedbackType => typeof(SpriteRendererSpriteFeedback);
+
+        public void DrawDocumentation()
+        {
+            GUILayout.Label("Changes the target SpriteRenderer sprite", EditorStyles.wordWrappedLabel);
+
+            EditorGUILayout.Space(2);
+
+            using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
+            {
+                GUILayout.Label("- Target: SpriteRenderer component that is going to be affected", EditorStyles.wordWrappedLabel);
+            }
+
+            using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
+            {
+                GUILayout.Label("- Sprite: sprite to set", EditorStyles.wordWrappedLabel);
+            }
+
+            using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
+            {
+                GenericsDocumentation.DelayDocumentation();
+            }
+
+            EditorGUILayout.Space(2);
+
+            using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
+            {
+                GUILayout.Label("Sequencing:");
+                GenericsDocumentation.SameTimeSequencingDocumentation();
+            }
+        }
+    }
+}

Editor/Documentation/SpriteRenderer/SpriteRendererFlipDocumentation.cs

@@ -11,7 +11,7 @@ public class UIAlphaDocumentation : IFeedbackDocumentation
 
         public void DrawDocumentation()
         {
-            GUILayout.Label("Using a CanvasGroup, can set the alpha values", EditorStyles.wordWrappedLabel);
+            GUILayout.Label("Using a CanvasGroup, can set the alpha value", EditorStyles.wordWrappedLabel);
 
             EditorGUILayout.Space(2);