Struct dfhack_proto::plugins::RemoteFortressReader

pub struct RemoteFortressReader<E, TProtocol: ProtocolTrait<E>> {
    pub protocol: Rc<RefCell<TProtocol>>,
    pub name: String,
    /* private fields */
}

RPC for the “RemoteFortressReader” plugin.

Fields

protocol: Rc<RefCell<TProtocol>>

Reference to the client to exchange messages.

name: String

Name of the plugin. All the RPC are attached to this name.

Implementations

impl<E, TProtocol: ProtocolTrait<E>> RemoteFortressReader<E, TProtocol>

pub fn new(protocol: Rc<RefCell<TProtocol>>) -> Self

Instanciate a new plugin instance

pub fn check_hashes(&mut self) -> Result<(), E>

Method CheckHashes from the plugin RemoteFortressReader

pub fn copy_screen(&mut self) -> Result<ScreenCapture, E>

Method CopyScreen from the plugin RemoteFortressReader

pub fn get_block_list(&mut self, request: BlockRequest) -> Result<BlockList, E>

Method GetBlockList from the plugin RemoteFortressReader

pub fn get_building_def_list(&mut self) -> Result<BuildingList, E>

Method GetBuildingDefList from the plugin RemoteFortressReader

pub fn get_creature_raws(&mut self) -> Result<CreatureRawList, E>

Method GetCreatureRaws from the plugin RemoteFortressReader

pub fn get_game_validity(&mut self) -> Result<bool, E>

Method GetGameValidity from the plugin RemoteFortressReader

pub fn get_growth_list(&mut self) -> Result<MaterialList, E>

Method GetGrowthList from the plugin RemoteFortressReader

pub fn get_item_list(&mut self) -> Result<MaterialList, E>

Method GetItemList from the plugin RemoteFortressReader

pub fn get_language(&mut self) -> Result<Language, E>

Method GetLanguage from the plugin RemoteFortressReader

pub fn get_map_info(&mut self) -> Result<MapInfo, E>

Method GetMapInfo from the plugin RemoteFortressReader

pub fn get_material_list(&mut self) -> Result<MaterialList, E>

Method GetMaterialList from the plugin RemoteFortressReader

pub fn get_partial_creature_raws(
    &mut self,
    request: ListRequest
) -> Result<CreatureRawList, E>

Method GetPartialCreatureRaws from the plugin RemoteFortressReader

pub fn get_partial_plant_raws(
    &mut self,
    request: ListRequest
) -> Result<PlantRawList, E>

Method GetPartialPlantRaws from the plugin RemoteFortressReader

pub fn get_pause_state(&mut self) -> Result<bool, E>

Method GetPauseState from the plugin RemoteFortressReader

pub fn get_plant_list(&mut self, request: BlockRequest) -> Result<PlantList, E>

Method GetPlantList from the plugin RemoteFortressReader

pub fn get_plant_raws(&mut self) -> Result<PlantRawList, E>

Method GetPlantRaws from the plugin RemoteFortressReader

pub fn get_region_maps(&mut self) -> Result<RegionMaps, E>

Method GetRegionMaps from the plugin RemoteFortressReader

pub fn get_region_maps_new(&mut self) -> Result<RegionMaps, E>

Method GetRegionMapsNew from the plugin RemoteFortressReader

pub fn get_reports(&mut self) -> Result<Status, E>

Method GetReports from the plugin RemoteFortressReader

pub fn get_side_menu(&mut self) -> Result<SidebarState, E>

Method GetSideMenu from the plugin RemoteFortressReader

pub fn get_tiletype_list(&mut self) -> Result<TiletypeList, E>

Method GetTiletypeList from the plugin RemoteFortressReader

pub fn get_unit_list(&mut self) -> Result<UnitList, E>

Method GetUnitList from the plugin RemoteFortressReader

pub fn get_unit_list_inside(
    &mut self,
    request: BlockRequest
) -> Result<UnitList, E>

Method GetUnitListInside from the plugin RemoteFortressReader

pub fn get_version_info(&mut self) -> Result<VersionInfo, E>

Method GetVersionInfo from the plugin RemoteFortressReader

pub fn get_view_info(&mut self) -> Result<ViewInfo, E>

Method GetViewInfo from the plugin RemoteFortressReader

pub fn get_world_map(&mut self) -> Result<WorldMap, E>

Method GetWorldMap from the plugin RemoteFortressReader

pub fn get_world_map_center(&mut self) -> Result<WorldMap, E>

Method GetWorldMapCenter from the plugin RemoteFortressReader

pub fn get_world_map_new(&mut self) -> Result<WorldMap, E>

Method GetWorldMapNew from the plugin RemoteFortressReader

pub fn jump_command(&mut self, request: MoveCommandParams) -> Result<(), E>

Method JumpCommand from the plugin RemoteFortressReader

pub fn menu_query(&mut self) -> Result<MenuContents, E>

Method MenuQuery from the plugin RemoteFortressReader

pub fn misc_move_command(&mut self, request: MiscMoveParams) -> Result<(), E>

Method MiscMoveCommand from the plugin RemoteFortressReader

pub fn move_command(&mut self, request: MoveCommandParams) -> Result<(), E>

Method MoveCommand from the plugin RemoteFortressReader

pub fn movement_select_command(&mut self, value: i32) -> Result<(), E>

Method MovementSelectCommand from the plugin RemoteFortressReader

pub fn pass_keyboard_event(&mut self, request: KeyboardEvent) -> Result<(), E>

Method PassKeyboardEvent from the plugin RemoteFortressReader

pub fn reset_map_hashes(&mut self) -> Result<(), E>

Method ResetMapHashes from the plugin RemoteFortressReader

pub fn send_dig_command(&mut self, request: DigCommand) -> Result<(), E>

Method SendDigCommand from the plugin RemoteFortressReader

pub fn set_pause_state(&mut self, value: bool) -> Result<(), E>

Method SetPauseState from the plugin RemoteFortressReader

pub fn set_side_menu(&mut self, request: SidebarCommand) -> Result<(), E>

Method SetSideMenu from the plugin RemoteFortressReader