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

Inherits UiInteractableStateAction.

Public Member Functions

 AZ_CLASS_ALLOCATOR (UiInteractableStateSprite, AZ::SystemAllocator)
 
 AZ_RTTI (UiInteractableStateSprite, "{89294558-CF45-4AA8-9EAA-A1D81BAB92A7}", UiInteractableStateAction)
 
 UiInteractableStateSprite (AZ::EntityId target, ISprite *sprite)
 
 UiInteractableStateSprite (AZ::EntityId target, const AZStd::string &spritePath)
 
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
 
ISprite * GetSprite ()
 
void SetSprite (ISprite *sprite)
 
AZStd::string GetSpritePathname ()
 
void SetSpritePathname (const AZStd::string &spritePath)
 
EntityComboBoxVec PopulateTargetEntityList ()
 
void OnSpritePathnameChange ()
 
- Public Member Functions inherited from UiInteractableStateAction
 AZ_CLASS_ALLOCATOR (UiInteractableStateAction, AZ::SystemAllocator)
 
 AZ_RTTI (UiInteractableStateAction, "{D86C82E1-E027-453F-A43B-BD801CF88391}")
 
virtual void Init (AZ::EntityId)
 Called from the Init of the UiInteractableComponent.
 
virtual void ApplyState ()=0
 Apply state or do action.
 
virtual void SetInteractableEntity (AZ::EntityId interactableEntityId)
 
virtual AZ::EntityId GetTargetEntity ()
 
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 Types

using AZu32ComboBoxVec = AZStd::vector< AZStd::pair< AZ::u32, AZStd::string > >
 

Protected Member Functions

bool IsSpriteSheet ()
 
void OnTargetElementChange ()
 
void LoadSpriteFromTargetElement ()
 
AZu32ComboBoxVec PopulateIndexStringList () const
 Returns a string representation of the indices used to index sprite-sheet types.
 

Protected Attributes

AZ::EntityId m_targetEntity
 
AzFramework::SimpleAssetReference< LmbrCentral::TextureAsset > m_spritePathname
 
ISprite * m_sprite = nullptr
 
AZ::u32 m_spriteSheetCellIndex = 0
 
- Protected Attributes inherited from UiInteractableStateAction
AZ::EntityId m_interactableEntity
 The interactable entity that this state belongs to.
 

Additional Inherited Members

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

Member Function Documentation

◆ ApplyState()

void UiInteractableStateSprite::ApplyState ( )
overridevirtual

Apply state or do action.

Implements UiInteractableStateAction.

◆ GetTargetEntity()

AZ::EntityId UiInteractableStateSprite::GetTargetEntity ( )
inlineoverridevirtual

Reimplemented from UiInteractableStateAction.

◆ Init()

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

Called from the Init of the UiInteractableComponent.

Reimplemented from UiInteractableStateAction.

◆ SetInteractableEntity()

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

Reimplemented from UiInteractableStateAction.

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