Merge branch 'fix_lua_examples' into 'master'

Fix lua doc example errors and typos

See merge request OpenMW/openmw!4823

docs/source/reference/lua-scripting/index_interfaces.rst

@@ -11,6 +11,7 @@ Interfaces
     AI <interface_ai>
     AnimationController <interface_animation>
     Camera <interface_camera>
+    Combat <interface_combat>
     Controls <interface_controls>
     Crimes <interface_crimes>
     GamepadControls <interface_gamepadcontrols>

files/lua_api/openmw/ambient.lua

@@ -18,7 +18,7 @@
 --   * `scale` - a boolean, to set if the sound's pitch should be scaled by simulation time scaling (default: true);
 --   * `loop` - a boolean, to set if the sound should be repeated when it ends (default: false);
 -- @usage local params = {
---    timeOffset=0.1
+--    timeOffset=0.1,
 --    volume=0.3,
 --    scale=false,
 --    pitch=1.0,
@@ -38,7 +38,7 @@
 --   * `scale` - a boolean, to set if the sound's pitch should be scaled by simulation time scaling (default: true);
 --   * `loop` - a boolean, to set if the sound should be repeated when it ends (default: false);
 -- @usage local params = {
---    timeOffset=0.1
+--    timeOffset=0.1,
 --    volume=0.3,
 --    scale=false,
 --    pitch=1.0,

files/lua_api/openmw/animation.lua

@@ -188,7 +188,7 @@
 --
 --   * `loops` - a number >= 0, the number of times the animation should loop after the first play (default: 0).
 --   * `priority` - Either a single #Priority value that will be assigned to all bone groups. Or a table mapping bone groups to its priority (default: PRIORITY.Default).
---   * `blendMask` - A mask of which bone groups to include in the animation (Default: BLEND_MASK.All.
+--   * `blendMask` - A mask of which bone groups to include in the animation (Default: BLEND_MASK.All).
 --   * `autoDisable` - If true, the animation will be immediately  removed upon finishing, which means information will not be possible to query once completed. (Default: true)
 --   * `speed` - a floating point number >= 0, the speed at which the animation should play (default: 1)
 --   * `startKey` - the animation key at which the animation should start (default: "start")
@@ -242,7 +242,7 @@
 --   model = types.Static.record(mgef.hitStatic).model,
 --   options = {
 --     vfxId = mgef.id,
---     particuleTextureOverride = mgef.particle,
+--     particleTextureOverride = mgef.particle,
 --     loop = false,
 --   }
 -- })
@@ -254,7 +254,7 @@
 -- Can only be used on self.
 -- @function [parent=#animation] removeVfx
 -- @param openmw.core#GameObject actor
--- @param #number vfxId an integer ID that uniquely identifies the VFX to remove
+-- @param #string vfxId a string ID that uniquely identifies the VFX to remove
 
 ---
 -- Removes all vfx from the actor.

files/lua_api/openmw/camera.lua

@@ -109,7 +109,6 @@
 
 ---
 -- Additional summand for the yaw angle; useful for camera shaking effects.
--- Setting extra pitch doesn't block player input.
 -- Full yaw is `getYaw()+getExtraYaw()`.
 -- @function [parent=#camera] setExtraYaw
 -- @param #number value
@@ -122,7 +121,7 @@
 
 ---
 -- Additional summand for the roll angle; useful for camera shaking effects.
--- Full yaw is `getRoll()+getExtraRoll()`.
+-- Full roll is `getRoll()+getExtraRoll()`.
 -- @function [parent=#camera] setExtraRoll
 -- @param #number value
 
@@ -150,7 +149,7 @@
 ---
 -- Set preferred offset between tracked position (see `getTrackedPosition`) and the camera focal point (the center of the screen) in third person mode.
 -- The offset is a 2d vector (X, Y) where X is horizontal (to the right from the character) and Y component is vertical (upward).
--- The real offset can differ from the preferred one during smooth transition of if blocked by an obstacle.
+-- The real offset can differ from the preferred one during smooth transition or if blocked by an obstacle.
 -- Smooth transition happens by default every time when the preferred offset was changed. Use `instantTransition()` to skip the current transition.
 -- @function [parent=#camera] setFocalPreferredOffset
 -- @param openmw.util#Vector2 offset

files/lua_api/openmw/core.lua

@@ -801,7 +801,7 @@
 --   * `pitch` - a floating point number >= 0, to set a sound pitch (default: 1);
 --   * `loop` - a boolean, to set if sound should be repeated when it ends (default: false);
 -- @usage local params = {
---    timeOffset=0.1
+--    timeOffset=0.1,
 --    volume=0.3,
 --    loop=false,
 --    pitch=1.0
@@ -822,7 +822,7 @@
 --   * `pitch` - a floating point number >= 0, to set a sound pitch (default: 1);
 --   * `loop` - a boolean, to set if sound should be repeated when it ends (default: false);
 -- @usage local params = {
---    timeOffset=0.1
+--    timeOffset=0.1,
 --    volume=0.3,
 --    loop=false,
 --    pitch=1.0

files/lua_api/openmw/types.lua

@@ -1004,7 +1004,7 @@
 -- @param openmw.core#GameObject actor NPC object
 -- @param #string faction Faction ID
 -- @usage local NPC = require('openmw.types').NPC;
--- NPC.clearExpell(player, "mages guild");
+-- NPC.clearExpelled(player, "mages guild");
 
 ---
 -- Check if NPC is expelled from given faction.