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 bound keybind (default[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.

[!IMPORTANT] The Loot actors are placed in a folder named __Droppeth and are automatically deleted whenever their associated token is removed from the board or when they are empty.

[!IMPORTANT] This feature requires a GM to be online to function.

Settings

Enabled 🌎

Allow users to drop items on the canvas by holding the assigned key.

Light Source 🌎 ✅

Should the dropped item emit light.

[!NOTE] Tokens emit light only if a single item is present in the actor's inventory.

Keybinds

Droppeth Modifier (Ctrl)

Key held when dropping an item on the ground.

API

game.toolbelt?.api.droppeth = {
    /** request an item to be dropped on the ground at location x,y */
    droppethRequest: (options: DroppethOptions) => void
}
type DroppethOptions = {
    item: PhysicalItemPF2e,
    x: number,
    y: number,
    quantity?: number,
};