Droppeth - reonZ/pf2e-toolbelt GitHub Wiki
This feature allows any user to drop items directly on the board from an actor sheet, the world sidebar or a compendium. To trigger this feature, user must hold the [Ctrl]
before starting to drag the item.
To manage this feature, the module creates a Loot
actor (and then a token) to host the dropped items, if only one item (independent of its Quantity
) is present in the actor, the actor's image and name will reflect the ones from the item ; If more than one item is present, a generic image and name will be used instead.
The Loot
actors are placed in a folder named __Droppeth
and are automatically deleted whenever their associated token is removed from the board.
[!IMPORTANT] This feature requires a GM to be online to function.
[!NOTE] This makes use of the With Container Content setting.
Settings
Enabled 🌎
Allow users to drop items on the canvas by holding the [Ctrl]
key.
Remove on Empty 🌎 ✅
Should the token & actor be removed when there are no more items.
Light Source 🌎 ✅
Should the dropped item emit light.
[!NOTE] Tokens emit light only if a single item is present in the actor's inventory.
Send Message to Chat 🌎 ✅
When items are dropped from an actor, a chat message will be generated.
Keybinds
Droppeth Modifier
Let you remap the key that needs to be held during the drag & drop of an item to drop it on the ground.
API
/*
* retrieve the api object for this feature
*/
game.modules.get("pf2e-toolbelt")?.api.droppeth;
/*
* drop an item on the ground at location x,y
* a request will be sent to the GM if the current user isn't
*/
droppethRequest: (
options: {
item: PhysicalItemPF2e | string;
x: number;
y: number;
quantity?: number;
},
userID?: string
) => void