Akashic Engine 逆引きリファレンス

文字列にルビを振る

Akashic Engine で描画する文字列にルビを振るには akashic-label を利用します。

凡例

var al = require("@akashic-extension/akashic-label");
var label = new al.Label({
  scene: scene,
  text: '{"rt":"コーヒー","rb":"珈琲"}を飲む。',
  font: font,
  fontSize: 30,
  width: g.game.width,
  rubyEnabled: true
});
scene.append(label);

利用例

次の例は、文字列にルビを振ります。

詳細

akashic-label@3.1.0 より前のバージョンでは、 rubyEnabled はデフォルトで有効でした。意図しない文字列がルビとして解釈されてしまう問題を避けるため、バージョン 3.1.0 以降ではゲーム開発者が明示的に rubyEnabled: true を指定する必要があります。

Akashic Engine 標準の g.Label エンティティはルビをサポートしていません。ルビの描画は akashic-label ライブラリがサポートしています。そのため、 akashic-label ライブラリをコンテンツに導入する必要があります。 akashic-label は g.Label に近い方法で利用できる Label エンティティを提供します。このエンティティを使うことで、ルビの描画のほか、複数行の文字列描画や禁則処理などの機能を利用することができます。ルビを利用する際は、 rubyEnabled: true を指定する必要があります。

akashic-label のインストールは game.json が置かれているディレクトリで以下のコマンドを実行してください。

akashic install @akashic-extension/akashic-label

関連情報

前 (複数行の文字列を描画する) | 目次 | 次 (ビットマップフォントを使う)