add comment about returning smart pointer by ref

This commit is contained in:
Andrew Meadows 2018-04-03 18:26:43 -07:00
parent 59abc1d5b5
commit 0a2b4a8d1d

View file

@ -75,6 +75,8 @@ public:
virtual QUuid getSimulatorID() const override;
virtual void bump(uint8_t priority) override;
// getEntity() returns a smart-pointer by reference because it is only ever used
// to insert into lists of smart pointers, and the lists will make their own copies
const EntityItemPointer& getEntity() const { return _entity; }
void resetMeasuredBodyAcceleration();