fiddlerwoaroof/crawl - Change FUEQ344KIQEMOSXUYPA4JVNZPITKCFG4ZJ635WVXHAP7VWVVZLYQC

Let markers change the description of any feature

Allow markers to change the short and/or long description of any feature, not just portal vault entrances. The feature_description() and feature_description_long() functions have been removed from the mapmark classes and turned into ordinary properties. Also added the marker property "door_description_suffix", which can be used to alter the short description of (known) doors by appending a string to them.

Created by Matthew Cline on October 25, 2009

FUEQ344KIQEMOSXUYPA4JVNZPITKCFG4ZJ635WVXHAP7VWVVZLYQC

Dependencies

In channels

main

Change contents

Deletion in crawl-ref/source/mapmark.h at line 42 [6.10602]

B:BD[5.2265] → [5.2265:2318]

B:BD[5.2318] → [2.2562:2620]

    virtual std::string feature_description() const;
    virtual std::string feature_description_long() const;

Deletion in crawl-ref/source/mapmark.h at line 113 [6.10602]
B:BD[5.2471] → [5.2471:2516]
B:BD[5.2516] → [2.2621:2671]
```
    std::string feature_description() const;
    std::string feature_description_long() const;
```
Deletion in crawl-ref/source/mapmark.h at line 142 [6.10602]
B:BD[7.550] → [7.550:595]
```
    std::string feature_description() const;
```
Deletion in crawl-ref/source/mapmark.cc at line 66 [6.13502]
B:BD[6.14683] → [5.2829:2884]
B:BD[5.2884] → [2.2673:2692]
```
}
std::string map_marker::feature_description() const
{
    return ("");
```
Deletion in crawl-ref/source/mapmark.cc at line 68 [6.13502]
B:BD[2.2695] → [2.2695:2752]
∅:D[2.2752] → [5.2884:2906]
B:BD[5.2884] → [5.2884:2906]
```
std::string map_marker::feature_description_long() const
{
    return ("");
}
```

Deletion in crawl-ref/source/mapmark.cc at line 372 [6.13502]

B:BD[5.3696] → [5.3696:3808]

∅:D[5.3808] → [8.11502:11503]

B:BD[8.11502] → [8.11502:11503]

B:BD[8.11503] → [2.2753:2870]

}
std::string map_lua_marker::feature_description() const
{
    return (call_str_fn("feature_description"));
}
std::string map_lua_marker::feature_description_long() const
{
    return (call_str_fn("feature_description_long"));

Replacement in crawl-ref/source/mapmark.cc at line 516 [6.13502]

B:BD[7.2084] → [7.2084:2146]

std::string map_wiz_props_marker::feature_description() const

[7.2084]

[7.2146]

std::string map_wiz_props_marker::property(const std::string &pname) const

Replacement in crawl-ref/source/mapmark.cc at line 518 [6.13502]
B:BD[7.2148] → [7.2148:2177]
∅:D[7.2177] → [9.10793:10795]
B:BD[9.10793] → [9.10793:10795]
```
    return property("desc");
}
```
[7.2148]
[7.2178]
```
    if (pname == "desc")
        return property("feature_description");
```
Deletion in crawl-ref/source/mapmark.cc at line 521 [6.13502]
B:BD[7.2179] → [7.2179:2256]
```
std::string map_wiz_props_marker::property(const std::string &pname) const
{
```

Replacement in crawl-ref/source/mapmark.cc at line 558 [6.13502]

B:BD[7.3189] → [7.3189:3256]

    return make_stringf("wizard props: ") + feature_description();

[7.3189]

[7.3256]

    return "Wizard props: " + property("feature_description");

Deletion in crawl-ref/source/directn.cc at line 2874 [11.3697945]
B:BD[10.6129] → [10.6129:6132]
∅:D[10.6132] → [12.19429:19496]
B:BD[5.8502] → [12.19429:19496]
∅:D[12.19496] → [5.8568:8570]
B:BD[5.8568] → [5.8568:8570]
B:BD[5.8570] → [13.6668:6738]
∅:D[13.6738] → [5.8629:8815]
B:BD[5.8629] → [5.8629:8815]
∅:D[5.8815] → [14.473863:473869]
∅:D[15.980763] → [14.473863:473869]
B:BD[14.473863] → [14.473863:473869]
B:BD[14.473869] → [5.8816:8833]
```
}
static std::string _marker_feature_description(const coord_def &p)
{
    std::vector<map_marker*> markers = env.markers.get_markers_at(p);
    for (int i = 0, size = markers.size(); i < size; ++i)
    {
        const std::string desc = markers[i]->feature_description();
        if (!desc.empty())
            return (desc);
    }
    return ("");
```

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

[15.980817]

[16.49958]

    std::string marker_desc = 
        env.markers.property_at(where, MAT_ANY, "feature_description");
    if (!marker_desc.empty())
    {
        if (bloody)
            marker_desc += ", spattered with blood";
        return thing_do_grammar(dtype, add_stop, false, marker_desc);
    }

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

[17.5330]

        const std::string door_desc_suffix = 
            env.markers.property_at(where, MAT_ANY,
                                    "door_description_suffix");
        desc += door_desc_suffix;

Insertion in crawl-ref/source/directn.cc at line 2953 [11.3697945]
[5.8938]
[18.3337]
```
        // Should have been handled at the top of the function.
```

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

B:BD[5.9018] → [16.50240:50298]

                    _marker_feature_description(where)));

[5.9018]

[15.982341]

                    "UNAMED PORTAL VAULT ENTRY"));

Deletion in crawl-ref/source/describe.cc at line 2009 [11.3736416]

B:BD[19.11826] → [3.3002:3004]

∅:D[3.3004] → [20.1079:1080]

B:BD[11.3844087] → [20.1079:1080]

B:BD[20.1080] → [2.2967:3324]

}
static std::string _marker_feature_description(const coord_def &pos)
{
    std::vector<map_marker*> markers = env.markers.get_markers_at(pos);
    for (int i = 0, size = markers.size(); i < size; ++i)
    {
        const std::string desc = markers[i]->feature_description_long();
        if (!desc.empty())
            return (desc);
    }
    return ("");

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

[10.7421]


    const std::string marker_desc =
        env.markers.property_at(pos, MAT_ANY, "feature_description_long");

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

B:BD[10.7422] → [2.3328:3369]

    if (feat == DNGN_ENTER_PORTAL_VAULT)

[10.7422]

[2.3369]

    if (!marker_desc.empty())
    {
        long_desc   = marker_desc;
        custom_desc = true;
    }
    if (feat == DNGN_ENTER_PORTAL_VAULT && !custom_desc)

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

B:BD[2.3375] → [2.3375:3550]

        std::string _desc = _marker_feature_description(pos);
        if (!_desc.empty())
        {
            long_desc   = _desc;
            custom_desc = true;
        }

[2.3375]

[2.3550]

        long_desc = "UNDESCRIBE PORTAL VAULT ENTRANCE.";
        custom_desc = true;

Insertion in crawl-ref/source/dat/clua/lm_toll.lua at line 62 [22.5280]

[21.3710]

[22.6668]

  end
  if pname == 'feature_description_long' then
    return self:feature_description_long(marker)

Deletion in crawl-ref/source/dat/clua/lm_pdesc.lua at line 33 [5.10433]

∅:D[18.10001] → [5.11137:11196]

B:BD[5.11137] → [5.11137:11196]

B:BD[5.11196] → [18.10002:10042]

B:BD[18.10042] → [2.4452:4561]

end
function PortalDescriptor:feature_description(marker)
  return self:unmangle(self.props.desc)
end
function PortalDescriptor:feature_description_long(marker)
  return self:unmangle(self.props.desc_long)

Insertion in crawl-ref/source/dat/clua/lm_pdesc.lua at line 36 [5.10433]

[5.11276]

[18.10043]

  if pname == 'feature_description' then
    return self:unmangle(self.props.desc)
  elseif pname == 'feature_description_long' then
    return self:unmangle(self.props.desc_long)
  end

Insertion in crawl-ref/docs/develop/level_design.txt at line 1858 [23.350]

[4.3694]


* door_description_suffix: A string to append to the description of
      any door the marker is on.  This should be used for doors
      rather than the feature_description property since it elemintates
      the need to track if the door is opened or closed, plus it will
      have no effect on secret doors which have yet to be detected.
* feature_description: What to use as the short description of the
      cell's feature.

Insertion in crawl-ref/docs/develop/level_design.txt at line 1868 [23.350]

[4.3695]

* feature_description_long: What to use as the long description of the
      cell's feature.