見出し画像

ジャンプタイトルティラノスクリプト(ビルダー)プラグイン

はじめに

Freem!公開時、「タイトル画面に戻る」のロールボタンの機能をカスタマイズする必要がありました。

Freem!では、セキュリティ上「htmlファイルの無効化」「ゲームのURL再利用の無効化」を行っているらしく、ティラノスクリプトのロールボタンは、「index.html」を再度呼び出すかたちになっているため、この制限に引っ掛かってしまいます。

なので、これの対策をしたというお話しです。


概要

ティラノスクリプトの標準機能である、ロールボタンのtitle(タイトル画面に戻る)機能を変更します。
ただし、これは標準機能を上書きしてしまうので、使用に関しては、ご自身の責任でお願いします。
ですが、このプラグインで、Freem!での動作に、問題がないことは確認しています。

以下、当プラグインを実装して公開した、ティラノビルダー制のゲームです。

ダウンロード

下記から「jumptitle{バージョン情報}.zip」をダウンロードしてください。
※ダウンロードファイルには、ティラノスクリプト用のフォルダが含まれています。

BOOTHにて、無料で公開していますので、こちらからもダウンロード可能です。

ソースコードと共にGitHubでも公開していますので、下記からでもダウンロード可能です。

プラグインの導入

①data/others/plugin にjumptitle{バージョン情報}.zipファイル内の「jumptitle」フォルダをコピーてください。

下記構成で2ファイルがあるか確認してください。
data/others/plugin/jumptitle/init.ks
data/others/plugin/jumptitle/jumptitle.js

②-1 ティラノスクリプトへの導入

first.ksからプラグインを呼び出してください。

下記のタグを「first.ks」内に追加してください。
[plugin name=jumptitle dispose="dispose.ks"]

;一番最初に呼び出されるファイル

[title name="ティラノスクリプト解説"]

[stop_keyconfig]


;ティラノスクリプトが標準で用意している便利なライブラリ群
;コンフィグ、CG、回想モードを使う場合は必須
@call storage="tyrano.ks"

;ゲームで必ず必要な初期化処理はこのファイルに記述するのがオススメ

;ジャンプタイトルプラグイン読込 ← この辺に入れる 
[plugin name=jumptitle dispose="dispose.ks"]

;メッセージボックスは非表示
@layopt layer="message" visible=false

;最初は右下のメニューボタンを非表示にする
[hidemenubutton]

;タイトル画面へ移動
@jump storage="title.ks"

[s]

②-2 ティラノビルダーへの導入

plugin.ksからプラグインを呼び出してください。
※plugin.ksは、data/scenario/systemの中にあります。

注意!!
ティラノビルダーの場合、first.ksは、起動時に上書きされてしまうので、こちらへ、プラグインの呼び出しを記載することは出来ません。

下記のタグを「plugin.ks」内に追加してください。
[plugin name=jumptitle dispose="dispose.ks"]

;ジャンプタイトルプラグイン
[plugin name=jumptitle dispose="dispose.ks"]

disposeパラメータに指定したシナリオファイルが、「タイトルへ戻る」が押された際に呼び出されます。
※詳細は次の「使い方」を参照してください。

使い方

基本的には、プラグインを導入するだけで、ロールボタンのタイトルへ戻る機能が上書きされます。
このとき、導入時に指定した「dispose」パラメータがある場合、タイトルへ戻るが押された際に、こちらのシナリオファイルが呼び出されるようになります。「dispose」パラメータの指定がない場合は「first.ks」が呼び出されます。

処理フロー

なので、正確には、タイトルへ戻るボタンではなく、指定したシナリオファイルへジャンプするボタンに変更されます。

①後処理シナリオファイル(dispose.ks)について

タイトルへ戻る際の後処理を、このシナリオファイルに記述します。
基本的には、イメージやメッセージ枠の消去、音楽や動画の停止を行います。そして、最後にタイトルへのジャンプを入れておきます。

これをやらないと、タイトル画面へ戻っても、画僧やテキストが表示されたままになってしまいます。

要は、自分で使ったものは、自分でしっかり片付けましょう!
という思想です。
ちょっと、面倒かと思いますが、こちらの方が色々と融通が利きます。

【dispose.ks】シナリオファイルのサンプル

; TODO ここに後処理を書く
; 以下サンプル

; レイヤをクリア
[freeimage layer="base"]
[freeimage layer="0"]
[freeimage layer="1"]
[freeimage layer="2"]
[clearfix]

; メッセージを非表示
[layopt layer="message" visible=false]

; メニューボタンを非表示
[hidemenubutton]

; 動画を停止
[stop_bgmovie]

; BGMを停止
[stopbgm]

; SEを停止
[stopse]

; タイトルへジャンプ
[jump storage="title.ks"]
[s]


②ティラノビルダーの後処理シナリオファイル(dispose.ks)

ティラノビルダーでも同様です。
dispose.ksのシナリオファイルを追加し、これに後処理を記述して、最後にタイトル画面へのジャンプを入れておきます。

dispose.ks

おわりに

以上が、ジャンプタイトルティラノスクリプト(ビルダー)プラグインの説明です。
標準の機能を上書きすることからも、当プラグインを公式で公開して頂くよう依頼するつもりはありません。
Freem!公開時に、どうしても必要な場合のみ、当プラグインを検討してみてください。

この記事が気に入ったらサポートをしてみませんか?