[Bug]: onTokenMove responds to multiple tokens with different PC visibility settings

[pizzystrizzy]

Describe the Bug

If you have two tokens, and set one to be visible to PCs and the other to not be visible to PCs, "onTokenMove" is called rather than the event "onMultipleTokensMove"

To Reproduce

1. Create a library token with the macros 'onTokenMove' and 'onMultipleTokensMove' and fill them with enough text so you can tell which one is executing when.

2. place two tokens on the map, setting one to be PC visible and one not to be PC visible

3. Select both tokens at the same time and move them

Expected Behaviour

When you select two or more tokens that are all PC visible, or are all not PC visible, and you move them, the event 'onMultipleTokensMove' executes. That is what I would expect when selecting two tokens with different visibility settings as well.

Screenshots

No response

MapTool Info

1.18.6

Desktop

Windows

Additional Context

No response

[FullBleed]

I did some basic testing and I'm not sure that I understand the issue... You might want to share a campaign file that better illustrates what you're seeing and what you're expecting to see.

[pizzystrizzy]

I did some basic testing and I'm not sure that I understand the issue... You might want to share a campaign file that better illustrates what you're seeing and what you're expecting to see.

Are you saying that you got onMultipleTokensMove to execute by moving two tokens, only one of which is "Visible to Players"? I could send you a cmpgn file but it would literally be just the steps to reproduce. If you move two tokens that are both Visible to Players, onMultipleTokensMove executes, but if only one has that checked, it doesn't execute.

[pizzystrizzy]

It looks like, more specifically, neither onTokenMove or onMultipleTokensMove are triggered by tokens that aren't visible to players. But that means that if you grab one of each, and move them, and your onTokenMove macro wants to, say, get the properties of the selected token, it's going to fail because you actually have two tokens selected.

[Baaaaaz]

I've added clarification to https://wiki.rptools.info/index.php/Guide_to_onTokenMove (as per the current code) that the onTokenMove event is not triggered by tokens which are not visible to players.

That wiki page did already have the following suggestion which seems relevant to the above comments:

If you use both events at the same time it is recommended that you use the tokens.moveCount variable in onTokenMove and abort if its >1 and let onMultipleTokensMove handle it.

[Baaaaaz]

It looks like, more specifically, neither onTokenMove or onMultipleTokensMove are triggered by tokens that aren't visible to players. But that means that if you grab one of each, and move them, and your onTokenMove macro wants to, say, get the properties of the selected token, it's going to fail because you actually have two tokens selected.

Rather than using getSelected() or similar in onTokenMove, the wiki states:
"The moved token is the token in context, so you can get its id with currentToken()."

[Jmr3366]

There could be something else going on that may contribute to the symptom. I believe in the use case, and in every multi-token selection, there is a "master token". This token is the only token that is looked at for AI movement, blocking, etc. it does not cycle through each token on a multi-token move for the path each token takes, the code looks at one token, and the rest will confirm with that master tokens movement, regardless of blocking and any other "rules".
Not exactly the same and what I'm stating may only be another variable in this mix
#3538

[pizzystrizzy]

I've added clarification to https://wiki.rptools.info/index.php/Guide_to_onTokenMove (as per the current code) that the onTokenMove event is not triggered by tokens which are not visible to players.

That wiki page did already have the following suggestion which seems relevant to the above comments:

If you use both events at the same time it is recommended that you use the tokens.moveCount variable in onTokenMove and abort if its >1 and let onMultipleTokensMove handle it.

That suggestion isn't particularly helpful because it results in it executing onTokenMove, but when you get the ID of the selected token, you get an array of two IDs. But using currentToken() I suppose is the solution.

All that said, it would be nice if there were a way for non-PC visible tokens to trigger the events as well.

[FullBleed]

That suggestion isn't particularly helpful because it results in it executing onTokenMove, but when you get the ID of the selected token, you get an array of two IDs. But using currentToken() I suppose is the solution.

Yeah, using getSelected() definitely was causing some issues in my testing, but I just couldn't be sure if it was a bug or whether it was "expected behaviour" given the way the event works. Events are quirky and limited in scope. Improved documentation would be helpful, so I appreciate Baaaaaz making some updates.

All that said, it would be nice if there were a way for non-PC visible tokens to trigger the events as well.

Perhaps this might be better suited as a feature request...

I'm not even sure why token visibility was hardcoded into the event... I would have rather that been left to the macro coder. I tried using the tokens.moveCount trick to get around the multi-select issue but if the token is not visible the variable doesn't return the correct number despite getSelected still returning two IDs, etc.