GFxUI.GFxObject

Extends

Object

Modifiers

within GFxMoviePlayer dependsOn ( GFxMoviePlayer ) native

Filename : GFxObject.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 : 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. GFxObject is GFxValue in Scaleform code

Core.Object
|   
+-- GFxUI.GFxObject

Direct Known Subclasses:

GFxClikWidget, GFxMinimap, GFxUIView

Functions Summary
	array<GFxObject>	ActionScriptArray (string path)
	float	ActionScriptFloat (string method)
	int	ActionScriptInt (string method)
	GFxObject	ActionScriptObject (string path)
		ActionScriptSetFunction (string Member)
		ActionScriptSetFunctionOn (GFxObject target, string Member)
	string	ActionScriptString (string method)
		ActionScriptVoid (string method)
	GFxObject	AttachMovie (string symbolname, string instancename, optional int depth = -1, optional class type = class'GFxObject')
	GFxObject	CreateEmptyMovieClip (string instancename, optional int depth = -1, optional class type = class'GFxObject')
	ASValue	Get (string Member)
	bool	GetBool (string Member)
	ASColorTransform	GetColorTransform ()
	ASDisplayInfo	GetDisplayInfo ()
	Matrix	GetDisplayMatrix ()
	ASValue	GetElement (int index)
	bool	GetElementBool (int index)
	ASDisplayInfo	GetElementDisplayInfo (int index)
	Matrix	GetElementDisplayMatrix (int index)
	float	GetElementFloat (int index)
	ASValue	GetElementMember (int index, string Member)
	bool	GetElementMemberBool (int index, string Member)
	float	GetElementMemberFloat (int index, string Member)
	GFxObject	GetElementMemberObject (int index, string Member, optional class type = class'GFxObject')
	string	GetElementMemberString (int index, string Member)
	GFxObject	GetElementObject (int index, optional class type = class'GFxObject')
	string	GetElementString (int index)
	float	GetFloat (string Member)
	GFxObject	GetObject (string Member, optional class type = class'GFxObject')
	bool	GetPosition (out float x, out float y)
	string	GetString (string Member)
	string	GetText ()
		GotoAndPlay (string frame)
		GotoAndPlayI (int frame)
		GotoAndStop (string frame)
		GotoAndStopI (int frame)
	ASValue	Invoke (string Member, array<ASValue> args)
		Set (string Member, ASValue Arg)
		SetBool (string Member, bool b)
		SetColorTransform (ASColorTransform cxform)
		SetDisplayInfo (ASDisplayInfo d)
		SetDisplayMatrix (Matrix m)
		SetDisplayMatrix3D (Matrix m)
		SetElement (int index, ASValue Arg)
		SetElementBool (int index, bool b)
		SetElementColorTransform (int index, ASColorTransform cxform)
		SetElementDisplayInfo (int index, ASDisplayInfo d)
		SetElementDisplayMatrix (int index, Matrix m)
		SetElementFloat (int index, float f)
		SetElementMember (int index, string Member, ASValue arg)
		SetElementMemberBool (int index, string Member, bool b)
		SetElementMemberFloat (int index, string Member, float f)
		SetElementMemberObject (int index, string Member, GFxObject val)
		SetElementMemberString (int index, string Member, string s)
		SetElementObject (int index, GFxObject val)
		SetElementPosition (int index, float x, float y)
		SetElementString (int index, string s)
		SetElementVisible (int index, bool visible)
		SetFloat (string Member, float f)
		SetFunction (string Member, Object context, name fname)
		SetObject (string Member, GFxObject val)
		SetPosition (float x, float y)
		SetString (string Member, string s, optional TranslationContext InContext)
		SetText (coerce string text, optional TranslationContext InContext)
		SetVisible (bool visible)
	String	TranslateString (String StringToTranslate, optional TranslationContext InContext)
	bool	WidgetInitialized (name WidgetName, name WidgetPath, GFxObject Widget)
	bool	WidgetUnloaded (name WidgetName, name WidgetPath, GFxObject Widget)

SubWidgetBindings Source code

Array of WidgetBindings for widgets that are forwarded to this widget for their WidgetInitialized() callback. See GFxMoviePlayer's WidgetBindings for details

Value[12] Source code

Stores reference information for the GFx-side GFxValue that this GFxObject refers to

ASColorTransform Source code

Struct for storing color transformation information for manipulation using the Complex Object Interface

ASDisplayInfo Source code

Struct for storing properties of display objects for easy and quick manipulation at runtime using the Complex Object Interface

ActionScriptArray Source code

ActionScriptFloat Source code

ActionScriptInt Source code

ActionScriptObject Source code

ActionScriptSetFunction Source code

Function property setters Use these functions 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. Examples: // Sets a ActionScript function property "onClick" to call back to the delegate specified in f function SetOnClick(delegate f) { ActionScriptSetFunction("onClick"); } // Sets OtherObject's "onClick" function object to the delegate specified in f function SetOnEvent(GFxObject OtherObject, delegate f) { ActionScriptSetFunctionOn(OtherObject, "onClick"); }

ActionScriptSetFunctionOn Source code

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("MyActionScriptFunction"); }

AttachMovie Source code

Attaches a symbol to specified movie instance. If no instance is found in this object's scope with the InstanceName, a new instance is created and returned

CreateEmptyMovieClip Source code

Creates an empty MovieClip in the movie. This can then be manipulated like any other MovieClip using the above functions

Get 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.

GetBool Source code

GetColorTransform Source code

GetDisplayInfo Source code

Complex Object Interface functions These functions are the preferred way modify the parameters of display objects (i.e. widgets). When possible, use these functions to view and change the display parameters of widgets over setting the parameters individually via Set() functions

GetDisplayMatrix Source code

GetElement Source code

Array accessor functions As with the normal member accessor functions, it is always preferable to use the accessor for the specific type, rather than the generic GetElement() / SetElement() functions.

GetElementBool Source code

GetElementDisplayInfo Source code

Array accessors for display objects

GetElementDisplayMatrix Source code

GetElementFloat Source code

GetElementMember Source code

Array accessors for general element types

GetElementMemberBool Source code

GetElementMemberFloat Source code

GetElementMemberObject Source code

GetElementMemberString Source code

GetElementObject Source code

GetElementString Source code

GetFloat Source code

GetObject Source code

Returns a GFxObject for the specified member. 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

GetPosition Source code

GetString Source code

GetText Source code

Text field accessor functions

GotoAndPlay Source code

Movie flow control functions These functions are used for controlling movie playback and skipping around on the timeline. The string functions take a (case-sensitive) frame label to jump to, while the integer functions jump to a frame number. If the label or frame isn't found, a warning will be sent to the DevGFxUI logging channel, but the movie can still potentially jump frames (usually to the end of the timeline for the object)

GotoAndPlayI Source code

GotoAndStop Source code

GotoAndStopI Source code

Invoke Source code

Calls an ActionScript function on this GFxObject, 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 of GFxObject to implement. Use this for one-off functions, or functions with variable length arguments

Set Source code

SetBool Source code

SetColorTransform Source code

SetDisplayInfo Source code

SetDisplayMatrix Source code

SetDisplayMatrix3D Source code

SetElement Source code

SetElementBool Source code

SetElementColorTransform Source code

SetElementDisplayInfo Source code

SetElementDisplayMatrix Source code

SetElementFloat Source code

SetElementMember Source code

SetElementMemberBool Source code

SetElementMemberFloat Source code

SetElementMemberObject Source code

SetElementMemberString Source code

SetElementObject Source code

SetElementPosition Source code

SetElementString Source code

SetElementVisible Source code

SetFloat Source code

SetFunction Source code

SetObject Source code

SetPosition Source code

SetString Source code

Set the field specified by 'member' on this object.
@param Member The member of set object to set; e.g. "text" or "htmlText" or "foo"
@param s Value of the string that is to be assigned to the member
@param InContext The TranslationContext to use when resolving any tags enocuntered in the text.

SetText Source code

Set the text field on this object.
@param text The text to set.
@param InContext The TranslationContext to use when resolving any tags enocuntered in the text.

SetVisible Source code

Toggles visibility of this object, if it is a display object

TranslateString Source code

Translate a string for handling markup
@param StringToTranslate - The text to set.
@param TranslationContext - The TranslationContext to use when resolving any tags enocountered in the text.

WidgetInitialized Source code

Callback when a child widget is initialized within the path bound to this widget via GFxMoviePlayer::SetWidgetPathBinding(). Allows for GFxObject subclasses that encapsulate functionality to handle their own initialization for child widgets, instead of the GFxMoviePlayer. Returns TRUE if the widget was handled, FALSE if not.

WidgetUnloaded Source code

Callback when a child widget with enableInitCallback set to TRUE is unloaded within the path bound to this widget via GFxMoviePlayer::SetWidgetPathBinding(). Returns TRUE if the widget was handled, FALSE if not.