概要

チャットコマンドを実行しアクティブユーザーの名前をチャットに表示する Rust 用プラグインを作成します。

参考情報

• Plugin lifecycle
• Writing your first plugin

関連情報

• Rust のサーバーを構築する
• VSCode に Rust の Mod の開発環境を構築する

プラグインの実装方法

ActivePlayers.cs ファイルを作成し、アクティブユーザーの名前をチャットに表示するチャットコマンドを実装します。

1. メソッド ActivePlayersCommand を実装します。

           void ActivePlayersCommand(BasePlayer player, string command, string[] args)
           {
   
           }
   

   メソッドは次の引数を受け取ります。

   • player: コマンドを呼び出したBasePlayer
   • command: 呼び出されるコマンド
   • args: コマンドに続くオプションの追加引数の配列

2. アノテーション ChatCommand でチャットコマンドを指定します。

           [ChatCommand("activeplayers")]
   

3. BasePlayer.activePlayerList でアクティブユーザーを取得し、その名前を PrintToChat でチャットに出力します。

               foreach (BasePlayer activePlayer in BasePlayer.activePlayerList)
               {
                   PrintToChat(player, $"Active Player: {activePlayer.displayName}");
               }
   

4. 全てのソースコードは次の通りです。

   namespace Oxide.Plugins
   {
       [Info("Active Players", "Unknown Author", "0.1.0")]
       [Description("This plugin displays all active usernames in the chat.")]
       class ActivePlayers : RustPlugin
       {
           void Init()
           {
           }
   
           [ChatCommand("activeplayers")]
           void ActivePlayersCommand(BasePlayer player, string command, string[] args)
           {
               foreach (BasePlayer activePlayer in BasePlayer.activePlayerList)
               {
                   PrintToChat(player, $"Active Player: {activePlayer.displayName}");
               }
           }
       }
   }
   

プラグインの動作確認

1. ActivePlayers.cs ファイルをサーバーの oxide/plugins フォルダにコピーします。

2. サーバーを起動します。

3. Rust を起動してサーバーに接続します。

4. チャットに /activeplayers を入力します。