テンプレート変数
ステップのテキストに使える変数、その値と値を提供するトリガーの一覧
{name} のように波括弧で変数を書くと、ステップの実行時に Vfinity が値を挿入します。たとえば ありがとう、{name}さん。{gift}をありがとう！ は、視聴者 Mika さんがバラを贈ると「ありがとう、Mika さん。バラをありがとう！」になります。
複数のトリガーで使える変数
| 変数 | 値 | 対応するトリガー |
|---|---|---|
{name} | 視聴者の表示名。なければ @ハンドル | 視聴者を特定できるもの |
{nickname} | 視聴者の表示名 | 視聴者を特定できるもの |
{uniqueId} | @ を除いた視聴者のハンドル | 視聴者を特定できるもの |
{points} | 費用を差し引いた後の視聴者のポイント残高 | 視聴者を特定できるもの |
{trigger} | API トリガーの名前、または gift や chat などトリガーの種類 | すべて |
{gift} | ギフト名 | ギフト |
{count} | ギフトのコンボ数、またはいいね数 | ギフト、いいね |
{diamonds} | ギフト 1 個のダイヤ価値 | ギフト |
{totalDiamonds} | コンボ全体の価値。ダイヤ × 個数 | ギフト |
{likes} | このイベントのいいね数 | いいね |
{totalLikes} | ルームの累計いいね数 | いいね、ルームのいいね目標達成 |
{comment} | チャットのメッセージ、またはギフトや報酬に添えられたメッセージ | チャットメッセージ、この配信での初コメント、ギフト、Twitchチャンネルポイント |
{args} | コマンドの後のテキスト全体 | チャットメッセージ |
{arg1}～{arg9} | コマンドの後の 1～9 番目の単語、または正規表現のキャプチャー | チャットメッセージ |
ポイント残高はプラットフォームごとに分かれます。同じ名前でも TikTok LIVE と Twitch では別の残高です。
個別のトリガーで使える変数
| 変数 | 値 | トリガー |
|---|---|---|
{months} | サブスクの月数、または YouTube のメンバーである月数 | サブスク |
{rewardName}、{rewardCost} | 報酬のタイトルと、そのチャンネルポイントでの消費量 | Twitchチャンネルポイント |
{rewardId}、{redemptionId} | Twitch での報酬の ID と、今回の交換の ID | Twitchチャンネルポイント |
{viewers} | レイドで来た人数、またはルームの視聴者数 | レイド、視聴者数マイルストーン |
{followers} | フォロワー数 | フォロワー数マイルストーン |
{coins} | 宝箱に入れたコイン数 | 宝箱 |
{emoteUrl} | 最初のエモート画像の URL | サブスクライバーエモート |
{questionText} | 質問文 | LIVE 質問 |
{phase}、{level}、{total} | ハイプトレインの段階、レベル、合計 | ハイプトレイン |
{value}、{target}、{cycle} | ゴールの進捗、目標値、繰り返しゴールの回数 | オーバーレイの目標達成 |
{result} | ルーレットの結果 | ルーレットの結果 |
{winner}、{tickets}、{entrants} | 当選者名、その人のチケット数、参加人数 | プレゼント企画の当選者 |
{team}、{score}、{otherScore} | 勝ったチーム、その得点、相手の得点 | 綱引きの勝利 |
{level}、{levelName} | 到達したレベルの番号と名前 | 盛り上がりレベル到達 |
プレゼント企画の当選者 は当選者を視聴者として扱うため、{name} も使えます。ギフト では、{comment} に Twitch の Cheer、Kicks のギフト、YouTube のスーパーチャットに添えられたメッセージ、または視聴者が報酬のために入力したテキストが入ります。
API トリガーのフィールド
API トリガー は、送信された data の最上位フィールドが文字列・数値・真偽値なら変数として使えます。最大 50 個までで、入れ子のオブジェクトは対象外です。{"name":"raid_alert","data":{"user":"Mika"}} を送れば、ステップで {user} を使えます。
バトル、TikTok LIVE ゴール、LIVE 質問、Super Fan も TikTok の最上位フィールドを同じ方法で公開します。バトルの {outcome} や LIVE ゴールの {description} と {progress} などです。
変数を使える場所
| ステップ・場所 | フィールド | 挿入方法 |
|---|---|---|
| テキストを読み上げる | 読み上げるテキスト | TTS のフィルターを通した発話テキスト |
| OBS を操作 の テキストソースに書き込む | テキスト | プレーンテキスト |
| HTTP Webhook | URL / アクション ID | パスとクエリだけでパーセントエンコード |
| HTTP Webhook | JSON ボディ / 引数 | JSON の文字列値の中 |
| Streamer.bot アクション | JSON ボディ / 引数 | JSON の文字列値の中 |
| アプリコマンド | 値 または 値（JSON） | 文字列値の中 |
Webhook は入力したホストにだけ送られます。変数はパスとクエリを変更できますが、サーバーは変更できません。JSON では文字列値のみ置換されるため、視聴者のメッセージでフィールドを増やしたり構造を壊したりできません。
値の埋め込み方
- 値がない変数、たとえばフォローでの
{gift}は空になります。 - Vfinity が知らない
{banana}のような名前は、そのまま残ります。 - 発話やプレーンテキストでは改行をスペースに置き換え、制御文字を削除します。値 1 つの上限は 500 文字です。
- 置換は 1 回だけです。視聴者名が文字どおり
{name}なら、そのまま表示されます。 - 大文字と小文字を区別します。
{Name}は{name}と異なります。
アラートのテキスト
アラートカードの カスタムメッセージ には、イベントではなくアラートから値を得る独自のプレースホルダーがあります。
| プレースホルダー | 値 |
|---|---|
{name} | 送り主。アクセント色で表示 |
{gift}、{count} | ギフト名と個数 |
{diamonds}、{totalDiamonds} | ギフト 1 個とコンボ全体の価値 |
{likes}、{totalLikes} | 超えたいいねのマイルストーンとルームの累計 |
{months} | サブスクの月数 |
{viewers} | レイドで来た人数 |
アラートで値のないプレースホルダーは 0 または空で表示されます。読み上げる文章はカードに表示される文章と同じです。
