The Battle for Wesnoth  1.17.0-dev
Namespaces | Enumerations | Functions
orb_status.hpp File Reference
#include <memory>
#include <string>
Include dependency graph for orb_status.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces

 orb_status_helper
 

Enumerations

enum  orb_status {
  orb_status::unmoved, orb_status::disengaged, orb_status::moved, orb_status::partial,
  orb_status::allied, orb_status::enemy
}
 Corresponds to the colored orbs displayed above units' hp-bar and xp-bar. More...
 

Functions

bool orb_status_helper::prefs_show_orb (orb_status os)
 Wrapper for the various preferences::show_..._orb() methods, using the enum instead of exposing a separate function for each preference. More...
 
std::string orb_status_helper::get_orb_color (orb_status os)
 Wrapper for the various preferences::unmoved_color(), moved_color(), etc methods, using the enum instead of exposing a separate function for each preference. More...
 

Enumeration Type Documentation

◆ orb_status

enum orb_status
strong

Corresponds to the colored orbs displayed above units' hp-bar and xp-bar.

Enumerator
unmoved 

The unit still has full movement and all attacks available.

disengaged 

The unit can move but can't attack, and wouldn't be able to attack even if it was moved to a hex adjacent to an enemy.

moved 

All moves and possible attacks have been done.

partial 

There are still moves and/or attacks possible, but the unit doesn't fit in the "unmoved" status.

allied 

Belongs to a friendly side.

enemy 

Belongs to a non-friendly side; normally visualised by not displaying an orb.

Definition at line 23 of file orb_status.hpp.