🔨 Support for "ZoneInEntitiesRequired"

[ghost]

I affirm:

• [x] I understand that if I do not agree to the following points by completing the checkboxes my issue will be ignored.
• [X] I have read and understood the Contributing Guide and the Code of Conduct.
• [X] I have searched existing issues to see if the issue has already been opened, and I have checked the commit log to see if the issue has been resolved since my server was last updated.

Describe the feature

The zone-in packet contains a counter value that indicates how many specially-marked entity packets need to be received before the client can continue on after the zone-in.

Packet 0x00A:

• "ZoneInEntitiesRequired": U16 @ 0xAC

Existing code: ref<uint8>(0xAC) = csid > 0 ? 0x01 : 0x00; // if 0x01 then pause between zone

Packet 0x00E:

• "RequiredEntity": bit 0 @ 0x1A

Relevant code: ref<uint16>(0x1A) = PEntity->m_TargID << 1; (that bit 0 is where this flag lives)

AFAIR entities like the ships always have this bit set.

If you're on retail and ever notice that some zones sit on a black screen a little longer than others when you zone in, this is why.

[github-actions[bot]]

✨ Thanks for the report! ✨

This is a friendly automated reminder that the maintainers won't look at your report until you've properly completed all of the checkboxes in the pre-filled template.

[TeoTwawki]

If you're on retail and ever notice that some zones sit on a black screen a little longer than others when you zone in, this is why.

neat!

[claywar]

@zach2good Interesting CI fail on this for checks, need to tolower/upper the fields for checkboxes.

[WinterSolstice8]

Incredibly useful information you've been posting. Thank you.

[claywar]

This is pretty huge, and I've noticed in several caps that even SE doesn't leverage this. Would be interesting to check modern day caps for this implementation.

EDIT: Doesn't leverage in all cases

[ghost]

One oddity I noticed when trying to datamine this is that, I think it's the mog house case, when you enter a mog house, the required entity count for the associated zone might be non-zero, but there are no actual corresponding entities. The client may have something to bypass this check when entering a mog house.

[TeoTwawki]

One oddity I noticed when trying to datamine this is that, I think it's the mog house case, when you enter a mog house, the required entity count for the associated zone might be non-zero, but there are no actual corresponding entities. The client may have something to bypass this check when entering a mog house.

likely because the mog house isn't its own "real" zone, and counts as wherever you entered from for most purposes such as cs events and messages.