Skip to content
This repository has been archived by the owner on Dec 29, 2024. It is now read-only.

[Port] Combat Indicator #12

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

[Port] Combat Indicator #12

wants to merge 2 commits into from

Conversation

PuroSlavKing
Copy link
Member

@PuroSlavKing PuroSlavKing commented Nov 17, 2024

EverwoodDividerOpen
EverwoodPRDesc

Taken from: Rxup/space-station-14#758

Todo:

  • Изменение звука на аутентичный.
  • Изменение спрайта на аутентичный.
  • Включение отдельной кнопкой.

EverwoodDivider
EverwoodPRMedia

Приложения

Example Media Embed

EverwoodDivider
EverwoodPRType

  • Feature
  • Fix
  • Tweak
  • Balance
  • Refactor
  • Port
  • Translate
  • Resprite

EverwoodDividerMidle
EverwoodPRChangelog
EverwoodPrint

🆑 PuroSlavKing

  • add: Добавлен индикатор боевого режима.
  • add: Добавлены звуки перехода в боевой режим.

EverwoodDividerClose

Summary by CodeRabbit

  • Новые функции

    • Улучшены визуальные индикаторы режима боя, добавлены новые спрайты для отображения состояния.
    • Введены звуковые эффекты для активации и деактивации режима боя, заменив всплывающие сообщения.
  • Документация

    • Добавлены новые файлы конфигурации для аудио и текстур, связанные с эффектами режима боя.

@PuroSlavKing PuroSlavKing added Feature Я хочу добавить что-то новое. Port Я портирую эти коммиты. labels Nov 17, 2024
@PuroSlavKing PuroSlavKing marked this pull request as ready for review November 30, 2024 12:55
Copy link

coderabbitai bot commented Nov 30, 2024

Walkthrough

Внесены изменения в классы CombatModeSystem и SharedCombatModeSystem, а также добавлены новые файлы конфигурации для аудио и текстур, связанные с режимом боя. В CombatModeSystem добавлены новые зависимости и методы для управления визуальными индикаторами режима боя. В SharedCombatModeSystem обновлен метод для воспроизведения звуковых эффектов при переключении режима боя. Также созданы новые файлы YAML и JSON для аудиоэффектов и метаданных текстур соответственно.

Changes

File Path Change Summary
Content.Client/CombatMode/CombatModeSystem.cs Добавлено поле _spriteQuery и метод UpdateCombatModeIndicator для управления индикаторами.
Content.Shared/CombatMode/SharedCombatModeSystem.cs Добавлено поле _audio и изменен метод OnActionPerform для воспроизведения звуковых эффектов.
Resources/Audio/_Everwood/Effects/CombatMode/attributions.yml Новый файл YAML для аудио ресурсов, содержащий файлы "on.ogg" и "off.ogg" с лицензией.
Resources/Textures/_Everwood/Effects/combat_mode.rsi/meta.json Новый файл JSON с метаданными для эффекта режима боя, включая размеры и задержки.

Poem

В мире битв, где смелость жжёт,
Индикаторы теперь зовут,
Звук и свет — в унисон,
Режим боя — наш закон!
Скачем, бьёмся, не устанем,
В каждом шаге — дух веселья! 🐇✨

Warning

Rate limit exceeded

@PuroSlavKing has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 12 minutes and 25 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 21f1a7d and e43bfaf.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 21f1a7d and e43bfaf.

📒 Files selected for processing (1)
  • Content.Shared/CombatMode/SharedCombatModeSystem.cs (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • Content.Shared/CombatMode/SharedCombatModeSystem.cs

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.

@PuroSlavKing PuroSlavKing marked this pull request as draft November 30, 2024 12:55
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🧹 Outside diff range and nitpick comments (4)
Content.Shared/CombatMode/SharedCombatModeSystem.cs (2)

2-2: Проверьте необходимость всех добавленных зависимостей

Добавлены новые зависимости для аудио системы, но некоторые using-директивы могут быть избыточными:

  • Content.Shared.CombatMode уже включен в пространство имен файла
  • Robust.Shared.GameObjects может быть уже доступен через другие зависимости
-using Content.Shared.CombatMode; // Everwood
-using Robust.Shared.GameObjects; // Everwood

Also applies to: 6-8, 20-20


61-62: Рассмотрите возможность комбинирования звукового и визуального оповещения

Закомментированные строки с popup-сообщениями могли быть полезны для игроков с отключенным звуком. Рекомендуется:

  1. Либо полностью удалить закомментированный код
  2. Либо реализовать комбинированное оповещение (звук + визуальное)
Content.Client/CombatMode/CombatModeSystem.cs (2)

30-30: Рекомендуется добавить модификатор readonly

Для поля _spriteQuery рекомендуется использовать модификатор readonly, так как оно инициализируется только один раз в методе Initialize.

-    private EntityQuery<SpriteComponent> _spriteQuery;
+    private readonly EntityQuery<SpriteComponent> _spriteQuery;

37-40: Рекомендуется унифицировать стиль комментариев

Комментарии "Everwood" и "Everwood EDIT" следует привести к единому стилю или удалить, если они не несут полезной информации.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 597f773 and 21f1a7d.

⛔ Files ignored due to path filters (3)
  • Resources/Audio/_Everwood/Effects/CombatMode/off.ogg is excluded by !**/*.ogg
  • Resources/Audio/_Everwood/Effects/CombatMode/on.ogg is excluded by !**/*.ogg
  • Resources/Textures/_Everwood/Effects/combat_mode.rsi/combat_mode.png is excluded by !**/*.png
📒 Files selected for processing (4)
  • Content.Client/CombatMode/CombatModeSystem.cs (3 hunks)
  • Content.Shared/CombatMode/SharedCombatModeSystem.cs (3 hunks)
  • Resources/Audio/_Everwood/Effects/CombatMode/attributions.yml (1 hunks)
  • Resources/Textures/_Everwood/Effects/combat_mode.rsi/meta.json (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • Resources/Audio/_Everwood/Effects/CombatMode/attributions.yml
  • Resources/Textures/_Everwood/Effects/combat_mode.rsi/meta.json
🔇 Additional comments (2)
Content.Client/CombatMode/CombatModeSystem.cs (2)

9-14: Корректное добавление зависимостей!

Все необходимые зависимости для работы с визуальными компонентами и действиями добавлены правильно.


114-114: Проверка наличия ресурсов спрайтов

Необходимо убедиться, что файлы спрайтов существуют в проекте.

✅ Verification successful

Ресурсы спрайтов успешно проверены

Проверка показала, что все необходимые ресурсы присутствуют в проекте:

  • Файл combat_mode.rsi существует в правильной директории
  • В meta.json определено состояние combat_mode с корректной анимацией
  • Файл текстуры combat_mode.png присутствует в директории RSI
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that combat mode sprite resources exist

# Check if the RSI file exists
fd -e rsi "combat_mode" Resources/Textures/_Everwood/Effects/

# Check if the meta.json exists and contains required states
fd -e json "meta.json" Resources/Textures/_Everwood/Effects/combat_mode.rsi/ \
  --exec jq -e '.states | has("combat_mode")'

Length of output: 362


Script:

#!/bin/bash
# Let's check the actual content of meta.json to understand its structure
cat Resources/Textures/_Everwood/Effects/combat_mode.rsi/meta.json

# Also check if the PNG files exist in the RSI directory
fd -e png "" Resources/Textures/_Everwood/Effects/combat_mode.rsi/

Length of output: 756

Content.Shared/CombatMode/SharedCombatModeSystem.cs Outdated Show resolved Hide resolved
Content.Shared/CombatMode/SharedCombatModeSystem.cs Outdated Show resolved Hide resolved
Comment on lines +104 to +125
// Everwood START
private void UpdateCombatModeIndicator(EntityUid uid, CombatModeComponent comp, ref GetStatusIconsEvent _)
{
if (!_spriteQuery.TryComp(uid, out var sprite))
return;

if (comp.IsInCombatMode)
{
if (!sprite.LayerMapTryGet("combat_mode_indicator", out var layer))
{
layer = sprite.AddLayer(new SpriteSpecifier.Rsi(new ResPath("_Everwood/Effects/combat_mode.rsi"), "combat_mode"));
sprite.LayerMapSet("combat_mode_indicator", layer);
}
}
else
{
if (sprite.LayerMapTryGet("combat_mode_indicator", out var layerToRemove))
{
sprite.RemoveLayer(layerToRemove);
}
}
} // Everwood END
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Требуются улучшения в реализации UpdateCombatModeIndicator

Выявлены следующие проблемы:

  1. Использование магических строк для имен слоев и путей
  2. Отсутствует проверка параметра comp на null
  3. Отсутствует обработка ошибок при загрузке спрайтов

Предлагаемые изменения:

+    private const string CombatModeIndicatorLayer = "combat_mode_indicator";
+    private const string CombatModeSpritePath = "_Everwood/Effects/combat_mode.rsi";
+    private const string CombatModeState = "combat_mode";

     private void UpdateCombatModeIndicator(EntityUid uid, CombatModeComponent comp, ref GetStatusIconsEvent _)
     {
+        if (comp == null)
+            return;
+
         if (!_spriteQuery.TryComp(uid, out var sprite))
             return;

         if (comp.IsInCombatMode)
         {
-            if (!sprite.LayerMapTryGet("combat_mode_indicator", out var layer))
+            if (!sprite.LayerMapTryGet(CombatModeIndicatorLayer, out var layer))
             {
+                try
+                {
-                layer = sprite.AddLayer(new SpriteSpecifier.Rsi(new ResPath("_Everwood/Effects/combat_mode.rsi"), "combat_mode"));
-                sprite.LayerMapSet("combat_mode_indicator", layer);
+                    layer = sprite.AddLayer(new SpriteSpecifier.Rsi(new ResPath(CombatModeSpritePath), CombatModeState));
+                    sprite.LayerMapSet(CombatModeIndicatorLayer, layer);
+                }
+                catch (Exception e)
+                {
+                    Logger.ErrorS("combat", $"Failed to load combat mode indicator sprite: {e}");
+                    return;
+                }
             }
         }
         else
         {
-            if (sprite.LayerMapTryGet("combat_mode_indicator", out var layerToRemove))
+            if (sprite.LayerMapTryGet(CombatModeIndicatorLayer, out var layerToRemove))
             {
                 sprite.RemoveLayer(layerToRemove);
             }
         }
     }
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
// Everwood START
private void UpdateCombatModeIndicator(EntityUid uid, CombatModeComponent comp, ref GetStatusIconsEvent _)
{
if (!_spriteQuery.TryComp(uid, out var sprite))
return;
if (comp.IsInCombatMode)
{
if (!sprite.LayerMapTryGet("combat_mode_indicator", out var layer))
{
layer = sprite.AddLayer(new SpriteSpecifier.Rsi(new ResPath("_Everwood/Effects/combat_mode.rsi"), "combat_mode"));
sprite.LayerMapSet("combat_mode_indicator", layer);
}
}
else
{
if (sprite.LayerMapTryGet("combat_mode_indicator", out var layerToRemove))
{
sprite.RemoveLayer(layerToRemove);
}
}
} // Everwood END
private const string CombatModeIndicatorLayer = "combat_mode_indicator";
private const string CombatModeSpritePath = "_Everwood/Effects/combat_mode.rsi";
private const string CombatModeState = "combat_mode";
private void UpdateCombatModeIndicator(EntityUid uid, CombatModeComponent comp, ref GetStatusIconsEvent _)
{
if (comp == null)
return;
if (!_spriteQuery.TryComp(uid, out var sprite))
return;
if (comp.IsInCombatMode)
{
if (!sprite.LayerMapTryGet(CombatModeIndicatorLayer, out var layer))
{
try
{
layer = sprite.AddLayer(new SpriteSpecifier.Rsi(new ResPath(CombatModeSpritePath), CombatModeState));
sprite.LayerMapSet(CombatModeIndicatorLayer, layer);
}
catch (Exception e)
{
Logger.ErrorS("combat", $"Failed to load combat mode indicator sprite: {e}");
return;
}
}
}
else
{
if (sprite.LayerMapTryGet(CombatModeIndicatorLayer, out var layerToRemove))
{
sprite.RemoveLayer(layerToRemove);
}
}
}

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Signed-off-by: PuroSlavKing <[email protected]>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Changes: Audio Changes: C# Changes: Sprite Changes: YML Feature Я хочу добавить что-то новое. Port Я портирую эти коммиты.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant