Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

Engine.ConsoleEntry

Extends
UIObject
Modifiers
native ( UIPrivate ) notplaceable

Temporary widget for representing the region that displays the text currently being typed into the console Copyright 1998-2008 Epic Games, Inc. All Rights Reserved. 

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIScreenObject
      |   
      +-- Engine.UIObject
         |   
         +-- Engine.ConsoleEntry
Constants Summary
ConsolePromptText="(> "
Inherited Contants from Engine.UIObject
CONTEXTMENU_BINDING_INDEX, FIRST_DEFAULT_DATABINDING_INDEX, TOOLTIP_BINDING_INDEX

Variables Summary
UIImageConsolePromptBackground
UILabelConsolePromptLabel
intCursorPosition
UIEditBoxInputBox
UIImageLowerConsoleBorder
UIImageUpperConsoleBorder
ConsoleEntry
boolbRenderCursor
Inherited Variables from Engine.UIObject
AnimationParent, AnimationPosition, AnimStack, bDebugShowBounds, bEnableActiveCursorUpdates, bSupportsPrimaryStyle, ContextMenuData, DebugBoundsColor, DockTargets, NavigationTargets, Owner, OwnerScene, PrimaryStyle, PrivateFlags, RenderBoundsVertices[EUIWidgetFace.UIFACE_MAX], RenderBounds[EUIWidgetFace.UIFACE_MAX], RenderOffset, Rotation, StyleSubscribers, TabIndex, ToolTip, WidgetID, WidgetTag
Inherited Variables from Engine.UIScreenObject
bHidden, bInitialized, bNeverFocus, bSupports3DPrimitives, Children, DefaultStates, EventProvider, FocusControls, FocusedCue, FocusPropagation, InactiveStates, InitialState, MouseEnterCue, NavigateDownCue, NavigateLeftCue, NavigateRightCue, NavigateUpCue, Opacity, PlayerInputMask, Position, StateStack, ZDepth

Functions Summary
event AddedChild (UIScreenObject WidgetOwner, UIObject NewChild ))
event PostInitialize ()))
event RemovedChild (UIScreenObject WidgetOwner, UIObject OldChild, optional array ExclusionSet ))
function SetupDockingLinks ()))
function SetValue (string NewValue ))
Inherited Functions from Engine.UIObject
AddStyleSubscriber, AnimSetBottom, AnimSetColor, AnimSetLeft, AnimSetOpacity, AnimSetPosition, AnimSetRelPosition, AnimSetRight, AnimSetRotation, AnimSetScale, AnimSetTop, AnimSetVisibility, CanAcceptFocus, ClearDefaultDataBinding, ClearUIAnimation, FindStyleSubscriberIndex, FindStyleSubscriberIndexById, GenerateSceneDataStoreMarkup, GenerateTransformMatrix, GetAnchorPosition, GetDefaultDataBinding, GetDefaultDataStores, GetOwner, GetParent, GetPositionExtent, GetPositionExtents, GetRotationMatrix, GetScene, GetToolTipValue, HasTransform, IsContainedBy, IsDockedTo, IsPrivateBehaviorSet, LogRenderBounds, NeedsActiveCursorUpdates, NotifyValueChanged, OnSetDatastoreBinding, PlayUIAnimation, RemoveStyleSubscriber, ResolveDefaultDataBinding, ResolveStyles, RotateWidget, SetActiveCursorUpdate, SetAnchorPosition, SetDefaultDataBinding, SetDockPadding, SetDockParameters, SetDockTarget, SetForcedNavigationTarget, SetNavigationTarget, SetPrivateBehavior, SetWidgetStyleByName, StopUIAnimation, TickAnim, UIAnimEnd, UpdateRotationMatrix
Inherited Functions from Engine.UIScreenObject
AcceptsPlayerInput, ActivateEventByClass, ActivateState, ActivateStateByClass, AddedChild, CanAcceptFocus, CanPlayOnline, CanPropagateFocusFor, CanvasToScreen, ConditionalPropagateEnabledState, ContainsChild, ContainsChildOfClass, CreatePlayerData, CreateWidget, DeactivateState, DeactivateStateByClass, DeProject, DisablePlayerInput, DisableWidget, EnablePlayerInput, EnableWidget, FindChild, FindChildIndex, FindChildUsingID, FindEventsOfClass, FocusFirstControl, FocusLastControl, GetActivePlayerCount, GetAspectRatioAutoScaleFactor, GetBestControllerId, GetBestPlayerIndex, GetBounds, GetCanvasToScreen, GetChildren, GetCurrentState, GetDockedWidgets, GetFocusedControl, GetInverseCanvasToScreen, GetLastFocusedControl, GetLoginStatus, GetNATType, GetObjectCount, GetParent, GetPlayerOwner, GetPosition, GetPositionVector, GetSupportedPlayerCount, GetSupportedUIActionKeyNames, GetViewportHeight, GetViewportOffset, GetViewportOrigin, GetViewportScale, GetViewportSize, GetViewportWidth, GetWidgetPathName, HasActiveStateOfClass, HasLinkConnection, Initialize, Initialized, InitializePlayerTracking, InsertChild, IsActive, IsEnabled, IsFocused, IsHidden, IsHoldingAlt, IsHoldingCtrl, IsHoldingShift, IsInitialized, IsLoggedIn, IsNeverFocused, IsPressed, IsVisible, KillFocus, LogCurrentState, NavigateFocus, NextControl, OnChangeVisibility, OnConsoleCommand, OnSetControllerId, OnShowAchievementsUI, OnShowContentMarketplaceUI, OnShowFeedbackUI, OnShowFriendInviteUI, OnShowFriendsUI, OnShowGamerCardUI, OnShowMembershipMarketplaceUI, OnShowMessagesUI, OnShowPlayersUI, OverrideLastFocusedControl, PixelToCanvas, PixelToScreen, PlayUISound, PostInitialize, PrevControl, PrivateSetVisibility, Project, RebuildNavigationLinks, RemoveChild, RemoveChildren, RemovedChild, RemovedFromParent, RemovePlayerData, ReplaceChild, RequestFormattingUpdate, RequestPrimitiveReview, RequestSceneUpdate, ScreenToCanvas, ScreenToPixel, SetEnabled, SetFocus, SetFocusToChild, SetInputMask, SetPosition, SetVisibility

Constants Detail

ConsolePromptText Source code

const ConsolePromptText = "(> ";

Variables Detail

ConsolePromptBackground Source code

var UIImage ConsolePromptBackground;

ConsolePromptLabel Source code

var UILabel ConsolePromptLabel;
displays the text that is currently being typed

CursorPosition Source code

var transient int CursorPosition;
the current position of the cursor in InputBox's string

InputBox Source code

var UIEditBox InputBox;

LowerConsoleBorder Source code

var UIImage LowerConsoleBorder;

UpperConsoleBorder Source code

var UIImage UpperConsoleBorder;

ConsoleEntry

bRenderCursor Source code

var(ConsoleEntry) bool bRenderCursor;
controls whether the underline cursor is rendered

Functions Detail

AddedChild Source code

event AddedChild ( UIScreenObject WidgetOwner, UIObject NewChild ) )

PostInitialize Source code

event PostInitialize ( ) )

RemovedChild Source code

event RemovedChild ( UIScreenObject WidgetOwner, UIObject OldChild, optional array<UIObject> ExclusionSet ) )
Called immediately after a child has been removed from this screen object. Clears the NotifyPositionChanged delegate in the removed child
@param WidgetOwner the screen object that the widget was removed from.
@param OldChild the widget that was removed
@param ExclusionSet used to indicate that multiple widgets are being removed in one batch; useful for preventing references between the widgets being removed from being severed. NOTE: If a value is specified, OldChild will ALWAYS be part of the ExclusionSet, since it is being removed.

SetupDockingLinks Source code

function SetupDockingLinks ( ) )

SetValue Source code

function SetValue ( string NewValue ) )

Defaultproperties 

defaultproperties
{
   ConsolePromptLabel=UILabel'Engine.Default__ConsoleEntry:ConsolePromptTemplate'
   ConsolePromptBackground=UIImage'Engine.Default__ConsoleEntry:ConsolePromptBackgroundTemplate'
   InputBox=UIEditBox'Engine.Default__ConsoleEntry:InputBoxTemplate'
   LowerConsoleBorder=UIImage'Engine.Default__ConsoleEntry:LowerConsoleBorderTemplate'
   UpperConsoleBorder=UIImage'Engine.Default__ConsoleEntry:UpperConsoleBorderTemplate'
   WidgetTag="ConsoleEntry"
   PrimaryStyle=(DefaultStyleTag="ConsoleStyle")
   bSupportsPrimaryStyle=False
   Children(0)=UIEditBox'Engine.Default__ConsoleEntry:InputBoxTemplate'
   Children(1)=UIImage'Engine.Default__ConsoleEntry:ConsolePromptBackgroundTemplate'
   Children(2)=UILabel'Engine.Default__ConsoleEntry:ConsolePromptTemplate'
   Children(3)=UIImage'Engine.Default__ConsoleEntry:LowerConsoleBorderTemplate'
   Children(4)=UIImage'Engine.Default__ConsoleEntry:UpperConsoleBorderTemplate'
   DefaultStates(2)=Class'Engine.UIState_Focused'
   Begin Object Class=UIComp_Event Name=WidgetEventComponent ObjName=WidgetEventComponent Archetype=UIComp_Event'Engine.Default__UIObject:WidgetEventComponent'
      ObjectArchetype=UIComp_Event'Engine.Default__UIObject:WidgetEventComponent'
   End Object
   EventProvider=WidgetEventComponent
   Name="Default__ConsoleEntry"
   ObjectArchetype=UIObject'Engine.Default__UIObject'
}
Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: sk 18-3-2018 10:00:35.568 - Created with UnCodeX