FLevelUtils Class Reference

#include <LevelUtils.h>

Classes
struct	FApplyLevelTransformParams

Static Public Member Functions
static ENGINE_API ULevelStreaming *	FindStreamingLevel (const ULevel *Level)
static ENGINE_API ULevelStreaming *	FindStreamingLevel (UWorld *InWorld, const FName PackageName)
static ENGINE_API ULevelStreaming *	FindStreamingLevel (UWorld *InWorld, const TCHAR *PackageName)
static ENGINE_API bool	IsValidStreamingLevel (UWorld *InWorld, const TCHAR *InPackageName)
static ENGINE_API bool	IsServerStreamingLevelVisible (UWorld *InWorld, const FName &InPackageName)
static ENGINE_API ULevelStreaming *	GetServerVisibleStreamingLevel (UWorld *InWorld, const FName &InPackageName)
static ENGINE_API bool	SupportsMakingVisibleTransactionRequests (UWorld *InWorld)
static ENGINE_API bool	SupportsMakingInvisibleTransactionRequests (UWorld *InWorld)
static ENGINE_API bool	IsLevelLoaded (ULevel *Level)
static ENGINE_API bool	IsLevelVisible (const ULevel *Level)
static ENGINE_API void	ApplyLevelTransform (const FApplyLevelTransformParams &TransformParams)

Detailed Description

A set of static methods for common editor operations that operate on ULevel objects.

Member Function Documentation

ApplyLevelTransform()

void FLevelUtils::ApplyLevelTransform ( const FApplyLevelTransformParams &  TransformParams )

static

Transforms the level to a new world space

FindStreamingLevel() [1/3]

ULevelStreaming * FLevelUtils::FindStreamingLevel ( const ULevel *  Level )

static

Returns the streaming level corresponding to the specified ULevel, or NULL if none exists.

Parameters

Level

The level to query.

Returns

The level's streaming level, or NULL if none exists.

FindStreamingLevel() [2/3]

ULevelStreaming * FLevelUtils::FindStreamingLevel ( UWorld *  InWorld, const FName  PackageName  )

static

Returns the streaming level by package FName, or NULL if none exists.

Parameters

InWorld	World to look in for the streaming level
PackageFName	FName of the package containing the ULevel to query

Returns

The level's streaming level, or NULL if none exists.

FindStreamingLevel() [3/3]

ULevelStreaming * FLevelUtils::FindStreamingLevel ( UWorld *  InWorld, const TCHAR *  PackageName  )

static

Returns the streaming level by package name, or NULL if none exists.

Parameters

InWorld	World to look in for the streaming level
PackageName	Name of the package containing the ULevel to query

Returns

The level's streaming level, or NULL if none exists.

GetServerVisibleStreamingLevel()

ULevelStreaming * FLevelUtils::GetServerVisibleStreamingLevel ( UWorld *  InWorld, const FName &  InPackageName  )

static

Returns the streaming level by package name if visible on server, or NULL if none exists.

Parameters

InWorld	World to look in for the streaming level
PackageName	Name of the package containing the ULevel to query

Returns

The level's streaming level if visible on server, or NULL if none exists.

IsLevelLoaded()

bool FLevelUtils::IsLevelLoaded ( ULevel *  Level )

static

Returns true if the level is currently loaded in the editor, false otherwise.

Parameters

Level

The level to query.

Returns

true if the level is loaded, false otherwise.

Returns true if the specified level is locked for edit, false otherwise.

Parameters

Level

The level to query.

Returns

true if the level is locked, false otherwise. Returns true if the level is currently loaded in the editor, false otherwise.

Parameters

Level

The level to query.

Returns

true if the level is loaded, false otherwise.

IsLevelVisible()

bool FLevelUtils::IsLevelVisible ( const ULevel *  Level )

static

Returns true if the specified level is visible in the editor, false otherwise.

Parameters

StreamingLevel	The level to query. Returns true if the specified level is visible in the editor, false otherwise.
Level	The level to query.

Returns true if the specified level is visible in the editor, false otherwise.

Parameters

Level

The level to query.

IsServerStreamingLevelVisible()

bool FLevelUtils::IsServerStreamingLevelVisible ( UWorld *  InWorld, const FName &  InPackageName  )

static

Returns whether the given package is part of the world server visible streaming levels or not.

Parameters

InWorld	World to look in for the streaming level
InPackageName	Name of the package containing the ULevel to query

Returns

True if the given package is referenced by one of the world server visible streaming levels, else False.

IsValidStreamingLevel()

bool FLevelUtils::IsValidStreamingLevel ( UWorld *  InWorld, const TCHAR *  InPackageName  )

static

Returns whether the given package is referenced by one of the world streaming levels or not.

Parameters

InWorld	World to look in for the streaming level
InPackageName	Name of the package containing the ULevel to query

Returns

True if the given package is referenced by one of the world streaming levels, else False.

SupportsMakingInvisibleTransactionRequests()

bool FLevelUtils::SupportsMakingInvisibleTransactionRequests ( UWorld *  InWorld )

static

Returns whether the world supports for a client to use "making invisible" transaction requests to the server.

SupportsMakingVisibleTransactionRequests()

bool FLevelUtils::SupportsMakingVisibleTransactionRequests ( UWorld *  InWorld )

static

Returns whether the world supports for a client to use "making visible" transaction requests to the server.

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Engine/Public/LevelUtils.h
• Engine/Source/Runtime/Engine/Private/LevelUtils.cpp