Group Selection - Jagusti/fvtt-wfrp4e-gmtoolkit GitHub Wiki
What this does
A standard utility getGroup()
is available for group selection, to be used by macros and other functionality and for setting default filter criteria.
- It is used internally within the GM Toolkit but is accessible to macro and other module authors.
- The function returns an array of users, characters, tokens or combatants.
- Group selection can be optionally filtered by assigned user status. Actors that are not assigned to players are removed from filtered results, but will appear in unfiltered results.
Usage
- This utility function can be called in macros with
game.gmtoolkit.utility.getGroup(groupType, {options})
.groupType
options are defined here.- The available
options
are:active
isundefined
by default, but can be set totrue
(user is logged in) orfalse
(user is not logged in)present
isundefined
by default, but can be set totrue
orfalse
to indicate whether to filter if user is viewing scene or actor has token in scene.interaction
isundefined
by default, but can be set to return only those group members that aretargeted
orselected
on the canvas.
- Actors that are not assigned to players (eg, NPCs) are removed from
active
filtered results, but will appear in unfiltered results if appropriate. - Tokens and combatants are always considered
present
on a given scene.
Group Definitions
#TODO: Add wiki summary of https://github.com/Jagusti/fvtt-wfrp4e-gmtoolkit/blob/863a5f09cd3eaa87c4a0b25f8e36206eda652a53/modules/utility.mjs#L229-L235)
Usage Settings
There are no user configuration options for this utility.
However, settings that leverage the functionality include:
Conflicts / Known Issues
None.
Source
History
- Version 0.9.4. Introduce getGroup() functionality.