From 39a0787c79db2baf3952bf742cb409c62ffdacf2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Manuel=20V=C3=B6gele?= Date: Fri, 30 Apr 2021 10:26:37 +0200 Subject: [PATCH] Add documentation about what needs to be awaited in SpeedProvider.onMovementHistoryUpdate --- src/speed_provider.js | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/speed_provider.js b/src/speed_provider.js index 29bebf7..be15e5b 100644 --- a/src/speed_provider.js +++ b/src/speed_provider.js @@ -86,7 +86,9 @@ export class SpeedProvider { /** * This hook is being called after Drag Ruler has updated the movement history for one or more tokens. - * It'll receive an array of tokens that have been updated + * It'll receive an array of tokens that have been updated. + * If your speed provider is storing any additional values that are relevant for the movement history, this function should + * await until those updates have completed inside foundry. */ async onMovementHistoryUpdate(tokens) {}