From d73fffb22f817b7fa8a385b32371c6ca90213a19 Mon Sep 17 00:00:00 2001 From: blujai831 Date: Sat, 6 Jan 2024 13:16:05 -0800 Subject: [PATCH] Clarified documentation of TweenChannel.arbitration_mode. --- util/TweenChannel.gd | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/util/TweenChannel.gd b/util/TweenChannel.gd index 53f780f..8eca74f 100644 --- a/util/TweenChannel.gd +++ b/util/TweenChannel.gd @@ -12,6 +12,13 @@ enum ArbitrationMode { } ## How to arbitrate between a tween request and an already running tween. +## +## Takes effect only for new calls to self.create_tween, +## not in-progress calls. That is to say, if self.create_tween +## has already been called at a time when arbitration_mode was YIELD, +## and it changes while the call is yielding, then the in-progress call +## still will not return until its turn, as though arbitration_mode +## were still YIELD. var arbitration_mode := ArbitrationMode.YIELD ## Tween currently running if any, else null. var current_tween: Tween = null