BlueGit

timfa questward

Files

questward / shared / items / letters.js

letters.js

letters.js 2.0 KiB Download Raw
1import { ItemId } from "../definitions/items.js";
2
3/** @param {object|null|undefined} stack */
4export function isLetterStack (stack)
5{
6 return (stack?.itemId | 0) === ItemId.letter && stack?.instance?.kind === "letter";
7}
8
9/**
10 * True when this character authored the letter (system letters use authorCharacterId 0).
11 * @param {object|null|undefined} stack
12 * @param {number} characterId
13 */
14export function isLetterWrittenBy (stack, characterId)
15{
16 if (!isLetterStack(stack))
17 { return false; }
18 const authorId = Number(stack.instance?.authorCharacterId);
19 return authorId > 0 && authorId === Number(characterId);
20}
21
22/**
23 * Letters you did not write cannot be pigeon'd or CE-listed to reach another player.
24 * Inheritance is handled separately outside these checks.
25 * @param {object|null|undefined} stack
26 * @param {number} characterId
27 */
28export function canTransferLetterToOtherPlayers (stack, characterId)
29{
30 if (!isLetterStack(stack))
31 { return true; }
32 return isLetterWrittenBy(stack, characterId);
33}
34
35/**
36 * A ground letter dropped by someone who did not write it is private to that dropper.
37 * Accepts a full ground item (`stack` + `droppedByCharacterId`) or a public payload
38 * (`itemId`/`instance` + `droppedByCharacterId`).
39 */
40export function isPrivateGroundLetter (item)
41{
42 if (!item)
43 { return false; }
44 const stack = item.stack ?? { itemId: item.itemId, instance: item.instance };
45 if (!isLetterStack(stack))
46 { return false; }
47 const dropperId = Number(item.droppedByCharacterId);
48 if (!(dropperId > 0))
49 { return false; }
50 return !isLetterWrittenBy(stack, dropperId);
51}
52
53/** @param {object} item @param {number} characterId */
54export function canCharacterSeeGroundItem (item, characterId)
55{
56 if (!isPrivateGroundLetter(item))
57 { return true; }
58 return Number(item.droppedByCharacterId) === Number(characterId);
59}
60
61/** @param {object} item @param {number} characterId */
62export function canCharacterPickupGroundItem (item, characterId)
63{
64 return canCharacterSeeGroundItem(item, characterId);
65}