Skip to content

Commit

Permalink
Merge branch 'docs-fix-boolean' into 'master'
Browse files Browse the repository at this point in the history
fix usage of #bool instead of #boolean in lua docs

See merge request OpenMW/openmw!4358
  • Loading branch information
jvoisin committed Sep 6, 2024
2 parents 1e94f53 + faf2147 commit 090c65c
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion files/lua_api/openmw/debug.lua
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@
---
-- Enable/disable automatic reload of modified shaders
-- @function [parent=#Debug] setShaderHotReloadEnabled
-- @param #bool value
-- @param #boolean value

---
-- To reload modified shaders
Expand Down
12 changes: 6 additions & 6 deletions files/lua_api/openmw/types.lua
Original file line number Diff line number Diff line change
Expand Up @@ -1003,7 +1003,7 @@
-- @function [parent=#NPC] isExpelled
-- @param openmw.core#GameObject actor NPC object
-- @param #string faction Faction ID
-- @return #bool isExpelled True if NPC is expelled from the faction.
-- @return #boolean isExpelled True if NPC is expelled from the faction.
-- @usage local NPC = require('openmw.types').NPC;
-- local result = NPC.isExpelled(player, "mages guild");

Expand Down Expand Up @@ -1105,8 +1105,8 @@
-- @field #string description Race description
-- @field #map<#string, #number> skills A map of bonus skill points by skill ID
-- @field #list<#string> spells A read-only list containing the ids of all spells inherent to the race
-- @field #bool isPlayable True if the player can pick this race in character generation
-- @field #bool isBeast True if this race is a beast race
-- @field #boolean isPlayable True if the player can pick this race in character generation
-- @field #boolean isBeast True if this race is a beast race
-- @field #GenderedNumber height Height values
-- @field #GenderedNumber weight Weight values
-- @field #map<#string, #GenderedNumber> attributes A read-only table of attribute ID to base value
Expand All @@ -1130,7 +1130,7 @@
-- @field #string head Path to the head body part model
-- @field #number baseGold The base barter gold of the NPC
-- @field #number baseDisposition NPC's starting disposition
-- @field #bool isMale The gender setting of the NPC
-- @field #boolean isMale The gender setting of the NPC
-- @field #map<#string, #boolean> servicesOffered The services of the NPC, in a table. Value is if the service is provided or not, and they are indexed by: Spells, Spellmaking, Enchanting, Training, Repair, Barter, Weapon, Armor, Clothing, Books, Ingredients, Picks, Probes, Lights, Apparatus, RepairItems, Misc, Potions, MagicItems, Travel.
-- @field #list<#TravelDestination> travelDestinations A list of @{#TravelDestination}s for this NPC.
-- @field #boolean isEssential whether the NPC is essential
Expand Down Expand Up @@ -1201,8 +1201,8 @@
-- @type PlayerQuest
-- @field #string id The quest id.
-- @field #number stage The quest stage (global and player scripts can change it). Changing the stage starts the quest if it wasn't started.
-- @field #bool started Whether the quest is started.
-- @field #bool finished Whether the quest is finished (global and player scripts can change it).
-- @field #boolean started Whether the quest is started.
-- @field #boolean finished Whether the quest is finished (global and player scripts can change it).

---
-- Sets the quest stage for the given quest, on the given player, and adds the entry to the journal, if there is an entry at the specified stage. Can only be used in global or player scripts.
Expand Down

0 comments on commit 090c65c

Please sign in to comment.