HPL3/Amnesia: Rebirth/Scripting/cWidgetMainMenu

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

Fields

cWidgetMainMenu has no public fields.

Functions

Return Type	Function And Description
cWidgetMenuItem	AddMenuItem(const tWString &in asText)
void	AddSeparator()
cGuiGlobalShortcut	AddShortcut(int alKeyModifiers, eKey aKey, eGuiMessage aMsg = eGuiMessage_ButtonPressed, const cGuiMessageData &in aData = cGuiMessageData, bool abBypassVisibility = true, bool abBypassEnabled = true)
void	AttachChild(iWidget@ apChild)
void	CenterGlobalPositionInSet()
void	ClearMenuItems()
bool	ClipsGraphics()
cVector3f	GetArrowOffset()
bool	GetCallbacksDisabled()
cVector3f	GetCheckOffset()
cVector3f	GetChildrenOffset()
bool	GetClipActive()
cColor	GetColorMul()
cColor	GetDefaultFontColor()
cVector2f	GetDefaultFontSize()
iFontData	GetDefaultFontType()
iWidget	GetFocusNavigation(eUIArrow aDir)
cVector3f	GetGlobalPosition()
cWidgetMenuItem	GetHighlightedItem()
cVector3f	GetLocalPosition()
float	GetMenuItemWidth()
bool	GetMouseIsOver()
tString	GetName()
iWidget	GetParent()
cWidgetMenuItem	GetParentItem()
iWidgetMenu	GetParentMenu()
cGuiGfxElement	GetPointerGfx()
cVector3f	GetScrollAmount()
cGuiSet	GetSet()
cVector2f	GetSize()
tWString	GetText()
cVector3f	GetTextOffset()
tWString	GetToolTip()
iWidget	GetToolTipWidget()
iWidgetMenu	GetTopMostMenu()
eWidgetType	GetType()
int	GetUserValue()
bool	HasFocus()
bool	HasFocusNavigation()
void	Hide()
void	Init()
bool	IsConnectedTo(iWidget@ apWidget, bool abIsStartWidget = true)
bool	IsConnectedToChildren()
bool	IsEnabled()
bool	IsGlobalKeyPressListener()
bool	IsGlobalUIInputListener()
bool	IsRightUnderMouse()
bool	IsSubmenuOpen()
bool	IsVisible()
bool	PointIsInside(const cVector2f &in avPoint, bool abOnlyClipped)
bool	ProcessMessage(eGuiMessage aMessage, const cGuiMessageData &in aData, bool abSkipVisCheck = false, bool abSkipEnabledCheck = false)
void	RemoveChild(iWidget@ apChild)
void	SetAffectedByScroll(bool abX)
void	SetArrowPos(const cVector3f &in avPos)
void	SetCallbacksDisabled(bool abX)
void	SetCheckPos(const cVector3f &in avPos)
void	SetChildrenOffset(const cVector3f &in )
void	SetClipActive(bool abX)
void	SetColorMul(const cColor &in aColor)
void	SetConnectedToChildren(bool abX)
void	SetDefaultFontColor(const cColor &in aColor)
void	SetDefaultFontSize(const cVector2f &in avSize)
void	SetDefaultFontType(iFontData@ apFont)
void	SetEnabled(bool abX)
void	SetFocusNavigation(eUIArrow aDir, iWidget@ apWidget)
void	SetGlobalKeyPressListener(bool abX)
void	SetGlobalPosition(const cVector3f &in avPos)
void	SetGlobalUIInputListener(bool abX)
void	SetHighlightedItem(cWidgetMenuItem@ apItem)
void	SetMustHide(bool abX)
void	SetName(const tString &in asName)
void	SetParentItem(cWidgetMenuItem@ apParentItem)
void	SetPosition(const cVector3f &in avPos)
void	SetPrevAttention(iWidget@ apWidget)
void	SetScrollAmount(const cVector3f &in avX)
void	SetSize(const cVector2f &in avSize)
void	SetText(const tWString &in asText)
void	SetTextPos(const cVector3f &in avPos)
void	SetToolTip(const tWString &in asToolTip)
void	SetToolTipEnabled(bool abX)
void	SetUserValue(int alX)
void	SetVisible(bool abX)
void	Update(float afTimeStep)

Details

AddMenuItem

cWidgetMenuItem@ AddMenuItem(const tWString &in asText)

Parameters

• asText (tWString) —

Returns:

• cWidgetMenuItem@—

AddSeparator

void AddSeparator()

Returns:

• void

AddShortcut

cGuiGlobalShortcut@ AddShortcut(int alKeyModifiers,
                                eKey aKey,
                                eGuiMessage aMsg = eGuiMessage_ButtonPressed,
                                const cGuiMessageData &in aData = cGuiMessageData,
                                bool abBypassVisibility = true,
                                bool abBypassEnabled = true)

Parameters

• alKeyModifiers (int) —
• aKey (eKey) —
• aMsg (eGuiMessage) —
• aData (cGuiMessageData) —
• abBypassVisibility (bool) —
• abBypassEnabled (bool) —

Returns:

• cGuiGlobalShortcut@—

AttachChild

void AttachChild(iWidget@ apChild)

Parameters

• apChild (iWidget@) —

Returns:

• void

CenterGlobalPositionInSet

void CenterGlobalPositionInSet()

Returns:

• void

ClearMenuItems

void ClearMenuItems()

Returns:

• void

ClipsGraphics

bool ClipsGraphics()

Returns:

• bool—

GetArrowOffset

const cVector3f& GetArrowOffset()

Returns:

• const cVector3f&—

GetCallbacksDisabled

bool GetCallbacksDisabled()

Returns:

• bool—

GetCheckOffset

const cVector3f& GetCheckOffset()

Returns:

• const cVector3f&—

GetChildrenOffset

const cVector3f& GetChildrenOffset()

Returns:

• const cVector3f&—

GetClipActive

bool GetClipActive()

Returns:

• bool—

GetColorMul

const cColor& GetColorMul()

Returns:

• const cColor&—

GetDefaultFontColor

const cColor& GetDefaultFontColor()

Returns:

• const cColor&—

GetDefaultFontSize

const cVector2f& GetDefaultFontSize()

Returns:

• const cVector2f&—

GetDefaultFontType

iFontData@ GetDefaultFontType()

Returns:

• iFontData@—

GetFocusNavigation

iWidget@ GetFocusNavigation(eUIArrow aDir)

Parameters

• aDir (eUIArrow) —

Returns:

• iWidget@—

GetGlobalPosition

const cVector3f& GetGlobalPosition()

Returns:

• const cVector3f&—

GetHighlightedItem

cWidgetMenuItem@ GetHighlightedItem()

Returns:

• cWidgetMenuItem@—

GetLocalPosition

const cVector3f& GetLocalPosition()

Returns:

• const cVector3f&—

GetMenuItemWidth

float GetMenuItemWidth()

Returns:

• float—

GetMouseIsOver

bool GetMouseIsOver()

Returns:

• bool—

GetName

const tString& GetName()

Returns:

• const tString&—

GetParent

iWidget@ GetParent()

Returns:

• iWidget@—

GetParentItem

cWidgetMenuItem@ GetParentItem()

Returns:

• cWidgetMenuItem@—

GetParentMenu

iWidgetMenu@ GetParentMenu()

Returns:

• iWidgetMenu@—

GetPointerGfx

cGuiGfxElement@ GetPointerGfx()

Returns:

• cGuiGfxElement@—

GetScrollAmount

const cVector3f& GetScrollAmount()

Returns:

• const cVector3f&—

GetSet

cGuiSet@ GetSet()

Returns:

• cGuiSet@—

GetSize

const cVector2f& GetSize()

Returns:

• const cVector2f&—

GetText

const tWString& GetText()

Returns:

• const tWString&—

GetTextOffset

const cVector3f& GetTextOffset()

Returns:

• const cVector3f&—

GetToolTip

const tWString& GetToolTip()

Returns:

• const tWString&—

GetToolTipWidget

iWidget@ GetToolTipWidget()

Returns:

• iWidget@—

GetTopMostMenu

iWidgetMenu@ GetTopMostMenu()

Returns:

• iWidgetMenu@—

GetType

eWidgetType GetType()

Returns:

• eWidgetType—

GetUserValue

int GetUserValue()

Returns:

• int—

HasFocus

bool HasFocus()

Returns:

• bool—

HasFocusNavigation

bool HasFocusNavigation()

Returns:

• bool—

Hide

void Hide()

Returns:

• void

Init

void Init()

Returns:

• void

IsConnectedTo

bool IsConnectedTo(iWidget@ apWidget,
                   bool abIsStartWidget = true)

Parameters

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

Returns:

• bool—

IsConnectedToChildren

bool IsConnectedToChildren()

Returns:

• bool—

IsEnabled

bool IsEnabled()

Returns:

• bool—

IsGlobalKeyPressListener

bool IsGlobalKeyPressListener()

Returns:

• bool—

IsGlobalUIInputListener

bool IsGlobalUIInputListener()

Returns:

• bool—

IsRightUnderMouse

bool IsRightUnderMouse()

Returns:

• bool—

IsSubmenuOpen

bool IsSubmenuOpen()

Returns:

• bool—

IsVisible

bool IsVisible()

Returns:

• bool—

PointIsInside

bool PointIsInside(const cVector2f &in avPoint,
                   bool abOnlyClipped)

Parameters

• avPoint (cVector2f) —
• abOnlyClipped (bool) —

Returns:

• bool—

ProcessMessage

bool ProcessMessage(eGuiMessage aMessage,
                    const cGuiMessageData &in aData,
                    bool abSkipVisCheck = false,
                    bool abSkipEnabledCheck = false)

Parameters

• aMessage (eGuiMessage) —
• aData (cGuiMessageData) —
• abSkipVisCheck (bool) —
• abSkipEnabledCheck (bool) —

Returns:

• bool—

RemoveChild

void RemoveChild(iWidget@ apChild)

Parameters

• apChild (iWidget@) —

Returns:

• void

SetAffectedByScroll

void SetAffectedByScroll(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetArrowPos

void SetArrowPos(const cVector3f &in avPos)

Parameters

• avPos (cVector3f) —

Returns:

• void

SetCallbacksDisabled

void SetCallbacksDisabled(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetCheckPos

void SetCheckPos(const cVector3f &in avPos)

Parameters

• avPos (cVector3f) —

Returns:

• void

SetChildrenOffset

void SetChildrenOffset(const cVector3f &in )

Parameters

• ' (cVector3f) —

Returns:

• void

SetClipActive

void SetClipActive(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetColorMul

void SetColorMul(const cColor &in aColor)

Parameters

• aColor (cColor) —

Returns:

• void

SetConnectedToChildren

void SetConnectedToChildren(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetDefaultFontColor

void SetDefaultFontColor(const cColor &in aColor)

Parameters

• aColor (cColor) —

Returns:

• void

SetDefaultFontSize

void SetDefaultFontSize(const cVector2f &in avSize)

Parameters

• avSize (cVector2f) —

Returns:

• void

SetDefaultFontType

void SetDefaultFontType(iFontData@ apFont)

Parameters

• apFont (iFontData@) —

Returns:

• void

SetEnabled

void SetEnabled(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetFocusNavigation

void SetFocusNavigation(eUIArrow aDir,
                        iWidget@ apWidget)

Parameters

• aDir (eUIArrow) —
• apWidget (iWidget@) —

Returns:

• void

SetGlobalKeyPressListener

void SetGlobalKeyPressListener(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetGlobalPosition

void SetGlobalPosition(const cVector3f &in avPos)

Parameters

• avPos (cVector3f) —

Returns:

• void

SetGlobalUIInputListener

void SetGlobalUIInputListener(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetHighlightedItem

void SetHighlightedItem(cWidgetMenuItem@ apItem)

Parameters

• apItem (cWidgetMenuItem@) —

Returns:

• void

SetMustHide

void SetMustHide(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetName

void SetName(const tString &in asName)

Parameters

• asName (tString) —

Returns:

• void

SetParentItem

void SetParentItem(cWidgetMenuItem@ apParentItem)

Parameters

• apParentItem (cWidgetMenuItem@) —

Returns:

• void

SetPosition

void SetPosition(const cVector3f &in avPos)

Parameters

• avPos (cVector3f) —

Returns:

• void

SetPrevAttention

void SetPrevAttention(iWidget@ apWidget)

Parameters

• apWidget (iWidget@) —

Returns:

• void

SetScrollAmount

void SetScrollAmount(const cVector3f &in avX)

Parameters

• avX (cVector3f) —

Returns:

• void

SetSize

void SetSize(const cVector2f &in avSize)

Parameters

• avSize (cVector2f) —

Returns:

• void

SetText

void SetText(const tWString &in asText)

Parameters

• asText (tWString) —

Returns:

• void

SetTextPos

void SetTextPos(const cVector3f &in avPos)

Parameters

• avPos (cVector3f) —

Returns:

• void

SetToolTip

void SetToolTip(const tWString &in asToolTip)

Parameters

• asToolTip (tWString) —

Returns:

• void

SetToolTipEnabled

void SetToolTipEnabled(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetUserValue

void SetUserValue(int alX)

Parameters

• alX (int) —

Returns:

• void

SetVisible

void SetVisible(bool abX)

Parameters

• abX (bool) —

Returns:

• void

Update

void Update(float afTimeStep)

Parameters

• afTimeStep (float) —

Returns:

• void

References

• HPL3/Amnesia: Rebirth/Scripting/cGuiSet ‎ (← links)

See all references...