Mostly Harmless

Difference between revisions of "UE3:Engine (UDK)"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
(Talk)
 
m (1 revision: class descriptions for UDK January update (part 2))
 
(One intermediate revision by one other user not shown)
Line 499: Line 499:
 
{{code|native static final function [[bool]] '''IsEditor''' ()}}
 
{{code|native static final function [[bool]] '''IsEditor''' ()}}
  
−
<!-- enter function description -->
+
'''Returns:'''
 +
:the GIsEditor flag setting
  
 
====IsGame====
 
====IsGame====

Latest revision as of 05:39, 17 January 2010

UDK Object >> Subsystem >> Engine
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, UT3
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.

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_BrushShape[edit]

Type: Object.Color


Default value:

Member Value
A 255
B 128
G 255
R 128

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 40
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.

StatColorMapEntry[edit]

Modifiers: native

float In 
Object.Color Out 

StatColorMapping[edit]

Modifiers: native

string StatName 
array<StatColorMapEntry> ColorMap 
bool DisableBlend 

Static native functions[edit]

AddOverlay[edit]

native static final function AddOverlay (Font Font, string Text, float X, float Y, float ScaleX, float ScaleY, bool bIsCentered)

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]

native static final function AddOverlayWrapped (Font Font, string Text, float X, float Y, float ScaleX, float ScaleY, float WrapWidth)

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

GetAdditionalFont[edit]

native static final function Font GetAdditionalFont (int AdditionalFontIndex)

Returns the specified additional font.

Parameters:

  • AdditionalFontIndex - Index into the AddtionalFonts array.

GetAudioDevice[edit]

native static final function AudioDevice GetAudioDevice ()

Returns:

the audio device (will be None if sound is disabled)

GetBuildDate[edit]

native static final function string GetBuildDate ()

Returns version info from the engine

GetCurrentWorldInfo[edit]

native static final function WorldInfo GetCurrentWorldInfo ()

Returns a pointer to the current world.

GetLargeFont[edit]

native static final function Font GetLargeFont ()

Returns the engine's default large font

GetLastMovieName[edit]

native static final function string GetLastMovieName ()

Returns:

Returns the name of the last movie that was played.

GetMediumFont[edit]

native static final function Font GetMediumFont ()

Returns the engine's default medium font

GetSmallFont[edit]

native static final function Font GetSmallFont ()

Returns the engine's default small font

GetSubtitleFont[edit]

native static final function Font GetSubtitleFont ()

Returns the engine's default subtitle font

GetTinyFont[edit]

native static final function Font GetTinyFont ()

Returns the engine's default tiny font

IsEditor[edit]

native static final function bool IsEditor ()

Returns:

the GIsEditor flag setting

IsGame[edit]

native static final function bool IsGame ()

Returns:

the GIsGame flag is setting

IsSplitScreen[edit]

native static final function bool IsSplitScreen ()

Returns:

whether we're currently running in splitscreen (more than one local player)

PlayLoadMapMovie[edit]

native static final function bool PlayLoadMapMovie ()

Play one of the LoadMap loading movies as configured by ini file

Returns:

TRUE if a movie was played

RemoveAllOverlays[edit]

native static final function RemoveAllOverlays ()

Removes all overlays from displaying

StopMovie[edit]

native static final function StopMovie (bool bDelayStopUntilGameHasRendered)

Stops the current movie

Parameters:

  • bDelayStopUntilGameHasRendered - If TRUE, the engine will delay stopping the movie until after the game has rendered at least one frame
Retrieved from "https://wiki.beyondunreal.com/UE3:Engine_(UDK)?oldid=40857"