Document the records function for all record types

files/lua_api/openmw/types.lua

@@ -466,6 +466,11 @@
 -- @param #any objectOrRecordId
 -- @return #CreatureRecord
 
+---
+-- Returns a read-only list of all @{#CreatureRecord}s in the world database.
+-- @function [parent=#Creature] records
+-- @return #list<#CreatureRecord>
+
 ---
 -- @type CreatureRecord
 -- @field #string name
@@ -502,6 +507,11 @@
 -- @param #any objectOrRecordId
 -- @return #NpcRecord
 
+---
+-- Returns a read-only list of all @{#NpcRecord}s in the world database.
+-- @function [parent=#Npc] records
+-- @return #list<#NpcRecord>
+
 ---
 -- @type NpcRecord
 -- @field #string name
@@ -564,6 +574,11 @@
 -- @param #any objectOrRecordId
 -- @return #ArmorRecord
 
+---
+-- Returns a read-only list of all @{#ArmorRecord}s in the world database.
+-- @function [parent=#Armor] records
+-- @return #list<#ArmorRecord>
+
 ---
 -- @type ArmorRecord
 -- @field #string id Record id
@@ -634,6 +649,11 @@
 -- @param #any objectOrRecordId
 -- @return #BookRecord
 
+---
+-- Returns a read-only list of all @{#BookRecord}s in the world database.
+-- @function [parent=#Book] records
+-- @return #list<#BookRecord>
+
 ---
 -- @type BookRecord
 -- @field #string id The record ID of the book
@@ -687,6 +707,11 @@
 -- @param #any objectOrRecordId
 -- @return #ClothingRecord
 
+---
+-- Returns a read-only list of all @{#ClothingRecord}s in the world database.
+-- @function [parent=#Clothing] records
+-- @return #list<#ClothingRecord>
+
 ---
 -- @type ClothingRecord
 -- @field #string id Record id
@@ -723,6 +748,11 @@
 -- @param #any objectOrRecordId
 -- @return #IngredientRecord
 
+---
+-- Returns a read-only list of all @{#IngredientRecord}s in the world database.
+-- @function [parent=#Ingredient] records
+-- @return #list<#IngredientRecord>
+
 ---
 -- @type IngredientRecord
 -- @field #string id Record id
@@ -755,6 +785,11 @@
 -- @param #any objectOrRecordId
 -- @return #LightRecord
 
+---
+-- Returns a read-only list of all @{#LightRecord}s in the world database.
+-- @function [parent=#Light] records
+-- @return #list<#LightRecord>
+
 ---
 -- @type LightRecord
 -- @field #string id Record id
@@ -792,6 +827,11 @@
 -- @param #any objectOrRecordId
 -- @return #MiscellaneousRecord
 
+---
+-- Returns a read-only list of all @{#MiscellaneousRecord}s in the world database.
+-- @function [parent=#Miscellaneous] records
+-- @return #list<#MiscellaneousRecord>
+
 ---
 -- @type MiscellaneousRecord
 -- @field #string id The record ID of the miscellaneous item
@@ -887,6 +927,11 @@
 -- @param #any objectOrRecordId
 -- @return #WeaponRecord
 
+---
+-- Returns a read-only list of all @{#WeaponRecord}s in the world database.
+-- @function [parent=#Weapon] records
+-- @return #list<#WeaponRecord>
+
 ---
 -- @type WeaponRecord
 -- @field #string id Record id
@@ -943,6 +988,11 @@
 -- @param #any objectOrRecordId
 -- @return #ApparatusRecord
 
+---
+-- Returns a read-only list of all @{#ApparatusRecord}s in the world database.
+-- @function [parent=#Apparatus] records
+-- @return #list<#ApparatusRecord>
+
 ---
 -- @type ApparatusRecord
 -- @field #string id The record ID of the apparatus
@@ -975,6 +1025,11 @@
 -- @param #any objectOrRecordId
 -- @return #LockpickRecord
 
+---
+-- Returns a read-only list of all @{#LockpickRecord}s in the world database.
+-- @function [parent=#Lockpick] records
+-- @return #list<#LockpickRecord>
+
 ---
 -- @type LockpickRecord
 -- @field #string id The record ID of the lockpick
@@ -1007,6 +1062,11 @@
 -- @param #any objectOrRecordId
 -- @return #ProbeRecord
 
+---
+-- Returns a read-only list of all @{#ProbeRecord}s in the world database.
+-- @function [parent=#Probe] records
+-- @return #list<#ProbeRecord>
+
 ---
 -- @type ProbeRecord
 -- @field #string id The record ID of the probe
@@ -1039,6 +1099,11 @@
 -- @param #any objectOrRecordId
 -- @return #RepairRecord
 
+---
+-- Returns a read-only list of all @{#RepairRecord}s in the world database.
+-- @function [parent=#Repair] records
+-- @return #list<#RepairRecord>
+
 ---
 -- @type RepairRecord
 -- @field #string id The record ID of the repair tool
@@ -1069,6 +1134,11 @@
 -- @param #any objectOrRecordId
 -- @return #ActivatorRecord
 
+---
+-- Returns a read-only list of all @{#ActivatorRecord}s in the world database.
+-- @function [parent=#Activator] records
+-- @return #list<#ActivatorRecord>
+
 ---
 -- @type ActivatorRecord
 -- @field #string id Record id
@@ -1112,6 +1182,11 @@
 -- @param #any objectOrRecordId
 -- @return #ContainerRecord
 
+---
+-- Returns a read-only list of all @{#ContainerRecord}s in the world database.
+-- @function [parent=#Container] records
+-- @return #list<#ContainerRecord>
+
 ---
 -- @type ContainerRecord
 -- @field #string id Record id
@@ -1162,6 +1237,11 @@
 -- @param #any objectOrRecordId
 -- @return #DoorRecord
 
+---
+-- Returns a read-only list of all @{#DoorRecord}s in the world database.
+-- @function [parent=#Door] records
+-- @return #list<#DoorRecord>
+
 ---
 -- @type DoorRecord
 -- @field #string id Record id
@@ -1191,6 +1271,11 @@
 -- @param #any objectOrRecordId
 -- @return #StaticRecord
 
+---
+-- Returns a read-only list of all @{#StaticRecord}s in the world database.
+-- @function [parent=#Static] records
+-- @return #list<#StaticRecord>
+
 ---
 -- @type StaticRecord
 -- @field #string id Record id