CommonLibSSE NG
RE::BookMenu Class Reference

#include <BookMenu.h>

Inheritance diagram for RE::BookMenu:
RE::IMenu RE::SimpleAnimationGraphManagerHolder RE::BSTEventSink< BSAnimationGraphEvent > RE::FxDelegateHandler RE::IAnimationGraphManagerHolder RE::GRefCountBase< FxDelegateHandler, GStatGroups::kGStat_Default_Mem > RE::GRefCountBaseStatImpl< GRefCountImpl, STAT > RE::GRefCountImpl RE::GRefCountImplCore

Classes

struct  RUNTIME_DATA
 

Public Member Functions

 ~BookMenu () override
 
UI_MESSAGE_RESULTS ProcessMessage (UIMessage &a_message) override
 
void AdvanceMovie (float a_interval, std::uint32_t a_currentTime) override
 
void PostDisplay () override
 
void PreDisplay () override
 
BSEventNotifyControl ProcessEvent (const BSAnimationGraphEvent *a_event, BSTEventSource< BSAnimationGraphEvent > *a_eventSource) override
 
SimpleAnimationGraphManagerHolderAsSimpleAnimationGraphManagerHolder () noexcept
 
const SimpleAnimationGraphManagerHolderAsSimpleAnimationGraphManagerHolder () const noexcept
 
BSTEventSink< BSAnimationGraphEvent > * AsBSAnimationGraphEventSink () noexcept
 
const BSTEventSink< BSAnimationGraphEvent > * AsBSAnimationGraphEventSink () const noexcept
 
RUNTIME_DATAGetRuntimeData () noexcept
 
const RUNTIME_DATAGetRuntimeData () const noexcept
 
- Public Member Functions inherited from RE::IMenu
 ~IMenu () override=default
 
void Accept (CallbackProcessor *a_processor) override
 
virtual void PostCreate ()
 
virtual void Unk_03 (void)
 
virtual void RefreshPlatform ()
 
constexpr bool AdvancesUnderPauseMenu () const noexcept
 
constexpr bool AllowSaving () const noexcept
 
constexpr bool AlwaysOpen () const noexcept
 
constexpr bool ApplicationMenu () const noexcept
 
constexpr bool AssignCursorToRenderer () const noexcept
 
constexpr bool CustomRendering () const noexcept
 
constexpr bool CompanionAppAllowed () const noexcept
 
constexpr bool DisablePauseMenu () const noexcept
 
constexpr bool DontHideCursorWhenTopmost () const noexcept
 
constexpr bool FreezeFrameBackground () const noexcept
 
constexpr bool FreezeFramePause () const noexcept
 
constexpr bool HasButtonBar () const noexcept
 
constexpr bool InventoryItemMenu () const noexcept
 
constexpr bool IsTopButtonBar () const noexcept
 
constexpr bool LargeScaleformRenderCacheMode () const noexcept
 
constexpr bool Modal () const noexcept
 
constexpr bool OnStack () const noexcept
 
constexpr bool PausesGame () const noexcept
 
constexpr bool RendersOffscreenTargets () const noexcept
 
constexpr bool RendersUnderPauseMenu () const noexcept
 
constexpr bool RequiresUpdate () const noexcept
 
constexpr bool SkipRenderDuringFreezeFrameScreenshot () const noexcept
 
constexpr bool TopmostRenderedMenu () const noexcept
 
constexpr bool UpdateUsesCursor () const noexcept
 
constexpr bool UsesBlurredBackground () const noexcept
 
constexpr bool UsesCursor () const noexcept
 
constexpr bool UsesMenuContext () const noexcept
 
constexpr bool UsesMovementToDirection () const noexcept
 
- Public Member Functions inherited from RE::FxDelegateHandler
 ~FxDelegateHandler () override=default
 
- Public Member Functions inherited from RE::GRefCountBaseStatImpl< GRefCountImpl, STAT >
 GFC_MEMORY_REDEFINE_NEW_IMPL (GRefCountImpl, GFC_REFCOUNTALLOC_CHECK_DELETE, StatType)
 
- Public Member Functions inherited from RE::GRefCountImpl
 ~GRefCountImpl () override=default
 
void AddRef ()
 
void Release ()
 
- Public Member Functions inherited from RE::SimpleAnimationGraphManagerHolder
bool GetAnimationGraphManagerImpl (BSTSmartPointer< BSAnimationGraphManager > &a_out) const override
 
bool SetAnimationGraphManagerImpl (BSTSmartPointer< BSAnimationGraphManager > &a_in) override
 
bool ConstructAnimationGraph (BSTSmartPointer< BShkbAnimationGraph > &a_out) override
 
virtual void Unk_13 (void)
 
- Public Member Functions inherited from RE::IAnimationGraphManagerHolder
virtual ~IAnimationGraphManagerHolder ()
 
virtual bool NotifyAnimationGraph (const BSFixedString &a_eventName)
 
virtual bool PopulateGraphNodesToTarget (BSScrapArray< NiAVObject * > &a_nodes)
 
virtual void Unk_06 (void)
 
virtual void Unk_07 (void)
 
virtual bool SetupAnimEventSinks (const BSTSmartPointer< BShkbAnimationGraph > &a_animGraph)
 
virtual void Unk_09 (void)
 
virtual bool CreateAnimationChannels (BSScrapArray< BSTSmartPointer< BSAnimationGraphChannel >> &animGraphChannels)
 
virtual void PostCreateAnimationGraphManager (BSTSmartPointer< BSAnimationGraphManager > &a_animGraphMgr)
 
virtual void Unk_0C (void)
 
virtual void PostChangeAnimationManager (const BSTSmartPointer< BShkbAnimationGraph > &a_arg1, const BSTSmartPointer< BShkbAnimationGraph > &a_arg2)
 
virtual void Unk_0E (void)
 
virtual std::uint32_t GetGraphVariableCacheSize () const
 
virtual bool GetGraphVariableImpl1 (const BSFixedString &a_variableName, float &a_out) const
 
virtual bool GetGraphVariableImpl2 (const BSFixedString &a_variableName, std::int32_t &a_out) const
 
virtual bool GetGraphVariableImpl3 (const BSFixedString &a_variableName, bool &a_out) const
 
bool GetAnimationGraphManager (BSTSmartPointer< BSAnimationGraphManager > &a_out) const
 
bool GetGraphVariableFloat (const BSFixedString &a_variableName, float &a_out) const
 
bool GetGraphVariableInt (const BSFixedString &a_variableName, std::int32_t &a_out) const
 
bool GetGraphVariableBool (const BSFixedString &a_variableName, bool &a_out) const
 
bool GetGraphVariableNiPoint3 (const BSFixedString &a_variableName, NiPoint3 &a_out) const
 
bool SetAnimationGraphManager (BSTSmartPointer< BSAnimationGraphManager > &a_in)
 
bool SetGraphVariableBool (const BSFixedString &a_variableName, bool a_in)
 
bool SetGraphVariableInt (const BSFixedString &a_variableName, std::int32_t a_in)
 
bool SetGraphVariableFloat (const BSFixedString &a_variableName, float a_in)
 
bool SetGraphVariableNiPoint3 (const BSFixedString &a_variableName, NiPoint3 &a_in) const
 
bool UpdateAnimationGraphManager (const BSAnimationUpdateData &a_updateData)
 
- Public Member Functions inherited from RE::BSTEventSink< BSAnimationGraphEvent >
virtual ~BSTEventSink ()=default
 

Static Public Member Functions

static TESObjectBOOKGetTargetForm ()
 
static TESObjectREFRGetTargetReference ()
 
static void OpenBookMenu (const BSString &a_description, const ExtraDataList *a_extraList, TESObjectREFR *a_ref, TESObjectBOOK *a_book, const NiPoint3 &a_pos, const NiMatrix3 &a_rot, float a_scale, bool a_useDefaultPos)
 

Static Public Attributes

static constexpr auto RTTI = RTTI_BookMenu
 
static constexpr auto VTABLE = VTABLE_BookMenu
 
constexpr static std::string_view MENU_NAME = "Book Menu"
 
- Static Public Attributes inherited from RE::IMenu
static constexpr auto RTTI = RTTI_IMenu
 
- Static Public Attributes inherited from RE::FxDelegateHandler
static constexpr auto RTTI = RTTI_FxDelegateHandler
 
- Static Public Attributes inherited from RE::GRefCountImpl
static constexpr auto RTTI = RTTI_GRefCountImpl
 
- Static Public Attributes inherited from RE::SimpleAnimationGraphManagerHolder
static constexpr auto RTTI = RTTI_SimpleAnimationGraphManagerHolder
 
- Static Public Attributes inherited from RE::IAnimationGraphManagerHolder
static constexpr auto RTTI = RTTI_IAnimationGraphManagerHolder
 

Additional Inherited Members

- Public Types inherited from RE::IMenu
using Context = UserEvents::INPUT_CONTEXT_ID
 
using Flag = UI_MENU_FLAGS
 
- Public Types inherited from RE::FxDelegateHandler
using CallbackFn = void(const FxDelegateArgs &a_params)
 
- Public Types inherited from RE::GRefCountBase< FxDelegateHandler, GStatGroups::kGStat_Default_Mem >
enum  
 
- Public Attributes inherited from RE::IMenu
GPtr< GFxMovieViewuiMovie { nullptr }
 
std::int8_t depthPriority { 3 }
 
std::uint8_t pad19 { 0 }
 
std::uint16_t pad20 { 0 }
 
stl::enumeration< UI_MENU_FLAGS, std::uint32_t > menuFlags { Flag::kNone }
 
stl::enumeration< Context, std::uint32_t > inputContext { Context::kNone }
 
std::uint32_t pad24 { 0 }
 
GPtr< FxDelegatefxDelegate { nullptr }
 
std::int32_t unk30 { -1 }
 
std::int32_t unk34 { 1 }
 
std::uint64_t unk38 { 0 }
 
- Public Attributes inherited from RE::SimpleAnimationGraphManagerHolder
BSTSmartPointer< BSAnimationGraphManageranimationGraphManager
 
NiPointer< SimpleAnimationGraphManagerLoadingTask > loadingTask
 

Constructor & Destructor Documentation

◆ ~BookMenu()

RE::BookMenu::~BookMenu ( )
override

Member Function Documentation

◆ AdvanceMovie()

void RE::BookMenu::AdvanceMovie ( float  a_interval,
std::uint32_t  a_currentTime 
)
overridevirtual

Reimplemented from RE::IMenu.

◆ AsBSAnimationGraphEventSink() [1/2]

const BSTEventSink<BSAnimationGraphEvent>* RE::BookMenu::AsBSAnimationGraphEventSink ( ) const
inlinenoexcept

◆ AsBSAnimationGraphEventSink() [2/2]

BSTEventSink<BSAnimationGraphEvent>* RE::BookMenu::AsBSAnimationGraphEventSink ( )
inlinenoexcept

◆ AsSimpleAnimationGraphManagerHolder() [1/2]

const SimpleAnimationGraphManagerHolder* RE::BookMenu::AsSimpleAnimationGraphManagerHolder ( ) const
inlinenoexcept

◆ AsSimpleAnimationGraphManagerHolder() [2/2]

SimpleAnimationGraphManagerHolder* RE::BookMenu::AsSimpleAnimationGraphManagerHolder ( )
inlinenoexcept

◆ GetRuntimeData() [1/2]

const RUNTIME_DATA& RE::BookMenu::GetRuntimeData ( ) const
inlinenoexcept

◆ GetRuntimeData() [2/2]

RUNTIME_DATA& RE::BookMenu::GetRuntimeData ( )
inlinenoexcept

◆ GetTargetForm()

static TESObjectBOOK* RE::BookMenu::GetTargetForm ( )
static

◆ GetTargetReference()

static TESObjectREFR* RE::BookMenu::GetTargetReference ( )
static

◆ OpenBookMenu()

static void RE::BookMenu::OpenBookMenu ( const BSString a_description,
const ExtraDataList a_extraList,
TESObjectREFR a_ref,
TESObjectBOOK a_book,
const NiPoint3 a_pos,
const NiMatrix3 a_rot,
float  a_scale,
bool  a_useDefaultPos 
)
static

◆ PostDisplay()

void RE::BookMenu::PostDisplay ( )
overridevirtual

Reimplemented from RE::IMenu.

◆ PreDisplay()

void RE::BookMenu::PreDisplay ( )
overridevirtual

Reimplemented from RE::IMenu.

◆ ProcessEvent()

BSEventNotifyControl RE::BookMenu::ProcessEvent ( const BSAnimationGraphEvent a_event,
BSTEventSource< BSAnimationGraphEvent > *  a_eventSource 
)
overridevirtual

◆ ProcessMessage()

UI_MESSAGE_RESULTS RE::BookMenu::ProcessMessage ( UIMessage a_message)
overridevirtual

Reimplemented from RE::IMenu.

Member Data Documentation

◆ MENU_NAME

constexpr static std::string_view RE::BookMenu::MENU_NAME = "Book Menu"
staticconstexpr

◆ RTTI

constexpr auto RE::BookMenu::RTTI = RTTI_BookMenu
inlinestaticconstexpr

◆ VTABLE

constexpr auto RE::BookMenu::VTABLE = VTABLE_BookMenu
inlinestaticconstexpr

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