UE3:Player (UT3)

Object >> Player

Package:

Engine

Direct subclass:

LocalPlayer

This class in other games:

RTNP, U1, UT, U2, U2XMP, UE2Runtime, UT2003, UT2004, UDK

Player: Corresponds to a real player (a local camera or remote net player). Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.

Properties

Actor

Type: PlayerController

Modifiers: transient, const

ConfiguredInternetSpeed

Type: int

Modifiers: globalconfig

Default value: 10000

ConfiguredLanSpeed

Type: int

Modifiers: globalconfig

Default value: 20000

CurrentNetSpeed

Type: int

Modifiers: const

PP_DesaturationMultiplier

Type: float

Modifiers: config

Global multiplier for scene desaturation PP effect.

Default value: 1.0

PP_HighlightsMultiplier

Type: float

Modifiers: config

Global multiplier for scene highlights PP effect.

Default value: 1.0

PP_MidTonesMultiplier

Type: float

Modifiers: config

Global multiplier for scene midtones PP effect.

Default value: 1.0

PP_ShadowsMultiplier

Type: float

Modifiers: config

Global multiplier for scene shadows PP effect.

Default value: 1.0

Native functions

GetDownloadListInfo

native final noexport function int GetDownloadListInfo (optional out array<name> DownloadList, optional out array<Object.Guid> GUIDList)

Returns information about the currently active downloads (NOTE: Clientside only)

Parameters:

• DownloadList - Outputs the full list of files to be downloaded
• GUIDList - Outputs the raw (non-string) GUID list, which directly corresponds to 'DownloadList'

Returns:

The total number of files to be downloaded

GetDownloadStatus

native final noexport function float GetDownloadStatus (optional out name File, optional out int Size, optional out int NumReceived, optional out byte Optional)

Retrieves information about the currently active file download

Parameters:

• File - Outputs the name of the file being downloaded
• Size - Outputs the size (in bytes) of the active download
• NumReceived - Outputs the number of bytes transferred thus far
• Optional - Outputs whether or not the current download is optional

Returns:

Returns the download completion percentage

IsDownloading

native function bool IsDownloading ()

Returns true if the client is currently downloading files from the server

SkipDownload

native function SkipDownload ()

Allows script code to skip the currently active file download (NOTE: Clientside only)

SwitchController

native function SwitchController (PlayerController PC)

Dynamically assign Controller to Player and set viewport.

Parameters:

• PC - new player controller to assign to player