From 46e56d6a16a65ed58808572826b6e1c1fe726e20 Mon Sep 17 00:00:00 2001 From: Echo-55 <82003117+Echo-55@users.noreply.github.com> Date: Mon, 9 Dec 2024 18:21:15 -0600 Subject: [PATCH] Updated trader image loading implementation to work better with the provided build script. Removed method TraderHelper.registerProfileImage from traderHelpers.ts as it is no longer being used. --- TypeScript/13AddTrader/src/mod.ts | 11 +++-- TypeScript/13AddTrader/src/traderHelpers.ts | 55 ++++++++------------- 2 files changed, 27 insertions(+), 39 deletions(-) diff --git a/TypeScript/13AddTrader/src/mod.ts b/TypeScript/13AddTrader/src/mod.ts index e284876..260f32e 100644 --- a/TypeScript/13AddTrader/src/mod.ts +++ b/TypeScript/13AddTrader/src/mod.ts @@ -4,7 +4,6 @@ import { DependencyContainer } from "tsyringe"; import { IPreSptLoadMod } from "@spt/models/external/IPreSptLoadMod"; import { IPostDBLoadMod } from "@spt/models/external/IPostDBLoadMod"; import { ILogger } from "@spt/models/spt/utils/ILogger"; -import { PreSptModLoader } from "@spt/loaders/PreSptModLoader"; import { DatabaseServer } from "@spt/servers/DatabaseServer"; import { ImageRouter } from "@spt/routers/ImageRouter"; import { ConfigServer } from "@spt/servers/ConfigServer"; @@ -25,6 +24,7 @@ import { ItemTpl } from "@spt/models/enums/ItemTpl"; class SampleTrader implements IPreSptLoadMod, IPostDBLoadMod { private mod: string; + private traderImgPath: string; private logger: ILogger; private traderHelper: TraderHelper; private fluentAssortCreator: FluentAssortCreator; @@ -34,6 +34,7 @@ class SampleTrader implements IPreSptLoadMod, IPostDBLoadMod { constructor() { this.mod = "13AddTrader"; // Set name of mod so we can log it to console later + this.traderImgPath = "res/cat.jpg"; // Set path to trader image // Get base json from /db/ folder this.traderBase = baseJson; this.traderNickname = "Cat" @@ -49,7 +50,6 @@ class SampleTrader implements IPreSptLoadMod, IPostDBLoadMod { this.logger.debug(`[${this.mod}] preSpt Loading... `); // Get SPT code/data we need later - const preSptModLoader: PreSptModLoader = container.resolve("PreSptModLoader"); const imageRouter: ImageRouter = container.resolve("ImageRouter"); const hashUtil: HashUtil = container.resolve("HashUtil"); const configServer = container.resolve("ConfigServer"); @@ -58,12 +58,15 @@ class SampleTrader implements IPreSptLoadMod, IPostDBLoadMod { // IMPORTANT - YOUR TRADER NEEDS A UNIQUE MONGO-ID, ASK IN DISCORD IF YOU DONT KNOW WHAT THAT IS // GOOGLE "mongoid generator" - this.traderBase._id = "66eeef8b2a166b73d2066a7e"; + this.traderBase = { + ...baseJson, + _id: "66eeef8b2a166b73d2066a7e" // This is a unique ID for your trader, also the first key in base.json + }; // Create helper class and use it to register our traders image/icon + set its stock refresh time this.traderHelper = new TraderHelper(); this.fluentAssortCreator = new FluentAssortCreator(hashUtil, this.logger); - this.traderHelper.registerProfileImage(this.traderBase, this.mod, preSptModLoader, imageRouter, "cat.jpg"); + imageRouter.addRoute(this.traderBase.avatar.replace(".jpg", ""), this.traderImgPath); this.traderHelper.setTraderUpdateTime(traderConfig, this.traderBase, 3600, 4000); // Add trader to trader enum diff --git a/TypeScript/13AddTrader/src/traderHelpers.ts b/TypeScript/13AddTrader/src/traderHelpers.ts index c4a8176..58026ad 100644 --- a/TypeScript/13AddTrader/src/traderHelpers.ts +++ b/TypeScript/13AddTrader/src/traderHelpers.ts @@ -1,28 +1,13 @@ -import { PreSptModLoader } from "@spt/loaders/PreSptModLoader"; -import { Item } from "@spt/models/eft/common/tables/IItem"; -import { ITraderBase, ITraderAssort } from "@spt/models/eft/common/tables/ITrader"; -import { ITraderConfig, UpdateTime } from "@spt/models/spt/config/ITraderConfig"; -import { IDatabaseTables } from "@spt/models/spt/server/IDatabaseTables"; -import { ImageRouter } from "@spt/routers/ImageRouter"; -import { JsonUtil } from "@spt/utils/JsonUtil"; -import { NewItemIds } from "./newitemIds"; +import {PreSptModLoader} from "@spt/loaders/PreSptModLoader"; +import {IItem} from "@spt/models/eft/common/tables/IItem"; +import {ITraderBase, ITraderAssort} from "@spt/models/eft/common/tables/ITrader"; +import {ITraderConfig, IUpdateTime} from "@spt/models/spt/config/ITraderConfig"; +import {IDatabaseTables} from "@spt/models/spt/server/IDatabaseTables"; +import {ImageRouter} from "@spt/routers/ImageRouter"; +import {JsonUtil} from "@spt/utils/JsonUtil"; +import {NewItemIds} from "./newItemIds"; export class TraderHelper { - /** - * Add profile picture to our trader - * @param baseJson json file for trader (db/base.json) - * @param modName mod folder name - * @param preSptModLoader mod loader class - used to get the mods file path - * @param imageRouter image router class - used to register the trader image path so we see their image on trader page - * @param traderImageName Filename of the trader icon to use - */ - public registerProfileImage(baseJson: any, modName: string, preSptModLoader: PreSptModLoader, imageRouter: ImageRouter, traderImageName: string): void { - // Reference the mod "res" folder - const imageFilepath = `./${preSptModLoader.getModPath(modName)}res`; - - // Register a route to point to the profile picture - remember to remove the .jpg from it - imageRouter.addRoute(baseJson.avatar.replace(".jpg", ""), `${imageFilepath}/${traderImageName}`); - } /** * Add record to trader config to set the refresh time of trader in seconds (default is 60 minutes) @@ -33,7 +18,7 @@ export class TraderHelper { */ public setTraderUpdateTime(traderConfig: ITraderConfig, baseJson: any, refreshTimeSecondsMin: number, refreshTimeSecondsMax: number): void { // Add refresh time in seconds to config - const traderRefreshRecord: UpdateTime = { + const traderRefreshRecord: IUpdateTime = { traderId: baseJson._id, seconds: { min: refreshTimeSecondsMin, @@ -83,9 +68,9 @@ export class TraderHelper { * Create a weapon from scratch, ready to be added to trader * @returns Item[] */ - public createGlock(): Item[] { + public createGlock(): IItem[] { // Create an array ready to hold weapon + all mods - const glock: Item[] = []; + const glock: IItem[] = []; // Add the base first glock.push({ // Add the base weapon first @@ -153,15 +138,15 @@ export class TraderHelper { } /** - * Add traders name/location/description to the locale table - * @param baseJson json file for trader (db/base.json) - * @param tables database tables - * @param fullName Complete name of trader - * @param firstName First name of trader - * @param nickName Nickname of trader - * @param location Location of trader (e.g. "Here in the cat shop") - * @param description Description of trader - */ + * Add traders name/location/description to the locale table + * @param baseJson json file for trader (db/base.json) + * @param tables database tables + * @param fullName Complete name of trader + * @param firstName First name of trader + * @param nickName Nickname of trader + * @param location Location of trader (e.g. "Here in the cat shop") + * @param description Description of trader + */ public addTraderToLocales(baseJson: any, tables: IDatabaseTables, fullName: string, firstName: string, nickName: string, location: string, description: string) { // For each language, add locale for the new trader const locales = Object.values(tables.locales.global);