Focus

Name: Prisma UI
Rating: 5 (1 reviews)
Author: StarkMP

Overview

Sets input focus to the specified PrismaView and shows the cursor. This method activates the UI for user interaction and optionally pauses the game to provide an uninterrupted interface experience.

Syntax

bool Focus(PrismaView view, bool pauseGame = false, bool disableFocusMenu = false);

Parameters

`view` (required)

Type: PrismaView
Description: The PrismaView to receive focus

`pauseGame` (optional)

Type: bool
Default: false
Description: Optional parameter to pause the game when focus is active

`disableFocusMenu` (optional)

Type: bool
Default: false
Description: If true, sets focus without activating the FocusMenu overlay. Available since 1.2.0.

Return Value

Type: bool
Returns: true if focus was successfully set; otherwise, false

Usage Examples

// Simple focus without pausing the game
bool success = PrismaUI->Focus(view);
if (success) {
    SKSE::log::info("View focused successfully");
} else {
    SKSE::log::error("Failed to focus view");
}

// Focus the view and pause the game
bool success = PrismaUI->Focus(view, true);
if (success) {
    SKSE::log::info("View focused and game paused");
    // UI is now active and game is paused
} else {
    SKSE::log::error("Failed to focus view");
}

// Focus without showing FocusMenu overlay
bool success = PrismaUI->Focus(view, false, true);
if (success) {
    SKSE::log::info("View focused without FocusMenu");
} else {
    SKSE::log::error("Failed to focus view");
}

Best Practices

Game Pause Management: Use pauseGame = true for menus that require full user attention
FocusMenu Control: Use disableFocusMenu = true when you want focus without the overlay menu
Focus Pairing: Always pair Focus calls with corresponding Unfocus calls