Archive/TombEngine
0
0
Fork 0
mirror of https://github.com/TombEngine/TombEngine.git synced 2025-04-28 15:57:59 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update Timer doc to give warning about names.

Browse source
This commit is contained in:
hispidence 2022-09-08 19:25:22 +01:00
parent 568019e4be
commit 74ce2183be
2 changed files with 4 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

2
Documentation/doc/5 lua utility modules/Timer.html
View file

@ -209,6 +209,8 @@ local myTimeFormat4 = {seconds = true}
<p><strong>At any given time, only one timer can show its countdown</strong>.</p>
<p><strong>Do not give your timers a name beginning with __TEN, as this is reserved for timers used by other internal libaries</strong>.</p>
<p>Use this sparingly; in the classics, timed challenges did not have visible countdowns. For shorter timers, the gameplay benefit from showing the remaining time might not be necessary, and could interfere with the atmosphere of the level.
The LevelFunc function to call when the time is up

2
Scripts/Engine/Timer.lua
View file

@ -57,6 +57,8 @@ Timer = {
--
--__At any given time, only one timer can show its countdown__.
--
--__Do not give your timers a name beginning with __TEN, as this is reserved for timers used by other internal libaries__.
--
--Use this sparingly; in the classics, timed challenges did not have visible countdowns. For shorter timers, the gameplay benefit from showing the remaining time might not be necessary, and could interfere with the atmosphere of the level.
--
-- @string name A label to give this timer; used to retrieve the timer later