These are UnityEditor only systems. You should assume they'll only exist "#if UNITY_EDITOR" is true. You can use these to IBeamHintSystems read, filter, clear and arrange data logically in relation to BeamHintHeaders to be read by UI and other systems. Keep in mind:
- These only work in editor — their instances won't ever be initialized outside of it.
- Place System.Diagnostics.ConditionalAttribute("UNITY_EDITOR") on all functions you plan to call from non-editor code.
- For use with non-editor only systems, write pure functions that take in ALL the necessary data from the non-editor systems and does the processing and addition of hints.
- Use "void" functions whenever interacting with non-editor code as we'll strip these calls in non-editor environments.
- If you need state to decide to show hints, aggregate and store this state in the IBeamHintSystem's member fields via calls to methods that are System.Diagnostics.ConditionalAttribute.
Public Member Functions | |
| void | SetPreferencesManager (IBeamHintPreferencesManager preferencesManager) |
| void | SetStorage (IBeamHintGlobalStorage hintGlobalStorage) |
| void | OnInitialized () |
Detailed Description
These are UnityEditor only systems. You should assume they'll only exist "#if UNITY_EDITOR" is true. You can use these to IBeamHintSystems read, filter, clear and arrange data logically in relation to BeamHintHeaders to be read by UI and other systems. Keep in mind:
- These only work in editor — their instances won't ever be initialized outside of it.
- Place System.Diagnostics.ConditionalAttribute("UNITY_EDITOR") on all functions you plan to call from non-editor code.
- For use with non-editor only systems, write pure functions that take in ALL the necessary data from the non-editor systems and does the processing and addition of hints.
- Use "void" functions whenever interacting with non-editor code as we'll strip these calls in non-editor environments.
- If you need state to decide to show hints, aggregate and store this state in the IBeamHintSystem's member fields via calls to methods that are System.Diagnostics.ConditionalAttribute.
Keep the usage of these as simple as you can. The point of these systems is to provide a simple way for teams to bake their assumptions and established conventions into their editor workflow. If complicate the process of doing this, it defeats its very purpose.
Member Function Documentation
◆ OnInitialized()
| void Beamable.Common.Assistant.IBeamHintSystem.OnInitialized | ( | ) |
Implemented in Beamable.Editor.Assistant.BeamHintNotificationManager.
◆ SetPreferencesManager()
| void Beamable.Common.Assistant.IBeamHintSystem.SetPreferencesManager | ( | IBeamHintPreferencesManager | preferencesManager | ) |
Implemented in Beamable.Editor.Assistant.BeamHintNotificationManager.
◆ SetStorage()
| void Beamable.Common.Assistant.IBeamHintSystem.SetStorage | ( | IBeamHintGlobalStorage | hintGlobalStorage | ) |
Implemented in Beamable.Editor.Assistant.BeamHintNotificationManager.
The documentation for this interface was generated from the following file:
- com.beamable/Common/Runtime/BeamHints/BeamHint.cs
