Struct IMenu

#[repr(C)]
pub struct IMenu {
    pub vtable: *const IMenuVtbl,
    pub refCount: AtomicU32,
    pub uiMovie: GPtr<GFxMovieView>,
    pub depthPriority: i8,
    pub menuFlags: UI_MENU_FLAGS,
    pub inputContext: INPUT_CONTEXT_ID,
    pub fxDelegate: GPtr<FxDelegate>,
    /* private fields */
}

Fields

vtable: *const IMenuVtbl

refCount: AtomicU32

uiMovie: GPtr<GFxMovieView>

depthPriority: i8

menuFlags: UI_MENU_FLAGS

inputContext: INPUT_CONTEXT_ID

fxDelegate: GPtr<FxDelegate>

Implementations

impl IMenu

pub const RTTI: VariantID = RTTI_IMenu

Address & Offset of the runtime type information (RTTI) identifier.

pub const VTABLE: [VariantID; 1] = VTABLE_IMenu

Address & Offset of the virtual function table.

pub const fn advances_under_pause_menu(&self) -> bool

Returns true if the menu advances while the pause menu is active.

pub const fn allow_saving(&self) -> bool

Returns true if the menu allows saving the game.

pub const fn always_open(&self) -> bool

Returns true if the menu is always open.

pub const fn application_menu(&self) -> bool

Returns true if this is an application-level menu.

pub const fn assign_cursor_to_renderer(&self) -> bool

Returns true if the cursor is assigned to the renderer.

pub const fn custom_rendering(&self) -> bool

Returns true if the menu uses custom rendering.

pub const fn companion_app_allowed(&self) -> bool

Returns true if the companion app is allowed to access this menu.

pub const fn disable_pause_menu(&self) -> bool

Returns true if the pause menu should be disabled.

pub const fn dont_hide_cursor_when_topmost(&self) -> bool

Returns true if the cursor should remain visible when this menu is topmost.

pub const fn freeze_frame_background(&self) -> bool

Returns true if the background is frozen while the menu is active.

pub const fn freeze_frame_pause(&self) -> bool

Returns true if the menu causes a freeze frame pause.

pub const fn has_button_bar(&self) -> bool

Returns true if the menu includes a button bar.

pub const fn inventory_item_menu(&self) -> bool

Returns true if this is an inventory item menu.

pub const fn is_top_button_bar(&self) -> bool

Returns true if this menu is the top button bar.

pub const fn large_scaleform_render_cache_mode(&self) -> bool

Returns true if large-scaleform render cache mode is enabled.

pub const fn modal(&self) -> bool

Returns true if the menu is modal and blocks interaction with other menus.

pub const fn on_stack(&self) -> bool

Returns true if the menu is currently on the menu stack.

pub const fn pauses_game(&self) -> bool

Returns true if the menu causes the game to pause.

pub const fn renders_offscreen_targets(&self) -> bool

Returns true if the menu renders offscreen targets.

pub const fn renders_under_pause_menu(&self) -> bool

Returns true if the menu renders underneath the pause menu.

pub const fn requires_update(&self) -> bool

Returns true if the menu requires updates while active.

pub const fn skip_render_during_freeze_frame_screenshot(&self) -> bool

Returns true if rendering is skipped during freeze frame screenshots.

pub const fn topmost_rendered_menu(&self) -> bool

Returns true if this is the topmost rendered menu.

pub const fn update_uses_cursor(&self) -> bool

Returns true if the menu uses the cursor during update.

pub const fn uses_blurred_background(&self) -> bool

Returns true if the menu uses a blurred background.

pub const fn uses_cursor(&self) -> bool

Returns true if the menu uses a cursor for interaction.

pub const fn uses_menu_context(&self) -> bool

Returns true if the menu uses a custom menu context.

pub const fn uses_movement_to_direction(&self) -> bool

Returns true if movement input is translated into direction within the menu.

Trait Implementations

impl Debug for IMenu

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl RefCounted for IMenu

fn add_ref(&mut self)

fn release(&mut self)