Open 3D Engine LyShine Gem API Reference 25.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
UiInteractableStateFont Class Reference

Inherits UiInteractableStateAction, and FontNotificationBus::Handler.

Public Types

using FontEffectComboBoxVec = AZStd::vector< AZStd::pair< unsigned int, AZStd::string > >
 
- Public Types inherited from UiInteractableStateAction
using EntityComboBoxVec = AZStd::vector< AZStd::pair< AZ::EntityId, AZStd::string > >
 

Public Member Functions

 AZ_CLASS_ALLOCATOR (UiInteractableStateFont, AZ::SystemAllocator)
 
 AZ_RTTI (UiInteractableStateFont, "{0E39A3BC-CEF5-4385-9D06-BFEE189E77E1}", UiInteractableStateAction)
 
 UiInteractableStateFont (AZ::EntityId target, const AZStd::string &pathname, unsigned int fontEffectIndex)
 
void Init (AZ::EntityId) override
 Called from the Init of the UiInteractableComponent.
 
void ApplyState () override
 Apply state or do action.
 
void SetInteractableEntity (AZ::EntityId interactableEntityId) override
 
AZ::EntityId GetTargetEntity () override
 
void OnFontsReloaded () override
 
const AZStd::string & GetFontPathname ()
 
void SetFontPathname (const AZStd::string &pathname)
 
const unsigned int GetFontEffectIndex ()
 
void SetFontEffectIndex (unsigned int index)
 
EntityComboBoxVec PopulateTargetEntityList ()
 
FontEffectComboBoxVec PopulateFontEffectList ()
 Populate the list for the font effect combo box in the properties pane.
 
void OnFontPathnameChange ()
 
- Public Member Functions inherited from UiInteractableStateAction
 AZ_CLASS_ALLOCATOR (UiInteractableStateAction, AZ::SystemAllocator)
 
 AZ_RTTI (UiInteractableStateAction, "{D86C82E1-E027-453F-A43B-BD801CF88391}")
 
EntityComboBoxVec PopulateTargetEntityList ()
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 
- Static Public Member Functions inherited from UiInteractableStateAction
static void Reflect (AZ::ReflectContext *context)
 

Protected Member Functions

void InitCommon (const AZStd::string &fontPathname)
 

Protected Attributes

AZ::EntityId m_targetEntity
 
AzFramework::SimpleAssetReference< LyShine::FontAsset > m_fontFilename
 
FontFamilyPtr m_fontFamily
 
unsigned int m_fontEffectIndex
 
- Protected Attributes inherited from UiInteractableStateAction
AZ::EntityId m_interactableEntity
 The interactable entity that this state belongs to.
 

Member Function Documentation

◆ ApplyState()

void UiInteractableStateFont::ApplyState ( )
overridevirtual

Apply state or do action.

Implements UiInteractableStateAction.

◆ GetTargetEntity()

AZ::EntityId UiInteractableStateFont::GetTargetEntity ( )
inlineoverridevirtual

Reimplemented from UiInteractableStateAction.

◆ Init()

void UiInteractableStateFont::Init ( AZ::EntityId  )
overridevirtual

Called from the Init of the UiInteractableComponent.

Reimplemented from UiInteractableStateAction.

◆ SetInteractableEntity()

void UiInteractableStateFont::SetInteractableEntity ( AZ::EntityId  interactableEntityId)
overridevirtual

Reimplemented from UiInteractableStateAction.

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