CiaranG
/
people
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document some more things

master
Ciaran Gultnieks 2014-04-16 22:54:32 +01:00
parent aec9fa8e8c
commit 5b63d22167
1 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -185,6 +185,8 @@ Walks to the given position.
Walks to a named position - names are looked up using the areas module, if
present This converts to go, pos={x,y,z}, with name retained for reference.
Names are most frequently used in conjunction with footpaths.
#### follow, with name="playername"
Follows the given player indefinitely (or at least until they log off).
@ -343,8 +345,8 @@ Ultimately it won't use this 'feature' at all.
People (in particular via the 'go' action) have an in-built understanding of
footpaths, which are laid out across the map by players, usually using cobble
and cobble stairs (but wood can also be used, e.g. for bridges). In addition,
specially areas (via the areas mod) are used to 'mark up' routes along these
and cobble steps (but wood can also be used, e.g. for bridges). In addition,
special areas (via the areas mod) are used to 'mark up' routes along these
footpaths. This provides people with the ability to do sensible long-range
navigation as a player would.
@ -352,13 +354,19 @@ Path junctions are marked up by creating a 1x1x1 area above the junction
node. They are always named `path_xxxxx`, where `xxxxx` is the unique name for
that junction - e.g. `path_My House`.
When following a footpath, preference will always be given to the direction
currently being travelled in. The means that, for example, a cobblestone
footpath can cross a larger area 'paved' with cobblestone (or other footpath
materials), so long as the crossing is in a straight line.
Additionally, above each node leading away from the junction, a 1x1x1 area
with the name `to_xxxxx` is used. In this case, `xxxxx` is the name of the
path node this direction leads to - e.g. `to_Your House`.
Changes to the footpath network only take effect when the `/people footpath_update`
command is used. At this point, if anything is wrong with the network, this
will be indicated, and the previous network will remain in effect.
will be indicated, and the previous network will remain in effect. The current
network is saved across server restarts.
If you tell a person to go to a named place (e.g. {"go", name="My House"}) they
will first look for `path_My House`, and then also find the nearest path