GFxUI.GFxMoviePlayer

Extends

Object

Modifiers

native config ( UI )

Filename : GFxMoviePlayer.uc Content : Unreal Scaleform GFx integration Copyright : (c) 2006-2007 Scaleform Corp. All Rights Reserved. Portions of the integration code is from Epic Games as identified by Perforce annotations. Copyright 2010 Epic Games, Inc. All rights reserved. Notes : Since 'ucc' will prefix all class names with 'U' there is not conflict with GFx file / class naming. Licensees may use this file in accordance with the valid Scaleform Commercial License Agreement provided with the software. This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR ANY PURPOSE.

Core.Object
|   
+-- GFxUI.GFxMoviePlayer

Direct Known Subclasses:

GFxMinimapHud, GFxUDKFrontEnd, GFxUIFrontEnd_TitleScreen, UTGFxTweenableMoviePlayer

Delegates Summary
		OnPostAdvance (float DeltaTime)

Functions Summary
	float	ActionScriptFloat (string path)
	int	ActionScriptInt (string path)
	GFxObject	ActionScriptObject (string path)
		ActionScriptSetFunction (GFxObject Object, string Member)
	string	ActionScriptString (string path)
		ActionScriptVoid (string path)
		AddCaptureKey (name key)
		AddFocusIgnoreKey (name key)
		Advance (float time)
		ApplyPriorityBlurEffect (bool bRemoveEffect)
		ApplyPriorityEffect (bool bRequestedBlurState, bool bRequestedHiddenState))
		ApplyPriorityVisibilityEffect (bool bRemoveEffect)
		ClearCaptureKeys ()
		ClearFocusIgnoreKeys ()
		Close (optional bool Unload = TRUE)
		ConditionalClearPause ()))
		ConsoleCommand (string Command ))
	GFxObject	CreateArray ()
	GFxObject	CreateObject (string ASClass, optional class<GFxObject> type)
	bool	FilterButtonInput (int ControllerId, name ButtonName, EInputEvent InputEvent)
		FlushPlayerInput (bool capturekeysonly)
	GameViewportClient	GetGameViewportClient ()
	LocalPlayer	GetLP ()))
	PlayerController	GetPC ()))
	ASValue	GetVariable (string path)
	bool	GetVariableArray (string path, int index, out array<ASValue> arg)
	bool	GetVariableBool (string path)
	bool	GetVariableFloatArray (string path, int index, out array<float> arg)
	bool	GetVariableIntArray (string path, int index, out array<int> arg)
	float	GetVariableNumber (string path)
	GFxObject	GetVariableObject (string path, optional class<GFxObject> type)
	string	GetVariableString (string path)
	bool	GetVariableStringArray (string path, int index, out array<string> arg)
		GetVisibleFrameRect (out float x0, out float y0, out float x1, out float y1)
		Init (optional LocalPlayer LocPlay))
	ASValue	Invoke (string method, array<ASValue> args)
		OnCleanup ()
		OnClose ()
		OnFocusGained (int LocalPlayerIndex))
		OnFocusLost (int LocalPlayerIndex))
		PlaySoundFromTheme (name EventName, optional name SoundThemeName='default'))
		PostAdvance (float DeltaTime)
		PostWidgetInit ()
		PublishDataStoreValues ()
		RefreshDataStoreBindings ()
		SetAlignment (GFxAlign a)
		SetExternalInterface (Object h))
	bool	SetExternalTexture (string resource, Texture texture)
		SetMovieCanReceiveFocus (bool bCanReceiveFocus)
		SetMovieCanReceiveInput (bool bCanReceiveInput)
		SetMovieInfo (SwfMovie data))
		SetPause (optional bool bPausePlayback = TRUE)
		SetPerspective3D (const out matrix matPersp)
		SetPriority (byte NewPriority)
		SetTimingMode (GFxTimingMode mode)
		SetVariable (string path, ASValue Arg)
	bool	SetVariableArray (string path, int index, array<ASValue> Arg)
		SetVariableBool (string path, bool b)
	bool	SetVariableFloatArray (string path, int index, array<float> Arg)
	bool	SetVariableIntArray (string path, int index, array<int> Arg)
		SetVariableNumber (string path, float f)
		SetVariableObject (string path, GFxObject Object)
		SetVariableString (string path, string s)
	bool	SetVariableStringArray (string path, int index, array<string> Arg)
		SetView3D (const out matrix matView)
		SetViewport (int x, int y, int width, int height)
		SetViewScaleMode (GFxScaleMode SM)
		SetWidgetPathBinding (GFxObject WidgetToBind, name Path)
	bool	Start (optional bool StartPaused = false)
	bool	WidgetInitialized (name WidgetName, name WidgetPath, GFxObject Widget)
	bool	WidgetUnloaded (name WidgetName, name WidgetPath, GFxObject Widget)

ASUClasses Source code

ASUObjects Source code

bAllowFocus Source code

If TRUE, this movie player will be allowed to accept focus events. Defaults to TRUE

bAllowInput Source code

If TRUE, this movie player will be allowed to accept input events. Defaults to TRUE

bAutoPlay Source code

If TRUE, MovieToLoad will be played immediately after loading

bBlurLesserMovies Source code

if true, this movie will try and blur out movies with a lower priority

bCaptureInput Source code

If TRUE, this movie player will capture input

bCloseOnLevelChange Source code

If TRUE, the movie will be closed on a level change NOTE: ONLY TIMINGMODE TM_REAL movies can stay open during level change

bDiscardNonOwnerInput Source code

If TRUE, any input received from a LocalPlayer that is not the owner of this movieplayer will be discarded and not acted upon This should be used in conjunction with bOnlyOwnerFocusable to make movieplayers that only respond to one player, but consume all input from the other players

bDisplayWithHudOff Source code

If TRUE, this movie player will render even if bShowHud is FALSE. Usually set to TRUE for menus, and FALSE for HUDs

bEnableGammaCorrection Source code

Whether to gamma correct this movie before writing to the destination surface.

bHideLesserMovies Source code

If ture, this movie will try and hide movies with a lower priority

bIgnoreBlurEffect Source code

If this is true, this movie will ignore any attempts to apply a blur effect to it through the priority system

bIgnoreMouseInput Source code

IF TRUE, this movie player will ignore mouse input

bIgnoreVisibilityEffect Source code

If this is true, this movie will ignore any attempts to apply a visibility effect to it through the priority system

bIsPriorityBlurred Source code

This will be TRUE if the movie is currently blurred via a higher priority movie

bIsPriorityHidden Source code

This will be TRUE if the movie is currently hidden via a higher priority movie

bLogUnhandedWidgetInitializations Source code

If TRUE, widgets that have an initialization callback that are NOT handled by WidgetInitialized() will log out a notification for debugging

bMovieIsOpen Source code

TRUE after Start() is called, FALSE after Close() is called.

bOnlyOwnerFocusable Source code

If TRUE, only the LocalPlayerOwner's input can be directed here

bPauseGameWhileActive Source code

If TRUE, the game will pause while this scene is up

bWidgetsInitializedThisFrame Source code

If TRUE, a widget within this movie player was initialized this frame. This will cause the PostWidgetInit event to be fired after the Advance() of the movie is complete

CaptureKeys Source code

List of keys that this movie player is listening for, and will capture (i.e. not send on to the game)

DataStoreBindings Source code

DataStoreSubscriber Source code

ExternalInterface Source code

Object that should receive ExternalInterface calls from ActionScript. If unspecified, all ExternalInterface calls will be routed through the movie player itself

ExternalTextures Source code

Array of ExternalTexture bindings that will automatically replaced when the movie player loads a new movie

FocusIgnoreKeys Source code

If this is a focus movie, all input will be sent to the movie EXCEPT these keys

LocalPlayerOwnerIndex Source code

Index into the GamePlayers array for the LocalPlayer who owns this movie

MovieInfo Source code

Reference to the movie currently being played

NextASUObject Source code

ObjectValues Source code

All GFxObjects created during the lifetime of GFxMoviePlayer

pCaptureKeys Source code

pFocusIgnoreKeys Source code

pMovie Source code

GFx Internals

Priority Source code

The priority of this movie player. Used to determine render and focus order when multiple movie players are open simultaneously

RenderTextureMode Source code

TimingMode Source code

WidgetBindings Source code

WidgetPathBindings Source code

Stores bindings for forwarding WidgetInitialized() calls on to a specific GFxObject instance for widgets within a certain movie object path. Entries can be added / removed from the widget binding mapping using SetWidgetPathBinding()

GFxMoviePlayer

RenderTexture Source code

Texture that the movie should be rendered to. If NULL, the movie will be rendered to the frame buffer.

SoundThemes Source code

Stores an array of bindings between sound theme names and actual UISoundThemes

ASType Source code

ActionScript type specifiers, for use with ASValue. Note that AS_Number corresponds to a float in UnrealScript.

GFxAlign Source code

GFxRenderTextureMode Source code

Rendering modes for the player - RTM_Opaque: No blending, opaque overlay - RTM_Alpha: Use with BLEND_Translucent, doesn't support add - RTM_AlphaComposite: Use with BLEND_AlphaComposite

GFxScaleMode Source code

GFxTimingMode Source code

Timing modes for playback of the movie - TM_Game: Movie will be advanced using the game's delta time (i.e. pausing the game pauses the movie) - TM_Real: Movie will proceed at normal playback speed, disregarding slomo and pause

ASValue Source code

Generic struct used for passing generic data to and from ActionScript. Should be used as little as possible because of overhead, except in cases where it is unavoidable

ExternalTexture Source code

Stores a mapping between a movie's image resource ("Linkage" identifier on an image resource in the movie) and an Unreal texture resource. This allows runtime remapping of the images used by the movie. Any texture with a linkage identifier can be replaced at runtime using SetExternalTexture()

GFxDataStoreBinding Source code

GFxWidgetBinding Source code

Widget class binding: To associate a CLIK widget instance in a movie with a particular UnrealScript subclass of GFxObject, add the widget's Flash name here, and specify the class. This will cause the GFxObject parameter of WidgetInitialized() to be created as the appropriate subclass.

SoundThemeBinding Source code

Structure that binds a sound theme name to an actual UISoundTheme to handle sound events from objects in this movie. Sound events can be fired by CLIK widgets or manually by the artist. Each event contains a theme name, and an event to play. This mapping binds the theme names specified by the artist to a UISoundTheme asset, which then binds event names to various sound cues or actions.
Theme:

Corresponding sound theme to handle sound events for this ThemeName

ThemeName:

Name of the sound theme, specified by the artist in the movie

OnPostAdvance Source code

Delegate that if set, will be fired whenever the movie gets an Advance() call.
@param DeltaTime Amount of time the movie has advanced

ActionScriptFloat Source code

ActionScriptInt Source code

ActionScriptObject Source code

ActionScriptSetFunction Source code

Function property setters Use this function to set function properties in ActionScript to UnrealScript delegates, using the delegate from the calling UnrealScript function. This is a useful method for getting callbacks from ActionScript into UnrealScript. Example: // Sets OtherObject's "onClick" function object to the delegate specified in f function SetOnEvent(GFxObject OtherObject, delegate f) { ActionScriptSetFunction(OtherObject, "onClick"); }

ActionScriptString Source code

ActionScriptVoid Source code

ActionScript function call wrappers These functions, when called from within a UnrealScript function, invoke an ActionScript function with the specified method name, with the parameters of the wrapping UnrealScript function. This is the preferred method for calling ActionScript functions from UnrealScript, as it is faster than Invoke, with less overhead. Example: To call the following ActionScript function from UnrealScript - function MyActionScriptFunction(Param1:String, Param2:Number, Param3:Object):Void; Use the following UnrealScript code - function CallMyActionScriptFunction(string Param1, float Param2, GFxObject Param3) { ActionScriptVoid("_root.MyActionScriptFunction"); }

AddCaptureKey Source code

Adds a key to the list of keys that get eaten by the movie being played, and not passed down to the game

AddFocusIgnoreKey Source code

Adds a key to the FocusIgnore list, which prevents key presses from being sent to the movie if this is the focus movie

Advance Source code

Advances the movie by the specified time. After the movie is started via Start(), Advance(0.f) can be called to initialize all the objects on the first frame without actually advancing the movie

ApplyPriorityBlurEffect Source code

Applies the priority blur effect to this movie. @bRemoveEffect - will be true if we want to remove the effect

ApplyPriorityEffect Source code

Apply any depth effects based on the priority of the scene just opened. @bRequestedBlurState - What should the blur state for this scene be @bRequestedHiddenState - What should the visibility for this scene be

ApplyPriorityVisibilityEffect Source code

Applies the priority visibility effect to this movie. @bRemoveEffect - will be true if we want to remove the effect

ClearCaptureKeys Source code

ClearFocusIgnoreKeys Source code

Close Source code

Close the movie

ConditionalClearPause Source code

See whether we need to attempt to unpause the game when the scene closes

ConsoleCommand Source code

Routes a console command through the player's PlayerController
@param Command - The console command to run

CreateArray Source code

CreateObject Source code

Used to create a new object of a specific ActionScript class. Note that the ASClass specified must be available in the movie you are trying to create it in!

FilterButtonInput Source code

Can be overridden to filter input to this movie. Return TRUE to trap the input, FALSE to let it pass through to Gfx

FlushPlayerInput Source code

Clears out all pressed keys from the player's input

GetGameViewportClient Source code

GetLP Source code

Helper function to get the owning local player for this movie
@return The LocalPlayer corresponding to the LocalPlayerOwnerIndex that owns this movie

GetPC Source code

Helper function to get the owning player controller for this movie
@return The PlayerController corresponding to the LocalPlayerOwnerIndex that owns this movie

GetVariable Source code

Accessors for ActionScript / GFx Objects If you know the type of the variable or object you're accessing, it is best to use one of the type specific accessor functions, as they are significantly faster. Avoid using the slower ASValue functions if possible.

GetVariableArray Source code

Array accessor functions As with the normal member accessor functions, it is always best to use the accessor for the specific type, rather than the generic ASValue implementations

GetVariableBool Source code

GetVariableFloatArray Source code

GetVariableIntArray Source code

GetVariableNumber Source code

GetVariableObject Source code

Returns a GFxObject for the specified path. If the type parameter is specified, the returned object will be of the specified class. Note the return value is not coerced though, so if you specify a type, you must manually cast the result

GetVariableString Source code

GetVariableStringArray Source code

GetVisibleFrameRect Source code

Init Source code

This should be called when a new GFxMoviePlayer is initialized. Handles the setting up of the LocalPlayerIndex, as well as automatically starting / advancing the movie if desired
@param LocPla - The LocalPlayer that owns this movie

Invoke Source code

Calls an ActionScript function on the movie, with the values from the args array as its parameters. This is slower than creating a wrapper function to call the ActionScript method using one of the ActionScript*() methods below, but does not require a subclass to implement. Use this for one-off functions, or functions with variable length arguments

OnCleanup Source code

Called when the movie is done and removed from the all movie list. So final clean up can be done

OnClose Source code

Called when a movie is closed to allow cleanup and handling

OnFocusGained Source code

Event triggered when focus is given to this MoviePlayer for a given LocalPlayer
@param LocalPlayerIndex - The index of the local player that is now focusing on this MoviePlayer

OnFocusLost Source code

Event triggered when focus is removed from this MoviePlayer for a given LocalPlayer
@param LocalPlayerIndex - The index of the local player that is no longer focusing on this MoviePlayer

PlaySoundFromTheme Source code

Plays a sound associated with an event from the specified sound theme. Can be used to manually fire off sounds from UnrealScript when it is inconvenient to fire them off from ActionScript
@param EventName - name of the sound event to play
@param SoundThemeName - name of the theme to play the sound from. Defaults to 'default'

PostAdvance Source code

Called after the movie is advanced, and handles things like calling OnPostAdvance(), if specified
@param DeltaTime Time that the movie was advanced

PostWidgetInit Source code

Callback when at least one CLIK widget with enableInitCallback set to TRUE has been initialized in a frame

PublishDataStoreValues Source code

RefreshDataStoreBindings Source code

SetAlignment Source code

SetExternalInterface Source code

Set a handler for ActionScript ExternalInterface calls for the movie being played. If no handler is specified, calls will be processed by this GFxMoviePlayer

SetExternalTexture Source code

Specifies a resource (linkage identifier in the movie) to be replaced by the specified texture

SetMovieCanReceiveFocus Source code

Sets whether or not a movie is allowed to receive focus. Defaults to true

SetMovieCanReceiveInput Source code

Sets whether or not a movie is allowed to receive input. Defaults to true

SetMovieInfo Source code

Set movie to play (for script-created objects)

SetPause Source code

Pauses / unpauses the movie playback

SetPerspective3D Source code

SetPriority Source code

SetTimingMode Source code

Sets the timing mode of the movie to either advance with game time (respecting game pause and time dilation), or real time (disregards game pause and time dilation)

SetVariable Source code

SetVariableArray Source code

SetVariableBool Source code

SetVariableFloatArray Source code

SetVariableIntArray Source code

SetVariableNumber Source code

SetVariableObject Source code

SetVariableString Source code

SetVariableStringArray Source code

SetView3D Source code

3D View functions

SetViewport Source code

Sets the viewport location and size for the movie being played

SetViewScaleMode Source code

SetWidgetPathBinding Source code

Sets a widget to handle WidgetInitialized() callbacks for a given widget path. Used when you want a specific widget within the movie to handle WidgetInitialized() calls for its own children. The most derived path handler will be called for any given widget Example: For WidgetInitialized() on the widget with the path _level0.a.b.c.d, if a path binding was set for _level0.a and _level0.a.b, the widget bound to path _level0.a.b would receive the call Passing in None for WidgetToBind will remove a Widget from being bound to that path

Start Source code

Start playing the movie. Returns false if there were load errors. Can be overridden to perform other setup, but be sure to call Super.Start() first.

WidgetInitialized Source code

Callback when a CLIK widget with enableInitCallback set to TRUE is initialized. Returns TRUE if the widget was handled, FALSE if not.

WidgetUnloaded Source code

Callback when a CLIK widget with enableInitCallback set to TRUE is unloaded. Returns TRUE if the widget was handled, FALSE if not.

defaultproperties
{
    bEnableGammaCorrection=FALSE
    bDisplayWithHudOff=TRUE
	bLogUnhandedWidgetInitializations=TRUE

	bAllowInput=TRUE
	bAllowFocus=TRUE

	bCloseOnLevelChange=TRUE

	Priority=1
}