app_util

Source: base/tealdef/scripts/app_util.d.tl

Notes

Types of /scripts/app_util.tl (AppUtil) for choosing between mouse and gamepad behaviour.

AppUtil

record global base/tealdef/scripts/app_util.d.tl:3

global record AppUtil

Load: local app_util = ug_require "/scripts/app_util.tl"

Notes

Input-mode helpers returned by ug_require "/scripts/app_util.tl".

Functions

isGamepadInputMode() : boolean base/tealdef/scripts/app_util.d.tl:4

Call as app_util.isGamepadInputMode

Notes

True if the game is currently in gamepad input mode.

Returns boolean

Used in the base game: 36 times in 13 files

base/content/mission/mission/mission_framework/mission_framework_react.tl:406

gamepadMode = app_util.isGamepadInputMode(),

base/content/mission/mission/guide_system/guide_system_react.tl:63

local isGamepadInputModeRef : ReactRefT<boolean> = react.useRefLazy(app_util.isGamepadInputMode)

base/content/gui/gui/menu/load_game_page.tl:56

if app_util.isGamepadInputMode() and initialFocusRef:get() then

base/content/gui/gui/main/selector_react_util.tl:108

react.fireEvent(refRC, "selectEntity", {entity = entity, stack = (allowStacking == nil and app_util.isGamepadInputMode()) or allowStacking})

base/content/gui/gui/entity_window/view_manager.tl:528

local keepPinned = not app_util.isGamepadInputMode()

base/content/gui/gui/entity_window/double_slip_switch.tl:16

local isGamepadState = engine_react_util.useStepState(app_util.isGamepadInputMode)

… and 7 more files.

getMouseOrGamepad<MouseType, GamepadTypeT>(mouse : MouseType, gamepad : GamepadTypeT) : MouseType | GamepadTypeT base/tealdef/scripts/app_util.d.tl:5

Call as app_util.getMouseOrGamepad

Notes

Returns gamepad in gamepad input mode, otherwise mouse.

Returns MouseType | GamepadTypeT

Example

crosshair = app_util.getMouseOrGamepad(false, true),

Used in the base game: 31 times in 16 files

base/content/gui/gui/layers/layer_terrain.tl:169

terrainCirclePolicy = app_util.getMouseOrGamepad("Never", "FocusSelection"),

base/content/gui/gui/layers/layer_passenger_flow.tl:195

terrainCirclePolicy = app_util.getMouseOrGamepad("Never", "FocusSelection"),

base/content/gui/gui/layers/layer_infrastructure.tl:179

terrainCirclePolicy = app_util.getMouseOrGamepad("Never", "FocusSelection"),

base/content/gui/gui/layers/layer_civilization.tl:97

terrainCirclePolicy = app_util.getMouseOrGamepad("Never", "FocusSelection"),

base/content/gui/gui/layers/layer_cargo_flow.tl:331

terrainCirclePolicy = app_util.getMouseOrGamepad("Never", "FocusSelection"),

base/content/gui/gui/layers/layer_noise.tl:189

terrainCirclePolicy = app_util.getMouseOrGamepad("Never", "FocusSelection"),

… and 10 more files.