From 2886f200b5fe19058d6ca5db35f5804cac852c24 Mon Sep 17 00:00:00 2001 From: Ian Jackson Date: Fri, 15 Apr 2022 11:50:07 +0100 Subject: [PATCH] InertPieceTrait: Add comment clarifying FaceId etc. Signed-off-by: Ian Jackson --- src/gamestate.rs | 3 +++ 1 file changed, 3 insertions(+) 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; -- 2.30.2