TVML言語規則概略

//! TVML Version 3.1

■改行で区切られた一行がひとつのイベントに対応する。１行分のイベントを実行し、そのイベントが終了したら次の行に記述されたイベン トを実行する。

■イベント書式は以下

イベントタイプ: コマンド名( arg1 = data1, arg2 = data2 , arg3 =data3, ...... )

・イベントタイプは次の11種類ある

character, camera, set, prop, light, movie, super, sound, drawing, video, cgenv

・コマンドの引数内のargは順不同
・コマンド引数において、dataを省略または引数そのものを省略するとデフォルトの値が採用される

■イベントには、イベントが始まって終わるまでの動作に時間がかかる行為イベント（例：座る）と、状態を変えるだけで経過時間がゼロな 状態イベント（例：スーパーオフ）の２種類ある。ふたつの行為イベントを同時に実行させたい時は、行為イベントのコマンド引数にwait=noをつけ加え て行為イベントのイベント終了待ちをしないようにする。例えばBobとMaryを同時におじぎさせ、おじぎが終わってからスーパーしたいときは次のように なる

character: bow( name=Bob, wait=no )
character: bow( name=Mary )
super: on( text = "MARY & BOB" )

したがって、引数中にwaitを持つものは行為イベント、waitを持たないものは状態イベントである。

■イベントには、以下のウェイトコマンドを持つものがある。ウェイトコマンドはコマンドの動作が終わるまで待ち、終わったらリターンす る。ウェイトコマンドは主にコマンドにおいてwait=noに設定した時に、そのコマンド動作が終わるのをチェックするために用いる。ウェイトコマンドの 書式は以下。

イベントタイプ: wait_コマンド名( arg1 = data1, arg2 = data2 , arg3= data3, ...... )

・コマンドの引数内のargは順不同
・コマンド引数において、dataを省略または引数そのものを省略するとデフォルトの値が採用される

■イベント以外の制御としてダイレクトコマンドがある。書式は以下。

コマンド名( arg1 = data1, arg2 = data2 , arg3 = data3,...... )

・コマンドの引数内のargは順不同
・コマンド引数において、dataを省略または引数そのものを省略するとデフォルトの値が採用される

■//以降は行末までコメントとみなされる

■/* と */ で囲まれた部分はコメントとみなされる

パラメータ の扱いについて

１．パラメータ書式の種別

(1) "arg=data"　　　 ：指定

dataで指定した値がパラメータargに入る
例：speed = 2.5（パラメータspeedに値2.5が入る）

(2) "arg=*"　　　　 ：デフォルト指定

パラメータargにデフォルト値が入る。*は予約語
例：speed = *（パラメータspeedにデフォルト値が入る。、この場合は1.0が入る）

(3) ""　　　　　　　　 ：省略

基本的に省略されたパラメータのデフォルトの値が入るので(2)と同様だが、一部のコマン ドで振る舞いが異なる場合もある（例：camera:move）。個別のコマンドリファレンス記述を参照。

２．パラメータの種類

（１）省略不可能パラメータ

省略することができないパラメータ。従ってデフォルト値は持たない。書式上は指定のみで、 省略およびデフォルト指定がされた時はエラーを出し、その行を無視（ スキップ）する。

　　　例：name （名前は必ず指定する）

（２）省略可能パラメータ

省略することができるパラメータ。書式上では、指定、デフォルト指定、省略すべてが可であ る。

コマンドリファレンス

コマンドリファレンスにおけるパラメータの扱いについて

• 引数で下線のあるものは必須パラメータです。
• パラメータの値の下線はデフォルト値です。
• コマンドによっては「追加パラメータ」が用意されていますが、これは通常のパラメータとまったく同じ扱いです。
  

1 CG キャラクターコマンド

character:openmodel( model, filename )
CGキャラクタのモデリングデータをオープンする

パラメータ

character:casting( name, model )
モデルを指定してキャラクタを作成する

パラメータ

解　説

character:setvoice( name, voicetype, adjlevel, adjlpf )
キャラクタの声質を指定する

パラメータ

name: キャラクタ名
voicetype: 音声合成ソフトの声質名を指定する。声質名については後述。ダブルクオーテーションで囲んで指定する
adjlevel: 口パク用の音圧レベルに対する感度を指定。defaultはシステムが指定する値
adjlpf: 口パク用の音声信号にかけるローパスフィルタの係数を指定する。0.0から1.0までの値で、0.0に近づくほどフィルタのかかりが悪く、1.0に近づく ほど深くかかる。LPFが深くかかると口パクが滑らかになり「もったり」する感じになる。defaultはシステムが指定する値

追加パラメータ

解　説

・現在のT2V onUNITYで使用できる声質名は以下の通り
　　日本語：
　　　VoiceSommelier:Voice06　：　日立製"ボイスソムリエ"、落ち着いた大人の女性
　　　VoiceSommelier:Voice07　：　日立製"ボイスソムリエ"、女性、ふつう
　　　VoiceSommelier:Voice08　：　日立製"ボイスソムリエ"、若い女性
　　　VoiceSommelier:Voice09　：　日立製"ボイスソムリエ"、男性、朗読調
　　　VoiceSommelier:Voice10　：　日立製"ボイスソムリエ"、若い男性
　　　OpenJTalk:Voice01　：　フリーソフト"Open JTalk"、男性
　英語：
　　　FLite:Voice01　：　フリーソフト"Flite (festival-lite)"、女性

・声質は混在して使うことができる
・setvoiceで設定したspeed, pitch, intonationなどのパラメータはスクリプト全体に渡って有効なので、ここでキャラの声を作っておき、talkコマンドでしゃべらせるとよい

character:visible( name, switch )
キャラクタの表示・非表示

パラメータ

character:position( name, x, y, z, rx, ry, rz, scale, posture )
キャラクタを配置する

パラメータ

解　説

character:talk( name, text, lipsync, caption, speed, pitch, intonation, volume, param0, paramtype, wait )
キャラクタをしゃべらせる

パラメータ

ウェイトコマンド

解　説

character:talkfile( name, filename, lipsync, caption, wait )
音声データファイルでキャラクタをしゃべらせる

パラメータ

ウェイトコマンド

解　説

character:gesture( name, switch, type, speed, degree )
しゃべりのジェスチャー

パラメータ

character:walk( name, x, z, step, speed, stride, raise, wait )
歩く

パラメータ

追加パラメータ

ウェイトコマンド

character:step( name, x, y, z, speed, raise, wait )
一歩で目的座標に移動

パラメータ

追加パラメータ

ウェイトコマンド

character:stop( name, wait )
歩いているキャラクタを止める

パラメータ

ウェイトコマンド

character:sit( name, speed, wait )
座る

パラメータ

追加パラメータ

ウェイトコマンド

character:stand( name, speed, wait )
座っているキャラクタを立ち上がらせる

パラメータ

ウェイトコマンド

character:turn( name, d, speed, wait )
キャラクタの向きを変える

パラメータ

ウェイトコマンド

character:bow( name, speed, level, type, wait )
おじぎをする

パラメータ

name: キャラクタ名
speed: おじぎの速さ。デフォルトに対する速度比　default: 1.0
level: おじぎの深さ。頭が下がりきった位置での角度（度）。負にするとのけぞる　default: 30度
type = normal（普通）、casual（頭だけ）
wait = yes, no

ウェイトコマンド

character:look( name, target, speed, type, track, wait )
指定した対象を見る

パラメータ

ウェイトコマンド

character:gaze( name, rx, ry, rz, speed, type, wait )
指定した方向を見る

パラメータ

ウェイトコマンド

character:jump( name, x, y, z, d, height, speed, mode, wait )
指定位置までジャンプする

パラメータ

ウェイトコマンド

character:action(name, action, speed, wrapmode, layer, wait)
キャラクタアニメーションを再生する

パラメータ

解　説

ウェイトコマンド

character:shake( name, switch, degree )
ふるえる

パラメータ

character:openmouth( name, switch, degree, speed, wait)
口を開ける

パラメータ

ウェイトコマンド

character:expression( name, type, degree, speed, wait )
顔の表情を変える

パラメータ

name: キャラクタ名
type = neutral, happy, fear, angry, sad, surprise, disgust
degree: 表情の強さ。デフォルトに対する倍数。0.0のとき表情強度がゼロ、1.0で最大。　default: 1.0
speed: 表情への移行スピード　default: 1.0　　単位sをつけると動作にかかる時間（秒）を指定
wait = yes, no

ウェイトコマンド

character: wait_expression( name )

解　説

・このコマンドは、表情をサポートするキャラクタにのみ有効。表情をサポートしていないキャラクタでは無視される。
・typeに指定する表情予約語はサポートされているもののみ動作する

character:pose( name, pose, speed, type,wait )
ポーズの実行

パラメータ

name: キャラクタ名
pose: defineposeで定義した実行したいポーズ名を指定。ポーズをやめる、いわゆる「なおれ」をしたい場合はpose =default とする。したがってposeの名前において default は予約語
speed: デフォルトに対する速度、および動作にかかる時間（秒）を指定する　default: 1.0 　　単位sをつけると動作にかかる時間（秒）を指定（type=uniform, gravityのみ）
type = servo（通常）, uniform（等速）, gravity（重力）

解　説

・typeのservoは「速いスタート・スローストップ」、uniformは等速、gravityは落下運動のシミュレートで「ス ロースタート・急ストップ」
・speedについては、type=servoのときはデフォルト速度に対する比のみ、type=uniform, gravityのときは動作時間のみしかサポートしていないので注意

ウェイトコマンド

character:definepose( name, pose, joint, rx, ry, rz, mx, my, mz, relative )
ポーズの定義

パラメータ

Root（腰の基点位置）
LeftThigh（左太もも）
LeftShin（左すね）
LeftFoot（左足）
RightThigh（右太もも）
RightShin（右すね）
RightFoot（右足）
Hip（お尻）　
Chest（胸）
LeftUpperArm（左上腕）
LeftLowerArm（左前腕）
LeftHand（左手）
RightUpperArm（右上腕）
RightLowerArm（右前腕）
RightHand（右手）
Neck（首）
Head（頭）
Jaw（下あご）
RestOfAll（直接指定されていないjointについて一括して値をセットする）

解　説

・rx, ry, rz, mx, my, mzに *を指定すると、当コマンドdefineposeを発行した時点に実際にキャラクタが行っている姿勢の値をパラメータに記憶する。これとjoint= RestOfAll を使うとキャラクタの姿勢を記憶することができる。
例：
character: definepose(name=Bob, posename=snap, joint=RestOfAll, rx=*,ry=*, rz=*, mx=*, my=*, mz=*)
で記憶し、
character: pose(name=Bob, posename=snap)
で呼び出す。
・指定されないjointがある場合、そのjointに対しては何もしない

character:sequencepose( name, sequencepose, speed, wait )
連続ポーズの実行

パラメータ

ウェイトコマンド

character:definesequencepose( sequencepose, pose, speed, type)
連続ポーズの定義

パラメータ

解　説

character:openmocap( motion, filename )
モーションキャプチャーデータファイルをオープンする

パラメータ

motion: モーションキャプチャーデータに名前をつける
filename: モーションキャプチャーデータファイル名をダブルクオーテーションで囲んで指定する

解　説

character:mocap( name, motion, preresettime, resettime, stopmode, from, to, ydiff, jointignored, wait )
モーションキャプチャーデータの実行

パラメータ

name: キャラクタ名
motion: openmocapでつけたモーションキャプチャーデータ名を指定する
preresettime: 現在のポーズからモーションキャプチャーデータの最初のポーズへの移行の時間（秒） default: 1.0
resettime: モーションキャプチャーデータの最後のポーズからデフォルトポーズへ戻る移行の時間（秒） default: 1.0
stopmode = reset（最後にデフォルトポーズに戻る）、remain（モーションキャプチャー データの最後のポーズのまま止まる）
from: 再生開始フレームの指定　defualt=-1（先頭フレームから再生）
to: 再生終了フレームの指定　defualt=-1（最終フレームで停止）
ydiff = on, off: モーションキャプチャーデータのy軸の値について、開始フレームからの差分のみを適用するかどうかのフラグ。on：差分のみ適用、off：絶対位置を適 用。デフォルトはoff
jointignored: モーションキャプチャーデータで動かしたくないjoint名を指定する。joint名は'+'で連結して複数記述できる。（例：jointignored =LeftUpperArm+LeftLowerArm）

Root（腰の基点位置）
LeftThigh（左太もも）
LeftShin（左すね）
LeftFoot（左足）
RightThigh（右太もも）
RightShin（右すね）
RightFoot（右足）
Chest（胸）
LeftUpperArm（左上腕）
LeftLowerArm（左前腕）
LeftHand（左手）
RightUpperArm（右上腕）
RightLowerArm（右前腕）
RightHand（右手）
Neck（首）
Head（頭）
LowerBody（下半身のすべてのjointの一括指定）

ウェイトコマンド

character: wait_mocap(name)

character:move( name, x, y, z, rx, ry, rz, speed, wait )
キャラクタを移動する

パラメータ

ウェイトコマンド

character: wait_move(name)

2 カメラコマンド

camera:switch( name )
指定カメラにスイッチングする

パラメータ

解　説

camera:position( name, x, y, z, rx, ry, rz, vangle )
カメラを指定位置に設定する

パラメータ

camera:move( name, x, y, z, rx, ry, rz, vangle, speed,type, transition, wait )
カメラを指定位置に動かす

パラメータ

解　説

ウェイトコマンド

camera:closeup( name, target, speed, dolly, track, type, transition, wait )
対象物をクローズアップ

パラメータ

追加パラメータ

解　説

・dollyをonにすると、対象物の真正面へカメラを移動し、角度と画角を自動調整してクローズアップします。dollyをoffに すると、カメラの位置はそのままで角度と画角を自動調整してクローズアップします。
・クローズアップのアングルを修正したいとき、従来はadjx, ady,...adjvangleを使っていましたが、今後はadjpan, adjtilt, adjzoomを使うことを推薦します。機能は以下の通りです。
adjzoom: デフォルトは1.0で、被写体のサイズの倍数を指定する。（例：　adjzoom=2.0にすると、2倍の大きさに写る）
adjpan: 画面の幅が1.0に相当。0.5のとき中央被写体が右のふちに写る（プラスが左振り方向）
adjtilt: 画面の高さが1.0に相当。0.5のとき中央被写体が上のふちに写る（プラスが下振り方向）
以上、被写体の大きさに連動して機能するので、汎用性が高い。
・speedについては、type=servoのときはデフォルト速度に対する比のみ、type=uniform, gravityのときは動作時間のみしかサポートしていないので注意

ウェイトコマンド

camera:twoshot( name, target1, target2, speed, dolly, track, type, transition, wait )
２つの対象物をツーショットにする

パラメータ

追加パラメータ

解　説

ウェイトコマンド

camera:catch( name, target, dolly, speed, track,wait )
対象物をフォローする

パラメータ

追加パラメータ

ウェイトコマンド

camera:revolve( name, target, x, y, z, ry, speed, wait )
対象物を中心に回転する

パラメータ

ウェイトコマンド

解　説

・ターゲット上空から見て半時計回りに回転する。
・カメラ方向についてはryが回転するのみでrx、rzは動かない。
・今のところ、中心座標のyの値は使っていない。

camera:stop( name )
動いているカメラを止める

パラメータ

name: カメラ名を指定 default: Acam 

3 CGスタジオセットコマンド

set:openmodel( name, filename )
セットのモデリングデータをオープンする

パラメータ

set:change( name )
セットをチェンジする

パラメータ

name: セット名を指定。 name=NULLとすることで、セットを何も表示しないようにできる。

set:position( name, x, y, z )
セットの位置を指定する

パラメータ

set:action(name, action, speed, wait)
セットのアニメーションを再生する

パラメータ

解　説

ウェイトコマンド

4 CG小道具コマンド

prop:openmodel( name, filename )
小道具のモデリングデータをオープンする

パラメータ

prop:position( name, x, y, z, rx, ry, rz, scale )
小道具を配置する

パラメータ

prop:visible( name, switch )
小道具の表示・非表示

パラメータ

prop:openimageplate( name, filename, hsize, vsize, aspect)
イメージプレートを作成する

パラメータ

解　説

prop:openmovieplate( name, moviename, hsize, vsize )
ムービープレートを作成する

パラメータ

解　説

prop: attach(name, target, joint, switch, x, y, z, rx, ry, rz, scale )
propを指定キャラクタの指定jointにくっつける、または別のpropにくっ つける

パラメータ

解　説

prop: move( name, x, y, z,rx, ry, rz, scale, tspeed, rspeed, sspeed, wait )
小道具の移動

パラメータ

解　説

ウェイトコマンド

prop: wait_move( name)

prop:action(name, action, wait)
小道具のアニメーションを再生する

パラメータ

解　説

ウェイトコマンド

5 CG照明コマンド

light:flat( name, r, g, b, vx, vy, vz )
平行光を一つ点ける

パラメータ

light:point( name, r, g,b, x, y, z, constant, linear, quadratic )
点光源を一つ点ける

パラメータ

解　説

点光源とスポットライトについては、物体が遠方に行くほど光量が落ちる減衰光が利用できます。パラメータ constant,linear, quadratic によって、光の減衰率に関する３つの係数を指定でき、このとき減衰率は以下の式に従います。
　　　　　 　　１
--------------------
k + d * k1 + d * d * k2
　　　ここで、d=光源と物体の距離、k(=constant)、k1(=linear)、k2(=quadratic)
通常の実世界での光源減衰式は 1/(d*d)になるのですが、CG表示で用いている近似計算においては、これで計算すると暗くなりすぎるので、3つの係数で光源減衰率が指定できるよう になっています。TVMLにおけるディフォルト状態では、 k=1、 k1=0、 k2=0なので、無限遠まで減衰しない光源になります。実世界に近いのは前述のとおり k=0、 k1=0、 k2=1 ですが、これで暗いときは、kと k1 を加減してください。詳しくは OpenGL のドキュメントを参照してください。

light:spot( name, r, g, b, x, y, z, vx, vy, vz, cutoff,constant, linear, quadratic )
スポットライトを一つ点ける

パラメータ

解　説

パラメータ constant,linear, quadratic については点光源と同一です。
スポットライトは、物体の頂点に対してシェーディングされるため、荒いポリゴンのモデルに対しては、あまり効果が期待できません。

light:ambient( name, r, g, b )
環境光を指定する

パラメータ

解　説

light:switch( name, switch )
照明をオンオフする

パラメータ

name: 照明の名前
switch = on, off

6 ムービーコマンド

movie:open( name, filename )
ムービーファイルをプリオープンする

パラメータ

name: ムービーに名前をつける
filename: ムービーデータファイル名をダブルクォーテーションで囲んで指定（使用できるフォーマットはogvのみ。TVMLスクリプトからの相対パス、または絶対パスで指定する）

解　説

movie:play( name, from, to, speed, repeat, wait )
プリオープンムービーを再生する

パラメータ

ウェイトコマンド

movie: stop( name)
再生しているムービーを停止する

パラメータ

name: open()でオープンされたムービー名。nameを省略するとplayfileのムービーに作用します。

解　説

movie:pause(name )
再生しているムービーをポーズする

パラメータ

解　説

movie:resume(name )
ポーズしているムービーを再開する

パラメータ

解　説

movie:goto( name, time )
指定時間へ飛ばす

パラメータ

解　説

プリオープンのみのサポートです。

7 スーパーイン ポーズコマンド

super:on( text, x, y )
簡易スー パーを表示する

パラメータ

解　説

super:off( )
簡易スーパーを消去する

8 サウンドコマン ド

sound:open( name, filename )
オーディオファイルをプリオープンする

パラメータ

name: オーディオの名前をつける
filename: オーディオファイル名をダブルクォーテーションで囲んで指定する （使用できるフォーマットはwav, oggのみ。TVMLスクリプトからの相対パス、または絶対パスで指定する）

sound:play( name, from, to, repeat, wait )
プリオープンオーディオを再生する

パラメータ

ウェイトコマンド

sound:stop( name )
再生中のオーディオを停止する

パラメータ

sound:pause( name )
再生中のオーディオをポーズする

パラメータ

解　説

sound: resume( name )
ポース中のオーディオを再開する

パラメータ

解　説

sound:goto( name, time )
指定時刻へ飛ばす

パラメータ

解　説

sound:fade( name, level, speed, wait )
指定されたレベルにフェードする

パラメータ

ウェイトコマンド

解　説

sound:level( name, level )
指定されたレベルに変える

パラメータ

解　説

9 ドローイングコ マンド

drawing:openbase( name ,x, y, refmode, height, width, layer, color ) 
2Dベースプレーンを作る

パラメータ

解　説

drawing:settext( name ,text, parent, x, y, refmode, height, width, align, overtext, language,basecolor, halftone)
2Dプレーンにテキストをセットする

パラメータ

解　説

drawing:setimage( name, filename,parent, x, y, refmode, height, width, align, aspect )
2Dプレーンにイメージをセットする

パラメータ

解　説

drawing: display( name,switch )
2Dプレーンを表示／非表示する

パラメータ

解　説

drawing:position( name ,x, y, layer) 
2Dプレーン位置を指定する

パラメータ

解　説

drawing:move( name ,x, y, speed, wait ) 
2Dプレーンを動かす

パラメータ

ウェイトコマンド

解　説

drawing:stop( name ) 
動いている2Dプレーンを止める

パラメータ

10 ビデオエフェクトコマンド

11 CGエフェクトコマンド

cgenv:bgcolor( r, g, b)
CGのオブジェクトの無い背景の色を指定する

パラメータ

12 ダイレクトコマンド

wait( time )
指定した時間待ち、リターンする

パラメータ

setcaption( switch, displaytime, color, font, fontsize, x, y, height, width,border, borderwidth, bordercolor)
字幕スーパーのセットアップ

パラメータ

switch = on, off: 字幕をオンオフ
displaytime: 字幕の表示時間を指定（秒）-1のとき出っぱなし default: -1 （注：現在未サポート）
color: 字幕の色を指定 default: ffffff（白）
font: フォントを指定する 
fontsize: フォントサイズを指定する 
x, y: 表示エリアの位置（%）　
height, width: 表示エリアの高さと幅（%） 
border = on, off: 字幕の縁取りをオンオフ
borderwidth: 字幕の縁取りの幅(pixel)
bordercolor: 字幕の縁取りの色を指定 default: 000000（黒）

解　説

skipscript( switch )
TVMLスクリプトをスキップする

パラメータ

解　説

end()
スクリプト再生を終了する

解　説

reset()
TVMLプレイヤーをリセットする

解　説

captionout()
表示されている字幕スーパーを消す

解　説