Room Exit Messages (#232)

# Changes
* Added room exit messages to exit definitions
* Added prompt for customizing exit message in `room edit exits` command
* Exit messages display and then wait 1 second before continuing through the exit.
* Fixing `zone edit` prompt around music to allow for no music, and provides relative path if needed.

Author: Volte6

_datafiles/guides/building/scripting/FUNCTIONS_ACTORS.md

@@ -29,7 +29,8 @@ ActorObjects are the basic object that represents Users and NPCs
   - [ActorObject.AddGold(amt int \[, bankAmt int\])](#actorobjectaddgoldamt-int--bankamt-int)
   - [ActorObject.AddHealth(amt int) int](#actorobjectaddhealthamt-int-int)
   - [ActorObject.Sleep(seconds int)](#actorobjectsleepseconds-int)
-  - [ActorObject.Command(cmd string, waitTurns ...int)](#actorobjectcommandcmd-string-waitturns-int)
+  - [ActorObject.Command(cmd string \[, waitTurns int\])](#actorobjectcommandcmd-string--waitturns-int)
+  - [ActorObject.CommandFlagged(cmd string, flag int \[, waitTurns int\])](#actorobjectcommandflaggedcmd-string-flag-int--waitturns-int)
   - [ActorObject.IsTameable() bool](#actorobjectistameable-bool)
   - [ActorObject.TrainSkill(skillName string, skillLevel int)](#actorobjecttrainskillskillname-string-skilllevel-int)
   - [ActorObject.GetSkillLevel(skillName string)](#actorobjectgetskilllevelskillname-string)
@@ -259,7 +260,7 @@ _Note: Only works on mobs._
 | --- | --- |
 | seconds | How many seconds to wait. |
 
-## [ActorObject.Command(cmd string, waitTurns ...int)](/internal/scripting/actor_func.go)
+## [ActorObject.Command(cmd string [, waitTurns int])](/internal/scripting/actor_func.go)
 Forces an ActorObject to execute a command as if they entered it
 
 _Note: Don't underestimate the power of this function! Complex and interesting behaviors or interactions can emerge from using it._
@@ -269,6 +270,18 @@ _Note: Don't underestimate the power of this function! Complex and interesting b
 | cmd | The command to execute such as `look west` or `say goodbye`. |
 | waitTurns (optional) | The number of turns (NOT rounds) to wait before executing the command. |
 
+## [ActorObject.CommandFlagged(cmd string, flag int [, waitTurns int])](/internal/scripting/actor_func.go)
+Forces an ActorObject to execute a command as if they entered it.
+WARNING: Advanced Usage. Required a flag integer.
+
+_Note: Don't underestimate the power of this function! Complex and interesting behaviors or interactions can emerge from using it._
+
+|  Argument | Explanation |
+| --- | --- |
+| cmd | The command to execute such as `look west` or `say goodbye`. |
+| flag | The special control flag to pass to the command. |
+| waitTurns (optional) | The number of turns (NOT rounds) to wait before executing the command. |
+
 ## [ActorObject.IsTameable() bool](/internal/scripting/actor_func.go)
 Returns `true` if actor can be tamed.
 

_datafiles/world/default/users/admin.yaml

@@ -63,17 +63,17 @@ character:
     - buffid: 28
       onstartevent: true
       permabuff: true
-      roundcounter: 28
+      roundcounter: 23
       triggersleft: 1000000000
     - buffid: 29
       onstartevent: true
       permabuff: true
-      roundcounter: 36
+      roundcounter: 16
       triggersleft: 1000000000
     - buffid: 39
       onstartevent: false
       permabuff: true
-      roundcounter: 10
+      roundcounter: 5
       triggersleft: 1000000000
   equipment:
     weapon:

internal/events/eventtypes.go

@@ -35,6 +35,7 @@ type Input struct {
 	MobInstanceId int
 	InputText     string
 	WaitTurns     int
+	Flags         uint64
 }
 
 func (i Input) Type() string { return `Input` }

internal/exit/exit.go

@@ -16,6 +16,7 @@ type RoomExit struct {
 	RoomId       int
 	Secret       bool          `yaml:"secret,omitempty"`
 	MapDirection string        `yaml:"mapdirection,omitempty"` // Optionaly indicate the direction of this exit for mapping purposes
+	ExitMessage  string        `yaml:"exitmessage,omitempty"`  // If set, this message is sent to the user, followed by a delay, before they actually go through the exit.
 	Lock         gamelock.Lock `yaml:"lock,omitempty"`         // 0 - no lock. greater than zero = difficulty to unlock.
 }
 

internal/scripting/actor_func.go

@@ -309,6 +309,17 @@ func (a ScriptActor) Command(cmd string, waitTurns ...int) {
 	}
 }
 
+func (a ScriptActor) CommandFlagged(cmd string, flags int, waitTurns ...int) {
+	if len(waitTurns) < 1 {
+		waitTurns = append(waitTurns, 0)
+	}
+	if a.userId > 0 {
+		a.userRecord.CommandFlagged(cmd, uint64(flags), waitTurns[0])
+	} else {
+		a.mobRecord.Command(cmd, waitTurns[0])
+	}
+}
+
 func (a ScriptActor) TrainSkill(skillName string, skillLevel int) bool {
 
 	if a.userRecord == nil {

internal/usercommands/README.md

@@ -3,7 +3,7 @@
 The `usercommands` package defines a function type and contains all of the commands a user can enter.
 
 ```
-type UserCommand func(rest string, user *users.UserRecord, room *rooms.Room) (bool, error)
+type UserCommand func(rest string, user *users.UserRecord, room *rooms.Room, flags UserCommandFlag) (bool, error)
 ```
 
 All commands follow that definition, where
@@ -13,7 +13,7 @@ All commands follow that definition, where
 
 ```
 
-func Glarble(rest string, user *users.UserRecord, room *rooms.Room) (bool, error) {
+func Glarble(rest string, user *users.UserRecord, room *rooms.Room, flags UserCommandFlag) (bool, error) {
     
     room.SendText(`This glarble text goes out to all players in room`)
 

internal/usercommands/admin.badcommands.go

@@ -9,7 +9,7 @@ import (
 	"github.com/volte6/gomud/internal/users"
 )
 
-func BadCommands(rest string, user *users.UserRecord, room *rooms.Room) (bool, error) {
+func BadCommands(rest string, user *users.UserRecord, room *rooms.Room, flags UserCommandFlag) (bool, error) {
 
 	if rest == "clear" {
 		badinputtracker.Clear()

internal/usercommands/admin.buff.go

@@ -16,7 +16,7 @@ import (
 	"github.com/volte6/gomud/internal/users"
 )
 
-func Buff(rest string, user *users.UserRecord, room *rooms.Room) (bool, error) {
+func Buff(rest string, user *users.UserRecord, room *rooms.Room, flags UserCommandFlag) (bool, error) {
 
 	// args should look like one of the following:
 	// target buffId - put buff on target if in the room

internal/usercommands/admin.build.go

@@ -12,7 +12,7 @@ import (
 	"github.com/volte6/gomud/internal/util"
 )
 
-func IBuild(rest string, user *users.UserRecord, room *rooms.Room) (bool, error) {
+func IBuild(rest string, user *users.UserRecord, room *rooms.Room, flags UserCommandFlag) (bool, error) {
 
 	// args should look like one of the following:
 	// info <optional room id>
@@ -115,7 +115,7 @@ func IBuild(rest string, user *users.UserRecord, room *rooms.Room) (bool, error)
 	return true, nil
 }
 
-func Build(rest string, user *users.UserRecord, room *rooms.Room) (bool, error) {
+func Build(rest string, user *users.UserRecord, room *rooms.Room, flags UserCommandFlag) (bool, error) {
 
 	// args should look like one of the following:
 	// info <optional room id>

internal/usercommands/admin.command.go

@@ -12,7 +12,7 @@ import (
 	"github.com/volte6/gomud/internal/users"
 )
 
-func Command(rest string, user *users.UserRecord, room *rooms.Room) (bool, error) {
+func Command(rest string, user *users.UserRecord, room *rooms.Room, flags UserCommandFlag) (bool, error) {
 
 	// args should look like one of the following:
 	// target buffId - put buff on target if in the room