Engine.LocalPlayer

Extends

Player

Modifiers

within Engine config ( Engine ) native transient

Core.Object
|   
+-- Engine.Player
   |   
   +-- Engine.LocalPlayer

Functions Summary
		ClearPostProcessSettingsOverride (optional float BlendOutTime)
		DeProject (vector2D RelativeScreenPos, out vector WorldOrigin, out vector WorldDirection)
	bool	GetActorVisibility (Actor TestActor) con)
	string	GetNickname ()))
	PostProcessChain	GetPostProcessChain (int InIndex)
	TranslationContext	GetTranslationContext ()
	UniqueNetId	GetUniqueNetId ()))
	bool	InsertPostProcessingChain (PostProcessChain InChain, int InIndex, bool bInClone)
		OverridePostProcessSettings (PostProcessSettings OverrideSettings, optional float BlendInTime)
	bool	RemoveAllPostProcessingChains ()
	bool	RemovePostProcessingChain (int InIndex)
		SendSplitJoin ()
		SetControllerId (int NewControllerId ))
	bool	SpawnPlayActor (string URL, ut string OutError)
		TouchPlayerPostProcessChain ()

ActivePPOverrides Source code

Stack of active overrides. Restricting this to 1 "active" and have all others be fading out, though

ActorVisibilityHistory Source code

AspectRatioAxisConstraint Source code

How to constrain perspective viewport FOV

bSentSplitJoin Source code

set when we've sent a split join request

bWantToResetToMapDefaultPP Source code

Whether or not to use the next map's defaults and ditch the current pp settings

ControllerId Source code

The controller ID which this player accepts input from.

CurrentPPInfo Source code

The Post Process value used

LastMap Source code

The last map this player remembers being on. Used to determine if the map has changed and the pp needs to be reset to default

LastViewLocation Source code

The location of the player's view the previous frame.

LevelPPInfo Source code

Baseline Level Post Process Info

Origin Source code

The coordinates for the upper left corner of the master viewport subregion allocated to this player. 0-1

PlayerPostProcess Source code

Chain of post process effects for this player view

PlayerPostProcessChains Source code

Size Source code

The size of the master viewport subregion allocated to this player. 0-1

TagContext Source code

This Local Player's translation context. See GetTranslationContext() below.

ViewportClient Source code

The master viewport containing this player's view.

ViewState Source code

CurrentPostProcessVolumeInfo Source code

BlendStartTime:

Time when a new post process volume was set

LastBlendTime:

Time when the settings blend was last updated.

LastSettings:

Last pp settings used when blending to the next set of volume values.

LastVolumeUsed:

The last post process volume that was applied to the scene

PostProcessSettingsOverride Source code

SynchronizedActorVisibilityHistory Source code

ClearPostProcessSettingsOverride Source code

Stop overriding post process settings. Will only affect active overrides -- in-progress blendouts are unaffected.
@param BlendOutTime - The amount of time you want to take to recover from the override you are clearing.

DeProject Source code

transforms 2D screen coordinates into a 3D world-space origin and direction
@note: use the Canvas version where possible as it already has the necessary information, whereas this function must gather it and is therefore slower
@param ScreenPos - relative screen coordinates (0 to 1, relative to this player's viewport region)
@param WorldOrigin (out) - world-space origin vector
@param WorldDirection (out) - world-space direction vector

GetActorVisibility Source code

Tests the visibility state of an actor in the most recent frame of this player's view to complete rendering.
@param TestActor - The actor to check visibility for.
@return True if the actor was visible in the frame.

GetNickname Source code

retrieves this player's name/tag from the online subsytem if this function returns a non-empty string, the returned name will replace the "Name" URL parameter passed around in the level loading and connection code, which normally comes from DefaultEngine.ini

GetPostProcessChain Source code

Get the PPChain at the given index.
@param InIndex The index of the chain to retrieve.
@return PostProcessChain The post process chain if found; NULL if not.

GetTranslationContext Source code

A TranslationContext is part of the system for managing translation tags in localization text. This system handles text with special tags. E.g.: Press to look at point of interest. A TranslationContext provides information that cannot be deduced from the text alone. In this case, it is used to differentiate between players 1 and 2.
@return Translation Context for this Local Player.

GetUniqueNetId Source code

retrieves this player's unique net ID from the online subsystem

InsertPostProcessingChain Source code

Add the given post process chain to the chain at the given index.
@param InChain The post process chain to insert.
@param InIndex The position to insert the chain in the complete chain. If -1, insert it at the end of the chain.
@param bInClone If TRUE, create a deep copy of the chains effects before insertion.
@return boolean TRUE if the chain was inserted FALSE if not

OverridePostProcessSettings Source code

Begins an override of the current post process settings.

RemoveAllPostProcessingChains Source code

Remove all post process chains.
@return boolean TRUE if the chain array was cleared FALSE if not

RemovePostProcessingChain Source code

Remove the post process chain at the given index.
@param InIndex The position to insert the chain in the complete chain.
@return boolean TRUE if the chain was removed FALSE if not

SendSplitJoin Source code

sends a splitscreen join command to the server to allow a splitscreen player to connect to the game the client must already be connected to a server for this function to work @note this happens automatically for all viewports that exist during the initial server connect so it's only necessary to manually call this for viewports created after that if the join fails (because the server was full, for example) all viewports on this client will be disconnected

SetControllerId Source code

Changes the ControllerId for this player; if the specified ControllerId is already taken by another player, changes the ControllerId for the other player to the ControllerId currently in use by this player.
@param NewControllerId the ControllerId to assign to this player.

SpawnPlayActor Source code

Creates an actor for this player.
@param URL - The URL the player joined with.
@param OutError - If an error occurred, returns the error description.
@return False if an error occurred, true if the play actor was successfully spawned.

TouchPlayerPostProcessChain Source code

Forces the PlayerPostProcess chain to be rebuilt. This should be called if a PPChain is retrieved using the GetPostProcessChain, and is modified directly.

defaultproperties
{

	
	bWantToResetToMapDefaultPP=true
}