GameFramework.MobileInputZone

Extends

Object

Modifiers

PerObjectConfig editinlinenew Config ( Game ) native

MobileInputZone Controls how mobile input is handled Copyright 1998-2011 Epic Games, Inc. All Rights Reserved.

Core.Object
|   
+-- GameFramework.MobileInputZone

Delegates Summary
	bool	OnDoubleTapDelegate (MobileInputZone Zone, EZoneTouchEvent EventType, Vector2D TouchLocation)
		OnPostDrawZone (MobileInputZone Zone, Canvas Canvas)
	bool	OnPreDrawZone (MobileInputZone Zone, Canvas Canvas)
	bool	OnProcessInputDelegate (MobileInputZone Zone, float DeltaTime, int Handle, EZoneTouchEvent EventType, Vector2D TouchLocation)
	bool	OnProcessSlide (MobileInputZone Zone, EZoneTouchEvent EventType, int SlideValue, Vector2D ViewportSize)
	bool	OnTapDelegate (MobileInputZone Zone, EZoneTouchEvent EventType, Vector2D TouchLocation)

Functions Summary
		ActivateZone ()
		AddKismetEventHandler (SeqEvent_MobileZoneBase NewHandler))
		DeactivateZone ()

AnimatingFadeOpacity Source code

Fade opacity, used for certain transient effects

bIsDoubleTapAndHold Source code

This will be true if this tap was a double tap. It's required in order to make sure we release the DoubleTapInputKey if it was a tap and hold

CurrentCenter Source code

For Joystick, this is the center of the analog zone to calculate the analog values from

CurrentLocation Source code

For Joystick and Trackball, this is where in the zone the user is currently holding down

EscapeVelocity Source code

For Trackball, how much escape velocity is left to apply

InitialCenter Source code

For Joystick, the initial center position (used only when resetting the joystick back to it's center)

InitialLocation Source code

Holds the Initialize location where the zone was touched

InputOwner Source code

A Reference back to the Player Input that controls this array Input zone

LastAxisValues Source code

Holds cached versions of the last axis values

LastTouchTime Source code

Used to calculate a double tap on this zone

LastWentActiveTime Source code

Holds the time this zone last went active

MobileSeqEventHandlers Source code

holds an list of MobileZone Sequence events associated with this zone

OverrideTexture1Name Source code

Ini-controlled string that will be looked up at runtime and hooked up to OverrideTexture1

OverrideTexture2Name Source code

Ini-controlled string that will be looked up at runtime and hooked up to OverrideTexture2

PreviousLocationCount Source code

For Joystick and Trackball, how many previous locations we're currently storing

PreviousLocations[6] Source code

For Joystick and Trackball, array of previous locations so that we can smooth input over frames

PreviousMoveDeltaTimes[6] Source code

For Joystick and Trackball, array of previous movement time deltas so that we can smooth input over frames

State Source code

State of the zone

TimeSinceLastTapRepeat Source code

How long since we last repeated a tap

TotalActiveTime Source code

Used to track the amount of time a zone is active

TransitionTime Source code

Holds the current transition time

Advanced

bAllowFirstDeltaForTrackballZone Source code

Unless enabled, the first movement delta for a trackball zone will be ignored. This is useful for devices with inconsistent 'dead zones' for initial touch deltas, however this will reduce responsiveness of trackball drags slightly.

Bounds

ActiveSizeX Source code

Size of active Zone. Note if it's set to 0, then SizeX/SizeY will be copied here. This setting is used when you have a zone that has bCenterOnEvent set and defines the size of

ActiveSizeY Source code

Size of active Zone. Note if it's set to 0, then SizeX/SizeY will be copied here. This setting is used when you have a zone that has bCenterOnEvent set and defines the size of

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

bActiveSizeYFromX Source code

If this is true, then ActiveSizeY is relative to ActiveSizeX

bCenterX Source code

if true, then this zone will be centered around the original X value. NOTE: X will be updated to reflect it's actual position

bCenterY Source code

if true, then this zone will be centered around the original Y value. NOTE: Y will be updated to reflect it's actual position

Border Source code

Border is an invisible region around the zone. The border is included in hit determination.

bRelativeSizeX Source code

bRelativeSizeY Source code

bRelativeX Source code

If any of the bReleative vars are true, then the corresponding X/Y/SizeX/SizeY will be consider a percentage of the viewport

bRelativeY Source code

bSizeYFromSizeX Source code

If this is true, then SizeX is relative to SizeY

SizeX Source code

Size of the zone

SizeY Source code

Size of the zone

X Source code

Top left corner

Y Source code

Top left corner

Input

Acceleration Source code

How much acceleration to apply to Trackball or Joystick movement (0.0 for none, no upper bounds)

bScalePawnMovement Source code

If true, this control will use it's "strength" to scale the movement of the pawn

DoubleTapInputKey Source code

Input to send from a double tap

EscapeVelocityStrength Source code

How much escape velocity to use for Trackball movement (0.0 for none, 1.0 for max)

HorizMultiplier Source code

Multiplier to scale the analog horizontal input by

HorizontalInputKey Source code

Input to send for horizontal analog input (can be NAME_None)

InputKey Source code

Input to send to input subsystem on event (vertical input for analog, can be NAME_None)

Smoothing Source code

How much input smoothing to apply to Trackball or Joystick movement (0.0 for none, 1.0 for max)

TapInputKey Source code

Input to send for tap input (e.g. for tap-to-fire)

VertMultiplier Source code

Multiplier to scale the analog vertical input by

Options

bCenterOnEvent Source code

If true, this zone will have it's "center" set when you touch it, otherwise the center will be set to the center of the zone

bFloatingTiltZone Source code

If true, the tilt zone will float within the SizeX/SizeY

bIsInvisible Source code

Do we draw anything on screen for this zone?

bQuickDoubleTap Source code

If true, then this double tap will be considered a quick press/release, other wise it's tap and hold

ResetCenterAfterInactivityTime Source code

If bCenterOnEvent is enabled and this is non zero, the center position will be reset to it's initial center after this period of inactivity

SlideType Source code

Determines what type of slide it is

TapDistanceConstraint Source code

Rendering

bRenderGuides Source code

If true, the zone will render little guide lines for debugging

CaptionXAdjustment Source code

This is a fixed adjustment that will be added to the zone's caption's X. It's used to align fonts correctly

CaptionYAdjustment Source code

This is a fixed adjustment that will be added to the zone's caption's Y. It's used to align fonts correctly

InactiveAlpha Source code

Holds the alpha value to use if the zone is inactive

OverrideTexture1 Source code

Override texture (for buttons, this is the texture when not clicked; for joystick/trackball, it's the background; for sliders, it's the slider)

OverrideTexture2 Source code

Override texture (for buttons, this is the texture when clicked; for joystick/trackball, it's the 'hat'; for sliders, it's unused)

OverrideUVs1 Source code

UVs for override texture 1 (in texel units)

OverrideUVs2 Source code

UVs for override texture 2 (in texel units)

RenderColor Source code

Holds the color to use when drawing images

Transitions

ActivateTime Source code

How fast should a zone for from active to inactive

bUseGentleTransitions Source code

If true, the zone will gracefully transition from Inactive to Active and vice-versus. NOTE: transitions are strickly visual. A

DeactivateTime Source code

How fast a zone should go from inactive to active

Zone

Caption Source code

For button zones, the Caption property will be displayed in the center of the button

TouchpadIndex Source code

Which touchpad this zone will respond to

Type Source code

What type of zone is this.

EZoneSlideType Source code

Defines which way the zone slides

EZoneState Source code

Describes the state of the zone.

EZoneTouchEvent Source code

Describes the type of event that has occurred

EZoneType Source code

Describes the type of zone

TextureUVs Source code

Structure to allow easy storage of UVs for a rendered image

OnDoubleTapDelegate Source code

A delegate that allows script to manage Double Tap events.
@param Zone The mobile Input zone that triggered the delegate
@param Location Where on the device has the touch occurred.
@param EventType The type of event that occurred
@returns true if we need to swallow the double tap

OnPostDrawZone Source code

Allows other actors to supplement the drawing of this zone. Note this is called after the default drawing code
@param Zone The mobile Input zone that triggered the delegate
@param Canvas The canvas to draw on

OnPreDrawZone Source code

Allows other actors to override the drawing of this zone. Note this is called before the default drawing code and if it returns true, will abort the drawing sequence
@param Zone The mobile Input zone that triggered the delegate
@param Canvas The canvas to draw on
@returns true to stop the rendering

OnProcessInputDelegate Source code

A delegate that allows script to override the process. We use delegates here
@param Zone The Mobile Input zone that triggered the delegate
@param Handle The unique ID of this touch
@param EventType The type of event that occurred
@param Location Where on the device has the touch occurred.
@returns true if we need to swallow the touch

OnProcessSlide Source code

This is a delegate that allows script to get values of a slide zone.
@param Zone The mobile Input zone that triggered the delegate
@param EventType The type of event that occurred
@param SlideVlaue Holds the offset value of the slides in a +/- range in pixels. So 0 = Resting at normal.
@param ViewportSize Holds the size of the current viewport.

OnTapDelegate Source code

A delegate that allows script to manage Tap events.
@param Zone The mobile Input zone that triggered the delegate
@param Location Where on the device has the touch occurred.
@param EventType The type of event that occurred
@returns true if we need to swallow the tap

ActivateZone Source code

Called to activate a zone.

AddKismetEventHandler Source code

Adds a new MobileInput Sequence Event to the handler list
@param NewHandler The handler to add

DeactivateZone Source code

Called to deactivate a zone

defaultproperties
{
}