Struct bwapi_wrapper::BWAPI_UnitInterface

#[repr(C)]pub struct BWAPI_UnitInterface {
    pub _base: BWAPI_Interface,
}

The Unit class is used to get information about individual units as well as issue orders to units.

Each unit in the game has a unique Unit object, and Unit objects are not deleted until the end of the match (so you don't need to worry about unit pointers becoming invalid).

Every Unit in the game is either accessible or inaccessible. To determine if an AI can access a particular unit, BWAPI checks to see if Flag::CompleteMapInformation is enabled. So there are two cases to consider - either the flag is enabled, or it is disabled:

If Flag::CompleteMapInformation is disabled, then a unit is accessible if and only if it is visible. @note Some properties of visible enemy units will not be made available to the AI (such as the contents of visible enemy dropships). If a unit is not visible, UnitInterface::exists will return false, regardless of whether or not the unit exists. This is because absolutely no state information on invisible enemy units is made available to the AI. To determine if an enemy unit has been destroyed, the AI must watch for AIModule::onUnitDestroy messages from BWAPI, which is only called for visible units which get destroyed.

If Flag::CompleteMapInformation is enabled, then all units that exist in the game are accessible, and UnitInterface::exists is accurate for all units. Similarly AIModule::onUnitDestroy messages are generated for all units that get destroyed, not just visible ones.

If a Unit is not accessible, then only the getInitial__ functions will be available to the AI. However for units that were owned by the player, getPlayer and getType will continue to work for units that have been destroyed.

@ingroup Interface

Fields

_base: BWAPI_Interface

Trait Implementations

impl Debug for BWAPI_UnitInterface

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for BWAPI_UnitInterface

fn default() -> Self

Returns the "default value" for a type.

impl Eq for BWAPI_UnitInterface

impl Hash for BWAPI_UnitInterface

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<BWAPI_UnitInterface> for BWAPI_UnitInterface

fn eq(&self, other: &BWAPI_UnitInterface) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &BWAPI_UnitInterface) -> bool

This method tests for !=.

impl StructuralEq for BWAPI_UnitInterface

impl StructuralPartialEq for BWAPI_UnitInterface