Beamable SDK
Public Member Functions | Public Attributes | List of all members
Beamable.Editor.Assistant.BeamHintDetailConverterAttribute Class Reference

Placed on top of any BeamHintDetailConverterProvider static methods that match one of the AcceptedSignatures. More...

Inheritance diagram for Beamable.Editor.Assistant.BeamHintDetailConverterAttribute:
Inheritance graph
[legend]
Collaboration diagram for Beamable.Editor.Assistant.BeamHintDetailConverterAttribute:
Collaboration graph
[legend]

Public Member Functions

 BeamHintDetailConverterAttribute (Type delegateType, BeamHintType matchType, string domainSubstring, string idRegex, string hintDetailConfigId, string userOverrideToHintDetailConfigId=null)
 Defines how this converter function maps to BeamHintHeader, conversion delegate types (Reflection.BeamHintReflectionCache.DefaultConverter) and BeamHintDetailsConfig.
 
AttributeValidationResult IsAllowedOnMember (MemberInfo member)
 Takes in the MemberInfo associated with this attribute and returns a AttributeValidationResult. More...
 

Public Attributes

readonly BeamHintType MatchType
 The type of hint this converter will be applied to.
 
readonly string DomainSubstring
 Domain filter for this converter. A match is found if a BeamHintHeader.Domain contains this text.
 
readonly string IdRegex
 A regex string used to match against BeamHintHeader.Id. The converter will be applied to
 
readonly string HintDetailConfigId
 BeamHintDetailsConfig.Id for the UXML/USS templates used to render this hint.
 
readonly string UserOverrideToHintDetailConfigId
 An alternative BeamHintDetailsConfig.Id that we set. If a user creates a BeamHintDetailsConfig with this Id in their project, they can override the HintDetailConfigId.
 
readonly Type DelegateType
 Type of the delegate for the converter. Must be one of the converter delegates declared at Reflection.BeamHintReflectionCache. See Reflection.BeamHintReflectionCache.DefaultConverter as an example.
 

Detailed Description

Placed on top of any BeamHintDetailConverterProvider static methods that match one of the AcceptedSignatures.

These functions should know how to inject data from a BeamHint and especially its BeamHint.ContextObject into BeamHintVisualsInjectionBag. This is used by BeamHintHeaderVisualElement to render hint details.

Member Function Documentation

◆ IsAllowedOnMember()

AttributeValidationResult Beamable.Editor.Assistant.BeamHintDetailConverterAttribute.IsAllowedOnMember ( MemberInfo  member)
inline

Takes in the MemberInfo associated with this attribute and returns a AttributeValidationResult.

Implements Beamable.Common.Reflection.IReflectionAttribute.


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