M&B: Bannerlord 1.2.12
The horns sound, the ravens gather.
Loading...
Searching...
No Matches
TaleWorlds.Library.InformationManager Class Reference

Static Public Member Functions

static void DisplayMessage (InformationMessage message)
 Adds a new message line to the chatlog.
 
static void ClearAllMessages ()
 Clears all lines in the chatlog.
 
static void AddSystemNotification (string message)
 Displays text on the top of the screen, notifying the player. Used for system/backend notifications. Not Used in Singleplayer.
 
static void ShowTooltip (Type type, params object[] args)
 Shows the tooltip that is associated to the given type.
 
static void HideTooltip ()
 Hides currently active tooltips.
 
static void ShowInquiry (InquiryData data, bool pauseGameActiveState=false, bool prioritize=false)
 Shows an inquiry panel with OK-Cancel options depending on Data.
 
static void ShowTextInquiry (TextInquiryData textData, bool pauseGameActiveState=false, bool prioritize=false)
 Shows an inquiry panel with OK-Cancel options and text input area depending on Data.
 
static void HideInquiry ()
 Removes on-screen inquiry if there is one.
 
static void RegisterIsAnyTooltipActiveCallback (Func< bool > callback)
 
static void UnregisterIsAnyTooltipActiveCallback (Func< bool > callback)
 
static void RegisterIsAnyTooltipExtendedCallback (Func< bool > callback)
 
static void UnregisterIsAnyTooltipExtendedCallback (Func< bool > callback)
 
static bool GetIsAnyTooltipActive ()
 Returns true if any tooltip is currently active.
 
static bool GetIsAnyTooltipExtended ()
 Returns true if any tooltip is currently extended.
 
static bool GetIsAnyTooltipActiveAndExtended ()
 Returns true if any tooltip is currently active and extended.
 
static void RegisterTooltip< TRegistered, TTooltip > (Action< TTooltip, object[]> onRefreshData, string movieName)
 Register a given type to a tooltip type. When the given type is used with the ShowTooltip method, an object of the tooltip type will be instantiated and used as a datasource to the movie with the given movieName.
 
static void UnregisterTooltip< TRegistered > ()
 Unregister a previously registered tooltip.
 
static void Clear ()
 Clears event registries of all information events.
 

Static Public Attributes

static Func< bool > IsAnyInquiryActive
 Returns if any inquiry is currently active. The system that implements ShowInquiry events, should also respond to this call.
 

Properties

static IReadOnlyDictionary< Type,(Type tooltipType, object onRefreshData, string movieName)> RegisteredTypes [get]
 

Events

static Action< InformationMessageDisplayMessageInternal
 
static Action ClearAllMessagesInternal
 
static Action< string > OnAddSystemNotification
 
static Action< Type, object[]> OnShowTooltip
 
static Action OnHideTooltip
 
static Action< InquiryData, bool, bool > OnShowInquiry
 
static Action< TextInquiryData, bool, bool > OnShowTextInquiry
 
static Action OnHideInquiry
 

Member Function Documentation

◆ DisplayMessage()

static void TaleWorlds.Library.InformationManager.DisplayMessage ( InformationMessage message)
static
Parameters
messageParameters of the message.

◆ ClearAllMessages()

static void TaleWorlds.Library.InformationManager.ClearAllMessages ( )
static
Parameters
messageParameters of the message.

◆ AddSystemNotification()

static void TaleWorlds.Library.InformationManager.AddSystemNotification ( string message)
static
Parameters
messageMain message/text of the system notification.

◆ ShowTooltip()

static void TaleWorlds.Library.InformationManager.ShowTooltip ( Type type,
params object[] args )
static
Parameters
typeType that is associated with a tooltip.
argsArguments that will be used by the tooltip.

◆ HideTooltip()

static void TaleWorlds.Library.InformationManager.HideTooltip ( )
static

◆ ShowInquiry()

static void TaleWorlds.Library.InformationManager.ShowInquiry ( InquiryData data,
bool pauseGameActiveState = false,
bool prioritize = false )
static
Parameters
dataParameters of the inquiry.
pauseGameActiveStatePauses the game's current active state while the inquiry is active.
prioritizeDetermines if the new query should be shown immediately if another query is active.

◆ ShowTextInquiry()

static void TaleWorlds.Library.InformationManager.ShowTextInquiry ( TextInquiryData textData,
bool pauseGameActiveState = false,
bool prioritize = false )
static
Parameters
textDataParameters of the inquiry.
pauseGameActiveStatePauses the game's current active state while the inquiry is active.
prioritizeDetermines if the new query should be shown immediately if another query is active.

◆ HideInquiry()

static void TaleWorlds.Library.InformationManager.HideInquiry ( )
static

◆ RegisterIsAnyTooltipActiveCallback()

static void TaleWorlds.Library.InformationManager.RegisterIsAnyTooltipActiveCallback ( Func< bool > callback)
static

◆ UnregisterIsAnyTooltipActiveCallback()

static void TaleWorlds.Library.InformationManager.UnregisterIsAnyTooltipActiveCallback ( Func< bool > callback)
static

◆ RegisterIsAnyTooltipExtendedCallback()

static void TaleWorlds.Library.InformationManager.RegisterIsAnyTooltipExtendedCallback ( Func< bool > callback)
static

◆ UnregisterIsAnyTooltipExtendedCallback()

static void TaleWorlds.Library.InformationManager.UnregisterIsAnyTooltipExtendedCallback ( Func< bool > callback)
static

◆ GetIsAnyTooltipActive()

static bool TaleWorlds.Library.InformationManager.GetIsAnyTooltipActive ( )
static

◆ GetIsAnyTooltipExtended()

static bool TaleWorlds.Library.InformationManager.GetIsAnyTooltipExtended ( )
static

◆ GetIsAnyTooltipActiveAndExtended()

static bool TaleWorlds.Library.InformationManager.GetIsAnyTooltipActiveAndExtended ( )
static

◆ RegisterTooltip< TRegistered, TTooltip >()

static void TaleWorlds.Library.InformationManager.RegisterTooltip< TRegistered, TTooltip > ( Action< TTooltip, object[]> onRefreshData,
string movieName )
static
Template Parameters
TRegisteredRegistered type
TTooltipTooltip type
Parameters
onRefreshDataA method that is used to refresh the tooltip data
movieNameName of the movie to be used with the given tooltip type
Type Constraints
TTooltip :TooltipBaseVM 

◆ UnregisterTooltip< TRegistered >()

static void TaleWorlds.Library.InformationManager.UnregisterTooltip< TRegistered > ( )
static
Template Parameters
TRegisteredRegistered type

◆ Clear()

static void TaleWorlds.Library.InformationManager.Clear ( )
static

Member Data Documentation

◆ IsAnyInquiryActive

Func<bool> TaleWorlds.Library.InformationManager.IsAnyInquiryActive
static

Property Documentation

◆ RegisteredTypes

IReadOnlyDictionary<Type, (Type tooltipType, object onRefreshData, string movieName)> TaleWorlds.Library.InformationManager.RegisteredTypes
staticget

Event Documentation

◆ DisplayMessageInternal

Action<InformationMessage> TaleWorlds.Library.InformationManager.DisplayMessageInternal
static

◆ ClearAllMessagesInternal

Action TaleWorlds.Library.InformationManager.ClearAllMessagesInternal
static

◆ OnAddSystemNotification

Action<string> TaleWorlds.Library.InformationManager.OnAddSystemNotification
static

◆ OnShowTooltip

Action<Type, object[]> TaleWorlds.Library.InformationManager.OnShowTooltip
static

◆ OnHideTooltip

Action TaleWorlds.Library.InformationManager.OnHideTooltip
static

◆ OnShowInquiry

Action<InquiryData, bool, bool> TaleWorlds.Library.InformationManager.OnShowInquiry
static

◆ OnShowTextInquiry

Action<TextInquiryData, bool, bool> TaleWorlds.Library.InformationManager.OnShowTextInquiry
static

◆ OnHideInquiry

Action TaleWorlds.Library.InformationManager.OnHideInquiry
static