Class WorldSettings

Actor containing all script accessible world properties.

Inheritance
System.Object
UObject
Actor
Info
WorldSettings
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.Engine
Assembly: UE4DotNet.dll
Syntax
public class WorldSettings : Info

Properties

| Improve this Doc View Source

AssetUserData

Array of user data stored with the asset

Declaration
public ObjectArrayField<AssetUserData> AssetUserData { get; }
Property Value
Type Description
ObjectArrayField<AssetUserData>
| Improve this Doc View Source

bEnableAISystem

Declaration
public bool bEnableAISystem { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bEnableHierarchicalLODSystem

Declaration
public bool bEnableHierarchicalLODSystem { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bEnableNavigationSystem

Declaration
public bool bEnableNavigationSystem { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bEnableWorldBoundsChecks

Declaration
public bool bEnableWorldBoundsChecks { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bEnableWorldComposition

Declaration
public bool bEnableWorldComposition { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bEnableWorldOriginRebasing

Declaration
public bool bEnableWorldOriginRebasing { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bForceNoPrecomputedLighting

Declaration
public bool bForceNoPrecomputedLighting { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bGenerateSingleClusterForLevel

Declaration
public bool bGenerateSingleClusterForLevel { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bGlobalGravitySet

Declaration
public bool bGlobalGravitySet { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bHighPriorityLoading

Declaration
public bool bHighPriorityLoading { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bHighPriorityLoadingLocal

Declaration
public bool bHighPriorityLoadingLocal { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bMinimizeBSPSections

Declaration
public bool bMinimizeBSPSections { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

BookmarkArray

Bookmark Array

Declaration
public ObjectArrayField<BookmarkBase> BookmarkArray { get; }
Property Value
Type Description
ObjectArrayField<BookmarkBase>
| Improve this Doc View Source

BookMarks

Book Marks

Declaration
public BookMark BookMarks { get; set; }
Property Value
Type Description
BookMark
| Improve this Doc View Source

bOverrideDefaultBroadphaseSettings

Declaration
public bool bOverrideDefaultBroadphaseSettings { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bPlaceCellsOnlyAlongCameraTracks

Declaration
public bool bPlaceCellsOnlyAlongCameraTracks { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bPrecomputeVisibility

Declaration
public bool bPrecomputeVisibility { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

BroadphaseSettings

Broadphase Settings

Declaration
public BroadphaseSettings BroadphaseSettings { get; set; }
Property Value
Type Description
BroadphaseSettings
| Improve this Doc View Source

bUseClientSideLevelStreamingVolumes

Declaration
public bool bUseClientSideLevelStreamingVolumes { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bWorldGravitySet

Declaration
public bool bWorldGravitySet { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

DefaultAmbientZoneSettings

Default interior settings used by audio volumes.

Declaration
public InteriorSettings DefaultAmbientZoneSettings { get; set; }
Property Value
Type Description
InteriorSettings
| Improve this Doc View Source

DefaultBaseSoundMix

Default Base SoundMix.

Declaration
public SoundMix DefaultBaseSoundMix { get; set; }
Property Value
Type Description
SoundMix
| Improve this Doc View Source

DefaultBookmarkClass

Class that will be used when creating new bookmarks.

Declaration
public SubclassOf<BookmarkBase> DefaultBookmarkClass { get; set; }
Property Value
Type Description
SubclassOf<BookmarkBase>
Remarks

Old bookmarks may be recreated with the new class where possible.

| Improve this Doc View Source

DefaultColorScale

Default color scale for the level

Declaration
public Vector DefaultColorScale { get; }
Property Value
Type Description
Vector
| Improve this Doc View Source

DefaultGameMode

The default GameMode to use when starting this map in the game. If this value is NULL, the INI setting for default game type is used.

Declaration
public SubclassOf<GameModeBase> DefaultGameMode { get; }
Property Value
Type Description
SubclassOf<GameModeBase>
| Improve this Doc View Source

DefaultMaxDistanceFieldOcclusionDistance

Max occlusion distance used by mesh distance fields, overridden if there is a movable skylight.

Declaration
public float DefaultMaxDistanceFieldOcclusionDistance { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static WorldSettings DefaultObject { get; }
Property Value
Type Description
WorldSettings
| Improve this Doc View Source

DefaultPhysicsVolumeClass

level specific default physics volume

Declaration
public SubclassOf<DefaultPhysicsVolume> DefaultPhysicsVolumeClass { get; }
Property Value
Type Description
SubclassOf<DefaultPhysicsVolume>
| Improve this Doc View Source

DefaultReverbSettings

Default reverb settings used by audio volumes.

Declaration
public ReverbSettings DefaultReverbSettings { get; set; }
Property Value
Type Description
ReverbSettings
| Improve this Doc View Source

DemoPlayTimeDilation

Additional TimeDilation used to control demo playback speed

Declaration
public float DemoPlayTimeDilation { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

DynamicIndirectShadowsSelfShadowingIntensity

Controls the intensity of self-shadowing from capsule indirect shadows.

Declaration
public float DynamicIndirectShadowsSelfShadowingIntensity { get; set; }
Property Value
Type Description
System.Single
Remarks

These types of shadows use approximate occluder representations, so reducing self-shadowing intensity can hide those artifacts.

| Improve this Doc View Source

GameNetworkManagerClass

Class of GameNetworkManager to spawn for network games

Declaration
public SubclassOf<GameNetworkManager> GameNetworkManagerClass { get; set; }
Property Value
Type Description
SubclassOf<GameNetworkManager>
| Improve this Doc View Source

GlobalDistanceFieldViewDistance

Distance from the camera that the global distance field should cover.

Declaration
public float GlobalDistanceFieldViewDistance { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

GlobalGravityZ

optional level specific gravity override set by level designer

Declaration
public float GlobalGravityZ { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

KillZ

any actor falling below this level gets destroyed

Declaration
public float KillZ { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

KillZDamageType

The type of damage inflicted when a actor falls below KillZ

Declaration
public SubclassOf<DamageType> KillZDamageType { get; }
Property Value
Type Description
SubclassOf<DamageType>
| Improve this Doc View Source

LastBookmarkClass

Tracked so we can detect changes from Config

Declaration
public SubclassOf<BookmarkBase> LastBookmarkClass { get; set; }
Property Value
Type Description
SubclassOf<BookmarkBase>
| Improve this Doc View Source

LightmassSettings

Lightmass Settings

Declaration
public LightmassWorldInfoSettings LightmassSettings { get; set; }
Property Value
Type Description
LightmassWorldInfoSettings
| Improve this Doc View Source

MatineeTimeDilation

Additional time dilation used by Matinee (or Sequencer) slomo track.

Declaration
public float MatineeTimeDilation { get; set; }
Property Value
Type Description
System.Single
Remarks

Transient because this is often temporarily modified by the editor when previewing slow motion effects, yet we don't want it saved or loaded from level packages.

| Improve this Doc View Source

MaxGlobalTimeDilation

Highest acceptable global time dilation.

Declaration
public float MaxGlobalTimeDilation { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

MaxNumberOfBookmarks

Maximum number of bookmarks allowed.

Declaration
public int MaxNumberOfBookmarks { get; set; }
Property Value
Type Description
System.Int32
Remarks

Changing this will change the allocation of the bookmarks array, and when shrinking may cause some bookmarks to become eligible for GC.

| Improve this Doc View Source

MaxUndilatedFrameTime

Largest possible frametime, not considering dilation. Equiv to 1/SlowestFPS.

Declaration
public float MaxUndilatedFrameTime { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

MinGlobalTimeDilation

Lowest acceptable global time dilation.

Declaration
public float MinGlobalTimeDilation { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

MinUndilatedFrameTime

Smallest possible frametime, not considering dilation. Equiv to 1/FastestFPS.

Declaration
public float MinUndilatedFrameTime { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

MonoCullingDistance

Distance from the player after which content will be rendered in mono if monoscopic far field rendering is activated

Declaration
public float MonoCullingDistance { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

NavigationSystemConfig

Holds parameters for NavigationSystem's creation.

Declaration
public NavigationSystemConfig NavigationSystemConfig { get; }
Property Value
Type Description
NavigationSystemConfig
Remarks

Set to Null will result in NavigationSystem instance not being created for this world. Note that if set NavigationSystemConfigOverride will be used instead.

| Improve this Doc View Source

NavigationSystemConfigOverride

Overrides NavigationSystemConfig.

Declaration
public NavigationSystemConfig NavigationSystemConfigOverride { get; set; }
Property Value
Type Description
NavigationSystemConfig
| Improve this Doc View Source

NumHLODLevels

Num HLODLevels

Declaration
public int NumHLODLevels { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

PackedLightAndShadowMapTextureSize

Maximum size of textures for packed light and shadow maps

Declaration
public int PackedLightAndShadowMapTextureSize { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

Pauser

If paused, FName of person pausing the game.

Declaration
public PlayerState Pauser { get; set; }
Property Value
Type Description
PlayerState
| Improve this Doc View Source

PhysicsCollisionHandlerClass

optional level specific collision handler

Declaration
public SubclassOf<PhysicsCollisionHandler> PhysicsCollisionHandlerClass { get; }
Property Value
Type Description
SubclassOf<PhysicsCollisionHandler>
| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class
| Improve this Doc View Source

TimeDilation

Normally 1 - scales real time passage.

Declaration
public float TimeDilation { get; set; }
Property Value
Type Description
System.Single
Remarks

Warning - most use cases should use GetEffectiveTimeDilation() instead of reading from this directly

| Improve this Doc View Source

VisibilityAggressiveness

Determines how aggressive precomputed visibility should be.

Declaration
public byte VisibilityAggressiveness { get; set; }
Property Value
Type Description
System.Byte
Remarks

More aggressive settings cull more objects but also cause more visibility errors like popping.

| Improve this Doc View Source

VisibilityCellSize

World space size of precomputed visibility cells in x and y.

Declaration
public int VisibilityCellSize { get; set; }
Property Value
Type Description
System.Int32
Remarks

Smaller sizes produce more effective occlusion culling at the cost of increased runtime memory usage and lighting build times.

| Improve this Doc View Source

WorldGravityZ

current gravity actually being used

Declaration
public float WorldGravityZ { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

WorldToMeters

scale of 1uu to 1m in real world measurements, for HMD and other physically tracked devices (e.g. 1uu = 1cm would be 100.0)

Declaration
public float WorldToMeters { get; }
Property Value
Type Description
System.Single

Methods

| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static WorldSettings New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
WorldSettings

Operators

| Improve this Doc View Source

Implicit(IntPtr to WorldSettings)

Convert from IntPtr to UObject

Declaration
public static implicit operator WorldSettings(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
WorldSettings