[ITG] Lua講座(第3回) Rateに応じてMVの再生速度を変える – Magical Love Words

やりたいこと

rateオプションで曲速度を変更した場合にMVの再生速度も合わせて変更したい

動画

ダウンロード

Lua

▼ クリックで展開

<ActorFrame><children>

	<Layer
		Type="Quad"
		OnCommand="%function(self)

		MVRate = 1.0;
		PlayerSide = 0;

		if GAMESTATE:IsPlayerEnabled(PLAYER_2) then PlayerSide = 1; end

		if GAMESTATE:PlayerIsUsingModifier(PlayerSide,'0.5xmusic') then MVRate = 0.5; end
		if GAMESTATE:PlayerIsUsingModifier(PlayerSide,'0.6xmusic') then MVRate = 0.6; end
		if GAMESTATE:PlayerIsUsingModifier(PlayerSide,'0.7xmusic') then MVRate = 0.7; end
		if GAMESTATE:PlayerIsUsingModifier(PlayerSide,'0.8xmusic') then MVRate = 0.8; end
		if GAMESTATE:PlayerIsUsingModifier(PlayerSide,'0.9xmusic') then MVRate = 0.9; end
		if GAMESTATE:PlayerIsUsingModifier(PlayerSide,'1.0xmusic') then MVRate = 1.0; end
		if GAMESTATE:PlayerIsUsingModifier(PlayerSide,'1.1xmusic') then MVRate = 1.1; end
		if GAMESTATE:PlayerIsUsingModifier(PlayerSide,'1.2xmusic') then MVRate = 1.2; end
		if GAMESTATE:PlayerIsUsingModifier(PlayerSide,'1.3xmusic') then MVRate = 1.3; end
		if GAMESTATE:PlayerIsUsingModifier(PlayerSide,'1.4xmusic') then MVRate = 1.4; end
		if GAMESTATE:PlayerIsUsingModifier(PlayerSide,'1.5xmusic') then MVRate = 1.5; end
		if GAMESTATE:PlayerIsUsingModifier(PlayerSide,'1.6xmusic') then MVRate = 1.6; end
		if GAMESTATE:PlayerIsUsingModifier(PlayerSide,'1.7xmusic') then MVRate = 1.7; end
		if GAMESTATE:PlayerIsUsingModifier(PlayerSide,'1.8xmusic') then MVRate = 1.8; end
		if GAMESTATE:PlayerIsUsingModifier(PlayerSide,'1.9xmusic') then MVRate = 1.9; end
		if GAMESTATE:PlayerIsUsingModifier(PlayerSide,'2.0xmusic') then MVRate = 2.0; end

		end"

	/>

	<Layer
		File="bga.mpg"
		OnCommand="%function(self)
			self:stretchto(SCREEN_LEFT,SCREEN_TOP,SCREEN_RIGHT,SCREEN_BOTTOM)
			self:rate(MVRate)
			self:diffusealpha(1)
			self:animate(1)
		end"
	/>

</children></ActorFrame>

説明

等速でクリアできない曲の速度を落として練習したり、トレーニングのために曲の速度を上げてプレイするなど、rateオプションによって曲の速度を変更する場合、MVは等速で再生されてしまうため曲とどんどんずれていってしまいます。
self:rate()によってMVの再生速度を制御することができるため、プレイ時のrateオプションの値を取得し制御することで、rateオプションを使用しても変わらずMVを鑑賞できるようにしたいと思います。

PlayerIsUsingModifier ( int playerNumber, string modifier )は、プレイヤーがmodifierに記述されていたオプションを使用していれば1、そうでなければ0を返すbool関数です。
Rateオプションの設定値は内部で”〇.〇xmusic”という文字列で保持されているため、0.5から2.0まで0.1刻みでチェックし、該当すればその値をMVrate変数に代入するという実装をしています。
BGAのレイヤではself:rate(MVRate)でMVの再生速度を変えています。

modifierとしてどういった値を取れるかについては、参考URLにあるLua API for OpenITG / NotITG(https://sm.heysora.net/doc/)にも記述が無いですが、オプション画面で選べる選択肢については対応するmodifierが概ねある=luaを通じて制御できるのではないかと思います。
(2020/3/13追記：modifierの一覧表を教えてもらいました。ハイスピやrate等の数値指定でないmodifierは網羅されているようです:https://sm.heysora.net/itg.txt)

ただし、modifierの中には曲中で変更できないものもあるようです(ShuffleやBlender等については再読み込みが必要)
また、曲中で見た目のハイスピを変更する(PIUでよく出現するギミック)方法については参考URLのparaphrohn’s diary(https://paraphrohn.hateblo.jp/)にて詳しく解説されています。

参考① rateオプションがOpenITGで選べない場合の対処法

OpenITG\Themes\home\metrics.iniの[ScreenOptionsMaster] [ScreenPlayerOption]に、以下を追記することでrateオプションを追加することができます。

▼ クリックで展開

[ScreenOptionsMaster]　の下の行に以下を追加
Rate=18
RateDefault=mod,1.0xmusic
Rate,1=mod,1.0xmusic;name,1.0x
Rate,2=mod,1.1xmusic;name,1.1x
Rate,3=mod,1.2xmusic;name,1.2x
Rate,4=mod,1.3xmusic;name,1.3x
Rate,5=mod,1.4xmusic;name,1.4x
Rate,6=mod,1.5xmusic;name,1.5x
Rate,7=mod,1.6xmusic;name,1.6x
Rate,8=mod,1.7xmusic;name,1.7x
Rate,9=mod,1.8xmusic;name,1.8x
Rate,10=mod,1.9xmusic;name,1.9x
Rate,11=mod,2.0xmusic;name,2.0x
Rate,12=mod,0.3xmusic;name,0.3x
Rate,13=mod,0.4xmusic;name,0.4x
Rate,14=mod,0.5xmusic;name,0.5x
Rate,15=mod,0.6xmusic;name,0.6x
Rate,16=mod,0.7xmusic;name,0.7x
Rate,17=mod,0.8xmusic;name,0.8x
Rate,18=mod,0.9xmusic;name,0.9x

[ScreenPlayerOption]の項目を以下と差し替え
[ScreenPlayerOptions]
LineNames=1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16
Line16=list,Rate

参考② SCREENMAN:GetTopScreen():GetChild('SongOptions')と文字列操作を使用した実装

上記の実装ではrateの変更が0.1刻みであるということを仮定した実装であるため、例えば0.05刻みに変更できるようなテーマでは想定通りに動きません。
これを解決する実装を以下に示します。

▼ クリックで展開

<ActorFrame><children>

  <Layer
    Type="Quad",
    InitCommand="%function(self)
      self:hidden(1)
      function getRateMod()
        local so = SCREENMAN:GetTopScreen():GetChild('SongOptions')
        local s = ''
        if not so then return 1.0 else s = so:GetText() end
        if not s then return 1.0 end
        local fbegin = string.find(s,'.',1,true)
        local fend = string.find(s,'xMusic')
        if fbegin and fend then
          return tonumber(string.sub(s,fbegin-1,fend-1))
        else
          return 1.0
        end
      end
    end"
  />

	/>

	<Layer
		File="bga.mpg"
		OnCommand="%function(self)
			self:stretchto(SCREEN_LEFT,SCREEN_TOP,SCREEN_RIGHT,SCREEN_BOTTOM)
			self:rate(getRateMod())
			self:diffusealpha(1)
			self:animate(1)
		end"
	/>

	
</children></ActorFrame>

1つ目のレイヤで、rateオプションの数値を取得する関数getRateMod()を定義しています。
変数にlocalを付けていますが、特に関数の定義においては他のレイヤから関数内の変数そのものを参照することが無いことがわかっているので、変数被りを避けるためlocal変数にしておくのが無難です。

local so = SCREENMAN:GetTopScreen():GetChild('SongOptions')
local s = ''
if not so then return 1.0 else s = so:GetText() end
if not s then return 1.0 end

SongOptionのActorを取得しsoに代入、文字列にしたものをsに代入しています。
何らかの理由で値が取れなかった場合は1.0を返すエラー処理をしています。

local fbegin = string.find(s,'.',1,true)
local fend = string.find(s,'xMusic')
if fbegin and fend then
return tonumber(string.sub(s,fbegin-1,fend-1))

文字列sに対する文字列操作で”〇.◇xMusic”の.とxMusicの位置を取得して、.の1文字前からxMusicの1文字前までの文字列を取得,さらにtonumberで数値化することにより〇.◇の部分を取得する、という流れです。
string.findの引数はそれぞれ取得元文字列、検索対象パターン、検索開始位置(〇文字目)、検索対象パターンを単なる文字列とみなすかどうか、の4つです。
fbeginの取得で3つ目と4つ目の引数を指定しているのは’.’の検索のみだと正規表現とみなされるためです。
また、実装上、rate10.0などの.の前が2桁になっているパターンは考慮していません。(そもそもrate10倍ってまともに動くんでしょうか)

オプション取得回りの実装の話はparaphさんのブログの最近の記事でも触れられていたので、見比べてみるのもよいと思います。
https://paraphrohn.hateblo.jp/entry/2020/03/09/221821

参考URL

Lua API for OpenITG / NotITG(英語)
https://sm.heysora.net/doc/
ITGのLuaを書くのにまず参照するページ。OpenITGで使用できる各種命令が記載されている。

paraphrohn’s diary
https://paraphrohn.hateblo.jp/
日本語でLuaの解説が書かれた貴重なページです。Luaの基本から譜面のワープ、ハイスピ変更ギミックなど様々な実装についての解説があります。