Working With...Locks & Keys

// WorkingWithLocksAndKeys.js
/* global AdventureJS A WorkingWithLocksAndKeys G */

var G = (WorkingWithLocksAndKeys = new AdventureJS.Game(
  "WorkingWithLocksAndKeys",
  "WorkingWithLocksAndKeysContainer"
));

// --------------------------------------------------
// Settings
// --------------------------------------------------

G.settings.set({
  display: "inline",
  layout: "classic",
  title: "Working With",
  author: "Ivan Cockrum",
  description: "Today we are Working With Keys",
  version: "0.0.1",

  // This setting prints a room's contents before
  // its exits, which is purely a stylistic choice.
  print_contents_before_exits: true,

  // This setting allows the player to use a key
  // they've never used before without being
  // prompted for a key. Sometimes you don't
  // want to give away a puzzle through inference.
  // Other times prompting is just really annoying.
  allow_inference_on_first_use: true,

  // These settings allow room names to be shown
  // in exit listings, as in
  // "you can go out to the playground"
  print_exits_room_names: true,
  print_exits_room_names_if_known: true,
});

// --------------------------------------------------
// Player
// --------------------------------------------------

G.createAsset({
  class: "Player",
  name: "Explorer",
  place: { in: "Chamber of Keys" },
});

// --------------------------------------------------
// Rooms
// --------------------------------------------------

G.createAsset({
  class: "Room",
  name: "Chamber of Keys",
  description: `
    Welcome to the Locks and Keys demo. 
    Things you'll find in the example code include 
    unlocking with a specific key,
    unlocking with any key,
    unlocking without a key,
    and picking locks with a lockpick.
    <br/><br/>
    The chief feature of this room
    is a ludicrously ornate ormolu desk, on which have been placed two
    small chests and 
    {copper bowl[is]empty[then]an empty copper bowl[else]a copper bowl full of keys}. 
    The desk also has three drawers: left, middle, and right.
  `,
  exits: {
    // look under exits & doors
  },
});

G.createAsset({
  class: "Room",
  name: "North Room",
  description: `This is the North Room. `,
  exits: {
    south: "Chamber of Keys",
  },
});

G.createAsset({
  class: "Room",
  name: "South Room",
  description: `This is the South Room. `,
  exits: {
    north: "Chamber of Keys",
  },
});

G.createAsset({
  class: "Room",
  name: "Courtyard",
  // setting definite_article makes it so that it will appear
  // in lists as "the Courtyard" rather than "Courtyard"
  definite_article: "the",
  description: `This is the small courtyard that lies outside the window. `,
  exits: {
    in: "Chamber of Keys",
  },
});

// --------------------------------------------------
// Exits & Doors
// --------------------------------------------------

// Chamber of Keys North - Exit
G.createAsset({
  class: "Exit",
  direction: "north",
  place: { in: "Chamber of Keys" },
  destination: "North Room",
  descriptions: {
    look: "It looks frosty that way. ",
  },
  aperture: "icy door",
});

// Chamber of Keys North - Icy Door
G.createAsset({
  class: "Door",
  name: "icy door",
  adjectives: "icy, north",
  synonyms: ["icy north door", "lock"],
  is: { closed: true, locked: true },
  dov: {
    open: true,
    close: true,
    unlock: {
      with_assets: ["glass key"],
      with_classes: ["SkeletonKey"],
      with_nothing: false,
    },
    lock: {
      with_assets: ["glass key"],
      with_classes: ["SkeletonKey"],
      with_nothing: false,
    },
  },
  descriptions: `
    The icy north door is 
    { icy door [is] locked [or] unlocked } and 
    { icy door [is] open [or] closed }. {[if icy door is locked]It looks like it takes a special key. }
  `,
});

// Chamber of Keys South - Exit
G.createAsset({
  class: "Exit",
  direction: "south",
  place: { in: "Chamber of Keys" },
  destination: "South Room",
  descriptions: {
    look: "It looks warm that way. ",
  },
  aperture: "warm door",
});

// Chamber of Keys South - Warm Door
G.createAsset({
  class: "Door",
  name: "warm door",
  adjectives: "warm, south, melted, lock",
  synonyms: ["warm south door", "melted keyhole"],
  is: { closed: true, locked: true },
  dov: {
    open: true,
    close: true,
    pick: {
      with_classes: ["Lockpick"],
      with_nothing: false,
    },
  },
  description: `
    The warm south door is { warm door [is] open [or] closed }. 
    The door's keyhole appears to be melted out of shape. It
    likely won't take a key, though the lock could probably be picked.
  `,
});

G.createAsset({
  class: "Exit",
  direction: "out",
  place: { in: "Chamber of Keys" },
  destination: "Courtyard",
  descriptions: {
    look: "Beyond the window lies a small courtyard. ",
    travel: "You climb out the window and land in the courtyard. ",
  },
  aperture: "casement window",
});

// Chamber of Keys Out - casement window
G.createAsset({
  class: "Window",
  name: "casement window",

  descriptions: {
    look: `
      The casement window can be locked and unlocked without a key.  
      Beyond the window lies a small courtyard. 
    `,
    out: function () {
      return this.descriptions.through;
    },
    through: "You see the courtyard. ",
  },

  is: { closed: true, locked: true },
  dov: { lock: { with_nothing: true }, unlock: { with_nothing: true } },
});

// The window mentions the courtyard, so we'll create a piece
// of scenery to response to input like "examine courtyard"
G.createAsset({
  class: "Scenery",
  name: "courtyard view",
  description: `There's nothing notable to say about the courtyard beyond the window. `,
  place: "Chamber of Keys",
});

// --------------------------------------------------
// Chests
// --------------------------------------------------

// burned chest
G.createAsset({
  class: "Chest",
  name: "burned chest",
  place: { on: "ormolu desk" },
  description: `
    It's a treasure chest with brass straps, 
    scarred from a fire that blackened its 
    wood, melted its straps, and warped its 
    keyhole to the point where it probably 
    can't even accept a key. It's currently 
    {burned chest [is] open [or] closed}. 
  `,
  adjectives: "treasure, blackened, melted, scarred, brass",
  synonyms: "burned chest lock, lock, straps",
  // Setting listed to false means the asset won't be
  // listed in the room's contents. We're doing that
  // for a number of assets that we've included
  // in the room description.
  is: { locked: true, listed: false },
  dov: {
    pick: { with_classes: "Lockpick" },
  },
});

// Keyed treasure chest
G.createAsset({
  class: "Chest",
  name: "velvet chest",
  place: { on: "ormolu desk" },
  description: `
    The small chest is lined with a luxuriant 
    purple velvet. 
  `,
  adjectives: ["treasure"],
  synonyms: "lock",
  is: { locked: true, listed: false },
  dov: {
    pick: { with_classes: ["SkeletonKey"], with_assets: ["tiny golden key"] },
    unlock: { with_nothing: false },
  },
});

// Chests collection
// We use collections to allow players
// to refer to specific groups of objects
G.createAsset({
  class: "Collection",
  name: "chests",
  place: { attached: "ormolu desk" },
  targets: "velvet chest, burned chest",
  synonyms: ["chests", "two chests"],
  is: { listed: false },
  description: `
    Two small heavy chests dominate the top of the ormolu desk. 
    For the sake of this demo, the left, velvet one is keyed and 
    the right, burned one is pickable.
    The velvet chest is { velvet chest [is] open [or] closed } and 
    the burned chest is { burned chest [is] open [or] closed }. 
  `,
});

// --------------------------------------------------
// Keys bowl
// --------------------------------------------------

G.createAsset({
  class: "Bowl",

  // Normally, authors don't need to provide asset IDs,
  // because asset IDs are generated from asset names.
  // However, we want to use a dynamic name for this
  // copper bowl, to indicate whether it's empty or full
  // when it appears in inventory lists. Dynamic names
  // are allowed, but in that case we MUST also provide an ID.
  name: "{copper bowl[is]empty[then]an empty copper bowl[else]a copper bowl full of keys}",
  id: "copper bowl",
  // Our dynamic name breaks the indefinite article algorithm
  // so we've included indefinite articles in the name and
  // we're going to explicitly set indefinite_article blank.
  indefinite_article: "",

  place: { on: "ormolu desk" },
  description: "It's a copper bowl for dropping keys in. ",

  // The Bowl class is subscribed to verb take,
  // which allows it to be taken. We don't want this
  // particular bowl to be takeable. We could disable
  // its verb subscription, like this...
  // dov: { take: false },

  // ...or we can just set it to fixed. This is a useful
  // property for items that are sometimes takeable
  // and sometimes not.
  is: { fixed: true, listed: false },
});

// --------------------------------------------------
// Keys and lockpicks
// --------------------------------------------------

// Glass key - unlocks icy door
G.createAsset({
  class: "Key",
  name: "glass key",
  place: { in: "copper bowl" },
  adjectives: "",
  description: `
    This glass key looks exceptionally brittle. 
    It's a single use key that will self-destruct
    after one use.
  `,
  // We're going to set this key to self-destruct
  // after one use.
  // There is a class named SingleUseKey which
  // already has this set, and that's the only
  // difference from the regular Key class.
  iov: {
    unlock: {
      then_destroy: true,
      on_destroy: "The glass key shatters into pieces. ",
    },
  },
});

// Brass key
G.createAsset({
  class: "Key",
  name: "melted brass key",
  place: { in: "copper bowl" },
  adjectives: "",
});

// Tiny golden key - velvet chest
G.createAsset({
  class: "Key",
  name: "tiny golden key",
  place: { in: "copper bowl" },
  description:
    "It's a tiny golden key with a thin ribbon of purple velvet tied to the head. ",
  synonyms: ["ribbon"],
  adjectives: ["gold"],
});

// Bobby pin - warm door and middle drawer
G.createAsset({
  class: "Lockpick",
  name: "bobby pin",
  place: { in: "copper bowl" },
  // We're going to set this lockpick to self-destruct
  // after one use.
  // There is a class named SingleUseLockpick which
  // already has this set, and that's the only
  // difference from the regular Lockpick class.
  iov: {
    unlock: {
      then_destroy: true,
      on_destroy: "The bobby pin snaps in half. ",
    },
    pick: {
      then_destroy: true,
      on_destroy: "The bobby pin snaps in half. ",
    },
  },
  description: `
    The hairpin is a squiggly little piece of black metal, 
    bent in the middle. It's a single use lockpick that will 
    self-destruct after one use.
  `,
  adjectives: "",
});

// lockpick set - warm door and middle drawer
G.createAsset({
  class: "Lockpick",
  name: "lockpick set",
  place: { in: "copper bowl" },
  description: `
    It's a beefy looking, industrially machined lockpick set. 
  `,
  adjectives: "beefy, industrial, machined",
});

// --------------------------------------------------
// Desk and drawers
// --------------------------------------------------

G.createAsset({
  class: "Desk",
  name: "ormolu desk",
  place: { in: "Chamber of Keys" },
  description: `
    It's a ludicrously ornate ormolu desk, with three drawers: 
    left, middle, and right. The desktop is dominated by two 
    small chests: a velvet chest, and a burned chest.
  `,
  adjectives: "ludicrously, ornate",
  is: { listed: false },
});

// Left drawer
G.createAsset({
  class: "Drawer",
  name: "left drawer",
  synonyms: "left desk drawer, left drawer lock, lock",
  description: "The left drawer is { left drawer [is] open [or] closed }. ",
  adjectives: "desk",
  place: { attached: "ormolu desk" },
  is: { closed: true, locked: true, listed: false },
  dov: {
    unlock: { with_classes: ["SkeletonKey"] },
  },
});

// Middle drawer
G.createAsset({
  class: "Drawer",
  name: "middle drawer",
  synonyms: "middle desk drawer, lock",
  description: `
    The middle drawer is { middle drawer [is] open [or] closed } 
    and { middle drawer [is] locked [or] unlocked }{
      [middle drawer is locked], 
      but looks like it can be picked with a lockpick }.
  `,
  adjectives: "desk",
  place: { attached: "ormolu desk" },
  is: { closed: true, locked: true, listed: false },
  dov: {
    pick: { with_classes: ["Lockpick"] },
    // setting unlock.with_nothing = false
    // stops "unlock drawer" from working
    // without disabling the unlock verb subscription
    unlock: { with_nothing: false },
  },
});

// Right drawer
G.createAsset({
  class: "Drawer",
  name: "right drawer",
  synonyms: "right desk drawer, lock",
  description: `
    The right drawer is { right drawer [is] locked [or] unlocked } and { right drawer [is] open [or] closed }. 
  `,
  adjectives: "desk",
  place: { attached: "ormolu desk" },
  is: { closed: true, locked: true, listed: false },
  dov: {
    unlock: { with_classes: ["SkeletonKey"] },
  },
});

// Drawers collection
// We use collections to allow players
// to refer to specific groups of objects
G.createAsset({
  class: "Collection",
  name: "desk drawers",
  place: { attached: "ormolu desk" },
  targets: "left drawer, middle drawer, right drawer",
  synonyms: ["drawers", "three drawers"],
  is: { listed: false },
  description: `
    The left drawer is { left drawer [is] open [or] closed }, 
    the middle drawer is { middle drawer [is] open [or] closed }, 
    and the right drawer is { right drawer [is] open [or] closed }. 
  `,
});