Skip to content

役職作成ドキュメント(メソッド・インターフェース)の網羅的更新#830

Merged
yukieiji merged 3 commits into
develop/next-releasefrom
fix-role-docs-technical-ref-4377101141010160149
May 17, 2026
Merged

役職作成ドキュメント(メソッド・インターフェース)の網羅的更新#830
yukieiji merged 3 commits into
develop/next-releasefrom
fix-role-docs-technical-ref-4377101141010160149

Conversation

@yukieiji

Copy link
Copy Markdown
Owner

役職作成に関する開発ドキュメントを大幅に更新しました。

  1. 07_interfaces.md:

    • IRoleWinPlayerModifier, IRoleSpecialSetUp, IRoleAwake, IRoleOnRevive などの不足していたインターフェースをすべて網羅。
    • 各メソッドの引数・戻り値の説明と、実装例を追記。
  2. 08_methods.md:

    • SingleRoleBase の主要なオーバーライド可能メソッド(RolePlayerKilledAction, GetTargetRoleSeeColor, GetImportantText など)をすべて網羅。
    • 各メソッドの引数・戻り値の説明と、実装例を追記。
  3. リンクの修正:

    • 01_overview.md, 02_role_class.md, 04_ability_handler.md 内の古いリンクや間違ったファイル名へのリンクを最新の状態に修正。

PR created automatically by Jules for task 4377101141010160149 started by @yukieiji

Updated `07_interfaces.md` and `08_methods.md` to include missing
interfaces and virtual methods from the codebase. Each entry now
includes method signatures, detailed argument/return value
descriptions, and practical code examples.

Additionally, corrected broken or outdated links across the
role development documentation.

Co-authored-by: yukieiji <40425798+yukieiji@users.noreply.github.com>
@google-labs-jules

Copy link
Copy Markdown
Contributor

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request performs a comprehensive update to the role creation development documentation. It ensures that all necessary interfaces and methods for role customization are thoroughly documented with clear explanations and code examples, while also cleaning up internal navigation links to maintain a consistent and accurate developer experience.

Highlights

  • Comprehensive Interface Documentation: Updated 07_interfaces.md to include all missing interfaces like IRoleWinPlayerModifier, IRoleSpecialSetUp, IRoleAwake, and IRoleOnRevive, complete with method descriptions and implementation examples.
  • Method Coverage Expansion: Updated 08_methods.md to cover all major overridable methods in SingleRoleBase, such as RolePlayerKilledAction, GetTargetRoleSeeColor, and GetImportantText, with detailed explanations.
  • Link Maintenance: Corrected broken or outdated internal links across 01_overview.md, 02_role_class.md, and 04_ability_handler.md to reflect the updated documentation structure.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize the Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counterproductive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.


Roles defined with care and grace, Methods mapped in every place. Docs now clear for all to see, Coding joy for you and me.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request reorganizes and expands the developer documentation for role creation, providing more comprehensive details on interfaces and SingleRoleBase methods. Key updates include categorized interface descriptions and expanded lifecycle documentation. Feedback was provided to correct a typo in the HookMurderPlayer method and to clarify the distinction between fields and properties for certain class members.

Comment thread doc/dev/role/07_interfaces.md Outdated

#### `IRoleMurderPlayerHook`
プレイヤーが殺害される瞬間の処理に割り込みます(キルボタン押下時ではなく、実際の死亡処理時)。
- `void HookMuderPlayer(PlayerControl source, PlayerControl target)`

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

low

HookMuderPlayerHookMurderPlayer のスペルミスと思われます。

Suggested change
- `void HookMuderPlayer(PlayerControl source, PlayerControl target)`
- void HookMurderPlayer(PlayerControl source, PlayerControl target)

Comment thread doc/dev/role/08_methods.md Outdated
## 実装のポイント

これらのインターフェースは、Roleクラス自体に実装することも可能ですが、ロジックの肥大化を防ぐために **AbilityHandler に実装し、Roleクラスから呼び出す** か、**Roleクラスが保持する AbilityClass にそのインターフェースを実装したインスタンスを割り当てる** 設計が推奨されます。
`SingleRoleBase` は多くの `virtual` プロパティ(`CanUseAdmin`, `UseVent` など)を持っています。これらをコンストラクタや `RoleSpecificInit` で適切に設定することで、役職の基本的な能力を定義できます。

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

low

CanUseAdminUseVentSingleRoleBase.cs の実装では virtual プロパティではなくフィールドとして定義されているため、表現を「フィールドやプロパティ」に修正することを推奨します。

Suggested change
`SingleRoleBase` は多くの `virtual` プロパティ(`CanUseAdmin`, `UseVent` など)を持っています。これらをコンストラクタや `RoleSpecificInit` で適切に設定することで、役職の基本的な能力を定義できます。
SingleRoleBase は多くのフィールドやプロパティ(CanUseAdmin, UseVent など)を持っています。これらをコンストラクタや RoleSpecificInit で適切に設定することで、役職の基本的な能力を定義できます。

@extremeroles-actionsbot

Copy link
Copy Markdown

GitHub Actions MSBuilds

  • Build Result : success

Translation Checker Report

  • FileName:Combination.zh-Hans.resx
Languages Missing TransKeys
SChinese GuesserGuessDefaultRoleMode
SChinese GuesserCanCrewmate
SChinese GuesserCanImpostor
SChinese GuesserCanDove
SChinese GuesserCanMilitant
  • FileName:Combination.zh-Hant.resx
Languages Missing TransKeys
TChinese GuesserGuessDefaultRoleMode
TChinese GuesserCanCrewmate
TChinese GuesserCanImpostor
TChinese GuesserCanDove
TChinese GuesserCanMilitant
  • FileName:ExtremeSkinsTransData.xlsx
Languages Missing TransKeys
English whisky
English geranium
English fuchsia
English safeBlue
SChinese whisky
SChinese geranium
SChinese fuchsia
SChinese safeBlue
TChinese errorCannotGameStart
TChinese errorNotInstalled
TChinese errorOldInstalled
TChinese errorNewInstalled
TChinese errorDiffHostVersion
TChinese innerslothMake
TChinese enableCreatorMode
TChinese disableReadyCreatorMode
TChinese enableReadyCreatorMode
TChinese kusaZunGreen
TChinese darkRed
TChinese mediumVioletRed
TChinese mediumPurple
TChinese rosyBrown
TChinese darkMagenta
TChinese olive
TChinese steelBlue
TChinese dodgerBlue
TChinese darkSeaGreen
TChinese sikon
TChinese konjou
TChinese vermilion
TChinese ivyGreen
TChinese tilleul
TChinese ivory
TChinese kenpou
TChinese grisbleu
TChinese melon
TChinese clan
TChinese Shiraaiiro
TChinese whitePink
TChinese thinPurple
TChinese sienna
TChinese lightAvocado
TChinese lightIwaitya
TChinese diardRed
TChinese diardGreen
TChinese diardBlue
TChinese chaos
TChinese inverted
TChinese oddGreen
TChinese tigr
TChinese kigi
TChinese whisky
TChinese geranium
TChinese fuchsia
TChinese safeBlue

@yukieiji yukieiji merged commit 07148c3 into develop/next-release May 17, 2026
4 checks passed
@yukieiji yukieiji deleted the fix-role-docs-technical-ref-4377101141010160149 branch May 17, 2026 07:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant