Browse docsps5.player_number
On this page
API method

ps5.player_number

Sends a Remote Play player indicator from 0 to 4; values clamp and 0 turns it off.

Syntax

Atlas Script
ps5.player_number(number)

Parameters

number
Player or slot number used by the console feedback API.

Return value

See the remarks for the returned value and runtime behavior.

Remarks

Sends a Remote Play player indicator from 0 to 4; values clamp and 0 turns it off. Device support is required.

Examples

Usage pattern
// Replace number with values described above.
ps5.player_number(number);
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.