@wayward/types 2.11.3-beta.dev.20220123.1 → 2.11.3-beta.dev.20220126.1

package/definitions/game/audio/IAudio.d.ts

@@ -34,25 +34,25 @@ export declare enum SfxType {
     Death = 7,
     Eating = 8,
     Exceptional = 9,
-    Fail = 10,
-    Hit = 11,
-    Hurt = 12,
-    Miss = 13,
-    PickUp = 14,
-    RockHit = 15,
-    SandstoneHit = 16,
-    Swim = 17,
-    Throw = 18,
-    Trample = 19,
-    TreeHit = 20,
-    UiActivate = 21,
-    UiDisable = 22,
-    UiEnable = 23,
-    UiInput = 24,
-    UiSelect = 25,
-    Walk = 26,
-    Water = 27,
-    Extinguish = 28
+    Extinguish = 10,
+    Fail = 11,
+    Hit = 12,
+    Hurt = 13,
+    Miss = 14,
+    PickUp = 15,
+    RockHit = 16,
+    SandstoneHit = 17,
+    Swim = 18,
+    Throw = 19,
+    Trample = 20,
+    TreeHit = 21,
+    UiActivate = 22,
+    UiDisable = 23,
+    UiEnable = 24,
+    UiInput = 25,
+    UiSelect = 26,
+    Walk = 27,
+    Water = 28
 }
 export declare enum Music {
     Shipwrecked = 0,

package/definitions/game/game/item/IItemManager.d.ts

@@ -10,8 +10,34 @@
  */
 import type Doodad from "game/doodad/Doodad";
 import type { DoodadType, DoodadTypeGroup } from "game/doodad/IDoodad";
+import type { ActionType } from "game/entity/action/IAction";
+import type Item from "game/item/Item";
 import type TileEvent from "game/tile/TileEvent";
 import type { IVector3 } from "utilities/math/IVector";
+/**
+ * Includes all protected items by default
+ */
+export interface IGetItemOptions {
+    /**
+     * True to exclude protected items
+     */
+    excludeProtectedItems: boolean;
+    /**
+     * True to include protected items if they pass an item.willBreakOnDamage() check.
+     * excludeProtectedItems must be set to false for this to work.
+     */
+    includeProtectedItemsThatWillNotBreak: ActionType;
+    /**
+     * Item will be ignored
+     */
+    ignoreItem?: Item;
+}
+export interface IGetItemsOptions extends IGetItemOptions {
+    /**
+     * Include sub containers in the search
+     */
+    includeSubContainers: boolean;
+}
 export declare enum CraftStatus {
     Invalid = 0,
     Failed = 1,

package/definitions/game/game/item/ItemManager.d.ts

@@ -17,7 +17,7 @@ import type Player from "game/entity/player/Player";
 import { Quality } from "game/IObject";
 import type { ContainerReference, IContainable, IContainer, IItemDescription, IItemWeightComponent } from "game/item/IItem";
 import { ItemType, ItemTypeGroup } from "game/item/IItem";
-import type { IAddToContainerOptions, IRequirementInfo } from "game/item/IItemManager";
+import type { IAddToContainerOptions, IGetItemOptions, IGetItemsOptions, IRequirementInfo } from "game/item/IItemManager";
 import { CraftStatus, WeightType, ContainerReferenceSource } from "game/item/IItemManager";
 import Item from "game/item/Item";
 import type ItemRecipeRequirementChecker from "game/item/ItemRecipeRequirementChecker";
@@ -188,16 +188,16 @@ export default class ItemManager extends ObjectManager<Item, IItemManagerEvents>
     /**
      * Get the best tier item
      */
-    getBestSafeItemInContainerByUse(container: IContainer, action: ActionType, allowProtectedItems?: boolean, actionMayDamageItem?: boolean, consumable?: boolean): Item | undefined;
-    getItemInContainer(container: IContainer, itemTypeSearch: ItemType, ignoreItem?: Item, allowProtectedItems?: boolean): Item | undefined;
-    getItemForHuman(human: Human, search: ItemType | ItemTypeGroup, ignoreItem?: Item, allowProtectedItems?: boolean): Item | undefined;
-    getItemInContainerByGroup(container: IContainer, itemTypeGroupSearch: ItemTypeGroup, ignoreItem?: Item, allowProtectedItems?: boolean): Item | undefined;
+    getBestSafeItemInContainerByUse(container: IContainer, action: ActionType, options?: Partial<IGetItemsOptions>, consumable?: boolean): Item | undefined;
+    getItemInContainer(container: IContainer, itemTypeSearch: ItemType, options?: Partial<IGetItemOptions>): Item | undefined;
+    getItemForHuman(human: Human, search: ItemType | ItemTypeGroup, options?: Partial<IGetItemOptions>): Item | undefined;
+    getItemInContainerByGroup(container: IContainer, itemTypeGroupSearch: ItemTypeGroup, options?: Partial<IGetItemOptions>): Item | undefined;
     getItemInAdjacentContainersByGroup(position: IVector3, itemTypeGroupSearch: ItemTypeGroup): Item | undefined;
-    getItemsInContainer(container: IContainer, includeSubContainers?: boolean, allowProtectedItems?: boolean): Item[];
-    getItemsInContainerByType(container: IContainer, itemType: ItemType, includeSubContainers?: boolean, filterText?: string): Item[];
-    getItemsInContainerByGroup(container: IContainer, itemGroup: ItemTypeGroup, includeSubContainers?: boolean): Item[];
-    getItemInInventoryByGroup(human: Human, itemTypeGroupSearch: ItemTypeGroup, ignoreItem?: Item): Item | undefined;
-    isItemInContainer(container: IContainer, itemTypeSearch: ItemType, ignoreItem?: Item): boolean;
+    getItemsInContainer(container: IContainer, options?: Partial<IGetItemsOptions>): Item[];
+    getItemsInContainerByType(container: IContainer, itemType: ItemType, options?: Partial<IGetItemsOptions>, filterText?: string): Item[];
+    getItemsInContainerByGroup(container: IContainer, itemGroup: ItemTypeGroup, options?: Partial<IGetItemsOptions>): Item[];
+    getItemInInventoryByGroup(human: Human, itemTypeGroupSearch: ItemTypeGroup, options?: Partial<IGetItemOptions>): Item | undefined;
+    isItemInContainer(container: IContainer, itemTypeSearch: ItemType, options?: Partial<IGetItemOptions>): boolean;
     isContainableInContainer(containable: IContainable, container: IContainer): boolean;
     getAdjacentContainers(humanOrPosition: Human | IVector3, includeNpcs?: boolean, ignoreOptions?: boolean): IContainer[];
     isContainableInAdjacentContainer(player: Player, containable: IContainable, includeNpcs?: boolean, ignoreOptions?: boolean): boolean;
@@ -207,7 +207,7 @@ export default class ItemManager extends ObjectManager<Item, IItemManagerEvents>
      * Returns ordered items for the containers
      * Note: It may return the real containedItems array!
      */
-    getOrderedContainerItems(container: IContainer, allowProtectedItems?: boolean): Item[];
+    getOrderedContainerItems(container: IContainer, options?: Partial<IGetItemOptions>): Item[];
     reduceDismantleWeight(createdItems: Item[], itemWeight: number): void;
     getItemTypeTranslation(itemType: ItemType | ItemTypeGroup): Translation;
     getItemTypeTranslation(itemType: ItemType | ItemTypeGroup, count: number): Translation;

package/definitions/game/language/dictionary/UiTranslation.d.ts

@@ -497,288 +497,290 @@ declare enum UiTranslation {
     MenuNewsButtonAllNews = 482,
     MenuNewsButtonViewChangelog = 483,
     MenuOptionsButtonDitherFogOfWar = 484,
-    MenuOptionsButtonDisableCustomCursor = 485,
-    MenuOptionsButtonDisplayArticleInObjectNames = 486,
-    MenuOptionsButtonDisplayArticleInObjectNamesTooltip = 487,
-    MenuOptionsButtonFullscreen = 488,
-    MenuOptionsButtonDeveloperMode = 489,
-    MenuOptionsButtonDeveloperModeContextMenu = 490,
-    MenuOptionsButtonPixelFont = 491,
-    MenuOptionsButtonReloadGame = 492,
-    MenuOptionsButtonReloadStylesheets = 493,
-    MenuOptionsButtonResetGeneratedSpriteCache = 494,
-    MenuOptionsButtonExportGlobalSaveData = 495,
-    MenuOptionsButtonImportGlobalSaveData = 496,
-    MenuOptionsButtonSaveDataBackups = 497,
-    MenuOptionsButtonSaveDataBackupsTooltip = 498,
-    MenuOptionsButtonSaveDataClearAll = 499,
-    MenuOptionsButtonSaveDataClearCharacters = 500,
-    MenuOptionsButtonSaveDataClearHighscores = 501,
-    MenuOptionsButtonSaveDataClearMilestones = 502,
-    MenuOptionsButtonSaveDataClearOptions = 503,
-    MenuOptionsButtonSaveDataClearCraftingRecipes = 504,
-    MenuOptionsButtonSaveDataClearSaves = 505,
-    MenuOptionsButtonSkipSplash = 506,
-    MenuOptionsButtonToggleDevTools = 507,
-    MenuOptionsButtonTooltipsCreatures = 508,
-    MenuOptionsButtonOpenBackupsFolder = 509,
-    MenuOptionsButtonOpenLogsFolder = 510,
-    MenuOptionsButtonTooltipsDoodads = 511,
-    MenuOptionsButtonTooltipsItems = 512,
-    MenuOptionsButtonTooltipsTerrain = 513,
-    MenuOptionsButtonDropLocationFacing = 514,
-    MenuOptionsButtonDropLocationFeet = 515,
-    MenuOptionsButtonStartTraceRecording = 516,
-    MenuOptionsButtonStopTraceRecording = 517,
-    MenuOptionsButtonTracingRecordingtTooltip = 518,
-    MenuOptionsButtonDropLocationFeetWhenFacingBlocked = 519,
-    MenuOptionsDescription = 520,
-    MenuOptionsHeadingAudio = 521,
-    MenuOptionsHeadingDeveloper = 522,
-    MenuOptionsHeadingGameplayOptions = 523,
-    MenuOptionsHeadingGameplayOptionsDescription = 524,
-    MenuOptionsHeadingOtherOptions = 525,
-    MenuOptionsHeadingControls = 526,
-    MenuOptionsHeadingLanguage = 527,
-    MenuOptionsHeadingPowerPreference = 528,
-    MenuOptionsHeadingModOptions = 529,
-    MenuOptionsHeadingOther = 530,
-    MenuOptionsHeadingSaveData = 531,
-    MenuOptionsHeadingTooltipsTile = 532,
-    MenuOptionsHeadingVideo = 533,
-    MenuOptionsLabelInterfaceScale = 534,
-    MenuOptionsLabelTooltipDelay = 535,
-    MenuOptionsLabelDirectionTurnDelay = 536,
-    MenuOptionsLabelMouseTurnDelay = 537,
-    MenuOptionsTooltipTurnDelay = 538,
-    MenuOptionsTooltipMouseTurnDelay = 539,
-    MenuOptionsTooltipUiScaleClamped = 540,
-    MenuOptionsTooltipControlsFilter = 541,
-    MenuOptionsLabelVolumeEffects = 542,
-    MenuOptionsLabelVolumeMusic = 543,
-    MenuOptionsTabAudio = 544,
-    MenuOptionsTabDeveloper = 545,
-    MenuOptionsTabGameplay = 546,
-    MenuOptionsTabTooltips = 547,
-    MenuOptionsTabOther = 548,
-    MenuOptionsTabLanguage = 549,
-    MenuOptionsTabControls = 550,
-    MenuOptionsTabMods = 551,
-    MenuOptionsTabSaveData = 552,
-    MenuOptionsTabVideo = 553,
-    MenuOptionsTabPerformance = 554,
-    MenuOptionsHeadingPerformance = 555,
-    MenuOptionsTitle = 556,
-    MenuOptionsTooltipMusicNextTrack = 557,
-    MenuOptionsBindChoose = 558,
-    MenuOptionsBindChooseAdd = 559,
-    MenuOptionsBindLabelModifier = 560,
-    MenuOptionsBindButtonResetTooltip = 561,
-    MenuOptionsBindButtonDeleteTooltip = 562,
-    MenuOptionsBindButtonAddTooltip = 563,
-    MenuOptionsBindButtonAddMacroTooltip = 564,
-    MenuOptionsButtonUnlockAllMilestones = 565,
-    MenuOptionsButtonUnlockAllCraftingRecipes = 566,
-    MenuOptionsButtonAlternatingDirectionMovement = 567,
-    MenuOptionsButtonAllowAlternatingDirectionMovementTooltip = 568,
-    MenuOptionsButtonAlwaysShowMoreInformation = 569,
-    MenuOptionsButtonAlwaysShowMoreInformationTooltip = 570,
-    MenuOptionsButtonAutoGatherHarvest = 571,
-    MenuOptionsButtonAutoGatherHarvestTooltip = 572,
-    MenuOptionsButtonDisableUIEffects = 573,
-    MenuOptionsButtonDisableUIEffectsTooltip = 574,
-    MenuOptionsButtonDisableUIOpacity = 575,
-    MenuOptionsButtonDisableUIOpacityTooltip = 576,
-    MenuOptionsButtonAutoAttack = 577,
-    MenuOptionsButtonAutoAttackTooltip = 578,
-    MenuOptionsButtonAutoPickup = 579,
-    MenuOptionsButtonAutoPickupTooltip = 580,
-    MenuOptionsButtonAutoPickupOnIdle = 581,
-    MenuOptionsButtonAutoPickupOnIdleTooltip = 582,
-    MenuOptionsButtonDropOnDismantle = 583,
-    MenuOptionsButtonDropOnDismantleTooltip = 584,
-    MenuOptionsButtonDisableCraftingProtectedItems = 585,
-    MenuOptionsButtonDisableCraftingProtectedItemsTooltip = 586,
-    MenuOptionsButtonDropOnGatherHarvest = 587,
-    MenuOptionsButtonDropOnGatherHarvestTooltip = 588,
-    MenuOptionsButtonKeepSortActive = 589,
-    MenuOptionsButtonKeepSortActiveTooltip = 590,
-    MenuOptionsButtonUseAdjacentContainers = 591,
-    MenuOptionsButtonUseAdjacentContainersTooltip = 592,
-    MenuOptionsButtonHideEquippedHeadgear = 593,
-    MenuOptionsButtonHideEquippedHeadgearTooltip = 594,
-    MenuOptionsButtonAutoSave = 595,
-    MenuOptionsButtonAutoSaveTooltip = 596,
-    MenuOptionsRangeAutoSaveTimerLabel = 597,
-    MenuOptionsRangeAutoSaveTimerTurnsDisplay = 598,
-    MenuOptionsRangeAutoSaveTimerTimeDisplay = 599,
-    MenuOptionsButtonWarnOnDangerousActions = 600,
-    MenuOptionsButtonWarnOnDangerousActionsTooltip = 601,
-    MenuOptionsButtonWarnWhenBreakingItemsOnCraft = 602,
-    MenuOptionsButtonWarnWhenBreakingItemsOnCraftTooltip = 603,
-    MenuOptionsButtonWarnWhenBreakingItemsOnUse = 604,
-    MenuOptionsButtonWarnWhenBreakingItemsOnUseTooltip = 605,
-    MenuOptionsHeadingWarnWhenBreakingItems = 606,
-    MenuOptionsButtonSaveDataClearBindings = 607,
-    MenuOptionsTooltipDialogOpacity = 608,
-    MenuOptionsLabelDialogOpacity = 609,
-    MenuOptionsDeveloperLogSourceFilterHeading = 610,
-    MenuOptionsDeveloperUIExperiments = 611,
-    MenuOptionsDeveloperUIExperimentsDescription = 612,
-    MenuOptionsAudioVolumeDisplay = 613,
-    MenuOptionsAudioInputSoundOnTyping = 614,
-    MenuOptionsMusicPlaylist = 615,
-    MenuOptionsButtonConfigureBindings = 616,
-    MenuOptionsButtonSaveCompression = 617,
-    MenuOptionsButtonSaveCompressionTooltip = 618,
-    MenuPauseButtonContinueGame = 619,
-    MenuPauseButtonReturnToGame = 620,
-    MenuPauseButtonOptions = 621,
-    MenuPauseButtonModes = 622,
-    MenuPauseButtonPaused = 623,
-    MenuPauseButtonMultiplayer = 624,
-    MenuPauseButtonTitleScreen = 625,
-    MenuPauseButtonStopServer = 626,
-    MenuPauseHeadingDedicatedServer = 627,
-    MenuPauseTooltipNotPaused = 628,
-    MenuPauseParagraphDedicatedServer = 629,
-    MenuPauseLabelPaused = 630,
-    MenuPauseLabelNotPaused = 631,
-    MenuModesTitle = 632,
-    MenuModesDescription = 633,
-    MenuMultiplayerOptionsTitle = 634,
-    MenuMultiplayerOptionsDescription = 635,
-    MenuMultiplayerOptionsOpenServer = 636,
-    MenuMultiplayerOptionsOpenServerDescription = 637,
-    MenuMultiplayerOptionsCopyGameCode = 638,
-    MenuMultiplayerOptionsCopyGameCodeTooltip = 639,
-    MenuMultiplayerOptionsInviteSteamFriends = 640,
-    MenuMultiplayerOptionsCheckConnectionHeading = 641,
-    MenuMultiplayerOptionsCheckConnectionParagraph = 642,
-    MenuMultiplayerOptionsCheckConnectionButton = 643,
-    MenuMultiplayerOptionsCheckConnectionResultUnknown = 644,
-    MenuMultiplayerOptionsCheckConnectionResultChecking = 645,
-    MenuMultiplayerOptionsCheckConnectionResultSteamRelayNetwork = 646,
-    MenuMultiplayerOptionsCheckConnectionResultSteamRelayNetworkFail = 647,
-    MenuMultiplayerOptionsCheckConnectionResultSteamRelayNetworkUnavailable = 648,
-    MenuMultiplayerOptionsCheckConnectionResultWebRTC = 649,
-    MenuMultiplayerOptionsCheckConnectionResultWebRTCFail = 650,
-    MenuMultiplayerOptionsCheckConnectionResultWebSocket = 651,
-    MenuMultiplayerOptionsCheckConnectionResultWebSocketFail = 652,
-    MenuMultiplayerOptionsCheckConnectionResultWebSocketUnavailable = 653,
-    MenuMultiplayerOptionsCheckConnectionResultSuccess = 654,
-    MenuJoinServerTitle = 655,
-    MenuJoinServerDescription = 656,
-    MenuJoinServerInputPlaceholder = 657,
-    MenuJoinServerNext = 658,
-    MenuJoinServerChooseModifiersTitle = 659,
-    MenuJoinServerChooseModifiersDescription = 660,
-    MenuSharedMultiplayerChoiceLobbyTypeFriends = 661,
-    MenuSharedMultiplayerChoiceLobbyTypeFriendsDescription = 662,
-    MenuSharedMultiplayerChoiceLobbyTypePublic = 663,
-    MenuSharedMultiplayerChoiceLobbyTypePublicDescription = 664,
-    MenuSharedMultiplayerChoiceLobbyTypePrivate = 665,
-    MenuSharedMultiplayerChoiceLobbyTypePrivateDescription = 666,
-    MenuSharedMultiplayerChoicePVP = 667,
-    MenuSharedMultiplayerChoicePVPDescription = 668,
-    MenuSharedMultiplayerChoiceAllowHardcoreRespawns = 669,
-    MenuSharedMultiplayerChoiceAllowHardcoreRespawnsDescription = 670,
-    MenuSharedMultiplayerDescription = 671,
-    MenuSharedMultiplayerMessageOfTheDay = 672,
-    MenuSharedMultiplayerMaxPlayers = 673,
-    MenuSharedRealTimeTickSpeedTooltip = 674,
-    MenuSharedRealTimeTickSpeedLabel = 675,
-    MenuSharedButtonDefault = 676,
-    MenuSharedValueMillseconds = 677,
-    MenuSharedValuePercentage = 678,
-    MenuSharedMilestonesNotUnlockable = 679,
-    MenuSharedMilestonesNotUnlockableDescription = 680,
-    MenuSharedMilestonesNotUnlockableButtonShowMods = 681,
-    MenuSharedButtonDisableAll = 682,
-    MenuSharedButtonEnableAll = 683,
-    MenuSharedMilestoneModifiersSelected = 684,
-    MiscSortBy = 685,
-    MiscSortDirection = 686,
-    MiscFilter = 687,
-    MiscPlayerNameDefault = 688,
-    MiscPlayerNameServer = 689,
-    MiscSaveNameDefault = 690,
-    MiscSaveNameDailyChallenge = 691,
-    MiscSaveNameChallenge = 692,
-    MiscSaveVersionUnknown = 693,
-    MiscVersion = 694,
-    MiscTime = 695,
-    MiscTimeMeridiem = 696,
-    MiscError = 697,
-    MiscContextMenuCopyTooltip = 698,
-    MiscBindableOr = 699,
-    MiscBindableNoBindings = 700,
-    DifficultyOptionsPeaceful = 701,
-    DifficultyOptionsAberrantSpawnsDisabled = 702,
-    DifficultyOptionsAberrantSpawnsOnly = 703,
-    DifficultyOptionsCreatureSpawningDisabled = 704,
-    DifficultyOptionsCreatureSpawnsDefault = 705,
-    DifficultyOptionsCreatureSpawnsAberrantOnly = 706,
-    DifficultyOptionsCreatureSpawnsNoAberrants = 707,
-    DifficultyOptionsSpawnLimit = 708,
-    DifficultyOptionsRespawn = 709,
-    DifficultyOptionsEternalNight = 710,
-    DifficultyOptionsEternalDay = 711,
-    DifficultyOptionsTimeInitial = 712,
-    DifficultyOptionsTimeFrozen = 713,
-    DifficultyOptionsTimeDayLength = 714,
-    DifficultyOptionsTimeDayPercent = 715,
-    DifficultyOptionsNoItems = 716,
-    DifficultyOptionsBenignityInitial = 717,
-    DifficultyOptionsBenignityMultiplier = 718,
-    DifficultyOptionsMalignityInitial = 719,
-    DifficultyOptionsMalignityMultiplier = 720,
-    DifficultyOptionsWeightBonus = 721,
-    DifficultyOptionsStatInitial = 722,
-    DifficultyOptionsStatMax = 723,
-    DifficultyOptionsStatMultiplier = 724,
-    DifficultyOptionsStatusEffectStartWith = 725,
-    DifficultyOptionsStatusEffectUntreatable = 726,
-    DifficultyOptionsStatusEffectPassChanceMultiplier = 727,
-    DifficultyOptionsNoRandomSkills = 728,
-    DifficultyOptionsSkillStartingCount = 729,
-    DifficultyOptionsSkillGainMultiplier = 730,
-    DifficultyOptionsSkillInitial = 731,
-    DifficultyOptionsStatusEffectPermanent = 732,
-    DifficultyOptionsStatusEffectRateMultiplier = 733,
-    DifficultyOptionsStatusEffectMultiplier = 734,
-    EquipmentBack = 735,
-    EquipmentBelt = 736,
-    EquipmentChest = 737,
-    EquipmentFeet = 738,
-    EquipmentHands = 739,
-    EquipmentHead = 740,
-    EquipmentLeftHand = 741,
-    EquipmentLeftHandOption = 742,
-    EquipmentLegs = 743,
-    EquipmentNeck = 744,
-    EquipmentRightHand = 745,
-    EquipmentRightHandOption = 746,
-    EquipmentUse = 747,
-    HudFilter = 748,
-    QuickSlot1 = 749,
-    QuickSlot10 = 750,
-    QuickSlot11 = 751,
-    QuickSlot12 = 752,
-    QuickSlot2 = 753,
-    QuickSlot3 = 754,
-    QuickSlot4 = 755,
-    QuickSlot5 = 756,
-    QuickSlot6 = 757,
-    QuickSlot7 = 758,
-    QuickSlot8 = 759,
-    QuickSlot9 = 760,
-    TabCrafting = 761,
-    TabDismantle = 762,
-    Version = 763,
-    WindowTitleContainer = 764,
-    WindowTitleCrafting = 765,
-    WindowTitleEquipment = 766,
-    WindowTitleInventory = 767
+    MenuOptionsButtonHealthVignette = 485,
+    MenuOptionsButtonHealthVignetteTooltip = 486,
+    MenuOptionsButtonDisableCustomCursor = 487,
+    MenuOptionsButtonDisplayArticleInObjectNames = 488,
+    MenuOptionsButtonDisplayArticleInObjectNamesTooltip = 489,
+    MenuOptionsButtonFullscreen = 490,
+    MenuOptionsButtonDeveloperMode = 491,
+    MenuOptionsButtonDeveloperModeContextMenu = 492,
+    MenuOptionsButtonPixelFont = 493,
+    MenuOptionsButtonReloadGame = 494,
+    MenuOptionsButtonReloadStylesheets = 495,
+    MenuOptionsButtonResetGeneratedSpriteCache = 496,
+    MenuOptionsButtonExportGlobalSaveData = 497,
+    MenuOptionsButtonImportGlobalSaveData = 498,
+    MenuOptionsButtonSaveDataBackups = 499,
+    MenuOptionsButtonSaveDataBackupsTooltip = 500,
+    MenuOptionsButtonSaveDataClearAll = 501,
+    MenuOptionsButtonSaveDataClearCharacters = 502,
+    MenuOptionsButtonSaveDataClearHighscores = 503,
+    MenuOptionsButtonSaveDataClearMilestones = 504,
+    MenuOptionsButtonSaveDataClearOptions = 505,
+    MenuOptionsButtonSaveDataClearCraftingRecipes = 506,
+    MenuOptionsButtonSaveDataClearSaves = 507,
+    MenuOptionsButtonSkipSplash = 508,
+    MenuOptionsButtonToggleDevTools = 509,
+    MenuOptionsButtonTooltipsCreatures = 510,
+    MenuOptionsButtonOpenBackupsFolder = 511,
+    MenuOptionsButtonOpenLogsFolder = 512,
+    MenuOptionsButtonTooltipsDoodads = 513,
+    MenuOptionsButtonTooltipsItems = 514,
+    MenuOptionsButtonTooltipsTerrain = 515,
+    MenuOptionsButtonDropLocationFacing = 516,
+    MenuOptionsButtonDropLocationFeet = 517,
+    MenuOptionsButtonStartTraceRecording = 518,
+    MenuOptionsButtonStopTraceRecording = 519,
+    MenuOptionsButtonTracingRecordingtTooltip = 520,
+    MenuOptionsButtonDropLocationFeetWhenFacingBlocked = 521,
+    MenuOptionsDescription = 522,
+    MenuOptionsHeadingAudio = 523,
+    MenuOptionsHeadingDeveloper = 524,
+    MenuOptionsHeadingGameplayOptions = 525,
+    MenuOptionsHeadingGameplayOptionsDescription = 526,
+    MenuOptionsHeadingOtherOptions = 527,
+    MenuOptionsHeadingControls = 528,
+    MenuOptionsHeadingLanguage = 529,
+    MenuOptionsHeadingPowerPreference = 530,
+    MenuOptionsHeadingModOptions = 531,
+    MenuOptionsHeadingOther = 532,
+    MenuOptionsHeadingSaveData = 533,
+    MenuOptionsHeadingTooltipsTile = 534,
+    MenuOptionsHeadingVideo = 535,
+    MenuOptionsLabelInterfaceScale = 536,
+    MenuOptionsLabelTooltipDelay = 537,
+    MenuOptionsLabelDirectionTurnDelay = 538,
+    MenuOptionsLabelMouseTurnDelay = 539,
+    MenuOptionsTooltipTurnDelay = 540,
+    MenuOptionsTooltipMouseTurnDelay = 541,
+    MenuOptionsTooltipUiScaleClamped = 542,
+    MenuOptionsTooltipControlsFilter = 543,
+    MenuOptionsLabelVolumeEffects = 544,
+    MenuOptionsLabelVolumeMusic = 545,
+    MenuOptionsTabAudio = 546,
+    MenuOptionsTabDeveloper = 547,
+    MenuOptionsTabGameplay = 548,
+    MenuOptionsTabTooltips = 549,
+    MenuOptionsTabOther = 550,
+    MenuOptionsTabLanguage = 551,
+    MenuOptionsTabControls = 552,
+    MenuOptionsTabMods = 553,
+    MenuOptionsTabSaveData = 554,
+    MenuOptionsTabVideo = 555,
+    MenuOptionsTabPerformance = 556,
+    MenuOptionsHeadingPerformance = 557,
+    MenuOptionsTitle = 558,
+    MenuOptionsTooltipMusicNextTrack = 559,
+    MenuOptionsBindChoose = 560,
+    MenuOptionsBindChooseAdd = 561,
+    MenuOptionsBindLabelModifier = 562,
+    MenuOptionsBindButtonResetTooltip = 563,
+    MenuOptionsBindButtonDeleteTooltip = 564,
+    MenuOptionsBindButtonAddTooltip = 565,
+    MenuOptionsBindButtonAddMacroTooltip = 566,
+    MenuOptionsButtonUnlockAllMilestones = 567,
+    MenuOptionsButtonUnlockAllCraftingRecipes = 568,
+    MenuOptionsButtonAlternatingDirectionMovement = 569,
+    MenuOptionsButtonAllowAlternatingDirectionMovementTooltip = 570,
+    MenuOptionsButtonAlwaysShowMoreInformation = 571,
+    MenuOptionsButtonAlwaysShowMoreInformationTooltip = 572,
+    MenuOptionsButtonAutoGatherHarvest = 573,
+    MenuOptionsButtonAutoGatherHarvestTooltip = 574,
+    MenuOptionsButtonDisableUIEffects = 575,
+    MenuOptionsButtonDisableUIEffectsTooltip = 576,
+    MenuOptionsButtonDisableUIOpacity = 577,
+    MenuOptionsButtonDisableUIOpacityTooltip = 578,
+    MenuOptionsButtonAutoAttack = 579,
+    MenuOptionsButtonAutoAttackTooltip = 580,
+    MenuOptionsButtonAutoPickup = 581,
+    MenuOptionsButtonAutoPickupTooltip = 582,
+    MenuOptionsButtonAutoPickupOnIdle = 583,
+    MenuOptionsButtonAutoPickupOnIdleTooltip = 584,
+    MenuOptionsButtonDropOnDismantle = 585,
+    MenuOptionsButtonDropOnDismantleTooltip = 586,
+    MenuOptionsButtonDisableCraftingProtectedItems = 587,
+    MenuOptionsButtonDisableCraftingProtectedItemsTooltip = 588,
+    MenuOptionsButtonDropOnGatherHarvest = 589,
+    MenuOptionsButtonDropOnGatherHarvestTooltip = 590,
+    MenuOptionsButtonKeepSortActive = 591,
+    MenuOptionsButtonKeepSortActiveTooltip = 592,
+    MenuOptionsButtonUseAdjacentContainers = 593,
+    MenuOptionsButtonUseAdjacentContainersTooltip = 594,
+    MenuOptionsButtonHideEquippedHeadgear = 595,
+    MenuOptionsButtonHideEquippedHeadgearTooltip = 596,
+    MenuOptionsButtonAutoSave = 597,
+    MenuOptionsButtonAutoSaveTooltip = 598,
+    MenuOptionsRangeAutoSaveTimerLabel = 599,
+    MenuOptionsRangeAutoSaveTimerTurnsDisplay = 600,
+    MenuOptionsRangeAutoSaveTimerTimeDisplay = 601,
+    MenuOptionsButtonWarnOnDangerousActions = 602,
+    MenuOptionsButtonWarnOnDangerousActionsTooltip = 603,
+    MenuOptionsButtonWarnWhenBreakingItemsOnCraft = 604,
+    MenuOptionsButtonWarnWhenBreakingItemsOnCraftTooltip = 605,
+    MenuOptionsButtonWarnWhenBreakingItemsOnUse = 606,
+    MenuOptionsButtonWarnWhenBreakingItemsOnUseTooltip = 607,
+    MenuOptionsHeadingWarnWhenBreakingItems = 608,
+    MenuOptionsButtonSaveDataClearBindings = 609,
+    MenuOptionsTooltipDialogOpacity = 610,
+    MenuOptionsLabelDialogOpacity = 611,
+    MenuOptionsDeveloperLogSourceFilterHeading = 612,
+    MenuOptionsDeveloperUIExperiments = 613,
+    MenuOptionsDeveloperUIExperimentsDescription = 614,
+    MenuOptionsAudioVolumeDisplay = 615,
+    MenuOptionsAudioInputSoundOnTyping = 616,
+    MenuOptionsMusicPlaylist = 617,
+    MenuOptionsButtonConfigureBindings = 618,
+    MenuOptionsButtonSaveCompression = 619,
+    MenuOptionsButtonSaveCompressionTooltip = 620,
+    MenuPauseButtonContinueGame = 621,
+    MenuPauseButtonReturnToGame = 622,
+    MenuPauseButtonOptions = 623,
+    MenuPauseButtonModes = 624,
+    MenuPauseButtonPaused = 625,
+    MenuPauseButtonMultiplayer = 626,
+    MenuPauseButtonTitleScreen = 627,
+    MenuPauseButtonStopServer = 628,
+    MenuPauseHeadingDedicatedServer = 629,
+    MenuPauseTooltipNotPaused = 630,
+    MenuPauseParagraphDedicatedServer = 631,
+    MenuPauseLabelPaused = 632,
+    MenuPauseLabelNotPaused = 633,
+    MenuModesTitle = 634,
+    MenuModesDescription = 635,
+    MenuMultiplayerOptionsTitle = 636,
+    MenuMultiplayerOptionsDescription = 637,
+    MenuMultiplayerOptionsOpenServer = 638,
+    MenuMultiplayerOptionsOpenServerDescription = 639,
+    MenuMultiplayerOptionsCopyGameCode = 640,
+    MenuMultiplayerOptionsCopyGameCodeTooltip = 641,
+    MenuMultiplayerOptionsInviteSteamFriends = 642,
+    MenuMultiplayerOptionsCheckConnectionHeading = 643,
+    MenuMultiplayerOptionsCheckConnectionParagraph = 644,
+    MenuMultiplayerOptionsCheckConnectionButton = 645,
+    MenuMultiplayerOptionsCheckConnectionResultUnknown = 646,
+    MenuMultiplayerOptionsCheckConnectionResultChecking = 647,
+    MenuMultiplayerOptionsCheckConnectionResultSteamRelayNetwork = 648,
+    MenuMultiplayerOptionsCheckConnectionResultSteamRelayNetworkFail = 649,
+    MenuMultiplayerOptionsCheckConnectionResultSteamRelayNetworkUnavailable = 650,
+    MenuMultiplayerOptionsCheckConnectionResultWebRTC = 651,
+    MenuMultiplayerOptionsCheckConnectionResultWebRTCFail = 652,
+    MenuMultiplayerOptionsCheckConnectionResultWebSocket = 653,
+    MenuMultiplayerOptionsCheckConnectionResultWebSocketFail = 654,
+    MenuMultiplayerOptionsCheckConnectionResultWebSocketUnavailable = 655,
+    MenuMultiplayerOptionsCheckConnectionResultSuccess = 656,
+    MenuJoinServerTitle = 657,
+    MenuJoinServerDescription = 658,
+    MenuJoinServerInputPlaceholder = 659,
+    MenuJoinServerNext = 660,
+    MenuJoinServerChooseModifiersTitle = 661,
+    MenuJoinServerChooseModifiersDescription = 662,
+    MenuSharedMultiplayerChoiceLobbyTypeFriends = 663,
+    MenuSharedMultiplayerChoiceLobbyTypeFriendsDescription = 664,
+    MenuSharedMultiplayerChoiceLobbyTypePublic = 665,
+    MenuSharedMultiplayerChoiceLobbyTypePublicDescription = 666,
+    MenuSharedMultiplayerChoiceLobbyTypePrivate = 667,
+    MenuSharedMultiplayerChoiceLobbyTypePrivateDescription = 668,
+    MenuSharedMultiplayerChoicePVP = 669,
+    MenuSharedMultiplayerChoicePVPDescription = 670,
+    MenuSharedMultiplayerChoiceAllowHardcoreRespawns = 671,
+    MenuSharedMultiplayerChoiceAllowHardcoreRespawnsDescription = 672,
+    MenuSharedMultiplayerDescription = 673,
+    MenuSharedMultiplayerMessageOfTheDay = 674,
+    MenuSharedMultiplayerMaxPlayers = 675,
+    MenuSharedRealTimeTickSpeedTooltip = 676,
+    MenuSharedRealTimeTickSpeedLabel = 677,
+    MenuSharedButtonDefault = 678,
+    MenuSharedValueMillseconds = 679,
+    MenuSharedValuePercentage = 680,
+    MenuSharedMilestonesNotUnlockable = 681,
+    MenuSharedMilestonesNotUnlockableDescription = 682,
+    MenuSharedMilestonesNotUnlockableButtonShowMods = 683,
+    MenuSharedButtonDisableAll = 684,
+    MenuSharedButtonEnableAll = 685,
+    MenuSharedMilestoneModifiersSelected = 686,
+    MiscSortBy = 687,
+    MiscSortDirection = 688,
+    MiscFilter = 689,
+    MiscPlayerNameDefault = 690,
+    MiscPlayerNameServer = 691,
+    MiscSaveNameDefault = 692,
+    MiscSaveNameDailyChallenge = 693,
+    MiscSaveNameChallenge = 694,
+    MiscSaveVersionUnknown = 695,
+    MiscVersion = 696,
+    MiscTime = 697,
+    MiscTimeMeridiem = 698,
+    MiscError = 699,
+    MiscContextMenuCopyTooltip = 700,
+    MiscBindableOr = 701,
+    MiscBindableNoBindings = 702,
+    DifficultyOptionsPeaceful = 703,
+    DifficultyOptionsAberrantSpawnsDisabled = 704,
+    DifficultyOptionsAberrantSpawnsOnly = 705,
+    DifficultyOptionsCreatureSpawningDisabled = 706,
+    DifficultyOptionsCreatureSpawnsDefault = 707,
+    DifficultyOptionsCreatureSpawnsAberrantOnly = 708,
+    DifficultyOptionsCreatureSpawnsNoAberrants = 709,
+    DifficultyOptionsSpawnLimit = 710,
+    DifficultyOptionsRespawn = 711,
+    DifficultyOptionsEternalNight = 712,
+    DifficultyOptionsEternalDay = 713,
+    DifficultyOptionsTimeInitial = 714,
+    DifficultyOptionsTimeFrozen = 715,
+    DifficultyOptionsTimeDayLength = 716,
+    DifficultyOptionsTimeDayPercent = 717,
+    DifficultyOptionsNoItems = 718,
+    DifficultyOptionsBenignityInitial = 719,
+    DifficultyOptionsBenignityMultiplier = 720,
+    DifficultyOptionsMalignityInitial = 721,
+    DifficultyOptionsMalignityMultiplier = 722,
+    DifficultyOptionsWeightBonus = 723,
+    DifficultyOptionsStatInitial = 724,
+    DifficultyOptionsStatMax = 725,
+    DifficultyOptionsStatMultiplier = 726,
+    DifficultyOptionsStatusEffectStartWith = 727,
+    DifficultyOptionsStatusEffectUntreatable = 728,
+    DifficultyOptionsStatusEffectPassChanceMultiplier = 729,
+    DifficultyOptionsNoRandomSkills = 730,
+    DifficultyOptionsSkillStartingCount = 731,
+    DifficultyOptionsSkillGainMultiplier = 732,
+    DifficultyOptionsSkillInitial = 733,
+    DifficultyOptionsStatusEffectPermanent = 734,
+    DifficultyOptionsStatusEffectRateMultiplier = 735,
+    DifficultyOptionsStatusEffectMultiplier = 736,
+    EquipmentBack = 737,
+    EquipmentBelt = 738,
+    EquipmentChest = 739,
+    EquipmentFeet = 740,
+    EquipmentHands = 741,
+    EquipmentHead = 742,
+    EquipmentLeftHand = 743,
+    EquipmentLeftHandOption = 744,
+    EquipmentLegs = 745,
+    EquipmentNeck = 746,
+    EquipmentRightHand = 747,
+    EquipmentRightHandOption = 748,
+    EquipmentUse = 749,
+    HudFilter = 750,
+    QuickSlot1 = 751,
+    QuickSlot10 = 752,
+    QuickSlot11 = 753,
+    QuickSlot12 = 754,
+    QuickSlot2 = 755,
+    QuickSlot3 = 756,
+    QuickSlot4 = 757,
+    QuickSlot5 = 758,
+    QuickSlot6 = 759,
+    QuickSlot7 = 760,
+    QuickSlot8 = 761,
+    QuickSlot9 = 762,
+    TabCrafting = 763,
+    TabDismantle = 764,
+    Version = 765,
+    WindowTitleContainer = 766,
+    WindowTitleCrafting = 767,
+    WindowTitleEquipment = 768,
+    WindowTitleInventory = 769
 }
 export default UiTranslation;

package/definitions/game/multiplayer/IMultiplayer.d.ts

@@ -105,6 +105,8 @@ export declare enum MultiplayerSyncCheck {
 export declare const maxPlayers = 32;
 export declare const packetTickRate = 16;
 export declare const defaultServerPort = 38740;
+export declare const defaultSshServerPort = 38742;
+export declare const defaultSshServerUsername = "wayward";
 export declare const steamLobbyPrefix = "steam:";
 export declare const checkConnectionMatchmakingId = "check";
 export declare const defaultSyncChecks: MultiplayerSyncCheck[];

package/definitions/game/multiplayer/dedicatedServer/ssh/ISsh.d.ts

@@ -8,6 +8,7 @@
  * Wayward is a copyrighted and licensed work. Modification and/or distribution of any source files is prohibited. If you wish to modify the game in any way, please refer to the modding guide:
  * https://github.com/WaywardGame/types/wiki
  */
+import type * as ssh2 from "ssh2";
 import type Log from "utilities/Log";
 export declare const globalHistory: Map<string, string[]>;
 export declare const maxHistory = 50;
@@ -20,7 +21,7 @@ export interface ISshStream {
         toString(): string;
     }) => void): void;
 }
-export interface ISshSession {
+export interface ISshSession extends ssh2.Session {
     clientId: string;
     clientLog: Log;
 }

package/definitions/game/multiplayer/dedicatedServer/ssh/SshServer.d.ts

@@ -8,9 +8,10 @@
  * Wayward is a copyrighted and licensed work. Modification and/or distribution of any source files is prohibited. If you wish to modify the game in any way, please refer to the modding guide:
  * https://github.com/WaywardGame/types/wiki
  */
+import type * as ssh2 from "ssh2";
 import type { IFileSystem } from "@hosts/shared/ipc/fileSystem";
 export interface ISshServerOptions {
-    ssh2: any;
+    ssh2: typeof ssh2;
     crypto: any;
     fs: IFileSystem;
     serverName: string;

package/definitions/game/save/data/ISaveDataGlobal.d.ts

@@ -33,6 +33,8 @@ export interface IOptions {
     developerModeContextMenu: boolean;
     dialogOpacity: number;
     directionTurnDelay: number;
+    disableCraftingProtectedItems: boolean;
+    disableHealthVignette: boolean;
     disableUIEffects: boolean;
     disableUIOpacity: boolean;
     dropLocation: DropLocation;
@@ -51,7 +53,6 @@ export interface IOptions {
     muteMusic: boolean;
     playInputSoundWhenTyping: boolean;
     powerPreference: PowerMode;
-    disableCraftingProtectedItems: boolean;
     realTimeTickSpeed: number;
     rightClickInspect: boolean;
     rightHand: boolean;

package/definitions/game/steamworks/ISteamworks.d.ts

@@ -35,8 +35,8 @@ export interface IDedicatedServerInfo {
         dailyChallenge?: boolean;
     };
     ssh: boolean;
-    sshPort?: number;
-    sshUsername?: string;
+    sshPort: number;
+    sshUsername: string;
     sshPassword?: string;
     devMode: boolean;
     syncChecks: MultiplayerSyncCheckLevel;

package/definitions/game/ui/Ui.d.ts

@@ -33,6 +33,7 @@ export interface IUiEvents {
     interruptClose(options: Partial<InterruptOptions>, result?: string | boolean | InterruptChoice): any;
     loadedFromSave(): any;
     toggleShowMoreInformation(showingMoreInformation: boolean): any;
+    toggleHealthVignette(healthVignette: boolean): any;
     toggleDeveloperMode(developerMode: boolean): any;
 }
 export declare class Ui extends EventEmitter.Host<IUiEvents> {
@@ -63,6 +64,10 @@ export declare class Ui extends EventEmitter.Host<IUiEvents> {
     playSound(sound: SfxType | "activate" | "select" | "input" | "enable" | "disable"): void;
     shouldShowMoreInformation(): boolean;
     toggleShowMoreInformation(showMoreInformation: boolean): void;
+    /**
+     * Toggle health vignette
+     */
+    toggleHealthVignette(healthVignette: boolean): void;
     /**
      * Toggles fullscreen
      */

package/definitions/game/ui/input/Bind.d.ts

@@ -65,7 +65,7 @@ declare enum BindingEvent {
     holding = 2
 }
 declare type BindingEventName = keyof typeof BindingEvent;
-export { BindingEventName as BindingEvent };
+export type { BindingEventName as BindingEvent };
 declare module Bind {
     /**
      * Registers a handler for when the given `Bindable` is pressed. This event won't be fired again until the `Bindable` was then *released*.

package/definitions/game/ui/old/screens/InGameScreen.d.ts

@@ -79,7 +79,6 @@ export default class InGameScreen extends BaseScreen {
     actionsMenuCentered: boolean;
     private activeContainer;
     private multipleContainersOpened;
-    private contextMenuBindPressed;
     private sortableElement;
     private sortableElementPosition;
     private sortableElementTargetContainer;
@@ -237,7 +236,6 @@ export default class InGameScreen extends BaseScreen {
     onItemEquipToggle(api: IBindHandlerApi): boolean;
     onItemProtectToggle(api: IBindHandlerApi): boolean;
     onContextMenu(api: IBindHandlerApi): boolean;
-    onContextMenuReleased(_api: IBindHandlerApi): void;
     onQuickSlotToggle(api: IBindHandlerApi): boolean;
     onQuickSlot(api: IBindHandlerApi): boolean;
     onQuickSlotClear(api: IBindHandlerApi): boolean;

package/definitions/game/ui/screen/screens/GameScreen.d.ts

@@ -47,6 +47,7 @@ export default class GameScreen extends Screen {
     private readonly quadrantMap;
     private readonly quadrantComponents;
     private readonly gameCanvas;
+    private readonly effects;
     private readonly placeholders;
     private readonly islandIntroWrapper;
     private readonly buttonRespawn;
@@ -60,6 +61,11 @@ export default class GameScreen extends Screen {
     onLoadedOnIsland(player: Player, island: Island): void;
     private showIslandIntro;
     onGameTickEnd(game: Game, tickFlag: TickFlag): void;
+    onExploreAsGhost(): void;
+    /**
+     * Notee: calculateEquipmentStats is always ran after calculateStats is called, so this will work
+     */
+    onCalculateEquipmentStats(): void;
     /**
      * Refreshed death / ghost state stuff
      */
@@ -72,7 +78,15 @@ export default class GameScreen extends Screen {
      * Refreshes respawn button state
      */
     private refreshRespawnButton;
-    onExploreAsGhost(): void;
+    private refreshHealthBasedEffects;
+    /**
+     * Refreshes the state of the hurt effect
+     */
+    private refreshHurtEffect;
+    /**
+     * Refreshes the state of the music speed
+     */
+    private refreshMusicSpeed;
     onOpenBook(human: Human, item: Item): void;
     protected onReadMap1(map: DrawnMap, item: Item, reader: Human): void;
     protected onSailOffMapEdge(player: Player, direction: Direction): void;
@@ -83,6 +97,7 @@ export default class GameScreen extends Screen {
     protected onScreenshotMode(): boolean;
     protected onShowMoreInfo(): void;
     protected onUnshowMoreInfo(): void;
+    protected onDisableHealthVignette(): void;
     protected onCancel(): boolean;
     protected create(): void;
     protected onHide(): void;

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@wayward/types",
 	"description": "TypeScript declarations for Wayward, used for modding.",
-	"version": "2.11.3-beta.dev.20220123.1",
+	"version": "2.11.3-beta.dev.20220126.1",
 	"license": "MIT",
 	"repository": {
 		"type": "git",