RealDocs

UGameplayStatics::IsSplitscreenForceDisabled

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

Description

Returns true if splitscreen has been forcibly disabled via SetForceDisableSplitscreen.

Caveats & Gotchas

  • Returns the forced-disable flag, not whether the viewport is actually displaying a single view — the result is only meaningful when compared against a previous SetForceDisableSplitscreen call.
  • On dedicated servers there is no viewport; this will always return false in that context.

Signature

static ENGINE_API bool IsSplitscreenForceDisabled(const UObject* WorldContextObject);

Parameters

Name Type Description Default
WorldContextObject const UObject* Object used to retrieve the world context.

Return Type

bool

Example

Guard against redundant disable calls C++
if (!UGameplayStatics::IsSplitscreenForceDisabled(this))
{
    UGameplayStatics::SetForceDisableSplitscreen(this, true);
}

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.