Widget UI system

Classes

Typedefs

`EventType`	`TypeID`
`WidgetType`	`TypeID`

Enums

ControlID VideoCallback VideoCommand VideoState WidgetAlignment WidgetFlags

Values

`ADDITIVE`	texture is added to a surface based on alpha
`BLEND`	texture is blended with a surface base on alpha
`CENTER`	Centers TextWidgetTypeID
`CID_BACK`
`CID_COUNT`
`CID_DOWN`
`CID_DRAG`	probably needed only for consoles
`CID_LEFT`	navigation
`CID_MENU`	get to main menu
`CID_NONE`
`CID_RADIALMENU`
`CID_RIGHT`
`CID_SELECT`	select/use focused
`CID_TABLEFT`
`CID_TABRIGHT`
`CID_UP`
`CLIPCHILDREN`
`CUSTOMUV`	ignores STRETCH/FLIPU/FLIPV and take custom UV set by SetWidgetUV()
`DISABLED`
`DRAGGABLE`
`EXACTPOS`	Uses physical resolution (g_iWidth, h_iHeight)
`EXACTSIZE`	Uses physical resolution
`FINISHED`	The video is paused at the end of the video
`FLIPU`	Flips texture in U axis
`FLIPV`	Flips texture in V axis
`HEXACTPOS`
`HEXACTSIZE`	Uses physical resolution (g_iWidth)
`IGNOREPOINTER`
`ISPLAYING`
`KILL`
`NOCLEAR`
`NOFILTER`	no texture filtering (no blur)
`NOFOCUS`
`NONE`	There is no video
`NOWRAP`	Do not do texture wrapping
`ON_BUFFERING_END`
`ON_BUFFERING_START`
`ON_END`
`ON_ERROR`
`ON_LOAD`
`ON_PAUSE`
`ON_PLAY`
`ON_SEEK`
`ON_STOP`
`PAUSED`	The video is paused
`PLAY`
`PLAYING`	The video is playing
`POSITION`
`RALIGN`	Right alignment TextWidgetTypeID
`RENDER_ALWAYS`
`REPEAT`
`REWIND`
`SOURCEALPHA`	takes alpha from texture * alpha from color. If not set, considers texture as non-transparent and transparency is set only by color
`STOP`
`STOPPED`	The video is paused at the beginning of the video
`STRETCH`	Stretch texture to a full size
`VCENTER`	Centers TextWidgetTypeID verticaly
`VEXACTPOS`
`VEXACTSIZE`	Uses physical resolution (h_iHeight)
`VISIBLE`	Widget is visible - ShowWidget(w, true)
`WA_BOTTOM`
`WA_CENTER`
`WA_LEFT`
`WA_RIGHT`
`WA_TOP`

Functions

`proto void ~Widget()`
`proto native void AddChild(Widget child, bool immedUpdate = true)`
`proto native void AddChildAfter(Widget child, Widget after, bool immedUpdate = true)`
`proto native int AddItem(string text, Class userData, int column, int row = -1)` [1/2]	Insert new Row, if row = -1, new Row is inserted at the end otherwise at row index.
`proto native int AddItem(string item)` [2/2]
`proto native Widget CancelWidgetDragging()`		more…
`proto native void Clear()`
`proto native void ClearAll()`
`proto native int ClearFlags(int flags, bool immedUpdate = true)`	SUBSTRACTS the value to the existing flag
`proto native void ClearItems()`
`proto native external Widget CreateWidget(WidgetType type, int left, int top, int width, int height, WidgetFlags flags, int color, int sort, Widget parentWidget = NULL)`	Create widgets by \ref WidgetType
`proto native external Widget CreateWidgets(string layout, Widget parentWidget = NULL, bool immedUpdate = true)`	Create widgets from *.layout file
`proto native void DisableSubtitles(bool disable)`	Enable/Disable subtitles	more…
`proto native void DrawLine(float x1, float y1, float x2, float y2, float width, int color)`
`proto native void ElideText(int line, float maxWidth, string str)`
`proto native void Enable(bool enable)`
`proto native void EnsureVisible(int row)`
`proto native Widget FindAnyWidget(string pathname)`	find Widget by name e.g. FindWidget("widget1")
`proto native Widget FindAnyWidgetById(int user_id)`	find Widget by userID
`proto native Widget FindWidget(string pathname)`	find Widget by path. e.g FindWidget("widget1.widget2.widget3.mywidget")
`proto native float GetAlpha()`
`proto native bool GetBold()`
`proto native int GetCarriageLine()`
`proto native int GetCarriagePos()`
`proto native Widget GetChildren()`
`proto native int GetColor()`
`proto native WidgetAlignment GetContentAlignmentH()`
`proto native WidgetAlignment GetContentAlignmentV()`
`proto native float GetContentHeight()` [1/2]
`proto native float GetContentHeight()` [2/2]
`proto native float GetContentOffset()`
`proto native float GetContentWidth()`
`proto native float GetCurrent()` [1/2]
`proto native float GetCurrent()` [2/2]
`proto native int GetCurrentItem()`
`proto native Widget GetDragWidget()`		more…
`proto native int GetFlags()`
`proto native Widget GetFocus()`		more…
`proto native float GetHScrollPos()`
`proto native float GetHScrollPos01()`
`proto native int GetImage()`	Returns active image
`proto void GetImageSize(int image, out int sx, out int sy)`	returns size of image
`proto native bool GetItalic()`
`proto void GetItemData(int row, int column, out Class data)`
`proto bool GetItemText(int row, int column, out string text)`	Get item	more…
`proto void GetLine(int line, out string text)`
`proto native int GetLinesCount()`
`proto native float GetLineWidth(int line)`
`proto native float GetMaskProgress()`	Progress determines which alpha values are opaque using the mask. For progress x, pixels with alpha in mask < x will be opaque and alpha in mask > x will be transparent. For smooth transition see GetMaskTransitionWidth.	more…
`proto native float GetMaskTransitionWidth()`	Transition width 0.1 and progress 0.2 mean that values in mask lower than progress will be opaque. Values higher than (progress + width) will be transparent and values between progress and (progress + width) will be smoothly transitioned.	more…
`proto native float GetMax()` [1/2]
`proto native float GetMax()` [2/2]
`proto native float GetMin()` [1/2]
`proto native float GetMin()` [2/2]
`proto native owned string GetName()`
`proto native int GetNumItems()` [1/2]
`proto native int GetNumItems()` [2/2]
`proto native int GetNumLines()`
`proto native int GetOutlineColor()`
`proto native int GetOutlineSize()`
`proto native Widget GetParent()`
`proto void GetPos(out float x, out float y)`
`proto native vector GetRotation()`	returns rotation of widget in order roll, pitch, yaw
`proto void GetScreenPos(out float x, out float y)`
`proto void GetScreenSize(out float width, out float height)`		more…
`proto void GetScript(out Class data)`
`proto native float GetScrollbarWidth()`
`proto native int GetSelectedRow()`
`proto native int GetShadowColor()`
`proto void GetShadowOffset(out float sx, out float sy)`
`proto native float GetShadowOpacity()`
`proto native int GetShadowSize()`
`proto native Widget GetSibling()`
`proto void GetSize(out float width, out float height)`
`proto native int GetSort()`
`proto native bool GetState()` [1/2]
`proto native VideoState GetState()` [2/2]	Get the current state of the video
`proto native float GetStep()`
`proto native owned string GetStyleName()`
`proto void GetText(out string text)` [1/3]
`proto string GetText()` [2/3]
`proto void GetText(out string text)` [3/3]
`proto native bool GetTextBold()`
`proto native bool GetTextItalic()`
`proto native int GetTextOutlineColor()`
`proto native int GetTextOutlineSize()`
`proto native float GetTextProportion()` [1/2]	Get text proportion - ratio between button height and button text height in interval <0,1>
`proto native float GetTextProportion()` [2/2]	Get text proportion - ratio between button height and button text height in interval <0,1>
`proto native int GetTextShadowColor()`
`proto native float GetTextShadowOffsetX()`
`proto native float GetTextShadowOffsetY()`
`proto native float GetTextShadowOpacity()`
`proto native int GetTextShadowSize()`
`proto void GetTextSize(out int sx, out int sy)`	Returns text size in pixels
`proto native int GetTime()`	Get the current time of the video
`proto native int GetTotalTime()`	Get the total time of the video
`proto native WidgetType GetTypeID()`
`proto native owned string GetTypeName()`
`proto void GetUserData(out Class data)`
`proto native int GetUserID()`
`proto native float GetVScrollPos()`
`proto native float GetVScrollPos01()`
`proto native Widget GetWidgetUnderCursor()`		more…
`proto native bool HScrollStep(int steps)`
`proto native void HScrollToPos(float pos)`
`proto native void HScrollToPos01(float pos01)`
`proto native void HScrollToWidget(Widget child)`
`proto native bool IsChecked()`
`proto native bool IsCircleToCrossSwapped()`PS3	circle and cross can be swapped when license area is japan/asia
`proto native bool IsControlClass()`
`proto native bool IsLooping()`	Whether looping is enabled
`proto native bool IsPlaying()`	QoL direct method to check for playing state (buffering while playing will still return true)
`proto native bool IsScrollbarVisible()`	reflects native C++ side scrollbar state
`proto native bool IsSubtitlesDisabled()`	Check if subtitles are disabled (enabled by default if available, so it will return false even if there are none)
`proto native bool IsVisible()`
`proto native bool IsVisibleHierarchy()`
`proto native bool Load(string name, bool looping = false, int startTime = 0)`	Load a video file Return is deprecated, treat as void and use 'VideoCallback.ON_ERROR'
`proto native bool LoadImageFile(int num, string name, bool noCache = false)`	Loads image. When image of this 'num' is already loaded, then is replaced by new one.	more…
`proto native bool LoadMaskTexture(string resource)`	Loads texture as mask used for alpha masking.	more…
`bool LoadVideo(string name, int soundScene)`	Legacy, preferably not used, left for backwards compat	more…
`proto native bool LoadWidgetImageSet(string filename)`
`proto native void LoadWidgetStyles(string filename)`
`bool OnChange(Widget w, int x, int y, bool finished)`
`bool OnChildAdd(Widget w, Widget child)`
`bool OnChildRemove(Widget w, Widget child)`
`bool OnClick(Widget w, int x, int y, int button)`
`bool OnController(Widget w, int control, int value)`	control is one of ControlID
`bool OnDoubleClick(Widget w, int x, int y, int button)`
`bool OnDrag(Widget w, int x, int y)`
`bool OnDragging(Widget w, int x, int y, Widget reciever)`
`bool OnDraggingOver(Widget w, int x, int y, Widget reciever)`
`bool OnDrop(Widget w, int x, int y, Widget reciever)`
`bool OnDropReceived(Widget w, int x, int y, Widget reciever)`
`bool OnEvent(EventType eventType, Widget target, int parameter0, int parameter1)`
`bool OnFocus(Widget w, int x, int y)`
`bool OnFocusLost(Widget w, int x, int y)`
`bool OnItemSelected(Widget w, int x, int y, int row, int column, int oldRow, int oldColumn)`
`bool OnKeyDown(Widget w, int x, int y, int key)`
`bool OnKeyPress(Widget w, int x, int y, int key)`
`bool OnKeyUp(Widget w, int x, int y, int key)`
`bool OnModalResult(Widget w, int x, int y, int code, int result)`
`bool OnMouseButtonDown(Widget w, int x, int y, int button)`
`bool OnMouseButtonUp(Widget w, int x, int y, int button)`
`bool OnMouseEnter(Widget w, int x, int y)`
`bool OnMouseLeave(Widget w, Widget enterW, int x, int y)`
`bool OnMouseWheel(Widget w, int x, int y, int wheel)`
`bool OnResize(Widget w, int x, int y)`
`bool OnSelect(Widget w, int x, int y)`
`bool OnUpdate(Widget w)`
`proto native bool Pause()`	Pauses video playback Return is deprecated, treat as void and use 'VideoCallback.ON_ERROR'
`proto native bool Play()` [1/2]	Starts video playback Return is deprecated, treat as void and use 'VideoCallback.ON_ERROR'
`int Play(VideoCommand cmd)` [2/2]	Legacy, preferably not used, left for backwards compat	more…
`proto native bool ReloadTexture(string path)`
`proto native void RemoveChild(Widget child)`
`proto native void RemoveItem(int item)`
`proto native void RemoveRow(int row)`
`proto native void ReportMouse(int mousex, int mousey, Widget rootWidget)`
`proto native void SelectRow(int row)`
`proto native bool SetActiveWindow(Widget w, bool resetFocus)`
`proto native void SetAlpha(float alpha)`
`proto native void SetBold(bool bold)`
`proto void SetCallback(VideoCallback cb, func fn)`	Set a callback for a certain video event
`proto native void SetChecked(bool checked)`
`proto native void SetColor(int color)`
`proto native void SetContentAlignmentH(WidgetAlignment alignment)`
`proto native void SetContentAlignmentV(WidgetAlignment alignment)`
`proto native void SetContentOffset(float offset, bool snapToLine = false)`
`proto native void SetCurrent(float curr)` [1/2]
`proto native void SetCurrent(float curr)` [2/2]
`proto native int SetCurrentItem(int n)`
`proto native void SetCursorWidget(Widget cursor)`		more…
`proto native int SetFlags(int flags, bool immedUpdate = true)`	ADDS the value to the existing flag
`proto native void SetFocus(Widget w)`		more…
`proto native void SetGUIWidget(IEntity ent, int index, RTTextureWidget w)`	sets Widget typu RTTextureWidgetTypeID, to which it is possible to reference in shader as $rendertarget it is posible to use only after object selection. When selecting another object, it is necessary to set GUI widget again
`proto native void SetHandler(ScriptedWidgetEventHandler eventHandler)`
`proto native void SetHideText(bool hide)`
`proto native bool SetImage(int num)`	Switches to another image, if it's loaded	more…
`proto native void SetImageTexture(int image, RTTextureWidget texture)`
`proto native void SetItalic(bool italic)`
`proto native void SetItem(int position, string text, Class userData, int column)` [1/2]
`proto native void SetItem(int item, string value)` [2/2]
`proto native void SetItemColor(int row, int column, int color)`
`proto native void SetLine(int line, string text)`
`proto native float SetLineBreakingOverride(int mode)` [1/2]
`proto native float SetLineBreakingOverride(int mode)` [2/2]
`proto native void SetLinesVisibility(int lineFrom, int lineTo, bool visible)`
`proto native void SetLooping(bool looping)`	Set whether the video should loop
`proto static void SetLV(float lv)`	Set global LV of widgets, value between [-15, 0], default: 0, lower value is less bright
`proto native void SetMaskProgress(float value)`	See GetMaskProgress for explanation.	more…
`proto native void SetMaskTransitionWidth(float value)`	See GetMaskTransitionWidth for transition width explanation.	more…
`proto native void SetMinMax(float minimum, float maximum)`
`proto native void SetModal(Widget w)`
`proto native void SetName(string name)`
`proto static void SetObjectLighting(float lighting)`	Set global lighting of objects in widgets, value between [0, 1], default: 1, lower value is less bright
`proto native void SetOutline(int outlineSize, int argb = 0xFF000000)`
`proto native void SetPos(float x, float y, bool immedUpdate = true)`
`proto native void SetRefresh(int period, int offset)`	when period > 1 then every n-th frame will be rendered. Offset is initial counter.
`proto native void SetResolutionScale(float xscale, float ycale)`
`proto native void SetRotation(float roll, float pitch, float yaw, bool immedUpdate = true)`
`proto native void SetScreenPos(float x, float y, bool immedUpdate = true)`
`proto native void SetScreenSize(float w, float h, bool immedUpdate = true)`
`proto native void SetShadow(int shadowSize, int shadowARGB = 0xFF000000, float shadowOpacity = 1, float shadowOffsetX = 0, float shadowOffsetY = 0)`
`proto native void SetSize(float w, float h, bool immedUpdate = true)`
`proto native void SetSort(int sort, bool immedUpdate = true)`
`proto native bool SetState(bool state)`
`proto native void SetStep(float step)`
`proto native void SetText(string text)` [1/4]
`proto native void SetText(string str)` [2/4]
`proto native void SetText(string str)` [3/4]
`proto native void SetText(string text, bool immedUpdate = true)` [4/4]
`proto native void SetTextBold(bool bold)`
`proto native void SetTextColor(int color)`
`proto native void SetTextExactSize(int size)`	set text exact size. Exact Text flag must be enabled. 0 equals original size.
`proto void SetTextFormat(string text, void param1 = NULL, void param2 = NULL, void param3 = NULL, void param4 = NULL, void param5 = NULL, void param6 = NULL, void param7 = NULL, void param8 = NULL, void param9 = NULL)`
`proto native void SetTextHorizontalAlignment(int align)`		more…
`proto native void SetTextItalic(bool italic)`
`proto static void SetTextLV(float lv)`	Set global LV of the text in widgets, value between [-15, 0], default: 0, lower value is less bright
`proto native void SetTextOffset(float xoffset, float yoffset)` [1/2]
`proto native void SetTextOffset(int left, int top)` [2/2]
`proto native void SetTextOutline(int outlineSize, int argb = 0xFF000000)`
`proto native void SetTextProportion(float val)` [1/2]	Set text proportion - ratio between button height and button text height in interval <0,1>
`proto native void SetTextProportion(float val)` [2/2]	Set text proportion - ratio between button height and button text height in interval <0,1>
`proto native void SetTextShadow(int shadowSize, int shadowARGB = 0xFF000000, float shadowOpacity = 1.0, float shadowOffsetX = 0.0, float shadowOffsetY = 0.0)`
`proto native void SetTextSpacing(int horiz, int vert)`
`proto native void SetTextVerticalAlignment(int align)`		more…
`proto native bool SetTime(int time, bool preload)`	Set the desired time for the video (preload decides whether it will already load the next frames too) Return is deprecated, treat as void and use 'VideoCallback.ON_ERROR'
`proto native void SetTransform(vector mat[4], bool immedUpdate = true)`
`proto native void SetUserData(Class data)`
`proto native void SetUserID(int id)`
`proto native void SetUV(float uv[4][2])`	When WF_CUSTOMUV is set, we can supply our own UV coords instead of computed ones.	more…
`proto native void SetWidgetWorld(RenderTargetWidget w, IEntity wrldEntity, int camera)`		more…
`proto native void Show(bool show, bool immedUpdate = true)`
`proto native void ShowCursorWidget(bool show)`	direct mouse cursor visibility control	more…
`proto native bool Stop()`	Stop video playback (cancels everything and sets it back at time 0) Return is deprecated, treat as void and use 'VideoCallback.ON_ERROR'
`proto static string TranslateString(string stringId)`
`proto native void Unlink()`	destroys widget and all its children
`proto native void Unload()`	Unload the video, freeing up all resources
`proto native volatile void Update()`
`proto native bool VScrollStep(int steps)`
`proto native void VScrollToPos(float pos)`
`proto native void VScrollToPos01(float pos01)`
`proto native void VScrollToWidget(Widget child)`
`proto private void Widget()`

Variables

`BaseListboxWidgetTypeID`DOXYGEN
`ButtonWidgetTypeID`DOXYGEN
`CheckBoxWidgetTypeID`DOXYGEN
`ComboBoxWidgetTypeID`DOXYGEN
`ConsoleWidgetTypeID`DOXYGEN
`EditBoxWidgetTypeID`DOXYGEN
`EmbededWidgetTypeID`DOXYGEN
`FrameWidgetTypeID`DOXYGEN
`GenericListboxWidgetTypeID`DOXYGEN
`GridSpacerWidgetTypeID`DOXYGEN
`ImageWidgetTypeID`DOXYGEN
`MultilineEditBoxWidgetTypeID`DOXYGEN
`MultilineTextWidgetTypeID`DOXYGEN
`PasswordEditBoxWidgetTypeID`DOXYGEN
`ProgressBarWidgetTypeID`DOXYGEN
`RenderTargetWidgetTypeID`DOXYGEN
`RichTextWidgetTypeID`DOXYGEN
`RTTextureWidgetTypeID`DOXYGEN
`ScrollWidgetTypeID`DOXYGEN
`SimpleProgressBarWidgetTypeID`DOXYGEN
`SliderWidgetTypeID`DOXYGEN
`TextListboxWidgetTypeID`DOXYGEN
`TextWidgetTypeID`DOXYGEN	Single-line text. See enf::TextWidget
`VideoWidgetTypeID`DOXYGEN
`WindowWidgetTypeID`DOXYGEN
`WorkspaceWidgetTypeID`DOXYGEN
`WrapSpacerWidgetTypeID`DOXYGEN

Function Documentation

CancelWidgetDragging

proto native Widget CancelWidgetDragging()

Referenced by ClosableContainer.CheckHeaderDragability(), SlotsIcon.ClearRemainSelected(), VicinityContainer.UpdateHeader()

Show 1 more

, VicinitySlotsContainer.ShowItemsInContainers()

DisableSubtitlesVideoWidget

proto native void DisableSubtitles(bool disable)

Enable/Disable subtitles

NoteSubtitles are in the format "videoName_Language.srt"

NoteIt is best to have the English one without language specified "videoName.srt"

WarningSubtitles need font to be assigned to VideoWidget in layout to work

GetDragWidget

proto native Widget GetDragWidget()

Referenced by ClosableContainer.CheckHeaderDragability(), ClosableHeader.MouseEnter(), SlotsIcon.MouseEnter()

Show 5 more

, SlotsIcon.MouseEnterGhostSlot(), SlotsIcon.MouseLeave(), SlotsIcon.MouseLeaveGhostSlot(), VicinityContainer.UpdateHeader(), and VicinitySlotsContainer.ShowItemsInContainers()

GetFocus

proto native Widget GetFocus()

Referenced by CharacterCreationMenu.NextOption(), CharacterCreationMenu.PreviousOption(), InGameMenuXbox.Init()

Show 11 more

, InGameMenuXbox.OnInputDeviceChanged(), MainMenu.OnModalResult(), MainMenuConsole.OnInputDeviceChanged(), OptionSelectorEditbox.OnFocus(), OptionSelectorSliderSetup.OnFocus(), ScriptConsoleCameraTab.OnMouseLeave(), ScriptConsoleCameraTab.Update(), ScriptConsoleWeatherTab.Update(), ServerBrowserEntry.Lighten(), ServerBrowserTab.GetNextEntry(), and ServerBrowserTab.GetPrevEntry()

GetItemTextTextListboxWidget

proto bool GetItemText(int row, int column, out string text)

Get item

row: int Index of row
column: int Index of column

Returns: string Value in widget on row and column

string value;
textListboxWidg.GetItemText(2, 0, value);

Referenced by SceneEditorMenu.AddItemToPreset(), SceneEditorMenu.GetCurrentItemName(), SceneEditorMenu.GetCurrentObjectName()

Show 11 more

, SceneEditorMenu.OnItemSelected(), ScriptConsoleConfigTab.OnClick(), ScriptConsoleItemsTab.AddItemToPreset(), ScriptConsoleItemsTab.GetCurrentItemName(), ScriptConsoleItemsTab.GetCurrentObjectName(), ScriptConsoleSoundsTab.HandleKeys(), ScriptConsoleSoundsTab.OnClick(), ScriptConsoleTabBase.AddItemToClipboard(), UIPopupScriptConfigs.AddItemToClipboard(), UIPopupScriptPositionManager.GetCurrentLocationName(), and UIPopupScriptSceneManager.OnClick()

GetMaskProgressImageWidget

proto native float GetMaskProgress()

Progress determines which alpha values are opaque using the mask. For progress x, pixels with alpha in mask < x will be opaque and alpha in mask > x will be transparent. For smooth transition see GetMaskTransitionWidth.

Returns: Progress from 0 to 1 representing alpha range which is visible in the mask

GetMaskTransitionWidthImageWidget

proto native float GetMaskTransitionWidth()

Transition width 0.1 and progress 0.2 mean that values in mask lower than progress will be opaque. Values higher than (progress + width) will be transparent and values between progress and (progress + width) will be smoothly transitioned.

Returns: Width of the alpha mask transition representing softness of the transition.