Controls

A script can capture an avatar’s movement keys and left mouse button, which is how vehicles, weapons and HUDs read input. Part of the Input feature.

Concepts

Controls need PERMISSION_TAKE_CONTROLS, requested from the avatar and granted in run_time_permissions
- Granted without a dialog when the avatar is sitting on the object or wearing it
llTakeControls takes controls, a mask of CONTROL_* control buttons
- accept decides whether the controls raise control events
- pass_on decides whether they still perform their normal function, such as moving the avatar
- With both accept and pass_on FALSE, every control except the specified ones is disabled
llReleaseControls gives the controls back and also revokes PERMISSION_TAKE_CONTROLS
A script that has taken controls keeps running in “No Outside Scripts” parcels, which keeps vehicles and AOs working; this applies only to the prim holding the script
control passes id, the avatar, plus two masks of CONTROL_* bits
- level has a bit set for each control held down
- edge has a bit set for each control that changed since the last event
Mouselook
- CONTROL_LBUTTON is the left mouse button in normal view, CONTROL_ML_LBUTTON the same button in mouselook
- llForceMouselook puts avatars that sit on the prim into mouselook
- llGetAgentInfo reports AGENT_MOUSELOOK while an avatar is in mouselook

Functions and events

	`llRequestPermissions(key agent, integer permissions)`
`event`	`run_time_permissions(integer perm)`
	`llTakeControls(integer controls, integer accept, integer pass_on)`
	`llReleaseControls()`
`event`	`control(key id, integer level, integer edge)`
	`llForceMouselook(integer mouselook)`

Presses, releases and held keys

Combine level and edge in the control event:

integer start = level & edge;   // pressed this event
integer end = ~level & edge;    // released this event
integer held = level & ~edge;   // still held

Touch

Clicking objects, touch positions, click actions and touch text.

Game Control

Controller-shaped buttons and axes, from a game controller or translated keyboard and mouse, and game-control modes.

Scripting Details

	`llRequestPermissions(key agent, integer permissions)` Requests permissions (a bitfield specified by permissions) from the agent in the same region, calling run_time_permissions if granted. This call does not pause script execution.
`event`	`run_time_permissions(integer perm)` Triggered when an agent grants or denies runtime permissions requested by llRequestPermissions. Passes the active integer permissions bitfield perm (returns 0 if no permissions are currently granted).
	`llTakeControls(integer controls, integer accept, integer pass_on)` Intercepts inputs (keyboard/mouse clicks) from the agent, specifically those specified by controls. The boolean accept determines if events are generated, and pass_on determines if inputs also perform their default functions. Requires the PERMISSION_TAKE_CONTROLS runtime permission.
	`llReleaseControls()` Stops taking inputs (previously acquired via llTakeControls) from the avatar, dequeuing any remaining control events and revoking the PERMISSION_TAKE_CONTROLS permission.
`event`	`control(key id, integer level, integer edge)` Triggered to pass captured avatar control inputs into the script. The parameter level indicates held controls, and edge indicates change in controls (both are bitfields of CONTROL_* constants).
	`llForceMouselook(integer mouselook)` Sets whether any avatar sitting on this prim is forced into mouselook mode. Setting mouselook to TRUE forces the mode; FALSE (default) allows the avatar to keep their current camera mode.
`integer`	`llGetAgentInfo(key id)` Returns an integer bitfield containing status information about the agent specified by id (such as AGENT_FLYING, AGENT_ATTACHMENTS, AGENT_SITTING, etc.).

Constant groups

Constant groups ControlButton 10

See also Feature Input Feature Permissions Category Input SL Wiki LSL ControlsPlanned Guide: capturing controls for a vehicle or weapon