Annikka/evennia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix errors in wilderness contrib docs. Resolve #3144

Browse source
This commit is contained in:
Griatch 2023-03-23 23:31:29 +01:00
parent 819fb8272a
commit 0fe07a513f
4 changed files with 34 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

15
docs/source/Contribs/Contrib-Wilderness.md
View file

@ -19,11 +19,11 @@ with their own name. If no name is provided, then a default one is used. Interna
the wilderness is stored as a Script with the name you specify. If you don't the wilderness is stored as a Script with the name you specify. If you don't
specify the name, a script named "default" will be created and used. specify the name, a script named "default" will be created and used.
@py from evennia.contrib.grid import wilderness; wilderness.create_wilderness() py from evennia.contrib.grid import wilderness; wilderness.create_wilderness()
Once created, it is possible to move into that wilderness map: Once created, it is possible to move into that wilderness map:
@py from evennia.contrib.grid import wilderness; wilderness.enter_wilderness(me) py from evennia.contrib.grid import wilderness; wilderness.enter_wilderness(me)
All coordinates used by the wilderness map are in the format of `(x, y)` All coordinates used by the wilderness map are in the format of `(x, y)`
tuples. x goes from left to right and y goes from bottom to top. So `(0, 0)` tuples. x goes from left to right and y goes from bottom to top. So `(0, 0)`
@ -102,14 +102,21 @@ class PyramidMapProvider(wilderness.WildernessMapProvider):
desc = "This is a room in the pyramid." desc = "This is a room in the pyramid."
if y == 3 : if y == 3 :
desc = "You can see far and wide from the top of the pyramid." desc = "You can see far and wide from the top of the pyramid."
room.ndb.desc = desc room.ndb.active_desc = desc
``` ```
Note that the currently active description is stored as `.ndb.active_desc`. When
looking at the room, this is what will be pulled and shown.
> Exits on a room are always present, but locks hide those not used for a
> location. So make sure to `quell` if you are a superuser (since the superuser ignores
> locks, those exits will otherwise not be hidden)
Now we can use our new pyramid-shaped wilderness map. From inside Evennia we Now we can use our new pyramid-shaped wilderness map. From inside Evennia we
create a new wilderness (with the name "default") but using our new map provider: create a new wilderness (with the name "default") but using our new map provider:
py from world import pyramid as p; p.wilderness.create_wilderness(mapprovider=p.PyramidMapProvider()) py from world import pyramid as p; p.wilderness.create_wilderness(mapprovider=p.PyramidMapProvider())
py from evennia.contrib import wilderness; wilderness.enter_wilderness(me, coordinates=(4, 1)) py from evennia.contrib.grid import wilderness; wilderness.enter_wilderness(me, coordinates=(4, 1))
## Implementation details ## Implementation details

15
evennia/contrib/grid/wilderness/README.md
View file

@ -19,11 +19,11 @@ with their own name. If no name is provided, then a default one is used. Interna
the wilderness is stored as a Script with the name you specify. If you don't the wilderness is stored as a Script with the name you specify. If you don't
specify the name, a script named "default" will be created and used. specify the name, a script named "default" will be created and used.
@py from evennia.contrib.grid import wilderness; wilderness.create_wilderness() py from evennia.contrib.grid import wilderness; wilderness.create_wilderness()
Once created, it is possible to move into that wilderness map: Once created, it is possible to move into that wilderness map:
@py from evennia.contrib.grid import wilderness; wilderness.enter_wilderness(me) py from evennia.contrib.grid import wilderness; wilderness.enter_wilderness(me)
All coordinates used by the wilderness map are in the format of `(x, y)` All coordinates used by the wilderness map are in the format of `(x, y)`
tuples. x goes from left to right and y goes from bottom to top. So `(0, 0)` tuples. x goes from left to right and y goes from bottom to top. So `(0, 0)`
@ -102,14 +102,21 @@ class PyramidMapProvider(wilderness.WildernessMapProvider):
desc = "This is a room in the pyramid." desc = "This is a room in the pyramid."
if y == 3 : if y == 3 :
desc = "You can see far and wide from the top of the pyramid." desc = "You can see far and wide from the top of the pyramid."
room.ndb.desc = desc room.ndb.active_desc = desc
``` ```
Note that the currently active description is stored as `.ndb.active_desc`. When
looking at the room, this is what will be pulled and shown.
> Exits on a room are always present, but locks hide those not used for a
> location. So make sure to `quell` if you are a superuser (since the superuser ignores
> locks, those exits will otherwise not be hidden)
Now we can use our new pyramid-shaped wilderness map. From inside Evennia we Now we can use our new pyramid-shaped wilderness map. From inside Evennia we
create a new wilderness (with the name "default") but using our new map provider: create a new wilderness (with the name "default") but using our new map provider:
py from world import pyramid as p; p.wilderness.create_wilderness(mapprovider=p.PyramidMapProvider()) py from world import pyramid as p; p.wilderness.create_wilderness(mapprovider=p.PyramidMapProvider())
py from evennia.contrib import wilderness; wilderness.enter_wilderness(me, coordinates=(4, 1)) py from evennia.contrib.grid import wilderness; wilderness.enter_wilderness(me, coordinates=(4, 1))
## Implementation details ## Implementation details

17
evennia/contrib/grid/wilderness/wilderness.py
View file

@ -92,9 +92,16 @@ class PyramidMapProvider(wilderness.WildernessMapProvider):
desc = "This is a room in the pyramid." desc = "This is a room in the pyramid."
if y == 3 : if y == 3 :
desc = "You can see far and wide from the top of the pyramid." desc = "You can see far and wide from the top of the pyramid."
room.ndb.desc = desc room.ndb.active_desc = desc
``` ```
Note that the currently active description is stored as `.ndb.active_desc`. When
looking at the room, this is what will be pulled and shown.
> Exits on a room are always present, but locks hide those not used for a
> location. So make sure to `quell` if you are a superuser (since the superuser ignores
> locks, those exits will otherwise not be hidden)
Now we can use our new pyramid-shaped wilderness map. From inside Evennia we Now we can use our new pyramid-shaped wilderness map. From inside Evennia we
create a new wilderness (with the name "default") but using our new map provider: create a new wilderness (with the name "default") but using our new map provider:
@ -116,13 +123,7 @@ create a new wilderness (with the name "default") but using our new map provider
""" """
from evennia import ( from evennia import DefaultExit, DefaultRoom, DefaultScript, create_object, create_script
DefaultExit,
DefaultRoom,
DefaultScript,
create_object,
create_script,
)
from evennia.typeclasses.attributes import AttributeProperty from evennia.typeclasses.attributes import AttributeProperty
from evennia.utils import inherits_from from evennia.utils import inherits_from