Skip to content

通信データ Chat

torgtaitai edited this page Jun 1, 2016 · 4 revisions

チャット関係のコマンド。

sendChatMessage

チャット発言用。

入力

  • senderName
    発言者の名前。現状の「どどんとふ」クライアント上では、「(発言者名)\t(立ち絵名)」で管理されています。立ち絵を使っていない発言では「発言者名」のみが格納されます。
  • message
    チャット内容。単純なテキストです。
  • channel
    「どどんとふ」のチャットウィンドウに複数並ぶタブのインデックス番号をソースコード上は「channel」と呼んで管理しています。0~(タブ数-1)の値を取ります。
  • color
    チャットの文字の色。16進数表記の文字列6文字になります。(例:"FFFFFF")
  • uniqueId
    発言者のユーザー識別ID。

出力

無し。

sendDiceBotChatMessage

ダイスロール時ののチャット発言用。

入力

  • name
    発言者の名前
  • state
    立ち絵情報
  • message
    発言内容。
  • channel
    チャットのタブ・インデックス。
  • color
    チャットの文字の色。16進数表記の文字列6文字になります。(例:"FFFFFF")
  • uniqueId
    発言者のユーザー識別ID。
  • sendto
    秘話の場合に使用する、送信先相手のユーザー識別ID。秘話で無い場合は指定しない。
  • randomSeed
    ダイスロール時の乱数シード。現在の実装では使用してません。
  • repeatCount
    指定したダイスロールを何回連続して行うかの指定。
  • gameType
    ダイスボットのタイトル指定。
  • isNeedResult
    現状では、常にtrueを渡す必要がある。必須。しかし過去の遺物…?

出力

  • シークレットロールではない場合
    戻り値はnil

  • isSecret
    シークレットロールの場合、true。 (そしてシークレットロールの場合はfalse、というか出力自体がnil…ってことはこの要素は不要では?) そしてシークレットロールの場合は以下の要素が含まれまsう。

  • 入力データ全て
    大前提として、送付した入力データが全て出力に含まれます。

  • message
    messageの内容は入力データから更新され、ダイスのロール結果を含む文字列になります。

sendChatMessageAll

サーバの管理用に使用する、全部屋への一括メッセージ送信機能。

入力

  • senderName
    発言者の名前。
  • message
    送信するメッセージ
  • password
    config.rb で定義されている、メンテナンス用パスワード $mentenanceModePassword を設定。合致しない場合は送信できません。
  • channel
    送信先のチャットタブのインデックス。基本0です(全部屋で確実に存在する番号とする必要があるため)
  • color
    チャットの文字の色。16進数表記の文字列6文字になります。(例:"FFFFFF")
  • uniqueId
    発言者のユーザー識別ID。

出力

  • result
    処理が正しく行われた場合は "OK"。それ以外はエラー文字を返します。
  • rooms
    メッセージ送信を送った部屋の番号のリスト。

deleteChatLog

ログインしている部屋のチャットの全ログを削除するコマンド。

入力

なし。 (デフォルトで部屋番号は送信されるため)

出力

  • result
    処理が正しく行われた場合は "OK"。それ以外はエラー文字を返します。