Inherits AZ::ComponentBus.

Public Member Functions
virtual float	GetFadeValue ()=0
	Get the fade value. This is a float between 0 and 1. 1 means no fade. 0 means complete fade to invisible.

virtual void	SetFadeValue (float fade)=0
	Set the fade value.

virtual void	Fade (float targetValue, float speed)=0

virtual bool	IsFading ()=0
	Get whether a fade animation is taking place.

virtual bool	GetUseRenderToTexture ()=0
	Get the flag that indicates whether the fader should use render to texture.

virtual void	SetUseRenderToTexture (bool useRenderToTexture)=0
	Set the flag that indicates whether the fader should use render to texture.

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

Member Function Documentation

◆ Fade()

virtual void UiFaderInterface::Fade	(	float	targetValue,
		float	speed
	)

pure virtual

Trigger a fade animation.

Parameters

targetValue	The value to end the fade at [0,1]
speed	Speed measured in full fade amount per second; 0 means instant
listener	The listener to notify when the fade is completed or interrupted

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