Struct Item 

pub struct Item { /* private fields */ }

Trait Implementations

impl Debug for Item

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Item

fn deserialize<__D>( __deserializer: __D, ) -> Result<Item, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl DynCast<<dyn OutlineTrait as GetDynCastConfig<dyn OutlineTrait>>::Config> for Item

fn dyn_cast_ref( &self, ) -> Result<&<<dyn OutlineTrait as GetDynCastConfig<dyn OutlineTrait>>::Config as DynCastConfig>::Target, &<<dyn OutlineTrait as GetDynCastConfig<dyn OutlineTrait>>::Config as DynCastConfig>::Source>

Cast a shared reference of this trait object to another trait object.

fn dyn_cast_mut( &mut self, ) -> Result<&mut <<dyn OutlineTrait as GetDynCastConfig<dyn OutlineTrait>>::Config as DynCastConfig>::Target, &mut <<dyn OutlineTrait as GetDynCastConfig<dyn OutlineTrait>>::Config as DynCastConfig>::Source>

Cast a mutable/unique reference of this trait object to another trait object.

fn dyn_cast_boxed( self: Box<Item>, ) -> Result<Box<<<dyn OutlineTrait as GetDynCastConfig<dyn OutlineTrait>>::Config as DynCastConfig>::Target>, Box<<<dyn OutlineTrait as GetDynCastConfig<dyn OutlineTrait>>::Config as DynCastConfig>::Source>>

Cast a boxed trait object to another trait object.

fn dyn_cast_rc( self: Rc<Item>, ) -> Result<Rc<<<dyn OutlineTrait as GetDynCastConfig<dyn OutlineTrait>>::Config as DynCastConfig>::Target>, Rc<<<dyn OutlineTrait as GetDynCastConfig<dyn OutlineTrait>>::Config as DynCastConfig>::Source>>

Cast a reference counted trait object to another trait object.

fn dyn_cast_arc( self: Arc<Item>, ) -> Result<Arc<<<dyn OutlineTrait as GetDynCastConfig<dyn OutlineTrait>>::Config as DynCastConfig>::Target>, Arc<<<dyn OutlineTrait as GetDynCastConfig<dyn OutlineTrait>>::Config as DynCastConfig>::Source>>

Cast an atomically reference counted trait object to another trait object.

impl DynCast<<dyn PieceBaseTrait as GetDynCastConfig<dyn PieceBaseTrait>>::Config> for Item

fn dyn_cast_ref( &self, ) -> Result<&<<dyn PieceBaseTrait as GetDynCastConfig<dyn PieceBaseTrait>>::Config as DynCastConfig>::Target, &<<dyn PieceBaseTrait as GetDynCastConfig<dyn PieceBaseTrait>>::Config as DynCastConfig>::Source>

Cast a shared reference of this trait object to another trait object.

fn dyn_cast_mut( &mut self, ) -> Result<&mut <<dyn PieceBaseTrait as GetDynCastConfig<dyn PieceBaseTrait>>::Config as DynCastConfig>::Target, &mut <<dyn PieceBaseTrait as GetDynCastConfig<dyn PieceBaseTrait>>::Config as DynCastConfig>::Source>

Cast a mutable/unique reference of this trait object to another trait object.

fn dyn_cast_boxed( self: Box<Item>, ) -> Result<Box<<<dyn PieceBaseTrait as GetDynCastConfig<dyn PieceBaseTrait>>::Config as DynCastConfig>::Target>, Box<<<dyn PieceBaseTrait as GetDynCastConfig<dyn PieceBaseTrait>>::Config as DynCastConfig>::Source>>

Cast a boxed trait object to another trait object.

fn dyn_cast_rc( self: Rc<Item>, ) -> Result<Rc<<<dyn PieceBaseTrait as GetDynCastConfig<dyn PieceBaseTrait>>::Config as DynCastConfig>::Target>, Rc<<<dyn PieceBaseTrait as GetDynCastConfig<dyn PieceBaseTrait>>::Config as DynCastConfig>::Source>>

Cast a reference counted trait object to another trait object.

fn dyn_cast_arc( self: Arc<Item>, ) -> Result<Arc<<<dyn PieceBaseTrait as GetDynCastConfig<dyn PieceBaseTrait>>::Config as DynCastConfig>::Target>, Arc<<<dyn PieceBaseTrait as GetDynCastConfig<dyn PieceBaseTrait>>::Config as DynCastConfig>::Source>>

Cast an atomically reference counted trait object to another trait object.

impl InertPieceTrait for Item

fn svg( &self, f: &mut Html, id: VisiblePieceId, face: FaceId, xdata: &Option<Box<dyn PieceXData>>, ) -> Result<(), InternalError>

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 describe_html(&self, _: FaceId) -> Result<Html, InternalError>

impl OutlineTrait for Item

fn outline_path(&self, scale: f64) -> Result<Html, InternalError>

fn surround_path(&self) -> Result<Html, InternalError>

fn thresh_dragraise(&self) -> Result<Option<i32>, InternalError>

fn bbox_approx(&self) -> Result<RectC<i32>, InternalError>

fn shape(&self) -> Option<Shape>

impl PieceBaseTrait for Item

fn nfaces(&self) -> u8

By convention, occult face is nfaces-1

fn itemname(&self) -> &str

impl PieceTrait for Item

fn svg_piece( &self, f: &mut Html, gpc: &GPiece, _gs: &GameState, vpid: VisiblePieceId, ) -> Result<(), InternalError>

fn describe_html( &self, gpc: &GPiece, _goccults: &GOccults, ) -> Result<Html, InternalError>

fn sortkey(&self) -> Option<&str>

fn add_ui_operations( &self, _y: ShowUnocculted, _upd: &mut Vec<UoDescription>, _gs: &GameState, _gpc: &GPiece, ) -> Result<(), InternalError>

fn ui_operation( &self, _y: ShowUnocculted, _a: ApiPieceOpArgs<'_>, _opname: &str, _wrc: WhatResponseToClientOp, ) -> Result<OpOutcomeThunkGeneric<(PlayerId, PieceId), (PieceUpdate, Vec<Box<dyn for<'r> FnOnce(&'r mut PrepareUpdatesBuffer<'_>)>>), ApiPieceOpError>, ApiPieceOpError>

fn ui_permit_flip(&self, _gpc: &GPiece) -> Result<bool, ApiPieceOpError>

Can return false to mean “I will handle it in ui_operation”

fn held_change_hook( &self, _ig: &InstanceRef, _gplayers: &DenseSlotMap<PlayerId, GPlayer>, _ipieces: &IPieces, _goccults: &GOccults, _gpieces: &mut GPieces, _tpiece: PieceId, _was_held: Option<PlayerId>, ) -> Result<OpOutcomeThunkGeneric<(PlayerId,), Vec<Box<dyn for<'r> FnOnce(&'r mut PrepareUpdatesBuffer<'_>)>>, InternalError>, InternalError>

Piece is responsible for dealing with the possibility that they may be occulted!

fn save_reloaded_hook( &self, _piece: PieceId, _gs: &mut GameState, _ig: &InstanceRef, ) -> Result<(), InternalError>

fn loaded_hook_preview(&self, _gpc: &mut GPiece) -> Result<(), InternalError>

fn bbox_preview(&self) -> Result<RectC<i32>, InternalError>

fn delete_hook( &self, _p: &GPiece, _gs: &mut GameState, ) -> ExecuteGameChangeUpdates

Not called if the whole game is destroyed. You can use Drop of course but it’s not usually much use since you don’t have a reference to the game or anything.

fn occultation_notify_hook( &self, _piece: PieceId, ) -> Vec<Box<dyn for<'r> FnOnce(&'r mut PrepareUpdatesBuffer<'_>)>>

fn op_multigrab( &self, _a: ApiPieceOpArgs<'_>, _show: ShowUnocculted, _qty: u32, _new_z: ShouldSetZLevel, ) -> Result<OpOutcomeThunkGeneric<(PlayerId, PieceId), (PieceUpdate, Vec<Box<dyn for<'r> FnOnce(&'r mut PrepareUpdatesBuffer<'_>)>>), ApiPieceOpError>, ApiPieceOpError>

fn abs_bbox(&self, p: &GPiece) -> Result<RectC<i32>, InternalError>

impl Serialize for Item

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.