Show / Hide Table of Contents

Class Engine

Abstract base class of all Engine classes, responsible for management of systems critical to editor or game systems.

Inheritance
System.Object
UObject
Engine
GameEngine
EditorEngine
Inherited Members
UObject.TransientPackage
UObject.CastTo<T>(UObject)
UObject.CastTo(UObject, Type)
UObject.RemoveObject(UObject)
UObject.MakeObjectArrayField<T>(NativeArray*)
UObject.NotImplemented<T>()
UObject.Construct()
UObject.GetHashCode()
UObject.GetName()
UObject.ToString()
UObject.Name
UObject._None
UObject.None
UObject.ObjPointer
UObject.LoadObjectFromClass(Class, UObject, String, String, LoadFlags, PackageMap, Boolean)
UObject.LoadClass(Class, UObject, String, String, LoadFlags, PackageMap)
UObject.GetPropertyFor<T>(Name)
UObject.ExecuteUbergraph
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 Engine : UObject
Remarks

Also defines default classes for certain engine systems.

Properties

| Improve this Doc View Source

AdditionalFonts

Any additional fonts that script may use without hard-referencing the font.

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

AIControllerClassName

name of Controller class to be used as default AIController class for pawns

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

ArrowMaterial

Material that 'fakes' lighting, used for arrows, widgets.

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

ArrowMaterialName

@todo document

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

AssetManager

A UObject spawned at initialization time to handle game-specific data

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

AssetManagerClassName

Name of a singleton class to spawn as the AssetManager, configurable per game. If empty, it will not spawn one

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

AvoidanceManagerClass

The class for behavior tree manager *

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

AvoidanceManagerClassName

Name of behavior tree manager class

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

bAllowMatureLanguage

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

bAllowMultiThreadedAnimationUpdate

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

bCanBlueprintsTickByDefault

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

bCheckForMultiplePawnsSpawnedInAFrame

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

bDisableAILogging

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

bEnableEditorPSysRealtimeLOD

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

bEnableOnScreenDebugMessages

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

bEnableOnScreenDebugMessagesDisplay

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

bIsOverridingSelectedColor

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

bLockReadOnlyLevels

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

BoneWeightMaterial

Material used to render bone weights on skeletal meshes

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

BoneWeightMaterialName

@todo document

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

bOptimizeAnimBlueprintMemberVariableAccess

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

bPauseOnLossOfFocus

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

bRenderLightMapDensityGrayscale

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

bSmoothFrameRate

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

BSPSelectionHighlightIntensity

Used to alter the intensity level of the selection highlight on selected BSP surfaces

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

bStartedLoadMapMovie

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

bSubtitlesEnabled

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

bSubtitlesForcedOff

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

bSuppressMapWarnings

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

bUseFixedFrameRate

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

C_AddWire

@todo document

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

C_BrushShape

@todo document

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

C_BrushWire

@todo document

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

C_BSPCollision

@todo document

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

C_NonSolidWire

@todo document

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

C_OrthoBackground

@todo document

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

C_ScaleBoxHi

@todo document

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

C_SemiSolidWire

@todo document

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

C_SubtractWire

@todo document

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

C_Volume

@todo document

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

C_VolumeCollision

@todo document

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

C_WireBackground

@todo document

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

C_WorldBox

Color preferences.

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

CameraRotationThreshold

camera rotation (deg) beyond which occlusion queries are ignored from previous frame (because they are likely not valid)

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

CameraTranslationThreshold

camera movement beyond which occlusion queries are ignored from previous frame (because they are likely not valid)

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

ClientCycles

@todo document

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

ClothPaintMaterial

Materials used to render cloth properties on skeletal meshes

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

ClothPaintMaterialInstance

Cloth Paint Material Instance

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

ClothPaintMaterialName

Name of the material used to render cloth in the clothing tools

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

ClothPaintMaterialWireframe

Cloth Paint Material Wireframe

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

ClothPaintMaterialWireframeInstance

Cloth Paint Material Wireframe Instance

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

ClothPaintMaterialWireframeName

Name of the material used to render cloth wireframe in the clothing tools

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

ConsoleClass

The class to use for the game console.

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

ConsoleClassName

@todo document

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

ConstraintLimitMaterial

Material used to render constraint limits

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

ConstraintLimitMaterialPrismatic

Constraint Limit Material Prismatic

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

ConstraintLimitMaterialX

Constraint Limit Material X

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

ConstraintLimitMaterialXAxis

Constraint Limit Material XAxis

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

ConstraintLimitMaterialY

Constraint Limit Material Y

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

ConstraintLimitMaterialYAxis

Constraint Limit Material YAxis

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

ConstraintLimitMaterialZ

Constraint Limit Material Z

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

ConstraintLimitMaterialZAxis

Constraint Limit Material ZAxis

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

CurrentCustomTimeStep

Control how the Engine process the Framerate/Timestep

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

CustomTimecodeProvider

Custom Timecode Provider

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

CustomTimeStepClassName

Override how the Engine process the Framerate/Timestep.

Declaration
public SoftClassPath CustomTimeStepClassName { get; set; }
Property Value
Type Description
SoftClassPath
Remarks

This class will be responsible of updating the application Time and DeltaTime. Can be used to synchronize the engine with another process (gen-lock).

| Improve this Doc View Source

DebugEditorMaterial

A material used to render debug meshes.

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

DebugEditorMaterialName

A material used to render debug opaque material. Used in various animation editor viewport features.

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

DebugMeshMaterial

A material used to render debug meshes.

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

DebugMeshMaterialName

@todo document

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

DefaultBloomKernelTexture

Texture used to bloom when using FFT, mimics characteristic bloom produced in a camera from a signle bright source

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

DefaultBloomKernelTextureName

@todo document

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

DefaultBlueprintBaseClassName

Name of the base class to use for new blueprints, configurable on a per-game basis

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

DefaultBokehTexture

Texture used to blur out of focus content, mimics the Bokeh shape of actual cameras

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

DefaultBokehTextureName

@todo document

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

DefaultBSPVertexTexture

@todo document

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

DefaultBSPVertexTextureName

@todo document

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

DefaultCustomTimeStep

Control how the Engine process the Framerate/Timestep

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

DefaultDiffuseTexture

A global default diffuse texture.

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

DefaultDiffuseTextureName

@todo document

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

DefaultObject

Get UE4 Default Object for this Class

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

DefaultPhysMaterial

PhysicalMaterial to use if none is defined for a particular object.

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

DefaultPhysMaterialName

@todo document

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

DefaultSelectedMaterialColor

Default color of selected objects in the level viewport (additive)

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

DefaultTexture

A global default texture.

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

DefaultTextureName

@todo document

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

DefaultTimecodeFrameRate

Frame rate used to generated the engine Timecode's frame number when no TimecodeProvider are specified.

Declaration
public FrameRate DefaultTimecodeFrameRate { get; set; }
Property Value
Type Description
FrameRate
Remarks

It doesn't control the Engine frame rate. The Engine can run faster or slower that the specified TimecodeFrameRate.

| Improve this Doc View Source

DefaultTimecodeProvider

Default timecode provider that will be used when no custom provider is set.

Declaration
public TimecodeProvider DefaultTimecodeProvider { get; set; }
Property Value
Type Description
TimecodeProvider
Remarks

This is expected to be valid throughout the entire life of the application.

| Improve this Doc View Source

DefaultTimecodeProviderClassName

Allows UEngine subclasses a chance to override the DefaultTimecodeProvider class.

Declaration
public SoftClassPath DefaultTimecodeProviderClassName { get; set; }
Property Value
Type Description
SoftClassPath
Remarks

This must be set before InitializeObjectReferences is called. This is intentionally protected and not exposed to config.

| Improve this Doc View Source

DisplayGamma

Current display gamma setting

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

EditorBrushMaterial

A material used to render the sides of the builder brush/volumes/etc.

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

EditorBrushMaterialName

@todo document

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

FixedFrameRate

The fixed framerate to use.

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

GameCycles

@todo document

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

GameScreenshotSaveDirectory

The save directory for newly created screenshots

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

GameSingleton

A UObject spawned at initialization time to handle game-specific data

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

GameSingletonClassName

Name of a singleton class to create at startup time, configurable per game

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

GameUserSettings

Global instance of the user game settings

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

GameUserSettingsClass

Game User Settings Class

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

GameUserSettingsClassName

Game User Settings Class Name

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

GameViewport

The view port representing the current game instance. Can be 0 so don't use without checking.

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

GameViewportClientClass

The class to use for the game viewport client.

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

GameViewportClientClassName

@todo document

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

GeomMaterial

A translucent material used to render things in geometry mode.

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

GeomMaterialName

@todo document

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

HighFrequencyNoiseTexture

Texture used to get random image grain values for post processing

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

HighFrequencyNoiseTextureName

@todo document

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

HoverHighlightIntensity

Used to alter the intensity level of the selection highlight on hovered objects

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

IdealLightMapDensity

Ideal lightmap density value for coloring.

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

InvalidLightmapSettingsMaterial

Material that renders a message about lightmap settings being invalid.

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

InvalidLightmapSettingsMaterialName

@todo document

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

LargeFont

@todo document

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

LargeFontName

@todo document

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

LevelColorationLitMaterial

Material used for visualizing level membership in lit view port modes.

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

LevelColorationUnlitMaterial

Material used for visualizing level membership in unlit view port modes.

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

LevelScriptActorClass

@todo document

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

LevelScriptActorClassName

@todo document

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

LightingOnlyBrightness

@todo document

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

LightingTexelDensityMaterial

Material used for visualizing lighting only w/ lightmap texel density.

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

LightMapDensitySelectedColor

The color to render selected objects in for LightMap Density view mode.

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

LightMapDensityTexture

Texture used to display LightMapDensity

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

LightMapDensityTextureName

@todo document

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

LightMapDensityVertexMappedColor

The color to render vertex mapped objects in for LightMap Density view mode.

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

LocalPlayerClass

The class to use for local players.

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

LocalPlayerClassName

@todo document

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

MaxES2PixelShaderAdditiveComplexityCount

Max ES2Pixel Shader Additive Complexity Count

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

MaxES3PixelShaderAdditiveComplexityCount

Max ES3Pixel Shader Additive Complexity Count

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

MaximumLoopIterationCount

Script maximum loop iteration count used as a threshold to warn users about script execution runaway

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

MaxLightMapDensity

Maximum lightmap density value for coloring.

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

MaxOcclusionPixelsFraction

Max screen pixel fraction where retesting when unoccluded is worth the GPU time.

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

MaxParticleResize

The maximum allowed size to a ParticleEmitterInstance::Resize call.

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

If larger, the function will return without resizing.

| Improve this Doc View Source

MaxParticleResizeWarn

If the resize request is larger than this, spew out a warning to the log

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

MaxPixelShaderAdditiveComplexityCount

Complexity limits for the various complexity view mode combinations.

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

These limits are used to map instruction counts to ShaderComplexityColors.

| Improve this Doc View Source

MediumFont

@todo document

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

MediumFontName

@todo document

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

MeshLODRange

Level of detail range control for meshes

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

MinDesiredFrameRate

Minimum desired framerate setting

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

MiniFontTexture

Texture used to do font rendering in shaders

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

MiniFontTextureName

@todo document

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

MinLightMapDensity

Minimum lightmap density value for coloring.

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

NavigationSystemClass

The class for NavigationSystem *

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

NavigationSystemClassName

@todo document

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

NavigationSystemConfigClass

The class for NavigationSystem *

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

NavigationSystemConfigClassName

Navigation System Config Class Name

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

NearClipPlane

The distance of the camera's near clipping plane.

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

NetClientTicksPerSecond

Number of times to tick each client per second

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

NextWorldContextHandle

Next World Context Handle

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

NumPawnsAllowedToBeSpawnedInAFrame

If bCheckForMultiplePawnsSpawnedInAFrame==true, then we will check to see that no more than this number of pawns are spawned in a frame. *

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

PhysicsCollisionHandlerClass

PhysicsCollisionHandler class we should use by default *

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

PhysicsCollisionHandlerClassName

Name of PhysicsCollisionHandler class we should use by default.

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

PreIntegratedSkinBRDFTexture

Texture used for pre-integrated skin shading

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

PreIntegratedSkinBRDFTextureName

@todo document

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

PreviewShadowsIndicatorMaterial

Material that renders a message about preview shadows being used.

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

PreviewShadowsIndicatorMaterialName

@todo document

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

PrimitiveProbablyVisibleTime

The amount of time a primitive is considered to be probably visible after it was last actually visible.

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

RemoveSurfaceMaterial

Material used to indicate that the associated BSP surface should be removed.

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

RemoveSurfaceMaterialName

@todo document

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

RenderLightMapDensityColorScale

The scale factor when rendering color density.

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

RenderLightMapDensityGrayscaleScale

The scale factor when rendering gray scale density.

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

ScreenSaverInhibitorSemaphore

Semaphore to control screen saver inhibitor thread access.

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

SelectedMaterialColor

Color of selected objects in the level viewport (additive)

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

SelectedMaterialColorOverride

An override to use in some cases instead of the selected material color

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

SelectionHighlightIntensity

Used to alter the intensity level of the selection highlight on selected objects

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

SelectionHighlightIntensityBillboards

Used to alter the intensity level of the selection highlight on selected billboard objects

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

SelectionMeshSectionHighlightIntensity

Used to alter the intensity level of the selection highlight on selected mesh sections in mesh editors

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

SelectionOutlineColor

Color of the selection outline color. Generally the same as selected material color unless the selection material color is being overridden

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

ShadedLevelColorationLitMaterial

Material used for visualizing level membership in lit view port modes. Uses shading to show axis directions.

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

ShadedLevelColorationUnlitMaterial

Material used for visualizing level membership in unlit view port modes. Uses shading to show axis directions.

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

SmallFont

@todo document

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

SmallFontName

@todo document

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

SmoothedFrameRateRange

Range of framerates in which smoothing will kick in

Declaration
public FloatRange SmoothedFrameRateRange { get; set; }
Property Value
Type Description
FloatRange
| 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

StreamingDistanceFactor

Fudge factor for tweaking the distance based miplevel determination

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

SubduedSelectionOutlineColor

Subdued version of the selection outline color. Used for indicating sub-selection of components vs actors

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

SubtitleFont

@todo document

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

SubtitleFontName

@todo document

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

TickCycles

@todo document

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

TimecodeProviderClassName

Override the CustomTimecodeProvider when the engine is started.

Declaration
public SoftClassPath TimecodeProviderClassName { get; set; }
Property Value
Type Description
SoftClassPath
Remarks

When set, this does not change the DefaultTImecodeProvider class. Instead, it will create an instance and set it as the CustomTimecodeProvider.

| Improve this Doc View Source

TinyFont

Fonts.

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

TinyFontName

@todo document

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

TransitionType

The current transition type.

Declaration
public byte TransitionType { get; set; }
Property Value
Type Description
System.Byte
| Improve this Doc View Source

VertexColorMaterial

Material that renders vertex color as emmissive.

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

VertexColorViewModeMaterial_AlphaAsColor

Material for visualizing vertex colors on meshes in the scene (alpha channel as color)

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

VertexColorViewModeMaterial_BlueOnly

Material for visualizing vertex colors on meshes in the scene (blue only)

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

VertexColorViewModeMaterial_ColorOnly

Material for visualizing vertex colors on meshes in the scene (color only, no alpha)

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

VertexColorViewModeMaterial_GreenOnly

Material for visualizing vertex colors on meshes in the scene (green only)

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

VertexColorViewModeMaterial_RedOnly

Material for visualizing vertex colors on meshes in the scene (red only)

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

WeightMapPlaceholderTexture

Texture used as a placeholder for terrain weight-maps to give the material the correct texture format.

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

WeightMapPlaceholderTextureName

@todo document

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

WireframeMaterial

The material used to render wireframe meshes.

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

WorldSettingsClass

The class for WorldSettings *

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

WorldSettingsClassName

@todo document

Declaration
public SoftClassPath WorldSettingsClassName { get; set; }
Property Value
Type Description
SoftClassPath

Methods

| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

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

Operators

| Improve this Doc View Source

Implicit(IntPtr to Engine)

Convert from IntPtr to UObject

Declaration
public static implicit operator Engine(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
Engine
  • Improve this Doc
  • View Source
Back to top Generated by DocFX