deletePlayer

Typemessage
DictionaryLCS
LibraryLiveCode Script
Syntax
deletePlayer
Associationsplayer
Summary

Sent to a player just before it is removed from the stack.

Introduced1.0
OSmac, windows, linux, ios, android
Platformsdesktop, server, mobile
Example
on deletePlayer -- delete the corresponding movie file
  delete file (the filename of the target)
  pass deletePlayer
end deletePlayer
RelatedKeyword: card, player
Property: script
Command: delete
Object: stack
Glossary: handler, player, message, command, trap
Control Structure: pass
Description

Handle the deletePlayer message if you want to perform cleanup before a player is removed from the stack.

The actual deletion is not triggered by the deletePlayer message, so trapping the message and not allowing it to pass does not prevent the player from being removed.

However, the undo command will restore a player after it is deleted by the user. For example, the following handler, placed in a card or stack script, effectively prevents a player from being deleted by the user:

on deletePlayer
    beep
    send "undo" to this card in 5 milliseconds
end deletePlayer

Tagsobjects