hellbound/Assets/Sources/Feel/MMFeedbacks/MMFeedbacksForThirdParty/MMTools/MMFeedbackDebugComment.cs

48 lines
2.1 KiB
C#
Raw Normal View History

2021-11-26 11:16:25 +03:00
using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using MoreMountains.Tools;
namespace MoreMountains.Feedbacks
{
/// <summary>
/// This feedback doesn't do anything by default, it's just meant as a comment, you can store text in it for future reference, maybe to remember how you setup a particular MMFeedbacks. Optionnally it can also output that comment to the console on Play.
/// </summary>
[AddComponentMenu("")]
[FeedbackHelp("This feedback doesn't do anything by default, it's just meant as a comment, you can store text in it for future reference, maybe to remember how you setup a particular MMFeedbacks. Optionnally it can also output that comment to the console on Play.")]
[FeedbackPath("Debug/Comment")]
public class MMFeedbackDebugComment : MMFeedback
{
/// sets the inspector color for this feedback
#if UNITY_EDITOR
public override Color FeedbackColor { get { return MMFeedbacksInspectorColors.DebugColor; } }
#endif
/// the comment / note associated to this feedback
[Tooltip("the comment / note associated to this feedback")]
[TextArea(10,30)]
public string Comment;
/// if this is true, the comment will be output to the console on Play
[Tooltip("if this is true, the comment will be output to the console on Play")]
public bool LogComment = false;
/// the color of the message when in DebugLogTime mode
[Tooltip("the color of the message when in DebugLogTime mode")]
[MMCondition("LogComment", true)]
public Color DebugColor = Color.gray;
/// <summary>
/// On Play we output our message to the console if needed
/// </summary>
/// <param name="position"></param>
/// <param name="feedbacksIntensity"></param>
protected override void CustomPlayFeedback(Vector3 position, float feedbacksIntensity = 1.0f)
{
if (Active && LogComment)
{
Debug.Log(Comment);
}
}
}
}