ティラノスクリプト - プラグイン
ティラノスクリプト用プラグインです。

TIPプラグイン

2016-04-14 2023-02-19 プラグイン 縦書き , TIPプラグイン
この記事をシェアする

「街」とか「428」とかのTIP機能みたいなプラグイン。
メッセージレイヤのテキストをクリックして別窓を開きます。

TIP内容はCSVから読み込みますので、表計算やデーターベースソフト等で管理できます。
html、css、jsRender を理解してないと使いにくいかもです…。

主な機能

  • テキストをクリックしてTIPを表示します。
  • TIPデータは、csvファイルを読み込みます。複数読み込み対応。
  • TIPテキストやホバー時の文字色・SE・マークの有無を指定できます。
  • TIP詳細の内容をページ分けできます。
  • TIP一覧を自動作成します。
  • TIP表示フラグを保存します(TIPテキストを表示したかどうか)
  • バックログからもTIP表示するかを指定できます。 (※4.01b以降、マークはCSS、カラーはバックログプラグインで対応お願いします)
  • TIP詳細・TIP一覧のレイアウトはhtmlファイルで編集可能です。csv別に指定もできます。
  • TIP詳細のテキストから別のTIP詳細を表示できます。
  • ページを指定してTIP詳細を表示できます。
  • 未読マークを表示できます。
  • 縦書き対応。

サンプル画像

縦画面サンプル(600*900)

サンプルゲーム

利用規約

  • 改造・再配布は自由です。ただし、有償での再配布は禁止します。改造後データの配布も同様にお願いします。
  • 利用報告・クレジット表記は任意です。
  • このプラグインはドネーションウェア(カンパウェア)です。もしよろしければ寄付をお願いいたします。(強制ではありません)
  • 詳しくは利用規約をお読みください。

ダウンロード

※v4.07はサンプルゲーム未収録です。必要な方はBOOTHからv4.06をダウンロードしてください。

動作確認

ティラノスクリプト ver521e

注意点

メッセージレイヤーの表示順を変更しています。設定や環境によってはうまく動作しない可能性があります。

使い方

組み込み方法

  1. data/others/plugin に 「tip」フォルダを保存してください。
  2. csvファイルを作成し、data/others/plugin/tip/csv/ に保存します。※作り方は後述 デフォルトのファイル名は「 tip_data.csv 」
  3. first.ks (ビルダーは scenario/system/plugin.ks )など、ゲーム起動時に必ず読み込むksファイルでプラグインを呼び出してください。 [plugin name=tip] [plugin] タグは1度だけ書けば大丈夫です。
  4. フラグ保存を f変数 にする場合は、
    make.ks ファイルに [tip_flag_reset] タグを記述します。
  5. TIP表示ボタンにしたいテキスト(以下「TIPテキスト」)を [tip]~[endtip] で囲みます。 [tip] タグには、keyid のどちらかを指定します。 例:[tip key=hoge]ほげ[endtip]
  6. TIPリストの表示は [tip_list] タグを使います。 [button] で呼び出す場合は、role=sleepgame を指定してください。 target 先に[tip_list]を書きます。
    例:
    [button x=0 y=0 fix=true role=sleepgame graphic=tiplist.gif target=*tiplist]
    
    *tiplist
    [tip_list]
    [s]

CSVファイルの作り方

  • CSVデータは、1行で1件分となります。 改行コードで次のデータとして分割します。
  • CSVの1行目は「見出し」にします。 見出しで使えるのは、半角英数のみです。
  • 見出しに「key」項目を作ります。keyで対象データを参照します。 「key」で使えるのは、半角英数のみです。
  • 「見出し」には、「id」「flag」は使えません(自動で追加されます) それ以外の見出し名は自由です。項目数にも制限はありません。
  • CSVファイルの文字コードは「UTF-8」にしてください。
  • CSVファイルは、tipフォルダ内の「csv」フォルダに保存してください。
  • テキスト内容が「カンマ区切りテキスト」であれば、拡張子は .csv 以外でも大丈夫です。 ファイル名を変更する場合は、ファイル名を指定してください。 [plugin name=tip file=***.txt] または、 [tip_loadcsv file=***.txt]
  • 必ず行の最後は「_EOF」を付けてください。v4以降は不要ですが、最後の項目が表示されない場合は追記してください。
  • htmlタグも記入できますが、「"」を使う場合は書出し後のデータチェックしてください。「'」推奨。
  • ファイルが上手く読込めない場合は、一度テキストエディタで開き上書き保存してみてください。

詳しい使い方

その他

  • マーク画像は、tip/image/tip_mark.png を差し替える事で変更可能です。 ※画像は正方形で作成してください。
  • マーク画像の表示は、tip/js/tip.css にて変更可能です。
  • 自動でのフラグ立ては、[tip] タグを表示した時点で true になります。TIPをクリックしたかは判断されません。
  • リスト表示で pagenum=auto(初期値)を使う場合は、 #tip_list_container の width() height() 値を正確に設定してください。 上手く動かない場合は、1ページの表示件数を数値で入力してください。
  • バックログのSEは「TIPからマウスカーソルが外れた時の音」には非対応です。
  • htmlの変更禁止id・class
    • tip.html … #tip_container .tip_body
    • tip_list.html … #tip_list_container .tip_list
  • sampleフォルダのtip_sample.ks がサンプルゲームとなっていますので参照してください。 ※サンプルゲームは、ティラノビルダーには対応していません(画像が無いのでエラーが出ます) ※ゲーム制作時は、sampleフォルダは削除してください。

パラメータ

[plugin]タグ用

(※初期値の場合は省略可)

パラメータ名 初期値 説明
file ファイル名 tip_data.csv TIPデータファイル名
color 0x000000形式 defaultChColor TIPテキストの色を変える
entercolor 0x000000形式 "" TIPテキストにマウスカーソルが乗った時の色
mark true/false false TIPテキストにマークを付ける
flag true/false true TIP表示をフラグ管理するか
flag_var sf/f sf フラグ保存用変数の種類
log true/false true バックログからもTIP表示させるか
log_se true/false false バックログのTIPテキストにSEを入れるか(※log=true時)
log_color true/false false バックログのTIPテキストにcolorを付けるか(※log=true時)
all_clickse oggファイル none 共通のクリック音
all_enterse oggファイル none 共通のマウスカーソルが乗った時の音
all_leavese oggファイル none 共通のマウスカーソルが外れた時の音
tip_clickse oggファイル none TIPテキストのクリック音
tip_enterse oggファイル none TIPテキストにマウスカーソルが乗った時の音
tip_leavese oggファイル none TIPテキストからマウスカーソルが外れた時の音
list_clickse oggファイル none TIPリストのクリック音
list_enterse oggファイル none TIPリストにマウスカーソルが乗った時の音
list_leavese oggファイル none TIPリストからマウスカーソルが外れた時の音
close_clickse oggファイル none 閉じるボタンのクリック音
close_enterse oggファイル none 閉じるボタンにマウスカーソルが乗った時の音
close_leavese oggファイル none 閉じるボタンからマウスカーソルが外れた時の音
navi_clickse oggファイル none ナビボタンのクリック音
navi_enterse oggファイル none ナビボタンにマウスカーソルが乗った時の音
navi_leavese oggファイル none ナビボタンからマウスカーソルが外れた時の音
tip_html htmlファイル tip.html TIP表示用テンプレート
tiplist_html htmlファイル tip_list.html TIPリスト表示用テンプレート
pagefeed auto/none/数値 auto TIPリストをページ分けするか。しない場合は none
fade_speed 数値 300 各TIP画面のフェード時間
vertical true/false config.vertical 縦書きにするか
[tip_loadcsv]タグ用

CSVファイルを読み込む為のタグです。 (※パラメータの指定が無い場合は、[plugin]の指定が反映されます。)

パラメータ名 必須 説明
file csvファイル名 × 読み込みたいcsvファイル
flag true/false × TIP表示をフラグ管理するか
flag_var sf/f × フラグ保存用変数の種類
tip_html htmlファイル × TIP表示用テンプレート
tiplist_html htmlファイル × TIPリスト表示用テンプレート
[tip]タグ用

メッセージテキストをTIP表示ボタンにするタグです。 (※パラメータの指定が無い場合は、[plugin]の指定が反映されます。)

パラメータ名 必須 説明
key 文字列 〇* csvファイルで定義した「key」の値
id 数値 〇* csvファイルの記述順(0からスタートです)
color 0x000000形式 × TTIPテキストの色
entercolor 0x000000形式 × TIPテキストにマウスカーソルが乗った時の色
mark true/false × TIPテキストにマークを付けるか
clickse oggファイル × TIPテキストのクリック音
enterse oggファイル × TIPテキストにマウスカーソルが乗った時の音
leavese oggファイル × TIPテキストからマウスカーソルが外れた時の音
data_name 文字列 × csvデータ名(※拡張子は無し)

* key または id のどちらかは必須。両方記述がある場合は key が優先になります。

[tip_show]タグ用

tipを表示するタグです。 (※パラメータの指定が無い場合は、[plugin]の指定が反映されます。)

パラメータ名 必須 説明
key 文字列 〇* csvファイルで定義した「key」の値
id 数値 〇* csvファイルの記述順(0からスタートです)
data_name 文字列 × csvデータ名(※拡張子は無し)

* key または id のどちらかは必須。両方記述がある場合は key が優先になります。

[tip_list]タグ用

TIPリストを表示するタグです。 (※パラメータの指定が無い場合は、[plugin]の指定が反映されます。)

パラメータ名 必須 説明
data_name 文字列 × csvデータ名(※拡張子は無し)
sort_key 文字列 × ソートしたいcsvデータの列の見出し
sort_reverse true/false × 降順ソートする場合は true。省略時は昇順(false)
[tip_flag]タグ用

フラグの値を追加したり変更したりするタグです。 (※パラメータの指定が無い場合は、[plugin]の指定が反映されます。)

パラメータ名 初期値 必須 説明
key 文字列 - 〇* csvファイルで定義した「key」の値
id 数値 - 〇* csvファイルの記述順(0からスタートです)
data_name 文字列 - × csvデータ名(※拡張子は無し)
flag_name 文字列 flag × フラグの名前
flag_val true/false true × フラグの値

* key または id のどちらかは必須。両方記述がある場合は key が優先になります。

[tip_btn] タグ用

button や glink にTIPリストの未読数を表示するタグです。 (※パラメータの指定が無い場合は、[plugin]の指定が反映されます。)

パラメータ名 初期値 説明
data_name 文字列 - csvデータ名(※拡張子は無し)
pos 文字列 rt 未読数の表示位置。
lt(左上)、rt(右上)、ct(中上)、lb(左下)、rb(右下)、cb(中下)
※left、right、center、top、bottom の頭文字です。
[tip_flag]タグ用

フラグの値を追加したり変更したりするタグです。
(※パラメータの指定が無い場合は、[plugin]の指定が反映されます。)

パラメータ名 初期値 説明
data_name 文字列 csvデータ名(※拡張子は無し)
tip_btn true/false false リスト表示用ボタンに未読バッジを使う場合は true
clear true/false false フラグ値を削除する場合は true

Ver・更新履歴

2023/02/19 ver4.07c
colorパラメータが動作しない不具合修正。パラメータlog_colorを追加。ティラノv521d/eにて動作確認。
2022/11/23 Ver4.07b
右クリックでcloseした場合の不具合修正。
2022/11/14 Ver4.07a
起動時の不具合対応。
2022/11/13 Ver4.07
v520でロード時に動作しない不具合対応。
2022/04/30 Ver4.06
[tip_flag_reset]タグ追加。[tip_flag]タグ使用時に未読バッジが反映してなかった不具合修正。
2021/09/30 Ver4.05
[tip_show]タグ・idパラメータ追加。テンプレートでゲーム変数を使えるように。 他、CSS整理など微調整。ティラノv510hで動作確認。
2021/02/11 Ver4.04
TIPリスト表示にソート機能を追加。ティラノv510aで動作確認。サンプルは追加なし。
2021/02/11 Ver4.03
ボタン用未読数の位置指定パラメータを追加、位置ズレを修正。ティラノv506eで動作確認。 [endtip]タグで[font]の指定がクリアされる仕様を変更。 リストからの詳細を閉じる際のチラつきを修正。prev/nextボタンのカーソル画像を修正。
2021/01/04 Ver4.02a
メニューの後にリストを開くと、メニューが残ってしまう不具合を修正。
2021/01/03 Ver4.02
未読マーク追加。セーブ・ロード画面からTIP詳細が開く不具合修正再び。ティラノv505eで動作確認。
2020/11/23 Ver4.01b
パラメータの log_color、log_mark、log_plugin、pagenum を削除。 テンプレートを簡略化、CSSを微調整等。
2020/10/22 Ver4.01a
csv読み込み、CSS間違い等不具合修正。ajax表記修正。
2020/10/19 Ver4.01
リスト表示用タグを[tip_list]に変更。ナビにprev/nextを追加。tipのページ指定追加。 tip内tip表示、f変数を指定した時の挙動等、不具合修正。他CSSなど修正。
2020/09/21 Ver4.00
CSV複数読み込み、テンプレート指定等機能追加。ティラノv504aで動作確認。
 
Ver4.00以前省略
2016/04/14 Ver1.00
公開。

参考サイト

この記事をシェアする
メッセージ枠調整プラグイン CSV読込みプラグイン

コメント一覧

hororo 1年前 ねこ様

ご報告ありがとうございます。
解決して良かったです!
すみません、セーブデータ削除の事をすっかり忘れていました💦

ご支援もありがとうございました!助かります。
また何かありましたらご質問ください。
制作頑張ってください!
ねこ
1年前 さっそくのご返信ありがとうございます。

再現しないとのことで、こちらで原因調査した結果、前のバージョンのTIPプラグインのデータが残ったままのsf.savが原因でした。
sf.savファイルを削除して1から起動し直したところ、無事システム変数に保存されるようになりました。
最新版の方はデフォルトで確認しましたが、旧バージョンは改造しているので、意図しない挙動になっていたかもしれません。

お手数をおかけして申し訳ございませんでした。

いつもご対応ありがとうございます。
TIPプラグインには大変助けられております。
無償でご対応いただくのは申し訳ないので、後ほどご支援させていただきます。
これからも応援しています。
hororo 1年前 ねこ様

こんにちは。
ティラノスクリプト v515bata4 + TIPプラグイン v4.06 で試してみましたが再現しませんでした。

一つ確認させてください。
シナリオ読み込みまでに、下記タグの記述はありませんでしょうか?

[clearsysvar]
又は
[tip_flag_reset clear=true]

もしどちらも無い場合は、お手数ですがシナリオまでのコードをお知らせ頂ければありがたいです。
非公開にしますので、コメントに貼り付けて頂いても構いませんし、メールかTwitterのDMでも大丈夫です。
Twitterであればスクショでも構いません。

よろしくお願い致します。
ねこ
1年前 お世話になっております。
以前何度かプラグインに関して質問させていただいた者です。

TIPプラグインの最新版を適用したところ、TIPの解放状況がシステム変数でなくゲーム変数で保存するようになってしまいました。

確認方法は下記の通りです。
ティラノスタジオv1.10dで[tip key=hoge]が記述されたシナリオを開く→
hogeのTIPが解放されているのを確認→
シナリオから[tip key=hoge]の記述を削除してリロード→
hogeのTIPが解放されていない

pluginタグにflag_var=sfを明示しても挙動に変化はありません。

ティラノスタジオは一度でもそのタグを通ればシステム変数に記録される仕様だったかと思うので(実際以前のバージョンでは上記のような動作をした場合リロードしてもhogeのTIPは解放されたままでした)、上記のような挙動にならないかご確認いただけないでしょうか。
ティラノスタジオ側の問題でしたら申し訳ございません。

お手隙の際にご確認いただけましたら幸いです。
よろしくお願いいたします。
hororo 2年前 アイ さま

TIPプラグイン v406 にて、フラグのリセット用の [tip_flag_reset] というタグを作りました。

title.ks でフラグをクリアする場合。
[tip_flag_reset clear=true]
と記述します。

また、make.ks には [plugin] タグではなく、[tip_flag_reset] を記述してください。
[plugin] タグだと、再度csv読込みをしてしまうので、動作的に凄く無駄なのです。

[tip_btn] が必要な場合は
[tip_flag_reset tip_btn=true] でも動作します。
別々に書いてもどちらでも大丈夫です。

ざっくりとしか検証できてないので、もし不具合がありましたらお知らせください。
よろしくお願い致します。
hororo 2年前 アイさま

おそらくjavascriptの仕様です。
make.ks にも、iscript 部分を記述すると動くようになると思います。

ざっくり説明すると、ティラノはロード時にhtmlを再構築するのでjsが非対応になってしまうのです(ざっくりすぎ)
sleepgameもロードと同じなのでjsが動かくなります。
詳しくは「jQuery 動的要素 イベント」等で検索してみてください。


「flagでTIPを解放する場合の未読件数バッジ」の件は、
お急ぎでしたらgithubのデータをDLしてください。
https://github.com/amuhororo/tip_plugin
右上にある、緑ボタンの「code」→「Download ZIP」からDLできます。

よろしくお願いします。
アイ
2年前 hororoさま

お返事ありがとうございます。
忙しいなか恐縮でございます。お待ちしております。

また…ひとつ…困っていることがございまして…。
自分でも色々と奮闘してみたのですが、どうにも分からなかったのでお尋ねします。
ほんとうに何度も何度も申し訳ありません…!

ゲーム内で、マウスオーバー時に解説画面を載せるボタンを導入しています。
こちら(https://7yen.hateblo.jp/entry/2017/06/05/022847)を参考にしています。「【ティラノスクリプト】マウスカーソルが載ったときに何かする」という、日野谷さんのブログです。
これがどうしてか、TIPリストを開いて閉じた直後のシナリオで、解説画像が表示されなくなります。
別シナリオに行って戻ってきたあとだと、再度表示されるようになります。
加えて、ロードした直後のデータでも作動しません。make.ksには[tip_btn]を記述しています。

もしもどこか競合する箇所があるようなら、ご教授いただけるとさいわいです。
お手数おかけしております…!
hororo 2年前 アイさま

「TIPのフラグ初期化」と「flagでTIPを解放する場合の未読件数バッジ」の件、失念しておりました。
対応させて頂きますので、申し訳ありませんがしばらくお待ち下さい!
アップデートしましたらお知らせさせて頂きます。
アイ
2年前 hororoさま

お返事ありがとうございます。
無事ゲーム変数に入力できました。ほんとうに助かりました!
行き詰まっていることに対してとても丁寧にお答えいただいて、感謝の言葉もありません。

確認なのですが…、ただこれはビルダーの仕様の問題で、お問い合わせの対象でないかもしれません。
ビルダーではシナリオ(たとえばゲームオーバー画面)からタイトル画面にジャンプさせ「はじめから」を選択する場合、同じセーブデータだと認識されるため変数が一切初期化されない現象があります。
そのため、一部のシナリオにTIPのフラグ初期化の入力をしたいのですが、そういったことはタグ打ちで可能でしょうか。


また、TIPボタンの未読件数バッジ表示についてもお聞きしたいです。
面白い機能なのでぜひ使わせていただきたいと思っております。
以前お教えいただいた、flagでTIPを解放する場合、flag入力をした時点では未読件数バッジが出てきません。一度TIPリストを開いてから閉じると、TIP未読件数バッジが表示されます。flag入力をすると同時に、ボタンに未読件数が表示されるようにすることは可能でしょうか。

重ね重ねお手数おかけしております。
気が向きましたらお返事お願いいたします。
hororo 2年前 アイさま

上手くいったようで良かったです!

flagの値をシステム変数ではなくゲーム変数に入れる方法は以下の通りです。
ちょっと面倒ですが、[plugin] タグの記述を変える時は、make.ks の変更も忘れないようにご注意ください。

① [plugin] タグに flag_var=f と、パラメータを指定します。
[plugin name=tip flag_var=f]


② make.ks(scenarioフォルダにあります)にも、同じ内容の [plugin] タグを記述します。
※[return] の上です。

よろしくお願い致します。
アイ
2年前 hororoさま

たびたび失礼します。先日はご丁寧にありがとうございました。イメージ通りのものを作ることが出来ました。

またお伺いしたいのですが、flagの値をシステム変数ではなくゲーム変数に入れるにはどうしたらよろしいでしょうか。
セーブデータごとにTIP解放数をリセットしたい次第です。

お時間ありましたらよろしくお願いいたします。
hororo 2年前 アイさん、はじめまして。

TIPプラグインをお使い頂きありがとうございます。
返事が遅くなってしまい申し訳ありません。


① TIPリストで未開放の分を非表示にする方法
テンプレートの、tip_list.html を書き換えます。
tip_list.html は html フォルダの中にはいっています。

{{for tips}} ~ {{/for}} の間の、{{if flag>=0}} {{/if}} の部分です。
----------------------------------------------------------------------------------
{{for tips}}
 {{if flag>=0}}
  <li class="tips_item tip_list{{if flag<0}}_none{{/if}}" data-num={{:id}}>
   <div class="tips_body">
    <span class="tip_id">Tip {{if id<9}}0{{/if}}{{:id +1}}</span>
    <span class="tip_title">{{:title}}</span>
    {{if flag==0}}<span class="new">New!</span>{{/if}}
   </div>
  </li>
 {{/if}}
{{/for}}
----------------------------------------------------------------------------------
※太字の部分が変更した箇所です。コピペで書き換えでも大丈夫です。


② フラグの立て方
ゲーム内のメール文に通常のテキストを使う場合で、
メッセージをリンクにする場合は [tip] タグを使います。
例:[tip key=xxx]テキスト[endtip]

リンクにしない場合や、メッセージを使わない場合は。[tip_flag] タグを使います。
例:[tip_flag key=xxx]
(※flag_name と flag_val は省略でOKです)


ビルダーの場合は、全て スクリプトの「ティラノスクリプト」でタグ打ちが必要になります。


説明が足りない部分がありましたら再度ご質問頂ければありがたいです。
よろしくお願い致します。
アイ
2年前 はじめまして。アイといいます。
数か月前からティラノビルダーを手探りで使っております。

TIPプラグインの存在を知り、とても楽しそうなシステムだと思いました。レイアウトも見やすく好みです。
ひとつお伺いしたいのですが、TIPを指定するまで、そのTIPの存在すら表示されないようにする方法はありますでしょうか。

うまくお伝え出来ず申し訳ないです。やりたいこととしては、メール機能のようなものをイメージしています。ゲーム内でメールが受信されたら見れる項目が増えていく…ようなものです。

お時間ありましたらご教授おねがいします。

コメント送信フォーム


※ Email will not be published
Loading...
 Please enter the letters of the image