HPL3/Amnesia: Rebirth/Scripting/cGuiSet

From Frictional Wiki
Jump to navigation Jump to search

Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!

Fields

cGuiSet has no public fields.

Functions

Return Type Function And Description
cWidgetButton CreateWidgetButton(const cVector3f &in avLocalPos, const cVector2f &in avSize, const tWString &in asText, iWidget@ apParent, bool abToggleable, const tString &in asName)
cWidgetCheckBox CreateWidgetCheckBox(const cVector3f &in avLocalPos, const cVector2f &in avSize, const tWString &in asText, iWidget@ apParent, const tString &in asName)
cWidgetComboBox CreateWidgetComboBox(const cVector3f &in avLocalPos, const cVector2f &in avSize, const tWString &in asText, iWidget@ apParent, const tString &in asName)
cWidgetContextMenu CreateWidgetContextMenu(const cVector3f &in avLocalPos, const cVector2f &in avSize, const tWString &in asText, iWidget@ apParent, const tString &in asName)
cWidgetDummy CreateWidgetDummy(const cVector3f &in avLocalPos, iWidget@ apParent, const tString &in asName)
cWidgetFrame CreateWidgetFrame(const cVector3f &in avLocalPos, const cVector2f &in avSize, bool abDrawFrame, iWidget@ apParent, bool abHScrollBar, bool abVScrollBar, const tString &in asName)
cWidgetGroup CreateWidgetGroup(const cVector3f &in avLocalPos, const cVector2f &in avSize, const tWString &in asText, iWidget@ apParent, const tString &in asName)
cWidgetImage CreateWidgetImage(const tString &in asFile, const cVector3f &in avLocalPos, const cVector2f &in avSize, eGuiMaterial aMaterial, bool abAnimate, iWidget@ apParent, const tString &in asName)
cWidgetLabel CreateWidgetLabel(const cVector3f &in avLocalPos, const cVector2f &in avSize, const tWString &in asText, iWidget@ apParent, const tString &in asName)
cWidgetListBox CreateWidgetListBox(const cVector3f &in avLocalPos, const cVector2f &in avSize, iWidget@ apParent, const tString &in asName)
cWidgetMainMenu CreateWidgetMainMenu(iWidget@ apParent, const tString &in asName)
cWidgetMenuItem CreateWidgetMenuItem(const cVector3f &in avLocalPos, const cVector2f &in avSize, const tWString &in asText, iWidget@ apParent, const tString &in asName)
cWidgetMultiPropertyListBox CreateWidgetMultiPropertyListBox(const cVector3f &in avLocalPos, const cVector2f &in avSize, iWidget@ apParent, const tString &in asName)
cWidgetSlider CreateWidgetSlider(eWidgetSliderOrientation aOrientation, const cVector3f &in avLocalPos, const cVector2f &in avSize, int alMaxValue, iWidget@ apParent, const tString &in asName)
cWidgetTabFrame CreateWidgetTabFrame(const cVector3f &in avLocalPos, const cVector2f &in avSize, const tWString &in asText, iWidget@ apParent, bool abAllowHScroll, bool abAllowVScroll, const tString &in asName)
cWidgetTextBox CreateWidgetTextBox(const cVector3f &in avLocalPos, const cVector2f &in avSize, const tWString &in asText, iWidget@ apParent, eWidgetTextBoxInputType aeType, float afNumericAdd, bool abShowButtons, const tString &in asName)
cWidgetWindow CreateWidgetWindow(int alFlags, const cVector3f &in avLocalPos, const cVector2f &in avSize, const tWString &in asText, iWidget@ apParent, const tString &in asName)
void DestroyAllWidgets()
void DestroyWidget(iWidget@ apWidget, bool abDestroyChildren)
void DrawFont(const tWString &in asText, iFontData@ apFont, const cVector3f &in avPos, const cVector2f &in avSize, const cColor &in aColor)
void DrawFontEx(const tWString &in asText, iFontData@ apFont, const cVector3f &in avPos, const cVector2f &in avSize, const cColor &in aColor, eFontAlign aAlign, eGuiMaterial aMaterial)
void DrawGfx(cGuiGfxElement@ apGfx, const cVector3f &in avPos)
void DrawGfx(cGuiGfxElement@ apGfx, const cVector3f &in avPos, const cVector2f &in avSize, const cColor &in aColor)
void DrawGfx(cGuiGfxElement@ apGfx, const cVector3f &in avPos, const cVector2f &in avSize, const cColor &in aColor, eGuiMaterial aMaterial, float afRotationAngle, bool abUseCustomPivot, const cVector3f &in avCustomPivot)
cVector3f Get3DSize()
cMatrixf Get3DTransform()
iWidget GetAttentionWidget()
bool GetCullBackface()
cGuiGfxElement GetCurrentPointer()
float GetDisplayScale()
bool GetDrawMouse()
int GetDrawPriority()
iWidget GetFocusedWidget()
bool GetMouseMovementEnabled()
cVector2f GetMousePos()
float GetMouseZ()
tString GetName()
bool GetRootWidgetClips()
cGuiSkin GetSkin()
cVector2f GetVirtualSize()
cVector2f GetVirtualSizeOffset()
iWidget GetWidgetFromName(const tString &in asName)
bool HasFocus()
bool Is3D()
bool IsActive()
bool IsValidWidget(iWidget@ apWidget)
void RemoveWindow(cWidgetWindow@ apWin)
void ResetMouseOver()
void Set3DSize(const cVector3f &in avSize)
void Set3DTransform(const cMatrixf &in a_mtxTransform)
void SetActive(bool abX)
void SetAttentionWidget(iWidget@ apWidget, bool abClearFocus)
void SetCullBackface(bool abX)
void SetCurrentPointer(cGuiGfxElement@ apGfx)
void SetDrawMouse(bool abX)
void SetDrawPriority(int alPrio)
void SetFocusedWidget(iWidget@ apWidget, bool abCheckForValidity = false)
void SetIs3D(bool abX)
void SetLastWindowZ(float afX)
void SetMouseMovementEnabled(bool abX)
void SetMouseZ(float afZ)
void SetRootWidgetClips(bool abX)
void SetSkin(cGuiSkin@ apSkin)
void SetVirtualSize(const cVector2f &in avSize, float afMinZ, float afMaxZ, const cVector2f &in avOffset)
void SetWindowOnTop(cWidgetWindow@ apWin)
void ShowContextMenu(cWidgetContextMenu@ apMenu, const cVector3f &in avPosition)

Details

CreateWidgetButton

cWidgetButton@ CreateWidgetButton(const cVector3f &in avLocalPos,
                                  const cVector2f &in avSize,
                                  const tWString &in asText,
                                  iWidget@ apParent,
                                  bool abToggleable,
                                  const tString &in asName)


Parameters

Returns:

  • cWidgetButton@

CreateWidgetCheckBox

cWidgetCheckBox@ CreateWidgetCheckBox(const cVector3f &in avLocalPos,
                                      const cVector2f &in avSize,
                                      const tWString &in asText,
                                      iWidget@ apParent,
                                      const tString &in asName)


Parameters

Returns:

  • cWidgetCheckBox@

CreateWidgetComboBox

cWidgetComboBox@ CreateWidgetComboBox(const cVector3f &in avLocalPos,
                                      const cVector2f &in avSize,
                                      const tWString &in asText,
                                      iWidget@ apParent,
                                      const tString &in asName)


Parameters

Returns:

  • cWidgetComboBox@

CreateWidgetContextMenu

cWidgetContextMenu@ CreateWidgetContextMenu(const cVector3f &in avLocalPos,
                                            const cVector2f &in avSize,
                                            const tWString &in asText,
                                            iWidget@ apParent,
                                            const tString &in asName)


Parameters

Returns:

  • cWidgetContextMenu@

CreateWidgetDummy

cWidgetDummy@ CreateWidgetDummy(const cVector3f &in avLocalPos,
                                iWidget@ apParent,
                                const tString &in asName)


Parameters

Returns:

  • cWidgetDummy@

CreateWidgetFrame

cWidgetFrame@ CreateWidgetFrame(const cVector3f &in avLocalPos,
                                const cVector2f &in avSize,
                                bool abDrawFrame,
                                iWidget@ apParent,
                                bool abHScrollBar,
                                bool abVScrollBar,
                                const tString &in asName)


Parameters

  • avLocalPos (cVector3f) —
  • avSize (cVector2f) —
  • abDrawFrame (bool) —
  • apParent (iWidget@) —
  • abHScrollBar (bool) —
  • abVScrollBar (bool) —
  • asName (tString) —

Returns:

  • cWidgetFrame@

CreateWidgetGroup

cWidgetGroup@ CreateWidgetGroup(const cVector3f &in avLocalPos,
                                const cVector2f &in avSize,
                                const tWString &in asText,
                                iWidget@ apParent,
                                const tString &in asName)


Parameters

Returns:

  • cWidgetGroup@

CreateWidgetImage

cWidgetImage@ CreateWidgetImage(const tString &in asFile,
                                const cVector3f &in avLocalPos,
                                const cVector2f &in avSize,
                                eGuiMaterial aMaterial,
                                bool abAnimate,
                                iWidget@ apParent,
                                const tString &in asName)


Parameters

Returns:

  • cWidgetImage@

CreateWidgetLabel

cWidgetLabel@ CreateWidgetLabel(const cVector3f &in avLocalPos,
                                const cVector2f &in avSize,
                                const tWString &in asText,
                                iWidget@ apParent,
                                const tString &in asName)


Parameters

Returns:

  • cWidgetLabel@

CreateWidgetListBox

cWidgetListBox@ CreateWidgetListBox(const cVector3f &in avLocalPos,
                                    const cVector2f &in avSize,
                                    iWidget@ apParent,
                                    const tString &in asName)


Parameters

Returns:

  • cWidgetListBox@

CreateWidgetMainMenu

cWidgetMainMenu@ CreateWidgetMainMenu(iWidget@ apParent,
                                      const tString &in asName)


Parameters

Returns:

  • cWidgetMainMenu@

CreateWidgetMenuItem

cWidgetMenuItem@ CreateWidgetMenuItem(const cVector3f &in avLocalPos,
                                      const cVector2f &in avSize,
                                      const tWString &in asText,
                                      iWidget@ apParent,
                                      const tString &in asName)


Parameters

Returns:

  • cWidgetMenuItem@

CreateWidgetMultiPropertyListBox

cWidgetMultiPropertyListBox@ CreateWidgetMultiPropertyListBox(const cVector3f &in avLocalPos,
                                                              const cVector2f &in avSize,
                                                              iWidget@ apParent,
                                                              const tString &in asName)


Parameters

Returns:

  • cWidgetMultiPropertyListBox@

CreateWidgetSlider

cWidgetSlider@ CreateWidgetSlider(eWidgetSliderOrientation aOrientation,
                                  const cVector3f &in avLocalPos,
                                  const cVector2f &in avSize,
                                  int alMaxValue,
                                  iWidget@ apParent,
                                  const tString &in asName)


Parameters

Returns:

  • cWidgetSlider@

CreateWidgetTabFrame

cWidgetTabFrame@ CreateWidgetTabFrame(const cVector3f &in avLocalPos,
                                      const cVector2f &in avSize,
                                      const tWString &in asText,
                                      iWidget@ apParent,
                                      bool abAllowHScroll,
                                      bool abAllowVScroll,
                                      const tString &in asName)


Parameters

Returns:

  • cWidgetTabFrame@

CreateWidgetTextBox

cWidgetTextBox@ CreateWidgetTextBox(const cVector3f &in avLocalPos,
                                    const cVector2f &in avSize,
                                    const tWString &in asText,
                                    iWidget@ apParent,
                                    eWidgetTextBoxInputType aeType,
                                    float afNumericAdd,
                                    bool abShowButtons,
                                    const tString &in asName)


Parameters

Returns:

  • cWidgetTextBox@

CreateWidgetWindow

cWidgetWindow@ CreateWidgetWindow(int alFlags,
                                  const cVector3f &in avLocalPos,
                                  const cVector2f &in avSize,
                                  const tWString &in asText,
                                  iWidget@ apParent,
                                  const tString &in asName)


Parameters

Returns:

  • cWidgetWindow@

DestroyAllWidgets

void DestroyAllWidgets()

Returns:

  • void

DestroyWidget

void DestroyWidget(iWidget@ apWidget,
                   bool abDestroyChildren)


Parameters

  • apWidget (iWidget@) —
  • abDestroyChildren (bool) —

Returns:

  • void

DrawFont

void DrawFont(const tWString &in asText,
              iFontData@ apFont,
              const cVector3f &in avPos,
              const cVector2f &in avSize,
              const cColor &in aColor)


Parameters

Returns:

  • void

DrawFontEx

void DrawFontEx(const tWString &in asText,
                iFontData@ apFont,
                const cVector3f &in avPos,
                const cVector2f &in avSize,
                const cColor &in aColor,
                eFontAlign aAlign,
                eGuiMaterial aMaterial)


Parameters

Returns:

  • void

DrawGfx

void DrawGfx(cGuiGfxElement@ apGfx,
             const cVector3f &in avPos)


Parameters

Returns:

  • void

DrawGfx

void DrawGfx(cGuiGfxElement@ apGfx,
             const cVector3f &in avPos,
             const cVector2f &in avSize,
             const cColor &in aColor)


Parameters

Returns:

  • void

DrawGfx

void DrawGfx(cGuiGfxElement@ apGfx,
             const cVector3f &in avPos,
             const cVector2f &in avSize,
             const cColor &in aColor,
             eGuiMaterial aMaterial,
             float afRotationAngle,
             bool abUseCustomPivot,
             const cVector3f &in avCustomPivot)


Parameters

Returns:

  • void

Get3DSize

const cVector3f& Get3DSize()

Returns:

  • const cVector3f&

Get3DTransform

const cMatrixf& Get3DTransform()

Returns:

  • const cMatrixf&

GetAttentionWidget

iWidget@ GetAttentionWidget()

Returns:

  • iWidget@

GetCullBackface

bool GetCullBackface()

Returns:

  • bool

GetCurrentPointer

cGuiGfxElement@ GetCurrentPointer()

Returns:

  • cGuiGfxElement@

GetDisplayScale

float GetDisplayScale()

Returns:

  • float

GetDrawMouse

bool GetDrawMouse()

Returns:

  • bool

GetDrawPriority

int GetDrawPriority()

Returns:

  • int

GetFocusedWidget

iWidget@ GetFocusedWidget()

Returns:

  • iWidget@

GetMouseMovementEnabled

bool GetMouseMovementEnabled()

Returns:

  • bool

GetMousePos

const cVector2f& GetMousePos()

Returns:

  • const cVector2f&

GetMouseZ

float GetMouseZ()

Returns:

  • float

GetName

const tString& GetName()

Returns:

  • const tString&

GetRootWidgetClips

bool GetRootWidgetClips()

Returns:

  • bool

GetSkin

cGuiSkin@ GetSkin()

Returns:

  • cGuiSkin@

GetVirtualSize

const cVector2f& GetVirtualSize()

Returns:

  • const cVector2f&

GetVirtualSizeOffset

const cVector2f& GetVirtualSizeOffset()

Returns:

  • const cVector2f&

GetWidgetFromName

iWidget@ GetWidgetFromName(const tString &in asName)


Parameters

Returns:

  • iWidget@

HasFocus

bool HasFocus()

Returns:

  • bool

Is3D

bool Is3D()

Returns:

  • bool

IsActive

bool IsActive()

Returns:

  • bool

IsValidWidget

bool IsValidWidget(iWidget@ apWidget)


Parameters

Returns:

  • bool

RemoveWindow

void RemoveWindow(cWidgetWindow@ apWin)


Parameters

Returns:

  • void

ResetMouseOver

void ResetMouseOver()

Returns:

  • void

Set3DSize

void Set3DSize(const cVector3f &in avSize)


Parameters

Returns:

  • void

Set3DTransform

void Set3DTransform(const cMatrixf &in a_mtxTransform)


Parameters

Returns:

  • void

SetActive

void SetActive(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetAttentionWidget

void SetAttentionWidget(iWidget@ apWidget,
                        bool abClearFocus)


Parameters

  • apWidget (iWidget@) —
  • abClearFocus (bool) —

Returns:

  • void

SetCullBackface

void SetCullBackface(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetCurrentPointer

void SetCurrentPointer(cGuiGfxElement@ apGfx)


Parameters

Returns:

  • void

SetDrawMouse

void SetDrawMouse(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetDrawPriority

void SetDrawPriority(int alPrio)


Parameters

  • alPrio (int) —

Returns:

  • void

SetFocusedWidget

void SetFocusedWidget(iWidget@ apWidget,
                      bool abCheckForValidity = false)


Parameters

  • apWidget (iWidget@) —
  • abCheckForValidity (bool) —

Returns:

  • void

SetIs3D

void SetIs3D(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetLastWindowZ

void SetLastWindowZ(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetMouseMovementEnabled

void SetMouseMovementEnabled(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetMouseZ

void SetMouseZ(float afZ)


Parameters

  • afZ (float) —

Returns:

  • void

SetRootWidgetClips

void SetRootWidgetClips(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetSkin

void SetSkin(cGuiSkin@ apSkin)


Parameters

Returns:

  • void

SetVirtualSize

void SetVirtualSize(const cVector2f &in avSize,
                    float afMinZ,
                    float afMaxZ,
                    const cVector2f &in avOffset)


Parameters

Returns:

  • void

SetWindowOnTop

void SetWindowOnTop(cWidgetWindow@ apWin)


Parameters

Returns:

  • void

ShowContextMenu

void ShowContextMenu(cWidgetContextMenu@ apMenu,
                     const cVector3f &in avPosition)


Parameters

Returns:

  • void

References

See all references...