ui-player.c File Reference

character screens and dumps More...

#include "angband.h"
#include "buildid.h"
#include "game-world.h"
#include "init.h"
#include "obj-curse.h"
#include "obj-desc.h"
#include "obj-gear.h"
#include "obj-info.h"
#include "obj-knowledge.h"
#include "obj-util.h"
#include "player.h"
#include "player-calcs.h"
#include "player-timed.h"
#include "player-util.h"
#include "store.h"
#include "ui-display.h"
#include "ui-entry.h"
#include "ui-entry-renderers.h"
#include "ui-history.h"
#include "ui-input.h"
#include "ui-menu.h"
#include "ui-object.h"
#include "ui-output.h"
#include "ui-player.h"

Data Structures
struct	panel_line
	Panel utilities More...
struct	panel
	Panel holder type. More...
struct	char_sheet_resist
	Cache the layout of the character sheet, currently only for the resistance panel, since it is no longer hardwired. More...
struct	char_sheet_config

Macros
#define	BOUND(x, min, max)   MIN(max, MAX(min, x))
#define	INFO_SCREENS   2 /* Number of screens in character info mode */

Functions
static struct panel *	panel_allocate (int n)
	Allocate some panel lines. More...
static void	panel_free (struct panel *p)
	Free up panel lines. More...
static void	panel_line (struct panel *p, byte attr, const char *label, const char *fmt,...)
	Add a new line to the panel. More...
static void	panel_space (struct panel *p)
	Add a spacer line in a panel. More...
static void	display_resistance_panel (int ipart, struct char_sheet_config *config)
static bool	have_valid_char_sheet_config (void)
static void	release_char_sheet_config (void)
static bool	check_for_two_categories (const struct ui_entry *entry, void *closure)
static void	configure_char_sheet (void)
static const char *	likert (int x, int y, byte *attr)
	Returns a "rating" of x depending on y, and sets "attr" to the corresponding "attribute". More...
static void	display_player_equippy (int y, int x)
	Equippy chars. More...
static void	display_player_flag_info (void)
void	display_player_stat_info (void)
	Special display, part 2b. More...
static void	display_player_sust_info (struct char_sheet_config *config)
	Special display, part 2c. More...
static void	display_panel (const struct panel *p, bool left_adj, const region *bounds)
static const char *	show_title (void)
static const char *	show_adv_exp (void)
static const char *	show_depth (void)
static const char *	show_speed (void)
static byte	max_color (int val, int max)
static struct panel *	get_panel_topleft (void)
static struct panel *	get_panel_midleft (void)
static struct panel *	get_panel_combat (void)
static struct panel *	get_panel_skills (void)
static struct panel *	get_panel_misc (void)
void	display_player_xtra_info (void)
void	display_player (int mode)
	Display the character on the screen (two different modes) More...
void	write_character_dump (ang_file *fff)
	Write a character dump. More...
bool	dump_save (const char *path)
	Save the lore to a file in the user directory. More...
void	do_cmd_change_name (void)
	Hack – change name. More...
static void	init_ui_player (void)
static void	cleanup_ui_player (void)

Variables
static struct char_sheet_config *	cached_config = NULL
static const byte	colour_table []
	Colours for table items. More...
struct {
region   bounds
bool   align_left
struct panel *(*   panel )(void)
}	panels []
	Panels for main character screen. More...
struct init_module	ui_player_module

Detailed Description

character screens and dumps

Copyright (c) 1997 Ben Harrison, James E. Wilson, Robert A. Koeneke

This work is free software; you can redistribute it and/or modify it under the terms of either:

a) the GNU General Public License as published by the Free Software Foundation, version 2, or

b) the "Angband licence": This software may be copied and distributed for educational, research, and not for profit purposes provided that this copyright and statement are included in all such copies. Other copyrights may also apply.

Macro Definition Documentation

BOUND

#define BOUND	(		x,
			min,
			max
	)		MIN(max, MAX(min, x))

Referenced by get_panel_skills().

INFO_SCREENS

#define INFO_SCREENS   2 /* Number of screens in character info mode */

Referenced by do_cmd_change_name().

Function Documentation

check_for_two_categories()

static bool check_for_two_categories ( const struct ui_entry *  entry, void *  closure  )

static

References categories, and ui_entry_has_category().

Referenced by configure_char_sheet().

cleanup_ui_player()

static void cleanup_ui_player ( void  )

static

References release_char_sheet_config().

configure_char_sheet()

static void configure_char_sheet ( void  )

static

References advance_ui_entry_iterator(), player::body, check_for_two_categories(), region::col, player_body::count, count_ui_entry_iterator(), char_sheet_resist::entry, get_ui_entry_label(), i, initialize_ui_entry_iterator(), char_sheet_resist::label, mem_alloc(), ui_entry_iterator::n, char_sheet_config::n_resist_by_region, char_sheet_config::n_stat_mod_entries, region::page_rows, release_char_sheet_config(), release_ui_entry_iterator(), char_sheet_config::res_cols, char_sheet_config::res_nlabel, char_sheet_config::res_regions, char_sheet_config::res_rows, char_sheet_config::resists_by_region, region::row, STAT_MAX, char_sheet_config::stat_mod_entries, text_mbstowcs(), void(), and region::width.

Referenced by display_player().

display_panel()

static void display_panel ( const struct panel *  p, bool  left_adj, const region *  bounds  )

static

References panel_line::attr, region::col, COLOUR_WHITE, i, panel_line::label, panel::len, panel::lines, pl, region_erase(), region::row, row, Term_putstr(), panel_line::value, w, and region::width.

Referenced by display_player(), and display_player_xtra_info().

display_player()

void display_player

(

int

mode

)

Display the character on the screen (two different modes)

The top two lines, and the bottom line (or two) are left blank.

Mode 0 = standard display with skills/history Mode 1 = special display with equipment flags

References align_left, angband_term, bounds, clear_from(), configure_char_sheet(), display_panel(), display_player_flag_info(), display_player_stat_info(), display_player_sust_info(), display_player_xtra_info(), have_valid_char_sheet_config(), p, panel_free(), panels, player_upkeep::playing, Term, and player::upkeep.

Referenced by death_info(), do_cmd_change_name(), roller_command(), textui_do_birth(), update_player0_subwindow(), update_player1_subwindow(), and write_character_dump().

display_player_equippy()

static void display_player_equippy ( int  y, int  x  )

static

Equippy chars.

References player::body, player_body::count, i, object_attr(), object_char(), slot_object(), Term_putch(), tile_height, and tile_width.

Referenced by display_resistance_panel().

display_player_flag_info()

static void display_player_flag_info ( void  )

static

References display_resistance_panel(), and i.

Referenced by display_player().

display_player_stat_info()

void display_player_stat_info

(

void

)

Special display, part 2b.

References buf, player_class::c_adj, c_put_str(), player::class, cnv_stat(), COLOUR_L_BLUE, COLOUR_L_GREEN, COLOUR_WHITE, COLOUR_YELLOW, i, put_str(), player_race::r_adj, player::race, row, player_state::stat_add, player::stat_cur, STAT_MAX, player::stat_max, stat_names, stat_names_reduced, player_state::stat_top, player_state::stat_use, player::state, and strnfmt().

Referenced by display_player(), point_based_start(), and point_based_stats().

display_player_sust_info()

static void display_player_sust_info ( struct char_sheet_config *  config )

static

Special display, part 2c.

Display stat modifiers from equipment and sustains. Colors and symbols are configured from ui_entry.txt and ui_entry_renderers.txt. Other configuration that's possible there (extra characters for each number for instance) aren't well handled here - the assumption is just one digit for each equipment slot.

References ui_entry_details::alternate_color_first, player::body, c_put_str(), COLOUR_WHITE, ui_entry_details::combined_position, compute_ui_entry_values_for_object(), compute_ui_entry_values_for_player(), player_body::count, get_ui_entry_renderer_index(), i, ui_entry_details::known_rune, ui_entry_details::label_position, loc(), mem_alloc(), mem_free(), mem_zalloc(), char_sheet_config::n_stat_mod_entries, ui_entry_details::position_step, release_cached_object_data(), release_cached_player_data(), row, ui_entry_details::show_combined, slot_object(), char_sheet_config::stat_mod_entries, ui_entry_renderer_apply(), ui_entry_details::value_position, ui_entry_details::vertical_label, loc::x, and loc::y.

Referenced by display_player().

display_player_xtra_info()

void display_player_xtra_info

(

void

)

References align_left, bounds, COLOUR_WHITE, display_panel(), player::history, i, N_ELEMENTS, p, panel_free(), panels, Term_gotoxy(), text_out_indent, text_out_to_screen(), and text_out_wrap.

Referenced by display_player(), point_based_misc(), and point_based_start().

display_resistance_panel()

static void display_resistance_panel ( int  ipart, struct char_sheet_config *  config  )

static

References ui_entry_details::alternate_color_first, player::body, region::col, COLOUR_WHITE, ui_entry_details::combined_position, compute_ui_entry_values_for_object(), compute_ui_entry_values_for_player(), player_body::count, display_player_equippy(), char_sheet_resist::entry, get_ui_entry_renderer_index(), i, is_ui_entry_for_known_rune(), ui_entry_details::known_rune, char_sheet_resist::label, ui_entry_details::label_position, loc(), mem_alloc(), mem_free(), mem_zalloc(), char_sheet_config::n_resist_by_region, ui_entry_details::position_step, release_cached_object_data(), release_cached_player_data(), char_sheet_config::res_cols, char_sheet_config::res_nlabel, char_sheet_config::res_regions, char_sheet_config::resists_by_region, region::row, row, ui_entry_details::show_combined, slot_object(), Term_putstr(), ui_entry_renderer_apply(), ui_entry_details::value_position, ui_entry_details::vertical_label, loc::x, and loc::y.

Referenced by display_player_flag_info().

do_cmd_change_name()

void do_cmd_change_name

(

void

)

Hack – change name.

References arg_force_name, ARROW_LEFT, ARROW_RIGHT, buf, mouseclick::button, keypress::code, COLOUR_WHITE, display_player(), dump_save(), ESCAPE, EVENT_MESSAGE_FLUSH, event_signal(), EVT_BUTTON, EVT_KBRD, EVT_MOUSE, player::full_name, get_character_name(), get_file, INFO_SCREENS, inkey_ex(), ui_event::key, ui_event::mouse, msg, my_strcat(), my_strcpy(), p, player_safe_name(), screen_load(), screen_save(), Term_putstr(), and ui_event::type.

Referenced by store_process_command_key().

dump_save()

bool dump_save

(

const char *

path

)

Save the lore to a file in the user directory.

Parameters

path	is the path to the filename

Returns

true on success, false otherwise.

References msg, text_lines_to_file(), and write_character_dump().

Referenced by death_file(), and do_cmd_change_name().

get_panel_combat()

static struct panel* get_panel_combat ( void  )

static

References player_state::ac, BTH_PLUS_ADJ, COLOUR_L_BLUE, object::dd, object::ds, equipped_item_by_slot_name(), object::known, player::known_state, player_state::num_blows, player_state::num_shots, p, panel_allocate(), panel_line(), panel_space(), SKILL_TO_HIT_BOW, SKILL_TO_HIT_MELEE, player_state::skills, player::state, player_state::to_a, player_state::to_d, object::to_d, player_state::to_h, and object::to_h.

get_panel_midleft()

static struct panel* get_panel_midleft ( void  )

static

References panel_line::attr, player::au, COLOUR_L_GREEN, COLOUR_L_RED, player::exp, player::lev, max_color(), player::max_exp, player::max_lev, p, panel_allocate(), panel_line(), panel_space(), show_adv_exp(), show_depth(), player_upkeep::total_weight, player::upkeep, and weight_remaining().

get_panel_misc()

static struct panel* get_panel_misc ( void  )

static

References player::age, panel_line::attr, COLOUR_L_BLUE, player::ht, p, panel_allocate(), panel_line(), player::resting_turn, player::total_energy, turn, and player::wt.

get_panel_skills()

static struct panel* get_panel_skills ( void  )

static

References panel_line::attr, BOUND, cave, COLOUR_L_GREEN, COLOUR_L_UMBER, colour_table, chunk::depth, desc, likert(), p, panel_allocate(), panel_line(), player_state::see_infra, show_speed(), SKILL_DEVICE, SKILL_DISARM_MAGIC, SKILL_DISARM_PHYS, SKILL_SAVE, SKILL_SEARCH, SKILL_STEALTH, player_state::skills, player_state::speed, player::state, and player::timed.

get_panel_topleft()

static struct panel* get_panel_topleft ( void  )

static

References player::chp, player::class, COLOUR_L_BLUE, player::csp, player::full_name, player::mhp, player::msp, player_race::name, player_class::name, p, panel_allocate(), panel_line(), player::race, and show_title().

have_valid_char_sheet_config()

static bool have_valid_char_sheet_config ( void  )

static

References player::body, player_body::count, char_sheet_config::res_cols, and char_sheet_config::res_nlabel.

Referenced by display_player().

init_ui_player()

static void init_ui_player ( void  )

static

likert()

static const char* likert ( int  x, int  y, byte *  attr  )

static

Returns a "rating" of x depending on y, and sets "attr" to the corresponding "attribute".

References COLOUR_L_GREEN, COLOUR_RED, and COLOUR_YELLOW.

Referenced by get_panel_skills().

max_color()

static byte max_color ( int  val, int  max  )

static

References COLOUR_L_GREEN, and COLOUR_YELLOW.

Referenced by get_panel_midleft().

panel_allocate()

static struct panel* panel_allocate ( int  n )

static

Allocate some panel lines.

References panel::len, panel::lines, panel::max, mem_zalloc(), and p.

Referenced by get_panel_combat(), get_panel_midleft(), get_panel_misc(), get_panel_skills(), and get_panel_topleft().

panel_free()

static void panel_free ( struct panel *  p )

static

Free up panel lines.

References panel::lines, and mem_free().

Referenced by display_player(), and display_player_xtra_info().

panel_line()

static void panel_line ( struct panel *  p, byte  attr, const char *  label, const char *  fmt,   ...  )

static

Add a new line to the panel.

References panel_line::attr, panel_line::label, panel::len, panel::lines, panel::max, pl, panel_line::value, and vstrnfmt().

Referenced by get_panel_combat(), get_panel_midleft(), get_panel_misc(), get_panel_skills(), and get_panel_topleft().

panel_space()

static void panel_space ( struct panel *  p )

static

Add a spacer line in a panel.

References panel::len, and panel::max.

Referenced by get_panel_combat(), and get_panel_midleft().

release_char_sheet_config()

static void release_char_sheet_config ( void  )

static

References i, mem_free(), char_sheet_config::resists_by_region, and char_sheet_config::stat_mod_entries.

Referenced by cleanup_ui_player(), and configure_char_sheet().

show_adv_exp()

static const char* show_adv_exp ( void  )

static

References buffer, player::expfact, player::lev, player_exp, PY_MAX_LEVEL, and strnfmt().

Referenced by get_panel_midleft().

show_depth()

static const char* show_depth ( void  )

static

References buffer, player::max_depth, and strnfmt().

Referenced by get_panel_midleft().

show_speed()

static const char* show_speed ( void  )

static

References buffer, extract_energy, multiplier, OPT, player_state::speed, player::state, strnfmt(), and player::timed.

Referenced by get_panel_skills().

show_title()

static const char* show_title ( void  )

static

References player::class, player::lev, PY_MAX_LEVEL, player_class::title, player::total_winner, and player::wizard.

Referenced by get_panel_topleft().

write_character_dump()

void write_character_dump

(

ang_file *

fff

)

Write a character dump.

References player::body, buf, buildid, player_body::count, player::died_from, display_player(), dump_history(), file_putf(), format(), gear_to_label(), i, I2A, player_upkeep::inven, player::is_dead, mem_free(), mem_zalloc(), message_str(), messages_num(), char_sheet_config::n_resist_by_region, object_desc(), object_info_chardump(), ODESC_FULL, ODESC_PREFIX, OP_BIRTH, OP_INTERFACE, OP_MAX, player_options::opt, option_desc(), option_name(), option_type(), player::opts, p, angband_constants::pack_size, player_upkeep::quiver, angband_constants::quiver_size, char_sheet_config::res_cols, char_sheet_config::res_regions, region::row, slot_object(), store::stock_num, STORE_HOME, angband_constants::store_inven_max, store_stock_list(), stores, Term_what(), player::upkeep, void(), and z_info.

Referenced by dump_save().

Variable Documentation

align_left

bool align_left

Referenced by display_player(), and display_player_xtra_info().

bounds

region bounds

Referenced by display_player(), and display_player_xtra_info().

cached_config

struct char_sheet_config* cached_config = NULL

static

colour_table

const byte colour_table[]

static

Initial value:

=
{
    COLOUR_RED, COLOUR_RED, COLOUR_RED, COLOUR_L_RED, COLOUR_ORANGE,
    COLOUR_YELLOW, COLOUR_YELLOW, COLOUR_GREEN, COLOUR_GREEN, COLOUR_L_GREEN,
    COLOUR_L_BLUE
}

Colours for table items.

Referenced by get_panel_skills().

panel

struct panel*(* panel) (void)

Referenced by display_knowledge().

panels

const { ... } panels[]

Initial value:

=
{
    
    { {  1, 1, 40, 7 }, true,  get_panel_topleft }, 
    { { 21, 1, 18, 3 }, false, get_panel_misc },    
    { {  1, 9, 24, 9 }, false, get_panel_midleft }, 
    { { 29, 9, 19, 9 }, false, get_panel_combat },
    { { 52, 9, 20, 8 }, false, get_panel_skills },
}

Panels for main character screen.

Referenced by display_player(), and display_player_xtra_info().

ui_player_module

struct init_module ui_player_module

Initial value:

= {
    .name = "ui-player",
    .init = init_ui_player,
    .cleanup = cleanup_ui_player
}