Struct veloren_common::comp::buff::Buff

pub struct Buff {
    pub kind: BuffKind,
    pub data: BuffData,
    pub cat_ids: Vec<BuffCategory>,
    pub end_time: Option<Time>,
    pub start_time: Time,
    pub effects: Vec<BuffEffect>,
    pub source: BuffSource,
}

Actual de/buff. Buff can timeout after some time if time is Some. If time is None, Buff will last indefinitely, until removed manually (by some action, like uncursing).

Buff has a kind, which is used to determine the effects in a builder function.

To provide more classification info when needed, buff can be in one or more buff category.

Fields

kind: BuffKind

data: BuffData

cat_ids: Vec<BuffCategory>

end_time: Option<Time>

start_time: Time

effects: Vec<BuffEffect>

source: BuffSource

Implementations

impl Buff

pub fn new( kind: BuffKind, data: BuffData, cat_ids: Vec<BuffCategory>, source: BuffSource, time: Time, dest_info: DestInfo<'_>, source_mass: Option<&Mass>, ) -> Self

Builder function for buffs

pub fn elapsed(&self, time: Time) -> Secs

Calculate how much time has elapsed since the buff was applied

Trait Implementations

impl Clone for Buff

fn clone(&self) -> Buff

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Buff

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Buff

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Buff

fn eq(&self, other: &Self) -> 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 Buff

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 Serialize for Buff

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.