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.
UiInteractableStateColor Class Reference

Inherits UiInteractableStateAction.

Public Member Functions

 AZ_CLASS_ALLOCATOR (UiInteractableStateColor, AZ::SystemAllocator)
 
 AZ_RTTI (UiInteractableStateColor, "{D7978A94-592F-4E1A-86EF-E34A819A55FB}", UiInteractableStateAction)
 
 UiInteractableStateColor (AZ::EntityId target, AZ::Color color)
 
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
 
AZ::Color GetColor ()
 
void SetColor (AZ::Color color)
 
EntityComboBoxVec PopulateTargetEntityList ()
 
- 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 Attributes

AZ::EntityId m_targetEntity
 
AZ::Color m_color
 
- 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 UiInteractableStateColor::ApplyState ( )
overridevirtual

Apply state or do action.

Implements UiInteractableStateAction.

◆ GetTargetEntity()

AZ::EntityId UiInteractableStateColor::GetTargetEntity ( )
inlineoverridevirtual

Reimplemented from UiInteractableStateAction.

◆ Init()

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

Called from the Init of the UiInteractableComponent.

Reimplemented from UiInteractableStateAction.

◆ SetInteractableEntity()

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

Reimplemented from UiInteractableStateAction.


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