Merge branch 'lua-docs-grammar-fixes' into 'master'

Lua docs: minor grammar fixes (mostly missing articles)

See merge request OpenMW/openmw!4996

Author: Assumeru

files/data/openmw_aux/time.lua

@@ -51,7 +51,7 @@ end
 
 ---
 -- Run given function repeatedly.
--- Note that loading a save stops the evaluation. If it should work always, call it during initialization of the script (i.e. not in a handler)
+-- Note that loading a save stops the evaluation. If it should always work, call it during the initialization of the script (i.e. not in a handler)
 -- @function [parent=#time] runRepeatedly
 -- @param #function fn the function that should be called
 -- @param #number period interval

files/data/openmw_aux/util.lua

@@ -23,21 +23,21 @@ local function deepToString(val, level, prefix)
 end
 
 ---
--- Works like `tostring` but shows also content of tables.
+-- Works like `tostring` but also shows the content of tables.
 -- @function [parent=#util] deepToString
--- @param #any value The value to convert to string
--- @param #number maxDepth Max depth of tables unpacking (optional, 1 by default)
+-- @param #any value The value to convert to a string
+-- @param #number maxDepth Max depth of table unpacking (optional, 1 by default)
 function aux_util.deepToString(value, maxDepth)
     return deepToString(value, maxDepth, '')
 end
 
 ---
--- Finds the element the minimizes `scoreFn`.
+-- Finds the element in the array given the lowest score by `scoreFn`.
 -- @function [parent=#util] findMinScore
 -- @param #table array Any array
 -- @param #function scoreFn Function that returns either nil/false or a number for each element of the array
--- @return element The element the minimizes `scoreFn`
--- @return #number score The output of `scoreFn(element)`
+-- @return element The element given the lowest score
+-- @return #number score The score given to the chosen element by `scoreFn`
 -- @return #number index The index of the chosen element in the array
 -- @usage -- Find the nearest NPC
 -- local nearestNPC, distToNPC = aux_util.findMinScore(

files/data/scripts/omw/activationhandlers.lua

@@ -58,7 +58,7 @@ return {
         -- @field [parent=#Activation] #number version
         version = 0,
 
-        --- Add new activation handler for a specific object.
+        --- Add a new activation handler for a specific object.
         -- If `handler(object, actor)` returns false, other handlers for
         -- the same object (including type handlers) will be skipped.
         -- @function [parent=#Activation] addHandlerForObject
@@ -73,7 +73,7 @@ return {
             handlers[#handlers + 1] = handler
         end,
 
-        --- Add new activation handler for a type of objects.
+        --- Add a new activation handler for a type of object.
         -- If `handler(object, actor)` returns false, other handlers for
         -- the same object (including type handlers) will be skipped.
         -- @function [parent=#Activation] addHandlerForType

files/data/scripts/omw/ai.lua

@@ -86,7 +86,7 @@ return {
         -- @return #boolean
         isFleeing = function() return self:_isFleeing() end,
 
-        --- Start new AI package.
+        --- Start a new AI package.
         -- @function [parent=#AI] startPackage
         -- @param #table options See the "AI packages" page.
         startPackage = startPackage,
@@ -128,7 +128,7 @@ return {
             end
         end,
 
-        --- Get list of targets of all packages of the given type.
+        --- Get a list of targets from all packages of the given type.
         -- @function [parent=#AI] getTargets
         -- @param #string packageType
         -- @return #list<openmw.core#GameObject>

files/data/scripts/omw/camera/camera.lua

@@ -250,16 +250,16 @@ return {
         -- @field [parent=#Camera] #number version
         version = 1,
 
-        --- Return primary mode (MODE.FirstPerson or MODE.ThirdPerson).
+        --- Return the primary mode (MODE.FirstPerson or MODE.ThirdPerson).
         -- @function [parent=#Camera] getPrimaryMode
         -- @return #number @{openmw.camera#MODE}
         getPrimaryMode = function() return primaryMode end,
 
-        --- Get base third person distance (without applying angle and speed modifiers).
+        --- Get the base third person distance (without applying angle and speed modifiers).
         -- @function [parent=#Camera] getBaseThirdPersonDistance
         -- @return #number
         getBaseThirdPersonDistance = function() return third_person.baseDistance end,
-        --- Set base third person distance
+        --- Set the base third person distance
         -- @function [parent=#Camera] setBaseThirdPersonDistance
         -- @param #number value
         setBaseThirdPersonDistance = function(v) third_person.baseDistance = v end,

files/data/scripts/omw/combat/local.lua

@@ -299,7 +299,7 @@ end
 
 ---
 -- @type AttackInfo
--- @field [parent=#AttackInfo] #table damage A table mapping stat name (health, fatigue, or magicka) to number. For example, {health = 50, fatigue = 10} will cause 50 damage to health and 10 to fatigue (before adjusting for armor and difficulty). This field is ignored for failed attacks.
+-- @field [parent=#AttackInfo] #table damage A table mapping a stat name (health, fatigue, or magicka) to a number. For example, {health = 50, fatigue = 10} will cause 50 damage to health and 10 to fatigue (before adjusting for armor and difficulty). This field is ignored for failed attacks.
 -- @field [parent=#AttackInfo] #number strength A number between 0 and 1 representing the attack strength. This field is ignored for failed attacks.
 -- @field [parent=#AttackInfo] #boolean successful Whether the attack was successful or not.
 -- @field [parent=#AttackInfo] #AttackSourceType sourceType What class of attack this is.
@@ -333,7 +333,7 @@ return {
 
         --- Add new onHit handler for this actor
         -- If `handler(attack)` returns false, other handlers for
-        -- the call will be skipped. where attack is the same @{#AttackInfo} passed to #Combat.onHit
+        -- the call will be skipped. Where attack is the same @{#AttackInfo} passed to #Combat.onHit
         -- @function [parent=#Combat] addOnHitHandler
         -- @param #function handler The handler.
         addOnHitHandler = function(handler)
@@ -349,7 +349,7 @@ return {
         -- @return #number Damage adjusted for armor
         adjustDamageForArmor = function(damage, actor) return adjustDamageForArmor(damage, actor or self) end,
 
-        --- Calculates a difficulty multiplier based on current difficulty settings
+        --- Calculates a difficulty multiplier based on the current difficulty settings
         -- and adjusts damage accordingly. Has no effect if both this actor and the
         -- attacker are NPCs, or if both are Players.
         -- @function [parent=#Combat] adjustDamageForDifficulty

files/data/scripts/omw/crimes.lua

@@ -7,7 +7,7 @@ local I = require('openmw.interfaces')
 -- @field openmw.core#GameObject victim The victim of the crime (optional)
 -- @field openmw.types#OFFENSE_TYPE_IDS type The type of the crime to commit. See @{openmw.types#OFFENSE_TYPE_IDS} (required)
 -- @field #string faction ID of the faction the crime is committed against (optional)
--- @field #number arg The amount to increase the player bounty by, if the crime type is theft. Ignored otherwise (optional, defaults to 0)
+-- @field #number arg The amount to increase the player bounty by if the crime type is theft. Ignored otherwise (optional, defaults to 0)
 -- @field #boolean victimAware Whether the victim is aware of the crime (optional, defaults to false)
 
 ---

files/data/scripts/omw/mechanics/animationcontroller.lua

@@ -100,7 +100,7 @@ return {
         -- @param #table options The table of play options that will be passed to @{openmw.animation#playBlended}
         playBlendedAnimation = playBlendedAnimation,
 
-        --- Add new playBlendedAnimation handler for this actor
+        --- Add a new playBlendedAnimation handler for this actor
         -- If `handler(groupname, options)` returns false, other handlers for
         -- the call will be skipped.
         -- @function [parent=#AnimationController] addPlayBlendedAnimationHandler
@@ -109,13 +109,13 @@ return {
             playBlendedHandlers[#playBlendedHandlers + 1] = handler
         end,
 
-        --- Add new text key handler for this actor
+        --- Add a new text key handler for this actor
         -- While playing, some animations emit text key events. Register a handle to listen for all
         -- text key events associated with this actor's animations.
         -- If `handler(groupname, key)` returns false, other handlers for
         -- the call will be skipped.
         -- @function [parent=#AnimationController] addTextKeyHandler
-        -- @param #string groupname Name of the animation group to listen to keys for. If the empty string or nil, all keys will be received
+        -- @param #string groupname Name of the animation group to listen to keys for. If it is an empty string or nil, all keys will be received
         -- @param #function handler The handler.
         addTextKeyHandler = function(groupname, handler)
             if not groupname then

files/data/scripts/omw/skillhandlers.lua

@@ -7,7 +7,7 @@ local NPC = require('openmw.types').NPC
 local Skill = core.stats.Skill
 
 ---
--- Table of skill use types defined by morrowind.
+-- Table of skill use types defined by Morrowind.
 -- Each entry corresponds to an index into the available skill gain values
 -- of a @{openmw.core#SkillRecord}
 -- @type SkillUseType
@@ -188,7 +188,7 @@ return {
         -- If `handler(skillid, source, options)` returns false, other handlers (including the default skill level up handler) 
         -- will be skipped. Where skillid and source are the parameters passed to @{#SkillProgression.skillLevelUp}, and options is
         -- a modifiable table of skill level up values, and can be modified to change the behavior of later handlers. 
-        -- These values are calculated based on vanilla mechanics. Setting any value to nil will cause that mechanic to be skipped. By default contains these values:
+        -- These values are calculated based on vanilla mechanics. Setting any value to nil will cause that mechanic to be skipped. By default it contains these values:
         --
         --   * `skillIncreaseValue` - The numeric amount of skill levels gained. By default this is 1, except when the source is jail in which case it will instead be -1 for all skills except sneak and security.
         --   * `levelUpProgress` - The numeric amount of level up progress gained.
@@ -216,7 +216,7 @@ return {
 
         --- Trigger a skill use, activating relevant handlers
         -- @function [parent=#SkillProgression] skillUsed
-        -- @param #string skillid The if of the skill that was used
+        -- @param #string skillid The ID of the skill that was used
         -- @param options A table of parameters. Must contain one of `skillGain` or `useType`. It's best to always include `useType` if applicable, even if you set `skillGain`, as it may be used
         -- by handlers to make decisions. See the addSkillUsedHandler example at the top of this page.
         --

files/data/scripts/omw/usehandlers.lua

@@ -58,7 +58,7 @@ return {
             handlers[#handlers + 1] = handler
         end,
 
-        --- Add new use action handler for a type of objects.
+        --- Add new use action handler for a type of object.
         -- If `handler(object, actor, options)` returns false, other handlers for
         -- the same object (including type handlers) will be skipped.
         -- @function [parent=#ItemUsage] addHandlerForType