Enfusion Script API
Loading...
Searching...
No Matches
Classes | Enumerations
UI

Classes

interface  AlignableSlot
 
interface  BaseListboxWidget
 
interface  BasicGraphWidget
 
interface  BlurWidget
 
interface  ButtonSlot
 
interface  ButtonWidget
 ButtonWidget class. More...
 
interface  CanvasWidget
 
interface  CanvasWidgetBase
 All methods working with vector work only with its x and y components, the z is always ignored. More...
 
interface  CheckBoxWidget
 
interface  ContentWidget
 
interface  EditBoxWidget
 
interface  FrameSlot
 
interface  FrameWidget
 FrameWidget class. More...
 
interface  GenericListboxWidget
 
interface  GridLayoutWidget
 GridLayoutWidget class. More...
 
interface  GridSlot
 
interface  HorizontalLayoutSlot
 
interface  HorizontalLayoutWidget
 
interface  ImageWidget
 
interface  LayoutSlot
 
interface  LayoutWidgetBase
 LayoutWidgetBase class. More...
 
interface  MultilineEditBoxWidget
 
interface  OverlaySlot
 
interface  OverlayWidget
 OverlayWidget class. More...
 
interface  PanelSlot
 
interface  PanelWidget
 
interface  ProgressBarWidget
 
interface  RenderTargetWidget
 
interface  RichTextWidget
 
interface  RingBufferGraphWidget
 
interface  RTTextureSlot
 
interface  RTTextureWidget
 
interface  ScaleWidget
 
interface  ScriptedWidgetComponent
 
interface  ScriptedWidgetEventHandler
 
interface  ScrollLayoutSlot
 
interface  ScrollLayoutWidget
 ScrollLayoutWidget class. More...
 
interface  SimpleListboxWidget
 base class, for listboxes with items of the same height More...
 
interface  SizeLayoutSlot
 
interface  SizeLayoutWidget
 SizeLayoutWidget class. More...
 
interface  SliderWidget
 
interface  SocketWidget
 
interface  TextListboxWidget
 
interface  TextWidget
 Widget representing text. More...
 
interface  ThreeStateCheckboxWidget
 
interface  TimeBasedGraphWidget
 
interface  TimeBasedGraphWithAxesWidget
 
interface  UIWidget
 
interface  UniformGridLayoutWidget
 UniformGridLayoutWidget class. More...
 
interface  UniformGridSlot
 
interface  UniversalListboxWidget
 
interface  UserWidget
 
interface  VerticalLayoutSlot
 
interface  VerticalLayoutWidget
 
interface  VideoWidget
 
interface  Widget
 
interface  WidgetManager
 Class containing global and util functions regarding widgets. More...
 
interface  WindowSlot
 
interface  WindowWidget
 
interface  WorkspaceSlot
 
interface  WorkspaceWidget
 WorkspaceWidget class. More...
 
interface  XComboBoxWidget
 
interface  GameLibWidgetType
 
interface  GameConsoleWidget
 
interface  SmartPanelWidget
 

Enumerations

enum  ControlID {
  ControlID.NONE , ControlID.SELECT , ControlID.BACK , ControlID.LEFT ,
  ControlID.RIGHT , ControlID.UP , ControlID.DOWN , ControlID.MENU ,
  ControlID.DRAG , ControlID.TABLEFT , ControlID.TABRIGHT , ControlID.RADIALMENU ,
  ControlID.COUNT
}
 
enum  ImageMaskMode { ImageMaskMode.REGULAR , ImageMaskMode.INVERTED , ImageMaskMode.RANGE , ImageMaskMode.RANGE_INVERTED }
 
enum  LayoutHorizontalAlign { LayoutHorizontalAlign.Left , LayoutHorizontalAlign.Center , LayoutHorizontalAlign.Right , LayoutHorizontalAlign.Stretch }
 
enum  LayoutSizeMode { LayoutSizeMode.Auto , LayoutSizeMode.Fill }
 LayoutSize enum. More...
 
enum  LayoutVerticalAlign { LayoutVerticalAlign.Top , LayoutVerticalAlign.Center , LayoutVerticalAlign.Bottom , LayoutVerticalAlign.Stretch }
 
enum  RenderTargetWidgetBlendMode { RenderTargetWidgetBlendMode.DISABLED , RenderTargetWidgetBlendMode.ALPHA_BLEND , RenderTargetWidgetBlendMode.ADDITIVE }
 
enum  RenderTargetWidgetFormat {
  RenderTargetWidgetFormat.DEFAULT , RenderTargetWidgetFormat.INHERIT , RenderTargetWidgetFormat.LDR , RenderTargetWidgetFormat.LDR_SRGB ,
  RenderTargetWidgetFormat.HDR_LOW , RenderTargetWidgetFormat.HDR_HIGH
}
 
enum  VideoCommand {
  VideoCommand.PLAY , VideoCommand.STOP , VideoCommand.REWIND , VideoCommand.POSITION ,
  VideoCommand.REPEAT , VideoCommand.ISPLAYING
}
 
enum  WidgetFlags {
  WidgetFlags.VISIBLE , WidgetFlags.CLIPCHILDREN , WidgetFlags.INHERIT_CLIPPING , WidgetFlags.DO_NOT_CLIP_RECT ,
  WidgetFlags.DIRTY , WidgetFlags.IGNORE_CURSOR , WidgetFlags.INHERIT_COLOR , WidgetFlags.DISABLED ,
  WidgetFlags.NOFOCUS , WidgetFlags.NO_PIXEL_PERFECT , WidgetFlags.BLEND , WidgetFlags.ADDITIVE ,
  WidgetFlags.SHADOW , WidgetFlags.NOWRAP , WidgetFlags.NOFILTER , WidgetFlags.STRETCH ,
  WidgetFlags.FLIPU , WidgetFlags.FLIPV , WidgetFlags.CUSTOMUV , WidgetFlags.CENTER ,
  WidgetFlags.VCENTER , WidgetFlags.RALIGN , WidgetFlags.WRAP_TEXT , WidgetFlags.NO_LOCALIZATION
}
 Widget flags. See enf::Widget::SetFlags() More...
 
enum  WidgetNavigationRuleType { WidgetNavigationRuleType.ESCAPE , WidgetNavigationRuleType.STOP , WidgetNavigationRuleType.WRAP , WidgetNavigationRuleType.EXPLICIT }
 WidgetNavigationRuleType. More...
 

Detailed Description

Enumeration Type Documentation

◆ ControlID

enum ControlID
Enumerator
NONE 
SELECT 

select/use focused

BACK 
LEFT 

navigation

RIGHT 
UP 
DOWN 
MENU 

get to main menu

DRAG 

probably needed only for consoles

TABLEFT 
TABRIGHT 
RADIALMENU 
COUNT 

◆ ImageMaskMode

Enumerator
REGULAR 
INVERTED 
RANGE 
RANGE_INVERTED 

◆ LayoutHorizontalAlign

Enumerator
Left 
Center 
Right 
Stretch 

◆ LayoutSizeMode

LayoutSize enum.

Enumerator
Auto 
Fill 

◆ LayoutVerticalAlign

Enumerator
Top 
Center 
Bottom 
Stretch 

◆ RenderTargetWidgetBlendMode

Enumerator
DISABLED 
ALPHA_BLEND 
ADDITIVE 

◆ RenderTargetWidgetFormat

Enumerator
DEFAULT 

Use currently set main RT format (based on game options)

INHERIT 

Use the render target format of currently set render target.

LDR 

LDR format (R8G8B8S8)

LDR_SRGB 

LDR format (R8G8B8S8_SRGB)

HDR_LOW 

HDR format, lower precision (R11G11B10)

HDR_HIGH 

HDR format, higher precision (R16G16B16A16)

◆ VideoCommand

Enumerator
PLAY 
STOP 
REWIND 
POSITION 
REPEAT 
ISPLAYING 

◆ WidgetFlags

Widget flags. See enf::Widget::SetFlags()

Enumerator
VISIBLE 

When set, widget and his children are visible.

CLIPCHILDREN 

Children will be clipped by regions of this widget.

INHERIT_CLIPPING 

Inherits WF_CLIPCHILDREN setting from its parent.

DO_NOT_CLIP_RECT 

Clip by rectangle given by some of the previous widgets.

DIRTY 

Indicates that a widget is dirty and should be updated.

IGNORE_CURSOR 

Widget will ignore query for widget which pointer is pointing to.

INHERIT_COLOR 

Inherits transparency from parent Widget.

DISABLED 

UI Widget is not enabled.

NOFOCUS 

UI Widget will never get focus.

NO_PIXEL_PERFECT 

Indicates that a widget position & size is rounded to always be a whole number.

BLEND 

Widget will be alpha-blended.

ADDITIVE 

Alpha-blending will be additive.

SHADOW 

Rendering of image shadow, INTERNAL USE ONLY.

NOWRAP 

Image will not be wrapped.

NOFILTER 

Image will not be bilinear filtered.

STRETCH 

Image will be used as big, as widget is and will be stretched accordingly.

FLIPU 

Image will be horizontally flipped. Used by enf::ImageWidget and enf::TextWidget.

FLIPV 

Image will be vertically flipped. Used by enf::ImageWidget and enf::TextWidget.

CUSTOMUV 

UV mapping will be externally set. Usable for special mappings as rotation etc. Used by enf::ImageWidget and enf::TextWidget.

CENTER 

Text will be centered.

VCENTER 

Text will be vertically centered.

RALIGN 

Text will be right aligned.

WRAP_TEXT 

Text will be wrapped on horizontal overflow.

NO_LOCALIZATION 

Text will not be parsed for string IDs.

◆ WidgetNavigationRuleType

WidgetNavigationRuleType.

Enumerator
ESCAPE 
STOP 
WRAP 
EXPLICIT