I love the smell of UnrealEd crashing in the morning. – tarquin

UE3:Engine internal variables (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT3 Object >> Subsystem >> Engine (internal variables)

Contents

Engine internal variables in other games:
UDK

Internal variables

AdditionalFontNames

Type: array<string>

Modifiers: globalconfig


AdditionalFonts

Type: array<Font>

Modifiers: private

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

bAllowMatureLanguage

Type: bool

Modifiers: config

whether mature language is allowed *

bDisablePhysXHardwareSupport

Type: bool

Modifiers: config

Do not use Ageia PhysX hardware

Default value: True

BeginUPTryCount

Type: int

Modifiers: config

The number of times to attempt the Begin*UP call before assuming the GPU is hosed

Default value: 200000

bEnableBranchingPCFShadows

Type: bool

Modifiers: config

Toggle Branching PCF implementation for projected shadows

bEnableColorClear

Type: bool

Modifiers: globalconfig, const

By default, each frame's initial scene color clear is disabled. This flag can be toggled at runtime to enable clearing for development.

bEnableKismetLogging

Type: bool

Modifiers: config

whether kismet logging is enabled.

bEnableVSMShadows

Type: bool

Modifiers: config

Toggle VSM (Variance Shadow Map) usage for projected shadows

bForceCPUSkinning

Type: bool

Modifiers: config

Force to CPU skinning only for skeletal mesh rendering

bOnScreenKismetWarnings

Type: bool

Modifiers: config

whether to send Kismet warning messages to the screen (via PlayerController::ClientMessage())

Default value: True

bPauseOnLossOfFocus

Type: bool

Modifiers: config

Whether to pause the game if focus is lost.

bRenderTerrainCollisionAsOverlay

Type: bool

Modifiers: config

Terrain collision viewing - If TRUE, overlay collision level else render it and overlay terrain.

bUseAdditiveComplexity

Type: bool

Modifiers: globalconfig

When true, pixel shader complexity is cumulative, otherwise only the last pixel drawn contributes complexity. Has no effect if bUsePixelShaderComplexity is false

Default value: True

bUsePixelShaderComplexity

Type: bool

Modifiers: globalconfig

When true, pixel shader complexity is shown, otherwise vertex shader complexity is shown in the shader complexity viewmode.

Default value: True

bUsePostProcessEffects

Type: bool

Modifiers: config

Whether to use post processing effects or not

CameraRotationThreshold

Type: float

Modifiers: config

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

Default value: 45.0

CameraTranslationThreshold

Type: float

Modifiers: config

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

Default value: 10000.0

Client

Type: Client

Modifiers: const

Abstract interface to platform-specific subsystems

ClientCycles

Type: int


ConsoleClass

Type: class<Console>

The class to use for the game console.

ConsoleClassName

Type: string

Modifiers: globalconfig


Default value: "UTGame.UTConsole"

CrossMaterial

Type: Material

Material used for drawing a cross mark.

CrossMaterialName

Type: string

Modifiers: globalconfig


Default value: "EditorMaterials.Cross_Mat"

DataStoreClientClass

Type: class<DataStoreClient>

The class to use for managing the global data stores

DataStoreClientClassName

Type: string

Modifiers: globalconfig


Default value: "Engine.DataStoreClient"

DebugManager

Type: DebugManager

Modifiers: const

Global debug manager helper object that stores configuration and state used during development

DefaultFogVolumeMaterial

Type: Material

The default fog volume material

DefaultFogVolumeMaterialName

Type: string

Modifiers: globalconfig


Default value: "EngineMaterials.FogVolumeMaterial"

DefaultMaterial

Type: Material

The material used when no material is explicitly applied.

DefaultMaterialName

Type: string

Modifiers: globalconfig


Default value: "EngineMaterials.DefaultMaterial"

DefaultOnlineSubsystemName

Type: string

Modifiers: globalconfig


Default value: "OnlineSubsystemGameSpy.OnlineSubsystemGameSpy"

DefaultPhysMaterial

Type: PhysicalMaterial

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

DefaultPhysMaterialName

Type: string

Modifiers: globalconfig


Default value: "EngineMaterials.DefaultPhysicalMaterial"

DefaultPostProcess

Type: PostProcessChain

Default engine post process chain used for the game and main editor view

DefaultPostProcessName

Type: string

Modifiers: config


Default value: "FX_HitEffects.UTPostProcess"

DefaultUICaretMaterial

Type: Material

Material used for drawing meshes when their collision is missing.

DefaultUICaretMaterialName

Type: string

Modifiers: globalconfig


Default value: "EngineMaterials.BlinkingCaret"

DefaultUIScenePostProcess

Type: PostProcessChain

post process chain used for rendering the UI

DefaultUIScenePostProcessName

Type: string

Modifiers: config


Default value: "EngineMaterials.DefaultUIPostProcess"

DeferredCommands

Type: array<string>

Modifiers: init

Array of deferred command strings/ execs that get executed at the end of the frame

DepthBias

Type: float

Modifiers: config

Depth bias that is applied in the depth pass for all types of projected shadows except VSM

Default value: 0.012

DynamicCoverMeshComponentName

Type: string

Modifiers: globalconfig

Overridable class for cover mesh rendering in-game, used to get around the editoronly restrictions needed by the base CoverMeshComponent

EditorBrushMaterial

Type: Material

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

EditorBrushMaterialName

Type: string

Modifiers: globalconfig


Default value: "EngineMaterials.EditorBrushMaterial"

EmissiveTexturedMaterial

Type: Material

A textured material with an instance parameter for the texture.

EmissiveTexturedMaterialName

Type: string

Modifiers: globalconfig


Default value: "EngineMaterials.EmissiveTexturedMaterial"

GameCycles

Type: int


GamePlayers

Type: array<LocalPlayer>

Modifiers: init

Viewports for all players in all game instances (all PIE windows, for example)

GameViewport

Type: GameViewportClient

Modifiers: const

the viewport representing the current game instance

GameViewportClientClass

Type: class<GameViewportClient>

The class to use for the game viewport client.

GameViewportClientClassName

Type: string

Modifiers: globalconfig


Default value: "UTGame.UTGameViewportClient"

GeomMaterial

Type: Material

A translucent material used to render things in geometry mode.

GeomMaterialName

Type: string

Modifiers: globalconfig


Default value: "EngineMaterials.GeomMaterial"

IdealTextureDensity

Type: float

Modifiers: globalconfig


Default value: 13.0

LargeFont

Type: Font

Modifiers: private


LargeFontName

Type: string

Modifiers: globalconfig


Default value: "MultiFont'UI_Fonts_Final.HUD..MF_Large'"

LevelColorationLitMaterial

Type: Material

Material used for visualizing level membership in lit viewport modes.

LevelColorationLitMaterialName

Type: string

Modifiers: globalconfig


Default value: "EngineMaterials.LevelColorationLitMaterial"

LevelColorationUnlitMaterial

Type: Material

Material used for visualizing level membership in unlit viewport modes.

LevelColorationUnlitMaterialName

Type: string

Modifiers: globalconfig


Default value: "EngineMaterials.LevelColorationUnlitMaterial"

LightComplexityColors

Type: array<Object.Color>

Modifiers: globalconfig

The colors used to render light complexity.

Default value, index 0:

Member Value
A 1
B 0
G 0
R 0

Default value, index 1:

Member Value
A 1
B 0
G 255
R 0

Default value, index 2:

Member Value
A 1
B 0
G 191
R 63

Default value, index 3:

Member Value
A 1
B 0
G 127
R 127

Default value, index 4:

Member Value
A 1
B 0
G 63
R 191

Default value, index 5:

Member Value
A 1
B 0
G 0
R 255

LocalPlayerClass

Type: class<LocalPlayer>

The class to use for local players.

LocalPlayerClassName

Type: string

Modifiers: config


Default value: "Engine.LocalPlayer"

MaxParticleResize

Type: int

Modifiers: config

The maximum allowed size to a ParticleEmitterInstance::Resize call. If larger, the function will return without resizing.

Default value: 1024

MaxParticleResizeWarn

Type: int

Modifiers: config

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

Default value: 10240

MaxPixelShaderAdditiveComplexityCount

Type: float

Modifiers: globalconfig

Complexity limits for the various complexity viewmode combinations. These limits are used to map instruction counts to ShaderComplexityColors.

Default value: 300.0

MaxPixelShaderOpaqueComplexityCount

Type: float

Modifiers: globalconfig


Default value: 100.0

MaxTextureDensity

Type: float

Modifiers: globalconfig


Default value: 55.0

MaxVertexShaderComplexityCount

Type: float

Modifiers: globalconfig


Default value: 100.0

MediumFont

Type: Font

Modifiers: private


MediumFontName

Type: string

Modifiers: globalconfig


Default value: "MultiFont'UI_Fonts_Final.HUD.MF_Medium'"

MeshLODRange

Type: float

Modifiers: config

Level of detail range control for meshes

MinTextureDensity

Type: float

Modifiers: globalconfig

Range for the texture density viewmode.

ModShadowFadeDistanceExponent

Type: float

Modifiers: config

controls the rate at which mod shadows will fade as they approach their min shadow size

Default value: 0.2

NetClientTicksPerSecond

Type: float

Modifiers: globalconfig

Number of times to tick each client per second

Default value: 200.0

OnlineSubsystemClass

Type: class<OnlineSubsystem>

OnlineSubsystem class to use for netplay

PendingDroppedNotes

Type: array<DropNoteInfo>

Modifiers: transient


PercentUnoccludedRequeries

Type: float

Modifiers: config

The percent of previously unoccluded primitives which are requeried every frame.

Default value: 0.125

PrimitiveProbablyVisibleTime

Type: float

Modifiers: config

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

Default value: 8.0

RandomAngleTexture

Type: Texture2D

Texture used to get random angles per-pixel by the Branching PCF implementation

RandomAngleTextureName

Type: string

Modifiers: globalconfig


Default value: "EngineMaterials.RandomAngles"

RemoteControlExec

Type: pointer{class FRemoteControlExec}

Modifiers: native

Entry point for RemoteControl, the in-game UI for the exec system.

RemoveSurfaceMaterial

Type: Material

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

RemoveSurfaceMaterialName

Type: string

Modifiers: globalconfig


Default value: "EngineMaterials.RemoveSurfaceMaterial"

SceneCaptureCubeActorMaterial

Type: Material

Material used for visualizing the cube map scene captures on a mesh

SceneCaptureCubeActorMaterialName

Type: string

Modifiers: globalconfig


Default value: "EngineMaterials.CubeMaterial"

SceneCaptureReflectActorMaterial

Type: Material

Material used for visualizing the reflection scene captures on a surface

SceneCaptureReflectActorMaterialName

Type: string

Modifiers: globalconfig


Default value: "EngineMaterials.ScreenMaterial"

ScoutClassName

Type: string

Modifiers: const, config

Class name of the scout to use for path building

Default value: "UTGame.UTScout"

ShaderComplexityColors

Type: array<Object.Color>

Modifiers: globalconfig

The colors used to render shader complexity.

Default value, index 0:

Member Value
A 1
B 100
G 255
R 0

Default value, index 1:

Member Value
A 1
B 0
G 255
R 0

Default value, index 2:

Member Value
A 1
B 0
G 191
R 63

Default value, index 3:

Member Value
A 1
B 0
G 127
R 127

Default value, index 4:

Member Value
A 1
B 0
G 63
R 191

Default value, index 5:

Member Value
A 1
B 0
G 0
R 255

ShadowFilterRadius

Type: float

Modifiers: config

Radius, in shadowmap texels, of the filter disk

Default value: 2.0

ShadowVolumeLightRadiusThreshold

Type: float

Modifiers: config

Lights with radius below threshold will not cast shadow volumes.

Default value: 1000.0

ShadowVolumePrimitiveScreenSpacePercentageThreshold

Type: float

Modifiers: config

Primitives with screen space percantage below threshold will not cast shadow volumes.

Default value: 0.25

SmallFont

Type: Font

Modifiers: private


SmallFontName

Type: string

Modifiers: globalconfig


Default value: "EngineFonts.SmallFont"

TerrainCollisionMaterial

Type: Material

Material used for visualizing terrain collision.

TerrainCollisionMaterialName

Type: string

Modifiers: globalconfig


Default value: "EngineMaterials.TerrainCollisionMaterial"

TerrainErrorMaterial

Type: Material

The material used when terrain compilation is too complex.

TerrainErrorMaterialName

Type: string

Modifiers: globalconfig


Default value: "EngineMaterials.MaterialError_Mat"

TerrainMaterialMaxTextureCount

Type: int

Modifiers: globalconfig


Default value: 16

TerrainTessellationCheckCount

Type: int

Modifiers: globalconfig

This is the number of frames that are used between terrain tessellation re-calculations

Default value: 6

TerrainTessellationCheckDistance

Type: float

Modifiers: globalconfig

The radius from the view origin that terrain tessellation checks should be performed. If 0.0, every component will be checked for tessellation changes each frame.

Default value: 4096.0

ThumbnailMaterialPostProcess

Type: PostProcessChain

post process chain used for material thumbnails

ThumbnailMaterialPostProcessName

Type: string

Modifiers: config


Default value: "EngineMaterials.DefaultThumbnailPostProcess"

ThumbnailParticleSystemPostProcess

Type: PostProcessChain

post process chain used for particle system thumbnails

ThumbnailParticleSystemPostProcessName

Type: string

Modifiers: config


Default value: "EngineMaterials.DefaultThumbnailPostProcess"

ThumbnailSkeletalMeshPostProcess

Type: PostProcessChain

post process chain used for skeletal mesh thumbnails

ThumbnailSkeletalMeshPostProcessName

Type: string

Modifiers: config


Default value: "EngineMaterials.DefaultThumbnailPostProcess"

TickCycles

Type: int


TickMaterial

Type: Material

Material used for drawing a tick mark.

TickMaterialName

Type: string

Modifiers: globalconfig


Default value: "EditorMaterials.Tick_Mat"

TinyFont

Type: Font

Modifiers: private


TinyFontName

Type: string

Modifiers: globalconfig


Default value: "EngineFonts.TinyFont"

TransitionDescription

Type: string

The current transition description text.

TransitionGameType

Type: string

The gametype for the destination map

TransitionType

Type: ETransitionType

The current transition type.

WireframeMaterial

Type: Material

The material used to render wireframe meshes.

WireframeMaterialName

Type: string

Modifiers: globalconfig


Default value: "EngineMaterials.WireframeMaterial"