Skip to main content

PlayerAreaMap

Struct PlayerAreaMap 

Source
pub struct PlayerAreaMap {
    chunks: HashMap<ChunkPos, FxHashSet<i32>>,
    player_chunks: HashMap<i32, FxHashSet<ChunkPos>>,
}
Expand description

Spatial index for player proximity queries.

Uses packed ChunkPos chunk coordinates as keys for efficient hashing. Thread-safe via scc::HashMap for concurrent access.

The map maintains a dual index:

  • chunks: Maps chunk coords to players whose tracking area includes that chunk
  • player_chunks: Maps player entity IDs to the set of chunks they’re registered in

This enables O(1) lookup of nearby players and O(tracking area) removal.

Entity IDs are used instead of UUIDs because:

  • They are globally unique within a server session (vanilla uses a static atomic counter)
  • They are smaller (4 bytes vs 16 bytes) and faster to hash
  • PlayerAreaMap only tracks players during a session, not persisted

Fields§

§chunks: HashMap<ChunkPos, FxHashSet<i32>>

Maps packed chunk coords (ChunkPos) to set of player entity IDs

§player_chunks: HashMap<i32, FxHashSet<ChunkPos>>

Maps player entity ID to its current set of tracked chunks (for efficient removal)

Implementations§

Source§

impl PlayerAreaMap

Source

pub fn new() -> Self

Creates a new player area map.

Source

pub fn on_player_join(&self, player: &Player, view: &PlayerChunkView)

Registers a player at their current position using their chunk view.

Source

pub fn on_player_leave(&self, player: &Arc<Player>)

Removes a player from all tracked chunks.

Source

pub fn remove_by_entity_id(&self, entity_id: i32)

Removes a player from all tracked chunks by entity ID.

This is useful when you don’t have an Arc<Player> reference, such as during respawn cleanup.

Source

pub fn on_player_view_change( &self, entity_id: i32, added_chunks: &[ChunkPos], removed_chunks: &[ChunkPos], )

Updates a player’s tracked chunks using pre-computed view differences.

Call this after computing the difference via PlayerChunkView::difference().

Source

pub fn get_tracking_players(&self, chunk: ChunkPos) -> Vec<i32>

Gets all players tracking the given chunk.

Source

pub fn len(&self) -> usize

Returns the number of tracked players.

Source

pub fn is_empty(&self) -> bool

Returns true if no players are tracked.

Source

fn add_to_chunk(&self, chunk: ChunkPos, entity_id: i32)

Source

fn remove_from_chunk(&self, chunk: ChunkPos, entity_id: i32)

Trait Implementations§

Source§

impl Default for PlayerAreaMap

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoShared for T

Source§

fn into_shared(self) -> Arc<Mutex<RawMutex, Self>>

Wraps this value in an Arc<SyncMutex<>>
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more