ホーム
>
RPGツクール
>
テクニック集
>
XP一覧
>
テクニック

縁取り＆影文字

FrameShadowText

概要

Summary

文字を縁取り表示するスクリプトです。
ついでに影文字(右下にDropShadow)も描画可能です。
draw_textの代わりに使用できます。
(「縁」の訳がややこしかったので、とりあえず「frame(枠)」にしました)

戦闘中に「縁取り文字」を使うと無駄に重くなります。
戦闘中はなるべく「影文字」または draw_text を使用してください。

↑目次

スクリーンショット

Screen Shot

ScreenShot

↑目次

スクリプト

Script

#_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/
#_/    ◆縁取り・影文字描画 － KGC_FrameShadowText◆
#_/----------------------------------------------------------------------------
#_/  draw_text を強化し、縁取りや影文字の描画機能を追加します。
#_/  Provides functions to draw texts which framed or dropped shadow.
#_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/

=begin
┏━━━━ 搭載メソッド - Methods ━━━━━━━━━━━━━━━━━━━━━━━
┠─── Class - Bitmap ────────────────────────────
┃ draw_frame_text(x, y, width, height, string[, align, frame_color])
┃ draw_frame_text(rect, string[, align, frame_color])
┃   x, y          : 描画先座標    [Integer]
┃                   Destination.
┃   width, height : 描画サイズ    [Integer]
┃                   Size.
┃   rect          : 描画領域      [Rect]
┃                   Rectangle.
┃   string        : 描画文字列    [String]
┃                   Output text.
┃   align         : 文字整列形式  [Integer]
┃                   Alignment.
┃   frame_color   : 縁取り色      [Color]
┃                   Frame color.
┃ 周りを frame_color で縁取りした文字列を描画します。
┃ Draws a character string framed in 'frame_color'.
┃
┃ draw_shadow_text(x, y, width, height, string[, align, frame_color])
┃ draw_shadow_text(rect, string[, align, frame_color])
┃   x, y          : 描画先座標    [Integer]
┃                   Destination.
┃   width, height : 描画サイズ    [Integer]
┃                   Size.
┃   rect          : 描画領域      [Rect]
┃                   Rectangle.
┃   string        : 描画文字列    [String]
┃                   Output text.
┃   align         : 文字整列形式  [Integer]
┃                   Alignment.
┃   frame_color   : 縁取り色      [Color]
┃                   Frame color.
┃ 右下に影を落とした文字列を描画します。
┃ Draws a character string which drops shadow to lower right.
┃
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
=end

$imported = {} if $imported == nil
$imported["FrameShadowText"] = true

#==============================================================================
# ■ Bitmap
#==============================================================================

class Bitmap
  #--------------------------------------------------------------------------
  # ● 縁取り文字描画
  #     x, y, width, height, string[, align, frame_color]
  #     rect, string[, align, frame_color]
  #--------------------------------------------------------------------------
  def draw_frame_text(*args)
    # 引数判定
    if args[0].is_a?(Rect)
      if args.size >= 2 && args.size <= 4
        # 引数を処理用のローカル変数へコピー
        x, y = args[0].x, args[0].y
        width, height = args[0].width, args[0].height
        string = args[1]
        align = args[2].equal?(nil) ? 0 : args[2]
        frame_color = args[3].equal?(nil) ? Color.new(0, 0, 0) : args[3]
      else
        # 引数が不正ならエラーを吐く
        raise(ArgumentError, "wrong number of arguments(#{args.size} of #{args.size < 2 ? 2 : 4})")
        return
      end
    else
      if args.size >= 5 && args.size <= 7
        # 引数を処理用のローカル変数へコピー
        x, y, width, height = args
        string = args[4]
        align = args[5].equal?(nil) ? 0 : args[5]
        frame_color = args[6].equal?(nil) ? Color.new(0, 0, 0) : args[6]
      else
        # 引数が不正ならエラーを吐く
        raise(ArgumentError, "wrong number of arguments(#{args.size} of #{args.size < 5 ? 5 : 7})")
        return
      end
    end
    # 元の色を保存
    origin_color = font.color.dup
    # 縁取り
    font.color = frame_color
    draw_text(x - 1, y - 1, width, height, string, align)
    draw_text(x - 1, y + 1, width, height, string, align)
    draw_text(x + 1, y - 1, width, height, string, align)
    draw_text(x + 1, y + 1, width, height, string, align)
    # 元の色に戻す
    font.color = origin_color
    draw_text(x, y, width, height, string, align)
  end
  #--------------------------------------------------------------------------
  # ● 影文字描画
  #     x, y, width, height, string[, align, shadow_color]
  #     rect, string[, align, shadow_color]
  #--------------------------------------------------------------------------
  def draw_shadow_text(*args)
    # 引数判定
    if args[0].is_a?(Rect)
      if args.size >= 2 && args.size <= 4
        # 引数を処理用のローカル変数へコピー
        x, y = args[0].x, args[0].y
        width, height = args[0].width, args[0].height
        string = args[1]
        align = args[2].equal?(nil) ? 0 : args[2]
        shadow_color = args[3].equal?(nil) ? Color.new(0, 0, 0) : args[3]
      else
        # 引数が不正ならエラーを吐く
        raise(ArgumentError, "wrong number of arguments(#{args.size} of #{args.size < 2 ? 2 : 4})")
        return
      end
    else
      if args.size >= 5 && args.size <= 7
        # 引数を処理用のローカル変数へコピー
        x, y, width, height = args
        string = args[4]
        align = args[5].equal?(nil) ? 0 : args[5]
        shadow_color = args[6].equal?(nil) ? Color.new(0, 0, 0) : args[6]
      else
        # 引数が不正ならエラーを吐く
        raise(ArgumentError, "wrong number of arguments(#{args.size} of #{args.size < 5 ? 5 : 7})")
        return
      end
    end
    # 元の色を保存
    origin_color = font.color.dup
    # 影描画
    font.color = shadow_color
    draw_text(x + 2, y + 2, width, height, string, align)
    # 元の色に戻す
    font.color = origin_color
    draw_text(x, y, width, height, string, align)
  end
end

↑目次

使用法

Usage

draw_text(...)
を
draw_frame_text(...)
や
draw_shadow_text(...)
に書き換えれば、縁取り文字・影文字を描画できます。

　　－メソッド仕様(クラス：Bitmap)－

　draw_frame_text(x, y, width, height, str[, align, color])
　draw_frame_text(rect, str[, align, color])
　draw_shadow_text(x, y, width, height, str[, align, color])
　draw_shadow_text(rect, str[, align, color])

[x, y, width, height, rect, str, align]draw_text と同様。
[color]縁取り・影の色。

↑目次