Mentioned In Room Description

version 1 by Ron Newcomb

  • Home page
  • Beginning
  • Next



  • Documentation


    Section : The Room Description

    This extension modifies Inform so that room descriptions which have their objects in square brackets, like this --

        Warehouse is a room. "The room is filled by [the ENIAC computing machine]."

    -- will no longer be mentioned later in LOOK, such as the you-can-also-see line or a paragraph dedicated to the item. Likewise, objects mentioned in the room's heading, such as the supporter a player stands upon, will also be considered already mentioned.

    Traditionally, a room description was completely static text, describing the setting that the player has just walked into. As most locations do not appreciably change between visits -- buildings and landscape are themselves fairly static -- this is appropriate. Subsequent paragraphs list the portable items and movable actors with which you actually interact. But increasingly the "room description" is co-opted for other purposes. Either the setting itself changes with time and weather, or immobile but interactive things are best presented within the room description (as in the case of scenery), or a portable item or character spends a great deal of time in a particular room necessitating personalisation, or a strongly narrative work uses rooms as single-use set pieces containing plot or scene information.

    In such cases this extension allows the author to more easily coordinate the mentioning of objects between the room description and the rest of LOOK's generated prose, because a single guideline will apply: mention objects only once, regardless of where.


    Section : 'Here' and 'Elsewhere' as Adjectives

    When we write portable items and people into the room description, an appropriate if-statement is likely needed to check that the item or person is still in the room. This extension defines "here" and "elsewhere" as adjectives for asking if an object is currently in the room being described. They can combine with other adjectives to ascertain several truths at once.

        The Catskills is a room. "Here is a lovely, secluded fold in the mountains, far from civilization[if Rip Van Winkle is here asleep]: as though to prove it, [Rip Van Winkle] is sleeping under a tree[end if]."
        
        Rip Van Winkle is a man in the Catskills. "Rip Van Winkle [if Rip is asleep]sleeps nearby[otherwise]stands here, looking mightily confused[end if]."


    The statement "if Rip is here asleep" ensures that Rip's description combines with the room's description only if both conditions are true. If he is awake, Rip gets a paragraph to himself. In other rooms, he gets a paragraph to himself regardless his state of consciousness. Only in that particular and presumably usual circumstance is the description of setting and character blended.


    Section : 'Mentioned Below'

    If an object is mentioned in the room description but the author still wishes LOOK to automatically describe it anyway, there are three ways to accomplish this. The first is simply not to enclose the object in square brackets to begin with, though if the name of the object changes such a change won't be reflected automatically. The second way is via the say phrase "mentioned below". The third way is via a rule.

        Warehouse is a room. "The room is filled by the ENIAC computing machine."
        
        Warehouse is a room. "The room is filled by [the ENIAC computing machine mentioned below]."
        
        Before printing the locale description of the warehouse: now the ENIAC machine is unmentioned.


    Section : 'If Capitalisation is Needed' and 'uc'

    "Mentioned below" preserves the article and capitalisation of its object as many Inform say phrases do. Meaning, it knows and respects the difference between "[The wrench]" and "[the wrench]" and "Eddie's [wrench]". But occasionally we don't wish to lead the mention of a common noun with an article, and in those cases we must explicitly tell Inform to capitalise the object's name with either the "[uc]" proofreading mark, or synonymously, the caret "[^]".

        The description of the cave is "[uc][Water] drips from above."
        The description of the cave is "[^][Water] drips from above."

    In cases where capitalisation is rather complex, we can explicitly define what the capitalised name of something is.
        The printed capitalised name of the iPod is "iPod".
        The printed capitalised plural name of the iPod is "iPods".

    The state of capitalisation can be queried with "if capitalisation is needed". This may be useful within the Printing The Name Of activity.

        Rule for printing the name of the player when the player is in the teleportation chamber:
            if capitalisation is needed, say "Flickering as if insubstantial, you";
            otherwise say "your ghostly self".

    When we use other indefinite articles, such as "some" as in "some water", we can call it forth by using the indefinite article "a", as in "[A Water] drips from the ceiling," or "There is [a water] here." Whichever article (if any) the object used in its definition will be printed. For more information on this aspect of the indeterminate article, see 3.18, "Articles and proper names", and Chapter 5.2, "Text which names things", in the Writing With Inform manual. See the built-in extension Plurality, by Emily Short, for further handling of "these/those", pronouns, and so on.


    Section : A Full Look After Going, Exiting

    With an increased reliance on room descriptions, we must take care with how the commands BRIEF and SUPERBRIEF will affect the work. These commands suppress the room description on subsequent visits, or permanently, respectively. The BRIEF listing, also called an abbreviated listing, is also used during VERBOSE mode after a character changes location via going, entering, or exiting, for example. For consistancy, this extension changes the default behavior so that a full LOOK is done after movement, removing this edge case and its small burden from the author.

    The author must still consider how the prose will lay if the player specifically enters the BRIEF or SUPERBRIEF commands. Generally, if a work requires a lot of backtracking, these modes are conveniences to the player, as he needs only room headings while running around to fetch keys and whatnot. But if the work provides a GO TO command which deposits the player at his destination in a single turn, it may be acceptable to disallow these modes completely.

        Check preferring sometimes abbreviated room descriptions: say "I'm sorry, but [italic type][the story title][roman type] does not support BRIEF mode." instead.
        
         Check preferring abbreviated room descriptions: say "I'm sorry, but [italic type][the story title][roman type] does not support SUPERBRIEF mode." instead.