イメージ関数

関数一覧

ImageSetup	イメージをセットアップする
Image	イメージの表示・非表示を制御する
ImageIn	イメージをフェードインします
ImageOut	イメージをフェードアウトします
ImagePos	イメージの表示位置を設定する
ImageClear	イメージをクリアする

関数詳細

ImageSetup()

機能

イメージを表示情報をセットアップします

書式

void ImageSetup( layer, basePath, costume )

引数

引数	型	省略	規定値	詳細
layer	整数	×	―	レイヤー番号。マイナス値の場合はサイドレイヤーとなります
basePath	文字列	×	―	ベースとなるファイルパス
costume	整数	◯	-1	コスチューム番号。マイナス値の場合はイメージテーブルに記述された値が使用されます

戻り値

なし

Image()

機能

イメージの表示・非表示を制御します

書式

void Image( layer, control, fadeTime, delayTime )

引数

引数	型	省略	規定値	詳細
layer	整数	×	―	レイヤー番号。マイナス値の場合はサイドレイヤーとなります
control	文字列	×	―	レイヤー制御文字列。記述方法は備考を参照してください
fadeTime	実数	◯	0.0	フェード時間
delayTime	実数	◯	0.0	ディレイ時間

戻り値

なし

備考

control 引数はレイヤーアルファベット＋差分番号の組合せをカンマ区切りで列挙します
差分番号は省略可能です。省略した場合はゼロを指定したのと同じになります
差分番号にマイナスの値を入れた場合はそのサブレイヤーを非表示にします

例) "a, b, c3, f-1" の場合
  サブレイヤー a の差分 0 を表示
  サブレイヤー b の差分 0 を表示
  サブレイヤー c の差分 3 を表示
  サブレイヤー f を非表示にする

ImgeIn()

機能

イメージ全体をフェードインします。この関数は FadeInLayer() と同様です

書式

void ImgeIn( layer, fadeTime, delayTime, rulePath, ruleSmoothing, screenSpaceRule, ruleOffsetX, ruleOffsetY )

引数

引数	型	省略	規定値	詳細
layer	整数	×	―	レイヤー番号。マイナス値の場合はサイドレイヤーとなります
fadeTime	実数	◯	0.5	フェード時間 (秒)
delayTime	実数	◯	0.0	ディレイ時間 (秒)
rulePath	文字列	◯	null	ルール画像のアセットバンドルパス
ruleSmoothing	実数	◯	-1.0	ルールのスムーシング値。マイナス値の場合は以前に設定された値を使用されます
screenSpaceRule	真偽値	◯	false	スクリーンスペースでルールトランジションを行うか
ruleOffsetX	実数	◯	0.0	ルール画像のＸオフセット。screenSpaceRule が true の場合この値は無視されます
ruleOffsetY	実数	◯	0.0	ルール画像のＹオフセット。screenSpaceRule が true の場合この値は無視されます

戻り値

なし

注意

デフォルトではレイヤーは表示状態になっていることに注意してください。必要に応じて ImgeOut( 0.0 ) を利用してフェードイン前にフェードアウトで一旦非表示にすると上手くフェードイン処理を行えます

ImgeOut()

機能

イメージ全体をフェードアウトさせます。この関数は FadeOutLayer() と同様です

書式

void ImgeOut( layer, fadeTime, delayTime, rulePath, ruleSmoothing, screenSpaceRule, ruleOffsetX, ruleOffsetY )

引数

引数	型	省略	規定値	詳細
layer	整数	×	―	レイヤー番号。マイナス値の場合はサイドレイヤーとなります
fadeTime	実数	◯	0.5	フェード時間 (秒)
delayTime	実数	◯	0.0	ディレイ時間 (秒)
rulePath	文字列	◯	null	ルール画像のアセットバンドルパス
ruleSmoothing	実数	◯	-1.0	ルールのスムーシング値。マイナス値の場合は以前に設定された値を使用します
screenSpaceRule	真偽値	◯	false	スクリーンスペースでルールトランジションを行うか
ruleOffsetX	実数	◯	0.0	ルール画像のＸオフセット。screenSpaceRule が true の場合この値は無視されます
ruleOffsetY	実数	◯	0.0	ルール画像のＹオフセット。screenSpaceRule が true の場合この値は無視されます

戻り値

なし

注意

フェードアウト後も画像は破棄されません。不要になったイメージは ImageClear() を使用して解放しするようにしてください

ImagePos()

機能

イメージの表示位置を設定します。この関数は SetLayerPos() と同様です

書式

void ImagePos( layer, posX, posY, duration, delayTime, ease )

引数

引数	型	省略	規定値	詳細
layer	整数	×	―	レイヤー番号。マイナス値の場合はサイドレイヤーとなります
posX	実数	◯	現在値	Ｘ座標。省略した場合は現在の値となります
posY	実数	◯	現在値	Ｙ座標。省略した場合は現在の値となります
duration	実数	◯	0.0	アニメーション時間
delayTime	実数	◯	0.0	ディレイ時間
ease	列挙型	◯	"Liner"	移動アニメーションのイーズ関数を示す列挙子 (イーズ関数を参照)

戻り値

なし

ImageClear()

機能

イメージをクリアします

書式

void ImageClear( layer )

引数

引数	型	省略	規定値	詳細
layer	整数	×	―	レイヤー番号。マイナス値の場合はサイドレイヤーとなります

戻り値

なし