メインコンテンツまでスキップ

effects

画面上にビジュアルスタンプエフェクトを表示します -- 指定された位置に、サイズ、不透明度、表示時間を設定可能な画像を表示します。

インポート

import { effects } from "@hmcs/sdk";

スタンプエフェクト

effects.stamp(asset, options?) は、画像アセットをスクリーン上の一時的なオーバーレイとして表示します。

// 最小構成 -- デフォルトの位置とサイズで表示
await effects.stamp("my-mod:thumbs-up");

// フルオプション
await effects.stamp("my-mod:heart", {
x: 100,
y: 200,
width: 80,
height: 80,
alpha: 0.9,
duration: 1.5,
});

パラメータ

パラメータ説明
assetstringスタンプ画像のアセット ID(例: "my-mod:heart"
optionsStampOptionsオプションの外観設定

StampOptions

フィールド説明
xnumberスクリーン上の X 位置(ピクセル)
ynumberスクリーン上の Y 位置(ピクセル)
widthnumber幅(ピクセル)
heightnumber高さ(ピクセル)
alphanumber不透明度(0--1)
durationnumberスタンプが消えるまでの秒数

次のステップ

  • Audio -- 効果音と BGM の再生
  • Signals -- クロスプロセス pub/sub メッセージング