[Port] Emotions menu / Меню эмоций #55

Spatison · 2024-09-11T20:09:38Z

Описание PR

Порт меню эмоций.

Изменения

🆑 Spatison

add: added emotions menu / Добавлено меню эмоций

coderabbitai · 2024-09-11T20:09:55Z

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

Commits

Files that changed from the base of the PR and between dcd1634 and 5ccd0ae.

Files selected for processing (2)

Content.Client/UserInterface/Systems/MenuBar/GameTopMenuBarUIController.cs (4 hunks)
Content.Client/_White/UI/Emotions/EmotionsUIController.cs (1 hunks)

_________________________________________________________________________________________________________________
< Iterate the schedule with the code. Use experience you gain as you implement to refine the project time scales. >
-----------------------------------------------------------------------------------------------------------------
 \
  \   \
       \ /\
       ( )
     .( o ).

Walkthrough

The pull request introduces a comprehensive update to the user interface, primarily focusing on the integration of an emotions menu. Key changes include the addition of an EmotionsUIController for managing emotional expressions and the EmotionsWindow, which provides a UI for users to interact with various emotes. New key bindings and localization entries for both English and Russian have been implemented to support the emotions menu and associated functionalities. Additionally, modifications were made to existing UI components to accommodate the new features.

Changes

Files	Change Summary
`Content.Client/Input/ContentContexts.cs`, `Content.Client/Options/UI/Tabs/KeyRebindTab.xaml.cs`, `Content.Client/UserInterface/Systems/MenuBar/GameTopMenuBarUIController.cs`, `Content.Client/UserInterface/Systems/MenuBar/Widgets/GameTopMenuBar.xaml`	Added functionality for accessing the emotions menu through various UI elements and key bindings.
`Content.Client/_White/UI/Emotions/EmotionsUIController.cs`, `Content.Client/_White/UI/Emotions/Windows/EmotionsWindow.xaml`, `Content.Client/_White/UI/Emotions/Windows/EmotionsWindow.xaml.cs`	Introduced the `EmotionsUIController` and `EmotionsWindow` for managing emotional interactions within the application.
`Content.Server/Chat/Systems/ChatSystem.Emote.cs`, `Content.Shared/Chat/Prototypes/EmotePrototype.cs`, `Content.Shared/Input/ContentKeyFunctions.cs`	Modified emote handling to support localization and added new properties for emotes.
`Resources/Locale/en-US/_white/HUD/game-hud.ftl`, `Resources/Locale/en-US/_white/emotes/speech-emotes.ftl`, `Resources/Locale/en-US/_white/escape-menu/options-menu.ftl`, `Resources/Locale/en-US/_white/ui/emotions-menu.ftl`	Added localization entries for the emotions menu and associated emotes in English.
`Resources/Locale/ru-RU/HUD/game-hud.ftl`, `Resources/Locale/ru-RU/_white/HUD/game-hud.ftl`, `Resources/Locale/ru-RU/_white/emotes/speech-emotes.ftl`, `Resources/Locale/ru-RU/_white/escape-menu/options-menu.ftl`, `Resources/Locale/ru-RU/_white/ui/emotions-menu.ftl`	Updated localization for the emotions menu and emotes in Russian, including new entries and modifications.
`Resources/Prototypes/Voice/speech_emotes.yml`, `Resources/Prototypes/_White/Voice/speech_emotes.yml`	Enhanced emote definitions with localized button text and chat messages, allowing for better user interaction.
`Resources/keybinds.yml`	Added new key binding for the `OpenEmotionsMenu` function and updated comment formatting for clarity.

Tip

CodeRabbit can suggest fixes for GitHub Check annotations.

Configure reviews.tools.github-checks in your project's settings in CodeRabbit to adjust the time to wait for GitHub Checks to complete.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 5

Outside diff range and nitpick comments (2)

Content.Shared/Chat/Prototypes/EmotePrototype.cs (1)

37-44: Consider improving the property names and removing non-standard comments.

The default value for ButtonText is set to "Unknown". Consider using a more meaningful default value that aligns with the intended purpose of the property.

The naming of the AllowToEmotionsMenu property is inconsistent with the ButtonText property. For better readability and consistency, consider renaming it to AllowInEmotionsMenu.

The // WD EDIT START and // WD EDIT END comments appear to be non-standard and may not adhere to the project's coding conventions. Consider removing them to maintain a clean and consistent codebase.
Content.Client/Input/ContentContexts.cs (1)
62-62: LGTM, but consider removing the "WD EDIT" comment.

The code change looks good and is consistent with the PR objective of adding an emotions menu.

However, the "WD EDIT" comment doesn't add much value and can be removed to keep the code clean.

Apply this diff to remove the comment:
-            human.AddFunction(ContentKeyFunctions.OpenEmotionsMenu); // WD EDIT
+            human.AddFunction(ContentKeyFunctions.OpenEmotionsMenu);

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f7fefc5 and 0749b3d.

Files ignored due to path filters (1)

Resources/Textures/_White/Interface/emotions.svg.192dpi.png is excluded by !**/*.png

Files selected for processing (23)

Content.Client/Input/ContentContexts.cs (1 hunks)
Content.Client/Options/UI/Tabs/KeyRebindTab.xaml.cs (1 hunks)
Content.Client/UserInterface/Systems/MenuBar/GameTopMenuBarUIController.cs (4 hunks)
Content.Client/UserInterface/Systems/MenuBar/Widgets/GameTopMenuBar.xaml (2 hunks)
Content.Client/_White/UI/Emotions/EmotionsUIController.cs (1 hunks)
Content.Client/_White/UI/Emotions/Windows/EmotionsWindow.xaml (1 hunks)
Content.Client/_White/UI/Emotions/Windows/EmotionsWindow.xaml.cs (1 hunks)
Content.Server/Chat/Systems/ChatSystem.Emote.cs (1 hunks)
Content.Shared/Chat/Prototypes/EmotePrototype.cs (1 hunks)
Content.Shared/Input/ContentKeyFunctions.cs (1 hunks)
Resources/Locale/en-US/_white/HUD/game-hud.ftl (1 hunks)
Resources/Locale/en-US/_white/emotes/speech-emotes.ftl (1 hunks)
Resources/Locale/en-US/_white/escape-menu/options-menu.ftl (1 hunks)
Resources/Locale/en-US/_white/ui/emotions-menu.ftl (1 hunks)
Resources/Locale/ru-RU/HUD/game-hud.ftl (1 hunks)
Resources/Locale/ru-RU/_white/HUD/game-hud.ftl (1 hunks)
Resources/Locale/ru-RU/_white/emotes/speech-emotes.ftl (1 hunks)
Resources/Locale/ru-RU/_white/escape-menu/options-menu.ftl (1 hunks)
Resources/Locale/ru-RU/_white/ui/emotions-menu.ftl (1 hunks)
Resources/Prototypes/Voice/speech_emotes.yml (1 hunks)
Resources/Prototypes/_White/Voice/speech_emotes.yml (1 hunks)
Resources/Textures/_White/Interface/emotions.svg.192dpi.png.yml (1 hunks)
Resources/keybinds.yml (2 hunks)

Files skipped from review due to trivial changes (5)

Resources/Locale/en-US/_white/HUD/game-hud.ftl
Resources/Locale/en-US/_white/ui/emotions-menu.ftl
Resources/Locale/ru-RU/_white/HUD/game-hud.ftl
Resources/Locale/ru-RU/_white/ui/emotions-menu.ftl
Resources/Textures/_White/Interface/emotions.svg.192dpi.png.yml

Additional comments not posted (57)

Resources/Locale/en-US/_white/escape-menu/options-menu.ftl (1)

1-1: LGTM!

The new localization entry for "Open emotions menu" UI option is correctly added.

Resources/Locale/ru-RU/_white/escape-menu/options-menu.ftl (1)

1-1: LGTM!

The addition of the localization string for opening the emotions menu in the Russian language resource file is approved. This change enhances the user interface for Russian-speaking users without altering any existing functionality or logic.

Content.Client/_White/UI/Emotions/Windows/EmotionsWindow.xaml.cs (1)

8-14: LGTM!

The EmotionsWindow class is correctly implemented and follows the standard pattern for defining a window in the project. The code changes are approved.

Content.Client/_White/UI/Emotions/Windows/EmotionsWindow.xaml (1)

1-12: LGTM!

The EmotionsWindow element is well-defined and follows the XAML syntax. The use of localization for the window's title is a good practice.

The EmotionsContainer is currently empty, but it is expected to be populated with the emotions menu content in the future.

Resources/Prototypes/_White/Voice/speech_emotes.yml (4)

1-7: LGTM!

The Nod emote prototype is well-defined and follows a consistent structure. The use of localization keys for the button text and chat messages is a good practice for supporting multiple languages. Setting allowMenu to true ensures that this emote can be accessed from a menu.

8-14: LGTM!

The ShakeHead emote prototype follows the same consistent structure as the previous emote. The localization keys and allowMenu property are used appropriately.

15-21: LGTM!

The Frown emote prototype maintains consistency with the previous emotes in terms of structure and usage of localization keys and the allowMenu property.

22-27: LGTM!

The Smile emote prototype follows the established pattern and is consistent with the other emotes in the file.

Content.Client/UserInterface/Systems/MenuBar/GameTopMenuBarUIController.cs (3)

1-1: LGTM!

The new using statement is necessary to use the EmotionsUIController class in this file.

28-28: LGTM!

The new EmotionsUIController dependency is correctly added to the GameTopMenuBarUIController class. This will allow integrating the emotions menu with the game top menu bar.

52-52: LGTM!

Calling the LoadButton method of the EmotionsUIController in the UnloadButtons and LoadButtons methods ensures that the emotions menu button is properly loaded and unloaded when the game top menu bar is loaded or unloaded.

Also applies to: 66-66

Resources/Locale/ru-RU/_white/emotes/speech-emotes.ftl (18)

1-7: Scream emote translations look good.

The button text and chat message variations for the scream emote are translated correctly.

9-15: Laugh emote translations look good.

The button text and chat message variations for the laugh emote are translated correctly.

17-18: Honk emote translation looks good, but button text is missing.

The chat message for the honk emote is translated correctly. However, there is no button text translation provided. This may be intentional if the honk emote does not have a dedicated button.

20-23: Sigh emote translations look good.

The button text and chat message for the sigh emote are translated correctly.

25-28: Whistle emote translations look good.

The button text and chat message for the whistle emote are translated correctly.

30-33: Crying emote translations look good.

The button text and chat message for the crying emote are translated correctly.

35-36: Squish emote translation looks good, but button text is missing.

The chat message for the squish emote is translated correctly. However, there is no button text translation provided. This may be intentional if the squish emote does not have a dedicated button.

38-39: Chitter emote translation looks good, but button text is missing.

The chat message for the chitter emote is translated correctly. However, there is no button text translation provided. This may be intentional if the chitter emote does not have a dedicated button.

41-42: Squeak emote translation looks good, but button text is missing.

The chat message for the squeak emote is translated correctly. However, there is no button text translation provided. This may be intentional if the squeak emote does not have a dedicated button.

44-46: Click emote translations look good, but button text is missing.

The two variations of the chat message for the click emote are translated correctly. However, there is no button text translation provided. This may be intentional if the click emote does not have a dedicated button.

48-51: Clap emote translations look good.

The button text and chat message for the clap emote are translated correctly.

53-62: Snap emote translations look good.

The button text and chat message variations for the snap emote are translated correctly, covering different verb conjugations.

64-67: Salute emote translations look good.

The button text and chat message for the salute emote are translated correctly.

69-72: Deathgasp emote translations look good.

The chat message variations for the deathgasp emote are translated correctly, accounting for different entity types (default, silicon, IPC). The use of placeholders for possessive adjectives based on the entity is a good approach.

74-99: Translations for Buzz, Weh, Chirp, Beep, Boop, Chime, Buzz-Two, Ping, and Whirr emotes look good, but button texts are missing.

The chat messages for the Buzz, Weh, Chirp, Beep, Boop, Chime, Buzz-Two, Ping, and Whirr emotes are translated correctly. However, there are no button text translations provided for any of these emotes. This may be intentional if these emotes do not have dedicated buttons.

101-104: Nod emote translations look good.

The button text and chat message for the nod emote are translated correctly.

106-109: ShakeHead emote translations look good.

The button text and chat message for the shake head emote are translated correctly.

111-119: Frown and Smile emote translations look good.

The button texts and chat messages for the frown and smile emotes are translated correctly.

Content.Client/_White/UI/Emotions/EmotionsUIController.cs (1)

17-131: LGTM!

The EmotionsUIController class is well-structured and follows the Single Responsibility Principle. It properly handles the lifecycle of the emotions window and button based on the gameplay state. The class efficiently populates the emotions window by enumerating emote prototypes and creating buttons for each one. It also implements a cooldown mechanism to prevent spamming emotes.

The code changes are approved.

Resources/Prototypes/Voice/speech_emotes.yml (20)

5-12: LGTM!

The changes to the Scream emote look good. The addition of buttonText, updates to chatMessages and chatTriggers, and inclusion of allowMenu are consistent with the new emote structure.

17-24: LGTM!

The changes to the Laugh emote look good. The addition of buttonText, updates to chatMessages and chatTriggers, and inclusion of allowMenu are consistent with the new emote structure.

29-31: LGTM!

The changes to the Honk emote look good. The updates to chatMessages and chatTriggers are consistent with the new emote structure.

36-40: LGTM!

The changes to the Sigh emote look good. The addition of buttonText, updates to chatMessages and chatTriggers, and inclusion of allowMenu are consistent with the new emote structure.

45-49: LGTM!

The changes to the Whistle emote look good. The addition of buttonText, updates to chatMessages and chatTriggers, and inclusion of allowMenu are consistent with the new emote structure.

54-59: LGTM!

The changes to the Crying emote look good. The addition of buttonText, updates to chatMessages and chatTriggers, and inclusion of allowMenu are consistent with the new emote structure.

64-66: LGTM!

The changes to the Squish emote look good. The updates to chatMessages and chatTriggers are consistent with the new emote structure.

71-73: LGTM!

The changes to the Chitter emote look good. The updates to chatMessages and chatTriggers are consistent with the new emote structure.

78-80: LGTM!

The changes to the Squeak emote look good. The updates to chatMessages and chatTriggers are consistent with the new emote structure.

85-88: LGTM!

The changes to the Click emote look good. The updates to chatMessages and chatTriggers are consistent with the new emote structure.

94-98: LGTM!

The changes to the Clap emote look good. The addition of buttonText, updates to chatMessages and chatTriggers, and inclusion of allowMenu are consistent with the new emote structure.

103-113: LGTM!

The changes to the Snap emote look good. The addition of buttonText, updates to chatMessages and chatTriggers, and inclusion of allowMenu are consistent with the new emote structure.

118-122: LGTM!

The changes to the Salute emote look good. The addition of buttonText, updates to chatMessages and chatTriggers, and inclusion of allowMenu are consistent with the new emote structure.

126-126: LGTM!

The changes to the DefaultDeathgasp emote look good. The update to chatMessages is consistent with the new emote structure.

130-130: LGTM!

The changes to the SiliconDeathgasp emote look good. The update to chatMessages is consistent with the new emote structure.

135-137: LGTM!

The changes to the Buzz emote look good. The updates to chatMessages and chatTriggers are consistent with the new emote structure.

142-142: LGTM!

The changes to the Weh emote look good. The update to chatMessages is consistent with the new emote structure.

147-149: LGTM!

The changes to the Chirp emote look good. The updates to chatMessages and chatTriggers are consistent with the new emote structure.

155-157: LGTM!

The changes to the Beep emote look good. The updates to chatMessages and chatTriggers are consistent with the new emote structure.

162-164: LGTM!

The changes to the Boop emote look good. The updates to chatMessages and chatTriggers are consistent with the new emote structure.

Content.Client/UserInterface/Systems/MenuBar/Widgets/GameTopMenuBar.xaml (2)

22-22: LGTM!

The code change is approved.

46-55: LGTM!

The code changes are approved.

The addition of the EmotionsButton with its properties and key binding looks good. It will provide users with access to the emotions menu from the game top menu bar.

Content.Server/Chat/Systems/ChatSystem.Emote.cs (1)

31-31: LGTM!

The change to use Loc.GetString(word).ToLower() for assigning lowerWord is a good improvement to ensure emote triggers are correctly localized. This will help address potential issues with case sensitivity in different languages or contexts.

Content.Shared/Input/ContentKeyFunctions.cs (1)

28-28: LGTM!

The addition of the OpenEmotionsMenu field to the ContentKeyFunctions class is approved. This new bound key function will allow users to open the emotions menu using a specific key binding.

Resources/keybinds.yml (2)

190-194: LGTM!

The new key binding for the OpenEmotionsMenu function looks good. The Y key is a suitable choice and the changes are clearly marked with comments.

551-555: LGTM!

The addition of comment markers around the LookUp binding improves the readability and maintainability of the file without altering its functionality.

Content.Client/Options/UI/Tabs/KeyRebindTab.xaml.cs (1)

231-231: LGTM!

The code changes are approved.

Resources/Locale/en-US/_white/emotes/speech-emotes.ftl

Content.Client/_White/UI/Emotions/EmotionsUIController.cs

Content.Client/UserInterface/Systems/MenuBar/GameTopMenuBarUIController.cs

Content.Client/_White/UI/Emotions/EmotionsUIController.cs

Content.Client/_White/UI/Emotions/Windows/EmotionsWindow.xaml

Content.Client/_White/UI/Emotions/EmotionsUIController.cs

Spatison added 5 commits September 11, 2024 18:11

add: emotions munu

2023518

tweak

391c875

fix

cbeaa0b

fix

301c2d2

WD EDIT

0749b3d

github-actions bot added Changes: C# Changes: Localization Changes: UI Changes: YML labels Sep 11, 2024

test

b236d95

coderabbitai bot reviewed Sep 11, 2024

View reviewed changes

AI rewiew

dcd1634

Spatison requested a review from Remuchi September 11, 2024 20:37

github-actions bot added the Status: Needs Review label Sep 11, 2024

Remuchi requested changes Sep 12, 2024

View reviewed changes

rewiew

5ccd0ae

Spatison requested a review from Remuchi September 12, 2024 16:21

Spatison self-assigned this Sep 12, 2024

Remuchi approved these changes Sep 13, 2024

View reviewed changes

Remuchi merged commit b914415 into master Sep 13, 2024
11 checks passed

Remuchi deleted the emotions branch September 13, 2024 05:13

riddleridou added a commit that referenced this pull request Sep 13, 2024

Automatic Changelog Update (#55)

51e3b06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Port] Emotions menu / Меню эмоций #55

[Port] Emotions menu / Меню эмоций #55

Spatison commented Sep 11, 2024

coderabbitai bot commented Sep 11, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

[Port] Emotions menu / Меню эмоций #55

[Port] Emotions menu / Меню эмоций #55

Conversation

Spatison commented Sep 11, 2024

Описание PR

Изменения

coderabbitai bot commented Sep 11, 2024 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot commented Sep 11, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)