## ToggleHeadlightDisplayMode

### Introduced

v6.0

### Description

Toggles the headlight for the 3D view under the cursor.
The headlight is a virtual light shining into the scene from the position of the camera. It is visible in any shaded OGL display mode (Shaded, Textured, Textured Decal, and so on), and when activated, temporarily disables all other scene lights. This is useful when you want to preview the shadowed parts of scene objects.
Note: the headlight is for display purposes only, and is not renderable. By default, the headlight shines from the camera's position. However, you can change its position using the Azimuth and Elevation controls.

### Scripting Syntax

    ToggleHeadlightDisplayMode();

### See Also

SetDisplayMode SetViewDisplayMode SetLightingDisplayMode