Annotate some of the functionality related to worldviews #6600
Conversation
Garanas
added
the
area: documentation
|
There's some interesting possibilities here with world views. It's sad that the original interface of the module(s)* is not friendly towards refactoring. For example, the value |
|
|
||
| --- Primary view, if in split screen this is the left view. The left view is always visible. | ||
| --- | ||
| --- Most features that rely on a worldview only work for the left worldview. One example is the reclaim overlay. |
There was a problem hiding this comment.
This is just a lua implementation detail, I don't think it is necessary in the documentation, as it is absolutely possible to have multi-view UI elements.
There was a problem hiding this comment.
Yes it is, but it's an intentional choice that we do not. For example, the reclaim overlay would be too expensive.
There was a problem hiding this comment.
It's good to document it as a ton of UI Lua being coupled to this specific worldview, but I think what stands out to me with this specific comment is that "features that rely on a worldview only work for the left worldview" sounds as if the engine depends on viewLeft, so I'd change it to something that specifies the Lua coupling more specifically.
Co-authored-by: lL1l1 <[email protected]>
Co-authored-by: lL1l1 <[email protected]>
Co-authored-by: lL1l1 <[email protected]>
Co-authored-by: lL1l1 <[email protected]>
Co-authored-by: lL1l1 <[email protected]>
| if GetNumRootFrames() < 2 then return end | ||
|
|
||
| --------------------------------------------------------------------------- | ||
| -- defensive programming |
| if GetNumRootFrames() < 2 then return end | ||
|
|
||
|
|
||
| --------------------------------------------------------------------------- |
Description of the proposed changes
Annotates the functionality related to world views. Documents to some degree how secondary worldviews (that run on secondary adapters) work.
Testing done on the proposed changes
Not necessary, these are just changes to annotations.
Additional context
In preparation of a feature for HintHunter to toggle the split screen.
Checklist