UGameplayStatics::AnnounceAccessibleString

function Engine Blueprint Since 4.26

#include "Kismet/GameplayStatics.h"

Access: public Specifiers: staticBlueprintCallable

Description

Sends a string to the platform's screen reader or accessibility announcement system when accessibility is enabled. Use sparingly to avoid overwhelming players who rely on assistive technology.

Caveats & Gotchas

• Currently only supported on Windows 10, macOS, and iOS — the function is a no-op on all other platforms including consoles and Android, so do not use it as the sole accessibility mechanism.
• Announcements can be interrupted by system-level accessibility events (e.g. focus changes). There is no callback or guarantee of delivery; for critical information always present it visually as well.

Signature

static ENGINE_API void AnnounceAccessibleString(const FString& AnnouncementString);

Parameters

Name	Type	Description	Default
AnnouncementString	const FString&	The text string to be read aloud by the platform accessibility system.	—

Return Type

void

Example

Announce item pickup for screen-reader users C++

void AMyPickup::NotifyPickedUp(APlayerController* PC)
{
    FString Message = FString::Printf(TEXT("Picked up %s"), *ItemName.ToString());
    UGameplayStatics::AnnounceAccessibleString(Message);
}

Version History

Introduced in: 4.26

Version	Status	Notes
5.6	stable	—

Feedback

Was this helpful?