Skip to content
Version 2.32.0
↓ Get the launcher

IInputShield interface

While any handle is held (reference-counted across plugins): blocks the game’s movement, camera, combat and interaction actions (mouse included), and blocks every keyboard key from the game — the same gate a focused Stellar text field uses, so Esc, Enter, M, Tab and the rest open nothing in the game. The holder reads the keyboard and mouse itself through the handle; framework hotkeys keep working. Main thread only. Handles a plugin still holds are released when it unloads.

public interface IInputShield
name description
IsPointerOverGameUi { get; } True when the pointer is over the game’s own interface (a game window, button or slider) and not over a Stellar window. A free camera that lets the player use the game’s interface leaves clicks, drags and the wheel to the game while this is true. Game interface hidden through ISceneVisibility may still answer, so consult it only while the game interface is shown. Works with or without a held handle. Main thread; evaluated at most once per rendered frame.
IsShielded { get; } True while the game’s input mask is up (the keyboard gate follows any held handle).
Shield() Raises the shield until the returned handle is disposed.