UE3:UIAction_ShowKeyboardUI (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
UT3 Object >> SequenceObject >> SequenceOp >> SequenceAction >> UIAction >> UIAction_ShowKeyboardUI
Package:
Engine

This action tells the online subsystem to show the keyboard input ui

Copyright 1998-2007 Epic Games, Inc. All Rights Reserved.

Properties

Property group 'UIAction_ShowKeyboardUI'

bIsPassword

Type: bool

Whether to use password entry or not

bShouldValidate

Type: bool

Whether to validate the text or not

Default value: True

DefaultText

Type: string

The text to put in the edit control by default

DescriptionText

Type: string

The text describing what is being input

TitleText

Type: string

The text to display at the top of the screen

Internal variables

bIsDone

Type: bool

Whether the async call is done or not

StringReturnValue

Type: string

Will hold the resultant value the user input

Default values

Property Value
bLatentExecution True
ObjCategory "Online"
ObjName "Get Keyboard Input"
VariableLinks[0]
Member Value
ExpectedType Class'Engine.SeqVar_String'
LinkDesc "Title Text"
PropertyName 'TitleText'
VariableLinks[1]
Member Value
ExpectedType Class'Engine.SeqVar_String'
LinkDesc "Description Text"
PropertyName 'DescriptionText'
VariableLinks[2]
Member Value
ExpectedType Class'Engine.SeqVar_String'
LinkDesc "Default Text"
PropertyName 'DefaultText'
VariableLinks[3]
Member Value
ExpectedType Class'Engine.SeqVar_Bool'
LinkDesc "Needs Validation"
MaxVars 255
MinVars 1
PropertyName 'bShouldValidate'
VariableLinks[4]
Member Value
ExpectedType Class'Engine.SeqVar_String'
LinkDesc "String Return Value"
MaxVars 255
MinVars 1
PropertyName 'StringReturnValue'

Functions

Events

ReadKeyboardInput

event ReadKeyboardInput ()

Uses the online subsystem to show the virtual keyboard for input

Other instance functions

OnKeyboardInputDone

function OnKeyboardInputDone (bool bWasSuccessful)

Reads the results of the user's keyboard input

Parameters:

  • bWasSuccessful - whether the call succeeded or not