mirror/openmw
1
0
Fork 0
mirror of https://github.com/OpenMW/openmw.git synced 2025-06-03 07:11:32 +00:00
Code Issues Releases Wiki Activity

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

Browse source
This commit is contained in:
Petr Mikheev 2021-10-12 21:25:34 +02:00
parent 6b482d0b52
commit 4e9d691715
1 changed files with 5 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
apps/openmw/mwworld/ptr.hpp
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 getTypeDescription() const