Struct sulis_state::Effect

pub struct Effect {
    pub name: String,
    pub tag: String,
    pub ui_visible: bool,
    pub listeners: ChangeListenerList<Effect>,
    pub removal_listeners: ChangeListenerList<Effect>,
    // some fields omitted
}

Fields

name: String

tag: String

ui_visible: bool

listeners: ChangeListenerList<Effect>

removal_listeners: ChangeListenerList<Effect>

Implementations

impl Effect

pub fn load(
    data: EffectSaveState,
    new_index: usize,
    entities: &HashMap<usize, Rc<RefCell<EntityState>>>
) -> Result<Effect, Error>

pub fn new(
    name: &str,
    tag: &str,
    duration: ExtInt,
    bonuses: BonusList,
    deactivate_with_ability: Option<String>
) -> Effect

pub fn mark_for_removal(&mut self)

pub fn set_surface_for_area(
    &mut self,
    area: &str,
    points: &[Point],
    squares_to_fire_on_moved: u32,
    aura: Option<usize>
)

pub fn icon(&self) -> Option<&Icon>

pub fn set_icon(&mut self, icon: String, text: String)

pub fn set_owning_entity(&mut self, entity: usize)

pub fn is_surface(&self) -> bool

pub fn is_aura(&self) -> bool

pub fn surface(&self) -> Option<(&str, &Vec<Point>)>

pub fn deactivates_with(&self, id: &str) -> bool

pub fn callbacks(&self) -> Vec<Rc<CallbackData>>

pub fn add_callback(&mut self, cb: Rc<CallbackData>)

#[must_use]pub fn update_on_moved_in_surface(&mut self) -> Vec<(Rc<CallbackData>, usize)>

#[must_use]pub fn update(&mut self, millis_elapsed: u32) -> Vec<Rc<CallbackData>>

Updates the effect time. returns true if a round has elapsed

pub fn is_removal(&self) -> bool

pub fn name(&self) -> &str

pub fn bonuses(&self) -> &BonusList

pub fn duration_millis(&self) -> ExtInt

pub fn total_duration_rounds(&self) -> ExtInt

pub fn remaining_duration_rounds(&self) -> ExtInt