Improve TaskTick comment

FAForever · Dec 27, 2024 · b3449f7 · b3449f7
1 parent c6b29fb
commit b3449f7
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 5 deletions.
diff --git a/lua/sim/ScriptTask.lua b/lua/sim/ScriptTask.lua
@@ -78,7 +78,7 @@ ScriptTask = Class(moho.ScriptTask_Methods) {
         self.CommandData = commandData
     end,
 
-    --- Called by the engine in an interval. Function must return a value in TaskStatus
+    --- Called by the engine at an interval determined by the returned TaskStatus value
     ---@param self ScriptTask
     ---@return ScriptTaskStatus
     TaskTick = function(self)

diff --git a/lua/sim/tasks/EnhanceTask.lua b/lua/sim/tasks/EnhanceTask.lua
@@ -38,7 +38,7 @@ EnhanceTask = Class(ScriptTask) {
     end,
 
     Stopping = State {
-        -- Called by the engine every tick. Function must return a value in TaskStatus
+        --- Called by the engine at an interval determined by the returned TaskStatus value
         ---@param self EnhanceTask
         ---@return ScriptTaskStatus
         TaskTick = function(self)
@@ -62,7 +62,7 @@ EnhanceTask = Class(ScriptTask) {
     },
 
     Enhancing = State {
-        -- Called by the engine every tick. Function must return a value in TaskStatus
+        --- Called by the engine at an interval determined by the returned TaskStatus value
         ---@param self EnhanceTask
         ---@return ScriptTaskStatus
         TaskTick = function(self)

diff --git a/lua/sim/tasks/GiveTask.lua b/lua/sim/tasks/GiveTask.lua
@@ -30,7 +30,7 @@ GiveTask = Class(ScriptTask) {
         self.first = true
     end,
 
-    -- Called by the engine every tick. Function must return a value in TaskStatus
+    --- Called by the engine at an interval determined by the returned TaskStatus value
     ---@param self GiveTask
     ---@return ScriptTaskStatus
     TaskTick = function(self)

diff --git a/lua/sim/tasks/TargetLocation.lua b/lua/sim/tasks/TargetLocation.lua
@@ -21,7 +21,7 @@ TargetLocation = Class(ScriptTask) {
         local unit = self:GetUnit():OnTargetLocation(commandData.Location)
     end,
 
-    -- Called by the engine every tick. Function must return a value in TaskStatus
+    --- Called by the engine at an interval determined by the returned TaskStatus value
     ---@param self TargetLocationTask
     ---@return ScriptTaskStatus
     TaskTick = function(self)