1
0
Fork 0
mirror of https://github.com/OpenMW/openmw.git synced 2025-11-03 22:56:40 +00:00

Merge branch 'customrecorddocs' into 'master'

Mention NpcRecord in createRecord docs

See merge request OpenMW/openmw!4967
This commit is contained in:
jvoisin 2025-10-28 17:06:45 +00:00
commit 4aa0edf895

View file

@ -166,18 +166,19 @@
-- potion = world.createObject('Generated:0x0', 1) -- potion = world.createObject('Generated:0x0', 1)
--- ---
-- Creates a custom record in the world database; String ids that came from ESM3 content files are lower-cased. -- Creates a custom record in the world database; string IDs that came from ESM3 content files are lower-cased.
-- Eventually meant to support all records, but the current -- Eventually meant to support all records, but the current
-- set of supported types is limited to: -- set of supported types is limited to:
-- --
-- * @{openmw.types#PotionRecord}, -- * @{openmw.types#ActivatorRecord},
-- * @{openmw.types#ArmorRecord}, -- * @{openmw.types#ArmorRecord},
-- * @{openmw.types#BookRecord}, -- * @{openmw.types#BookRecord},
-- * @{openmw.types#MiscellaneousRecord},
-- * @{openmw.types#ClothingRecord}, -- * @{openmw.types#ClothingRecord},
-- * @{openmw.types#WeaponRecord}, -- * @{openmw.types#LightRecord},
-- * @{openmw.types#ActivatorRecord}, -- * @{openmw.types#MiscellaneousRecord},
-- * @{openmw.types#LightRecord} -- * @{openmw.types#NpcRecord},
-- * @{openmw.types#PotionRecord},
-- * @{openmw.types#WeaponRecord}
-- @function [parent=#world] createRecord -- @function [parent=#world] createRecord
-- @param #any record A record to be registered in the database. Must be one of the supported types. The id field is not used, one will be generated for you. -- @param #any record A record to be registered in the database. Must be one of the supported types. The id field is not used, one will be generated for you.
-- @return #any A new record added to the database. The type is the same as the input's. -- @return #any A new record added to the database. The type is the same as the input's.