Manages and persists BeamHint preferences. Can decide to display/ignore hints, play mode warnings and/or notifications. It persists this configuration in a per-session or permanent level. More...

Inheritance diagram for Beamable.Editor.Assistant.BeamHintPreferencesManager:

[legend]

Collaboration diagram for Beamable.Editor.Assistant.BeamHintPreferencesManager:

[legend]

Public Member Functions
	BeamHintPreferencesManager (List< BeamHintHeader > playModeWarningByDefaultHints=null)
	Creates a new BeamHintPreferencesManager instance you can use to manage BeamHint display/ignore preferences.

void	RebuildPerHintPreferences ()
	Restores the current in-memory state of the BeamHintPreferencesManager to match what is stored in its persistent storages. More...

BeamHintVisibilityPreference	GetHintVisibilityPreferences (BeamHint hint)
	Gets the current BeamHintVisibilityPreference for the given hint. More...

void	SetHintVisibilityPreferences (BeamHint hint, BeamHintVisibilityPreference newBeamHintVisibilityPreference)
	Sets, for the given hint , the given newBeamHintVisibilityPreference . More...

void	SplitHintsByVisibilityPreferences (IEnumerable< BeamHint > hints, out IEnumerable< BeamHint > outToDisplayHints, out IEnumerable< BeamHint > outToIgnoreHints)
	Splits all given hints by their BeamHintVisibilityPreferences. More...

BeamHintPlayModeWarningPreference	GetHintPlayModeWarningPreferences (BeamHint hint)
	Gets the current BeamHintPlayModeWarningPreference for the given hint. More...

void	SetHintPlayModeWarningPreferences (BeamHint hint, BeamHintPlayModeWarningPreference newBeamHintPlayModeWarningPreference)
	Sets, for the given hint , the given newBeamHintPlayModeWarningPreference . More...

void	SplitHintsByPlayModeWarningPreferences (IEnumerable< BeamHint > hints, out IEnumerable< BeamHint > outToWarnHints, out IEnumerable< BeamHint > outToIgnoreHints)
	Splits all given hints by their BeamHintPlayModeWarningPreferences. More...

BeamHintNotificationPreference	GetHintNotificationPreferences (BeamHint hint)
	Gets the current BeamHintNotificationPreference for the given hint. More...

void	SetHintNotificationPreferences (BeamHint hint, BeamHintNotificationPreference newBeamHintNotificationPreference)
	Update the BeamHintNotificationPreference for a given hint. More...

void	SplitHintsByNotificationPreferences (IEnumerable< BeamHint > hints, out List< BeamHint > outToNotifyNever, out List< BeamHint > outToNotifyOncePerSession, out List< BeamHint > outToNotifyOnContextObjectChange)
	Splits all given hints by their BeamHintPlayModeWarningPreferences. More...

void	ClearAllPreferences ()
	Discards all persisted BeamHintVisibilityPreferences, BeamHintPlayModeWarningPreferences and BeamHintNotificationPreferences of all hints. More...

Detailed Description

Manages and persists BeamHint preferences. Can decide to display/ignore hints, play mode warnings and/or notifications. It persists this configuration in a per-session or permanent level.

Member Function Documentation

◆ ClearAllPreferences()

void Beamable.Editor.Assistant.BeamHintPreferencesManager.ClearAllPreferences ( )

inline

Discards all persisted BeamHintVisibilityPreferences, BeamHintPlayModeWarningPreferences and BeamHintNotificationPreferences of all hints.

Implements Beamable.Common.Assistant.IBeamHintPreferencesManager.

◆ GetHintNotificationPreferences()

BeamHintNotificationPreference Beamable.Editor.Assistant.BeamHintPreferencesManager.GetHintNotificationPreferences ( BeamHint hint )

inline

Gets the current BeamHintNotificationPreference for the given hint.

Implements Beamable.Common.Assistant.IBeamHintPreferencesManager.

◆ GetHintPlayModeWarningPreferences()

BeamHintPlayModeWarningPreference Beamable.Editor.Assistant.BeamHintPreferencesManager.GetHintPlayModeWarningPreferences ( BeamHint hint )

inline

Gets the current BeamHintPlayModeWarningPreference for the given hint.

Implements Beamable.Common.Assistant.IBeamHintPreferencesManager.

◆ GetHintVisibilityPreferences()

BeamHintVisibilityPreference Beamable.Editor.Assistant.BeamHintPreferencesManager.GetHintVisibilityPreferences ( BeamHint hint )

inline

Gets the current BeamHintVisibilityPreference for the given hint.

Implements Beamable.Common.Assistant.IBeamHintPreferencesManager.

◆ RebuildPerHintPreferences()

void Beamable.Editor.Assistant.BeamHintPreferencesManager.RebuildPerHintPreferences ( )

inline

Restores the current in-memory state of the BeamHintPreferencesManager to match what is stored in its persistent storages.

Implements Beamable.Common.Assistant.IBeamHintPreferencesManager.

◆ SetHintNotificationPreferences()

void Beamable.Editor.Assistant.BeamHintPreferencesManager.SetHintNotificationPreferences	(	BeamHint	hint,
		BeamHintNotificationPreference	newBeamHintNotificationPreference
	)

inline

Update the BeamHintNotificationPreference for a given hint.

Implements Beamable.Common.Assistant.IBeamHintPreferencesManager.

◆ SetHintPlayModeWarningPreferences()

void Beamable.Editor.Assistant.BeamHintPreferencesManager.SetHintPlayModeWarningPreferences	(	BeamHint	hint,
		BeamHintPlayModeWarningPreference	newBeamHintPlayModeWarningPreference
	)

inline

Sets, for the given hint , the given newBeamHintPlayModeWarningPreference .

Implements Beamable.Common.Assistant.IBeamHintPreferencesManager.

◆ SetHintVisibilityPreferences()

void Beamable.Editor.Assistant.BeamHintPreferencesManager.SetHintVisibilityPreferences	(	BeamHint	hint,
		BeamHintVisibilityPreference	newBeamHintVisibilityPreference
	)

inline

Sets, for the given hint , the given newBeamHintVisibilityPreference .

Implements Beamable.Common.Assistant.IBeamHintPreferencesManager.

◆ SplitHintsByNotificationPreferences()

void Beamable.Editor.Assistant.BeamHintPreferencesManager.SplitHintsByNotificationPreferences	(	IEnumerable< BeamHint >	hints,
		out List< BeamHint >	outToNotifyNever,
		out List< BeamHint >	outToNotifyOncePerSession,
		out List< BeamHint >	outToNotifyOnContextObjectChange
	)

inline

Splits all given hints by their BeamHintPlayModeWarningPreferences.

Parameters

hints	The hints to split by.
outToNotifyNever	The resulting list of BeamHints that should never notify.
outToNotifyOncePerSession	The resulting list of BeamHints that should notify only once per session.
outToNotifyOnContextObjectChange	The resulting list of BeamHints that should notify whenever the context object changed.

Implements Beamable.Common.Assistant.IBeamHintPreferencesManager.

◆ SplitHintsByPlayModeWarningPreferences()

void Beamable.Editor.Assistant.BeamHintPreferencesManager.SplitHintsByPlayModeWarningPreferences	(	IEnumerable< BeamHint >	hints,
		out IEnumerable< BeamHint >	outToWarnHints,
		out IEnumerable< BeamHint >	outToIgnoreHints
	)

inline

Splits all given hints by their BeamHintPlayModeWarningPreferences.

Parameters

hints	The hints to split by.
outToWarnHints	The resulting list of BeamHints that should cause a play-mode-warning.
outToIgnoreHints	The resulting list of BeamHints that should cause a play-mode-warning.

Implements Beamable.Common.Assistant.IBeamHintPreferencesManager.

◆ SplitHintsByVisibilityPreferences()

void Beamable.Editor.Assistant.BeamHintPreferencesManager.SplitHintsByVisibilityPreferences	(	IEnumerable< BeamHint >	hints,
		out IEnumerable< BeamHint >	outToDisplayHints,
		out IEnumerable< BeamHint >	outToIgnoreHints
	)

inline

Splits all given hints by their BeamHintVisibilityPreferences.

Parameters

hints	The hints to split by.
outToDisplayHints	The resulting list of BeamHints that should be displayed.
outToIgnoreHints	The resulting list of BeamHints that should be ignored.

Implements Beamable.Common.Assistant.IBeamHintPreferencesManager.

The documentation for this class was generated from the following file:

com.beamable/Editor/BeamableAssistant/BeamHints/BeamHintPreferencesManager.cs

Public Member Functions

Detailed Description

Member Function Documentation

◆ ClearAllPreferences()

◆ GetHintNotificationPreferences()

◆ GetHintPlayModeWarningPreferences()

◆ GetHintVisibilityPreferences()

◆ RebuildPerHintPreferences()

◆ SetHintNotificationPreferences()

◆ SetHintPlayModeWarningPreferences()

◆ SetHintVisibilityPreferences()

◆ SplitHintsByNotificationPreferences()

◆ SplitHintsByPlayModeWarningPreferences()

◆ SplitHintsByVisibilityPreferences()