UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FWorldInitializationValues Struct Reference

#include <WorldInitializationValues.h>

Public Member Functions

 FWorldInitializationValues ()
 
FWorldInitializationValuesInitializeScenes (const bool bInitialize)
 
FWorldInitializationValuesAllowAudioPlayback (const bool bAllow)
 
FWorldInitializationValuesRequiresHitProxies (const bool bRequires)
 
FWorldInitializationValuesCreatePhysicsScene (const bool bCreate)
 
FWorldInitializationValuesCreateNavigation (const bool bCreate)
 
FWorldInitializationValuesCreateAISystem (const bool bCreate)
 
FWorldInitializationValuesShouldSimulatePhysics (const bool bInShouldSimulatePhysics)
 
FWorldInitializationValuesEnableTraceCollision (const bool bInEnableTraceCollision)
 
FWorldInitializationValuesForceUseMovementComponentInNonGameWorld (const bool bInForceUseMovementComponentInNonGameWorld)
 
FWorldInitializationValuesSetTransactional (const bool bInTransactional)
 
FWorldInitializationValuesCreateFXSystem (const bool bCreate)
 
FWorldInitializationValuesCreateWorldPartition (const bool bCreate)
 
FWorldInitializationValuesEnableWorldPartitionStreaming (const bool bEnableStreaming)
 
FWorldInitializationValuesSetDefaultGameMode (TSubclassOf< class AGameModeBase > GameMode)
 

Public Attributes

uint32 bInitializeScenes:1
 
uint32 bAllowAudioPlayback:1
 
uint32 bRequiresHitProxies:1
 
uint32 bCreatePhysicsScene:1
 
uint32 bCreateNavigation:1
 
uint32 bCreateAISystem:1
 
uint32 bShouldSimulatePhysics:1
 
uint32 bEnableTraceCollision:1
 
uint32 bForceUseMovementComponentInNonGameWorld:1
 
uint32 bTransactional:1
 
uint32 bCreateFXSystem:1
 
uint32 bCreateWorldPartition:1
 
uint32 bEnableWorldPartitionStreaming:1
 
TSubclassOf< class AGameModeBase > DefaultGameMode
 

Detailed Description

Struct containing a collection of optional parameters for initialization of a World.

Constructor & Destructor Documentation

◆ FWorldInitializationValues()

FWorldInitializationValues::FWorldInitializationValues ( )
inline

Member Function Documentation

◆ AllowAudioPlayback()

FWorldInitializationValues & FWorldInitializationValues::AllowAudioPlayback ( const bool  bAllow)
inline

◆ CreateAISystem()

FWorldInitializationValues & FWorldInitializationValues::CreateAISystem ( const bool  bCreate)
inline

◆ CreateFXSystem()

FWorldInitializationValues & FWorldInitializationValues::CreateFXSystem ( const bool  bCreate)
inline

◆ CreateNavigation()

FWorldInitializationValues & FWorldInitializationValues::CreateNavigation ( const bool  bCreate)
inline

◆ CreatePhysicsScene()

FWorldInitializationValues & FWorldInitializationValues::CreatePhysicsScene ( const bool  bCreate)
inline

◆ CreateWorldPartition()

FWorldInitializationValues & FWorldInitializationValues::CreateWorldPartition ( const bool  bCreate)
inline

◆ EnableTraceCollision()

FWorldInitializationValues & FWorldInitializationValues::EnableTraceCollision ( const bool  bInEnableTraceCollision)
inline

◆ EnableWorldPartitionStreaming()

FWorldInitializationValues & FWorldInitializationValues::EnableWorldPartitionStreaming ( const bool  bEnableStreaming)
inline

◆ ForceUseMovementComponentInNonGameWorld()

FWorldInitializationValues & FWorldInitializationValues::ForceUseMovementComponentInNonGameWorld ( const bool  bInForceUseMovementComponentInNonGameWorld)
inline

◆ InitializeScenes()

FWorldInitializationValues & FWorldInitializationValues::InitializeScenes ( const bool  bInitialize)
inline

◆ RequiresHitProxies()

FWorldInitializationValues & FWorldInitializationValues::RequiresHitProxies ( const bool  bRequires)
inline

◆ SetDefaultGameMode()

FWorldInitializationValues & FWorldInitializationValues::SetDefaultGameMode ( TSubclassOf< class AGameModeBase >  GameMode)
inline

◆ SetTransactional()

FWorldInitializationValues & FWorldInitializationValues::SetTransactional ( const bool  bInTransactional)
inline

◆ ShouldSimulatePhysics()

FWorldInitializationValues & FWorldInitializationValues::ShouldSimulatePhysics ( const bool  bInShouldSimulatePhysics)
inline

Member Data Documentation

◆ bAllowAudioPlayback

uint32 FWorldInitializationValues::bAllowAudioPlayback

Are sounds allowed to be generated from this world.

◆ bCreateAISystem

uint32 FWorldInitializationValues::bCreateAISystem

Should the AI system be created for this world.

◆ bCreateFXSystem

uint32 FWorldInitializationValues::bCreateFXSystem

Should the FX system be created for this world.

◆ bCreateNavigation

uint32 FWorldInitializationValues::bCreateNavigation

Should the navigation system be created for this world.

◆ bCreatePhysicsScene

uint32 FWorldInitializationValues::bCreatePhysicsScene

Should the physics scene be created. bInitializeScenes must be true for this to be considered.

◆ bCreateWorldPartition

uint32 FWorldInitializationValues::bCreateWorldPartition

Should the world be partitioned

◆ bEnableTraceCollision

uint32 FWorldInitializationValues::bEnableTraceCollision

Are collision trace calls valid within this world.

◆ bEnableWorldPartitionStreaming

uint32 FWorldInitializationValues::bEnableWorldPartitionStreaming

If bCreateWorldPartition is set to true, this flag will init the streaming mode for the WorldPartition object (default to true to preserve previous behavior)

◆ bForceUseMovementComponentInNonGameWorld

uint32 FWorldInitializationValues::bForceUseMovementComponentInNonGameWorld

Special flag to enable movement component in non game worlds (see UMovementComponent::OnRegister)

◆ bInitializeScenes

uint32 FWorldInitializationValues::bInitializeScenes

Should the scenes (physics, rendering) be created.

◆ bRequiresHitProxies

uint32 FWorldInitializationValues::bRequiresHitProxies

Should the render scene create hit proxies.

◆ bShouldSimulatePhysics

uint32 FWorldInitializationValues::bShouldSimulatePhysics

Should physics be simulated in this world.

◆ bTransactional

uint32 FWorldInitializationValues::bTransactional

Should actions performed to objects in this world be saved to the transaction buffer.

◆ DefaultGameMode

TSubclassOf<class AGameModeBase> FWorldInitializationValues::DefaultGameMode

The default game mode for this world (if any)


The documentation for this struct was generated from the following file: