Skip to content
Prisma UI

IsHidden

Overview

Section titled “Overview”

Checks if the specified PrismaView is currently hidden. This method allows you to query a view’s visibility state, which is useful for conditional UI logic and state management.

Syntax

Section titled “Syntax”
bool IsHidden(PrismaView view);

Parameters

Section titled “Parameters”

view (required)

Section titled “view (required)”
  • Type: PrismaView
  • Description: The PrismaView to check for hidden state

Return Value

Section titled “Return Value”
  • Type: bool
  • Returns: true if the view is hidden (or not found), false if the view is visible

Usage Examples

Section titled “Usage Examples”
// Check if view is hidden
if (PrismaUI->IsHidden(view)) {
    SKSE::log::info("View is hidden");
}

Behavior Details

Section titled “Behavior Details”
  • Returns true if the view’s isHidden flag is set to true
  • Returns false if the view is visible
  • Returns true if the view is not found (with a warning logged)

Best Practices

Section titled “Best Practices”
  • State Validation: Check visibility before show/hide operations
  • Conditional Logic: Use for UI state-dependent behavior
  • Toggle Operations: Essential for implementing toggle functionality
  • Error Handling: Check for true return with invalid views

Common Issues

Section titled “Common Issues”