Skip to main content

Challenge

Provides access to the challenge module.

Properties​

isActive​

Indicates whether the active session is part of a challenge. This property is read-only.

Functions​

start(targetPlayer)​

Starts the challenge for the specified player.

Parameters​

  • targetPlayer — Player to start the challenge for.

setComplete(targetPlayer, score)​

Sets the challenge complete for the specified player.

Parameters​

  • targetPlayer — The player to complete the challenge.
  • score — The score to set for the challenge (optional).

setDnf(targetPlayer)​

Sets the challenge complete for the specified player with a DNF (i.e. Did Not Finish) score.

Parameters​

  • targetPlayer — The player to complete the challenge.