goto.h

Go to the documentation of this file.

/***********************************************************************
 Freeciv - Copyright (C) 1996 - A Kjeldberg, L Gregersen, P Unold
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2, or (at your option)
   any later version.
 
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.
***********************************************************************/
#ifndef FC__GOTO_H
#define FC__GOTO_H
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
struct pf_path;
struct tile;
struct unit;
struct unit_list;
 
enum goto_tile_state {
  GTS_TURN_STEP,
  GTS_MP_LEFT,
  GTS_EXHAUSTED_MP,
 
  GTS_COUNT
};
 
void init_client_goto(void);
void free_client_goto(void);
 
void enter_goto_state(struct unit_list *punits);
void exit_goto_state(void);
 
void goto_unit_killed(struct unit *punit);
 
bool goto_is_active(void);
bool goto_get_turns(int *min, int *max);
bool goto_tile_state(const struct tile *ptile, enum goto_tile_state *state,
                     int *turns, bool *waypoint);
bool goto_add_waypoint(void);
bool goto_pop_waypoint(void);
 
bool is_valid_goto_destination(const struct tile *ptile);
bool is_valid_goto_draw_line(struct tile *dest_tile);
 
void request_orders_cleared(struct unit *punit);
void send_goto_path(struct unit *punit, struct pf_path *path,
                    struct unit_order *last_order);
bool send_goto_tile(struct unit *punit, struct tile *ptile);
bool send_rally_tile(struct city *pcity, struct tile *ptile, bool persistent);
bool send_attack_tile(struct unit *punit, struct tile *ptile);
void send_patrol_route(void);
void send_goto_route(void);
void send_connect_route(enum unit_activity activity,
                        struct extra_type *tgt);
 
struct pf_path *path_to_nearest_allied_city(struct unit *punit);
struct tile *tile_before_end_path(struct unit *punit, struct tile *ptile);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* FC__GOTO_H */