G1R AngelScript
Scripting reference for the Gothic 1 Remake
Loading...
Searching...
No Matches
UCommonHardwareVisibilityBorder Class Reference

A container that controls visibility based on Platform, Input. More...

Static Public Member Functions

Static Functions
static UClass StaticClass ()
Static Public Member Functions inherited from UCommonBorder
static UClass StaticClass ()
Static Public Member Functions inherited from UBorder
static UClass StaticClass ()
Static Public Member Functions inherited from UContentWidget
static UClass StaticClass ()
Static Public Member Functions inherited from UPanelWidget
static UClass StaticClass ()
Static Public Member Functions inherited from UWidget
static UClass StaticClass ()
Static Public Member Functions inherited from UVisual
static UClass StaticClass ()
Static Public Member Functions inherited from UObject
static UClass StaticClass ()

Public Attributes

Visibility
ESlateVisibility VisibleType
ESlateVisibility HiddenType
FGameplayTagQuery VisibilityQuery
FMargin MinimumPadding
 The minimum padding we will reduce to when the safezone grows.
TSubclassOf< UCommonBorderStyle > Style
 References the border style to use.
bool bReducePaddingBySafezone
 Turning this on will cause the safe zone size to be removed from this borders content padding down to the minimum specified.
Public Attributes inherited from UBorder
EHorizontalAlignment HorizontalAlignment
 The alignment of the content horizontally.
FLinearColor ContentColorAndOpacity
 Color and opacity multiplier of content in the border.
EVerticalAlignment VerticalAlignment
 The alignment of the content vertically.
FMargin Padding
 The padding area between the slot and the content it contains.
FOnPointerEvent__Widget OnMouseButtonUpEvent
FOnPointerEvent__Widget OnMouseMoveEvent
FOnPointerEvent__Widget OnMouseButtonDownEvent
FOnPointerEvent__Widget OnMouseDoubleClickEvent
bool bFlipForRightToLeftFlowDirection
 Flips the background image if the localization's flow direction is RightToLeft.
FVector2D DesiredSizeScale
 Scales the computed desired size of this border and its contents. Useful for making things that slide open without having to hard-code their size. Note: if the parent widget is set up to ignore this widget's desired size, then changing this value will have no effect.
FLinearColor BrushColor
 Color and opacity of the actual border image.
bool bShowEffectWhenDisabled
 Whether or not to show the disabled effect when this border is disabled.
FSlateBrush Background
 Brush to drag as the background.
const UMaterialInstanceDynamic DynamicMaterial
const UPanelSlot ContentSlot
UWidget Content
const int ChildrenCount
 Gets number of child widgets in the container.
const TArray< UWidget > AllChildren
 Gets all widgets in the container.
Public Attributes inherited from UWidget
FText AccessibleSummaryText
 When AccessibleSummaryBehavior is set to Custom, this is the text that will be used to describe the widget.
FText AccessibleText
 When AccessibleBehavior is set to Custom, this is the text that will be used to describe the widget.
ESlateAccessibleBehavior AccessibleBehavior
 Whether or not the widget is accessible, and how to describe it. If set to custom, additional customization options will appear.
ESlateAccessibleBehavior AccessibleSummaryBehavior
 How to describe this widget when it's being presented through a summary of a parent widget. If set to custom, additional customization options will appear.
EMouseCursor Cursor
 The cursor to show when the mouse is over the widget.
FText ToolTipText
 Tooltip text to show when the user hovers over the widget with the mouse.
UWidget ToolTipWidget
 Tooltip widget to show when the user hovers over the widget with the mouse.
bool bIsEnabled
 Sets whether this widget can be modified interactively by the user.
ESlateVisibility Visibility
 The visibility of the widget.
UPanelSlot Slot
 The parent slot of the UWidget. Allows us to easily inline edit the layout controlling this widget.
EFlowDirectionPreference FlowDirectionPreference
 Allows you to set a new flow direction.
UWidgetNavigation Navigation
 The navigation object for this widget is optionally created if the user has configured custom navigation rules for this widget in the widget designer. Those rules determine how navigation transitions can occur between widgets.
bool bIsVolatile
 If true prevents the widget or its child's geometry or layout information from being cached. If this widget changes every frame, but you want it to still be in an invalidation panel you should make it as volatile instead of invalidating it every frame, which would prevent the invalidation panel from actually ever caching anything.
FVector2D RenderTransformPivot
 The render transform pivot controls the location about which transforms are applied. This value is a normalized coordinate about which things like rotations will occur.
FWidgetTransform RenderTransform
 The render transform of the widget allows for arbitrary 2D transforms to be applied to the widget.
EWidgetPixelSnapping PixelSnapping
 If the widget will draw snapped to the nearest pixel. Improves clarity but might cause visibile stepping in animation.
EWidgetClipping Clipping
 Controls how the clipping behavior of this widget. Normally content that overflows the bounds of the widget continues rendering. Enabling clipping prevents that overflowing content from being seen.
float32 RenderOpacity
 The opacity of the widget.
const FGeometry CachedGeometry
 Gets the last geometry used to Tick the widget. This data may not exist yet if this call happens prior to the widget having been ticked/painted, or it may be out of date, or a frame behind.
const FGeometry PaintSpaceGeometry
const UGameInstance GameInstance
 Gets the game instance associated with this UI.
const UPanelWidget Parent
 Gets the parent widget.
const FVector2D DesiredSize
 Gets the widgets desired size. NOTE: The underlying Slate widget must exist and be valid, also at least one pre-pass must have occurred before this value will be of any use.
const FGeometry TickSpaceGeometry
bool IsEnabled
 Gets the current enabled status of the widget.
const ULocalPlayer OwningLocalPlayer
 Gets the local player associated with this UI.
const APlayerController OwningPlayer
 Gets the player controller associated with this UI.
float32 RenderTransformAngle
Public Attributes inherited from UObject
const UClass Class
const UObject Outer
const UPackage Outermost
const UPackage Package
const UWorld World
const FName Name
const bool IsRooted

Additional Inherited Members

Public Member Functions inherited from UCommonBorder
const TSubclassOf< UCommonBorderStyle > & GetStyle () const
 References the border style to use.
void SetStyle (TSubclassOf< UCommonBorderStyle > InStyle)
Public Member Functions inherited from UBorder
const FLinearColor & GetContentColorAndOpacity () const
 Color and opacity multiplier of content in the border.
const EHorizontalAlignment & GetHorizontalAlignment () const
 The alignment of the content horizontally.
const EVerticalAlignment & GetVerticalAlignment () const
 The alignment of the content vertically.
bool GetbShowEffectWhenDisabled () const
 Whether or not to show the disabled effect when this border is disabled.
void SetbShowEffectWhenDisabled (bool bInShowEffectWhenDisabled)
 Whether or not to show the disabled effect when this border is disabled.
const FMargin & GetPadding () const
 The padding area between the slot and the content it contains.
const FLinearColor & GetBrushColor () const
 Color and opacity of the actual border image.
const FVector2D & GetDesiredSizeScale () const
 Scales the computed desired size of this border and its contents. Useful for making things that slide open without having to hard-code their size. Note: if the parent widget is set up to ignore this widget's desired size, then changing this value will have no effect.
void SetShowEffectWhenDisabled (bool bInShowEffectWhenDisabled)
void SetBrush (FSlateBrush InBrush)
void SetBrushColor (FLinearColor InBrushColor)
void SetBrushFromAsset (USlateBrushAsset Asset)
void SetBrushFromMaterial (UMaterialInterface Material)
void SetBrushFromTexture (UTexture2D Texture)
void SetContentColorAndOpacity (FLinearColor InContentColorAndOpacity)
void SetDesiredSizeScale (FVector2D InScale)
 Sets the DesiredSizeScale of this border.
void SetHorizontalAlignment (EHorizontalAlignment InHorizontalAlignment)
void SetPadding (FMargin InPadding)
UMaterialInstanceDynamic GetDynamicMaterial ()
void SetVerticalAlignment (EVerticalAlignment InVerticalAlignment)
UPanelSlot GetContentSlot () const
UPanelSlot SetContent (UWidget Content)
UWidget GetContent () const
int GetChildrenCount () const
 Gets number of child widgets in the container.
void ClearChildren ()
 Remove all child widgets from the panel widget.
TArray< UWidget > GetAllChildren () const
 Gets all widgets in the container.
UWidget GetChildAt (int Index) const
 Gets the widget at an index.
int GetChildIndex (const UWidget Content) const
 Gets the index of a specific child widget.
UPanelSlot AddChild (UWidget Content)
 Adds a new child widget to the container. Returns the base slot type, requires casting to turn it into the type specific to the container.
bool HasAnyChildren () const
 Returns true if there are any child widgets in the panel.
bool HasChild (UWidget Content) const
 Returns true if panel contains this widget.
bool RemoveChild (UWidget Content)
 Removes a specific widget from the container.
bool RemoveChildAt (int Index)
 Removes a child by it's index.
Public Member Functions inherited from UWidget
bool IsInViewport () const
void RemoveFieldValueChangedDelegate (FFieldNotificationId FieldId, FFieldValueChangedDynamicDelegate Delegate=FFieldValueChangedDynamicDelegate())
void BroadcastFieldValueChanged (FFieldNotificationId FieldId)
void AddFieldValueChangedDelegate (FFieldNotificationId FieldId, FFieldValueChangedDynamicDelegate Delegate=FFieldValueChangedDynamicDelegate())
void SetbOverride_Cursor (bool Value)
void SetToolTipWidget (UWidget Widget)
 Tooltip widget to show when the user hovers over the widget with the mouse.
bool GetbIsEnabled () const
 Sets whether this widget can be modified interactively by the user.
void SetbIsEnabled (bool bInIsEnabled)
 Sets whether this widget can be modified interactively by the user.
const FWidgetTransform & GetRenderTransform ()
const FText & GetToolTipText () const
 Tooltip text to show when the user hovers over the widget with the mouse.
UWidget GetToolTipWidget () const
 Tooltip widget to show when the user hovers over the widget with the mouse.
const FVector2D & GetRenderTransformPivot () const
 The render transform pivot controls the location about which transforms are applied. This value is a normalized coordinate about which things like rotations will occur.
void GetChildWidgets (TArray< UWidget > &OutChildWidgets) const
void SetbOverrideAccessibleDefaults (bool Value)
 Override all of the default accessibility behavior and text for this widget.
void SetbCanChildrenBeAccessible (bool Value)
 Whether or not children of this widget can appear as distinct accessible widgets.
void SetAccessibleText (FText Value)
 When AccessibleBehavior is set to Custom, this is the text that will be used to describe the widget.
void SetAccessibleSummaryText (FText Value)
 When AccessibleSummaryBehavior is set to Custom, this is the text that will be used to describe the widget.
bool GetbIsVolatile () const
 If true prevents the widget or its child's geometry or layout information from being cached. If this widget changes every frame, but you want it to still be in an invalidation panel you should make it as volatile instead of invalidating it every frame, which would prevent the invalidation panel from actually ever caching anything.
void SetbIsVolatile (bool Value)
 If true prevents the widget or its child's geometry or layout information from being cached. If this widget changes every frame, but you want it to still be in an invalidation panel you should make it as volatile instead of invalidating it every frame, which would prevent the invalidation panel from actually ever caching anything.
const EMouseCursor & GetCursor () const
 The cursor to show when the mouse is over the widget.
const FGeometry & GetCachedGeometry () const
 Gets the last geometry used to Tick the widget. This data may not exist yet if this call happens prior to the widget having been ticked/painted, or it may be out of date, or a frame behind.
EWidgetClipping GetClipping () const
 Gets the clipping state of this widget.
FVector2D GetDesiredSize () const
 Gets the widgets desired size. NOTE: The underlying Slate widget must exist and be valid, also at least one pre-pass must have occurred before this value will be of any use.
FText GetAccessibleText () const
 Gets the accessible text from the underlying Slate accessible widget.
FText GetAccessibleSummaryText () const
 Gets the accessible summary text from the underlying Slate accessible widget.
UGameInstance GetGameInstance () const
 Gets the game instance associated with this UI.
ULocalPlayer GetOwningLocalPlayer () const
 Gets the local player associated with this UI.
APlayerController GetOwningPlayer () const
 Gets the player controller associated with this UI.
const FGeometry & GetPaintSpaceGeometry () const
UPanelWidget GetParent () const
 Gets the parent widget.
float32 GetRenderOpacity () const
 Gets the current visibility of the widget.
bool GetIsEnabled () const
 Gets the current enabled status of the widget.
void ForceVolatile (bool bForce)
 Sets the forced volatility of the widget.
ESlateVisibility GetVisibility () const
 Gets the current visibility of the widget.
bool HasAnyUserFocus () const
 Returns true if this widget is focused by any user.
bool HasFocusedDescendants () const
 Returns true if any descendant widget is focused by any user.
bool HasKeyboardFocus () const
 Checks to see if this widget currently has the keyboard focus.
bool HasMouseCapture () const
 Checks to see if this widget is the current mouse captor.
bool HasMouseCaptureByUser (int UserIndex, int PointerIndex=- 1) const
 Checks to see if this widget is the current mouse captor.
bool HasUserFocus (APlayerController PlayerController) const
 Returns true if this widget is focused by a specific user.
bool HasUserFocusedDescendants (APlayerController PlayerController) const
 Returns true if any descendant widget is focused by a specific user.
void InvalidateLayoutAndVolatility ()
 Invalidates the widget from the view of a layout caching widget that may own this widget. will force the owning widget to redraw and cache children on the next paint pass.
bool IsHovered () const
 Returns true if the widget is currently being hovered by a pointer device.
void ForceLayoutPrepass ()
 Forces a pre-pass. A pre-pass caches the desired size of the widget hierarchy owned by this widget. One pre-pass already happens for every widget before Tick occurs. You only need to perform another pre-pass if you are adding child widgets this frame and want them to immediately be visible this frame.
bool IsRendered () const
 Returns true if the widget is Visible, HitTestInvisible or SelfHitTestInvisible and the Render Opacity is greater than 0.
bool IsVisible () const
 Returns true if the widget is Visible, HitTestInvisible or SelfHitTestInvisible.
const FGeometry & GetTickSpaceGeometry () const
void SetClipping (EWidgetClipping InClipping)
 Sets the clipping state of this widget.
void SetNavigationRuleCustom (EUINavigation Direction, FCustomWidgetNavigationDelegate InCustomDelegate=FCustomWidgetNavigationDelegate())
 Sets the widget navigation rules for a specific direction. This can only be called on widgets that are in a widget tree. This works only for Custom Rule.
void RemoveFromParent ()
 Removes the widget from its parent widget. If this widget was added to the player's screen or the viewport it will also be removed from those containers.
void ResetCursor ()
 Resets the cursor to use on the widget, removing any customization for it.
void SetAllNavigationRules (EUINavigationRule Rule, FName WidgetToFocus)
 Sets the widget navigation rules for all directions. This can only be called on widgets that are in a widget tree.
void SetVisibility (ESlateVisibility InVisibility)
 Sets the visibility of the widget.
void SetCursor (EMouseCursor InCursor)
 Sets the cursor to show over the widget.
void SetFocus ()
 Sets the focus to this widget for the owning user.
void SetIsEnabled (bool bInIsEnabled)
 Sets the current enabled status of the widget.
void SetKeyboardFocus ()
 Sets the focus to this widget.
void SetNavigationRule (EUINavigation Direction, EUINavigationRule Rule, FName WidgetToFocus)
void SetNavigationRuleBase (EUINavigation Direction, EUINavigationRule Rule)
 Sets the widget navigation rules for a specific direction. This can only be called on widgets that are in a widget tree. This works only for non Explicit, non Custom and non CustomBoundary Rules.
void SetUserFocus (APlayerController PlayerController)
 Sets the focus to this widget for a specific user (if setting focus for the owning user, prefer SetFocus()).
void SetNavigationRuleCustomBoundary (EUINavigation Direction, FCustomWidgetNavigationDelegate InCustomDelegate=FCustomWidgetNavigationDelegate())
 Sets the widget navigation rules for a specific direction. This can only be called on widgets that are in a widget tree. This works only for CustomBoundary Rule.
void SetNavigationRuleExplicit (EUINavigation Direction, UWidget InWidget)
 Sets the widget navigation rules for a specific direction. This can only be called on widgets that are in a widget tree. This works only for Explicit Rule.
void SetRenderOpacity (float32 InOpacity)
 Sets the visibility of the widget.
void SetToolTip (UWidget Widget)
 Sets a custom widget as the tooltip of the widget.
void SetToolTipText (FText InToolTipText)
 Sets the tooltip text for the widget.
void SetRenderTransformAngle (float32 Angle)
void SetRenderTransformPivot (FVector2D Pivot)
float32 GetRenderTransformAngle () const
void SetRenderTransform (FWidgetTransform InTransform)
void SetRenderShear (FVector2D Shear)
void SetRenderScale (FVector2D Scale)
void SetRenderTranslation (FVector2D Translation)
Public Member Functions inherited from UObject
bool MarkPackageDirty () const
void RemoveFromRoot ()
bool GetIsRooted () const
bool IsTransient () const
bool Modify (bool bAlwaysMarkDirty=true)
void SetTransactional (bool bTransactional)
bool IsSupportedForNetworking () const
UClass GetClass () const
UObject GetOuter () const
UObject GetTypedOuter (TSubclassOf< UObject > Target) const
 Traverses the outer chain searching for the next object of a certain type.
UPackage GetOutermost () const
UPackage GetPackage () const
void AddToRoot ()
UWorld GetWorld () const
FName GetName () const
FString GetFullName (const UObject StopOuter=nullptr) const
FString GetPathName (const UObject StopOuter=nullptr) const
bool IsA (const UClass Class) const
 Returns true if this object is of the specified type, or a child of that type.
void SaveConfig ()
void LoadConfig ()
void ReloadConfig ()
void CopyScriptPropertiesFrom (const UObject OtherObject)
void opCast (?&Address) const
FString ToString () const

Detailed Description

A container that controls visibility based on Platform, Input.

Member Function Documentation

◆ StaticClass()

UClass StaticClass ( )
static

Member Data Documentation

◆ HiddenType

ESlateVisibility HiddenType

◆ VisibilityQuery

FGameplayTagQuery VisibilityQuery

◆ VisibleType

ESlateVisibility VisibleType