Improving GMCP room data to include more data about exits (#306)

# Changes
* `coords` added for rooms with known coordinates.
* Non compass direction exit names excluded from exits list
* `exitsv2` data node added with more details about exits
  * target room `num`
  * `dx`, `dy`, `dz` delta directions of target room
  * `locked` true/false
  * `haskey` true/false
  * `haspickcombo` true/false

Author: Volte6

internal/hooks/RoomChange_LocationGMCPUpdates.go

@@ -7,6 +7,7 @@ import (
 
 	"github.com/volte6/gomud/internal/connections"
 	"github.com/volte6/gomud/internal/events"
+	"github.com/volte6/gomud/internal/mapper"
 	"github.com/volte6/gomud/internal/mudlog"
 	"github.com/volte6/gomud/internal/rooms"
 	"github.com/volte6/gomud/internal/users"
@@ -106,13 +107,36 @@ func LocationGMCPUpdates(e events.Event) events.ListenerReturn {
 		roomInfoStr.WriteString(`"area": "` + newRoom.Zone + `", `)
 		roomInfoStr.WriteString(`"environment": "` + newRoom.GetBiome().Name() + `", `)
 
+		// build coords
+		// room coordinates (string of numbers separated by commas - area,X,Y,Z)
+		// GoMud doesn't use numbers for areas, so will use string.
+		roomInfoStr.WriteString(`"coords": "` + newRoom.Zone + `, `)
+		m := mapper.GetZoneMapper(newRoom.Zone)
+		x, y, z, err := m.GetCoordinates(newRoom.RoomId)
+		if err != nil {
+			roomInfoStr.WriteString(`999999999999999999,999999999999999999,999999999999999999`)
+		} else {
+			roomInfoStr.WriteString(strconv.Itoa(x))
+			roomInfoStr.WriteString(`, `)
+			roomInfoStr.WriteString(strconv.Itoa(y))
+			roomInfoStr.WriteString(`, `)
+			roomInfoStr.WriteString(strconv.Itoa(z))
+		}
+		roomInfoStr.WriteString(`", `)
+		// end coords
+
 		// build exits
 		roomInfoStr.WriteString(`"exits": {`)
 		exitCt := 0
 		for name, exitInfo := range newRoom.Exits {
 			if exitInfo.Secret {
 				continue
 			}
+
+			if !mapper.IsCompassDirection(name) {
+				continue
+			}
+
 			if exitCt > 0 {
 				roomInfoStr.WriteString(`, `)
 			}
@@ -124,6 +148,56 @@ func LocationGMCPUpdates(e events.Event) events.ListenerReturn {
 		roomInfoStr.WriteString(`}, `)
 		// End exits
 
+		// build exits "extra" (exits that map to roomId AND include x/y/z delta information)
+		roomInfoStr.WriteString(`"exitsv2": {`)
+		exitCt = 0
+		deltaX, deltaY, deltaZ := 0, 0, 0
+		for name, exitInfo := range newRoom.Exits {
+
+			if exitInfo.Secret {
+				continue
+			}
+
+			if exitCt > 0 {
+				roomInfoStr.WriteString(`, `)
+			}
+
+			if len(exitInfo.MapDirection) > 0 {
+				deltaX, deltaY, deltaZ = mapper.GetDelta(exitInfo.MapDirection)
+			} else {
+				deltaX, deltaY, deltaZ = mapper.GetDelta(name)
+			}
+
+			roomInfoStr.WriteString(`"` + name + `": { "num": `)
+			roomInfoStr.WriteString(strconv.Itoa(exitInfo.RoomId))
+			roomInfoStr.WriteString(`, "dx": `)
+			roomInfoStr.WriteString(strconv.Itoa(deltaX))
+			roomInfoStr.WriteString(`, "dy": `)
+			roomInfoStr.WriteString(strconv.Itoa(deltaY))
+			roomInfoStr.WriteString(`, "dz": `)
+			roomInfoStr.WriteString(strconv.Itoa(deltaZ))
+
+			if exitInfo.HasLock() {
+				roomInfoStr.WriteString(`, "locked": true`)
+
+				lockId := fmt.Sprintf(`%d-%s`, newRoom.RoomId, name)
+
+				hasKey, hasSequence := user.Character.HasKey(lockId, int(exitInfo.Lock.Difficulty))
+
+				roomInfoStr.WriteString(`, "haskey": `)
+				roomInfoStr.WriteString(strconv.FormatBool(hasKey))
+
+				roomInfoStr.WriteString(`, "haspickcombo": `)
+				roomInfoStr.WriteString(strconv.FormatBool(hasSequence))
+			}
+
+			roomInfoStr.WriteString(`}`)
+
+			exitCt++
+		}
+		roomInfoStr.WriteString(`}, `)
+		// End exits
+
 		// build details
 		roomInfoStr.WriteString(`"details": [`)
 

internal/mapper/mapper.go

@@ -24,6 +24,19 @@ var (
 	ErrOutOfBounds  = errors.New(`out of bounds`)
 	ErrRoomNotFound = errors.New(`room not found`)
 
+	compassDirections = map[string]struct{}{
+		"north":     struct{}{},
+		"south":     struct{}{},
+		"west":      struct{}{},
+		"east":      struct{}{},
+		"northwest": struct{}{},
+		"northeast": struct{}{},
+		"southwest": struct{}{},
+		"southeast": struct{}{},
+		"down":      struct{}{},
+		"up":        struct{}{},
+	}
+
 	// TODO: Refactor this and remove string identifier from room data.
 	posDeltas = map[string]positionDelta{
 		"north":     {0, -1, 0, '│'},
@@ -87,6 +100,18 @@ var (
 	mapperZoneCache = map[string]*mapper{}
 )
 
+func GetDelta(exitName string) (x, y, z int) {
+	if delta, ok := posDeltas[exitName]; ok {
+		return delta.x, delta.y, delta.z
+	}
+	return 0, 0, 0
+}
+
+func IsCompassDirection(exitName string) bool {
+	_, ok := compassDirections[exitName]
+	return ok
+}
+
 func GetDirectionDeltaNames() []string {
 	ret := []string{}
 	for name, _ := range posDeltas {