こんにちは。
のちたままです。
今回はStreamElementsのカスタムコマンドで使えるsender変数について解説します。
sender変数の基本
sender変数はコマンドを打った人を指定する変数です。
コマンドの応答内容にsender変数を入れることで、コマンド打った人の情報を表示することができます。
基本的な書き方は以下の通りです。
- 記述例：$(sender)
- 結果例：のちたまま
sender変数はuser変数に似ています。
user変数は引数なしだとsender変数と同じようにコマンドを打った人の情報を表示できます。
しかし、user変数は引数にユーザー名を指定することで特定のユーザーに関する情報を表示できます。
user変数に関しての詳しい情報は以下の記事を参考にしてください。
sender変数の応用
sender変数は基本的な書き方以外にも、ユーザーの詳しい情報を表示できるようにいくつかの書き方があります。
以下に一覧を表示します。
項目名から詳細に飛べるのでご活用ください。
| 書き方 | 内容 |
|---|---|
| sender.name | ユーザー名を小文字で表示 |
| sender.points | ユーザーの持つロイヤリティポイントを表示 |
| sender.points_rank | ユーザーのロイヤリティポイントにおける現在の順位を表示 |
| sender.points_alltime_rank | ユーザーのロイヤリティポイントにおける全期間の順位を表示 |
| sender.level | ユーザーレベルの表示 |
| sender.lastmessage | ユーザーがチャットに打った最新の内容を表示 |
| sender.lastseen | ユーザーが視聴者リストやチャットに最近表示された時間を表示 |
| sender.lastactive | ユーザーが直近でチャットをした時間 |
| sender.time_online | ユーザーの合計視聴時間 |
| sender.time_online_rank | ユーザーのオンライン視聴時間における順位 |
| sender.time_offline_rank | ユーザーのオフライン視聴時間における順位 |
sender.name
sender.nameはユーザー名を小文字で表示します。
書き方と出力結果例は以下の通りです。
- 記述例：あなたの名前は$(sender.name)です。
- 結果例：あなたの名前はnochitamamaです。
sender.points
sender.pointsはユーザーの持つロイヤリティポイントの数値を表示します。
書き方と出力結果例は以下の通りです。
- 記述例：あなたのポイント数は$(sender.points)です。
- 結果例：あなたのポイント数は17860です。
sender.points_rank
sender.points_rankはユーザーのロイヤリティポイントにおける現在の順位を表示します。
書き方と出力結果例は以下の通りです。
- 記述例：あなたの順位は$(sender.points_rank)位です。
- 結果例：あなたの順位は4/647位です。
sender.points_alltime_rank
sender.points_alltime_rankはユーザーのロイヤリティポイントにおける全期間の順位を表示します。
書き方と出力結果例は以下の通りです。
- 記述例：あなたの全期間の順位は$(sender.points_alltime_rank)位です。
- 結果例：あなたの全期間の順位は1/645位です。
sender.level
sender.levelはユーザーレベルを数値で表示をします。
書き方と出力結果例は以下の通りです。
- 記述例：あなたのユーザーレベルは$(sender.level)です。
- 結果例：あなたのユーザーレベルは1500です。
僕のチャンネルで実際に打ってみたところ、ユーザーレベルの表示は以下のように割り振られていました。
- 配信者：1500
- モデレーター：500
- VIP：400
- その他：100
あくまで僕のチャンネルで打ってみた結果なので人によって変わるかもしれません。
予めご了承ください。
sender.lastmessage
sender.lastmessageはユーザーが最後に打ったチャット内容を表示します。
書き方と出力結果例は以下の通りです。
- 記述例：あなたの最後のチャットは$(sender.lastmessage)です。
- 結果例：あなたの最後のチャットは!sendです。
sender.lastmessageに関しては自身のチャットが表示されるので、おそらくコマンド名がメッセージ内容として出力されると思います。
ですので、あまり意味がないように感じています。
sender.lastseen
sender.lastseenはユーザーがチャット内ユーザーのリストもしくはチャットを打った最後の時間を表示します。
書き方と出力結果例は以下の通りです。
- 記述例：あなたが最後に現れたのは$(sender.lastseen)前です。
- 結果例：あなたが最後に現れたのは 11 mins 40 secs前です。
これは一つ前のチャット表示時間などが出るので、コマンドを打ったからと言って0秒前みたいにはならないようです。
sender.lastactive
sender.lastactiveはユーザーがチャットに現れた最後の時刻を表示します。
書き方と出力結果例は以下の通りです。
- 記述例：あなたが最後にチャットを打ったのは$(sender.lastactive)前です。
- 結果例：あなたが最後にチャットを打ったのは 1 min 14 secs前です。
これもsender.lastseen同様、一つ前のチャット時間が表示されており、0秒前にはならないようです。
sender.time_online
sender.time_onlineはユーザーのオンラインにおける合計視聴時間の表示をします。
書き方と出力結果例は以下の通りです。
- 記述例：あなたの合計視聴時間は$(sender.time_online)です。
- 結果例：あなたの合計視聴時間は 2 months 24 days 22 hoursです。
これは視聴時間の合計がどれくらいの長さになるかを表示します。
sender.time_online_rank
sender.time_online_rankはユーザーの合計視聴時間の順位を表示するものです。
書き方と出力結果例は以下の通りです。
- 記述例：あなたの合計視聴時間における順位は$(sender.time_online_rank)です。
- 結果例：あなたの合計視聴時間における順位は1/645です。
sender.time_offline_rank
sender.time_offline_rankはユーザーのオフライン視聴時間における順位を表示します。
書き方と出力結果例は以下の通りです。
- 記述例：あなたのオフライン視聴時間の順位は$(sender.time_offline_rank)です。
- 結果例：あなたのオフライン視聴時間の順位は3/617です。
組み合わせの例
それでは紹介したものの中からいくつか使用してコマンドを作ってみます。
今回は名前とロイヤリティポイント、ポイントにおける順位を2種類表示してみましょう。
以下のようにコマンドを作ってみます。
- コマンド名：!senderinfo
- 応答内容：\$(sender)のロイヤリティポイントは\$(sender.points)です。現在の順位は\$(sender.points_rank)位で、全期間における順位は\$(sender.points_alltime_rank)位です。
応答結果は以下のようになりました。
のちたままのロイヤリティポイントは17890です。現在の順位は10/647位で、全期間における順位は1/645位です。
sender.nameではなくsenderにしたのは、表示名を出すためです。
sender.nameだとユーザー名(ID)の小文字が表示されるため、今回はあえてsenderで表示させました。
おまけ
user変数との違い
sender変数の基本でも書きましたが、user変数との違いは引数が使えるかどうかしかありません。
.nameや.pointsなど応用的な書き方はuser変数と全く同じです。
引数を受け付けたくない場合はsender変数、引数を受け付ける場合はuser変数を使うといった使い分けでも良いと思います。
ただ、user変数も引数を書かなければsender変数と同じ動きをするので、user変数でも良いとは思います。
sender変数の別名
sender変数は別名として、sourceという名前でも同様の動きをします。
ですので、$(sender)と書いていたところを$(source)と書いても大丈夫です。
他にもsender.nameやsender.pointsなどをsource.nameやsource.pointsと書いてもらって大丈夫です。
最後に
今回はsender変数について詳しく紹介しました。
ユーザーが使うようなコマンドを作るときには良いかもしれませんが、user変数で代用できる部分が多いのであまり使い道は無いかもしれません。
ただ、こういう変数もあるんだと頭の片隅に置いとくといつか役に立つかもしれません。
それではまた別の記事でお会いしましょう。
Twitchにて配信活動をしています。
もし良ければチャンネルを見ていただけると嬉しいです。
その他のリンクはこちら
コメント