From: Ian Jackson <ijackson@chiark.greenend.org.uk>
Date: Fri, 15 Apr 2022 10:50:07 +0000 (+0100)
Subject: InertPieceTrait: Add comment clarifying FaceId etc.
X-Git-Tag: otter-1.1.0~597
X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=commitdiff_plain;h=2886f200b5fe19058d6ca5db35f5804cac852c24;p=otter.git

InertPieceTrait: Add comment clarifying FaceId etc.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
---

diff --git a/src/gamestate.rs b/src/gamestate.rs
index db92d2b7..50f4ac18 100644
--- a/src/gamestate.rs
+++ b/src/gamestate.rs
@@ -242,6 +242,9 @@ pub trait PieceTrait: PieceBaseTrait + Send + Debug + 'static {
 pub trait InertPieceTrait: PieceBaseTrait {
   /// When used for occultated version of another object,
   /// face used is always default, regardless of nfaces.
+  /// This is always the case for a piece whose `PieceSpec::load`
+  /// returns `Some` for occultation, but which does not provide
+  /// a nontrivial `PieceSpec::load_inert`.
   fn svg(&self, f: &mut Html, id: VisiblePieceId, face: FaceId,
          xdata: &PieceXDataState /* use with care! */) -> Result<(),IE>;
   fn describe_html(&self, face: FaceId) -> Result<Html,IE>;