The three virtues of a programmer: Laziness, Impatience, and Hubris. – Larry Wall
UE3:Engine (UT3)
- Package:
- Engine
- Known classes within Engine:
- GameViewportClient, LocalPlayer, UTGameViewportClient
- Direct subclasses:
- EditorEngine, GameEngine
- This class in other games:
- RTNP, U1, UT, U2, UE2Runtime, UT2003, U2XMP, UT2004, UDK
| This is an auto-generated page and may need human attention. Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete. |
Engine: The base class of the global application object classes. Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.
Properties[edit]
Property group 'Colors'[edit]
C_AddWire[edit]
Type: Object.Color
Default value:
| Member | Value |
|---|---|
| A | 255 |
| B | 255 |
| G | 127 |
| R | 127 |
C_BrushWire[edit]
Type: Object.Color
Default value:
| Member | Value |
|---|---|
| A | 255 |
| B | 0 |
| G | 0 |
| R | 192 |
C_BSPCollision[edit]
Type: Object.Color
Default value:
| Member | Value |
|---|---|
| A | 255 |
| B | 223 |
| G | 157 |
| R | 149 |
C_NonSolidWire[edit]
Type: Object.Color
Default value:
| Member | Value |
|---|---|
| A | 255 |
| B | 32 |
| G | 192 |
| R | 63 |
C_OrthoBackground[edit]
Type: Object.Color
Default value:
| Member | Value |
|---|---|
| A | 255 |
| B | 163 |
| G | 163 |
| R | 163 |
C_ScaleBoxHi[edit]
Type: Object.Color
Default value:
| Member | Value |
|---|---|
| A | 255 |
| B | 157 |
| G | 149 |
| R | 223 |
C_SemiSolidWire[edit]
Type: Object.Color
Default value:
| Member | Value |
|---|---|
| A | 255 |
| B | 0 |
| G | 255 |
| R | 127 |
C_SubtractWire[edit]
Type: Object.Color
Default value:
| Member | Value |
|---|---|
| A | 255 |
| B | 63 |
| G | 192 |
| R | 255 |
C_Volume[edit]
Type: Object.Color
Default value:
| Member | Value |
|---|---|
| A | 255 |
| B | 255 |
| G | 196 |
| R | 255 |
C_VolumeCollision[edit]
Type: Object.Color
Default value:
| Member | Value |
|---|---|
| A | 255 |
| B | 157 |
| G | 223 |
| R | 149 |
C_WireBackground[edit]
Type: Object.Color
Default value:
| Member | Value |
|---|---|
| A | 255 |
| B | 0 |
| G | 0 |
| R | 0 |
C_WorldBox[edit]
Type: Object.Color
Default value:
| Member | Value |
|---|---|
| A | 255 |
| B | 107 |
| G | 0 |
| R | 0 |
Property group 'Settings'[edit]
bForceStaticTerrain[edit]
Type: bool
Modifiers: config
Flag for forcing terrain to be 'static' (MinTessellationLevel = MaxTesselationLevel) Game time only...
bSubtitlesEnabled[edit]
Type: bool
Modifiers: config
Flag for completely disabling subtitles for localized sounds.
Default value: True
bSubtitlesForcedOff[edit]
Type: bool
Modifiers: config
Flag for forcibly disabling subtitles even if you try to turn them back on they will be off
bUseBackgroundLevelStreaming[edit]
Type: bool
Modifiers: config
Whether to allow background level streaming.
Default value: True
bUseSound[edit]
Type: bool
Modifiers: config
Default value: True
bUseTextureStreaming[edit]
Type: bool
Modifiers: config
Whether to use texture streaming.
Default value: True
StreamingDistanceFactor[edit]
Type: float
Fudge factor for tweaking the distance based miplevel determination
TimeBetweenPurgingPendingKillObjects[edit]
Type: float
Modifiers: config
Time in seconds (game time) we should wait between purging object references to objects that are pending kill
Default value: 30.0
Internal variables[edit]
See Engine internal variables.
Enums[edit]
ETransitionType[edit]
A transition type.
- TT_None
- TT_Paused
- TT_Loading
- TT_Saving
- TT_Connecting
- TT_Precaching
Structs[edit]
DropNoteInfo[edit]
Modifiers: native
Info about one note dropped in the map during PIE.
- Object.Vector Location
- Location to create Note actor in edited level.
- Object.Rotator Rotation
- Rotation to create Note actor in edited level.
- string Comment
- Text to assign to Note actor in edited level.
Static native functions[edit]
AddOverlay[edit]
Adds a text overlay to the movie
Parameters:
- Font - Font to use to display (must be in the root set so this will work during loads)
- Text - Text to display
- X - X location in resolution-independent coordinates (ignored if centered)
- Y - Y location in resolution-independent coordinates
- ScaleX - Text horizontal scale
- ScaleY - Text vertical scale
- bIsCentered - TRUE if the text should be centered
AddOverlayWrapped[edit]
Adds a wrapped text overlay to the movie
Parameters:
- Font - Font to use to display (must be in the root set so this will work during loads)
- Text - Text to display
- X - X location in resolution-independent coordinates (ignored if centered)
- Y - Y location in resolution-independent coordinates
- ScaleX - Text horizontal scale
- ScaleY - Text vertical scale
- WrapWidth - Number of pixels before text should wrap
CheatWasEnabled[edit]
Call when a cheat was enabled, to disable achievement progress
GetAdditionalFont[edit]
Returns the specified additional font.
Parameters:
- AdditionalFontIndex - Index into the AddtionalFonts array.
GetAudioDevice[edit]
Returns:
- the audio device (will be None if sound is disabled)
GetCurrentWorldInfo[edit]
Returns a pointer to the current world.
GetLargeFont[edit]
Returns the engine's default large font
GetLastMovieName[edit]
Returns:
- Returns the name of the last movie that was played.
GetMediumFont[edit]
Returns the engine's default medium font
GetSmallFont[edit]
Returns the engine's default small font
GetTinyFont[edit]
Returns the engine's default tiny font
IsSplitScreen[edit]
Returns:
- whether we're currently running in splitscreen (more than one local player)
PlayLoadMapMovie[edit]
Play one of the LoadMap loading movies as configured by ini file
Returns:
- TRUE if a movie was played
RemoveAllOverlays[edit]
Removes all overlays from displaying
StopMovie[edit]
Stops the current movie
