The three virtues of a programmer: Laziness, Impatience, and Hubris. – Larry Wall

UE3:Player (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT3 Object >> Player
Package: 
Engine
Direct subclass:
LocalPlayer
This class in other games:
RTNP, U1, UT, U2, U2XMP, UT2003, UE2Runtime, 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[edit]

Actor[edit]

Type: PlayerController

Modifiers: transient, const


ConfiguredInternetSpeed[edit]

Type: int

Modifiers: globalconfig


Default value: 10000

ConfiguredLanSpeed[edit]

Type: int

Modifiers: globalconfig


Default value: 20000

CurrentNetSpeed[edit]

Type: int

Modifiers: const


PP_DesaturationMultiplier[edit]

Type: float

Modifiers: config

Global multiplier for scene desaturation PP effect.

Default value: 1.0

PP_HighlightsMultiplier[edit]

Type: float

Modifiers: config

Global multiplier for scene highlights PP effect.

Default value: 1.0

PP_MidTonesMultiplier[edit]

Type: float

Modifiers: config

Global multiplier for scene midtones PP effect.

Default value: 1.0

PP_ShadowsMultiplier[edit]

Type: float

Modifiers: config

Global multiplier for scene shadows PP effect.

Default value: 1.0

Native functions[edit]

GetDownloadListInfo[edit]

native final noexport function int GetDownloadListInfo (optional out array<nameDownloadList, optional out array<Object.GuidGUIDList)

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

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

native function bool IsDownloading ()

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

SkipDownload[edit]

native function SkipDownload ()

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

SwitchController[edit]

native function SwitchController (PlayerController PC)

Dynamically assign Controller to Player and set viewport.

Parameters:

  • PC - new player controller to assign to player