Struct de_objects::cannon::LaserCharge

pub struct LaserCharge {
    charge_time: Duration,
    discharge_time: Duration,
    charge: f32,
}

Charge of a laser cannon. It is used to keep track of needed cannon charging time.

A laser cannon cannot fire immediately after it is activated, but takes time to charge. After firing, it has to (re)charge. It has to recharge after it any (re)activation.

Self::tick must be called during every frame. After that, Self::hold or Self::fire must be called in a loop while Self::charged returns true.

LaserTimer implements total ordering based on elapsed time since reaching charge for at least one fire.

Fields

charge_time: Duration

discharge_time: Duration

charge: f32

Implementations

impl LaserCharge

fn new(charge_time: Duration, discharge_time: Duration) -> Self

Returns a new timer.

Arguments

• charge_time - time it takes to fully (re)charge the laser cannon.

• discharge_time - time it takes to fully discharge the laser cannot if it is not actively charged.

Panics

Panics if charge_time or discharge_time spans zero time.

pub fn tick(&mut self, time_delta: Duration, charge: bool)

Updates the timer.

Arguments

• time_delta - time delta since last call to this method.

• charge - true if the cannon is charging, false if it is discharging.

pub fn charged(&self) -> bool

Returns true if the cannon is charged for at least one fire.

pub fn hold(&mut self)

Clamps charge to one fire.

Must be called after Self::tick.

pub fn fire(&mut self) -> bool

Subtracts one fire worth of charge and returns true if there is charge for another fire.

Must be called after Self::tick.

Trait Implementations

impl Clone for LaserCharge

fn clone(&self) -> LaserCharge

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Ord for LaserCharge

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for LaserCharge

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for LaserCharge

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for LaserCharge

impl StructuralPartialEq for LaserCharge