Struct InterestConfig 

pub struct InterestConfig {
    pub tiers: Vec<InterestTier>,
    pub hysteresis: f32,
    pub stagger: bool,
}

Rings of interest, from near to far, plus how sticky their edges are. Entities beyond the last ring are not sent at all.

Defaults: everything within 40 units every tick, within 120 units every 4th tick, a hysteresis of 5 units, sends spread over ticks.

let c = ponko::InterestConfig::default();
assert_eq!(c.tiers.len(), 2);
assert_eq!(c.hysteresis, 5.0);

Fields

tiers: Vec<InterestTier>

1 to MAX_INTEREST_TIERS rings with increasing radii.

hysteresis: f32

An entity moves to a closer ring only once it is this far inside it, and to a farther ring (or out of interest) only once it is this far outside, so one standing on a boundary doesn’t flip back and forth. Less than the first radius.

stagger: bool

Spread the sends of slow rings over different ticks (by entity id), instead of every entity of a ring sending on the same tick.

Implementations

impl InterestConfig

pub fn validate(&self) -> Result<(), &'static str>

Checks the settings (what Interest::new panics about): 1 to MAX_INTEREST_TIERS tiers with positive, increasing radii and an every of at least 1, and a hysteresis from 0 up to (not including) the first radius.

use ponko::InterestConfig;
assert!(InterestConfig::default().validate().is_ok());
assert!(InterestConfig { tiers: vec![], ..Default::default() }.validate().is_err());

Trait Implementations

impl Clone for InterestConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InterestConfig

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

Formats the value using the given formatter.

impl Default for InterestConfig

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for InterestConfig

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for InterestConfig