equipment toggle, sounds, etcetera

Author: MrVauxs

CHANGELOG.md

@@ -12,10 +12,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- `atLocation`, `radius`, `constrainedByWalls`, `volume`, and `duration` support for sound effects.
+- `equipment:[state]` roll options for `toggle` animations. Use them wisely.
 - `templateAsOrigin` preset option for `ranged` animations. Allows to have the template to be the source of the animation, as opposed to the owner token. Allows for template animations detached from token location.
 
 ### Changed
 
+- The Sounds Database to use a two-digit indexes (01, 02, 03, etc.)
 - Inner Radiance Torrent (P) to use `templateAsOrigin`.
 
 ### Fixed

animations/spells.json

@@ -145,4 +145,4 @@
 			}
 		}
 	]
-}
+}

src/assets/soundDb.ts

@@ -1,26 +1,28 @@
+// Start from 01
+
 const p = 'modules/pf2e-graphics/assets/library'
 const database = {
 	lightning_bolt: {
 		impact: {
-			0: `${p}/sounds/ovani-sounds/Magic/Shock/Lightning Bolt Impact A.wav`,
-			1: `${p}/sounds/ovani-sounds/Magic/Shock/Lightning Bolt Impact B.wav`,
-			2: `${p}/sounds/ovani-sounds/Magic/Shock/Lightning Bolt Impact C.wav`,
+			'01': `${p}/sounds/ovani-sounds/Magic/Shock/Lightning Bolt Impact A.wav`,
+			'02': `${p}/sounds/ovani-sounds/Magic/Shock/Lightning Bolt Impact B.wav`,
+			'03': `${p}/sounds/ovani-sounds/Magic/Shock/Lightning Bolt Impact C.wav`,
 		},
 	},
 	bow: {
-		0: `${p}/sounds/gamedev-market/BowWhistleShot1.wav`,
-		1: `${p}/sounds/gamedev-market/BowWhistleShot2.wav`,
-		2: `${p}/sounds/gamedev-market/BowWhistleShot3.wav`,
-		3: `${p}/sounds/gamedev-market/BowWhistleShot4.wav`,
-		4: `${p}/sounds/gamedev-market/BowWhistleShot5.wav`,
-		5: `${p}/sounds/gamedev-market/BowWhistleShot6.wav`,
-		6: `${p}/sounds/gamedev-market/BowWhistleShot7.wav`,
+		'01': `${p}/sounds/gamedev-market/BowWhistleShot1.wav`,
+		'02': `${p}/sounds/gamedev-market/BowWhistleShot2.wav`,
+		'03': `${p}/sounds/gamedev-market/BowWhistleShot3.wav`,
+		'04': `${p}/sounds/gamedev-market/BowWhistleShot4.wav`,
+		'05': `${p}/sounds/gamedev-market/BowWhistleShot5.wav`,
+		'06': `${p}/sounds/gamedev-market/BowWhistleShot6.wav`,
+		'07': `${p}/sounds/gamedev-market/BowWhistleShot7.wav`,
 	},
 	crossbow: {
-		0: `${p}/sounds/gamedev-market/Crossbow Shot A.wav`,
-		1: `${p}/sounds/gamedev-market/Crossbow Shot B.wav`,
-		2: `${p}/sounds/gamedev-market/Crossbow Shot C.wav`,
-		3: `${p}/sounds/gamedev-market/Crossbow Shot D.wav`,
+		'01': `${p}/sounds/gamedev-market/Crossbow Shot A.wav`,
+		'02': `${p}/sounds/gamedev-market/Crossbow Shot B.wav`,
+		'03': `${p}/sounds/gamedev-market/Crossbow Shot C.wav`,
+		'04': `${p}/sounds/gamedev-market/Crossbow Shot D.wav`,
 	},
 }
 

src/storage/AnimCore.ts

@@ -1,5 +1,5 @@
 import { ErrorMsg, dedupeStrings, dev, devMessage, findTokenByActor, getPlayerOwners, log, mergeObjectsConcatArrays, nonNullable } from 'src/utils.ts'
-import type { Entries, TokenOrDoc } from 'src/extensions'
+import type { TokenOrDoc } from 'src/extensions'
 import { settings } from 'src/settings'
 import { type PresetKeys, presets } from './presets'
 

src/storage/presets.ts

@@ -123,8 +123,20 @@ export const helpers = {
 
 		return seq
 	},
-	genericSoundFunction(seq: SoundSection, _item: ItemPF2e, _target: Target, options: SoundConfig) {
+	genericSoundFunction(seq: SoundSection, _item: ItemPF2e, target: Target, options: SoundConfig) {
 		seq.file(options?.file)
+
+		if (options?.atLocation)
+			seq.atLocation(target, options.atLocation)
+		if (options?.radius)
+			seq.radius(options.radius)
+		if (options?.constrainedByWalls)
+			seq.constrainedByWalls(options.constrainedByWalls)
+		if (options?.volume)
+			seq.volume(options.volume)
+		if (options?.duration)
+			seq.duration(options.duration)
+
 		return seq
 	},
 }
@@ -136,12 +148,17 @@ type presetOptions<T> =
 
 interface rangedOptions {
 	bounce: { file: string, sound: SoundConfig }
-	templateAsOrigin: true
+	templateAsOrigin: boolean
 }
 
 interface SoundConfig {
 	file: string
 	waitUntilFinished: number
+	atLocation: Parameters<SoundSection['atLocation']>[1]
+	radius: number
+	volume: number
+	duration: number
+	constrainedByWalls: boolean
 }
 
 export interface EffectOptions<T extends PresetKeys> {

src/triggers/toggle.ts

@@ -1,16 +1,42 @@
 import { devMessage } from 'src/utils'
 
+function check(i: ItemPF2e, o: { _id: string, system: any }) {
+	const result = {
+		bool: false,
+		options: [] as string[],
+	}
+
+	if (i.system.rules.length) {
+		result.bool = true
+	}
+
+	if (o?.system?.equipped?.carryType || o?.system?.equipped?.handsHeld) {
+		result.bool = true
+		// @ts-expect-error These do exist.
+		if (Number(i.handsHeld) === Number(i.hands.replace('+', ''))) {
+			result.options.push(`equipment:wielded`)
+		} else {
+			result.options.push(`equipment:${o.system.equipped.carryType}`)
+		}
+	}
+
+	return result
+}
+
 function trifectaFunc(item: ItemPF2e, _options: { _id: string, system: Partial<ItemPF2e['system']> }, _id: ItemPF2e['id']) {
-	if (!item.actor || !item.system.rules.length) return
+	const { bool, options: newOptions } = check(item, _options)
+	// If there is no actor, don't.
+	// 	If there are no rules AND no special changes, don't. || If there are either rules or special changes, continue.
+	if (!item.actor || !bool) return
 
 	const deliverable = {
-		rollOptions: [...item.getRollOptions(), ...item.actor.getRollOptions()].sort(),
+		rollOptions: [...item.getRollOptions(), ...item.actor.getRollOptions(), ...newOptions],
 		trigger: 'toggle' as const,
 		actor: item.actor,
 		item,
 	}
 
-	devMessage('Toggle Hook Data', deliverable, _options)
+	devMessage('Toggle Hook Data', deliverable, _options, newOptions)
 	window.pf2eGraphics.AnimCore.findAndAnimate(deliverable)
 }