Allows setting tick_interval on status effects to 0, effectively passing process() straight to tick() (#90248)

## About The Pull Request

Adds STATUS_EFFECT_AUTO_TICK, a define with a value of 0 that just makes
process() call tick() every time.

## Why It's Good For The Game

An unambiguous way to make tick() consistent with process() is quite
nice.
Sometimes you just have a status effect that only needs to run every
0.2s or every 2s. (past cases downstream)
Other times you have a status effect that is reliant on being in sync
with process() (my case downstream that started this PR)
This commit is contained in:
RikuTheKiller
2025-04-29 17:07:29 -06:00
committed by Shadow-Quill
parent 158769f299
commit a6f13664b9
3 changed files with 12 additions and 10 deletions
+2
View File
@@ -11,6 +11,8 @@
#define STATUS_EFFECT_PERMANENT -1
/// Use in status effect "tick_interval" to prevent it from calling tick()
#define STATUS_EFFECT_NO_TICK -1
/// Use in status effect "tick_interval" to guarantee that tick() gets called on every process()
#define STATUS_EFFECT_AUTO_TICK 0
/// Indicates this status effect is an abstract type, ie not instantiated
/// Doesn't actually do anything in practice, primarily just a marker / used in unit tests,
+7 -4
View File
@@ -119,13 +119,16 @@
qdel(src)
return
if(tick_interval != STATUS_EFFECT_NO_TICK && tick_interval < world.time)
if(tick_interval == STATUS_EFFECT_AUTO_TICK)
tick(seconds_per_tick)
else if(tick_interval != STATUS_EFFECT_NO_TICK && tick_interval < world.time)
var/tick_length = (tick_interval_upperbound && tick_interval_lowerbound) ? rand(tick_interval_lowerbound, tick_interval_upperbound) : initial(tick_interval)
tick(tick_length / (1 SECONDS))
tick_interval = world.time + tick_length
if(QDELING(src))
// tick deleted us, no need to continue
return
if(QDELING(src))
// tick deleted us, no need to continue
return
if(duration != STATUS_EFFECT_PERMANENT)
if(duration < world.time)
@@ -11,19 +11,16 @@
if(tick_speed == INFINITY)
TEST_FAIL("Status effect [checking] has tick_interval set to INFINITY, this is not how you prevent ticks - use tick_interval = STATUS_EFFECT_NO_TICK instead.")
continue
if(tick_speed == 0)
TEST_FAIL("Status effect [checking] has tick_interval set to 0, this is not how you prevent ticks - use tick_interval = STATUS_EFFECT_NO_TICK instead.")
continue
switch(initial(checking.processing_speed))
if(STATUS_EFFECT_FAST_PROCESS)
if(tick_speed < SSfastprocess.wait)
if(tick_speed < SSfastprocess.wait && tick_speed != STATUS_EFFECT_AUTO_TICK)
TEST_FAIL("Status effect [checking] has tick_interval set to [tick_speed], which is faster than SSfastprocess can tick ([SSfastprocess.wait]).")
if(STATUS_EFFECT_NORMAL_PROCESS)
if(tick_speed < SSprocessing.wait)
if(tick_speed < SSprocessing.wait && tick_speed != STATUS_EFFECT_AUTO_TICK)
TEST_FAIL("Status effect [checking] has tick_interval set to [tick_speed], which is faster than SSprocessing can tick ([SSprocessing.wait]).")
if(STATUS_EFFECT_PRIORITY)
var/priority_wait = world.tick_lag * SSpriority_effects.wait // SSpriority_effects has the SS_TICKER flag, so its wait is in ticks, so we have to convert it to deciseconds.
if(tick_speed < priority_wait)
if(tick_speed < priority_wait && tick_speed != STATUS_EFFECT_AUTO_TICK)
TEST_FAIL("Status effect [checking] has tick_interval set to [tick_speed], which is faster than SSpriority_effects can tick ([priority_wait]).")
else
TEST_FAIL("Invalid processing speed for status effect [checking] : [initial(checking.processing_speed)]")