Navigation
API > API/Runtime > API/Runtime/Engine
A volume representing a location in the world. Used for World Partition loading regions.
| Name | ALocationVolume |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Public/LocationVolume.h |
| Include Path | #include "LocationVolume.h" |
Syntax
UCLASS (BlueprintType, Blueprintable,
HideCategories=(Mobility, HLOD, Collision, Navigation, BrushSettings, Tags, Cooking, Replication, Networking, Actor, Mobile, RayTracing, AssetUserData, LevelInstance, DataLayers),
MinimalAPI)
class ALocationVolume :
public AVolume ,
public IWorldPartitionActorLoaderInterface
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → AActor → ABrush → AVolume → ALocationVolume
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
ALocationVolume
(
const FObjectInitializer& ObjectInitializer |
LocationVolume.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsAutoLoad | uint8 | To support per-user last loaded location volumes | LocationVolume.h | |
| DebugColor | FColor | LocationVolume.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| WorldPartitionActorLoader | FLoaderAdapterActor * | LocationVolume.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool IsLoaded() |
Return if this location volume is loaded | LocationVolume.h |
|
void Load() |
Load this location volume | LocationVolume.h |
|
void Unload() |
Unload this location volume | LocationVolume.h |
|
Overridden from AActor
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanChangeIsSpatiallyLoadedFlag() |
Returns true if this actor allows changing the spatially loaded flag. | LocationVolume.h | |
virtual void PostRegisterAllComponents () |
Called after all the components in the Components array are registered, called both in editor and during gameplay. | LocationVolume.h | |
virtual void UnregisterAllComponents
(
bool bForReregister |
Unregister all currently registered components | LocationVolume.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginDestroy() |
LocationVolume.h | ||
virtual bool IsEditorOnly() |
LocationVolume.h |
Overridden from IWorldPartitionActorLoaderInterface
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ILoaderAdapter * GetLoaderAdapter() |
LocationVolume.h |