1
0
mirror of https://gitlab.com/OpenMW/openmw.git synced 2025-02-21 18:40:01 +00:00

Merge branch 'add_comment' into 'master'

Add comment for MWWorld::Ptr::getType() because it is not obvious.

See merge request OpenMW/openmw!1291
This commit is contained in:
psi29a 2021-10-14 12:44:04 +00:00
commit e86b9a7b89

View File

@ -35,6 +35,11 @@ namespace MWWorld
return mRef == nullptr;
}
// Returns a 32-bit id of the ESM record this object is based on.
// Specific values of ids are defined in ESM::RecNameInts.
// Note 1: ids are not sequential. E.g. for a creature `getType` returns 0x41455243.
// Note 2: Life is not easy and full of surprises. For example
// prison marker reuses ESM::Door record. Player is ESM::NPC.
unsigned int getType() const;
std::string_view getTypeDescription() const