llde / xOBSE

Oblivion Script extender source
243 stars 35 forks source link

llde#41: fix Ref Walking Functions documentation; update code example #217

Closed ir4ne closed 10 months ago

ir4ne commented 11 months ago

Fixed following errors in Ref Walking Functions documentation:

  1. It states that GetFirstRef/GetNextRef functions can only be used within Label/Goto loop, however, as it was mentioned here, they can also be used within While loop.
  2. Small inaccuracy in GetFirstRef description - for depth = 2 it would be player's cell + 24 adjacent cells, not 25.

Also updated code example with While loop.

llde commented 11 months ago

Can you define the "WARNING! Some people have reported that it's not working that way" better?

ir4ne commented 11 months ago

Yeah, it's probably a bit too loud statement. There is an unconfirmed bug https://github.com/llde/xOBSE/issues/72. Should I say "Note: there have been reports that includeInactiveRefs doesn't work" and attach link instead?