Open 3D Engine LyShine Gem API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
UiVisualInterface Class Referenceabstract

Inherits AZ::ComponentBus.

Public Member Functions

virtual void ResetOverrides ()=0
 Reset the overrides, used when setting interactable states.
 
virtual void SetOverrideColor (const AZ::Color &color)=0
 Set the override color, used for interactable states.
 
virtual void SetOverrideAlpha (float alpha)=0
 Set the override alpha, used for interactable states.
 
virtual void SetOverrideSprite ([[maybe_unused]] ISprite *sprite, [[maybe_unused]] AZ::u32 cellIndex)
 
virtual void SetOverrideFont (FontFamilyPtr fontFamily)
 
virtual void SetOverrideFontEffect ([[maybe_unused]] unsigned int fontEffectIndex)
 Set the override font effect, if this visual component uses a font this will override it.
 

Static Public Attributes

static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single
 Only one component on a entity can implement the events.
 

Member Function Documentation

◆ SetOverrideFont()

virtual void UiVisualInterface::SetOverrideFont ( FontFamilyPtr  fontFamily)
inlinevirtual

Set the override font, if this visual component uses a font this will override it

Parameters
fontIf null the font on the visual component will not be overridden

◆ SetOverrideSprite()

virtual void UiVisualInterface::SetOverrideSprite ( [[maybe_unused] ] ISprite sprite,
[[maybe_unused] ] AZ::u32  cellIndex 
)
inlinevirtual

Set the override sprite, if this visual component uses a sprite this will override it

Parameters
spriteIf null the sprite on the visual component will not be overridden
cellIndexThis value will be ignored if the given sprite isn't a sprite-sheet spritetype.

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