Struct dfhack_remote::RemoteFortressReader

pub struct RemoteFortressReader<'a, TChannel>where
    TChannel: Channel,{
    pub channel: &'a mut TChannel,
}

RPC for the “RemoteFortressReader” plugin.

Fields

channel: &'a mut TChannel

Reference to the client to exchange messages.

Implementations

impl<'a, TChannel> RemoteFortressReader<'a, TChannel>where
    TChannel: Channel,

pub fn new(channel: &'a mut TChannel) -> RemoteFortressReader<'a, TChannel>

Initialize the plugin from a channel to DFHack.

pub fn check_hashes(&mut self) -> Result<(), <TChannel as Channel>::TError>

Method CheckHashes from the plugin RemoteFortressReader

pub fn copy_screen(
    &mut self
) -> Result<ScreenCapture, <TChannel as Channel>::TError>

Method CopyScreen from the plugin RemoteFortressReader

pub fn get_block_list(
    &mut self,
    request: BlockRequest
) -> Result<BlockList, <TChannel as Channel>::TError>

Method GetBlockList from the plugin RemoteFortressReader

pub fn get_building_def_list(
    &mut self
) -> Result<BuildingList, <TChannel as Channel>::TError>

Method GetBuildingDefList from the plugin RemoteFortressReader

pub fn get_creature_raws(
    &mut self
) -> Result<CreatureRawList, <TChannel as Channel>::TError>

Method GetCreatureRaws from the plugin RemoteFortressReader

pub fn get_game_validity(
    &mut self
) -> Result<bool, <TChannel as Channel>::TError>

Method GetGameValidity from the plugin RemoteFortressReader

pub fn get_growth_list(
    &mut self
) -> Result<MaterialList, <TChannel as Channel>::TError>

Method GetGrowthList from the plugin RemoteFortressReader

pub fn get_item_list(
    &mut self
) -> Result<MaterialList, <TChannel as Channel>::TError>

Method GetItemList from the plugin RemoteFortressReader

pub fn get_language(
    &mut self
) -> Result<Language, <TChannel as Channel>::TError>

Method GetLanguage from the plugin RemoteFortressReader

pub fn get_map_info(&mut self) -> Result<MapInfo, <TChannel as Channel>::TError>

Method GetMapInfo from the plugin RemoteFortressReader

pub fn get_material_list(
    &mut self
) -> Result<MaterialList, <TChannel as Channel>::TError>

Method GetMaterialList from the plugin RemoteFortressReader

pub fn get_partial_creature_raws(
    &mut self,
    request: ListRequest
) -> Result<CreatureRawList, <TChannel as Channel>::TError>

Method GetPartialCreatureRaws from the plugin RemoteFortressReader

pub fn get_partial_plant_raws(
    &mut self,
    request: ListRequest
) -> Result<PlantRawList, <TChannel as Channel>::TError>

Method GetPartialPlantRaws from the plugin RemoteFortressReader

pub fn get_pause_state(&mut self) -> Result<bool, <TChannel as Channel>::TError>

Method GetPauseState from the plugin RemoteFortressReader

pub fn get_plant_list(
    &mut self,
    request: BlockRequest
) -> Result<PlantList, <TChannel as Channel>::TError>

Method GetPlantList from the plugin RemoteFortressReader

pub fn get_plant_raws(
    &mut self
) -> Result<PlantRawList, <TChannel as Channel>::TError>

Method GetPlantRaws from the plugin RemoteFortressReader

pub fn get_region_maps(
    &mut self
) -> Result<RegionMaps, <TChannel as Channel>::TError>

Method GetRegionMaps from the plugin RemoteFortressReader

pub fn get_region_maps_new(
    &mut self
) -> Result<RegionMaps, <TChannel as Channel>::TError>

Method GetRegionMapsNew from the plugin RemoteFortressReader

pub fn get_reports(&mut self) -> Result<Status, <TChannel as Channel>::TError>

Method GetReports from the plugin RemoteFortressReader

pub fn get_side_menu(
    &mut self
) -> Result<SidebarState, <TChannel as Channel>::TError>

Method GetSideMenu from the plugin RemoteFortressReader

pub fn get_tiletype_list(
    &mut self
) -> Result<TiletypeList, <TChannel as Channel>::TError>

Method GetTiletypeList from the plugin RemoteFortressReader

pub fn get_unit_list(
    &mut self
) -> Result<UnitList, <TChannel as Channel>::TError>

Method GetUnitList from the plugin RemoteFortressReader

pub fn get_unit_list_inside(
    &mut self,
    request: BlockRequest
) -> Result<UnitList, <TChannel as Channel>::TError>

Method GetUnitListInside from the plugin RemoteFortressReader

pub fn get_version_info(
    &mut self
) -> Result<VersionInfo, <TChannel as Channel>::TError>

Method GetVersionInfo from the plugin RemoteFortressReader

pub fn get_view_info(
    &mut self
) -> Result<ViewInfo, <TChannel as Channel>::TError>

Method GetViewInfo from the plugin RemoteFortressReader

pub fn get_world_map(
    &mut self
) -> Result<WorldMap, <TChannel as Channel>::TError>

Method GetWorldMap from the plugin RemoteFortressReader

pub fn get_world_map_center(
    &mut self
) -> Result<WorldMap, <TChannel as Channel>::TError>

Method GetWorldMapCenter from the plugin RemoteFortressReader

pub fn get_world_map_new(
    &mut self
) -> Result<WorldMap, <TChannel as Channel>::TError>

Method GetWorldMapNew from the plugin RemoteFortressReader

pub fn jump_command(
    &mut self,
    request: MoveCommandParams
) -> Result<(), <TChannel as Channel>::TError>

Method JumpCommand from the plugin RemoteFortressReader

pub fn menu_query(
    &mut self
) -> Result<MenuContents, <TChannel as Channel>::TError>

Method MenuQuery from the plugin RemoteFortressReader

pub fn misc_move_command(
    &mut self,
    request: MiscMoveParams
) -> Result<(), <TChannel as Channel>::TError>

Method MiscMoveCommand from the plugin RemoteFortressReader

pub fn move_command(
    &mut self,
    request: MoveCommandParams
) -> Result<(), <TChannel as Channel>::TError>

Method MoveCommand from the plugin RemoteFortressReader

pub fn movement_select_command(
    &mut self,
    value: i32
) -> Result<(), <TChannel as Channel>::TError>

Method MovementSelectCommand from the plugin RemoteFortressReader

pub fn pass_keyboard_event(
    &mut self,
    request: KeyboardEvent
) -> Result<(), <TChannel as Channel>::TError>

Method PassKeyboardEvent from the plugin RemoteFortressReader

pub fn reset_map_hashes(&mut self) -> Result<(), <TChannel as Channel>::TError>

Method ResetMapHashes from the plugin RemoteFortressReader

pub fn send_dig_command(
    &mut self,
    request: DigCommand
) -> Result<(), <TChannel as Channel>::TError>

Method SendDigCommand from the plugin RemoteFortressReader

pub fn set_pause_state(
    &mut self,
    value: bool
) -> Result<(), <TChannel as Channel>::TError>

Method SetPauseState from the plugin RemoteFortressReader

pub fn set_side_menu(
    &mut self,
    request: SidebarCommand
) -> Result<(), <TChannel as Channel>::TError>

Method SetSideMenu from the plugin RemoteFortressReader