asobi_zone (asobi v0.72.6)

View Source

One spatial partition of an asobi_world_server. A gen_server that owns the entities in its cell of the grid, ticks their simulation, applies player input, manages interest (subscribers), and answers spatial queries via asobi_spatial. Zones are created and reaped lazily as players move.

Summary

Functions

add_entity(Pid, EntityId, EntityState)
cancel_entity_timer(Pid, EntityId, TimerId)
despawn_entity(Pid, EntityId)
get_entities(Pid)
get_subscriber_count(Pid)
handle_call/3
handle_cast/2
handle_continue/2
handle_info/2
init(Config)
player_input(Pid, PlayerId, Input)
query_radius(Pid, Center, Radius)
query_rect(Pid, TopLeft, BottomRight)
reap(Pid)
remove_entity(Pid, EntityId)
spawn_entities(Pid, Spawns)
spawn_entity(Pid, TemplateId, Pos)
spawn_entity(Pid, TemplateId, Pos, Overrides)
start_entity_timer(Pid, Config)
start_link(Config)
subscribe/2
sync(Pid)

Drain everything this caller has already cast to the zone, reporting whether the zone is still alive rather than exiting the caller if it is not.

terminate/2
tick(Pid, TickN)
unsubscribe(Pid, PlayerId)

Functions

add_entity(Pid, EntityId, EntityState)

-spec add_entity(pid(), binary(), map()) -> ok.

cancel_entity_timer(Pid, EntityId, TimerId)

-spec cancel_entity_timer(pid(), binary(), binary()) -> ok.

despawn_entity(Pid, EntityId)

-spec despawn_entity(pid(), binary()) -> ok.

get_entities(Pid)

-spec get_entities(pid()) -> map().

get_subscriber_count(Pid)

-spec get_subscriber_count(pid()) -> non_neg_integer().

handle_call/3

-spec handle_call(term(), gen_server:from(), map()) -> {reply, term(), map()}.

handle_cast/2

-spec handle_cast(term(), map()) ->
                     {noreply, map()} | {noreply, map(), hibernate} | {stop, normal, map()}.

handle_continue/2

-spec handle_continue(init_zone_state, map()) -> {noreply, map()}.

handle_info/2

-spec handle_info(term(), map()) -> {noreply, map()}.

init(Config)

-spec init(map()) -> {ok, map(), {continue, init_zone_state}}.

player_input(Pid, PlayerId, Input)

-spec player_input(pid(), binary(), map()) -> ok.

query_radius(Pid, Center, Radius)

-spec query_radius(pid(), {number(), number()}, number()) -> [{binary(), {number(), number()}}].

query_rect(Pid, TopLeft, BottomRight)

-spec query_rect(pid(), {number(), number()}, {number(), number()}) ->
                    [{binary(), {number(), number()}}].

reap(Pid)

-spec reap(pid()) -> ok.

remove_entity(Pid, EntityId)

-spec remove_entity(pid(), binary()) -> ok.

spawn_entities(Pid, Spawns)

-spec spawn_entities(pid(), [{binary(), {number(), number()}, map()}]) -> ok.

spawn_entity(Pid, TemplateId, Pos)

-spec spawn_entity(pid(), binary(), {number(), number()}) -> ok.

spawn_entity(Pid, TemplateId, Pos, Overrides)

-spec spawn_entity(pid(), binary(), {number(), number()}, map()) -> ok.

start_entity_timer(Pid, Config)

-spec start_entity_timer(pid(), map()) -> ok.

start_link(Config)

-spec start_link(map()) -> gen_server:start_ret().

subscribe/2

-spec subscribe(pid(), {binary(), pid()}) -> ok.

sync(Pid)

-spec sync(pid()) -> ok | zone_gone.

Drain everything this caller has already cast to the zone, reporting whether the zone is still alive rather than exiting the caller if it is not.

Callers that cast to a zone and then need the cast to have landed (the join and crossing paths in asobi_world_server) must not use a raw get_subscriber_count/1 for that: a zone reaped between the caller resolving its pid and the drain exits the caller with {normal, {gen_server, call, _}}, taking the whole world down over one player's placement (widgrensit/asobi#283). ok means every earlier cast from this process was processed; zone_gone means the zone died and those casts were dropped.

terminate/2

-spec terminate(term(), map()) -> ok.

tick(Pid, TickN)

-spec tick(pid(), non_neg_integer()) -> ok.

unsubscribe(Pid, PlayerId)

-spec unsubscribe(pid(), binary()) -> ok.