APIでの利用方法

おれいポップアップ

編集

APIでの利用方法

おれいポップアップ表示

メソッドwindow.RPGAtsumaru.popups.displayThanksModal()
説明おれいポップアップを表示します
引数なし
戻り値Promise<void>

おれいポップアップ設定

メソッドwindow.RPGAtsumaru.popups.setThanksSettings(thanksSettings: ThanksSettings)
説明おれいポップアップを自動表示するかどうかと、表示する画像やメッセージを設定します
引数ThanksSettings
戻り値なし

引数の型 ThanksSettings について

引数で指定する ThanksSettings は以下のような型です。

interface ThanksSettings {
    autoThanks?: boolean;
    thanksText?: string;
    thanksImage?: string;
    clapThanksText?: string;
    clapThanksImage?: string;
    giftThanksText?: string;
    giftThanksImage?: string;
}

プロパティの内容は次のようになっています。

プロパティ内容
autoThanksbooleanおれいポップアップの自動表示を有効にするかどうか
thanksTextstringおれいポップアップに表示される作者からのメッセージ
thanksImagestringおれいポップアップに表示される画像。ゲーム内のURL、またはData-Url形式も可
clapThanksTextstring拍手されたときにおれいポップアップに表示される作者からのメッセージ
clapThanksImagestring拍手されたときにおれいポップアップに表示される画像。ゲーム内のURL、またはData-Url形式も可
giftThanksTextstringギフトされたときにおれいポップアップに表示される作者からのメッセージ
giftThanksImagestringギフトされたときにおれいポップアップに表示される画像。ゲーム内のURL、またはData-Url形式も可

引数の例

RPGAtsumaru.popups.setThanksSettings({
    autoThanks: false,
    thanksText: "プレイありがとう!",
    thanksImage: "img/pictures/Actor1_1.png", // ゲーム内画像を指定する場合
    clapThanksImage: "data:******", // Data-Url形式も指定可。画像の動的生成などにどうぞ
    // 設定不要or前の設定のままにしておきたいプロパティは省略可
});

関連ドキュメント

ドキュメントリンク備考
機能解説おれいポップアップ機能概要や全般的な解説
プラグインでの利用方法プラグインでの利用方法RPGツクールシリーズユーザー向け

最終更新日

  • 2021/09/30