RE::UI Class Reference

#include <UI.h>

Inheritance diagram for RE::UI:

Classes
struct	UIMenuEntry

Public Types
using	Create_t = IMenu *()
Public Types inherited from RE::BSTSingletonSDMBase< Traits >
using	Type = typename Traits::Type
using	Allocator = typename Traits::Allocator
Public Types inherited from RE::BSTEventSource< MenuOpenCloseEvent >
using	Sink = BSTEventSink< MenuOpenCloseEvent >
Public Types inherited from RE::BSTEventSource< MenuModeChangeEvent >
using	Sink = BSTEventSink< MenuModeChangeEvent >
Public Types inherited from RE::BSTEventSource< void * >
using	Sink = BSTEventSink< void * >

Public Member Functions
template<class T >
void	AddEventSink (BSTEventSink< T > *a_sink)
bool	GameIsPaused ()
template<class T >
BSTEventSource< T > *	GetEventSource ()
GPtr< IMenu >	GetMenu (const std::string_view &a_menuName)
GPtr< GFxMovieView >	GetMovieView (const std::string_view &a_menuName)
bool	IsApplicationMenuOpen () const
bool	IsCursorHiddenWhenTopmost () const
bool	IsItemMenuOpen () const
bool	IsMenuOpen (const std::string_view &a_menuName)
bool	IsModalMenuOpen () const
bool	IsPauseMenuDisabled () const
bool	IsSavingAllowed () const
bool	IsShowingMenus () const
bool	IsUsingCustomRendering () const
void	Register (const std::string_view &a_menuName, Create_t *a_creator)
template<class T >
void	RemoveEventSink (BSTEventSink< T > *a_sink)
void	ShowMenus (bool a_show)
template<class T , std::enable_if_t< std::conjunction_v< UIImpl::is_menu_ptr< T * >, UIImpl::has_menu_name< T > >, int > = 0>
GPtr< T >	GetMenu ()
template<class T , std::enable_if_t< UIImpl::is_menu_ptr_v< T * >, int > = 0>
GPtr< T >	GetMenu (const std::string_view &a_menuName)
Public Member Functions inherited from RE::BSTEventSource< MenuOpenCloseEvent >
	BSTEventSource ()
void	AddEventSink (Sink *a_eventSink)
void	AddEventSink (BSTEventSink< SinkEvent > *a_sink)
void	PrependEventSink (Sink *a_eventSink)
void	PrependEventSink (BSTEventSink< SinkEvent > *a_sink)
void	RemoveEventSink (Sink *a_eventSink)
void	SendEvent (const MenuOpenCloseEvent *a_event)
void	operator() (const MenuOpenCloseEvent *a_event)
Public Member Functions inherited from RE::BSTEventSource< MenuModeChangeEvent >
	BSTEventSource ()
void	AddEventSink (Sink *a_eventSink)
void	AddEventSink (BSTEventSink< SinkEvent > *a_sink)
void	PrependEventSink (Sink *a_eventSink)
void	PrependEventSink (BSTEventSink< SinkEvent > *a_sink)
void	RemoveEventSink (Sink *a_eventSink)
void	SendEvent (const MenuModeChangeEvent *a_event)
void	operator() (const MenuModeChangeEvent *a_event)
Public Member Functions inherited from RE::BSTEventSource< void * >
	BSTEventSource ()
void	AddEventSink (Sink *a_eventSink)
void	AddEventSink (BSTEventSink< SinkEvent > *a_sink)
void	PrependEventSink (Sink *a_eventSink)
void	PrependEventSink (BSTEventSink< SinkEvent > *a_sink)
void	RemoveEventSink (Sink *a_eventSink)
void	SendEvent (const void * *a_event)
void	operator() (const void * *a_event)

Static Public Member Functions
static UI *	GetSingleton ()

Public Attributes
BSTArray< GPtr< IMenu > >	menuStack
BSTHashMap< BSFixedString, UIMenuEntry >	menuMap
BSSpinLock	processMessagesLock
std::uint32_t	numPausesGame
std::uint32_t	numItemMenus
std::uint32_t	numDisablePauseMenu
std::uint32_t	numAllowSaving
std::uint32_t	numDontHideCursorWhenTopmost
std::uint32_t	numCustomRendering
std::uint32_t	numApplicationMenus
bool	modal
std::uint8_t	pad17D
std::uint16_t	pad17E
BSTimer	uiTimer
bool	menuSystemVisible
bool	closingAllMenus
std::uint16_t	pad1C2
std::uint32_t	pad1C4
Public Attributes inherited from RE::BSTEventSource< MenuOpenCloseEvent >
BSTArray< Sink * >	sinks
BSTArray< Sink * >	pendingRegisters
BSTArray< Sink * >	pendingUnregisters
BSSpinLock	lock
bool	notifying
std::uint8_t	pad51
std::uint16_t	pad52
std::uint32_t	pad54
Public Attributes inherited from RE::BSTEventSource< MenuModeChangeEvent >
BSTArray< Sink * >	sinks
BSTArray< Sink * >	pendingRegisters
BSTArray< Sink * >	pendingUnregisters
BSSpinLock	lock
bool	notifying
std::uint8_t	pad51
std::uint16_t	pad52
std::uint32_t	pad54
Public Attributes inherited from RE::BSTEventSource< void * >
BSTArray< Sink * >	sinks
BSTArray< Sink * >	pendingRegisters
BSTArray< Sink * >	pendingUnregisters
BSSpinLock	lock
bool	notifying
std::uint8_t	pad51
std::uint16_t	pad52
std::uint32_t	pad54

Member Typedef Documentation

Create_t

using RE::UI::Create_t = IMenu*()

Member Function Documentation

AddEventSink()

template<class T >

void RE::UI::AddEventSink

(

BSTEventSink< T > *

a_sink

)

GameIsPaused()

bool RE::UI::GameIsPaused

(

)

GetEventSource()

template<class T >

BSTEventSource< T > * RE::UI::GetEventSource

(

)

GetMenu() [1/3]

template<class T , std::enable_if_t< std::conjunction_v< UIImpl::is_menu_ptr< T * >, UIImpl::has_menu_name< T > >, int > = 0>

GPtr< T > RE::UI::GetMenu ( )

inline

GetMenu() [2/3]

GPtr< IMenu > RE::UI::GetMenu

(

const std::string_view &

a_menuName

)

GetMenu() [3/3]

template<class T , std::enable_if_t< UIImpl::is_menu_ptr_v< T * >, int > = 0>

GPtr< T > RE::UI::GetMenu ( const std::string_view &  a_menuName )

inline

GetMovieView()

GPtr< GFxMovieView > RE::UI::GetMovieView

(

const std::string_view &

a_menuName

)

GetSingleton()

static UI * RE::UI::GetSingleton ( )

static

IsApplicationMenuOpen()

bool RE::UI::IsApplicationMenuOpen

(

)

const

IsCursorHiddenWhenTopmost()

bool RE::UI::IsCursorHiddenWhenTopmost

(

)

const

IsItemMenuOpen()

bool RE::UI::IsItemMenuOpen

(

)

const

IsMenuOpen()

bool RE::UI::IsMenuOpen

(

const std::string_view &

a_menuName

)

IsModalMenuOpen()

bool RE::UI::IsModalMenuOpen

(

)

const

IsPauseMenuDisabled()

bool RE::UI::IsPauseMenuDisabled

(

)

const

IsSavingAllowed()

bool RE::UI::IsSavingAllowed

(

)

const

IsShowingMenus()

bool RE::UI::IsShowingMenus

(

)

const

IsUsingCustomRendering()

bool RE::UI::IsUsingCustomRendering

(

)

const

Register()

void RE::UI::Register	(	const std::string_view &	a_menuName,
		Create_t *	a_creator
	)

RemoveEventSink()

template<class T >

void RE::UI::RemoveEventSink ( BSTEventSink< T > *  a_sink )

inline

ShowMenus()

void RE::UI::ShowMenus

(

bool

a_show

)

Member Data Documentation

closingAllMenus

bool RE::UI::closingAllMenus

menuMap

BSTHashMap<BSFixedString, UIMenuEntry> RE::UI::menuMap

menuStack

BSTArray<GPtr<IMenu> > RE::UI::menuStack

menuSystemVisible

bool RE::UI::menuSystemVisible

modal

bool RE::UI::modal

numAllowSaving

std::uint32_t RE::UI::numAllowSaving

numApplicationMenus

std::uint32_t RE::UI::numApplicationMenus

numCustomRendering

std::uint32_t RE::UI::numCustomRendering

numDisablePauseMenu

std::uint32_t RE::UI::numDisablePauseMenu

numDontHideCursorWhenTopmost

std::uint32_t RE::UI::numDontHideCursorWhenTopmost

numItemMenus

std::uint32_t RE::UI::numItemMenus

numPausesGame

std::uint32_t RE::UI::numPausesGame

pad17D

std::uint8_t RE::UI::pad17D

pad17E

std::uint16_t RE::UI::pad17E

pad1C2

std::uint16_t RE::UI::pad1C2

pad1C4

std::uint32_t RE::UI::pad1C4

processMessagesLock

BSSpinLock RE::UI::processMessagesLock

mutable

uiTimer

BSTimer RE::UI::uiTimer

---

The documentation for this class was generated from the following file:

• CommonLibSSE/include/RE/U/UI.h