Browse docslightbar.clear
On this page
API method

lightbar.clear

Latches a black Remote Play lightbar value.

Syntax

Atlas Script
lightbar.clear()

Parameters

This method does not accept arguments.

Return value

See the remarks for the returned value and runtime behavior.

Remarks

Latches a black Remote Play lightbar value. Use lightbar.reset() to release ownership. Device support is required, non-Remote-Play hosts reject feedback.

Examples

Usage pattern
// Call this method from the event that owns this work.
lightbar.clear();
Reference details are generated from the Atlas Script schema in this documentation source snapshot. Confirm release-specific behavior in the Atlas for Windows build you use.