Class soundChecklistItem

Implemention of a checklist item which only provides a challenge sound.

It can be used to play a sound that indicates the start or the end of a checklist.

See also:

Info:

  • Copyright: 2022 Patrick Lang
  • Author: Patrick Lang

Methods

soundChecklistItem:new (challengeKey) Creates a hidden checklist item, which will be completed auotmatically after the sound file has been played.
soundChecklistItem:getChallengeKey () Gets the key of the challenge sound.
soundChecklistItem:evaluate () Checks whether the conditions of the checklist items are met.


Methods

soundChecklistItem:new (challengeKey)
Creates a hidden checklist item, which will be completed auotmatically after the sound file has been played.

Parameters:

  • challengeKey string The key of the challenge sound.

Returns:

    soundChecklistItem The created checklist item.
soundChecklistItem:getChallengeKey ()
Gets the key of the challenge sound.

Returns:

    string The key of the challenge sound.
soundChecklistItem:evaluate ()
Checks whether the conditions of the checklist items are met.

Returns:

    bool Always true.
generated by LDoc 1.4.6 Last updated 2022-05-28 12:58:52