RealDocs

UKismetSystemLibrary::IsScreensaverEnabled

function Engine Blueprint Since 4.0
#include "Kismet/KismetSystemLibrary.h"
Access: public Specifiers: staticBlueprintCallable

Description

Returns true if the OS screensaver is currently enabled on the device.

Caveats & Gotchas

  • Meaningful mainly on desktop and mobile platforms with a native screensaver/lock concept; consoles typically have no equivalent and will return a fixed value.
  • Reflects the OS-level setting, not whether your game has called ControlScreensaver — the two are independent state.

Signature

static ENGINE_API bool IsScreensaverEnabled()

Return Type

bool

Example

Check screensaver state before a long cutscene C++
if (UKismetSystemLibrary::IsScreensaverEnabled())
{
    UKismetSystemLibrary::ControlScreensaver(false);
}

Version History

Introduced in: 4.0

Version Status Notes
5.6 stable

Feedback

Was this helpful?

Suggest an edit

Select a field above to begin editing.