Document EntityPlayer.WillPlayerRevive

[Zamiell]

This function will return true if the player has one or more extra lives or if a conditional revival item will work on the next death.

There are 3 items that grant conditional extra lives:

1. Guppy's Collar - This function will successfully predict whether or not the next revive from Guppy's Collar will work or not. (50% chance)
2. Broken Ankh - This function will successfully predict whether or not the next revive from Broken Ankh will work or not. (22.22% chance)
3. Mysterious Paper - This function will not successfully predict the revive from Mysterious Paper. (25% chance)

Mysterious Paper works like the following:

[INFO] - Lua Debug: GAME FRAME: 76 - WILL PLAYER REVIVE: false
[INFO] - Lua Debug: GAME FRAME: 77 - WILL PLAYER REVIVE: false
[INFO] - Lua Debug: GAME FRAME: 78 - WILL PLAYER REVIVE: false
[INFO] - Lua Debug: GAME FRAME: 79 - WILL PLAYER REVIVE: true
[INFO] - Lua Debug: GAME FRAME: 80 - WILL PLAYER REVIVE: false
[INFO] - Lua Debug: GAME FRAME: 81 - WILL PLAYER REVIVE: false
[INFO] - Lua Debug: GAME FRAME: 82 - WILL PLAYER REVIVE: false
[INFO] - Lua Debug: GAME FRAME: 83 - WILL PLAYER REVIVE: true
[INFO] - Lua Debug: GAME FRAME: 84 - WILL PLAYER REVIVE: false
[INFO] - Lua Debug: GAME FRAME: 85 - WILL PLAYER REVIVE: false
[INFO] - Lua Debug: GAME FRAME: 86 - WILL PLAYER REVIVE: false
[INFO] - Lua Debug: GAME FRAME: 87 - WILL PLAYER REVIVE: true
[INFO] - Lua Debug: GAME FRAME: 88 - WILL PLAYER REVIVE: false
[INFO] - Lua Debug: GAME FRAME: 89 - WILL PLAYER REVIVE: false
[INFO] - Lua Debug: GAME FRAME: 90 - WILL PLAYER REVIVE: false
[INFO] - Lua Debug: GAME FRAME: 91 - WILL PLAYER REVIVE: true
[INFO] - Lua Debug: GAME FRAME: 92 - WILL PLAYER REVIVE: false
[INFO] - Lua Debug: GAME FRAME: 93 - WILL PLAYER REVIVE: false
[INFO] - Lua Debug: GAME FRAME: 94 - WILL PLAYER REVIVE: false
[INFO] - Lua Debug: GAME FRAME: 95 - WILL PLAYER REVIVE: true
[INFO] - Lua Debug: GAME FRAME: 96 - WILL PLAYER REVIVE: false
[INFO] - Lua Debug: GAME FRAME: 97 - WILL PLAYER REVIVE: false
[INFO] - Lua Debug: GAME FRAME: 98 - WILL PLAYER REVIVE: false
[INFO] - Lua Debug: GAME FRAME: 99 - WILL PLAYER REVIVE: true
[INFO] - Lua Debug: GAME FRAME: 100 - WILL PLAYER REVIVE: false
[INFO] - Lua Debug: GAME FRAME: 101 - WILL PLAYER REVIVE: false
[INFO] - Lua Debug: GAME FRAME: 102 - WILL PLAYER REVIVE: false
[INFO] - Lua Debug: GAME FRAME: 103 - WILL PLAYER REVIVE: true

This is because it cycles through the 4 possible items on each frame, as documented on the wiki.

[wofsauge]

Added info in 7cd3bb0