UE3:PlayerController native functions (UT3)

Object >> Actor >> Controller >> PlayerController (native functions)

PlayerController native functions in other games:

UDK

Other member categories for this class:

events, exec functions, instance functions, internal variables, states

Native functions

ClientConvolve

reliable client final private native event ClientConvolve (string C, int H)

ClientFlushLevelStreaming

reliable client native final event ClientFlushLevelStreaming ()

tells the client to block until all pending level streaming actions are complete happens at the end of the tick primarily used to force update the client ASAP at join time

ClientTravel

reliable client native event ClientTravel (string URL, Actor.ETravelType TravelType, optional bool bSeamless)

travel to a different map

Parameters:

• URL - the URL to travel to
• TravelType - type of URL
• bSeamless - whether to use seamless travel (requires TravelType of TRAVEL_Relative)

ServerNotifyLoadedWorld

reliable server native final event ServerNotifyLoadedWorld (name WorldPackageName)

called to notify the server when the client has loaded a new world via seamless travelling

Parameters:

• WorldPackageName - the name of the world package that was loaded

ServerProcessConvolve

reliable server final private native event ServerProcessConvolve (string C, int H)

ServerUpdateLevelVisibility

native reliable server final event ServerUpdateLevelVisibility (name PackageName, bool bIsVisible)

called when the client adds/removes a streamed level the server will only replicate references to Actors in visible levels so that it's impossible to send references to Actors the client has not initialized

Parameters:

• PackageName - the name of the package for the level whose status changed

CheckSpeedHack

native final function bool CheckSpeedHack (float DeltaTime)

CleanUpAudioComponents

native function CleanUpAudioComponents ()

Clears out 'left-over' audio components.

ClientSetTravelGuid

reliable client native function ClientSetTravelGuid (Object.Guid NextTravelGuid)

sets the GUID for the package of a pending ClientTravel()

Hack: should be part of the ClientTravel() parameters, but needs to be separate for backwards compatibility

ClientUpdateLevelStreamingStatus

native reliable client final function ClientUpdateLevelStreamingStatus (name PackageName, bool bNewShouldBeLoaded, bool bNewShouldBeVisible, bool bNewShouldBlockOnLoad)

ConsoleCommand

native function string ConsoleCommand (string Command, optional bool bWriteToLog)

Overrides: Actor.ConsoleCommand

CopyToClipboard

native function CopyToClipboard (string Text)

FindStairRotation

native(524) final function int FindStairRotation (float DeltaTime)

GetDefaultURL

native final function string GetDefaultURL (string Option)

GetPlayerNetworkAddress

native final function string GetPlayerNetworkAddress ()

GetPooledAudioComponent

native function AudioComponent GetPooledAudioComponent (SoundCue ASound, Actor SourceActor, bool bStopWhenOwnerDestroyed, optional bool bUseLocation, optional Object.Vector SourceLocation)

get an audio component from the HearSound pool creates a new component if the pool is empty and MaxConcurrentHearSounds has not been exceeded the component is initialized with the values passed in, ready to call Play() on its OnAudioFinished delegate is set to this PC's HearSoundFinished() function

Parameters:

• ASound - the sound to play
• SourceActor - the Actor to attach the sound to (if None, attached to self)
• bStopWhenOwnerDestroyed - whether the sound stops if SourceActor is destroyed
• bUseLocation - optional) - whether to use the SourceLocation parameter for the sound's location (otherwise, SourceActor's location)
• SourceLocation - optional) - if bUseLocation, the location for the sound

Returns:

the AudioComponent that was found/created

GetServerNetworkAddress

native final function string GetServerNetworkAddress ()

GetViewTarget

native function Actor GetViewTarget ()

HasClientLoadedCurrentWorld

native final function bool HasClientLoadedCurrentWorld ()

returns whether the client has completely loaded the server's current world (valid on server only)

IsControllerTiltActive

native simulated function bool IsControllerTiltActive () const

Returns:

whether or not this Controller has Tilt Turned on

IsKeyboardAvailable

native simulated function bool IsKeyboardAvailable () const

Returns:

whether or not this Controller has a keyboard available to be used

IsLocalPlayerController

native function bool IsLocalPlayerController ()

Overrides: Controller.IsLocalPlayerController

returns whether this Controller is a locally controlled PlayerController

Note: not valid until the Controller is completely spawned (i.e, unusable in Pre/PostBeginPlay())

IsMouseAvailable

native simulated function bool IsMouseAvailable () const

Returns:

whether or not this Controller has a mouse available to be used

IsPlayerMuted

native final function bool IsPlayerMuted (const out OnlineSubsystem.UniqueNetId Sender)

Native function to determine if voice data should be received from this player. Only called on the server to determine whether voice packet replication should happen for the given sender.

NOTE: This function is final because it can be called n^2 number of times in a given frame, where n is the number of players. Change/overload this function with caution as this can affect your network performance.

Parameters:

• Sender - the player to check for mute status

Returns:

TRUE if this player is muted, FALSE otherwise

IsShowingSubtitles

native simulated function bool IsShowingSubtitles ()

This will turn return whether the subtitles are on or off

PasteFromClipboard

native function string PasteFromClipboard ()

SetAllowMatureLanguage

native function SetAllowMatureLanguage (bool bAllowMatureLanguge)

Whether or not to allow mature language *

SetAudioGroupVolume

native function SetAudioGroupVolume (name GroupName, float Volume)

Sets the Audio Group to this the value passed in *

SetControllerTiltActive

native simulated function SetControllerTiltActive (bool bActive)

sets whether or not the Tilt functionality is turned on

SetControllerTiltDesiredIfAvailable

native simulated function SetControllerTiltDesiredIfAvailable (bool bActive)

sets whether or not the the player wants to utilize the Tilt functionality

SetNetSpeed

native final function SetNetSpeed (int NewSpeed)

SetOnlyUseControllerTiltInput

native simulated function SetOnlyUseControllerTiltInput (bool bActive)

sets whether or not to ONLY use the tilt input controls

SetShowSubtitles

native simulated function SetShowSubtitles (bool bValue)

This will turn the subtitles on or off depending on the value of bValue

Parameters:

• bValue - to show or not to show

SetUseTiltForwardAndBack

native simulated function SetUseTiltForwardAndBack (bool bActive)

sets whether or not to use the tilt forward and back input controls

SetViewTarget

native function SetViewTarget (Actor NewViewTarget, optional Camera.ViewTargetTransitionParams TransitionParams)

UpdateURL

native(546) final function UpdateURL (string NewOption, string NewValue, bool bSave1Default)