FTraceWorldFiltering

[UWorld](API\Runtime\Engine\Engine\UWorld) specific Trace filter, marks individual instances to not be traced out (and all containing actors / objects)

Choose your operating system:

Windows

macOS

Linux

References

Module

SourceFilteringTrace

Header

/Engine/Plugins/Developer/TraceSourceFiltering/Source/SourceFilteringTrace/Public/TraceWorldFiltering.h

Include

#include "TraceWorldFiltering.h"

Syntax

struct FTraceWorldFiltering

Remarks

UWorld specific Trace filter, marks individual instances to not be traced out (and all containing actors / objects)

Functions

Name Description

Public function Static

void

 

Destroy()

Public function Static

void

 

GetWorldDisplayString

(
    const UWorld* InWorld,
    FString& OutDisplayString
)

Returns a user facing display string for the provided UWorld instance

Public function Static

const TArray...

 

GetWorlds()

Return all Worlds currently tracked for Filtering

Public function Static

const FSourc...

 

GetWorldSourceFilterManager

(
    const UWorld* World
)

Retrieve a FSourceFilterManager instance representing the source filtering for a specific, provided) World instance

Public function Static

void

 

Initialize()

Public function Static

bool

 

IsWorldNetModeTraceable

(
    ENetMode InNetMode
)

Check whether or not a specific World's Net Mode can output Trace Data (not filtered out)

Public function Static

bool

 

IsWorldTypeTraceable

(
    EWorldType::Type InType
)

Check whether or not a specific World Type can output Trace Data (not filtered out)

Public function Static

FTraceWorldF...

 

OnFilterStateChanged()

Delegate which will be broadcast whenever the filtering state for any world (type, netmode) changes

Protected function Static

void

 

OnWorldCleanup

(
    UWorld* World,
    bool bSessionEnded,
    bool bCleanupResources
)

Protected function Static

void

 

OnWorldInit

(
    UWorld* World,
    const UWorld::InitializationValues ...
)

Callbacks used to keep tracking of active (alive) UWorld instances

Protected function Static

void

 

OnWorldPostInit

(
    UWorld* World,
    const UWorld::InitializationValues ...
)

Protected function Static

void

 

RemoveWorld

(
    UWorld* InWorld
)

Public function Static

void

 

SetStateByWorldNetMode

(
    ENetMode NetMode,
    bool bState
)

Set whether or not a specific World Net Mode should be filtered out (or in)

Public function Static

void

 

SetStateByWorldType

(
    EWorldType::Type WorldType,
    bool bState
)

Set whether or not a specific World Type should be filtered out (or in)

Public function Static

void

 

SetWorldState

(
    const UWorld* InWorld,
    bool bState
)

Set whether or not a specific UWorld instance's filtering state

Protected function Static

void

 

UpdateWorldFiltering()

Typedefs

Constants

Name

Description

FilterStateChangedDelegate

Delegate for broadcasting filtering changes

NetModeFilterStates

Per ENetMode enum entry flag, determines whether or not UWorld's using this netmode should be filtered out

PreWorldFinishDestroyHandle

WorldBeginTearDownHandle

WorldCleanupHandle

WorldFilterStatesCritical

Synchronization object for accessing WorldTypeFilterStates and NetModeFilterStates, required to ensure there is not competing access between Networking and Gamethread

WorldInitHandle

WorldPostInitHandle

Worlds

Array of currently active and alive UWorlds

WorldSourceFilterManagers

Mapping from UWorld instance to FSourceFilterManager, entries correspond to world instances in Worlds

WorldTypeFilterStates

Per EWorldType enum entry flag, determines whether or not UWorld's of this type should be filtered out