The Battle for Wesnoth  1.19.5+dev
drawing_layer.hpp
Go to the documentation of this file.
1 
2 /*
3  Copyright (C) 2003 - 2024
4  by David White <dave@whitevine.net>
5  Part of the Battle for Wesnoth Project https://www.wesnoth.org/
6 
7  This program is free software; you can redistribute it and/or modify
8  it under the terms of the GNU General Public License as published by
9  the Free Software Foundation; either version 2 of the License, or
10  (at your option) any later version.
11  This program is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY.
13 
14  See the COPYING file for more details.
15 */
16 
17 #pragma once
18 
19 enum class drawing_layer {
20  /** Terrain drawn behind the unit */
21  terrain_bg,
22 
23  /** Top half part of grid image */
24  grid_top,
25 
26  /** Mouseover overlay used by editor */
28 
29  /** Footsteps showing path from unit to mouse */
30  footsteps,
31 
32  /** Top half of image following the mouse */
34 
35  /** Reserve layers to be selected for wml. */
36  unit_first,
37 
38  /** Ellipse behind the unit. */
39  unit_bg = unit_first + 10,
40 
41  /** Default layer for drawing units */
42  unit_default = unit_first + 40,
43 
44  /** Terrain drawn in front of the unit */
45  terrain_fg = unit_first + 50,
46 
47  /** Bottom half part of grid image. Should be under moving units, to avoid masking south move */
49 
50  /** Default layer for drawing moving units */
52 
53  /** Ellipse in front of the unit */
54  unit_fg = unit_first + 80,
55 
56  /** Default layer for missile frames */
58 
59  unit_last = unit_first + 100,
60 
61  /** Overlay on unreachable hexes */
62  reachmap,
63 
64  /** Bottom half of image following the mouse */
66 
67  /** Fog and shroud. */
68  fog_shroud,
69 
70  /** Arrows from the arrows framework. Used for planned moves display */
71  arrows,
72 
73  /** Move numbering for the whiteboard */
75 
76  /** Image on the selected unit */
78 
79  /** Layer which holds the attack indicator */
81 
82  /** Unit bars and overlays are drawn on this layer (for testing here) */
83  unit_bar,
84 
85  /** Movement info (defense%, etc...) */
86  move_info,
87 
88  /** The overlay used for the linger mode */
90 
91  /** The border of the map */
92  border,
93 };
drawing_layer
@ border
The border of the map.
@ unit_fg
Ellipse in front of the unit.
@ unit_missile_default
Default layer for missile frames.
@ unit_bg
Ellipse behind the unit.
@ linger_overlay
The overlay used for the linger mode.
@ terrain_bg
Terrain drawn behind the unit.
@ reachmap
Overlay on unreachable hexes.
@ unit_bar
Unit bars and overlays are drawn on this layer (for testing here)
@ footsteps
Footsteps showing path from unit to mouse.
@ attack_indicator
Layer which holds the attack indicator.
@ grid_bottom
Bottom half part of grid image.
@ unit_default
Default layer for drawing units.
@ mouseover_top
Top half of image following the mouse.
@ mouseover_overlay
Mouseover overlay used by editor.
@ unit_first
Reserve layers to be selected for wml.
@ mouseover_bottom
Bottom half of image following the mouse.
@ terrain_fg
Terrain drawn in front of the unit.
@ move_info
Movement info (defense%, etc...)
@ fog_shroud
Fog and shroud.
@ actions_numbering
Move numbering for the whiteboard.
@ selected_hex
Image on the selected unit.
@ unit_move_default
Default layer for drawing moving units.
@ arrows
Arrows from the arrows framework.
@ grid_top
Top half part of grid image.