FViewportWorldOptions

#include <ViewportWorlds/Public/ViewportWorldTypes.h>

Collaboration diagram

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class FViewportWorldOptions["FViewportWorldOptions"]
  class UViewportWorldGameInstance["UViewportWorldGameInstance"]
  FViewportWorldOptions *-- UViewportWorldGameInstance

Class detail

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class FViewportWorldOptions {
    +OverrideGameMode : TSoftClassPtr< AGameModeBase >
    +OverrideGameInstance : TSoftClassPtr< UViewportWorldGameInstanc
    +bTickWorld : bool
    +GetIVS() const FWorldInitializationValues
    +FViewportWorldOptions()
    +bInitializeScenes : bool
    +bAllowAudioPlayback : bool
    +bRequiresHitProxies : bool
    +bCreatePhysicsScene : bool
    +bCreateNavigation : bool
    +bCreateAI_System : bool
    +bEnableTraceCollision : bool
    +bCreateFX_System : bool
    +bCreateWorldPartition : bool
  }

struct FViewportWorldOptions

Defined in ViewportWorldTypes.h:170 Represents the options for a viewport world.

Public Attributes

Return	Name	Description
`TSoftClassPtr< AGameModeBase >`	`OverrideGameMode`	Represents the override game mode for a viewport world.
`TSoftClassPtr< UViewportWorldGameInstance >`	`OverrideGameInstance`
`bool`	`bTickWorld`	Should the world be ticked?

OverrideGameMode

TSoftClassPtr< AGameModeBase > OverrideGameMode

Defined in ViewportWorldTypes.h:216 Represents the override game mode for a viewport world.

Referenced by

OverrideGameInstance

TSoftClassPtr< UViewportWorldGameInstance > OverrideGameInstance

Defined in ViewportWorldTypes.h:219

Referenced by

Internal_LoadWorld

bTickWorld

bool bTickWorld

Defined in ViewportWorldTypes.h:223 Should the world be ticked?

Referenced by

Internal_LoadWorld

Public Methods

Return	Name	Description
`FWorldInitializationValues`	`GetIVS` `const`	GetIVS is a method of FViewportWorldOptions class that returns the FWorldInitializationValues object.
	`FViewportWorldOptions` `inline`	Default constructor

GetIVS

const

FWorldInitializationValues GetIVS() const

Defined in ViewportWorldTypes.h:234 GetIVS is a method of FViewportWorldOptions class that returns the FWorldInitializationValues object.

This method initializes the FWorldInitializationValues object based on the values of the properties of FViewportWorldOptions class. It sets various properties such as initialization scenes, audio playback, hit proxies, physics scene, navigation, AI system, trace collision, transactional, FX system, world partition, override game mode, and tick world.

Returns

FWorldInitializationValues - The initialized FWorldInitializationValues object with the specified properties.

Referenced by

Internal_LoadWorld

FViewportWorldOptions

inline

inline FViewportWorldOptions()

Defined in ViewportWorldTypes.h:237 Default constructor

Protected Attributes

Return	Name	Description
`bool`	`bInitializeScenes`	Should the scenes (physics, rendering) be created.
`bool`	`bAllowAudioPlayback`	Are sounds allowed to be generated from this world.
`bool`	`bRequiresHitProxies`	Should the render scene create hit proxies.
`bool`	`bCreatePhysicsScene`	Should the physics scene be created. bInitializeScenes must be true for this to be considered.
`bool`	`bCreateNavigation`	Should the navigation system be created for this world.
`bool`	`bCreateAI_System`	Should the AI system be created for this world.
`bool`	`bEnableTraceCollision`	Are collision trace calls valid within this world.
`bool`	`bCreateFX_System`	Should the FX system be created for this world.
`bool`	`bCreateWorldPartition`	Should the world be partitioned