Server/project/src/models/spt/config/IGiftsConfig.ts

33 lines
1.2 KiB
TypeScript
Raw Normal View History

import { Item } from "@spt-aki/models/eft/common/tables/IItem";
import { IUserDialogInfo } from "@spt-aki/models/eft/profile/IAkiProfile";
import { GiftSenderType } from "@spt-aki/models/enums/GiftSenderType";
import { SeasonalEventType } from "@spt-aki/models/enums/SeasonalEventType";
import { Traders } from "@spt-aki/models/enums/Traders";
import { IBaseConfig } from "@spt-aki/models/spt/config/IBaseConfig";
export interface IGiftsConfig extends IBaseConfig
{
2023-11-16 02:35:05 +01:00
kind: "aki-gifts";
gifts: Record<string, Gift>;
}
export interface Gift
{
/** Items to send to player */
2023-11-16 02:35:05 +01:00
items: Item[];
/** Who is sending the gift to player */
2023-11-16 02:35:05 +01:00
sender: GiftSenderType;
/** Optinal - supply a users id to send from, not necessary when sending from SYSTEM or TRADER */
2023-11-16 02:35:05 +01:00
senderId?: string;
senderDetails: IUserDialogInfo;
/** Optional - supply a trader type to send from, not necessary when sending from SYSTEM or USER */
2023-11-16 02:35:05 +01:00
trader?: Traders;
messageText: string;
/** Optional - if sending text from the client locale file */
2023-11-16 02:35:05 +01:00
localeTextId?: string;
/** Optional - Used by Seasonal events to send on specific day */
2023-11-16 02:35:05 +01:00
timestampToSend?: number;
associatedEvent: SeasonalEventType;
collectionTimeHours: number;
}