Annotate engine/Sim batch 3

engine/Sim/CBoneEntityManipulator.lua

@@ -3,11 +3,10 @@
 local CBoneEntityManipulator = {}
 
 ---
---  derived from IAniManipulator
-function CBoneEntityManipulator:SetPivot()
+---@param x number
+---@param y number
+---@param z number
+function CBoneEntityManipulator:SetPivot(x, y, z)
 end
 
 return CBoneEntityManipulator
-
-
-

engine/Sim/CBuilderArmManipulator.lua

@@ -13,8 +13,19 @@ function CBuilderArmManipulator:SetAimingArc(minHeading,  maxHeading,  headingMa
 end
 
 ---
---  CBuilderArmManipulator:SetHeadingPitch(heading, pitch)
-function CBuilderArmManipulator:SetHeadingPitch(heading,  pitch)
+---@param minHeading number
+---@param maxHeading number
+---@param headingMaxSlew number
+---@param minPitch number
+---@param maxPitch number
+---@param pitchMaxSlew number
+function CBuilderArmManipulator:SetAimingArc(minHeading, maxHeading, headingMaxSlew, minPitch, maxPitch, pitchMaxSlew)
+end
+
+---
+---@param heading number
+---@param pitch number
+function CBuilderArmManipulator:SetHeadingPitch(heading, pitch)
 end
 
 return CBuilderArmManipulator

engine/Sim/CDamage.lua

@@ -4,7 +4,7 @@
 local CDamage = {}
 
 ---
----@return Entity
+---@return Entity | Projectile | Prop | Unit
 function CDamage:GetInstigator()
 end
 
@@ -14,14 +14,13 @@ function CDamage:GetTarget()
 end
 
 ---
---  CDamage:SetInstigator()
-function CDamage:SetInstigator()
+---@param instigator Unit
+function CDamage:SetInstigator(instigator)
 end
 
 ---
---  CDamage:SetTarget()
-function CDamage:SetTarget()
+---@param target Entity | Projectile | Prop | Unit
+function CDamage:SetTarget(target)
 end
 
 return CDamage
-

engine/Sim/CDecalHandle.lua

@@ -6,4 +6,3 @@ function CDecalHandle:Destroy()
 end
 
 return CDecalHandle
-

engine/Sim/CEconomyEvent.lua

@@ -3,4 +3,3 @@
 local CEconomyEvent = {}
 
 return CEconomyEvent
-

engine/Sim/CRotateManipulator.lua

@@ -7,49 +7,47 @@ function CRotateManipulator:ClearFollowBone()
 end
 
 ---
---  RotateManipulator:ClearGoal()
 function CRotateManipulator:ClearGoal()
 end
 
 ---
---  RotateManipulator:GetCurrentAngle()
+---@return number
 function CRotateManipulator:GetCurrentAngle()
 end
 
 ---
---  RotateManipulator:SetAccel(degrees_per_second_squared)
-function CRotateManipulator:SetAccel(degrees_per_second_squared)
+---@param degreesPerSecondSquared number
+function CRotateManipulator:SetAccel(degreesPerSecondSquared)
 end
 
 ---
---  RotateManipulator:SetCurrentAngle(angle)
+---@param angle number
 function CRotateManipulator:SetCurrentAngle(angle)
 end
 
 ---
---  RotateManipulator:SetFollowBone(bone)
+---@param bone Bone
 function CRotateManipulator:SetFollowBone(bone)
 end
 
 ---
---  RotateManipulator:SetGoal(self, degrees)
-function CRotateManipulator:SetGoal(self,  degrees)
+---@param degrees number
+function CRotateManipulator:SetGoal(degrees)
 end
 
 ---
---  RotateManipulator:SetSpeed(self, degrees_per_second)
-function CRotateManipulator:SetSpeed(self,  degrees_per_second)
+---@param degreesPerSecond number
+function CRotateManipulator:SetSpeed(degreesPerSecond)
 end
 
 ---
---  RotateManipulator:SetSpinDown(self, flag)
-function CRotateManipulator:SetSpinDown(self,  flag)
+---@param spinDown boolean
+function CRotateManipulator:SetSpinDown(spinDown)
 end
 
 ---
---  RotateManipulator:SetTargetSpeed(degrees_per_second)
-function CRotateManipulator:SetTargetSpeed(degrees_per_second)
+---@param degreesPerSecond number
+function CRotateManipulator:SetTargetSpeed(degreesPerSecond)
 end
 
 return CRotateManipulator
-