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

Revision as of 11:47, 6 November 2009 (edit) (Talk)		Revision as of 05:24, 17 January 2010 (edit) (undo) (Talk) Newer edit →
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====

---

Revision as of 05:24, 17 January 2010

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

Property group 'Colors'

C_AddWire

Type: Object.Color

Default value:

Member	Value
A	255
B	255
G	127
R	127

C_BrushShape

Type: Object.Color

Default value:

Member	Value
A	255
B	128
G	255
R	128

C_BrushWire

Type: Object.Color

Default value:

Member	Value
A	255
B	0
G	0
R	192

C_BSPCollision

Type: Object.Color

Default value:

Member	Value
A	255
B	223
G	157
R	149

C_NonSolidWire

Type: Object.Color

Default value:

Member	Value
A	255
B	32
G	192
R	63

C_OrthoBackground

Type: Object.Color

Default value:

Member	Value
A	255
B	163
G	163
R	163

C_ScaleBoxHi

Type: Object.Color

Default value:

Member	Value
A	255
B	157
G	149
R	223

C_SemiSolidWire

Type: Object.Color

Default value:

Member	Value
A	255
B	0
G	255
R	127

C_SubtractWire

Type: Object.Color

Default value:

Member	Value
A	255
B	63
G	192
R	255

C_Volume

Type: Object.Color

Default value:

Member	Value
A	255
B	255
G	196
R	255

C_VolumeCollision

Type: Object.Color

Default value:

Member	Value
A	255
B	157
G	223
R	149

C_WireBackground

Type: Object.Color

Default value:

Member	Value
A	255
B	0
G	0
R	0

C_WorldBox

Type: Object.Color

Default value:

Member	Value
A	255
B	40
G	0
R	0

Property group 'Settings'

bForceStaticTerrain

Type: bool

Modifiers: config

Flag for forcing terrain to be 'static' (MinTessellationLevel = MaxTesselationLevel) Game time only...

bSubtitlesEnabled

Type: bool

Modifiers: config

Flag for completely disabling subtitles for localized sounds.

Default value: True

bSubtitlesForcedOff

Type: bool

Modifiers: config

Flag for forcibly disabling subtitles even if you try to turn them back on they will be off

bUseBackgroundLevelStreaming

Type: bool

Modifiers: config

Whether to allow background level streaming.

Default value: True

bUseSound

Type: bool

Modifiers: config

Default value: True

bUseTextureStreaming

Type: bool

Modifiers: config

Whether to use texture streaming.

Default value: True

StreamingDistanceFactor

Type: float

Fudge factor for tweaking the distance based miplevel determination

TimeBetweenPurgingPendingKillObjects

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

See Engine internal variables.

Enums

ETransitionType

A transition type.

TT_None 

TT_Paused 

TT_Loading 

TT_Saving 

TT_Connecting 

TT_Precaching 

Structs

DropNoteInfo

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

Modifiers: native

float In 

Object.Color Out 

StatColorMapping

Modifiers: native

string StatName 

array<StatColorMapEntry> ColorMap 

bool DisableBlend 

Static native functions

AddOverlay

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

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

Returns the specified additional font.

Parameters:

• AdditionalFontIndex - Index into the AddtionalFonts array.

GetAudioDevice

Returns:

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

GetBuildDate

Returns version info from the engine

GetCurrentWorldInfo

Returns a pointer to the current world.

GetLargeFont

Returns the engine's default large font

GetLastMovieName

Returns:

Returns the name of the last movie that was played.

GetMediumFont

Returns the engine's default medium font

GetSmallFont

Returns the engine's default small font

GetSubtitleFont

Returns the engine's default subtitle font

GetTinyFont

Returns the engine's default tiny font

IsEditor

Returns:

the GIsEditor flag setting

IsGame

Returns:

the GIsGame flag is setting

IsSplitScreen

Returns:

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

PlayLoadMapMovie

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

Returns:

TRUE if a movie was played

RemoveAllOverlays

Removes all overlays from displaying

StopMovie

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