fiddlerwoaroof/crawl - Change LJPUO3NNFABVOQOBA5LUDNT2R5H4LMP6TPJBNVJ7VJBERCBYZIXQC

Let portal vaults (and places like Vault:8 and Slime:6) change the short and

long descriptions of features. For example, "An ice covered rock wall" instead of "A rock wall". See dat/icecave.des function ice_cave_feat_descs() for examples.

git-svn-id: https://crawl-ref.svn.sourceforge.net/svnroot/crawl-ref/trunk@7992 c06c8d41-db1a-0410-9941-cceddc491573

Created by zelgadis on December 27, 2008

LJPUO3NNFABVOQOBA5LUDNT2R5H4LMP6TPJBNVJ7VJBERCBYZIXQC

Dependencies

In channels

main

Change contents

Replacement in crawl-ref/source/store.cc at line 613 [4.12569]
B:BD[4.24744] → [4.24744:24767]
```
    if (type != (x)) \
```
[4.24744]
[4.24767]
```
    if (type != (x) || (flags & SFLAG_UNSET)) \
```
Insertion in crawl-ref/source/luadgn.cc at line 20 [7.1232]
[5.4423]
[6.5960]
```
#include "describe.h"
```

Insertion in crawl-ref/source/luadgn.cc at line 1584 [7.1232]

[8.17315]

}
static int dgn_set_feature_desc_short(lua_State *ls)
{
    const std::string base_name = luaL_checkstring(ls, 1);
    const std::string desc      = luaL_checkstring(ls, 2);
    if (base_name.empty())
    {
        luaL_argerror(ls, 1, "Base name can't be empty");
        return (0);
    }
    set_feature_desc_short(base_name, desc);
    return (0);

Insertion in crawl-ref/source/luadgn.cc at line 1602 [7.1232]

[8.17318]

static int dgn_set_feature_desc_long(lua_State *ls)
{
    const std::string raw_name = luaL_checkstring(ls, 1);
    const std::string desc     = luaL_checkstring(ls, 2);
    if (raw_name.empty())
    {
        luaL_argerror(ls, 1, "Raw name can't be empty");
        return (0);
    }
    set_feature_desc_long(raw_name, desc);
    return (0);
}

Insertion in crawl-ref/source/luadgn.cc at line 2975 [7.1232]

[9.5994]

[10.106287]

    { "set_feature_desc_short", dgn_set_feature_desc_short },
    { "set_feature_desc_long", dgn_set_feature_desc_long },

Insertion in crawl-ref/source/files.cc at line 1309 [11.3084589]
[3.15798]
[3.15798]
```
    setup_feature_descs_short();
```

Replacement in crawl-ref/source/directn.h at line 174 [11.3696722]

B:BD[12.34950] → [12.34950:35005]

                                bool add_stop = true);

[12.34950]

[12.35005]

                                bool add_stop = true, bool base_desc = false);

Replacement in crawl-ref/source/directn.h at line 176 [11.3696722]

B:BD[12.35068] → [9.7576:7639]

                                    trap_type tr = NUM_TRAPS);

[12.35068]

[13.3385]

                                    trap_type tr = NUM_TRAPS,
                                    bool base_desc = false);

Replacement in crawl-ref/source/directn.h at line 181 [11.3696722]

B:BD[12.35383] → [12.35383:35438]

                                bool add_stop = true);

[12.35383]

[11.3697902]

                                bool add_stop = true, bool base_desc = false);

Insertion in crawl-ref/source/directn.h at line 183 [11.3696722]

[11.3697903]

[14.2993]

void set_feature_desc_short(dungeon_feature_type grid,
                            const std::string &desc);
void set_feature_desc_short(const std::string &base_name,
                            const std::string &desc);
void setup_feature_descs_short();

Insertion in crawl-ref/source/directn.cc at line 59 [11.3697945]

[11.3698920]

[11.3698927]


#define SHORT_DESC_KEY "short_desc_key"
typedef std::map<std::string, std::string> desc_map;

Insertion in crawl-ref/source/directn.cc at line 64 [11.3697945]
[11.3698928]
[15.450922]
```
static desc_map base_desc_to_short;
```

Replacement in crawl-ref/source/directn.cc at line 2323 [11.3697945]

B:BD[9.8129] → [9.8129:8176]

                                bool add_stop)

[9.8129]

[9.8176]

                                bool add_stop, bool base_desc)

Replacement in crawl-ref/source/directn.cc at line 2325 [11.3697945]

B:BD[9.8178] → [9.8178:8238]

    std::string desc = raw_feature_description(grid, trap);

[9.8178]

[16.4762]

    std::string desc = raw_feature_description(grid, trap, base_desc);

Replacement in crawl-ref/source/directn.cc at line 2332 [11.3697945]

B:BD[12.36260] → [12.36260:36323]

B:BD[12.36323] → [9.8313:8365]

std::string raw_feature_description(dungeon_feature_type grid,
                                    trap_type trap)

[12.36260]

[17.980573]

static std::string _base_feature_desc(dungeon_feature_type grid,
                                      trap_type trap)

Insertion in crawl-ref/source/directn.cc at line 2560 [11.3697945]

[9.8502]

[18.19429]

std::string raw_feature_description(dungeon_feature_type grid,
                                    trap_type trap, bool base_desc)
{
    std::string base_str = _base_feature_desc(grid, trap);
    if (base_desc)
        return (base_str);
    desc_map::iterator i = base_desc_to_short.find(base_str);
    if (i != base_desc_to_short.end())
        return (i->second);
    return (base_str);
}
void set_feature_desc_short(dungeon_feature_type grid,
                            const std::string &desc)
{
    set_feature_desc_short(_base_feature_desc(grid, NUM_TRAPS), desc);
}
void set_feature_desc_short(const std::string &base_name,
                            const std::string &_desc)
{
    ASSERT(!base_name.empty());
    CrawlHashTable &props = env.properties;
    if (!props.exists(SHORT_DESC_KEY))
        props[SHORT_DESC_KEY].new_table(SV_STR);
    CrawlHashTable &desc_table = props[SHORT_DESC_KEY];
    if (_desc.empty())
    {
        base_desc_to_short.erase(base_name);
        desc_table.erase(base_name);
    }
    else
    {
        std::string desc = replace_all(_desc, "$BASE", base_name);
        base_desc_to_short[base_name] = desc;
        desc_table[base_name]         = desc;
    }
}
void setup_feature_descs_short()
{
    base_desc_to_short.clear();
    const CrawlHashTable &props = env.properties;
    if (!props.exists(SHORT_DESC_KEY))
        return;
    const CrawlHashTable &desc_table = props[SHORT_DESC_KEY].get_table();
    CrawlHashTable::const_iterator i;
    for (i = desc_table.begin(); i != desc_table.end(); ++i)
        base_desc_to_short[i->first] = i->second.get_string();
}

Replacement in crawl-ref/source/directn.cc at line 2646 [11.3697945]

∅:D[19.49957] → [16.4883:4960]

B:BD[16.4883] → [16.4883:4960]

                                description_level_type dtype, bool add_stop)

[19.49957]

[17.980815]

                                description_level_type dtype, bool add_stop,
                                bool base_desc)

Replacement in crawl-ref/source/directn.cc at line 2676 [11.3697945]
∅:D[16.5036] → [12.40842:40897]
∅:D[9.8902] → [12.40842:40897]
∅:D[20.27922] → [12.40842:40897]
∅:D[19.50193] → [12.40842:40897]
B:BD[12.40842] → [12.40842:40897]
```
                                    dtype, add_stop));
```
[20.27922]
[2.9115]
```
                                    dtype, add_stop, base_desc));
```

Replacement in crawl-ref/source/directn.cc at line 2688 [11.3697945]

B:BD[17.982354] → [16.5037:5117]

        return (feature_description(grid, NUM_TRAPS, bloody, dtype, add_stop));

[17.982354]

[17.982369]

        return (feature_description(grid, NUM_TRAPS, bloody, dtype, add_stop,
                                    base_desc));

Insertion in crawl-ref/source/describe.h at line 55 [11.3734214]
[11.3735580]
[11.3735612]
```
// last updated 24 Dec 2008 {mpc}
```

Insertion in crawl-ref/source/describe.h at line 57 [11.3734214]

[11.3735687]

 * called from: luadgn
 * *********************************************************************** */
void set_feature_desc_long(const std::string &raw_name,
                           const std::string &desc);
/* ***********************************************************************

Insertion in crawl-ref/source/describe.cc at line 52 [11.3736416]
[21.18935]
[11.3737621]
```
#define LONG_DESC_KEY "long_desc_key"
```
Replacement in crawl-ref/source/describe.cc at line 2000 [11.3736416]
B:BD[22.5075] → [19.51092:51153]
∅:D[19.51153] → [22.5125:5143]
B:BD[22.5125] → [22.5125:5143]
```
    std::string desc = feature_description(coord_def(x, y));
    desc += "$$";
```
[22.5075]
[23.2012]
```
    const coord_def pos(x, y);
    const dungeon_feature_type feat = grd(pos);
```

Replacement in crawl-ref/source/describe.cc at line 2003 [11.3736416]

B:BD[23.2013] → [23.2013:2058]

    // Get rid of trailing .$$ before lookup

[23.2013]

[24.6694]

    std::string desc = feature_description(pos, false, DESC_CAP_A, false);

Replacement in crawl-ref/source/describe.cc at line 2005 [11.3736416]

B:BD[24.6720] → [24.6720:6842]

        grd[x][y] == DNGN_ENTER_SHOP ? "A shop"
                                     : desc.substr(0, desc.length() - 3);

[24.6720]

[23.2125]

        grd[x][y] == DNGN_ENTER_SHOP ? "A shop" : desc;
    std::string long_desc = getLongDescription(db_name);
    desc += ".$$";
    // If we couldn't find a description in the database then see if
    // the feature's base name is different.
    if (long_desc.empty())
    {
        db_name   = feature_description(pos, false, DESC_CAP_A, false, true);
        long_desc = getLongDescription(db_name);
    }
    bool custom_desc = false;
    const CrawlHashTable &props = env.properties;
    if (props.exists(LONG_DESC_KEY))
    {
        const CrawlHashTable &desc_table = props[LONG_DESC_KEY].get_table();
        // First try the modified name, then the base name.
        std::string key = raw_feature_description(feat);
        if (!desc_table.exists(key))
            key = raw_feature_description(feat, NUM_TRAPS, true);
        if (desc_table.exists(key))
        {
            long_desc   = desc_table[key].get_string();
            custom_desc = true;
        }
        std::string quote = getQuoteString(key);
        if (!quote.empty())
            db_name = key;
    }
    desc += long_desc;

Deletion in crawl-ref/source/describe.cc at line 2043 [11.3736416]
B:BD[23.2126] → [24.6843:6884]
```
    desc += getLongDescription(db_name);
```

Replacement in crawl-ref/source/describe.cc at line 2044 [11.3736416]

B:BD[23.2164] → [18.20812:20866]

    desc += _get_feature_description_wide(grd[x][y]);

[23.2164]

[11.3844087]

    if (!custom_desc)
        desc += _get_feature_description_wide(grd[x][y]);

Insertion in crawl-ref/source/describe.cc at line 2058 [11.3736416]

[22.5281]

}
void set_feature_desc_long(const std::string &raw_name,
                           const std::string &desc)
{
    ASSERT(!raw_name.empty());
    CrawlHashTable &props = env.properties;
    if (!props.exists(LONG_DESC_KEY))
        props[LONG_DESC_KEY].new_table(SV_STR);
    CrawlHashTable &desc_table = props[LONG_DESC_KEY];
    if (desc.empty())
        desc_table.erase(raw_name);
    else
        desc_table[raw_name] = desc;

Insertion in crawl-ref/source/dat/icecave.des at line 46 [25.2680]

[25.3616]

end
}}
{{
-- Alter short feature descriptions for all ice cave destination vaults.
function ice_cave_feat_descs()
    dgn.set_feature_desc_short("rock wall", "ice covered $BASE")
    dgn.set_feature_desc_short("gate leading back to the Dungeon",
                               "ice covered $BASE")
    dgn.set_feature_desc_short("empty arch of ancient stone",
                               "ice choked $BASE")
    dgn.set_feature_desc_short("Some shallow water",
                               "Some ice crusted shallow water")
    dgn.set_feature_desc_short("Some deep water",
                               "Some ice crusted deep water")
    dgn.set_feature_desc_long("Some deep water",
                              "It looks freezing!");

Insertion in crawl-ref/source/dat/icecave.des at line 65 [25.2680]
[25.3620]
[25.3620]
```
dgn.set_lt_callback("ice_cave", "ice_cave_feat_descs")
```