A compound-key identifying each hint. It is a string-based compound key whose individual fields cannot have AS_KEY_SEPARATOR or BeamHintSharedConstants.BEAM_HINT_PREFERENCES_SEPARATOR. These are reserved by our internal systems that manage hints. See BeamHintDomains and BeamHintIds for a better understanding of how to generate hint domains and ids. More...
Inheritance diagram for Beamable.Common.Assistant.BeamHintHeader:
Collaboration diagram for Beamable.Common.Assistant.BeamHintHeader:
Public Member Functions | |
| BeamHintHeader (BeamHintType type, string domain, string id="") | |
| Creates a new header with the given type , domain and id. See BeamHintDomains and BeamHintIds for a better understanding of how these are generated. | |
| bool | Equals (BeamHintHeader other) |
| override bool | Equals (object obj) |
| override int | GetHashCode () |
| string | AsKey () |
| Returns the header in it's "key" string format. This is used to interface with EditorPrefs/SessionState in multiple places. | |
| override string | ToString () |
Static Public Member Functions | |
| static BeamHintHeader | DeserializeBeamHintHeader (string serializedHint) |
| Deserializes a single BeamHintHeader in the format provided by BeamHintHeader.AsKey. | |
Public Attributes | |
| BeamHintType | Type |
| Type of the BeamHint. | |
| string | Domain |
| Domain this hint belongs to. See BeamHintDomains for more details. | |
| string | Id |
| Unique Id, within Domain and Type, that represents these hints. Cannot have "₢" character as it is reserved by the system. | |
Static Public Attributes | |
| const string | AS_KEY_SEPARATOR = "¬¬" |
Detailed Description
A compound-key identifying each hint. It is a string-based compound key whose individual fields cannot have AS_KEY_SEPARATOR or BeamHintSharedConstants.BEAM_HINT_PREFERENCES_SEPARATOR. These are reserved by our internal systems that manage hints. See BeamHintDomains and BeamHintIds for a better understanding of how to generate hint domains and ids.
The documentation for this struct was generated from the following file:
- com.beamable/Common/Runtime/BeamHints/BeamHint.cs
