navigator

Index Home Arana > Arana Architecture > Arana Daemons > navigator

This daemon manages the physical world of Arana - indoors and outdoors - by reading maps and tracking location state.  This daemon rendors maps of the physical world and manages movement through the world.

Messages Received and Processed

Messages Received and Processed

Specific Messages

MsgTag

Description

navigate.sharedesc

navigate.sharemap

navigate.areareset

navigate.movehere

attack

take-item

query-some-items

take-booty

query-some-booty


User Response Messages

MsgTag

Description

navigate.savefloornotes

navigate.savenotes

navigate.saveplacenotes

setarealabel

Misc messages (orphaned?)

gobdg

viewbdg

gofloor

viewfloor

goarea

viewarea

take-some-items

take-some-booty


Mouse Messages

Region

MsgTag

Description

map-select-area

map-select-area

Rempote Procedure Calls (RPC)

appmap-panleft

appmap-panleft

appmap-panright

appmap-panright

appmap-panup

appmap-panup

appmap-pandown

appmap-pandown

appmap-panhome

appmap-panhome

appmap-zoomin

appmap-zoomin

appmap-zoomout

appmap-zoomout

map-select-one

map-select-one

map-select-multi

map-select-multi

zoommapxy

zoommapxy

fullmapxy

fullmapxy

map-select-bdg

map-select-bdg


API Messages

MsgTag

Description

inside

Loads place content (if not already cached)

SEQUENCE cmd_nav_dm_view 160

navigator <- msg label= "inside";

END

outside

SEQUENCE cmd_nav_dm_view 170

navigator <- msg label= "outside";

END

setleader

SEQUENCE cmd_nav_leader 30

setting <- msg label= "setleader";

navigator <- msg label= "setleader";

END

dmnav

SEQUENCE cmd_nav_dm_view 30

navigator <- msg label= "dmnav";

END

pcnav

SEQUENCE cmd_nav_pc_view 30

navigator <- msg label= "pcnav";

END

fullview

SEQUENCE cmd_nav_dm_view 40

navigator <- msg label= "fullview";

END

SEQUENCE cmd_nav_pc_view 40

navigator <- msg label= "fullview";

END

describe

SEQUENCE cmd_nav_dm_view 50

navigator <- msg label= "describe";

END

SEQUENCE cmd_nav_pc_view 50

navigator <- msg label= "describe";

END

browse

SEQUENCE cmd_nav_dm_view 60

navigator <- msg label= "browse";

END

pickplace

SEQUENCE cmd_nav_dm_view 70

navigator <- msg label= "pickplace";

END

pickfloor

SEQUENCE cmd_nav_dm_view 80

navigator <- msg label= "pickfloor";

END

pickbdg

SEQUENCE cmd_nav_dm_view 90

navigator <- msg label= "pickbdg";

END

pickarea

SEQUENCE cmd_nav_dm_view 70

navigator <- msg label= "pickarea";

END

sharearea

SEQUENCE cmd_nav_dm_view 110

navigator <- msg label= "sharearea";

END

shareareamap

SEQUENCE cmd_nav_dm_view 120

navigator <- msg label= "shareareamap";

END

areareset

SEQUENCE cmd_nav_dm_view 130

navigator <- msg label= "areareset";

END

movehere

SEQUENCE cmd_nav_dm_view 160

navigator <- msg label= "movearea";

END

portalmove

SEQUENCE cmd_nav_dm_view 140

navigator <- msg label= "portalmove";

END

hexmove

DEPRECATED.

SEQUENCE cmd_nav_dm_view 150

navigator <- msg label= "hexmove";

END

displand

SEQUENCE cmd_nav_displand 150

navigator <- msg label= "displand";

END

dispmilieuland

SEQUENCE cmd_nav_dispmilieuland 150

navigator <- msg label= "dispmilieuland";

END

displandhexes

SEQUENCE cmd_nav_displandhexes 150

navigator <- msg label= "displand";

END

dispmilieulandhexes

SEQUENCE cmd_nav_dispmilieulandhexes 150

navigator <- msg label= "dispmilieuland";

END

landhexselect

SEQUENCE cmd_nav_landhexselect 150

navigator <- msg label= "landhexselect";

END

milieuhexselect

SEQUENCE cmd_nav_milieuhexselect 150

navigator <- msg label= "milieuhexselect";

END

landhexesselect

SEQUENCE cmd_nav_landhexesselect 150

navigator <- msg label= "landhexesselect";

END

milieuhexesselect

SEQUENCE cmd_nav_milieuhexesselect 150

navigator <- msg label= "milieuhexesselect";

END

dispmapbdg

SEQUENCE cmd_nav_dispmapbdg 150

navigator <- msg label= "dispmapbdg";

END

selectmapbdg

SEQUENCE cmd_nav_selectbdg 150

navigator <- msg label= "selectbdg";

END

dispmapareas

Are we missing 'details' here?

SEQUENCE cmd_nav_dispmap 150

navigator <- msg label= "dispmap";

END

selectmapareas

SEQUENCE cmd_nav_dispmap 150

navigator <- msg label= "dispmap";

END

getBuildingsMap

Action handler for API call (message command getBuildingsMap).

device Handle for communicating with user if necessary

map_id The PlaceMap id of the indoor map

buildings A list of building names inside the place to map (if empty, then all)

level The level to display (if 0, use primary level)

detail - May be empty set or contains: "interior", "label"

llx If ll & ur not 0, the lower left x value of box to display

lly If ll & ur not 0, the lower left y value of box to display

urx If ll & ur not 0, the upper right x value of box to display

ury If ll & ur not 0, the upper right y value of box to display

pixels Size of image, in pixels

cbdata key-value pairs to send back to calling app; if cbchannel is set, response is sent there; if cbrequest is set, that is response request (otherwiwse, getLandMapImageHexesCB the request)

@return true if request sent

SEQUENCE cmd_nav_getBuildingsMap 150

navigator <- msg label= "getBuildingsMap";

END

getBuildingAreasMap

Action handler for API call (message command getBuildingAreasMap).

&device Handle for communicating with user if necessary

map_id The PlaceMap id of the indoor map

building The name of the building containing the areas

level The level to display (if 0, use primary level)

areas A list of areas to draw

detail - May be empty set or contains: "label", "exits"

llx If ll & ur not 0, the lower left x value of box to display

lly If ll & ur not 0, the lower left y value of box to display

urx If ll & ur not 0, the upper right x value of box to display

ury If ll & ur not 0, the upper right y value of box to display

pixels Size of image, in pixels

cbdata key-value pairs to send back to calling app; if cbchannel is set, response is sent there; if cbrequest is set, that is response request (otherwiwse, getLandMapImageHexesCB the request)

@return true if request sent

SEQUENCE cmd_nav_getBuildingAreasMap 150

navigator <- msg label= "getBuildingAreasMap";

END

placemc

getLandMapImage

Draw the entireity of the defined landscape for Land record at land_id.

land_id - the Land record

milieu_id - the Milieu record; if provided, places from the milieu can be labelled

macrolevel - see Land class, default is 10 mile wide hexes

pixels - size of image, in pixels

cbdata - key-value pairs to send back to calling app; if cbchannel is set, response is sent there; if cbrequest is set, that is response request (otherwiwse, getLandMapImageCBis the request)

getLandMapImageAt

Draw a section of landscape for Land record at land_id.

land_id - the Land record

milieu_id - the Milieu record; if provided, places from the milieu can be labelled

x - center hex location at (x,y)

y - center hex location at (x,y)

macrolevel - see Land class, default is 10 mile wide hexes

radius - number of hexes around the starting hex

shape - general shape of the map to generate, values may be:  square (default), round (hex)

pixels - size of image, in pixels

cbdata - key-value pairs to send back to calling app; if cbchannel is set, response is sent there; if cbrequest is set, that is response request (otherwiwse, getLandMapImageAtCBis the request)

getLandMapImageHexes

Draw a section of landscape for Land record at land_id, specifically identified by the list of hexes provided.

land_id - the Land record

milieu_id - the Milieu record; if provided, places from the milieu can be labelled

hexes - a list of locations at (x,y)

macrolevel - see Land class, default is 10 mile wide hexes

radius - number of hexes around the starting hex

pixels - size of image, in pixels

cbdata - key-value pairs to send back to calling app; if cbchannel is set, response is sent there; if cbrequest is set, that is response request (otherwiwse, getLandMapImageHexesCB the request)