Beamable.Editor.Assistant.BeamHintsDataModel Class Reference

A serializable data model to store, across domain reloads, the current state of the BeamableAssistantWindow's Hint display. More...

Public Member Functions
void	AppendGlobalStorage (IBeamHintGlobalStorage beamHintGlobalStorage)
void	SetPreferencesManager (IBeamHintPreferencesManager beamHintPreferencesManager)
void	RefreshDomainsFromHints (IEnumerable< BeamHint > storage)
	Refreshes the SortedDomainsInStorage from a given list of hints. More...
bool	RefreshDisplayingHints ()
	Refreshes the list of displaying hints based on what is currently in storage and currently defined filters. Returns whether or not new hints appeared.
void	RefreshDisplayingHints (IEnumerable< BeamHint > storage, List< string > domains)
	Updates the current DisplayingHints based on the SelectedDomains, CurrentFilter and visibility preferences stored in IBeamHintPreferencesManager to the given storage.
void	SelectDomains (List< string > domainsToSelect)
	Selects a group of domains and updates DisplayingHints accordingly.
BeamHint	GetHint (BeamHintHeader header)
	Gets the full BeamHint from a BeamHintHeader.
void	FilterDisplayedBy (string searchText)
	Updates CurrentFilter and DisplayingHints based on the given searchText .
BeamHintNotificationPreference	GetHintNotificationValue (BeamHintHeader header)
	Gets the BeamHintNotificationPreference for the given header .
void	SetHintNotificationValue (BeamHintHeader header, bool evtNewValue)
	Updates the IBeamHintPreferencesManager with a new BeamHintNotificationPreference for the given header header . More...
BeamHintPlayModeWarningPreference	GetHintPlayModeWarningState (BeamHintHeader header)
	Gets the BeamHintPlayModeWarningPreference for the given header .
void	SetHintPreferencesValue (BeamHintHeader header, BeamHintPlayModeWarningPreference newPreference)
	Updates the IBeamHintPreferencesManager with a new BeamHintPlayModeWarningPreference for the given header header .
void	OpenHintDetails (BeamHintHeader beamHintHeader)
	Guarantees a hint's details are opened. More...

Public Attributes
List< BeamHintHeader >	DetailsOpenedHints
	Current list of all Hints that have their details expanded.
List< string >	SelectedDomains
	Current list of all selected domains in the domain tree.
List< BeamHintHeader >	DisplayingHints
	Current list of all hints being displayed.
List< string >	SortedDomainsInStorage
	Current list of all domains, sorted by their value, that can be found in the current DisplayingHints.
string	CurrentFilter
	Current text filter applied to existing hints in _hintGlobalStorages to generate the DisplayingHints.

Detailed Description

A serializable data model to store, across domain reloads, the current state of the BeamableAssistantWindow's Hint display.

Member Function Documentation

OpenHintDetails()

void Beamable.Editor.Assistant.BeamHintsDataModel.OpenHintDetails ( BeamHintHeader  beamHintHeader )

inline

Guarantees a hint's details are opened.

Parameters

beamHintHeader

RefreshDomainsFromHints()

void Beamable.Editor.Assistant.BeamHintsDataModel.RefreshDomainsFromHints ( IEnumerable< BeamHint >  storage )

inline

Refreshes the SortedDomainsInStorage from a given list of hints.

Parameters

storage

Typically, this will be the IBeamHintGlobalStorage.All. But if we need we can regenerate these from any collection of BeamHints.

SetHintNotificationValue()

void Beamable.Editor.Assistant.BeamHintsDataModel.SetHintNotificationValue ( BeamHintHeader  header, bool  evtNewValue  )

inline

Updates the IBeamHintPreferencesManager with a new BeamHintNotificationPreference for the given header header .

Parameters

header	The hint whose notification preference we want to update.
evtNewValue	True will set it to BeamHintNotificationPreference.NotifyAlways. False to BeamHintNotificationPreference.NotifyNever.

---

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

• com.beamable/Editor/UI/BeamableAssistant/Models/BeamHintsDataModel.cs