Follow module (#354)

# Description

This removes the old `follow` command and creates a new module called `follow` with extended functionality.

It also adds a `MobIdle{}` event that can be handled for when mobs are idle.

Mobs out of alignment with players won't let players follow them.

## Changes

- Added mob and user `follow` commands
  - Includes `unfollow`/`follow stop`, and `lose`/`follow lose`
- Players can now follow mobs, not just other players.
- Mobs can now follow players/mobs, a behavior that did not exist previously.
- Added helpfile, keywords, etc. into module
- Removed character `followers` slice and functions that use it.
- Adjusted listener adding logic for default "add to end" behavior
- mob commands now look for any keyword aliases that are defined to use.
- Fixed up some bugginess with keyword aliases that was appending a space to the end, causing things to break.
- Added `MobIdle{}` event and handlers. Moved some of the existing mob idle calculation to a new handler function.
- follow module abort MobIdle{} event if mob is in the middle of a follow behavior.

## Links

#348

Author: Volte6

_datafiles/world/default/keywords.yaml

@@ -87,7 +87,6 @@ help:
       - online
       - quit
     parties:
-      - follow
       - party
       - share
     locks:

_datafiles/world/default/mobs/frostfang/scripts/2-guard.js

@@ -9,6 +9,10 @@ var PathTargets = [
 
 function onIdle(mob, room) {
 
+    if ( mob.PathingAtWaypoint() && mob.IsHome() ) {
+        mob.SetAdjective("patrolling", false);
+    }
+
     var random = Math.floor(Math.random() * 10);
     switch (random) {
         case 0:
@@ -19,8 +23,10 @@ function onIdle(mob, room) {
         case 2:
             // Start a patrol path
             var randomPath = Math.floor(Math.random() * PathTargets.length);
-            var selectedPath = PathTargets[randomPath]
+            var selectedPath = PathTargets[randomPath];
+            mob.SetAdjective("patrolling", true);
             mob.Command("pathto "+selectedPath.join(' '));
+
             return true;
         case 3:
             // wander randomly.

_datafiles/world/empty/keywords.yaml

@@ -87,7 +87,6 @@ help:
       - online
       - quit
     parties:
-      - follow
       - party
       - share
     locks:

_datafiles/world/empty/templates/help/follow.template

@@ -85,7 +85,6 @@ type Character struct {
 	roomHistory      []int             // A stack FILO of the last X rooms the character has been in
 	PlayerDamage     map[int]int       `yaml:"-"` // key = who, value = how much
 	LastPlayerDamage uint64            `yaml:"-"` // last round a player damaged this character
-	followers        []int             // everyone following this user
 	permaBuffIds     []int             // Buff Id's that are always present for this character
 	userId           int               // User ID of the character if any
 }
@@ -532,10 +531,6 @@ func (c *Character) GetRandomItem() (items.Item, bool) {
 	return c.Items[util.Rand(len(c.Items))], true
 }
 
-func (c *Character) AddFollower(uId int) {
-	c.followers = append(c.followers, uId)
-}
-
 // USERNAME appears to be <BLANK>
 func (c *Character) GetHealthAppearance() string {
 
@@ -561,10 +556,6 @@ func (c *Character) GetHealthAppearance() string {
 	return fmt.Sprintf(`<ansi fg="username">%s</ansi> is in <ansi fg="%s">perfect health.</ansi>`, c.Name, className)
 }
 
-func (c *Character) GetFollowers() []int {
-	return append([]int{}, c.followers...)
-}
-
 func (c *Character) GetAllSkillRanks() map[string]int {
 	retMap := make(map[string]int)
 	for skillName, skillLevel := range c.Skills {

internal/characters/character.go

@@ -153,6 +153,13 @@ type NewTurn struct {
 
 func (n NewTurn) Type() string { return `NewTurn` }
 
+// Anytime a mob is idle
+type MobIdle struct {
+	MobInstanceId int
+}
+
+func (i MobIdle) Type() string { return `MobIdle` }
+
 // Gained or lost an item
 type EquipmentChange struct {
 	UserId        int
@@ -339,6 +346,8 @@ type Party struct {
 	Position      map[int]string
 }
 
+func (p Party) Type() string { return `Party` }
+
 type RedrawPrompt struct {
 	UserId        int
 	OnlyIfChanged bool

internal/events/eventtypes.go

@@ -91,16 +91,16 @@ func RegisterListener(emptyEvent any, cbFunc Listener, qFlag ...QueueFlag) Liste
 	} else if listenerDetails.isFinal {
 		eventListeners[eType] = append(eventListeners[eType], listenerDetails)
 
-	} else {
+	} else { // end of the list, but before any "final" listeners
 
 		insertPosition := 0
-		for idx := 0; idx < len(eventListeners[eType]); idx++ {
+
+		for idx := len(eventListeners[eType]) - 1; idx >= 0; idx-- {
 			// If we're looking at a "final" listener, we can't go any farther down the list
 			if !eventListeners[eType][idx].isFinal {
-				insertPosition = idx
-				continue
+				insertPosition = idx + 1
+				break
 			}
-			break
 		}
 
 		eventListeners[eType] = append(eventListeners[eType], ListenerWrapper{})

internal/events/listeners.go

@@ -0,0 +1,73 @@
+package hooks
+
+import (
+	"github.com/GoMudEngine/GoMud/internal/configs"
+	"github.com/GoMudEngine/GoMud/internal/events"
+	"github.com/GoMudEngine/GoMud/internal/mobcommands"
+	"github.com/GoMudEngine/GoMud/internal/mobs"
+	"github.com/GoMudEngine/GoMud/internal/rooms"
+	"github.com/GoMudEngine/GoMud/internal/scripting"
+	"github.com/GoMudEngine/GoMud/internal/util"
+)
+
+//
+// Handles default mob idle behavior
+//
+
+func HandleIdleMobs(e events.Event) events.ListenerReturn {
+
+	evt := e.(events.MobIdle)
+
+	mob := mobs.GetInstance(evt.MobInstanceId)
+	if mob == nil {
+		return events.Cancel
+	}
+
+	// if a mob shouldn't be allowed to leave their area (via wandering)
+	// but has somehow been displaced, such as pulling through combat, spells, or otherwise
+	// tell them to path back home
+	if mob.MaxWander == 0 && mob.Character.RoomId != mob.HomeRoomId {
+		mob.Command("pathto home")
+	}
+
+	if mob.CanConverse() && util.Rand(100) < int(configs.GetGamePlayConfig().MobConverseChance) {
+		if mobRoom := rooms.LoadRoom(mob.Character.RoomId); mobRoom != nil {
+			mobcommands.Converse(``, mob, mobRoom) // Execute this directly so that target mob doesn't leave the room before this command executes
+		}
+	}
+
+	// If they have idle commands, maybe do one of them?
+	handled, _ := scripting.TryMobScriptEvent("onIdle", mob.InstanceId, 0, ``, nil)
+	if !handled {
+
+		if !mob.Character.IsCharmed() { // Won't do this stuff if befriended
+
+			if mob.MaxWander > -1 && mob.WanderCount > mob.MaxWander {
+				mob.Command(`pathto home`)
+			}
+
+		}
+
+		//
+		// Look for trouble
+		//
+		if mob.Character.IsCharmed() {
+			// Only some mobs can apply first aid
+			if mob.Character.KnowsFirstAid() {
+				mob.Command(`lookforaid`)
+			}
+		} else {
+
+			idleCmd := `lookfortrouble`
+			if util.Rand(100) < mob.ActivityLevel {
+				idleCmd = mob.GetIdleCommand()
+				if idleCmd == `` {
+					idleCmd = `lookfortrouble`
+				}
+			}
+			mob.Command(idleCmd)
+		}
+	}
+
+	return events.Continue
+}

internal/hooks/MobIdle_HandleIdleMobs.go

@@ -8,10 +8,8 @@ import (
 
 	"github.com/GoMudEngine/GoMud/internal/configs"
 	"github.com/GoMudEngine/GoMud/internal/events"
-	"github.com/GoMudEngine/GoMud/internal/mobcommands"
 	"github.com/GoMudEngine/GoMud/internal/mobs"
 	"github.com/GoMudEngine/GoMud/internal/rooms"
-	"github.com/GoMudEngine/GoMud/internal/scripting"
 	"github.com/GoMudEngine/GoMud/internal/users"
 	"github.com/GoMudEngine/GoMud/internal/util"
 )
@@ -25,10 +23,8 @@ func IdleMobs(e events.Event) events.ListenerReturn {
 	mobPathAnnounce := false // useful for debugging purposes.
 
 	mc := configs.GetMemoryConfig()
-	gp := configs.GetGamePlayConfig()
 
 	maxBoredom := uint8(mc.MaxMobBoredom)
-	globalConverseChance := int(gp.MobConverseChance)
 
 	allMobInstances := mobs.GetAllMobInstanceIds()
 
@@ -143,55 +139,7 @@ func IdleMobs(e events.Event) events.ListenerReturn {
 			mob.Path.Clear()
 		}
 
-		// if a mob shouldn't be allowed to leave their area (via wandering)
-		// but has somehow been displaced, such as pulling through combat, spells, or otherwise
-		// tell them to path back home
-		if mob.MaxWander == 0 && mob.Character.RoomId != mob.HomeRoomId {
-			mob.Command("pathto home")
-			continue
-		}
-
-		if mob.CanConverse() && util.Rand(100) < globalConverseChance {
-			if mobRoom := rooms.LoadRoom(mob.Character.RoomId); mobRoom != nil {
-				mobcommands.Converse(``, mob, mobRoom) // Execute this directly so that target mob doesn't leave the room before this command executes
-				//mob.Command(`converse`)
-			}
-			continue
-		}
-
-		// If they have idle commands, maybe do one of them?
-		handled, _ := scripting.TryMobScriptEvent("onIdle", mob.InstanceId, 0, ``, nil)
-		if !handled {
-
-			if !mob.Character.IsCharmed() { // Won't do this stuff if befriended
-
-				if mob.MaxWander > -1 && mob.WanderCount > mob.MaxWander {
-					mob.Command(`pathto home`)
-					continue
-				}
-
-			}
-
-			//
-			// Look for trouble
-			//
-			if mob.Character.IsCharmed() {
-				// Only some mobs can apply first aid
-				if mob.Character.KnowsFirstAid() {
-					mob.Command(`lookforaid`)
-				}
-			} else {
-
-				idleCmd := `lookfortrouble`
-				if util.Rand(100) < mob.ActivityLevel {
-					idleCmd = mob.GetIdleCommand()
-					if idleCmd == `` {
-						idleCmd = `lookfortrouble`
-					}
-				}
-				mob.Command(idleCmd)
-			}
-		}
+		events.AddToQueue(events.MobIdle{MobInstanceId: mobId})
 
 	}
 

internal/hooks/NewRound_IdleMobs.go

@@ -31,6 +31,7 @@ func RegisterListeners() {
 	//
 	events.RegisterListener(events.NewRound{}, AutoHeal)
 	events.RegisterListener(events.NewRound{}, IdleMobs)
+	events.RegisterListener(events.MobIdle{}, HandleIdleMobs)
 
 	// Turn Hooks
 	events.RegisterListener(events.NewTurn{}, CleanupZombies)