Player Usable

Overview

• Node Name: Player Usable
• Category: repeat_instant
• File: extensions/flowgraph/nodes/vehicle/playerUsable.lua

Sets whether a vehicle can be controlled by the player. Useful for locking/unlocking vehicles during scenarios.

Known Issue: PlayerUsable has some bugs and only works the first time (per the source todo comment).

Pin Schema

Input Pins

Legacy Pin Mapping

• in.vehiId → vehId

Internals

Key Methods

How It Works

1. On each tick, work() looks up the vehicle by vehId using scenetree.findObjectById().
2. If no valid ID is provided (nil or 0), the node does nothing (player vehicle fallback is commented out).
3. Sets the playerUsable property on the vehicle's underlying object to the controllable pin value.

Usage Example

-- In a flowgraph - lock a vehicle so the player cannot control it:
-- [Get Vehicle ID] → (vehId) → [Player Usable].vehId
-- [Bool: false]    →            [Player Usable].controllable

-- Direct Lua equivalent:
local veh = scenetree.findObjectById(vehId)
veh.obj.playerUsable = false  -- lock
veh.obj.playerUsable = true   -- unlock

Key Dependencies

• scenetree.findObjectById() - resolves vehicle ID to scene object
• obj.playerUsable - engine property controlling player input acceptance

See Also

• Align for Coupling (Flowgraph Node) - Related reference
• Apply Velocity to Vehicle (Flowgraph Node) - Related reference
• Boost Vehicle (Flowgraph Node) - Related reference
• FlowGraph Guide - Guide