DreamGUI
类参考

UDreamUserWidget

UDreamUserWidget

继承自 UDreamWidget。

声明于 Public/Core/DreamUserWidget.h。

一种控件层级,它是一个类而不是资源实例——对应 UMG 的 UUserWidget,也是 DreamUI 预制体正在成为的东西。

它自身就是一个 UDreamWidget,正如 UUserWidget 本身就是一个 UWidget。这正是嵌套能够自然成立的原因:将其中一个放入另一个层级中,它就是该层级中的一个控件,而它自身的内容则来自它自己的类。

它的内容存放在 WidgetTree 之后,而不是直接放在 Children 中,这种间接性并非装饰。没有它,“一个控件的类”和“一个层级的类”就会是同一回事,而 UDreamWidget 子类(它们是 Blueprintable 的)就无法与层级模板区分开来。UMG 用 UWidgetTree 实现了同样的分离,这里也同样不是可选的。

WidgetTree 是 Transient 的:类模板绝不能携带已展开的子树,否则嵌套的用户控件就会被烘焙进其父级的模板中,并停止跟踪它自己的类。它在 Initialize 时从类构建,每次都是如此。

Properties

NameTypeCategoryIn the details panelFrom BlueprintDescription
bWantsTickboolDreamGUIUserWidgetyesread only
bAllowEventBubbleUpboolDreamGUIUserWidgetyesread only
bCanNavigateHereboolDreamGUIUserWidgetyesread only

Functions

FunctionKindDescription
bool AddToPlayerScreen(int32 ZOrder)callableUMG 的 AddToPlayerScreen:在所属玩家的屏幕上执行 AddToViewport,当没有所属玩家时拒绝,而不是回退到屏幕 0。这就是这里的全部区别,因为每个屏幕已经属于一个玩家。当控件之后位于该屏幕上时为 True。
void AddToViewport(int32 ZOrder)callableUMG 的 AddToViewport:以 ZOrder 将此控件放到屏幕上并开启它。另一半是 UDreamWidget::RemoveFromParent,它会再次将其移除并保留。
void BindToAnimationEvent(UMovieSceneSequence* Animation, FDreamUIAnimationDynamicEvent Delegate, EDreamUIAnimationEvent AnimationEvent)callable上述两者的通用形式。
void BindToAnimationFinished(UMovieSceneSequence* Animation, FDreamUIAnimationDynamicEvent Delegate)callable当动画的一个实例结束(自然结束或通过 Stop)时调用。使用相同的委托解除绑定。
void BindToAnimationStarted(UMovieSceneSequence* Animation, FDreamUIAnimationDynamicEvent Delegate)callable当动画的一个实例开始时调用。使用相同的委托解除绑定。
void ClearPlacementInViewport()callable将页面的几何形状交还给堆栈,这意味着从下次刷新起再次全出血。
void EvaluatePropertyBindings()callable运行此控件所有属性绑定一次:调用每个绑定函数,将结果交给控件的 setter。在 Initialize 时运行(因此第一帧显示绑定值),并且可以安全地手动调用。
UDreamWidgetAnimationComponent* FindAnimationComponentFor(UMovieSceneSequence* InAnimation)pure持有 InAnimation 的组件,或 null。暴露它是因为想要使用此控件未镜像的组件 API 中某些部分的调用方不应猜测哪个控件携带它。
FDreamUIAnimationHandle FindAnimationInstance(UMovieSceneSequence* Animation)pure动画最新的活动(播放中或暂停)实例,或无效句柄。
UDreamWidget* FindSlotWidget(FName InSlotName)pure在此实例内携带该名称的 UDreamNamedSlot 的控件,或 null。
void FlushAnimations()callable在返回前应用仍为此控件的动画排队的任何求值。
bool GetAllowEventBubbleUp()pureGet Allow Event Bubble Up
UMovieSceneSequence* GetAnimationByName(FString Name)pure此控件层级中具有该显示名称的动画,或 null。对于想要动画对象——将其绑定到事件、询问它是否正在播放、将其交给接受句柄的调用——而不是想要播放它的调用方而言,它是 PlayAnimationByName 的对应物。它与 PlayAnimationByName 完全一样,通过显示名称来指定内嵌动画,通过资源名称来指定独立序列资源。
float GetAnimationCurrentTime(FDreamUIAnimationHandle Handle)pure进入动画的秒数;对于不再活动的句柄为零。
bool GetCanNavigateHere()pureGet Can Navigate Here
UDreamWidget* GetContentForNamedSlot(FName InSlotName)pure宿主放入 InSlotName 中的内容,或 null。读取绑定,而不是附加关系。
UDreamWidget* GetContentRoot()pure此控件自身内容的根——树的根,而不是此控件。Initialize 之前为 Null。
FName GetDefaultSlotName()pure不带插槽名称到达的内容所去往的插槽——.dui 嵌套,以及设计器拖放到控件自身上的内容。None 表示未插槽的内容停留在它落下的位置。
FVector2D GetLocalSize()pure此控件自己的盒子,在其自身空间中——UMG 的 GetCachedGeometry 的局部部分。
TArray<FName> GetNativeSlotNames()pure此类打开的洞,用于内容为代码而非原型的类。
APawn* GetOwningPlayerPawn()pureGet Owning Player Pawn
FBox2D GetScreenSpaceRect()pure此控件在屏幕上落于何处,在根画布的空间中——UMG 的 GetCachedGeometry / GetPaintSpaceGeometry 的绝对部分。当控件不在画布下时为零尺寸。
UObject* GetViewModel(FName Name)pureviewmodels 条目 Name 当前所持有的内容;当它为空或不存在该条目时为 null。
bool GetWantsTick()pureGet Wants Tick
UDreamWidget* GetWidgetFromName(FName InVariableName)pure此实例内该变量名称的控件——UMG 的 GetWidgetFromName。
TArray<UDreamWidget*> GetWidgetsByTag(FName InTag)pure此控件自身内容中所有带有 InTag 的控件(UDreamWidget::Tags,在 .dui 中为 @tag),父级先于子级,同级按顺序。
UDreamWidgetTree* GetWidgetTree()pureGet Widget Tree
bool HasPlayingAnimation(UMovieSceneSequence* Animation)pure如果该动画的任何实例当前正在播放,则为 True。
bool IsAnimationPaused(FDreamUIAnimationHandle Handle)pureIs Animation Paused
bool IsAnimationPlaying(FDreamUIAnimationHandle Handle)pureIs Animation Playing
bool IsAnimationPlayingForward(FDreamUIAnimationHandle Handle)pure当实例向其末端运行时为 True;反向时为 false。
bool IsAnyAnimationPlaying()pure如果此控件自身内容的任何组件上的任何动画正在播放,则为 True。
bool IsConstructed()pure在 NativeOnConstruct 和 NativeOnDestruct 之间为 True——控件在屏幕上处于活动状态。
bool IsDesignTime()pure在设计器预览中为 True,在 PIE 和烘焙游戏中为 false——UMG 的 IsDesignTime。
bool IsInitialized()pureIs Initialized
bool IsListeningForInputAction(FDreamUIActionHandle InHandle)pureIs Listening for Input Action
void K2_AddFieldValueChangedDelegate(FFieldNotificationId FieldId, FFieldValueChangedDynamicDelegate Delegate)callableAdd Field Value Changed Delegate
void K2_BroadcastFieldValueChanged(FFieldNotificationId FieldId)callable告诉所有监听者某个字段已更改——UMG 的 K2_BroadcastFieldValueChanged。
TArray<FName> K2_GetDeclaredSlotNames()pure此实例声明的命名插槽,按其类声明它们的顺序排列。
void K2_RemoveFieldValueChangedDelegate(FFieldNotificationId FieldId, FFieldValueChangedDynamicDelegate Delegate)callableRemove Field Value Changed Delegate
FDreamUIActionHandle ListenForInputAction(FDataTableRowHandle InAction, FDreamUIActionExecutedDelegate InCallback, bool bDisplayInActionBar)callableUMG 的 ListenForInputAction,在此框架自己的动作层上。
void OnAnimationFinished(UMovieSceneSequence* Animation)event此控件某个动画的一个实例结束(自然结束或通过 Stop)。
void OnAnimationStarted(UMovieSceneSequence* Animation)event此控件某个动画的一个实例开始。
void OnBeginDrag(UDreamPointerEventData* EventData)eventOn Begin Drag
void OnConstruct()eventNativeOnConstruct 的蓝图部分,由它调用。
void OnDestruct()eventNativeOnDestruct 的蓝图部分,由它调用。
void OnDisable()eventNativeOnDisable 的蓝图部分,由它调用。
void OnDoubleClick(UDreamPointerEventData* EventData)event双击时
void OnDrag(UDreamPointerEventData* EventData)event拖拽时
void OnDragCancelled(UDreamDragDropOperation* Operation)event拖拽取消时
void OnDragEnter(UDreamPointerEventData* EventData, UDreamDragDropOperation* Operation)event拖拽进入时
void OnDragLeave(UDreamPointerEventData* EventData, UDreamDragDropOperation* Operation)event拖拽离开时
void OnDragOver(UDreamPointerEventData* EventData, UDreamDragDropOperation* Operation)event拖拽悬停时
void OnDrop(UDreamPointerEventData* EventData)event放下时
void OnEnable()eventNativeOnEnable 的蓝图部分,由它调用。
void OnEndDrag(UDreamPointerEventData* EventData)event结束拖拽时
void OnInitialized()eventNativeOnInitialized 的蓝图部分,由它调用。相同的约定,相同的时机。
void OnLongPress(UDreamPointerEventData* EventData)event长按时
void OnMouseMove(UDreamPointerEventData* EventData)event鼠标移动时
void OnMouseWheel(UDreamPointerEventData* EventData)event鼠标滚轮时
UDreamWidget* OnNavigate(EDreamUINavigationDirection Direction)eventNativeOnNavigate 的蓝图部分:返回要移动到的控件,或返回空以保持不变。
void OnPinch(UDreamGestureEventData* EventData)event捏合时
void OnPointerClick(UDreamPointerEventData* EventData)event指针点击时
void OnPointerDown(UDreamPointerEventData* EventData)event指针按下时
void OnPointerEnter(UDreamPointerEventData* EventData)event指针进入时
void OnPointerExit(UDreamPointerEventData* EventData)event指针离开时
void OnPointerUp(UDreamPointerEventData* EventData)event指针抬起时
void OnSlotContentAttached()eventNativeOnSlotContentAttached 的蓝图部分:宿主的内容已就位。
void OnSwipe(UDreamGestureEventData* EventData)event滑动时
void OnTick(float DeltaTime)eventNativeOnTick 的蓝图部分,在启用了逐帧更新时由它调用。
float PauseAnimation(FDreamUIAnimationHandle Handle)callable@return 实例在暂停时所处的时间,单位为秒;将其传回 PlayAnimation 的 StartAtTime 即可从该处继续。
float PauseAnimationsOf(UMovieSceneSequence* Animation)callable暂停该动画的每个活动实例。@return 最新实例的暂停时间,单位为秒。
FDreamUIAnimationHandle PlayAnimation(UMovieSceneSequence* Animation, float StartAtTime, int32 NumLoopsToPlay, EDreamUIAnimationPlayMode PlayMode, float PlaybackSpeed, bool bRestoreState)callable播放此控件的某个动画。这是编译器生成的动画变量所馈入的入口:将变量拖入,放到 Animation 上,将 Target 保留为 self。
FDreamUIAnimationHandle PlayAnimationByName(FString Name, float StartAtTime, int32 NumLoopsToPlay, EDreamUIAnimationPlayMode PlayMode, float PlaybackSpeed, bool bRestoreState)callable按显示名称播放,适用于确实从文本开始的调用方。建议优先使用动画变量。
FDreamUIAnimationHandle PlayAnimationForward(UMovieSceneSequence* Animation, float PlaybackSpeed, bool bRestoreState)callable相对于动画的当前状态向前播放:已在运行或已暂停的实例会从所在位置调转方向,否则会从头开始一个新实例。这就是“点击时面板滑出,再次点击时滑回”的惯用法,与 UMG 中完全一致。
FDreamUIAnimationHandle PlayAnimationReverse(UMovieSceneSequence* Animation, float PlaybackSpeed, bool bRestoreState)callablePlayAnimationForward 的反向部分:将活动实例调转方向,或从末尾开始一个实例。
FDreamUIAnimationHandle PlayAnimationTimeRange(UMovieSceneSequence* Animation, float StartAtTime, float EndAtTime, int32 NumLoopsToPlay, EDreamUIAnimationPlayMode PlayMode, float PlaybackSpeed, bool bRestoreState)callable播放动画并在 EndAtTime 处停止,而非在动画末尾停止。@param EndAtTime 动画中播放结束的绝对秒数。为零或更小表示动画自身的末尾。
void PlaySound(USoundBase* InSound, float InVolumeMultiplier, float InPitchMultiplier)callableUMG 的 PlaySound:面向拥有玩家的 2D 声音,没有衰减,也没有世界位置。
void PreConstruct(bool bIsDesignTime)eventUMG 的 PreConstruct,带有其名称所指的标志。
void QueuePauseAnimation(FDreamUIAnimationHandle Handle)callable队列暂停动画
void QueuePlayAnimation(UMovieSceneSequence* Animation, float StartAtTime, int32 NumLoopsToPlay, EDreamUIAnimationPlayMode PlayMode, float PlaybackSpeed, bool bRestoreState)callable相同的操作被推迟到本帧序列求值结束时执行:在动画自身的 Started / Finished / 事件回调内部调用是安全的。
void QueuePlayAnimationTimeRange(UMovieSceneSequence* Animation, float StartAtTime, float EndAtTime, int32 NumLoopsToPlay, EDreamUIAnimationPlayMode PlayMode, float PlaybackSpeed, bool bRestoreState)callable队列播放动画时间范围
void QueueStopAllAnimations()callable队列停止所有动画
void QueueStopAnimation(FDreamUIAnimationHandle Handle)callable队列停止动画
bool ReceiveAnalogValueChanged(UDreamKeyEventData* EventData)event模拟值变化时
void ReceiveFocusLost(int32 UserIndex, int32 PointerId)event焦点丢失时
void ReceiveFocusReceived(int32 UserIndex, int32 PointerId)event获得焦点时
bool ReceiveKeyChar(UDreamKeyEventData* EventData)event按键字符时
bool ReceiveKeyDown(UDreamKeyEventData* EventData)event按键按下时
bool ReceiveKeyUp(UDreamKeyEventData* EventData)event按键抬起时
void RefreshEachBindings()callable重新读取每个 each 和 for 源,并刷新其列表或其副本。作为 FieldNotify 变量的源在广播时会为你调用此方法;函数源没有可广播的内容,因此当代码改变了其返回值时,需要手动调用此方法。
void ResumeAnimation(FDreamUIAnimationHandle Handle)callable按实例原先的方向继续播放已暂停的实例。
void ReverseAnimation(FDreamUIAnimationHandle Handle)callable反向动画
void SetAlignmentInViewport(FVector2D InAlignment)callable枢轴点,按此控件自身框体的 0..1 取值。UMG 称之为对齐。
void SetAllowEventBubbleUp(bool Value)callable此控件看到指针/拖拽事件后,这些事件是否继续向祖先冒泡。
void SetAnchorsInViewport(FVector2D InAnchorMin, FVector2D InAnchorMax)callable相对于屏幕的锚点,min 和 max 按 0..1 取值。两者相等即为点锚点。
void SetAnimationCurrentTime(FDreamUIAnimationHandle Handle, float InTime)callable将实例跳转到以秒为单位的时间点,而不改变其是否正在播放。
void SetCanNavigateHere(bool Value)callable将此控件设为游戏手柄/键盘导航的停靠点。关闭时,导航会完全忽略它。
bool SetContentForNamedSlot(FName InSlotName, UDreamWidget* InContent)callable将 InContent 绑定到 InSlotName。InContent 必须与此控件属于同一棵树——插槽由放置此实例的宿主填充,绝不会由第三方资源填充。
void SetDesiredSizeInViewport(FVector2D InSize)callable设置视口中的期望尺寸
void SetNumLoopsToPlay(FDreamUIAnimationHandle Handle, int32 NumLoopsToPlay)callable更改活动实例总共播放的次数。为零表示无限循环。
void SetOwningPlayer(APlayerController* InPlayerController)callable将此控件(以及它随后创建的一切)指向另一个本地玩家。
void SetPlaybackSpeed(FDreamUIAnimationHandle Handle, float PlaybackSpeed)callable设置播放速度
void SetPositionInViewport(FVector2D InPosition)callableUMG 的 SetPositionInViewport,以及与之配套的另外三个方法。
bool SetViewModel(FName Name, UObject* ViewModel)callable将此控件 viewmodels 条目 Name 所持有的对象交给它——这适用于无法看到蓝图类变量的代码(C++、UnrealSharp)中宿主所做的操作。该对象必须是该条目类的对象;它会被写入该条目的变量并广播该字段,因此所有通过它读取的绑定都会重新读取。为空则清除该条目。当此类没有该条目或对象属于其他类时,返回 False,并在日志中给出警告。
void SetWantsTick(bool Value)callable启用或禁用此控件的逐帧 OnTick。在任何时候都是安全的,包括从 OnInitialized 中调用。
void StopAllAnimations()callable此控件自身内容中每个组件上的所有动画,不包括嵌套实例。
void StopAnimation(FDreamUIAnimationHandle Handle)callable让实例在其当前位置结束。其 Finished 委托会触发,与自然结束相同。
void StopAnimationsOf(UMovieSceneSequence* Animation)callable停止该动画的每个活动实例。
void StopListeningForAllInputActions()callable停止监听所有输入操作
void StopListeningForInputAction(FDreamUIActionHandle InHandle)callable停止监听输入操作
void UnbindAllFromAnimationFinished(UMovieSceneSequence* Animation)callable解除动画完成的所有绑定
void UnbindAllFromAnimationStarted(UMovieSceneSequence* Animation)callable解除动画开始的所有绑定
void UnbindFromAnimationFinished(UMovieSceneSequence* Animation, FDreamUIAnimationDynamicEvent Delegate)callable解除动画完成的绑定
void UnbindFromAnimationStarted(UMovieSceneSequence* Animation, FDreamUIAnimationDynamicEvent Delegate)callable解除动画开始的绑定

事件

事件签名描述
OnAnimationEventvoid DreamUIAnimEventDelegate__DelegateSignature(FName EventName)在此控件的某个动画播放期间,一个 DreamUI 事件轨道关键帧被越过。

本页目录