Skip to content

Add new ui functions #63

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 14, 2025
Merged

Add new ui functions #63

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
33f76a0
Add new ui functions
juso40 Jun 5, 2025
a91d9c9
Split into HUD and OnlineMessage UI, rename functions and reword docs
juso40 Jun 8, 2025
bdb514f
Add early break
juso40 Jun 9, 2025
20e3e8c
Remove context managers
juso40 Jun 9, 2025
a4d5520
cleanup, update changelog
apple1417 Jun 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 23 additions & 21 deletions src/ui_utils/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,21 @@
from .clipboard import clipboard_copy, clipboard_paste
from .hud_message import (
ERewardPopup,
blocking_message_hide,
blocking_message_show,
contextual_prompt_hide,
contextual_prompt_show,
display_blocking_message,
display_contextual_prompt,
display_message,
message_hide,
message_show,
show_big_notification,
display_button_prompt,
hide_button_prompt,
show_button_prompt,
show_discovery_message,
show_hud_message,
show_reward_popup,
show_top_center_message,
show_second_wind_notification,
)
from .online_message import (
display_blocking_message,
display_message,
hide_blocking_message,
hide_message,
show_blocking_message,
show_message,
)
from .option_box import OptionBox, OptionBoxButton
from .reorder_box import ReorderBox
Expand All @@ -32,25 +34,25 @@
"__author__",
"__version__",
"__version_info__",
"blocking_message_hide",
"blocking_message_show",
"clipboard_copy",
"clipboard_paste",
"contextual_prompt_hide",
"contextual_prompt_show",
"display_blocking_message",
"display_contextual_prompt",
"display_button_prompt",
"display_message",
"message_hide",
"message_show",
"show_big_notification",
"hide_blocking_message",
"hide_button_prompt",
"hide_message",
"show_blocking_message",
"show_button_prompt",
"show_chat_message",
"show_discovery_message",
"show_hud_message",
"show_message",
"show_reward_popup",
"show_top_center_message",
"show_second_wind_notification",
)

__version_info__: tuple[int, int] = (1, 3)
__version_info__: tuple[int, int] = (1, 4)
__version__: str = f"{__version_info__[0]}.{__version_info__[1]}"
__author__: str = "bl-sdk"

Expand Down
157 changes: 30 additions & 127 deletions src/ui_utils/hud_message.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,19 +23,13 @@ class ERewardPopup(IntEnum):

__all__: tuple[str, ...] = (
"ERewardPopup",
"blocking_message_hide",
"blocking_message_show",
"contextual_prompt_hide",
"contextual_prompt_show",
"display_blocking_message",
"display_contextual_prompt",
"display_message",
"message_hide",
"message_show",
"show_big_notification",
"display_button_prompt",
"hide_button_prompt",
"show_button_prompt",
"show_discovery_message",
"show_hud_message",
"show_reward_popup",
"show_top_center_message",
"show_second_wind_notification",
)


Expand Down Expand Up @@ -75,7 +69,7 @@ def show_hud_message(title: str, msg: str, duration: float = 2.5) -> None:
)


def show_big_notification(
def show_second_wind_notification(
msg: str,
ui_sound: unreal.UObject | None | EllipsisType = ...,
) -> None:
Expand All @@ -84,24 +78,22 @@ def show_big_notification(

Uses the message style of the Second Wind notification.

Note this message can only display up to 33 characters.
Note this should not be used for critical messages, it may silently fail at any point.

Args:
msg: The message to display.
ui_sound: An optional AkEvent to play when the message is displayed.
If Ellipsis, default sound will be used.
If Ellipsis, default sound will be used.
"""
if (hud_movie := get_pc().GetHUDMovie()) is None:
return

sound_backup = None
sw_interaction = None
for gfx_movie in unrealsdk.find_all("GearboxGFxMovie", exact=False):
for interaction in gfx_movie.InteractionOverrideSounds:
if interaction.Interaction == "SecondWind":
sound_backup = interaction.AkEvent
sw_interaction = interaction
break
for interaction in hud_movie.InteractionOverrideSounds:
if interaction.Interaction == "SecondWind":
sound_backup = interaction.AkEvent
sw_interaction = interaction

if ui_sound is not Ellipsis and sw_interaction:
sw_interaction.AkEvent = ui_sound
Expand All @@ -114,21 +106,21 @@ def show_big_notification(
sw_interaction.AkEvent = sound_backup


def show_top_center_message(msg: str, show_discovered_message: bool = False) -> None:
def show_discovery_message(msg: str, show_discovered_message: bool = False) -> None:
"""
Displays a message in the top center of the screen.

Uses the style of the new area discovered message.

Note this message can only display up to 41 characters.
Note this should not be used for critical messages, it may silently fail at any point.

Args:
msg: The message to display.
show_discovered_message: If True, the message 'You have discovered' header will show.
"""
if (hud_movie := get_pc().GetHUDMovie()) is None:
return
hud_movie.ShowWorldDiscovery("", "msg", show_discovered_message, False)
hud_movie.ShowWorldDiscovery("", msg, show_discovered_message, False)


def show_reward_popup(
Expand All @@ -138,7 +130,7 @@ def show_reward_popup(
"""
Displays a reward popup with the given message and reward type.

Note this message can only display up to 33 characters.
Note this should not be used for critical messages, it may silently fail at any point.

Args:
msg: The message to display in the popup.
Expand All @@ -160,136 +152,47 @@ def show_reward_popup(
hud_movie.SetVariableString("p1.badassToken.inner.dispText.text", msg)


def contextual_prompt_show(text: str, button_string: str) -> None:
def show_button_prompt(reason: str, button: str) -> None:
"""
Displays a contextual prompt with the given text and button string.

Note both text and button_string can each display up to 16 characters.
This will stay visible until it is explicitly hidden, see `hide_contextual_prompt`.

Note this should not be used for critical messages, it may silently fail at any point.

Args:
text: The text top to display in the prompt.
button_string: The button string to display in the prompt.
reason: The text top to display in the prompt.
button: The button string to display in the prompt.
"""

if (hud_movie := get_pc().GetHUDMovie()) is None:
return
contextual_prompt = hud_movie.ContextualPromptButtonString
hud_movie.ContextualPromptButtonString = button_string
hud_movie.ToggleContextualPrompt(text, True)
hud_movie.ContextualPromptButtonString = button
hud_movie.ToggleContextualPrompt(reason, True)
hud_movie.ContextualPromptButtonString = contextual_prompt


def contextual_prompt_hide() -> None:
def hide_button_prompt() -> None:
"""Hides the currently displayed contextual prompt, if any."""
if (hud_movie := get_pc().GetHUDMovie()) is None:
return
hud_movie.ToggleContextualPrompt("", False)


@contextmanager
def display_contextual_prompt(text: str, button_string: str) -> Iterator[None]:
def display_button_prompt(reason: str, button: str) -> Iterator[None]:
"""
Context manager to display and hide a contextual prompt.

This will display the prompt when entering the context and hide it when exiting.

Args:
text: The text to display in the prompt.
button_string: The button string to display in the prompt.
"""
contextual_prompt_show(text, button_string)
try:
yield
finally:
contextual_prompt_hide()


def blocking_message_show(msg: str, reason: str | None = None) -> None:
"""
Displays a blocking message with the given text.

This message will block any input until it is hidden.

Note this message has no character limit, but only scales horizontally.
Multiple lines will not be displayed correctly.

Args:
msg: The message to display.
reason: An optional reason for the blocking message, which will be displayed as a subtitle.
If None, the default text will show.
"""
if (msg_movie := get_pc().GetOnlineMessageMovie()) is None:
return

backup = msg_movie.BlockingSubtitle
msg_movie.BlockingSubtitle = reason if reason is not None else backup
msg_movie.DisplayBlockingMessage(msg)
msg_movie.BlockingSubtitle = backup


def blocking_message_hide() -> None:
"""Hides the currently displayed blocking message, if any."""
if (msg_movie := get_pc().GetOnlineMessageMovie()) is None:
return

msg_movie.HideBlocking()


@contextmanager
def display_blocking_message(msg: str, reason: str | None = None) -> Iterator[None]:
"""
Context manager to display and hide a blocking message.

This will display the message when entering the context and hide it when exiting.

Args:
msg: The message to display.
reason: An optional reason for the blocking message, which will be displayed as a subtitle.
If None, the default text will show.
"""
blocking_message_show(msg, reason)
try:
yield
finally:
blocking_message_hide()


def message_show(msg: str) -> None:
"""
Displays a message on the left side of the screen.

Note this message has no character limit, but only scales horizontally.
Multiple lines will not be displayed correctly.

Args:
msg: The message to display.
"""
if (msg_movie := get_pc().GetOnlineMessageMovie()) is None:
return

msg_movie.DisplayMessage(msg)


def message_hide() -> None:
"""Hides the currently displayed message in the online message movie."""
if (msg_movie := get_pc().GetOnlineMessageMovie()) is None:
return

msg_movie.Hide()


@contextmanager
def display_message(msg: str) -> Iterator[None]:
"""
Context manager to display and hide a message.

This will display the message when entering the context and hide it when exiting.

Args:
msg: The message to display.
reason: The text to display in the prompt.
button: The button string to display in the prompt.
"""
message_show(msg)
show_button_prompt(reason, button)
try:
yield
finally:
message_hide()
hide_button_prompt()
Loading
Loading