Allow multiple clients to share a map

[hydra-dragonfire.git] / doc / map.md

diff --git a/doc/map.md b/doc/map.md
index 26fd51a7e57ea2c25104fd8e30951c464d95ef03..9e857c55dc2679ff50b991f9d58663dce324a214 100644 (file)
--- a/doc/map.md
+++ b/doc/map.md
@@ -1,13 +1,10 @@
-# Map Component
+# Map interface
 Source code: [map.go](../map.go)
 
-Map handles the `blk_data` and `node_metas_changed` packets.
-Map may send `got_blks`, `deleted_blks` packets.
+A map stores mapblocks received from server. To be of any use, a map needs to be added to one or more clients. See [comp_map.md](comp_map.md) and [client.md](client.md).
 
 ## Functions
 
-`self:clear()`: Forget all blocks.
-
 `self:block(blkpos)`: Return the `map_blk` at `blkpos` as found in the `blk_data` packet (See [client_pkts.md](client_pkts.md)). `nil` if block is not present.
 
 `self:node(pos)`: Return a node in the form `{ param0 = 126, param1 = 0, param2 = 0, meta = { ... } }`. The meta field is a `node_meta` as found in the `blk_data` packet. `nil` if node is not present.