document part::unlink

project-imprimis · Dec 5, 2024 · 8b5fa1c · 8b5fa1c
1 parent 8f0db5b
commit 8b5fa1c
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/src/engine/model/animmodel.h b/src/engine/model/animmodel.h
@@ -599,6 +599,14 @@ class animmodel : public model
                 void genBIH(std::vector<BIH::mesh> &bih, const matrix4x3 &m, float modelscale) const;
                 void genshadowmesh(std::vector<triangle> &tris, const matrix4x3 &m, float modelscale) const;
                 bool link(part *p, std::string_view tag, const vec &translate = vec(0, 0, 0), int anim = -1, int basetime = 0, vec *pos = nullptr);
+
+                /**
+                 * @brief Removes from this part's linkedpart list the linkedpart corresponding to the passed part
+                 *
+                 * `part::links` is the vector containing the list of linkedparts.
+                 *
+                 * @param p the part to remove the corresponding linkedpart from
+                 */
                 bool unlink(const part *p);
                 void initskins(Texture *tex = notexture, Texture *masks = notexture, uint limit = 0);
                 bool alphatested() const;