FScopedConditionalWorldSwitcher

When created, switches global context to a PIE world When destroyed, resets the GWorld back to what it was before

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/UnrealEngine.h

Include

#include "UnrealEngine.h"

Syntax

class FScopedConditionalWorldSwitcher

Remarks

When created, switches global context to a PIE world When destroyed, resets the GWorld back to what it was before

Constructors

Name Description

Public function

FScopedConditionalWorldSwitcher

(
    FViewportClient* InViewportCli...
)

Use the viewport to figure out what world to set temporarily

Public function

FScopedConditionalWorldSwitcher

(
    UWorld* InWorld
)

Explicitly set to the specific world

Destructors

Name Description

Public function

~FScopedConditionalWorldSwitcher()

Resets back to initial world

Constants

Name

Description

SwitchWorldForPIEDelegate

Delegate to call to switch worlds for PIE viewports.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback