Climbing Exits and Stair Exits

[GhostOfMoria]

Greetings,

I was hoping someone could help me troubleshoot this code. I'm attempting to implement a set of rooms connected by a ladder. The Wiki (Attributes for Exits) shows how to use the ClimbExit and StairsUp / Down attributes, but implementing them is giving me errors. Specifically, the error is "uncaught ReferenceError: ClimbExit is not defined." I feel like I've copied the code from the Wiki pretty closely, so I'm not sure what I'm missing. As an added note, I have ensured that the code is error-free and that all rooms are navigable as intended when using the standard up and down Exits rather than the ClimbExit or StairsUp / Down exits. I've copied the offending code here.

createRoom("PrisonCellSE", {
	desc: "A verbose description, truncated here for brevity.",
	darkDesc: "This looks to be another cell, but the dim light doesn't reach inside.",
	lightSource: function () {
		return world.LIGHT_NONE
	},
	north: new Exit("PrisonEastHall", {
		illuminated: true,
	}),
	down: new ClimbExit("PrisonCellar", "prisonLadder_up"),
	exit_locked_down: true,
})

createRoom("PrisonCellar", {
	lightSource: function () {
		return world.LIGHT_NONE
	},
	up: new ClimbExit("PrisonCellSE", "prisonLadder_down"),
})

createItem("prisonLadder_down", {
	alias: "ladder",
	loc: "PrisonCellar",
	examine: "A simple wooden ladder.",
	scenery: true,
})

createItem("prisonLadder_up", {
	alias: "ladder",
	loc: "PrisonCellSE",
	examine: "A simple wooden ladder.",
	scenery: true,
})

And here is the section where I've attempted to implement the StairsUp and StairsDown code. This, too, was copied pretty closely from the Wiki, but it gives me errors as well.

createRoom("PrisonWestHall", {
	alias: "Prison Hallway - West End",
	desc: "This is the west end of a prison hallway. There are cells to the north and south. A small table sits here, and a lantern sconce attached to the wall lights the area.",
	east: new Exit("PrisonCentralHall"),
	south: new Exit("PrisonCellSW"),
	north: new Exit("PrisonCellNW"),
	west: new StairsUp("PrisonStairLanding", "PrisonWestHall_scenery_stairs"),
	scenery: [
		"stairs",
	],
})
createRoom("PrisonStairLanding", {
	desc: "This is a small landing where the stairway doubles back on itself as it goes upward. The signs of neglect are obvious here. Broken crates and pieces of furniture were piled here.",
	east: new StairsDown("PrisonWestHall", "PrisonStairLanding_scenery_stairs"),
	east: new StairsUp("RuinedTower", "PrisonStairLanding_scenery_stairs"),
	scenery: [
		"stairs",
	],
})
createRoom("RuinedTower", {
	desc: "A verbose description, truncated here for brevity.",
	west: new StairsDown("PrisonStairLanding", "RuinedTower_scenery_stairs"),
	northwest: new Exit("DirewoodCampsite"),
	scenery: [
		"stairs",
	],
})

As a final note, it seems that I get an error when trying the ClimbExit code on its own, and I get an error when trying the StairsUp/Down code on its own. Which seems to indicate that there are issues with both sections of code. I appreciate the help!

[cellarderecho]

The issue seems to be that the code the wiki references does not exist in the most recent release of QuestJS. Version 1.4 was released on March 11, 2023, but the exit types you are asking about were not added until March 31 in 458f408.

You could try working off the master branch instead of 1.4, or potentially, you could just add the new exit types (though I'm not sure if there would be any conflicts with 1.4). I'm adding the relevant code here, for reference.

class ClimbExit extends Exit {
  constructor(name, itemName, hash) {
    super(name, hash)
    this.climbItemName = itemName
    this.initFunction = function() {
      if (!this.climbItemName) return errormsg('The ClimbExit exit for ' + this.origin.name + ' requires an item name.')
      if (!w[this.climbItemName]) return errormsg('The ClimbExit exit for ' + this.origin.name + ' has a bad item name (found "' + this.climbItemName + '").')
      if (this.dir === 'up') {
        w[this.climbItemName].climbupverb = function(options) {
          return w[this.loc].up.use(options.char)
        }
        this.alsoDir = ['climb_up']
      }
      if (this.dir === 'down') {  // else will not work, as it would catch the new climb_up direction
        w[this.climbItemName].climbdownverb = function(options) {
          return w[this.loc].down.use(options.char)
        }
        this.alsoDir = ['climb_down']
      }
      if (this.dir === 'up' || this.dir === 'climb_up') {
        this.alias = 'up'
        if (!this.npcEnterMsg) this.npcEnterMsg = insertItemName(lang.npc_enter_climb_up, itemName)
        if (!this.npcLeaveMsg) this.npcLeaveMsg = insertItemName(lang.npc_leave_climb_up, itemName)
        w[this.climbItemName].goUpDirection = 'up'
      }
      if (this.dir === 'down' || this.dir === 'climb_down') {
        this.alias = 'down'
        if (!this.npcEnterMsg) this.npcEnterMsg = insertItemName(lang.npc_enter_climb_down, itemName)
        if (!this.npcLeaveMsg) this.npcLeaveMsg = insertItemName(lang.npc_leave_climb_down, itemName)
        w[this.climbItemName].goDownDirection = 'down'
      }
    }
  }  
}



class StairsUp extends Exit {
  constructor(name, itemName, hash) {
    super(name, hash)
    this.climbItemName = itemName
    this.initFunction = function() {
      if (!this.climbItemName) return errormsg('The StairsUp exit for ' + this.origin.name + ' requires an item name.')
      if (!w[this.climbItemName]) return errormsg('The StairsUp exit for ' + this.origin.name + ' has a bad item name (found "' + this.climbItemName + '").')
      w[this.climbItemName].goUpDirection = this.dir
      w[this.climbItemName].climbupverb = function(options) {
        return w[this.loc].up.use(options.char)
      }
      this.alsoDir = ['up', 'climb_up']
      if (!this.npcEnterMsg) this.npcEnterMsg = insertItemName(lang.npc_enter_up_stairs, itemName)
      if (!this.npcLeaveMsg) this.npcLeaveMsg = insertItemName(lang.npc_leave_up_stairs, itemName)
      w[this.climbItemName].goUpDirection = 'up'
    }
  }  
}

class StairsDown extends Exit {
  constructor(name, itemName, hash) {
    super(name, hash)
    this.climbItemName = itemName
    this.initFunction = function() {
      if (!this.climbItemName) return errormsg('The StairsDown exit for ' + this.origin.name + ' requires an item name.')
      if (!w[this.climbItemName]) return errormsg('The StairsDown exit for ' + this.origin.name + ' has a bad item name (found "' + this.climbItemName + '").')
      w[this.climbItemName].goDownDirection = this.dir
      w[this.climbItemName].climbdownverb = function(options) {
        return w[this.loc].down.use(options.char)
      }
      this.alsoDir = ['down']
      if (!this.npcEnterMsg) this.npcEnterMsg = insertItemName(lang.npc_enter_down_stairs, itemName)
      if (!this.npcLeaveMsg) this.npcLeaveMsg = insertItemName(lang.npc_leave_down_stairs, itemName)
      w[this.climbItemName].goDownDirection = 'down'
    }
  }  
}

[GhostOfMoria]

Thank you so much. I was just not understanding what was wrong with my code, so this makes sense. If I wanted to, as you suggest, work off the master branch, is this as simple as downloading all the currently uncompressed directories and copying over my edited content in the game directory (data.js, code.js, settings.js, and style.css)?

[cellarderecho]

Pretty much! If you go to the main GitHub page for QuestJS, you can click the green "Code" button, and then "Download ZIP" under that. Extract the archive, and you'll have a copy of the current version of the master branch. There are more things in there than you strictly need (previous versions and examples), but you're right, all you need to do is copy your files into the game directory and it should work the way you expect.