veloren_world/
index.rs

1use crate::{
2    Colors, Features,
3    layer::wildlife::{self, DensityFn, SpawnEntry},
4    site::{Site, economy::TradeInformation},
5};
6use common::{
7    assets::{AssetExt, AssetHandle},
8    store::Store,
9    trade::{SiteId, SitePrices},
10};
11use core::ops::Deref;
12use noise::{Fbm, MultiFractal, Perlin, SuperSimplex};
13use std::sync::Arc;
14
15const WORLD_COLORS_MANIFEST: &str = "world.style.colors";
16const WORLD_FEATURES_MANIFEST: &str = "world.features";
17
18pub struct Index {
19    pub seed: u32,
20    pub time: f32,
21    pub noise: Noise,
22    pub sites: Store<Site>,
23    pub trade: TradeInformation,
24    pub wildlife_spawns: Vec<(AssetHandle<SpawnEntry>, DensityFn)>,
25    colors: AssetHandle<Arc<Colors>>,
26    features: AssetHandle<Arc<Features>>,
27}
28
29/// An owned reference to indexed data.
30///
31/// The data are split out so that we can replace the colors without disturbing
32/// the rest of the index, while also keeping all the data within a single
33/// indirection.
34#[derive(Clone)]
35pub struct IndexOwned {
36    colors: Arc<Colors>,
37    features: Arc<Features>,
38    index: Arc<Index>,
39}
40
41impl Deref for IndexOwned {
42    type Target = Index;
43
44    fn deref(&self) -> &Self::Target { &self.index }
45}
46
47/// A shared reference to indexed data.
48///
49/// This is copyable and can be used from either style of index.
50#[derive(Clone, Copy)]
51pub struct IndexRef<'a> {
52    pub colors: &'a Colors,
53    pub features: &'a Features,
54    pub index: &'a Index,
55}
56
57impl Deref for IndexRef<'_> {
58    type Target = Index;
59
60    fn deref(&self) -> &Self::Target { self.index }
61}
62
63impl Index {
64    /// NOTE: Panics if the color manifest cannot be loaded.
65    pub fn new(seed: u32) -> Self {
66        let colors = Arc::<Colors>::load_expect(WORLD_COLORS_MANIFEST);
67        let features = Arc::<Features>::load_expect(WORLD_FEATURES_MANIFEST);
68        let wildlife_spawns = wildlife::spawn_manifest()
69            .into_iter()
70            .map(|(e, f)| (SpawnEntry::load_expect(e), f))
71            .collect();
72
73        Self {
74            seed,
75            time: 0.0,
76            noise: Noise::new(seed),
77            sites: Store::default(),
78            trade: Default::default(),
79            wildlife_spawns,
80            colors,
81            features,
82        }
83    }
84
85    pub fn colors(&self) -> impl Deref<Target = Arc<Colors>> + '_ { self.colors.read() }
86
87    pub fn features(&self) -> impl Deref<Target = Arc<Features>> + '_ { self.features.read() }
88
89    pub fn get_site_prices(&self, site_id: SiteId) -> Option<SitePrices> {
90        self.sites
91            .recreate_id(site_id)
92            .map(|i| self.sites.get(i))
93            .map(|s| s.economy.get_site_prices())
94    }
95}
96
97impl IndexOwned {
98    pub fn new(index: Index) -> Self {
99        let colors = index.colors.cloned();
100        let features = index.features.cloned();
101
102        Self {
103            index: Arc::new(index),
104            colors,
105            features,
106        }
107    }
108
109    /// NOTE: Callback is called only when colors actually have to be reloaded.
110    /// The server is responsible for making sure that all affected chunks are
111    /// reloaded; a naive approach will just regenerate every chunk on the
112    /// server, but it is possible that eventually we can find a better
113    /// solution.
114    ///
115    /// Ideally, this should be called about once per tick.
116    pub fn reload_if_changed<R>(&mut self, reload: impl FnOnce(&mut Self) -> R) -> Option<R> {
117        let reloaded = self.index.colors.reloaded_global() || self.index.features.reloaded_global();
118        reloaded.then(move || {
119            // Reload the fields from the asset handle, which is updated automatically
120            self.colors = self.index.colors.cloned();
121            self.features = self.index.features.cloned();
122            // Update wildlife spawns which is based on base_density in features
123            reload(self)
124        })
125    }
126
127    pub fn as_index_ref(&self) -> IndexRef {
128        IndexRef {
129            colors: &self.colors,
130            features: &self.features,
131            index: &self.index,
132        }
133    }
134}
135
136pub struct Noise {
137    pub cave_nz: SuperSimplex,
138    pub scatter_nz: SuperSimplex,
139    pub cave_fbm_nz: Fbm<Perlin>,
140}
141
142impl Noise {
143    fn new(seed: u32) -> Self {
144        Self {
145            cave_nz: SuperSimplex::new(seed + 0),
146            scatter_nz: SuperSimplex::new(seed + 1),
147            cave_fbm_nz: Fbm::new(seed + 2).set_octaves(5),
148        }
149    }
150}
veloren_world/index.rs

veloren_world/
index.rs
