diff --git a/Libraries/Core/Loaders/BundleLoader.cs b/Libraries/Core/Loaders/BundleLoader.cs index 29e413ef..3940090e 100644 --- a/Libraries/Core/Loaders/BundleLoader.cs +++ b/Libraries/Core/Loaders/BundleLoader.cs @@ -94,7 +94,10 @@ namespace Core.Loaders _inMemoryCacheService = inMemoryCacheService; _cloner = cloner; } - + /// + /// Handle singleplayer/bundles + /// + /// List of loaded bundles. public List GetBundles() { var result = new List(); diff --git a/Libraries/Core/Models/Common/IdWithCount.cs b/Libraries/Core/Models/Common/IdWithCount.cs index 2aa0cc9c..ff909791 100644 --- a/Libraries/Core/Models/Common/IdWithCount.cs +++ b/Libraries/Core/Models/Common/IdWithCount.cs @@ -4,9 +4,9 @@ namespace Core.Models.Common; public record IdWithCount { - /** - * Id of stack to take money from - */ + /// + /// ID of stack to take money from + /// [JsonPropertyName("id")] public string? Id { @@ -14,9 +14,9 @@ public record IdWithCount set; } - /** - * Amount of money to take off player for treatment - */ + /// + /// Amount of money to take off player for treatment + /// [JsonPropertyName("count")] public double? Count { diff --git a/Libraries/Core/Models/Eft/Common/Globals.cs b/Libraries/Core/Models/Eft/Common/Globals.cs index 66afbd70..f8fa6549 100644 --- a/Libraries/Core/Models/Eft/Common/Globals.cs +++ b/Libraries/Core/Models/Eft/Common/Globals.cs @@ -9758,9 +9758,9 @@ public record Preset set; } - /** - * Default presets have this property - */ + /// + /// Default presets have this property + /// [JsonPropertyName("_encyclopedia")] public string? Encyclopedia { diff --git a/Libraries/Core/Models/Eft/Common/Location.cs b/Libraries/Core/Models/Eft/Common/Location.cs index 43b426d3..92fc33db 100644 --- a/Libraries/Core/Models/Eft/Common/Location.cs +++ b/Libraries/Core/Models/Eft/Common/Location.cs @@ -6,9 +6,9 @@ namespace Core.Models.Eft.Common; public record Location { - /** - * Map meta-data - */ + /// + /// Map meta-data + /// [JsonPropertyName("base")] public LocationBase? Base { @@ -16,9 +16,9 @@ public record Location set; } - /** - * Loose loot positions and item weights - */ + /// + /// Loose loot positions and item weights + /// [JsonPropertyName("looseLoot")] public LazyLoad? LooseLoot { @@ -26,9 +26,9 @@ public record Location set; } - /** - * Static loot item weights - */ + /// + /// Static loot item weights + /// [JsonPropertyName("staticLoot")] public LazyLoad>? StaticLoot { @@ -36,9 +36,9 @@ public record Location set; } - /** - * Static container positions and item weights - */ + /// + /// Static container positions and item weights + /// [JsonPropertyName("staticContainers")] public LazyLoad? StaticContainers { @@ -53,9 +53,9 @@ public record Location set; } - /** - * All possible static containers on map + their assign groupings - */ + /// + /// All possible static containers on map + their assign groupings + /// [JsonPropertyName("statics")] public StaticContainer? Statics { @@ -63,9 +63,9 @@ public record Location set; } - /** - * All possible map extracts - */ + /// + /// All possible map extracts + /// [JsonPropertyName("allExtracts")] public Exit[] AllExtracts { diff --git a/Libraries/Core/Models/Eft/Common/LocationBase.cs b/Libraries/Core/Models/Eft/Common/LocationBase.cs index a29d3fd5..75c745e3 100644 --- a/Libraries/Core/Models/Eft/Common/LocationBase.cs +++ b/Libraries/Core/Models/Eft/Common/LocationBase.cs @@ -106,9 +106,9 @@ public record LocationBase set; } - /** - * Weighting on how likely a bot will be Easy difficulty - */ + /// + /// Weighting on how likely a bot will be Easy difficulty + /// [JsonPropertyName("BotEasy")] public int? BotEasy { @@ -116,9 +116,9 @@ public record LocationBase set; } - /** - * Weighting on how likely a bot will be Hard difficulty - */ + /// + /// Weighting on how likely a bot will be Hard difficulty + /// [JsonPropertyName("BotHard")] public int? BotHard { @@ -126,9 +126,9 @@ public record LocationBase set; } - /** - * Weighting on how likely a bot will be Impossible difficulty - */ + /// + /// Weighting on how likely a bot will be Impossible difficulty + /// [JsonPropertyName("BotImpossible")] public int? BotImpossible { @@ -150,9 +150,9 @@ public record LocationBase set; } - /** - * Maximum Number of bots that are currently alive/loading/delayed - */ + /// + /// Maximum Number of bots that are currently alive/loading/delayed + /// [JsonPropertyName("BotMax")] public int? BotMax { @@ -160,9 +160,9 @@ public record LocationBase set; } - /** - * Is not used in 33420 - */ + /// + /// Is not used in 33420 TODO: still needed? + /// [JsonPropertyName("BotMaxPlayer")] public int? BotMaxPlayer { @@ -170,9 +170,9 @@ public record LocationBase set; } - /** - * Is not used in 33420 - */ + /// + /// Is not used in 33420 TODO: still needed? + /// [JsonPropertyName("BotMaxTimePlayer")] public int? BotMaxTimePlayer { @@ -180,9 +180,9 @@ public record LocationBase set; } - /** - * Does not even exist in the client in 33420 - */ + /// + /// Does not even exist in the client in 33420 TODO: still needed? + /// [JsonPropertyName("BotMaxPvE")] public int? BotMaxPvE { @@ -190,9 +190,9 @@ public record LocationBase set; } - /** - * Weighting on how likely a bot will be Normal difficulty - */ + /// + /// Weighting on how likely a bot will be Normal difficulty + /// [JsonPropertyName("BotNormal")] public int? BotNormal { @@ -200,9 +200,9 @@ public record LocationBase set; } - /** - * How many bot slots that need to be open before trying to spawn new bots. - */ + /// + /// How many bot slots that need to be open before trying to spawn new bots. + /// [JsonPropertyName("BotSpawnCountStep")] public int? BotSpawnCountStep { @@ -210,9 +210,9 @@ public record LocationBase set; } - /** - * How often to check if bots are spawn-able. In seconds - */ + /// + /// How often to check if bots are spawn-able. In seconds + /// [JsonPropertyName("BotSpawnPeriodCheck")] public int? BotSpawnPeriodCheck { @@ -220,9 +220,9 @@ public record LocationBase set; } - /** - * The bot spawn will toggle on and off in intervals of Off(Min/Max) and On(Min/Max) - */ + /// + /// The bot spawn will toggle on and off in intervals of Off(Min/Max) and On(Min/Max) + /// [JsonPropertyName("BotSpawnTimeOffMax")] public int? BotSpawnTimeOffMax { @@ -251,9 +251,9 @@ public record LocationBase set; } - /** - * How soon bots will be allowed to spawn - */ + /// + /// How soon bots will be allowed to spawn + /// [JsonPropertyName("BotStart")] public int? BotStart { @@ -261,9 +261,9 @@ public record LocationBase set; } - /** - * After this long bots will no longer spawn - */ + /// + /// After this long bots will no longer spawn + /// [JsonPropertyName("BotStop")] public int? BotStop { @@ -1666,9 +1666,9 @@ public record ColliderProps public record Exit { - /** - * % Chance out of 100 exit will appear in raid - */ + /// + /// % Chance out of 100 exit will appear in raid + /// [JsonPropertyName("Chance")] public double? Chance { @@ -1950,9 +1950,9 @@ public record Wave set; } - /** - * OPTIONAL - Needs to be unique - Used by custom wave service to ensure same wave isnt added multiple times - */ + /// + /// OPTIONAL - Needs to be unique - Used by custom wave service to ensure same wave isnt added multiple times + /// [JsonPropertyName("sptId")] public string? SptId { @@ -1967,9 +1967,9 @@ public record Wave set; } - /** - * 'pve' and/or 'regular' - */ + /// + /// 'pve' and/or 'regular' + /// [JsonPropertyName("SpawnMode")] public List? SpawnMode { diff --git a/Libraries/Core/Models/Eft/Common/PmcData.cs b/Libraries/Core/Models/Eft/Common/PmcData.cs index e954e29d..a31a327c 100644 --- a/Libraries/Core/Models/Eft/Common/PmcData.cs +++ b/Libraries/Core/Models/Eft/Common/PmcData.cs @@ -40,9 +40,9 @@ public record PostRaidStats set; } - /** - * Only found in profile we get from client post raid - */ + /// + /// Only found in profile we get from client post raid + /// [JsonPropertyName("Arena")] public EftStats? Arena { diff --git a/Libraries/Core/Models/Eft/Common/Tables/BotBase.cs b/Libraries/Core/Models/Eft/Common/Tables/BotBase.cs index 1c650e2d..0fb697fd 100644 --- a/Libraries/Core/Models/Eft/Common/Tables/BotBase.cs +++ b/Libraries/Core/Models/Eft/Common/Tables/BotBase.cs @@ -24,9 +24,9 @@ public record BotBase set; } - /** - * SPT property - use to store player id - TODO - move to AID ( account id as guid of choice) - */ + /// + /// SPT property - use to store player id - TODO - move to AID ( account id as guid of choice) + /// [JsonPropertyName("sessionId")] public string? SessionId { @@ -149,9 +149,9 @@ public record BotBase set; } - /** - * Achievement id and timestamp - */ + /// + /// Achievement id and timestamp + /// [JsonPropertyName("Achievements")] [JsonConverter(typeof(ArrayToObjectFactoryConverter))] public Dictionary? Achievements @@ -218,9 +218,9 @@ public record BotBase set; } - /** - * SPT specific property used during bot generation in raid - */ + /// + /// SPT specific property used during bot generation in raid + /// [JsonPropertyName("sptIsPmc")] public bool? IsPmc { @@ -232,9 +232,9 @@ public record BotBase public record MoneyTransferLimits { // Resets every 24 hours in live - /** - * TODO: Implement - */ + /// + /// TODO: Implement + /// [JsonPropertyName("nextResetTime")] public double? NextResetTime { @@ -286,10 +286,9 @@ public record TaskConditionCounter get; set; } - - /** - * Quest id - */ + /// + /// Quest id + /// [JsonPropertyName("sourceId")] public string? SourceId { @@ -857,9 +856,9 @@ public record BotBaseInventory set; } - /** - * Key is hideout area enum numeric as string e.g. "24", value is area _id - */ + /// + /// Key is hideout area enum numeric as string e.g. "24", value is area _id + /// [JsonIgnore(Condition = JsonIgnoreCondition.Never)] [JsonPropertyName("hideoutAreaStashes")] public Dictionary? HideoutAreaStashes @@ -1560,9 +1559,9 @@ public record BackendCounter public record InsuredItem { - /** - * Trader Id item was insured by - */ + /// + /// Trader ID item was insured by + /// [JsonPropertyName("tid")] public string? TId { @@ -1690,18 +1689,18 @@ public record Production // use this instead of productive and scavcase set; } - /** - * Seconds passed of production - */ + /// + /// Seconds passed of production + /// public double? Progress { get; set; } - /** - * Is craft in some state of being worked on by client (crafting/ready to pick up) - */ + /// + /// Is craft in some state of being worked on by client (crafting/ready to pick up) + /// [JsonPropertyName("inProgress")] public bool? InProgress { @@ -1721,9 +1720,9 @@ public record Production // use this instead of productive and scavcase set; } - /** - * Seconds needed to fully craft - */ + /// + /// Seconds needed to fully craft + /// public double? ProductionTime { get; @@ -1760,18 +1759,18 @@ public record Production // use this instead of productive and scavcase set; } - /** - * Used in hideout production.json - */ + /// + /// Used in hideout production.json + /// public bool? needFuelForAllProductionTime { get; set; } - /** - * Used when sending data to client - */ + /// + /// Used when sending data to client + /// public bool? NeedFuelForAllProductionTime { get; @@ -1785,9 +1784,9 @@ public record Production // use this instead of productive and scavcase set; } - /** - * Some crafts are always inProgress, but need to be reset, e.g. water collector - */ + /// + /// Some crafts are always inProgress, but need to be reset, e.g. water collector + /// [JsonPropertyName("sptIsComplete")] public bool? SptIsComplete { @@ -1795,9 +1794,9 @@ public record Production // use this instead of productive and scavcase set; } - /** - * Is the craft a Continuous, e.g bitcoins/water collector - */ + /// + /// Is the craft a Continuous, e.g. bitcoins/water collector + /// [JsonPropertyName("sptIsContinuous")] public bool? SptIsContinuous { @@ -1805,9 +1804,9 @@ public record Production // use this instead of productive and scavcase set; } - /** - * Stores a list of tools used in this craft and whether they're FiR, to give back once the craft is done - */ + /// + /// Stores a list of tools used in this craft and whether they're FiR, to give back once the craft is done + /// [JsonPropertyName("sptRequiredTools")] public List? SptRequiredTools { @@ -1815,7 +1814,9 @@ public record Production // use this instead of productive and scavcase set; } - // Craft is cultist circle sacrifice + /// + /// Craft is cultist circle sacrifice + /// [JsonPropertyName("sptIsCultistCircle")] public bool? SptIsCultistCircle { @@ -1860,9 +1861,9 @@ public record BotHideoutArea set; } - /** - * Must be integer - */ + /// + /// Must be integer + /// [JsonPropertyName("completeTime")] public double? CompleteTime { @@ -1895,7 +1896,7 @@ public record BotHideoutArea public record HideoutSlot { /// - /// SPT specific value to keep track of what index this slot is (0,1,2,3 etc) + /// SPT specific value to keep track of what index this slot is (0,1,2,3 etc.) /// [JsonPropertyName("locationIndex")] public double? LocationIndex @@ -1971,9 +1972,9 @@ public record Quests set; } - /** - * Property does not exist in live profile data, but is used by ProfileChanges.questsStatus when sent to client - */ + /// + /// Property does not exist in live profile data, but is used by ProfileChanges.questsStatus when sent to client + /// [JsonPropertyName("completedConditions")] public List? CompletedConditions { diff --git a/Libraries/Core/Models/Eft/Common/Tables/BotType.cs b/Libraries/Core/Models/Eft/Common/Tables/BotType.cs index bfd5abb1..08af098c 100644 --- a/Libraries/Core/Models/Eft/Common/Tables/BotType.cs +++ b/Libraries/Core/Models/Eft/Common/Tables/BotType.cs @@ -435,9 +435,9 @@ public record DifficultyCategories public record Experience { - /** - * key = bot difficulty - */ + /// + /// key = bot difficulty + /// [JsonPropertyName("aggressorBonus")] public Dictionary? AggressorBonus { @@ -452,9 +452,9 @@ public record Experience set; } - /** - * key = bot difficulty - */ + /// + /// key = bot difficulty + /// [JsonPropertyName("reward")] public Dictionary>? Reward { @@ -462,9 +462,9 @@ public record Experience set; } - /** - * key = bot difficulty - */ + /// + /// key = bot difficulty + /// [JsonPropertyName("standingForKill")] public Dictionary? StandingForKill { @@ -492,9 +492,9 @@ public record Generation public record GenerationData { - /** - * key: number of items, value: weighting - */ + /// + /// key: number of items, value: weighting + /// [JsonPropertyName("weights")] public Dictionary? Weights { @@ -502,9 +502,9 @@ public record GenerationData set; } - /** - * Array of item tpls - */ + /// + /// Array of item tpls + /// [JsonPropertyName("whitelist")] [JsonConverter(typeof(ArrayToObjectFactoryConverter))] public Dictionary? Whitelist diff --git a/Libraries/Core/Models/Eft/Common/Tables/CustomisationStorage.cs b/Libraries/Core/Models/Eft/Common/Tables/CustomisationStorage.cs index 1dd85f10..9e874d87 100644 --- a/Libraries/Core/Models/Eft/Common/Tables/CustomisationStorage.cs +++ b/Libraries/Core/Models/Eft/Common/Tables/CustomisationStorage.cs @@ -4,6 +4,7 @@ namespace Core.Models.Eft.Common.Tables; public record CustomisationStorage { + // Customisation.json/itemId [JsonPropertyName("id")] public string? Id { diff --git a/Libraries/Core/Models/Eft/Common/Tables/Item.cs b/Libraries/Core/Models/Eft/Common/Tables/Item.cs index 252cedb1..6fb57c6b 100644 --- a/Libraries/Core/Models/Eft/Common/Tables/Item.cs +++ b/Libraries/Core/Models/Eft/Common/Tables/Item.cs @@ -91,8 +91,10 @@ public record Item public record HideoutItem { + /// + /// Hideout inventory id that was used by improvement action + /// [JsonPropertyName("_id")] - public string? _Id { get @@ -179,9 +181,9 @@ public record ItemLocation set; } - /** - * SPT property? - */ + /// + /// SPT property? + /// [JsonPropertyName("rotation")] public object? Rotation { @@ -222,9 +224,9 @@ public record Upd set; } - /** - * SPT specific property, not made by BSG - */ + /// + /// SPT specific property, not made by BSG + /// [JsonPropertyName("sptPresetId")] public string? SptPresetId { diff --git a/Libraries/Core/Models/Eft/Common/Tables/ProfileTemplate.cs b/Libraries/Core/Models/Eft/Common/Tables/ProfileTemplate.cs index 3770b152..9c747d9c 100644 --- a/Libraries/Core/Models/Eft/Common/Tables/ProfileTemplate.cs +++ b/Libraries/Core/Models/Eft/Common/Tables/ProfileTemplate.cs @@ -189,9 +189,9 @@ public record ProfileTraderTemplate set; } - /** - * How many days is usage of the flea blocked for upon profile creation - */ + /// + /// How many days is usage of the flea blocked for upon profile creation + /// [JsonPropertyName("fleaBlockedDays")] public int? FleaBlockedDays { @@ -199,9 +199,9 @@ public record ProfileTraderTemplate set; } - /** - * What traders default to being locked on profile creation - */ + /// + /// What traders default to being locked on profile creation + /// [JsonPropertyName("lockedByDefaultOverride")] public List? LockedByDefaultOverride { @@ -209,9 +209,9 @@ public record ProfileTraderTemplate set; } - /** - * What traders should have their clothing unlocked/purchased on creation - */ + /// + /// What traders should have their clothing unlocked/purchased on creation + /// [JsonPropertyName("purchaseAllClothingByDefaultForTrader")] public List? PurchaseAllClothingByDefaultForTrader { diff --git a/Libraries/Core/Models/Eft/Common/Tables/RepeatableQuests.cs b/Libraries/Core/Models/Eft/Common/Tables/RepeatableQuests.cs index 975594d2..1f6f408e 100644 --- a/Libraries/Core/Models/Eft/Common/Tables/RepeatableQuests.cs +++ b/Libraries/Core/Models/Eft/Common/Tables/RepeatableQuests.cs @@ -219,6 +219,9 @@ public record PmcDataRepeatableQuest set; } + /// + /// What it costs to reset: QuestId, ChangeRequirement. Redundant to change requirements within RepeatableQuest + /// [JsonIgnore(Condition = JsonIgnoreCondition.Never)] [JsonPropertyName("changeRequirement")] public Dictionary? ChangeRequirement @@ -261,6 +264,9 @@ public record ChangeRequirement public record ChangeCost { + /// + /// What item it will take to reset daily + /// [JsonPropertyName("templateId")] public string? TemplateId { @@ -268,6 +274,9 @@ public record ChangeCost set; } + /// + /// Amount of item needed to reset + /// [JsonPropertyName("count")] public int? Count { diff --git a/Libraries/Core/Models/Eft/Common/Tables/Reward.cs b/Libraries/Core/Models/Eft/Common/Tables/Reward.cs index 5150d64e..3e6f7986 100644 --- a/Libraries/Core/Models/Eft/Common/Tables/Reward.cs +++ b/Libraries/Core/Models/Eft/Common/Tables/Reward.cs @@ -55,9 +55,9 @@ public record Reward set; } - /** - * Hideout area id - */ + /// + /// Hideout area id + /// [JsonPropertyName("traderId")] public object? TraderId { @@ -93,9 +93,9 @@ public record Reward set; } - /** - * Game editions whitelisted to get reward - */ + /// + /// Game editions whitelisted to get reward + /// [JsonPropertyName("availableInGameEditions")] public HashSet? AvailableInGameEditions { @@ -103,9 +103,9 @@ public record Reward set; } - /** - * Game editions blacklisted from getting reward - */ + /// + /// Game editions blacklisted from getting reward + /// [JsonPropertyName("notAvailableInGameEditions")] public HashSet? NotAvailableInGameEditions { diff --git a/Libraries/Core/Models/Eft/Common/Tables/Trader.cs b/Libraries/Core/Models/Eft/Common/Tables/Trader.cs index 35cffade..5f235015 100644 --- a/Libraries/Core/Models/Eft/Common/Tables/Trader.cs +++ b/Libraries/Core/Models/Eft/Common/Tables/Trader.cs @@ -422,13 +422,15 @@ public record TraderRepair get; set; } - + /// + /// Doesn't exist in client object + /// [JsonPropertyName("excluded_id_list")] public List? ExcludedIdList { get; set; - } // Doesn't exist in client object + } [JsonPropertyName("quality")] [JsonConverter(typeof(StringToNumberFactoryConverter))] diff --git a/Libraries/Core/Models/Eft/Dialog/ChatServer.cs b/Libraries/Core/Models/Eft/Dialog/ChatServer.cs index 53e82f9f..cab520b6 100644 --- a/Libraries/Core/Models/Eft/Dialog/ChatServer.cs +++ b/Libraries/Core/Models/Eft/Dialog/ChatServer.cs @@ -60,9 +60,9 @@ public record ChatServer set; } - /** - * Possibly removed - */ + /// + /// Possibly removed + /// [JsonPropertyName("IsDeveloper")] public bool? IsDeveloper { diff --git a/Libraries/Core/Models/Eft/Game/GameConfigResponse.cs b/Libraries/Core/Models/Eft/Game/GameConfigResponse.cs index bfa835dd..8a56cd8e 100644 --- a/Libraries/Core/Models/Eft/Game/GameConfigResponse.cs +++ b/Libraries/Core/Models/Eft/Game/GameConfigResponse.cs @@ -67,9 +67,9 @@ public record GameConfigResponse set; } - /** - * Total in game time - */ + /// + /// Total in game time + /// [JsonPropertyName("totalInGame")] public double? TotalInGame { diff --git a/Libraries/Core/Models/Eft/Health/HealthTreatmentRequestData.cs b/Libraries/Core/Models/Eft/Health/HealthTreatmentRequestData.cs index 4ac33c6d..77a37202 100644 --- a/Libraries/Core/Models/Eft/Health/HealthTreatmentRequestData.cs +++ b/Libraries/Core/Models/Eft/Health/HealthTreatmentRequestData.cs @@ -13,10 +13,10 @@ public record HealthTreatmentRequestData : InventoryBaseActionRequestData set; } - /** - * Id of stack to take money from - * Amount of money to take off player for treatment - */ + /// + /// Id of stack to take money from
+ /// Amount of money to take off player for treatment + /// [JsonPropertyName("items")] public List? Items { @@ -123,9 +123,9 @@ public record BodyPartEffects set; } - /** - * Effects in array to be removed - */ + /// + /// Effects in array to be removed + /// public List Effects { get; diff --git a/Libraries/Core/Models/Eft/Hideout/HandleQTEEventRequestData.cs b/Libraries/Core/Models/Eft/Hideout/HandleQTEEventRequestData.cs index a2ed865f..785aa064 100644 --- a/Libraries/Core/Models/Eft/Hideout/HandleQTEEventRequestData.cs +++ b/Libraries/Core/Models/Eft/Hideout/HandleQTEEventRequestData.cs @@ -5,9 +5,9 @@ namespace Core.Models.Eft.Hideout; public record HandleQTEEventRequestData : InventoryBaseActionRequestData { - /** - * true if QTE was successful, otherwise false - */ + /// + /// true if QTE was successful, otherwise false + /// [JsonPropertyName("results")] public List? Results { @@ -15,9 +15,9 @@ public record HandleQTEEventRequestData : InventoryBaseActionRequestData set; } - /** - * Id of the QTE object used from db/hideout/qte.json - */ + /// + /// Id of the QTE object used from db/hideout/qte.json + /// [JsonPropertyName("id")] public string? Id { diff --git a/Libraries/Core/Models/Eft/Hideout/HideoutArea.cs b/Libraries/Core/Models/Eft/Hideout/HideoutArea.cs index 3200650e..892873c0 100644 --- a/Libraries/Core/Models/Eft/Hideout/HideoutArea.cs +++ b/Libraries/Core/Models/Eft/Hideout/HideoutArea.cs @@ -131,9 +131,9 @@ public record Stage set; } - /** - * Containers inventory tpl - */ + /// + /// Containers inventory tpl + /// [JsonPropertyName("container")] public string? Container { diff --git a/Libraries/Core/Models/Eft/Hideout/HideoutImproveAreaRequestData.cs b/Libraries/Core/Models/Eft/Hideout/HideoutImproveAreaRequestData.cs index 2253073e..fa5415dd 100644 --- a/Libraries/Core/Models/Eft/Hideout/HideoutImproveAreaRequestData.cs +++ b/Libraries/Core/Models/Eft/Hideout/HideoutImproveAreaRequestData.cs @@ -7,9 +7,9 @@ namespace Core.Models.Eft.Hideout; public record HideoutImproveAreaRequestData : InventoryBaseActionRequestData { - /** - * Hideout area id from areas.json - */ + /// + /// Hideout area id from areas.json + /// [JsonPropertyName("id")] public string? AreaId { diff --git a/Libraries/Core/Models/Eft/Hideout/HideoutProduction.cs b/Libraries/Core/Models/Eft/Hideout/HideoutProduction.cs index 15300878..7db175de 100644 --- a/Libraries/Core/Models/Eft/Hideout/HideoutProduction.cs +++ b/Libraries/Core/Models/Eft/Hideout/HideoutProduction.cs @@ -58,9 +58,9 @@ public record HideoutProduction set; } - /** - * Tpl of item being crafted - */ + /// + /// Tpl of item being crafted + /// [JsonPropertyName("endProduct")] public string? EndProduct { diff --git a/Libraries/Core/Models/Eft/Inventory/AddItemRequestData.cs b/Libraries/Core/Models/Eft/Inventory/AddItemRequestData.cs index e55f5450..f31c0691 100644 --- a/Libraries/Core/Models/Eft/Inventory/AddItemRequestData.cs +++ b/Libraries/Core/Models/Eft/Inventory/AddItemRequestData.cs @@ -4,7 +4,9 @@ namespace Core.Models.Eft.Inventory; public record AddItemRequestData { - // Trader id + /// + /// Trader id + /// [JsonPropertyName("tid")] public string? TraderId { diff --git a/Libraries/Core/Models/Eft/Inventory/AddItemTempObject.cs b/Libraries/Core/Models/Eft/Inventory/AddItemTempObject.cs index 52ca255b..55f279cb 100644 --- a/Libraries/Core/Models/Eft/Inventory/AddItemTempObject.cs +++ b/Libraries/Core/Models/Eft/Inventory/AddItemTempObject.cs @@ -33,7 +33,9 @@ public record AddItemTempObject set; } - // Container item will be placed in - stash or sorting table + /// + /// Container item will be placed in - stash or sorting table + /// [JsonPropertyName("containerId")] public string? ContainerIdentifier { diff --git a/Libraries/Core/Models/Eft/Inventory/AddItemsDirectRequest.cs b/Libraries/Core/Models/Eft/Inventory/AddItemsDirectRequest.cs index 50a72828..221fedbf 100644 --- a/Libraries/Core/Models/Eft/Inventory/AddItemsDirectRequest.cs +++ b/Libraries/Core/Models/Eft/Inventory/AddItemsDirectRequest.cs @@ -5,7 +5,9 @@ namespace Core.Models.Eft.Inventory; public record AddItemsDirectRequest { + /// /// Item and child mods to add to player inventory + /// [JsonPropertyName("itemsWithModsToAdd")] public List>? ItemsWithModsToAdd { @@ -19,16 +21,18 @@ public record AddItemsDirectRequest get; set; } - + /// /// Runs after EACH item with children is added + /// [JsonPropertyName("callback")] public Action? Callback { get; set; } - + /// /// Should sorting table be used when no space found in stash + /// [JsonPropertyName("useSortingTable")] public bool? UseSortingTable { diff --git a/Libraries/Core/Models/Eft/Inventory/InventoryBaseActionRequestData.cs b/Libraries/Core/Models/Eft/Inventory/InventoryBaseActionRequestData.cs index 222dfe20..4f60795e 100644 --- a/Libraries/Core/Models/Eft/Inventory/InventoryBaseActionRequestData.cs +++ b/Libraries/Core/Models/Eft/Inventory/InventoryBaseActionRequestData.cs @@ -59,7 +59,7 @@ public record Container { get; set; - } // TODO: types given: ILocation or number + } // TODO: types given: ILocation or number - BSG data object shows as location only. } public record Location diff --git a/Libraries/Core/Models/Eft/Inventory/InventorySplitRequestData.cs b/Libraries/Core/Models/Eft/Inventory/InventorySplitRequestData.cs index 3695dfcb..8c5e5426 100644 --- a/Libraries/Core/Models/Eft/Inventory/InventorySplitRequestData.cs +++ b/Libraries/Core/Models/Eft/Inventory/InventorySplitRequestData.cs @@ -4,9 +4,9 @@ namespace Core.Models.Eft.Inventory; public record InventorySplitRequestData : InventoryBaseActionRequestData { - /** - * Id of item to split - */ + /// + /// Id of item to split + /// [JsonPropertyName("splitItem")] public string? SplitItem { @@ -14,9 +14,9 @@ public record InventorySplitRequestData : InventoryBaseActionRequestData set; } - /** - * Id of new item stack - */ + /// + /// Id of new item stack + /// [JsonPropertyName("newItem")] public string? NewItem { @@ -24,9 +24,9 @@ public record InventorySplitRequestData : InventoryBaseActionRequestData set; } - /** - * Destination new item will be placed in - */ + /// + /// Destination new item will be placed in + /// [JsonPropertyName("container")] public Container? Container { diff --git a/Libraries/Core/Models/Eft/Inventory/PinOrLockItemRequest.cs b/Libraries/Core/Models/Eft/Inventory/PinOrLockItemRequest.cs index 2773dbd4..36c2cd85 100644 --- a/Libraries/Core/Models/Eft/Inventory/PinOrLockItemRequest.cs +++ b/Libraries/Core/Models/Eft/Inventory/PinOrLockItemRequest.cs @@ -5,9 +5,9 @@ namespace Core.Models.Eft.Inventory; public record PinOrLockItemRequest : InventoryBaseActionRequestData { - /** - * Id of item being pinned - */ + /// + /// Id of item being pinned + /// [JsonPropertyName("Item")] public string? Item { @@ -15,9 +15,9 @@ public record PinOrLockItemRequest : InventoryBaseActionRequestData set; } - /** - * "Pinned"/"Locked"/"Free" - */ + /// + /// "Pinned"/"Locked"/"Free" + /// [JsonPropertyName("State")] [JsonConverter(typeof(JsonStringEnumConverter))] public PinLockState? State diff --git a/Libraries/Core/Models/Eft/ItemEvent/ItemEventRouterBase.cs b/Libraries/Core/Models/Eft/ItemEvent/ItemEventRouterBase.cs index 8816b5b9..ffbe0ed5 100644 --- a/Libraries/Core/Models/Eft/ItemEvent/ItemEventRouterBase.cs +++ b/Libraries/Core/Models/Eft/ItemEvent/ItemEventRouterBase.cs @@ -113,9 +113,9 @@ public record ProfileChange set; } - /** - * Hideout area improvement id - */ + /// + /// Hideout area improvement id + /// [JsonPropertyName("improvements")] public Dictionary? Improvements { @@ -306,9 +306,9 @@ public record ItemChanges } // Only needs _id property } -/** - * Related to TraderInfo - */ +/// +/// Related to TraderInfo +/// public record TraderData { [JsonPropertyName("salesSum")] diff --git a/Libraries/Core/Models/Eft/ItemEvent/ItemEventRouterResponse.cs b/Libraries/Core/Models/Eft/ItemEvent/ItemEventRouterResponse.cs index baf949f6..c81ed6a2 100644 --- a/Libraries/Core/Models/Eft/ItemEvent/ItemEventRouterResponse.cs +++ b/Libraries/Core/Models/Eft/ItemEvent/ItemEventRouterResponse.cs @@ -1,5 +1,7 @@ namespace Core.Models.Eft.ItemEvent; - +/// +/// An object sent back to the game client that contains alterations the client must make to ensure server/client are in sync +/// public record ItemEventRouterResponse : ItemEventRouterBase { } diff --git a/Libraries/Core/Models/Eft/Location/GetAirdropLootResponse.cs b/Libraries/Core/Models/Eft/Location/GetAirdropLootResponse.cs index 61e6143f..e76e5cf1 100644 --- a/Libraries/Core/Models/Eft/Location/GetAirdropLootResponse.cs +++ b/Libraries/Core/Models/Eft/Location/GetAirdropLootResponse.cs @@ -6,7 +6,9 @@ namespace Core.Models.Eft.Location; public record GetAirdropLootResponse { - // The type of airdrop + /// + /// The type of airdrop + /// [JsonPropertyName("icon")] public AirdropTypeEnum? Icon { diff --git a/Libraries/Core/Models/Eft/Match/StartLocalRaidRequestData.cs b/Libraries/Core/Models/Eft/Match/StartLocalRaidRequestData.cs index 31479ef5..292a72a4 100644 --- a/Libraries/Core/Models/Eft/Match/StartLocalRaidRequestData.cs +++ b/Libraries/Core/Models/Eft/Match/StartLocalRaidRequestData.cs @@ -55,9 +55,9 @@ public record StartLocalRaidRequestData : IRequestData set; } - /** - * Should loot generation be skipped, default false - */ + /// + /// Should loot generation be skipped, default false + /// [JsonPropertyName("sptSkipLootGeneration")] public bool? ShouldSkipLootGeneration { diff --git a/Libraries/Core/Models/Eft/PresetBuild/PresetBuildActionRequestData.cs b/Libraries/Core/Models/Eft/PresetBuild/PresetBuildActionRequestData.cs index 17fcc493..8685d332 100644 --- a/Libraries/Core/Models/Eft/PresetBuild/PresetBuildActionRequestData.cs +++ b/Libraries/Core/Models/Eft/PresetBuild/PresetBuildActionRequestData.cs @@ -20,9 +20,9 @@ public record PresetBuildActionRequestData : IRequestData set; } - /** - * name of preset given by player - */ + /// + /// name of preset given by player + /// [JsonPropertyName("Name")] public string? Name { diff --git a/Libraries/Core/Models/Eft/Profile/SptProfile.cs b/Libraries/Core/Models/Eft/Profile/SptProfile.cs index 916ba4b2..a62bdf84 100644 --- a/Libraries/Core/Models/Eft/Profile/SptProfile.cs +++ b/Libraries/Core/Models/Eft/Profile/SptProfile.cs @@ -23,9 +23,9 @@ public record SptProfile set; } - /** - * Clothing purchases - */ + /// + /// Clothing purchases + /// [JsonPropertyName("suits")] public List? Suits { @@ -75,9 +75,9 @@ public record SptProfile set; } - /** - * Assort purchases made by player since last trader refresh - */ + /// + /// Assort purchases made by player since last trader refresh + /// [JsonPropertyName("traderPurchases")] public Dictionary?>? TraderPurchases { @@ -85,9 +85,9 @@ public record SptProfile set; } - /** - * List of friend profile IDs - */ + /// + /// List of friend profile IDs + /// [JsonPropertyName("friends")] public List? FriendProfileIds { @@ -122,9 +122,9 @@ public record TraderPurchaseData public record Info { - /** - * main profile id - */ + /// + /// main profile id + /// [JsonPropertyName("id")] public string? ProfileId { @@ -192,9 +192,9 @@ public record Characters } } -/** - * used by profile.userbuilds - */ +/// +/// used by profile.userbuilds +/// public record UserBuilds { [JsonPropertyName("weaponBuilds")] @@ -326,9 +326,9 @@ public record MagazineTemplateAmmoItem } } -/** - * Used by defaultEquipmentPresets.json - */ +/// +/// Used by defaultEquipmentPresets.json +/// public record DefaultEquipmentPreset : EquipmentBuild { [JsonPropertyName("type")] @@ -391,7 +391,7 @@ public record Dialogue } } -// @Cleanup: Maybe the same as Dialogue? +//TODO: @Cleanup: Maybe the same as Dialogue? public record DialogueInfo { [JsonPropertyName("attachmentsNew")] @@ -699,9 +699,9 @@ public record UpdatableChatMember public record Spt { - /** - * What version of SPT was this profile made with - */ + /// + /// What version of SPT was this profile made with + /// [JsonPropertyName("version")] public string? Version { @@ -709,9 +709,9 @@ public record Spt set; } - /** - * What mods has this profile loaded at any point in time - */ + /// + /// What mods has this profile loaded at any point in time + /// [JsonPropertyName("mods")] public List? Mods { @@ -719,9 +719,9 @@ public record Spt set; } - /** - * What gifts has this profile received and how many - */ + /// + /// What gifts has this profile received and how many + /// [JsonPropertyName("receivedGifts")] public List? ReceivedGifts { @@ -729,9 +729,9 @@ public record Spt set; } - /** - * item TPLs blacklisted from being sold on flea for this profile - */ + /// + /// item TPLs blacklisted from being sold on flea for this profile + /// [JsonPropertyName("blacklistedItemTpls")] public HashSet? BlacklistedItemTemplates { @@ -739,9 +739,9 @@ public record Spt set; } - /** - * key: daily type - */ + /// + /// key: daily type + /// [JsonPropertyName("freeRepeatableRefreshUsedCount")] public Dictionary? FreeRepeatableRefreshUsedCount { @@ -749,9 +749,9 @@ public record Spt set; } - /** - * When was a profile migrated, value is timestamp - */ + /// + /// When was a profile migrated, value is timestamp + /// [JsonPropertyName("migrations")] public Dictionary? Migrations { @@ -759,9 +759,9 @@ public record Spt set; } - /** - * Cultist circle rewards received that are one time use, key (md5) is a combination of sacrificed + reward items - */ + /// + /// Cultist circle rewards received that are one time use, key (md5) is a combination of sacrificed + reward items + /// [JsonPropertyName("cultistRewards")] public Dictionary? CultistRewards { diff --git a/Libraries/Core/Models/Eft/Quests/CompleteQuestRequestData.cs b/Libraries/Core/Models/Eft/Quests/CompleteQuestRequestData.cs index 2fa8345b..3ca773ae 100644 --- a/Libraries/Core/Models/Eft/Quests/CompleteQuestRequestData.cs +++ b/Libraries/Core/Models/Eft/Quests/CompleteQuestRequestData.cs @@ -5,9 +5,9 @@ namespace Core.Models.Eft.Quests; public record CompleteQuestRequestData : InventoryBaseActionRequestData { - /** - * Quest Id - */ + /// + /// Quest Id + /// [JsonPropertyName("qid")] public string? QuestId { diff --git a/Libraries/Core/Models/Eft/Ragfair/RagfairOffer.cs b/Libraries/Core/Models/Eft/Ragfair/RagfairOffer.cs index 5c12e4bd..00434fac 100644 --- a/Libraries/Core/Models/Eft/Ragfair/RagfairOffer.cs +++ b/Libraries/Core/Models/Eft/Ragfair/RagfairOffer.cs @@ -64,9 +64,9 @@ public record RagfairOffer set; } - /** - * Handbook price - */ + /// + /// Handbook price + /// [JsonPropertyName("itemsCost")] public double? ItemsCost { @@ -74,9 +74,9 @@ public record RagfairOffer set; } - /** - * Rouble price per item - */ + /// + /// Rouble price per item + /// [JsonPropertyName("requirementsCost")] public double? RequirementsCost { @@ -98,9 +98,9 @@ public record RagfairOffer set; } - /** - * True when offer is sold as pack - */ + /// + /// True when offer is sold as pack + /// [JsonPropertyName("sellInOnePiece")] public bool? SellInOnePiece { @@ -108,9 +108,9 @@ public record RagfairOffer set; } - /** - * Rouble price - same as requirementsCost - */ + /// + /// Rouble price - same as requirementsCost + /// [JsonPropertyName("summaryCost")] public double? SummaryCost { @@ -125,9 +125,9 @@ public record RagfairOffer set; } - /** - * Trader only - */ + /// + /// Trader only + /// [JsonPropertyName("unlimitedCount")] public bool? UnlimitedCount { diff --git a/Libraries/Core/Models/Eft/Repair/RepairActionDataRequest.cs b/Libraries/Core/Models/Eft/Repair/RepairActionDataRequest.cs index 5f3650dc..3970d3e9 100644 --- a/Libraries/Core/Models/Eft/Repair/RepairActionDataRequest.cs +++ b/Libraries/Core/Models/Eft/Repair/RepairActionDataRequest.cs @@ -12,27 +12,36 @@ public record RepairActionDataRequest : InventoryBaseActionRequestData set; } + /// + /// item to repair + /// [JsonPropertyName("target")] public string? Target { get; set; - } // item to repair + } } public record RepairKitsInfo { + /// + /// id of repair kit to use + /// [JsonPropertyName("_id")] public string? Id { get; set; - } // id of repair kit to use + } + /// + /// amount of units to reduce kit by + /// [JsonPropertyName("count")] public int? Count { get; set; - } // amount of units to reduce kit by + } } diff --git a/Libraries/Core/Models/Eft/Trade/ProcessBuyTradeRequestData.cs b/Libraries/Core/Models/Eft/Trade/ProcessBuyTradeRequestData.cs index a9f52546..0c2190d1 100644 --- a/Libraries/Core/Models/Eft/Trade/ProcessBuyTradeRequestData.cs +++ b/Libraries/Core/Models/Eft/Trade/ProcessBuyTradeRequestData.cs @@ -26,6 +26,9 @@ public record ProcessBuyTradeRequestData : ProcessBaseTradeRequestData set; } + /// + /// Id of stack to take money from, is money tpl when Action is `SptInsure` + /// [JsonPropertyName("scheme_items")] public List? SchemeItems { diff --git a/Libraries/Core/Models/Eft/Weather/WeatherData.cs b/Libraries/Core/Models/Eft/Weather/WeatherData.cs index 420e92b0..e375cb0b 100644 --- a/Libraries/Core/Models/Eft/Weather/WeatherData.cs +++ b/Libraries/Core/Models/Eft/Weather/WeatherData.cs @@ -71,9 +71,9 @@ public record Weather set; } - /** - * 1 - 3 light rain, 3+ 'rain' - */ + /// + /// 1 - 3 light rain, 3+ 'rain' + /// [JsonPropertyName("rain")] public double? Rain { @@ -102,16 +102,9 @@ public record Weather set; } - /** - * < - * - - * 0 - * . - * 4 - * = - * clear - * day - */ + /// + /// < -0.4 = clear day + /// [JsonPropertyName("cloud")] public double? Cloud { diff --git a/Libraries/Core/Models/Spt/Bots/GenerateWeaponRequest.cs b/Libraries/Core/Models/Spt/Bots/GenerateWeaponRequest.cs index 84a8f157..6d295ba3 100644 --- a/Libraries/Core/Models/Spt/Bots/GenerateWeaponRequest.cs +++ b/Libraries/Core/Models/Spt/Bots/GenerateWeaponRequest.cs @@ -5,9 +5,9 @@ namespace Core.Models.Spt.Bots; public record GenerateWeaponRequest { - /** - * Weapon to add mods to / result that is returned - */ + /// + /// Weapon to add mods to / result that is returned + /// [JsonPropertyName("weapon")] public List? Weapon { @@ -15,9 +15,9 @@ public record GenerateWeaponRequest set; } - /** - * Pool of compatible mods to attach to weapon - */ + /// + /// Pool of compatible mods to attach to weapon + /// [JsonPropertyName("modPool")] public GlobalMods? ModPool { @@ -25,9 +25,9 @@ public record GenerateWeaponRequest set; } - /** - * ParentId of weapon - */ + /// + /// ParentId of weapon + /// [JsonPropertyName("weaponId")] public string? WeaponId { @@ -35,9 +35,9 @@ public record GenerateWeaponRequest set; } - /** - * Weapon which mods will be generated on - */ + /// + /// Weapon which mods will be generated on + /// [JsonPropertyName("parentTemplate")] public TemplateItem? ParentTemplate { @@ -45,9 +45,9 @@ public record GenerateWeaponRequest set; } - /** - * Chance values mod will be added - */ + /// + /// Chance values mod will be added + /// [JsonPropertyName("modSpawnChances")] public Dictionary? ModSpawnChances { @@ -55,9 +55,9 @@ public record GenerateWeaponRequest set; } - /** - * Ammo tpl to use when generating magazines/cartridges - */ + /// + /// Ammo tpl to use when generating magazines/cartridges + /// [JsonPropertyName("ammoTpl")] public string? AmmoTpl { @@ -65,9 +65,9 @@ public record GenerateWeaponRequest set; } - /** - * Bot-specific properties - */ + /// + /// Bot-specific properties + /// [JsonPropertyName("botData")] public BotData? BotData { @@ -75,9 +75,9 @@ public record GenerateWeaponRequest set; } - /** - * limits placed on certain mod types per gun - */ + /// + /// limits placed on certain mod types per gun + /// [JsonPropertyName("modLimits")] public BotModLimits? ModLimits { @@ -85,9 +85,9 @@ public record GenerateWeaponRequest set; } - /** - * Info related to the weapon being generated - */ + /// + /// Info related to the weapon being generated + /// [JsonPropertyName("weaponStats")] public WeaponStats? WeaponStats { @@ -95,9 +95,9 @@ public record GenerateWeaponRequest set; } - /** - * Array of item tpls the weapon does not support - */ + /// + /// Array of item tpls the weapon does not support + /// [JsonPropertyName("conflictingItemTpls")] public HashSet? ConflictingItemTpls { @@ -108,9 +108,9 @@ public record GenerateWeaponRequest public record BotData { - /** - * Role of bot weapon is generated for - */ + /// + /// Role of bot weapon is generated for + /// [JsonPropertyName("role")] public string? Role { @@ -118,9 +118,9 @@ public record BotData set; } - /** - * Level of the bot weapon is being generated for - */ + /// + /// Level of the bot weapon is being generated for + /// [JsonPropertyName("level")] public int? Level { @@ -128,9 +128,9 @@ public record BotData set; } - /** - * role of bot when accessing bot.json equipment config settings - */ + /// + /// role of bot when accessing bot.json equipment config settings + /// [JsonPropertyName("equipmentRole")] public string? EquipmentRole { diff --git a/Libraries/Core/Models/Spt/Config/BotConfig.cs b/Libraries/Core/Models/Spt/Config/BotConfig.cs index 513ce477..5c4ee115 100644 --- a/Libraries/Core/Models/Spt/Config/BotConfig.cs +++ b/Libraries/Core/Models/Spt/Config/BotConfig.cs @@ -14,9 +14,9 @@ public record BotConfig : BaseConfig set; } = "spt-bot"; - /** - * How many variants of each bot should be generated on raid start - */ + /// + /// How many variants of each bot should be generated on raid start + /// [JsonPropertyName("presetBatch")] public Dictionary? PresetBatch { @@ -24,9 +24,9 @@ public record BotConfig : BaseConfig set; } - /** - * Bot roles that should not have PMC types (pmcBEAR/pmcUSEC) added as enemies to - */ + /// + /// Bot roles that should not have PMC types (pmcBEAR/pmcUSEC) added as enemies to + /// [JsonPropertyName("botsToNotAddPMCsAsEnemiesTo")] public List BotsToNotAddPMCsAsEnemiesTo { @@ -34,9 +34,9 @@ public record BotConfig : BaseConfig set; } - /** - * What bot types should be classified as bosses - */ + /// + /// What bot types should be classified as bosses + /// [JsonPropertyName("bosses")] public List Bosses { @@ -44,9 +44,9 @@ public record BotConfig : BaseConfig set; } - /** - * Control weapon/armor durability min/max values for each bot type - */ + /// + /// Control weapon/armor durability min/max values for each bot type + /// [JsonPropertyName("durability")] public BotDurability Durability { @@ -54,9 +54,9 @@ public record BotConfig : BaseConfig set; } - /** - * Controls the percentage values of randomization item resources - */ + /// + /// Controls the percentage values of randomization item resources + /// [JsonPropertyName("lootItemResourceRandomization")] public Dictionary LootItemResourceRandomization { @@ -64,9 +64,10 @@ public record BotConfig : BaseConfig set; } - /** - * Control what bots are added to a bots revenge list key: bottype, value: bottypes to revenge on seeing their death - */ + /// + /// Control what bots are added to a bots revenge list
+ /// key: bottype, value: bottypes to revenge on seeing their death + /// [JsonPropertyName("revenge")] public Dictionary> Revenge { @@ -74,11 +75,11 @@ public record BotConfig : BaseConfig set; } - /** - * Control how many items are allowed to spawn on a bot - * key: bottype, value: - * - */ + /// + /// Control how many items are allowed to spawn on a bot
+ /// key: bottype, value:
+ /// key: itemTpl: value: max item count> + /// [JsonPropertyName("itemSpawnLimits")] public Dictionary> ItemSpawnLimits { @@ -86,9 +87,9 @@ public record BotConfig : BaseConfig set; } - /** - * Blacklist/whitelist items on a bot - */ + /// + /// Blacklist/whitelist items on a bot + /// [JsonPropertyName("equipment")] public Dictionary Equipment { @@ -96,9 +97,9 @@ public record BotConfig : BaseConfig set; } - /** - * Show a bots botType value after their name - */ + /// + /// Show a bots botType value after their name + /// [JsonPropertyName("showTypeInNickname")] public bool ShowTypeInNickname { @@ -106,9 +107,9 @@ public record BotConfig : BaseConfig set; } - /** - * What ai brain should a normal scav use per map - */ + /// + /// What ai brain should a normal scav use per map + /// [JsonPropertyName("assaultBrainType")] public Dictionary> AssaultBrainType { @@ -116,9 +117,9 @@ public record BotConfig : BaseConfig set; } - /** - * What ai brain should a player scav use per map - */ + /// + /// What ai brain should a player scav use per map + /// [JsonPropertyName("playerScavBrainType")] public Dictionary> PlayerScavBrainType { @@ -126,9 +127,9 @@ public record BotConfig : BaseConfig set; } - /** - * Max number of bots that can be spawned in a raid at any one time - */ + /// + /// Max number of bots that can be spawned in a raid at any one time + /// [JsonPropertyName("maxBotCap")] public Dictionary MaxBotCap { @@ -136,9 +137,9 @@ public record BotConfig : BaseConfig set; } - /** - * Chance scav has fake pscav name e.g. Scav name (player name) - */ + /// + /// Chance scav has fake pscav name e.g. Scav name (player name) + /// [JsonPropertyName("chanceAssaultScavHasPlayerScavName")] public int ChanceAssaultScavHasPlayerScavName { @@ -146,9 +147,9 @@ public record BotConfig : BaseConfig set; } - /** - * How many stacks of secret ammo should a bot have in its bot secure container - */ + /// + /// How many stacks of secret ammo should a bot have in its bot secure container + /// [JsonPropertyName("secureContainerAmmoStackCount")] public int SecureContainerAmmoStackCount { @@ -156,9 +157,9 @@ public record BotConfig : BaseConfig set; } - /** - * Bot roles in this array will be given a dog tag on generation - */ + /// + /// Bot roles in this array will be given a dog tag on generation + /// [JsonPropertyName("botRolesWithDogTags")] public HashSet BotRolesWithDogTags { @@ -166,9 +167,9 @@ public record BotConfig : BaseConfig set; } - /** - * Settings to control the items that get added into wallets on bots - */ + /// + /// Settings to control the items that get added into wallets on bots + /// [JsonPropertyName("walletLoot")] public WalletLootSettings WalletLoot { @@ -176,9 +177,9 @@ public record BotConfig : BaseConfig set; } - /** - * Currency weights, Keyed by botrole / currency - */ + /// + /// Currency weights, Keyed by botrole / currency + /// [JsonPropertyName("currencyStackSize")] public Dictionary>> CurrencyStackSize { @@ -186,9 +187,9 @@ public record BotConfig : BaseConfig set; } - /** - * Tpls for low profile gas blocks - */ + /// + /// Tpls for low profile gas blocks + /// [JsonPropertyName("lowProfileGasBlockTpls")] public HashSet LowProfileGasBlockTpls { @@ -196,9 +197,9 @@ public record BotConfig : BaseConfig set; } - /** - * What bottypes should be excluded from having loot generated on them (backpack/pocket/vest) does not disable food/drink/special/ - */ + /// + /// What bottypes should be excluded from having loot generated on them (backpack/pocket/vest) does not disable food/drink/special/ + /// [JsonPropertyName("disableLootOnBotTypes")] public HashSet DisableLootOnBotTypes { @@ -206,9 +207,9 @@ public record BotConfig : BaseConfig set; } - /** - * Max length a bots name can be - */ + /// + /// Max length a bots name can be + /// [JsonPropertyName("botNameLengthLimit")] public int BotNameLengthLimit { @@ -216,9 +217,9 @@ public record BotConfig : BaseConfig set; } - /** - * Bot roles that must have a unique name when generated vs other bots in raid - */ + /// + /// Bot roles that must have a unique name when generated vs other bots in raid + /// [JsonPropertyName("botRolesThatMustHaveUniqueName")] public HashSet BotRolesThatMustHaveUniqueName { @@ -227,9 +228,9 @@ public record BotConfig : BaseConfig } } -/** - * Number of bots to generate and store in cache on raid start per bot type - */ +/// +/// Number of bots to generate and store in cache on raid start per bot type +/// public record PresetBatch { [JsonPropertyName("assault")] diff --git a/Libraries/Core/Models/Spt/Config/BotDurability.cs b/Libraries/Core/Models/Spt/Config/BotDurability.cs index 18b3f9ce..886d4033 100644 --- a/Libraries/Core/Models/Spt/Config/BotDurability.cs +++ b/Libraries/Core/Models/Spt/Config/BotDurability.cs @@ -26,9 +26,9 @@ public record BotDurability } } -/** - * Durability values to be used when a more specific bot type can't be found - */ +/// +/// Durability values to be used when a more specific bot type can't be found +/// public record DefaultDurability { [JsonPropertyName("armor")] diff --git a/Libraries/Core/Models/Spt/Config/CoreConfig.cs b/Libraries/Core/Models/Spt/Config/CoreConfig.cs index 108bf90c..6579a2bb 100644 --- a/Libraries/Core/Models/Spt/Config/CoreConfig.cs +++ b/Libraries/Core/Models/Spt/Config/CoreConfig.cs @@ -96,9 +96,9 @@ public record CoreConfig : BaseConfig set; } - /** - * Commit hash build server was created from - */ + /// + /// Commit hash build server was created from + /// [JsonPropertyName("commit")] public string? Commit { @@ -106,9 +106,9 @@ public record CoreConfig : BaseConfig set; } - /** - * Timestamp of server build - */ + /// + /// Timestamp of server build + /// [JsonPropertyName("buildTime")] public string? BuildTime { @@ -116,9 +116,9 @@ public record CoreConfig : BaseConfig set; } - /** - * Server locale keys that will be added to the bottom of the startup watermark - */ + /// + /// Server locale keys that will be added to the bottom of the startup watermark + /// [JsonPropertyName("customWatermarkLocaleKeys")] public List? CustomWatermarkLocaleKeys { @@ -129,18 +129,18 @@ public record CoreConfig : BaseConfig public record BsgLogging { - /** - * verbosity of what to log, yes I know this is backwards, but its how nlog deals with ordinals. - * complain to them about it! In all cases, better exceptions will be logged. - * WARNING: trace-info logging will quickly create log files in the megabytes. - * 0 - trace - * 1 - debug - * 2 - info - * 3 - warn - * 4 - error - * 5 - fatal - * 6 - off - */ + /// + /// verbosity of what to log, yes I know this is backwards, but its how nlog deals with ordinals.
+ /// complain to them about it! In all cases, better exceptions will be logged.
+ /// WARNING: trace-info logging will quickly create log files in the megabytes.
+ /// 0 - trace
+ /// 1 - debug
+ /// 2 - info
+ /// 3 - warn
+ /// 4 - error
+ /// 5 - fatal
+ /// 6 - off + /// [JsonPropertyName("verbosity")] public int Verbosity { @@ -148,7 +148,9 @@ public record BsgLogging set; } - // Should we send the logging to the server + /// + /// Should we send the logging to the server + /// [JsonPropertyName("sendToServer")] public bool SendToServer { @@ -159,7 +161,9 @@ public record BsgLogging public record Release { - // Disclaimer outlining the intended usage of bleeding edge + /// + /// Disclaimer outlining the intended usage of bleeding edge + /// [JsonPropertyName("betaDisclaimerText")] public string? BetaDisclaimerText { @@ -167,7 +171,9 @@ public record Release set; } - // Text logged when users agreed to terms + /// + /// Text logged when users agreed to terms + /// [JsonPropertyName("betaDisclaimerAcceptText")] public string BetaDisclaimerAcceptText { @@ -175,7 +181,9 @@ public record Release set; } - // Server mods loaded message + /// + /// Server mods loaded message + /// [JsonPropertyName("serverModsLoadedText")] public string ServerModsLoadedText { @@ -183,7 +191,9 @@ public record Release set; } - // Server mods loaded debug message text + /// + /// Server mods loaded debug message text + /// [JsonPropertyName("serverModsLoadedDebugText")] public string ServerModsLoadedDebugText { @@ -191,7 +201,9 @@ public record Release set; } - // Client mods loaded message + /// + /// Client mods loaded message + /// [JsonPropertyName("clientModsLoadedText")] public string ClientModsLoadedText { @@ -199,15 +211,18 @@ public record Release set; } - // Client mods loaded debug message text + /// + /// Client mods loaded debug message text + /// [JsonPropertyName("clientModsLoadedDebugText")] public string ClientModsLoadedDebugText { get; set; } - - // Illegal plugins log message + /// + /// Illegal plugins log message + /// [JsonPropertyName("illegalPluginsLoadedText")] public string IllegalPluginsLoadedText { @@ -215,7 +230,9 @@ public record Release set; } - // Illegal plugins exception + /// + /// Illegal plugins exception + /// [JsonPropertyName("illegalPluginsExceptionText")] public string IllegalPluginsExceptionText { @@ -223,7 +240,9 @@ public record Release set; } - // Summary of release changes + /// + /// Summary of release changes + /// [JsonPropertyName("releaseSummaryText")] public string? ReleaseSummaryText { @@ -231,7 +250,9 @@ public record Release set; } - // Enables the cool watermark in-game + /// + /// Enables the cool watermark in-game + /// [JsonPropertyName("isBeta")] public bool? IsBeta { @@ -239,7 +260,9 @@ public record Release set; } - // Whether mods are enabled + /// + /// Whether mods are enabled + /// [JsonPropertyName("isModdable")] public bool? IsModdable { @@ -247,7 +270,9 @@ public record Release set; } - // Are mods loaded on the server? + /// + /// Are mods loaded on the server? + /// [JsonPropertyName("isModded")] public bool IsModded { @@ -255,7 +280,9 @@ public record Release set; } - // How long before the messagebox times out and closes the game + /// + /// How long before the messagebox times out and closes the game + /// [JsonPropertyName("betaDisclaimerTimeoutDelay")] public int BetaDisclaimerTimeoutDelay { @@ -266,9 +293,9 @@ public record Release public record GameFixes { - /** - * Shotguns use a different value than normal guns causing huge pellet dispersion - */ + /// + /// Shotguns use a different value than normal guns causing huge pellet dispersion + /// [JsonPropertyName("fixShotgunDispersion")] public bool FixShotgunDispersion { @@ -276,9 +303,9 @@ public record GameFixes set; } - /** - * Remove items added by mods when the mod no longer exists - can fix dead profiles stuck at game load - */ + /// + /// Remove items added by mods when the mod no longer exists - can fix dead profiles stuck at game load + /// [JsonPropertyName("removeModItemsFromProfile")] public bool RemoveModItemsFromProfile { @@ -286,9 +313,9 @@ public record GameFixes set; } - /** - * Remove invalid traders from profile - trader data can be leftover when player removes trader mod - */ + /// + /// Remove invalid traders from profile - trader data can be leftover when player removes trader mod + /// [JsonPropertyName("removeInvalidTradersFromProfile")] public bool RemoveInvalidTradersFromProfile { @@ -296,9 +323,9 @@ public record GameFixes set; } - /** - * Fix issues that cause the game to not start due to inventory item issues - */ + /// + /// Fix issues that cause the game to not start due to inventory item issues + /// [JsonPropertyName("fixProfileBreakingInventoryItemIssues")] public bool FixProfileBreakingInventoryItemIssues { @@ -309,7 +336,9 @@ public record GameFixes public record ServerFeatures { - /* Controls whether or not the server attempts to download mod dependencies not included in the server's executable */ + /// + /// Controls whether the server attempts to download mod dependencies not included in the server's executable + /// [JsonPropertyName("autoInstallModDependencies")] public bool AutoInstallModDependencies { @@ -331,9 +360,9 @@ public record ServerFeatures set; } - /** - * Keyed to profile type e.g. "Standard" or "SPT Developer" - */ + /// + /// Keyed to profile type e.g. "Standard" or "SPT Developer" + /// [JsonPropertyName("createNewProfileTypesBlacklist")] public HashSet CreateNewProfileTypesBlacklist { @@ -341,9 +370,9 @@ public record ServerFeatures set; } - /** - * Profile ids to ignore when calculating achievement stats - */ + /// + /// Profile ids to ignore when calculating achievement stats + /// [JsonPropertyName("achievementProfileIdBlacklist")] public HashSet? AchievementProfileIdBlacklist { @@ -375,6 +404,9 @@ public record ChatbotFeatures set; } + /// + /// Human readable id to guid for each bot + /// [JsonPropertyName("ids")] public Dictionary Ids { @@ -382,6 +414,9 @@ public record ChatbotFeatures set; } + /// + /// Bot Ids player is allowed to interact with + /// [JsonPropertyName("enabledBots")] public Dictionary EnabledBots { diff --git a/Libraries/Core/Models/Spt/Config/HideoutConfig.cs b/Libraries/Core/Models/Spt/Config/HideoutConfig.cs index 732ee58b..aee98144 100644 --- a/Libraries/Core/Models/Spt/Config/HideoutConfig.cs +++ b/Libraries/Core/Models/Spt/Config/HideoutConfig.cs @@ -88,6 +88,9 @@ public record HideoutConfig : BaseConfig public record HideoutCraftToAdd { + /// + /// The new mongoId for the craft to use + /// [JsonPropertyName("newId")] public string NewId { diff --git a/Libraries/Core/Models/Spt/Config/InRaidConfig.cs b/Libraries/Core/Models/Spt/Config/InRaidConfig.cs index 18e3d5eb..3a83b57f 100644 --- a/Libraries/Core/Models/Spt/Config/InRaidConfig.cs +++ b/Libraries/Core/Models/Spt/Config/InRaidConfig.cs @@ -11,9 +11,9 @@ public record InRaidConfig : BaseConfig set; } = "spt-inraid"; - /** - * Overrides to apply to the pre-raid settings screen - */ + /// + /// Overrides to apply to the pre-raid settings screen + /// [JsonPropertyName("raidMenuSettings")] public RaidMenuSettings RaidMenuSettings { @@ -21,9 +21,9 @@ public record InRaidConfig : BaseConfig set; } - /** - * What effects should be saved post-raid - */ + /// + /// What effects should be saved post-raid + /// [JsonPropertyName("save")] public RaidSave Save { @@ -31,9 +31,9 @@ public record InRaidConfig : BaseConfig set; } - /** - * Names of car extracts - */ + /// + /// Names of car extracts + /// [JsonPropertyName("carExtracts")] public List CarExtracts { @@ -41,9 +41,9 @@ public record InRaidConfig : BaseConfig set; } - /** - * Names of coop extracts - */ + /// + /// Names of coop extracts + /// [JsonPropertyName("coopExtracts")] public List CoopExtracts { @@ -51,9 +51,9 @@ public record InRaidConfig : BaseConfig set; } - /** - * Fence rep gain from a single car extract - */ + /// + /// Fence rep gain from a single car extract + /// [JsonPropertyName("carExtractBaseStandingGain")] public double CarExtractBaseStandingGain { @@ -61,9 +61,9 @@ public record InRaidConfig : BaseConfig set; } - /** - * Fence rep gain from a single coop extract - */ + /// + /// Fence rep gain from a single coop extract + /// [JsonPropertyName("coopExtractBaseStandingGain")] public double CoopExtractBaseStandingGain { @@ -71,9 +71,9 @@ public record InRaidConfig : BaseConfig set; } - /** - * Fence rep gain when successfully extracting as pscav - */ + /// + /// Fence rep gain when successfully extracting as pscav + /// [JsonPropertyName("scavExtractStandingGain")] public double ScavExtractStandingGain { @@ -81,9 +81,9 @@ public record InRaidConfig : BaseConfig set; } - /** - * The likelihood of PMC eliminating a minimum of 2 scavs while you engage them as a pscav. - */ + /// + /// The likelihood of PMC eliminating a minimum of 2 scavs while you engage them as a pscav. + /// [JsonPropertyName("pmcKillProbabilityForScavGain")] public double PmcKillProbabilityForScavGain { @@ -91,9 +91,9 @@ public record InRaidConfig : BaseConfig set; } - /** - * On death should items in your secure keep their Find in raid status regardless of how you finished the raid - */ + /// + /// On death should items in your secure keep their Find in raid status regardless of how you finished the raid + /// [JsonPropertyName("keepFiRSecureContainerOnDeath")] public bool KeepFiRSecureContainerOnDeath { @@ -101,9 +101,9 @@ public record InRaidConfig : BaseConfig set; } - /** - * If enabled always keep found in raid status on items - */ + /// + /// If enabled always keep found in raid status on items + /// [JsonPropertyName("alwaysKeepFoundInRaidOnRaidEnd")] public bool AlwaysKeepFoundInRaidOnRaidEnd { @@ -111,9 +111,9 @@ public record InRaidConfig : BaseConfig set; } - /** - * Percentage chance a player scav hot is hostile to the player when scavving - */ + /// + /// Percentage chance a player scav hot is hostile to the player when scavving + /// [JsonPropertyName("playerScavHostileChancePercent")] public double PlayerScavHostileChancePercent { @@ -183,9 +183,9 @@ public record RaidMenuSettings public record RaidSave { - /** - * Should loot gained from raid be saved - */ + /// + /// Should loot gained from raid be saved + /// [JsonPropertyName("loot")] public bool Loot { diff --git a/Libraries/Core/Models/Spt/Config/InsuranceConfig.cs b/Libraries/Core/Models/Spt/Config/InsuranceConfig.cs index 879ee2f5..ef42b5ee 100644 --- a/Libraries/Core/Models/Spt/Config/InsuranceConfig.cs +++ b/Libraries/Core/Models/Spt/Config/InsuranceConfig.cs @@ -71,7 +71,9 @@ public record InsuranceConfig : BaseConfig set; } - // Lowest rouble price for an attachment to be allowed to be taken + /// + /// Lowest rouble price for an attachment to be allowed to be taken + /// [JsonPropertyName("minAttachmentRoublePriceToBeTaken")] public double MinAttachmentRoublePriceToBeTaken { @@ -79,7 +81,9 @@ public record InsuranceConfig : BaseConfig set; } - // Chance out of 100% no attachments from a parent are taken + /// + /// Chance out of 100% no attachments from a parent are taken + /// [JsonPropertyName("chanceNoAttachmentsTakenPercent")] public double ChanceNoAttachmentsTakenPercent { diff --git a/Libraries/Core/Models/Spt/Config/InventoryConfig.cs b/Libraries/Core/Models/Spt/Config/InventoryConfig.cs index beff16e2..d392c6e4 100644 --- a/Libraries/Core/Models/Spt/Config/InventoryConfig.cs +++ b/Libraries/Core/Models/Spt/Config/InventoryConfig.cs @@ -12,9 +12,9 @@ public record InventoryConfig : BaseConfig set; } = "spt-inventory"; - /** - * Should new items purchased by flagged as found in raid - */ + /// + /// Should new items purchased by flagged as found in raid + /// [JsonPropertyName("newItemsMarkedFound")] public bool NewItemsMarkedFound { @@ -36,9 +36,9 @@ public record InventoryConfig : BaseConfig set; } - /** - * Contains item tpls that the server should consider money and treat the same as roubles/euros/dollars - */ + /// + /// Contains item tpls that the server should consider money and treat the same as roubles/euros/dollars + /// [JsonPropertyName("customMoneyTpls")] public List CustomMoneyTpls { @@ -46,9 +46,9 @@ public record InventoryConfig : BaseConfig set; } - /** - * Multipliers for skill gain when inside menus, NOT in-game - */ + /// + /// Multipliers for skill gain when inside menus, NOT in-game + /// [JsonPropertyName("skillGainMultiplers")] public Dictionary SkillGainMultipliers { @@ -56,9 +56,9 @@ public record InventoryConfig : BaseConfig set; } - /** - * Container Tpls that should be deprioritised when choosing where to take money from for payments - */ + /// + /// Container Tpls that should be deprioritised when choosing where to take money from for payments + /// [JsonPropertyName("deprioritisedMoneyContainers")] public HashSet DeprioritisedMoneyContainers { @@ -121,9 +121,9 @@ public record SealedAirdropContainerSettings set; } - /** - * Should contents be flagged as found in raid when opened - */ + /// + /// Should contents be flagged as found in raid when opened + /// [JsonPropertyName("foundInRaid")] public bool FoundInRaid { diff --git a/Libraries/Core/Models/Spt/Config/ItemConfig.cs b/Libraries/Core/Models/Spt/Config/ItemConfig.cs index a80b00d0..6377c968 100644 --- a/Libraries/Core/Models/Spt/Config/ItemConfig.cs +++ b/Libraries/Core/Models/Spt/Config/ItemConfig.cs @@ -12,9 +12,9 @@ public record ItemConfig : BaseConfig set; } = "spt-item"; - /** - * Items that should be globally blacklisted - */ + /// + /// Items that should be globally blacklisted + /// [JsonPropertyName("blacklist")] public HashSet Blacklist { @@ -22,9 +22,9 @@ public record ItemConfig : BaseConfig set; } - /** - * Items that should not be lootable from any location - */ + /// + /// Items that should not be lootable from any location + /// [JsonPropertyName("lootableItemBlacklist")] public HashSet LootableItemBlacklist { @@ -32,9 +32,9 @@ public record ItemConfig : BaseConfig set; } - /** - * items that should not be given as rewards - */ + /// + /// items that should not be given as rewards + /// [JsonPropertyName("rewardItemBlacklist")] public HashSet RewardItemBlacklist { @@ -42,9 +42,9 @@ public record ItemConfig : BaseConfig set; } - /** - * Item base types that should not be given as rewards - */ + /// + /// Item base types that should not be given as rewards + /// [JsonPropertyName("rewardItemTypeBlacklist")] public HashSet RewardItemTypeBlacklist { @@ -52,9 +52,9 @@ public record ItemConfig : BaseConfig set; } - /** - * Items that can only be found on bosses - */ + /// + /// Items that can only be found on bosses + /// [JsonPropertyName("bossItems")] public HashSet BossItems { @@ -69,9 +69,9 @@ public record ItemConfig : BaseConfig set; } - /** - * Presets to add to the globals.json `ItemPresets` dictionary on server start - */ + /// + /// Presets to add to the globals.json `ItemPresets` dictionary on server start + /// [JsonPropertyName("customItemGlobalPresets")] public List CustomItemGlobalPresets { @@ -82,9 +82,9 @@ public record ItemConfig : BaseConfig public record HandbookPriceOverride { - /** - * Price in roubles - */ + /// + /// Price in roubles + /// [JsonPropertyName("price")] public double Price { @@ -92,9 +92,9 @@ public record HandbookPriceOverride set; } - /** - * NOT parentId from items.json, but handbook.json - */ + /// + /// NOT parentId from items.json, but handbook.json + /// [JsonPropertyName("parentId")] public string ParentId { diff --git a/Libraries/Core/Models/Spt/Config/LocaleConfig.cs b/Libraries/Core/Models/Spt/Config/LocaleConfig.cs index 7d3ebd3c..09f1cca7 100644 --- a/Libraries/Core/Models/Spt/Config/LocaleConfig.cs +++ b/Libraries/Core/Models/Spt/Config/LocaleConfig.cs @@ -11,9 +11,9 @@ public record LocaleConfig : BaseConfig set; } = "spt-locale"; - /** - * e.g. ru/en/cn/fr etc, or 'system', will take computer locale setting - */ + /// + /// e.g. ru/en/cn/fr etc, or 'system', will take computer locale setting + /// [JsonPropertyName("gameLocale")] public string GameLocale { @@ -21,9 +21,9 @@ public record LocaleConfig : BaseConfig set; } - /** - * e.g. ru/en/cn/fr etc, or 'system', will take computer locale setting - */ + /// + /// e.g. ru/en/cn/fr etc, or 'system', will take computer locale setting + /// [JsonPropertyName("serverLocale")] public string ServerLocale { @@ -31,9 +31,9 @@ public record LocaleConfig : BaseConfig set; } - /** - * Languages server can be translated into - */ + /// + /// Languages server can be translated into + /// [JsonPropertyName("serverSupportedLocales")] public List ServerSupportedLocales { diff --git a/Libraries/Core/Models/Spt/Config/LocationConfig.cs b/Libraries/Core/Models/Spt/Config/LocationConfig.cs index 9d6779f6..8952738f 100644 --- a/Libraries/Core/Models/Spt/Config/LocationConfig.cs +++ b/Libraries/Core/Models/Spt/Config/LocationConfig.cs @@ -254,7 +254,9 @@ public record ReserveRaiderSpawnChanceOverrides public record EquipmentLootSettings { - // Percentage chance item will be added to equipment + /// + /// Percentage chance item will be added to equipment + /// [JsonPropertyName("modSpawnChancePercent")] public Dictionary ModSpawnChancePercent { @@ -323,9 +325,9 @@ public record SplitWaveSettings public record CustomWaves { - /** - * Bosses spawn on raid start - */ + /// + /// Bosses spawn on raid start + /// [JsonPropertyName("boss")] public Dictionary> Boss { @@ -351,9 +353,9 @@ public record BotTypeLimit : MinMax } } -/** - * Multiplier to apply to the loot count for a given map - */ +/// +/// Multiplier to apply to the loot count for a given map +/// public record LootMultiplier { [JsonPropertyName("bigmap")] @@ -492,9 +494,9 @@ public record ContainerRandomisationSettings set; } - /** - * What maps can use the container randomisation feature - */ + /// + /// What maps can use the container randomisation feature + /// [JsonPropertyName("maps")] public Dictionary Maps { @@ -502,9 +504,9 @@ public record ContainerRandomisationSettings set; } - /** - * Some container types don't work when randomised - */ + /// + /// Some container types don't work when randomised + /// [JsonPropertyName("containerTypesToNotRandomise")] public HashSet ContainerTypesToNotRandomise { @@ -556,9 +558,10 @@ public record ScavRaidTimeConfigSettings public record ScavRaidTimeLocationSettings { - /** - * Should loot be reduced by same percent length of raid is reduced by - */ + + /// + /// Should loot be reduced by same percent length of raid is reduced by + /// [JsonPropertyName("reduceLootByPercent")] public bool ReduceLootByPercent { @@ -566,9 +569,9 @@ public record ScavRaidTimeLocationSettings set; } - /** - * Smallest % of container loot that should be spawned - */ + /// + /// Smallest % of container loot that should be spawned + /// [JsonPropertyName("minStaticLootPercent")] public double MinStaticLootPercent { @@ -576,9 +579,9 @@ public record ScavRaidTimeLocationSettings set; } - /** - * Smallest % of loose loot that should be spawned - */ + /// + /// Smallest % of loose loot that should be spawned + /// [JsonPropertyName("minDynamicLootPercent")] public double MinDynamicLootPercent { @@ -586,9 +589,9 @@ public record ScavRaidTimeLocationSettings set; } - /** - * Chance raid time is reduced - */ + /// + /// Chance raid time is reduced + /// [JsonPropertyName("reducedChancePercent")] public double ReducedChancePercent { @@ -596,9 +599,9 @@ public record ScavRaidTimeLocationSettings set; } - /** - * How much should raid time be reduced - weighted - */ + /// + /// How much should raid time be reduced - weighted + /// [JsonPropertyName("reductionPercentWeights")] public Dictionary ReductionPercentWeights { @@ -606,9 +609,9 @@ public record ScavRaidTimeLocationSettings set; } - /** - * Should bot waves be removed / spawn times be adjusted - */ + /// + /// Should bot waves be removed / spawn times be adjusted + /// [JsonPropertyName("adjustWaves")] public bool AdjustWaves { diff --git a/Libraries/Core/Models/Spt/Config/LootConfig.cs b/Libraries/Core/Models/Spt/Config/LootConfig.cs index a2bb02af..10212b4d 100644 --- a/Libraries/Core/Models/Spt/Config/LootConfig.cs +++ b/Libraries/Core/Models/Spt/Config/LootConfig.cs @@ -12,9 +12,9 @@ public record LootConfig : BaseConfig set; } = "spt-loot"; - /** - * Spawn positions to add into a map, key=mapid - */ + /// + /// Spawn positions to add into a map, key=mapid + /// [JsonPropertyName("looseLoot")] public Dictionary LooseLoot { @@ -22,9 +22,9 @@ public record LootConfig : BaseConfig set; } - /** - * Loose loot probability adjustments to apply on game start - */ + /// + /// Loose loot probability adjustments to apply on game start + /// [JsonPropertyName("looseLootSpawnPointAdjustments")] public Dictionary>? LooseLootSpawnPointAdjustments { diff --git a/Libraries/Core/Models/Spt/Config/LostOnDeathConfig.cs b/Libraries/Core/Models/Spt/Config/LostOnDeathConfig.cs index bb3034b6..f4bc8f72 100644 --- a/Libraries/Core/Models/Spt/Config/LostOnDeathConfig.cs +++ b/Libraries/Core/Models/Spt/Config/LostOnDeathConfig.cs @@ -11,9 +11,9 @@ public record LostOnDeathConfig : BaseConfig set; } = "spt-lostondeath"; - /** - * What equipment in each slot should be lost on death - */ + /// + /// What equipment in each slot should be lost on death + /// [JsonPropertyName("equipment")] public LostEquipment Equipment { @@ -21,9 +21,9 @@ public record LostOnDeathConfig : BaseConfig set; } - /** - * Should special slot items be removed from quest inventory on death e.g. wifi camera/markers - */ + /// + /// Should special slot items be removed from quest inventory on death e.g. wifi camera/markers + /// [JsonPropertyName("specialSlotItems")] public bool SpecialSlotItems { @@ -31,9 +31,9 @@ public record LostOnDeathConfig : BaseConfig set; } - /** - * Should quest items be removed from quest inventory on death - */ + /// + /// Should quest items be removed from quest inventory on death + /// [JsonPropertyName("questItems")] public bool QuestItems { diff --git a/Libraries/Core/Models/Spt/Config/PmcConfig.cs b/Libraries/Core/Models/Spt/Config/PmcConfig.cs index b4bf6369..ca2d3db0 100644 --- a/Libraries/Core/Models/Spt/Config/PmcConfig.cs +++ b/Libraries/Core/Models/Spt/Config/PmcConfig.cs @@ -14,9 +14,9 @@ public record PmcConfig : BaseConfig set; } = "spt-pmc"; - /** - * What game version should the PMC have - */ + /// + /// What game version should the PMC have + /// [JsonPropertyName("gameVersionWeight")] public Dictionary GameVersionWeight { @@ -24,9 +24,9 @@ public record PmcConfig : BaseConfig set; } - /** - * What account type should the PMC have - */ + /// + /// What account type should the PMC have + /// [JsonPropertyName("accountTypeWeight")] public Dictionary AccountTypeWeight { @@ -34,9 +34,9 @@ public record PmcConfig : BaseConfig set; } - /** - * Global whitelist/blacklist of vest loot for PMCs - */ + /// + /// Global whitelist/blacklist of vest loot for PMCs + /// [JsonPropertyName("vestLoot")] public SlotLootSettings VestLoot { @@ -44,9 +44,9 @@ public record PmcConfig : BaseConfig set; } - /** - * Global whitelist/blacklist of pocket loot for PMCs - */ + /// + /// Global whitelist/blacklist of pocket loot for PMCs + /// [JsonPropertyName("pocketLoot")] public SlotLootSettings PocketLoot { @@ -54,9 +54,9 @@ public record PmcConfig : BaseConfig set; } - /** - * Global whitelist/blacklist of backpack loot for PMCs - */ + /// + /// Global whitelist/blacklist of backpack loot for PMCs + /// [JsonPropertyName("backpackLoot")] public SlotLootSettings BackpackLoot { @@ -71,9 +71,9 @@ public record PmcConfig : BaseConfig set; } - /** - * Use difficulty defined in config/bot.json/difficulty instead of chosen difficulty dropdown value - */ + /// + /// Use difficulty defined in config/bot.json/difficulty instead of chosen difficulty dropdown value + /// [JsonPropertyName("useDifficultyOverride")] public bool UseDifficultyOverride { @@ -81,9 +81,9 @@ public record PmcConfig : BaseConfig set; } - /** - * Difficulty override e.g. "AsOnline/Hard" - */ + /// + /// Difficulty override e.g. "AsOnline/Hard" + /// [JsonPropertyName("difficulty")] public string Difficulty { @@ -91,9 +91,9 @@ public record PmcConfig : BaseConfig set; } - /** - * Chance out of 100 to have a complete gun in backpack - */ + /// + /// Chance out of 100 to have a complete gun in backpack + /// [JsonPropertyName("looseWeaponInBackpackChancePercent")] public double LooseWeaponInBackpackChancePercent { @@ -101,9 +101,9 @@ public record PmcConfig : BaseConfig set; } - /** - * Chance out of 100 to have an enhancement applied to PMC weapon - */ + /// + /// Chance out of 100 to have an enhancement applied to PMC weapon + /// [JsonPropertyName("weaponHasEnhancementChancePercent")] public double WeaponHasEnhancementChancePercent { @@ -111,9 +111,9 @@ public record PmcConfig : BaseConfig set; } - /** - * MinMax count of weapons to have in backpack - */ + /// + /// MinMax count of weapons to have in backpack + /// [JsonPropertyName("looseWeaponInBackpackLootMinMax")] public MinMax LooseWeaponInBackpackLootMinMax { @@ -128,9 +128,9 @@ public record PmcConfig : BaseConfig set; } - /** - * Percentage chance PMC will be USEC - */ + /// + /// Percentage chance PMC will be USEC + /// [JsonPropertyName("isUsec")] public double IsUsec { @@ -138,9 +138,9 @@ public record PmcConfig : BaseConfig set; } - /** - * WildSpawnType enum value USEC PMCs use - */ + /// + /// WildSpawnType enum value USEC PMCs use + /// [JsonPropertyName("usecType")] public string UsecType { @@ -148,9 +148,9 @@ public record PmcConfig : BaseConfig set; } - /** - * WildSpawnType enum value BEAR PMCs use - */ + /// + /// WildSpawnType enum value BEAR PMCs use + /// [JsonPropertyName("bearType")] public string BearType { @@ -165,9 +165,9 @@ public record PmcConfig : BaseConfig set; } - /** - * What 'brain' does a PMC use, keyed by map and side (USEC/BEAR) key: map location, value: type for usec/bear - */ + /// + /// What 'brain' does a PMC use, keyed by map and side (USEC/BEAR) key: map location, value: type for usec/bear + /// [JsonPropertyName("pmcType")] public Dictionary>> PmcType { @@ -196,9 +196,9 @@ public record PmcConfig : BaseConfig set; } - /** - * How many levels above player level can a PMC be - */ + /// + /// How many levels above player level can a PMC be + /// [JsonPropertyName("botRelativeLevelDeltaMax")] public int BotRelativeLevelDeltaMax { @@ -206,9 +206,9 @@ public record PmcConfig : BaseConfig set; } - /** - * How many levels below player level can a PMC be - */ + /// + /// How many levels below player level can a PMC be + /// [JsonPropertyName("botRelativeLevelDeltaMin")] public int BotRelativeLevelDeltaMin { @@ -216,9 +216,9 @@ public record PmcConfig : BaseConfig set; } - /** - * Force a number of healing items into PMCs secure container to ensure they can heal - */ + /// + /// Force a number of healing items into PMCs secure container to ensure they can heal + /// [JsonPropertyName("forceHealingItemsIntoSecure")] public bool ForceHealingItemsIntoSecure { @@ -247,9 +247,9 @@ public record PmcConfig : BaseConfig set; } - /** - * Should secure container loot from usec.json/bear.json be added to pmc bots secure - */ + /// + /// Should secure container loot from usec.json/bear.json be added to pmc bots secure + /// [JsonPropertyName("addSecureContainerLootFromBotConfig")] public bool AddSecureContainerLootFromBotConfig { @@ -288,9 +288,9 @@ public record PmcConfig : BaseConfig public record HostilitySettings { - /** - * Bot roles that are 100% an enemy - */ + /// + /// Bot roles that are 100% an enemy + /// [JsonPropertyName("additionalEnemyTypes")] public List? AdditionalEnemyTypes { @@ -298,9 +298,9 @@ public record HostilitySettings set; } - /** - * Objects that determine the % chance another bot type is an enemy - */ + /// + /// Objects that determine the % chance another bot type is an enemy + /// [JsonPropertyName("chancedEnemies")] public List? ChancedEnemies { @@ -329,9 +329,9 @@ public record HostilitySettings set; } - /** - * Bot roles that are 100% a friendly - */ + /// + /// Bot roles that are 100% a friendly + /// [JsonPropertyName("additionalFriendlyTypes")] public List? AdditionalFriendlyTypes { @@ -366,9 +366,9 @@ public record PmcTypes public record SlotLootSettings { - /** - * Item Type whitelist - */ + /// + /// Item Type whitelist + /// [JsonPropertyName("whitelist")] public HashSet Whitelist { @@ -376,9 +376,9 @@ public record SlotLootSettings set; } - /** - * Item tpl blacklist - */ + /// + /// Item tpl blacklist + /// [JsonPropertyName("blacklist")] public HashSet Blacklist { diff --git a/Libraries/Core/Models/Spt/Config/QuestConfig.cs b/Libraries/Core/Models/Spt/Config/QuestConfig.cs index 70e6bf8e..bcbfb286 100644 --- a/Libraries/Core/Models/Spt/Config/QuestConfig.cs +++ b/Libraries/Core/Models/Spt/Config/QuestConfig.cs @@ -15,7 +15,9 @@ public record QuestConfig : BaseConfig set; } = "spt-quest"; - // Hours to get/redeem items from quest mail keyed by profile type + /// + /// Hours to get/redeem items from quest mail keyed by profile type + /// [JsonPropertyName("mailRedeemTimeHours")] public Dictionary? MailRedeemTimeHours { @@ -30,9 +32,9 @@ public record QuestConfig : BaseConfig set; } - /** - * Show non-seasonal quests be shown to player - */ + /// + /// Show non-seasonal quests be shown to player + /// [JsonPropertyName("showNonSeasonalEventQuests")] public bool? ShowNonSeasonalEventQuests { @@ -75,9 +77,9 @@ public record QuestConfig : BaseConfig set; } - /** - * Quests that the keyed game version do not see/access - */ + /// + /// Quests that the keyed game version do not see/access + /// [JsonPropertyName("profileBlacklist")] public Dictionary>? ProfileBlacklist { @@ -85,9 +87,9 @@ public record QuestConfig : BaseConfig set; } - /** - * key=questid, gameversions that can see/access quest - */ + /// + /// key=questid, gameversions that can see/access quest + /// [JsonPropertyName("profileWhitelist")] public Dictionary>? ProfileWhitelist { @@ -262,9 +264,9 @@ public record RepeatableQuestConfig set; } - /** - * Item base types to block when generating rewards - */ + /// + /// Item base types to block when generating rewards + /// [JsonPropertyName("rewardBaseTypeBlacklist")] public HashSet? RewardBaseTypeBlacklist { @@ -272,9 +274,9 @@ public record RepeatableQuestConfig set; } - /** - * Item tplIds to ignore when generating rewards - */ + /// + /// Item tplIds to ignore when generating rewards + /// [JsonPropertyName("rewardBlacklist")] public HashSet? RewardBlacklist { diff --git a/Libraries/Core/Models/Spt/Config/RagfairConfig.cs b/Libraries/Core/Models/Spt/Config/RagfairConfig.cs index ee3568fa..d61a8888 100644 --- a/Libraries/Core/Models/Spt/Config/RagfairConfig.cs +++ b/Libraries/Core/Models/Spt/Config/RagfairConfig.cs @@ -12,9 +12,9 @@ public record RagfairConfig : BaseConfig set; } = "spt-ragfair"; - /** - * How many seconds should pass before expired offers and processed + player offers checked if sold - */ + /// + /// How many seconds should pass before expired offers and processed + player offers checked if sold + /// [JsonPropertyName("runIntervalSeconds")] public int RunIntervalSeconds { @@ -22,9 +22,9 @@ public record RagfairConfig : BaseConfig set; } - /** - * Default values used to hydrate `runIntervalSeconds` with - */ + /// + /// Default values used to hydrate `runIntervalSeconds` with + /// [JsonPropertyName("runIntervalValues")] public RunIntervalValues RunIntervalValues { @@ -32,9 +32,9 @@ public record RagfairConfig : BaseConfig set; } - /** - * Player listing settings - */ + /// + /// Player listing settings + /// [JsonPropertyName("sell")] public Sell Sell { @@ -42,9 +42,9 @@ public record RagfairConfig : BaseConfig set; } - /** - * Trader ids + should their assorts be listed on flea - */ + /// + /// Trader ids + should their assorts be listed on flea + /// [JsonPropertyName("traders")] public Dictionary Traders { @@ -69,9 +69,9 @@ public record RagfairConfig : BaseConfig public record Sell { - /** - * Should a fee be deducted from player when listing an item for sale - */ + /// + /// Should a fee be deducted from player when listing an item for sale + /// [JsonPropertyName("fees")] public bool Fees { @@ -79,9 +79,9 @@ public record Sell set; } - /** - * Settings to control chances of offer being sold - */ + /// + /// Settings to control chances of offer being sold + /// [JsonPropertyName("chance")] public Chance Chance { @@ -89,9 +89,9 @@ public record Sell set; } - /** - * Settings to control how long it takes for a player offer to sell - */ + /// + /// Settings to control how long it takes for a player offer to sell + /// [JsonPropertyName("time")] public MinMax Time { @@ -99,9 +99,9 @@ public record Sell set; } - /** - * Seconds from clicking remove to remove offer from market - */ + /// + /// Seconds from clicking remove to remove offer from market + /// [JsonPropertyName("expireSeconds")] public int ExpireSeconds { @@ -112,9 +112,9 @@ public record Sell public record Chance { - /** - * Base chance percent to sell an item - */ + /// + /// Base chance percent to sell an item + /// [JsonPropertyName("base")] public int Base { @@ -122,9 +122,9 @@ public record Chance set; } - /** - * Value to multiply the sell chance by - */ + /// + /// Value to multiply the sell chance by + /// [JsonPropertyName("sellMultiplier")] public double SellMultiplier { @@ -132,9 +132,9 @@ public record Chance set; } - /** - * Max possible sell chance % for a player listed offer - */ + /// + /// Max possible sell chance % for a player listed offer + /// [JsonPropertyName("maxSellChancePercent")] public int MaxSellChancePercent { @@ -142,9 +142,9 @@ public record Chance set; } - /** - * Min possible sell chance % for a player listed offer - */ + /// + /// Min possible sell chance % for a player listed offer + /// [JsonPropertyName("minSellChancePercent")] public int MinSellChancePercent { @@ -155,24 +155,30 @@ public record Chance public record Dynamic { + /// + /// Should a purchased dynamic offers items be flagged as found in raid + /// [JsonPropertyName("purchasesAreFoundInRaid")] - // Should a purchased dynamic offers items be flagged as found in raid public bool PurchasesAreFoundInRaid { get; set; } + /// + /// Use the highest trader price for an offer if its greater than the price in templates/prices.json + /// [JsonPropertyName("useTraderPriceForOffersIfHigher")] - /** Use the highest trader price for an offer if its greater than the price in templates/prices.json */ public bool UseTraderPriceForOffersIfHigher { get; set; } + /// + /// Barter offer specific settings + /// [JsonPropertyName("barter")] - /** Barter offer specific settings */ public BarterDetails Barter { get; @@ -186,48 +192,60 @@ public record Dynamic set; } + /// + /// Dynamic offer price below handbook adjustment values + /// [JsonPropertyName("offerAdjustment")] - /** Dynamic offer price below handbook adjustment values */ public OfferAdjustment OfferAdjustment { get; set; } + /// + /// How many offers should expire before an offer regeneration occurs + /// [JsonPropertyName("expiredOfferThreshold")] - /** How many offers should expire before an offer regeneration occurs */ public int ExpiredOfferThreshold { get; set; } + /// + /// How many offers should be listed + /// [JsonPropertyName("offerItemCount")] - /** How many offers should be listed */ public MinMax OfferItemCount { get; set; } + /// + /// How much should the price of an offer vary by (percent 0.8 = 80%, 1.2 = 120%) + /// [JsonPropertyName("priceRanges")] - /** How much should the price of an offer vary by (percent 0.8 = 80%, 1.2 = 120%) */ public PriceRanges PriceRanges { get; set; } + /// + /// Should default presets to listed only or should non-standard presets found in globals.json be listed too + /// [JsonPropertyName("showDefaultPresetsOnly")] - /** Should default presets to listed only or should non-standard presets found in globals.json be listed too */ public bool ShowDefaultPresetsOnly { get; set; } + /// + /// Tpls that should not use the variable price system when their quality is less than 100% (lower dura/uses = lower price) + /// [JsonPropertyName("ignoreQualityPriceVarianceBlacklist")] - /** Tpls that should not use the variable price system when their quality is < 100% (lower dura/uses = lower price) */ public HashSet IgnoreQualityPriceVarianceBlacklist { get; @@ -241,48 +259,60 @@ public record Dynamic set; } + /// + /// Settings to control the durability range of item items listed on flea + /// [JsonPropertyName("condition")] - /** Settings to control the durability range of item items listed on flea */ public Dictionary Condition { get; set; } + /// + /// Size stackable items should be listed for in percent of max stack size + /// [JsonPropertyName("stackablePercent")] - /** Size stackable items should be listed for in percent of max stack size */ public MinMax StackablePercent { get; set; } + /// + /// Items that cannot be stacked can have multiples sold in one offer, what range of values can be listed + /// [JsonPropertyName("nonStackableCount")] - /** Items that cannot be stacked can have multiples sold in one offer, what range of values can be listed */ public MinMax NonStackableCount { get; set; } + /// + /// Range of rating offers for items being listed + /// [JsonPropertyName("rating")] - /** Range of rating offers for items being listed */ public MinMax Rating { get; set; } + /// + /// Armor specific flea settings + /// [JsonPropertyName("armor")] - /** Armor specific flea settings */ public ArmorSettings Armor { get; set; } + /// + /// A multipler to apply to individual tpls price just prior to item quality adjustment + /// [JsonPropertyName("itemPriceMultiplier")] - /** A multipler to apply to individual tpls price just prior to item quality adjustment */ public Dictionary? ItemPriceMultiplier { get; @@ -296,48 +326,60 @@ public record Dynamic set; } + /// + /// Percentages to sell offers in each currency + /// [JsonPropertyName("currencies")] - /** Percentages to sell offers in each currency */ public Dictionary Currencies { get; set; } + /// + /// Item tpls that should be forced to sell as a single item + /// [JsonPropertyName("showAsSingleStack")] - /** Item tpls that should be forced to sell as a single item */ public HashSet ShowAsSingleStack { get; set; } + /// + /// Should christmas/halloween items be removed from flea when not within the seasonal bounds + /// [JsonPropertyName("removeSeasonalItemsWhenNotInEvent")] - /** Should christmas/halloween items be removed from flea when not within the seasonal bounds */ public bool RemoveSeasonalItemsWhenNotInEvent { get; set; } + /// + /// Flea blacklist settings + /// [JsonPropertyName("blacklist")] - /** Flea blacklist settings */ public RagfairBlacklist Blacklist { get; set; } + /// + /// Dict of price limits keyed by item type + /// [JsonPropertyName("unreasonableModPrices")] - /** Dict of price limits keyed by item type */ public Dictionary UnreasonableModPrices { get; set; } + /// + /// Custom rouble prices for items to override values from prices.json + /// [JsonPropertyName("itemPriceOverrideRouble")] - /** Custom rouble prices for items to override values from prices.json */ public Dictionary ItemPriceOverrideRouble { get; @@ -371,9 +413,9 @@ public record PriceRanges public record BarterDetails { - /** - * Percentage change an offer is listed as a barter - */ + /// + /// Percentage change an offer is listed as a barter + /// [JsonPropertyName("chancePercent")] public double ChancePercent { @@ -381,9 +423,9 @@ public record BarterDetails set; } - /** - * Min number of required items for a barter requirement - */ + /// + /// Min number of required items for a barter requirement + /// [JsonPropertyName("itemCountMin")] public int ItemCountMin { @@ -391,9 +433,9 @@ public record BarterDetails set; } - /** - * Max number of required items for a barter requirement - */ + /// + /// Max number of required items for a barter requirement + /// [JsonPropertyName("itemCountMax")] public int ItemCountMax { @@ -401,9 +443,9 @@ public record BarterDetails set; } - /** - * How much can the total price of requested items vary from the item offered - */ + /// + /// How much can the total price of requested items vary from the item offered + /// [JsonPropertyName("priceRangeVariancePercent")] public double PriceRangeVariancePercent { @@ -411,9 +453,9 @@ public record BarterDetails set; } - /** - * Min rouble price for an offer to be considered for turning into a barter - */ + /// + /// Min rouble price for an offer to be considered for turning into a barter + /// [JsonPropertyName("minRoubleCostToBecomeBarter")] public double MinRoubleCostToBecomeBarter { @@ -421,9 +463,9 @@ public record BarterDetails set; } - /** - * Should barter offers only single stack - */ + /// + /// Should barter offers only single stack + /// [JsonPropertyName("makeSingleStackOnly")] public bool MakeSingleStackOnly { @@ -431,9 +473,9 @@ public record BarterDetails set; } - /** - * Item Tpls to never be turned into a barter - */ + /// + /// Item Tpls to never be turned into a barter + /// [JsonPropertyName("itemTypeBlacklist")] public HashSet ItemTypeBlacklist { @@ -444,9 +486,9 @@ public record BarterDetails public record PackDetails { - /** - * Percentage change an offer is listed as a pack - */ + /// + /// Percentage change an offer is listed as a pack + /// [JsonPropertyName("chancePercent")] public double ChancePercent { @@ -454,9 +496,9 @@ public record PackDetails set; } - /** - * Min number of required items for a pack - */ + /// + /// Min number of required items for a pack + /// [JsonPropertyName("itemCountMin")] public int ItemCountMin { @@ -464,9 +506,9 @@ public record PackDetails set; } - /** - * Max number of required items for a pack - */ + /// + /// Max number of required items for a pack + /// [JsonPropertyName("itemCountMax")] public int ItemCountMax { @@ -474,9 +516,9 @@ public record PackDetails set; } - /** - * item types to allow being a pack - */ + /// + /// item types to allow being a pack + /// [JsonPropertyName("itemTypeWhitelist")] public HashSet ItemTypeWhitelist { diff --git a/Libraries/Core/Models/Spt/Config/RepairConfig.cs b/Libraries/Core/Models/Spt/Config/RepairConfig.cs index a07ba56d..75507091 100644 --- a/Libraries/Core/Models/Spt/Config/RepairConfig.cs +++ b/Libraries/Core/Models/Spt/Config/RepairConfig.cs @@ -41,9 +41,9 @@ public record RepairConfig : BaseConfig set; } - /** - * INT gain multiplier per repaired item type - */ + /// + /// INT gain multiplier per repaired item type + /// [JsonPropertyName("repairKitIntellectGainMultiplier")] public IntellectGainValues RepairKitIntellectGainMultiplier { @@ -51,7 +51,9 @@ public record RepairConfig : BaseConfig set; } - // ** How much INT can be given to player per repair action */ + /// + /// How much INT can be given to player per repair action + /// [JsonPropertyName("maxIntellectGainPerRepair")] public MaxIntellectGainValues MaxIntellectGainPerRepair { @@ -110,9 +112,9 @@ public record MaxIntellectGainValues public record WeaponTreatmentRepairValues { - /** - * The chance to gain more weapon maintenance skill - */ + /// + /// The chance to gain more weapon maintenance skill + /// [JsonPropertyName("critSuccessChance")] public double CritSuccessChance { @@ -127,9 +129,9 @@ public record WeaponTreatmentRepairValues set; } - /** - * The chance to gain less weapon maintenance skill - */ + /// + /// The chance to gain less weapon maintenance skill + /// [JsonPropertyName("critFailureChance")] public double CritFailureChance { @@ -144,9 +146,9 @@ public record WeaponTreatmentRepairValues set; } - /** - * The multiplier used for calculating weapon maintenance XP - */ + /// + /// The multiplier used for calculating weapon maintenance XP + /// [JsonPropertyName("pointGainMultiplier")] public double PointGainMultiplier { @@ -226,9 +228,9 @@ public record BonusValues set; } - /** - * What dura is buff active between (min max of current max) - */ + /// + /// What dura is buff active between (min max of current max) + /// [JsonPropertyName("activeDurabilityPercentMinMax")] public MinMax ActiveDurabilityPercentMinMax { diff --git a/Libraries/Core/Models/Spt/Config/SeasonalEventConfig.cs b/Libraries/Core/Models/Spt/Config/SeasonalEventConfig.cs index 8f7d03bd..d4f2ea7b 100644 --- a/Libraries/Core/Models/Spt/Config/SeasonalEventConfig.cs +++ b/Libraries/Core/Models/Spt/Config/SeasonalEventConfig.cs @@ -21,9 +21,9 @@ public record SeasonalEventConfig : BaseConfig set; } - /** - * event / botType / equipSlot / itemid - */ + /// + /// event / botType / equipSlot / itemid + /// [JsonPropertyName("eventGear")] public Dictionary>>> EventGear { @@ -31,9 +31,9 @@ public record SeasonalEventConfig : BaseConfig set; } - /** - * event / bot type / equipSlot / itemid - */ + /// + /// event / bot type / equipSlot / itemid + /// [JsonPropertyName("eventLoot")] public Dictionary>>> EventLoot { @@ -76,9 +76,9 @@ public record SeasonalEventConfig : BaseConfig set; } - /** - * key = event, second key = map name - */ + /// + /// key = event, second key = map name + /// [JsonPropertyName("hostilitySettingsForEvent")] public Dictionary>> HostilitySettingsForEvent { @@ -86,9 +86,9 @@ public record SeasonalEventConfig : BaseConfig set; } - /** - * Ids of containers on locations that only have christmas loot - */ + /// + /// Ids of containers on locations that only have Christmas loot + /// [JsonPropertyName("christmasContainerIds")] public List ChristmasContainerIds { @@ -96,9 +96,9 @@ public record SeasonalEventConfig : BaseConfig set; } - /** - * Season - botType - location (body/feet/hands/head) - */ + /// + /// Season - botType - location (body/feet/hands/head) + /// [JsonPropertyName("botAppearanceChanges")] public Dictionary>>> BotAppearanceChanges { diff --git a/Libraries/Core/Models/Spt/Config/TraderConfig.cs b/Libraries/Core/Models/Spt/Config/TraderConfig.cs index 2b0d553e..72a734dd 100644 --- a/Libraries/Core/Models/Spt/Config/TraderConfig.cs +++ b/Libraries/Core/Models/Spt/Config/TraderConfig.cs @@ -34,9 +34,9 @@ public record TraderConfig : BaseConfig set; } - /** - * Should trader reset times be set based on server start time (false = bsg time - on the hour) - */ + /// + /// Should trader reset times be set based on server start time (false = bsg time - on the hour) + /// [JsonPropertyName("tradersResetFromServerStart")] public bool TradersResetFromServerStart { @@ -82,9 +82,9 @@ public record UpdateTime set; } - /** - * Seconds between trader resets - */ + /// + /// Seconds between trader resets + /// [JsonPropertyName("seconds")] public MinMax Seconds { @@ -165,9 +165,9 @@ public record FenceConfig set; } - /** - * Keyed to plate protection level - */ + /// + /// Keyed to plate protection level + /// [JsonPropertyName("chancePlateExistsInArmorPercent")] public Dictionary ChancePlateExistsInArmorPercent { @@ -175,9 +175,9 @@ public record FenceConfig set; } - /** - * Key: item tpl - */ + /// + /// Key: item tpl + /// [JsonPropertyName("itemStackSizeOverrideMinMax")] public Dictionary?> ItemStackSizeOverrideMinMax { @@ -192,9 +192,9 @@ public record FenceConfig set; } - /** - * Prevent duplicate offers of items of specific categories by parentId - */ + /// + /// Prevent duplicate offers of items of specific categories by parentId + /// [JsonPropertyName("preventDuplicateOffersOfCategory")] public List PreventDuplicateOffersOfCategory { @@ -209,9 +209,9 @@ public record FenceConfig set; } - /** - * Max rouble price before item is not listed on flea - */ + /// + /// Max rouble price before item is not listed on flea + /// [JsonPropertyName("itemCategoryRoublePriceLimit")] public Dictionary ItemCategoryRoublePriceLimit { @@ -219,9 +219,9 @@ public record FenceConfig set; } - /** - * Each slotid with % to be removed prior to listing on fence - */ + /// + /// Each slotid with % to be removed prior to listing on fence + /// [JsonPropertyName("presetSlotsToRemoveChancePercent")] public Dictionary PresetSlotsToRemoveChancePercent { @@ -229,9 +229,9 @@ public record FenceConfig set; } - /** - * Block seasonal items from appearing when season is inactive - */ + /// + /// Block seasonal items from appearing when season is inactive + /// [JsonPropertyName("blacklistSeasonalItems")] public bool BlacklistSeasonalItems { @@ -239,9 +239,9 @@ public record FenceConfig set; } - /** - * Max pen value allowed to be listed on flea - affects ammo + ammo boxes - */ + /// + /// Max pen value allowed to be listed on flea - affects ammo + ammo boxes + /// [JsonPropertyName("ammoMaxPenLimit")] public double AmmoMaxPenLimit { @@ -270,9 +270,9 @@ public record FenceConfig set; } - /** - * Smallest value player rep with fence can fall to - */ + /// + /// Smallest value player rep with fence can fall to + /// [JsonPropertyName("playerRepMin")] public double PlayerRepMin { @@ -280,9 +280,9 @@ public record FenceConfig set; } - /** - * Highest value player rep with fence can climb to - */ + /// + /// Highest value player rep with fence can climb to + /// [JsonPropertyName("playerRepMax")] public double PlayerRepMax { @@ -377,14 +377,14 @@ public record DiscountOptions } } -/** - * Custom trader data needed client side for things such as the clothing service - */ +/// +/// Custom trader data needed client side for things such as the clothing service +/// public record ModdedTraders { - /** - * Trader Ids to enable the clothing service for - */ + /// + /// Trader Ids to enable the clothing service for + /// [JsonPropertyName("clothingService")] public List ClothingService { diff --git a/Libraries/Core/Models/Spt/Config/WeatherConfig.cs b/Libraries/Core/Models/Spt/Config/WeatherConfig.cs index 4ce5ef79..f9e37ee9 100644 --- a/Libraries/Core/Models/Spt/Config/WeatherConfig.cs +++ b/Libraries/Core/Models/Spt/Config/WeatherConfig.cs @@ -101,9 +101,9 @@ public record WeatherValues set; } - /** - * How many hours to generate weather data into the future - */ + /// + /// How many hours to generate weather data into the future + /// [JsonPropertyName("generateWeatherAmountHours")] public int? GenerateWeatherAmountHours { @@ -111,9 +111,9 @@ public record WeatherValues set; } - /** - * Length of each weather period - */ + /// + /// Length of each weather period + /// [JsonPropertyName("timePeriod")] public WeatherSettings? TimePeriod { diff --git a/Libraries/Core/Models/Spt/Dialog/SendMessageDetails.cs b/Libraries/Core/Models/Spt/Dialog/SendMessageDetails.cs index 792cc7af..23b48c3d 100644 --- a/Libraries/Core/Models/Spt/Dialog/SendMessageDetails.cs +++ b/Libraries/Core/Models/Spt/Dialog/SendMessageDetails.cs @@ -127,9 +127,9 @@ public record SendMessageDetails set; } - /** - * Optional - the MongoID of the dialogue message to reply to - */ + /// + /// Optional - the MongoID of the dialogue message to reply to + /// [JsonPropertyName("replyTo")] public string? ReplyTo { diff --git a/Libraries/Core/Models/Spt/Inventory/OwnerInventoryItems.cs b/Libraries/Core/Models/Spt/Inventory/OwnerInventoryItems.cs index 9fa3491f..dd39d6d1 100644 --- a/Libraries/Core/Models/Spt/Inventory/OwnerInventoryItems.cs +++ b/Libraries/Core/Models/Spt/Inventory/OwnerInventoryItems.cs @@ -5,6 +5,9 @@ namespace Core.Models.Spt.Inventory; public record OwnerInventoryItems { + /// + /// Inventory items from source + /// [JsonPropertyName("from")] public List? From { @@ -12,6 +15,9 @@ public record OwnerInventoryItems set; } + /// + /// Inventory items at destination + /// [JsonPropertyName("to")] public List? To { diff --git a/Libraries/Core/Models/Spt/Location/RaidChanges.cs b/Libraries/Core/Models/Spt/Location/RaidChanges.cs index 770db49e..73ef765c 100644 --- a/Libraries/Core/Models/Spt/Location/RaidChanges.cs +++ b/Libraries/Core/Models/Spt/Location/RaidChanges.cs @@ -4,6 +4,9 @@ namespace Core.Models.Spt.Location; public record RaidChanges { + /// + /// What percentage of dynamic loot should the map contain + /// [JsonPropertyName("dynamicLootPercent")] public double? DynamicLootPercent { @@ -11,6 +14,9 @@ public record RaidChanges set; } + /// + /// What percentage of static loot should the map contain + /// [JsonPropertyName("staticLootPercent")] public double? StaticLootPercent { @@ -18,6 +24,9 @@ public record RaidChanges set; } + /// + /// How many seconds into the raid is the player simulated to spawn in at + /// [JsonPropertyName("simulatedRaidStartSeconds")] public double? SimulatedRaidStartSeconds { @@ -25,7 +34,9 @@ public record RaidChanges set; } - /** How many minutes are in the raid total */ + /// + /// How many minutes are in the raid total + /// [JsonPropertyName("RaidTimeMinutes")] public double? RaidTimeMinutes { @@ -33,7 +44,9 @@ public record RaidChanges set; } - /** The new number of seconds required to avoid a run through */ + /// + /// The new number of seconds required to avoid a run through + /// [JsonPropertyName("NewSurviveTimeSeconds")] public double? NewSurviveTimeSeconds { @@ -41,7 +54,9 @@ public record RaidChanges set; } - /** The original number of seconds required to avoid a run through */ + /// + /// The original number of seconds required to avoid a run through + /// [JsonPropertyName("OriginalSurvivalTimeSeconds")] public double? OriginalSurvivalTimeSeconds { @@ -49,7 +64,9 @@ public record RaidChanges set; } - /** Any changes required to the extract list */ + /// + /// Any changes required to the extract list + /// [JsonPropertyName("ExitChanges")] public List? ExitChanges { diff --git a/Libraries/Core/Models/Spt/Mod/NewItemDetails.cs b/Libraries/Core/Models/Spt/Mod/NewItemDetails.cs index 4bae7166..836e446b 100644 --- a/Libraries/Core/Models/Spt/Mod/NewItemDetails.cs +++ b/Libraries/Core/Models/Spt/Mod/NewItemDetails.cs @@ -15,6 +15,9 @@ public record NewItemDetails : NewItemDetailsBase public record NewItemFromCloneDetails : NewItemDetailsBase { + /// + /// Id of the item to copy and use as a base + /// [JsonPropertyName("itemTplToClone")] public string? ItemTplToClone { @@ -22,6 +25,9 @@ public record NewItemFromCloneDetails : NewItemDetailsBase set; } + /// + /// Item properties that should be applied over the top of the cloned base + /// [JsonPropertyName("overrideProperties")] public Props? OverrideProperties { @@ -29,6 +35,9 @@ public record NewItemFromCloneDetails : NewItemDetailsBase set; } + /// + /// ParentId for the new item (item type) + /// [JsonPropertyName("parentId")] public string? ParentId { @@ -36,6 +45,10 @@ public record NewItemFromCloneDetails : NewItemDetailsBase set; } + /// + /// the id the new item should have, leave blank to have one generated for you. + /// This is often known as the TplId, or TemplateId + /// [JsonPropertyName("newId")] public string? NewId { diff --git a/Libraries/Core/Models/Spt/Ragfair/TplWithFleaPrice.cs b/Libraries/Core/Models/Spt/Ragfair/TplWithFleaPrice.cs index a8ab6958..b32b81fb 100644 --- a/Libraries/Core/Models/Spt/Ragfair/TplWithFleaPrice.cs +++ b/Libraries/Core/Models/Spt/Ragfair/TplWithFleaPrice.cs @@ -11,7 +11,9 @@ public record TplWithFleaPrice set; } - // Roubles + /// + /// Roubles + /// [JsonPropertyName("price")] public double? Price { diff --git a/Libraries/Core/Models/Spt/Server/Locations.cs b/Libraries/Core/Models/Spt/Server/Locations.cs index d4a8c93f..85286f3d 100644 --- a/Libraries/Core/Models/Spt/Server/Locations.cs +++ b/Libraries/Core/Models/Spt/Server/Locations.cs @@ -178,9 +178,9 @@ public record Locations set; } - /** - * Holds a mapping of the linkages between locations on the UI - */ + /// + /// Holds a mapping of the linkages between locations on the UI + /// [JsonPropertyName("base")] public LocationsBase? Base { diff --git a/Libraries/Core/Models/Spt/Services/LootRequest.cs b/Libraries/Core/Models/Spt/Services/LootRequest.cs index e29359b2..3b54c64a 100644 --- a/Libraries/Core/Models/Spt/Services/LootRequest.cs +++ b/Libraries/Core/Models/Spt/Services/LootRequest.cs @@ -133,6 +133,9 @@ public record LootRequest set; } + /// + /// Should seasonal items appear when it's not the season for them + /// [JsonPropertyName("blockSeasonalItemsOutOfSeason")] public bool? BlockSeasonalItemsOutOfSeason { diff --git a/Libraries/Core/Models/Spt/Templates/Templates.cs b/Libraries/Core/Models/Spt/Templates/Templates.cs index fbc5d071..cd4e31c2 100644 --- a/Libraries/Core/Models/Spt/Templates/Templates.cs +++ b/Libraries/Core/Models/Spt/Templates/Templates.cs @@ -62,9 +62,9 @@ public record Templates set; } - /** - * The profile templates listed in the launcher on profile creation, split by account type (e.g. Standard) then side (e.g. bear/usec) - */ + /// + /// The profile templates listed in the launcher on profile creation, split by account type (e.g. Standard) then side (e.g. bear/usec) + /// [JsonPropertyName("profiles")] public ProfileTemplates? Profiles { @@ -72,9 +72,9 @@ public record Templates set; } - /** - * Flea prices of items - gathered from online flea market dump - */ + /// + /// Flea prices of items - gathered from online flea market dump + /// [JsonPropertyName("prices")] public Dictionary? Prices { @@ -82,9 +82,9 @@ public record Templates set; } - /** - * Default equipment loadouts that show on main inventory screen - */ + /// + /// Default equipment loadouts that show on main inventory screen + /// [JsonPropertyName("defaultEquipmentPresets")] public List? DefaultEquipmentPresets { @@ -92,9 +92,9 @@ public record Templates set; } - /** - * Achievements - */ + /// + /// Achievements + /// [JsonPropertyName("achievements")] public List? Achievements { @@ -102,9 +102,9 @@ public record Templates set; } - /** - * Location services data - */ + /// + /// Location services data + /// [JsonPropertyName("locationServices")] public LocationServices? LocationServices {