I'm a doctor, not a mechanic

UE3:UIPrefabInstance (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UDK Object >> UIRoot >> UIScreenObject >> UIObject >> UIPrefabInstance
Package: 
Engine
This class in other games:
UT3

This widget class is a container for widgets which are instances of a UIPrefab.

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

Properties[edit]

ArchetypeToInstanceMap[edit]

Type: Map{UObject*,UObject*}

Modifiers: const, native

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[edit]

Type: array<byte>

Modifiers: editoronly, const


PI_CompleteObjects[edit]

Type: array<Object>

Modifiers: editoronly, const


PI_DataOffset[edit]

Type: int

Modifiers: editoronly, const

the offset into PI_Bytes for this UIPrefabInstance's property data

PI_LicenseePackageVersion[edit]

Type: int

Modifiers: editoronly, const


Default value: -1

PI_ObjectMap[edit]

Type: Map{UObject*,INT}

Modifiers: const, native


PI_PackageVersion[edit]

Type: int

Modifiers: editoronly, const

Contains the epic+licensee version that this PrefabInstance's package was saved with.

Default value: -1

PI_ReferencedObjects[edit]

Type: array<Object>

Modifiers: editoronly, const


PI_SavedNames[edit]

Type: array<string>

Modifiers: editoronly, const


PrefabInstanceVersion[edit]

Type: int

Modifiers: const

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[edit]

Type: UIPrefab

Modifiers: const, archetype

The prefab that this is an instance of.

Subobjects[edit]

WidgetEventComponent[edit]

Class: Engine.UIComp_Event

Inherits from: UIObject.WidgetEventComponent

No new values.

Native functions[edit]

DetachFromSourcePrefab[edit]

native final function DetachFromSourcePrefab ()

Converts all widgets in this UIPrefabInstance into normal widgets and removes the UIPrefabInstance from the scene.