Skip to main content

Class FeedbackHighlightSO

Namespace: mobisim.Feedback

Feedback Highlight data model that provides highlight snapshot. FeedbackHighlightPresenter retrieves these data and format for display.

[CreateAssetMenu(fileName = "New Feedback Highlight", menuName = "ScriptableObject/Feedback UI/Highlight")]
public class FeedbackHighlightSO : ScriptableObject

Inheritance​

object→Object→ScriptableObject→FeedbackHighlightSO

Fields​

HelpTypeVariable​

The current help type used to determine which highlight to display.

[Tooltip("The current help type used to determine which highlight to display.")]
public FeedbackHelpTypeVariable HelpTypeVariable

Field Value​

FeedbackHelpTypeVariable

HighlightDictionary​

A dictionary mapping help type tags to highlight sprites.

[Tooltip("Dictionary mapping help tags to highlight images (sprites).")]
public SerializableDictionary<FeedbackHelpScriptableTag, Sprite> HighlightDictionary

Field Value​

SerializableDictionary<FeedbackHelpScriptableTag, Sprite>

Properties​

Image​

The highlight image associated with the current help type, or null if none is available.

public Sprite Image { get; }

Property Value​

Sprite

IsHighlightEnabled​

Whether the highlight is enabled, determined by whether a valid image exists for the current help type.

public bool IsHighlightEnabled { get; }

Property Value​

bool