`LAND_SMALL_BRUSH` / `LAND_MEDIUM_BRUSH` / `LAND_LARGE_BRUSH`

[Martin-Pitt]

While investigating a related ground function (llSetGroundTexture has no documentation on the return value, still a mystery), I noticed a ridiculous situation with llModifyLand.

The small brush reads as:

LAND_SMALL_BRUSH:
  tooltip: 'Use a small brush size.\nNOTE: This value is incorrect, a small brush
    should be 0.'
  type: integer
  value: 1

Same with the other brush constants

Is this a legacy error? If the LSL definition is really the source of truth — could this be amended and should it?

This issue is unimportant/trivial in the grand scheme of things and I was thinking of not bringing it up, but it does help settle how far reaching error fixes to the definition file can be and what the resolution process to issues could be as well as a case study. An alternative fix for example could be a new set of constants with the correct enumeration and deprecating the old constants.

---

This repo is using Opire - what does it mean? 👇

💵 Everyone can add rewards for this issue commenting /reward 100 (replace 100 with the amount).
🕵️‍♂️ If someone starts working on this issue to earn the rewards, they can comment /try to let everyone know!
🙌 And when they open the PR, they can comment /claim #14 either in the PR description or in a PR's comment.

🪙 Also, everyone can tip any user commenting /tip 20 @Martin-Pitt (replace 20 with the amount, and @Martin-Pitt with the user to tip).

📖 If you want to learn more, check out our documentation.

[HaroldCindy]

I had a look at the git blame, and yep, this is a legacy error. Part of this work was moving those constant definitions out of the lexer definition itself, and those values were in the lexer going back at least 20 years.

Looking at the code for llModifyLand():

const F32 LAND_BRUSH_SIZE[LAND_BRUSH_SIZE_COUNT] = {1.0f, 2.0f, 4.0f};

// ...

S32 brush_radius_index = args[1].mInteger;

// ...

// we clamp the brush size
brush_radius_index = llclamp(brush_radius_index, 0,
                               LAND_BRUSH_SIZE_COUNT - 1);

So SMALL is really MEDIUM, and MEDIUM is really LARGE, only LARGE is correct due to the clamping. Since there's no notion of stdlib versioning in LSL, I don't know if those definitions can be changed though...

@bennettgoble any thoughts?

[HaroldCindy]

@Martin-Pitt Regarding llSetGroundTexture(), I don't see the return value being used at all in the implementation, so it's likely always 0. Errors are instead exposed over the script debug channel.

[bennettgoble]

@HaroldCindy yeah I'm thinking we may want to document but not fix this problem as it could break content.