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

Engine.UIPrefabInstance

Extends
UIObject
Modifiers
native ( UIPrivate ) notplaceable HideDropDown

This widget class is a container for widgets which are instances of a UIPrefab. Copyright 1998-2008 Epic Games, Inc. All Rights Reserved. 

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIScreenObject
      |   
      +-- Engine.UIObject
         |   
         +-- Engine.UIPrefabInstance
Constants Summary
Inherited Contants from Engine.UIObject
CONTEXTMENU_BINDING_INDEX, FIRST_DEFAULT_DATABINDING_INDEX, TOOLTIP_BINDING_INDEX

Variables Summary
MapArchetypeToInstanceMap
array<byte>PI_Bytes
array<object>PI_CompleteObjects
intPI_DataOffset
intPI_LicenseePackageVersion
MapPI_ObjectMap
intPI_PackageVersion
array<object>PI_ReferencedObjects
array<string>PI_SavedNames
intPrefabInstanceVersion
UIPrefabSourcePrefab
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
function DetachFromSourcePrefab ()
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

Variables Detail

ArchetypeToInstanceMap Source code

var const native Map ArchetypeToInstanceMap;
Mapping from archetypes in the SourcePrefab to instances of those archetypes in this UIPrefabInstance. Used by UpdatePrefabInstance to determine the archetypes which were added to SourcePrefab since the last time this UIPrefabInstance was updated, as well as tracking which widgets have been removed from this UIPrefabInstance by the user. This map holds references to all objects in the UIPrefab and UIPrefabInstance, including any components and subobjects. A NULL key indicates that the widget was removed from the UIPrefab; the instance associated with the NULL key will be removed from the UIPrefabInstance's list of children the next time that UpdateUIPrefabInstance is called. A NULL value indicates that the user manually removed an instanced widget from the UIPrefabInstance. When this UIPrefabInstance is updated, that widget archetype will not be re-instanced.

PI_Bytes Source code

var editoronly const array<byte> PI_Bytes;

PI_CompleteObjects Source code

var editoronly const array<object> PI_CompleteObjects;

PI_DataOffset Source code

var editoronly const int PI_DataOffset;

PI_LicenseePackageVersion Source code

var editoronly const int PI_LicenseePackageVersion;

PI_ObjectMap Source code

var const native Map PI_ObjectMap;

PI_PackageVersion Source code

var editoronly const int PI_PackageVersion;
Contains the epic+licensee version that this PrefabInstance's package was saved with.

PI_ReferencedObjects Source code

var editoronly const array<object> PI_ReferencedObjects;

PI_SavedNames Source code

var editoronly const array<string> PI_SavedNames;

PrefabInstanceVersion Source code

var const int PrefabInstanceVersion;
The version for this UIPrefabInstance. When the value of PrefabInstanceVersion does not match the value of SourcePrefab's PrefabVersion, it indicates that SourcePrefab has been updated since the last time this UIPrefabInstance was updated.

SourcePrefab Source code

var const archetype UIPrefab SourcePrefab;
The prefab that this is an instance of.

Functions Detail

DetachFromSourcePrefab Source code

native final function DetachFromSourcePrefab ( )
Converts all widgets in this UIPrefabInstance into normal widgets and removes the UIPrefabInstance from the scene.

Defaultproperties 

defaultproperties
{
   PI_PackageVersion=-1
   PI_LicenseePackageVersion=-1
   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__UIPrefabInstance"
   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:47.648 - Created with UnCodeX