Interface IMessageManager
Methods
addToHistory
- addToHistory(messageHistoryItem: IMessageHistoryItem): void
-
Returns void
clear
- clear(): IMessageManager
-
getMessageHistory
- getMessageHistory(): Stream<IMessage>
-
pruneMessageHistory
- pruneMessageHistory(isLocalPlayer: boolean): boolean
-
Returns boolean
send
- send(message: default | default, ...args: TranslationArg[]): boolean
-
Returns boolean
sendPacked
- sendPacked(pack?: default | Partial<IPackedMessage>, ...extraSources: Source[]): boolean
-
Parameters
-
-
Rest ...extraSources: Source[]
Returns boolean
sentToAll
- sentToAll(sentToAll?: boolean): IMessageManager
-
Parameters
-
Optional sentToAll: boolean
source
- source(noGameSource: true, ...sources: (undefined | false | Source)[]): IMessageManager
-
Parameters
-
noGameSource: true
-
Rest ...sources: (undefined | false | Source)[]
- source(...sources: (undefined | false | Source)[]): IMessageManager
-
Parameters
-
Rest ...sources: (undefined | false | Source)[]
upgrade
- upgrade(id: `Input:${string}` | `Health:${string}` | `Action:${string}` | `Skill:${string}` | `ActionSlotItemMethod:${string}` | `ActionSort:${string}` | `AiType:${string}` | `AutoSave:${string}` | `BadTemperature:${string}` | `Bindable:${string}` | `BindableType:${string}` | `Biome:${string}` | `BleedLevel:${string}` | `Book:${string}` | `Challenge:${string}` | `ChangelogChangeType:${string}` | `CharacterSort:${string}` | `CombatDangerLevel:${string}` | `CombatStrength:${string}` | `Command:${string}` | `ContainerSort:${string}` | `Corpse:${string}` | `CraftEfficacy:${string}` | `CraftingSort:${string}` | `Creature:${string}` | `CurseComponent:${string}` | `DamageType:${string}` | `Deity:${string}` | `DeitySymbol:${string}` | `Dialog:${string}` | `Direction:${string}` | `DisplayLevel:${string}` | `DoctorCure:${string}` | `DoctorMethod:${string}` | `Doodad:${string}` | `DoodadExtra:${string}` | `DoodadGroup:${string}` | `DrawnMapTheme:${string}` | `DurabilityLevel:${string}` | `EquipEffect:${string}` | `EquipSlot:${string}` | `ExhaustionLevel:${string}` | `FireStage:${string}` | `FontStyle:${string}` | `GameEndMessage:${string}` | `GameMode:${string}` | `Growth:${string}` | `GrowthFungus:${string}` | `HealthAccuracy:${string}` | `HelpArticle:${string}` | `HighscoreSort:${string}` | `HumanName:${string}` | `HungerLevel:${string}` | `InspectType:${string}` | `InterruptChoice:${string}` | `IslandModifier:${string}` | `IslandName:${string}` | `IslandNameBiomeDescriptor:${string}` | `IslandNameBiomeNoun:${string}` | `IslandNameModifierDescriptor:${string}` | `IslandNameOverrunWithCreatureDescriptor:${string}` | `Item:${string}` | `ItemAffix:${string}` | `ItemExtra:${string}` | `ItemGroup:${string}` | `JoinServerRetryReason:${string}` | `Label:${string}` | `Level:${string}` | `LighthouseName:${string}` | `Loading:${string}` | `Macro:${string}` | `MagicalPropertyType:${string}` | `MapQuality:${string}` | `MenuBarButton:${string}` | `Message:${string}` | `MessagesDefaultFilter:${string}` | `MessagesTimestampMode:${string}` | `Milestone:${string}` | `MilestoneModifierGroup:${string}` | `MilestoneSort:${string}` | `Misc:${string}` | `ModLoadError:${string}` | `ModLoadFailureReason:${string}` | `ModProvide:${string}` | `ModSort:${string}` | `ModType:${string}` | `MultiplayerCompatibility:${string}` | `MultiplayerDisconnectReason:${string}` | `MusicPlaylist:${string}` | `Note:${string}` | `Npc:${string}` | `Number:${string}` | `PartOfDay:${string}` | `Prompt:${string}` | `QuadrantComponent:${string}` | `QuadrantComponentContextMenuAction:${string}` | `Quality:${string}` | `Quest:${string}` | `QuestRequirement:${string}` | `RecipeLevel:${string}` | `Region:${string}` | `Riddle:${string}` | `RunekeeperDomain:${string}` | `RunekeeperDomainEvent:${string}` | `SaveImportErrorReason:${string}` | `SaveSlotSort:${string}` | `SkillsSort:${string}` | `Source:${string}` | `Stat:${string}` | `Status:${string}` | `StatusEffect:${string}` | `StatusThreatLevel:${string}` | `SteamInputKeyboardPosition:${string}` | `TeamMemberResponsibility:${string}` | `TemperatureType:${string}` | `Term:${string}` | `Terrain:${string}` | `ThirstLevel:${string}` | `TileEvent:${string}` | `TooltipVisibilityOption:${string}` | `Ui:${string}` | `UiQuadrant:${string}` | `UnableToJoinReason:${string}` | `UnlockedRecipesStrategy:${string}` | `UsableActionType:${string}` | `Website:${string}` | `WeightStatus:${string}` | `WorldLayer:${string}`, dictionary: default, entry: number, upgrader?: ITranslationUpgrader): IMessageManager
-
Parameters
-
id: `Input:${string}` | `Health:${string}` | `Action:${string}` | `Skill:${string}` | `ActionSlotItemMethod:${string}` | `ActionSort:${string}` | `AiType:${string}` | `AutoSave:${string}` | `BadTemperature:${string}` | `Bindable:${string}` | `BindableType:${string}` | `Biome:${string}` | `BleedLevel:${string}` | `Book:${string}` | `Challenge:${string}` | `ChangelogChangeType:${string}` | `CharacterSort:${string}` | `CombatDangerLevel:${string}` | `CombatStrength:${string}` | `Command:${string}` | `ContainerSort:${string}` | `Corpse:${string}` | `CraftEfficacy:${string}` | `CraftingSort:${string}` | `Creature:${string}` | `CurseComponent:${string}` | `DamageType:${string}` | `Deity:${string}` | `DeitySymbol:${string}` | `Dialog:${string}` | `Direction:${string}` | `DisplayLevel:${string}` | `DoctorCure:${string}` | `DoctorMethod:${string}` | `Doodad:${string}` | `DoodadExtra:${string}` | `DoodadGroup:${string}` | `DrawnMapTheme:${string}` | `DurabilityLevel:${string}` | `EquipEffect:${string}` | `EquipSlot:${string}` | `ExhaustionLevel:${string}` | `FireStage:${string}` | `FontStyle:${string}` | `GameEndMessage:${string}` | `GameMode:${string}` | `Growth:${string}` | `GrowthFungus:${string}` | `HealthAccuracy:${string}` | `HelpArticle:${string}` | `HighscoreSort:${string}` | `HumanName:${string}` | `HungerLevel:${string}` | `InspectType:${string}` | `InterruptChoice:${string}` | `IslandModifier:${string}` | `IslandName:${string}` | `IslandNameBiomeDescriptor:${string}` | `IslandNameBiomeNoun:${string}` | `IslandNameModifierDescriptor:${string}` | `IslandNameOverrunWithCreatureDescriptor:${string}` | `Item:${string}` | `ItemAffix:${string}` | `ItemExtra:${string}` | `ItemGroup:${string}` | `JoinServerRetryReason:${string}` | `Label:${string}` | `Level:${string}` | `LighthouseName:${string}` | `Loading:${string}` | `Macro:${string}` | `MagicalPropertyType:${string}` | `MapQuality:${string}` | `MenuBarButton:${string}` | `Message:${string}` | `MessagesDefaultFilter:${string}` | `MessagesTimestampMode:${string}` | `Milestone:${string}` | `MilestoneModifierGroup:${string}` | `MilestoneSort:${string}` | `Misc:${string}` | `ModLoadError:${string}` | `ModLoadFailureReason:${string}` | `ModProvide:${string}` | `ModSort:${string}` | `ModType:${string}` | `MultiplayerCompatibility:${string}` | `MultiplayerDisconnectReason:${string}` | `MusicPlaylist:${string}` | `Note:${string}` | `Npc:${string}` | `Number:${string}` | `PartOfDay:${string}` | `Prompt:${string}` | `QuadrantComponent:${string}` | `QuadrantComponentContextMenuAction:${string}` | `Quality:${string}` | `Quest:${string}` | `QuestRequirement:${string}` | `RecipeLevel:${string}` | `Region:${string}` | `Riddle:${string}` | `RunekeeperDomain:${string}` | `RunekeeperDomainEvent:${string}` | `SaveImportErrorReason:${string}` | `SaveSlotSort:${string}` | `SkillsSort:${string}` | `Source:${string}` | `Stat:${string}` | `Status:${string}` | `StatusEffect:${string}` | `StatusThreatLevel:${string}` | `SteamInputKeyboardPosition:${string}` | `TeamMemberResponsibility:${string}` | `TemperatureType:${string}` | `Term:${string}` | `Terrain:${string}` | `ThirstLevel:${string}` | `TileEvent:${string}` | `TooltipVisibilityOption:${string}` | `Ui:${string}` | `UiQuadrant:${string}` | `UnableToJoinReason:${string}` | `UnlockedRecipesStrategy:${string}` | `UsableActionType:${string}` | `Website:${string}` | `WeightStatus:${string}` | `WorldLayer:${string}`
-
-
entry: number
-
Signal that the message was sent to everyone