Using <Local Player> in scripts may be problematic in multiplayer and replays

[Caball009]

• Related issue Playing sounds exclusively for "Local Player" can mismatch the game  #386

The use of <Local Player> in scripts refers to the actual local player for live matches, but refers to the observer for replays. That means that some scripts that were meant to execute for <Local Player> may be skipped in replay mode, potentially leading to a mismatch.

For multiplayer the issue already becomes apparent during the live match, because <Local Player> only refers to the actual local player and not the player whose data should used be for the script condition. This likely makes the use of <Local Player> very mismatch prone in multiplayer matches.

[kABUSE1]

Please don't touch this. I need this behavior for reasons.

Incorrect scripting of maps using Local Player so that it mismatches the game or breaks replays is just bad scripting (=skill issue). This doesn't need to be fixed on engine-level.

[xezon]

Can you explain?

[kABUSE1]

You can use Local Player with a condition, to check if the active game session is a Replay or a Live Game. I need this in hacky edge-case scenarios.

I have said this before: Please don't change Local Player, apart from fixing the bug that playing localized sounds can cause mismatch, as per related issue linked above.

Apart from that, Local Player is working as intended.

If Local Player causes other issues, it's because it was incorrectly used by the person who scripted the map. Incorrectly scripted maps should be fixed on map level, not on game engine level.

Also, there is no randomness in it. A map that is incorrectly scripted is not "more prone to mismatches", it just instantly mismatches every time, when the bad script runs and mismatches data.

[Caball009]

There's a clear potential source of mismatches here, so suggesting very strongly that we don't touch this because the fix may impact your scripts is not the right approach. Calling the improper use of <Local Player> a 'skill issue' doesn't help players experiencing a mismatch because of it. We should investigate how can we fix this, and then weigh the pros and cons, and see if we can come up with a good solution.

Also, there is no randomness in it. A map that is incorrectly scripted is not "more prone to mismatches", it just instantly mismatches every time, when the bad script runs and mismatches data.

I don't see it that way. Scripts are likely conditional, so there's no guarantee that a script always causes an issue, because sometimes its conditions are met and sometimes they never are.

[xezon]

Other than <Local Player>, is there another player for "Local Player that is the same in match and replay"? If not, then this is highly suspicious. If there is, then it is probably fine?

[kABUSE1]

I don't think you understand what I mean.

Who even told you that <Local Player> needs fixing? What maps are you talking about?

The way AdrianeYves described <Local Player> usage in #386 is just plainly wrong. This is not what <Local Player> is for. It is not supposed to replace or summarize player0 - player7 (aka addressing player slots as per their lobby slot). It is a completely different thing.

It makes no sense to pretend that it needs fixing. It's working the way it is meant to work. People just don't understand how it is meant to work and call it a bug instead. And now you want to punish people who actually understand what it does and use it correctly.

You also make it sound as if this is a common source for mismatches in many maps. It is not. First of, we are talking only about custom maps with custom scripts, so stuff like AOD maps or casino maps. Normal maps don't have scripts. And if they have scripts, they will never require the usage of <Local Player>. In 99.9% of cases, if <Local Player> is used, it is used incorrectly. There are only very few edge-cases where <Local Player> is required. And these edge-case solutions are no longer achievable, if you for some crazy reason decide to change <Local Player>. You can check the scripts in Versus AOD. On that map you can pay to make object types buildable. So every player individually has to pay $20.000 to unlock laser turrets for themselves. It is the only map in existence where this technique is used.

The game will also crash if the map maker tries to spawn a team that doesn't exist. Will you now fix this mapping error on engine level as well? It makes no sense fixing map-level user errors on engine level.

If you still think that <Local Player> needs fixing, you still don't understand what it is intended for. Please reach out to me in discord and I can explain it in a call or something how to correctly use it.

[Stubbjax]

In 99.9% of cases, if <Local Player> is used, it is used incorrectly.

This is indicative of a huge UI/UX or design issue that should be addressed regardless.

[kABUSE1]

It's the first entry in this list of players, when you create scripts.

I wouldn't call it a huge UI/UX issue if scripter decides to select a player whos function he does not understand.

Again, you are blowing this issue up like crazy for absolutely no reason. Local-player related mismatch issues are FAR less common than you make them out to be.

[Stubbjax]

I wouldn't call it a huge UI/UX issue if scripter decides to select a player whos function he does not understand.

I certainly would, especially with a 99.9% misuse rate as you suggest. If it's not easy to understand then it is worth exploring how it can be communicated better.