GameFramework.MobileMenuScene

Extends

Object

Modifiers

native

MobileMenuScene This is the base class for the mobile menu system Copyright 1998-2011 Epic Games, Inc. All Rights Reserved.

Core.Object
|   
+-- GameFramework.MobileMenuScene

Direct Known Subclasses:

MobileMenuBase, MobileMenuControls, MobileMenuPause, MobileMenuSplash

Functions Summary
		CleanUpScene ()
		Closed ()))
	bool	Closing ()))
	MobileMenuObject	FindMenuObject (string Tag))
	float	GetGlobalScaleX ()
	float	GetGlobalScaleY ()
		InitMenuScene (MobilePlayerInput PlayerInput, int ScreenWidth, int ScreenHeight))
		MadeTopMenu ()))
	bool	MobileMenuCommand (string Command))
	bool	OnSceneTouch (EZoneTouchEvent EventType, float TouchX, float TouchY))
		OnTouch (MobileMenuObject Sender, loat TouchX, float TouchY, bool bCancel))
		Opened (string Mode))
		RenderScene (Canvas Canvas, loat RenderDelta))

Options

AuthoredGlobalScale Source code

This is the scale factor you are authoring for. 2.0 is useful for Retina display resolution (960x640), 1.0 for iPads and older iPhones

bApplyGlobalScaleHeight Source code

bApplyGlobalScaleLeft Source code

bApplyGlobalScaleTop Source code

bApplyGlobalScaleWidth Source code

bRelativeHeight Source code

bRelativeLeft Source code

bRelativeTop Source code

bRelativeWidth Source code

Opacity Source code

The general opacity of the scene

Positions

Height Source code

Left Source code

Positions and sizing

Top Source code

Width Source code

Sounds

UITouchSound Source code

Holds a reference to the sound to play when a touch occurs in the mobile menu system

UIUnTouchSound Source code

Holds a reference to the sound to play when a touch occurs in the mobile menu system

UI

bSceneDoesNotRequireInput Source code

InputOwner Source code

A reference to the input owner

MenuName Source code

MenuObjects Source code

SceneCaptionFont Source code

Allows for a single font for all buttons in a scene

TouchpadIndex Source code

Which touchpad this menu will respond to

CleanUpScene Source code

Closed Source code

Closed will be called when the closing process is done and the scene has been removed from the stack

Closing Source code

Closing will be called before the closing process really begins. Return false if you wish to override the closing process.
@returns true if we can close

FindMenuObject Source code

Search the menu stack for a object
@param Tag - The name of the object to find.
@returns the object

GetGlobalScaleX Source code

Native functions to get the global scale to apply to UI elements that desire such

GetGlobalScaleY Source code

InitMenuScene Source code

Script events that allows for menu setup. It's called at the beginning of the native InitMenuScene. Nothing is set at this point and allows the scene to override default settings
@param PlayerInput - A pointer to the MobilePlayerInput object that owns the UI scene
@param ScreenWidth - The Width of the Screen
@param ScreenHeight - The Height of the Screen

MadeTopMenu Source code

Called when this menu is the topmost menu (ie, when opened or when one of top was closed)

MobileMenuCommand Source code

Allows menus to handle exec commands
@Param Command - The command to handle
@returns true if handled

OnSceneTouch Source code

Allows the scene to manage touches that aren't sent to any given control

OnTouch Source code

This event is called when a "touch is detected on an object.
@param Sender - The Object that swallowed the touch
@param TouchX - The X location of the touch event
@param TouchY - The Y location of the touch event
@param bCancel- If TRUE, the touch was canceled

Opened Source code

Opened will be called after the scene is opened and initialized.
@param Mode Optional string to pass to the scene for however it wants to use it

RenderScene Source code

Render the scene
@param Canvas - the canvas object for drawing

defaultproperties
{
	AuthoredGlobalScale=2.0
	SceneCaptionFont=Font'EngineFonts.SmallFont'
	Opacity=1.0
	bSceneDoesNotRequireInput=false;
}