RPGツクールXP テクニック　－書式指定文字描画

メッセージウィンドウの制御文字や、独自の制御文字を使用した描画処理を行うことができます。

スクリプト

KGC_FormatText

#_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/
#_/　　◆書式指定文字描画 － KGC_FormatText◆
#_/----------------------------------------------------------------------------
#_/　draw_text を強化し、制御文字を指定した描画機能を追加します。
#_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/

=begin ┏━━━━━━━┓
┏━━━┫ メソッド仕様 ┣━━━━━━━━━━━━━━━━━━━━━━━━━━━
┃ ┗━━━━━━━┛
┠─── draw_format_text(x, y, width, height, string[, align]) ────────
┃ x, y : 描画先の座標
┃ width, height : 描画範囲
┃ string : 描画文字列
┃ align : 整列(0…左揃え 1…中央揃え 2…右揃え)
┃
┠─── draw_format_text(rect, string[, align]) ───────────────
┃ rect : 描画範囲(Rect)
┃ string : 描画文字列
┃ align : 整列(0…左揃え 1…中央揃え 2…右揃え)
┃
┃ ┏━━━━━━━━━━━━━━━━━━━━━━━┓
┣━━━┫ 互換制御文字(イベントコマンド「文章の表示」) ┣━━━━━━━━━━━
┃ ┗━━━━━━━━━━━━━━━━━━━━━━━┛
┠─── \\C[n] ────────────────────────────────
┃ 描画文字色を n に変更します。
┃
┠─── \\G ─────────────────────────────────
┃ 所持金を描画します。
┃
┠─── \\N[n] ────────────────────────────────
┃ ID:n のアクター名を描画します。
┃
┠─── \\V[n] ────────────────────────────────
┃ 変数 ID:n の値を描画します。
┃
┃ ┏━━━━━━━┓
┣━━━┫ 独自制御文字 ┣━━━━━━━━━━━━━━━━━━━━━━━━━━━
┃ ┗━━━━━━━┛
┠─── \\FN[name] ──────────────────────────────
┃ 描画文字のフォント名を name に変更します。
┃
┠─── \\FS[n] ───────────────────────────────
┃ 描画文字のフォントサイズを n に変更します。
┃
┠─── \\SS ～ \\ES ─────────────────────────────
┃ 囲んだ文字列を影文字(ShadowText)で描画します。
┃ ※≪縁取り＆影文字描画[FrameShadowText]≫が必要です。
┃
┠─── \\SF ～ \\EF ─────────────────────────────
┃ 囲んだ文字列を縁取り文字(FrameText)で描画します。
┃ ※≪縁取り＆影文字描画[FrameShadowText]≫が必要です。
┃
┠─── \\IN[n] ───────────────────────────────
┃ ID:n のアイテム名を描画します。
┃
┠─── \\WN[n] ───────────────────────────────
┃ ID:n の武器名を描画します。
┃
┠─── \\AN[n] ───────────────────────────────
┃ ID:n の防具名を描画します。
┃
┠─── \\IT[n] ───────────────────────────────
┃ ID:n のアイテム名をアイコン付きで描画します。
┃
┠─── \\WP[n] ───────────────────────────────
┃ ID:n の武器名をアイコン付きで描画します。
┃
┠─── \\AR[n] ───────────────────────────────
┃ ID:n の防具名をアイコン付きで描画します。
┃
┃ ┏━━━━━━┓
┣━━━┫ タグもどき ┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━
┃ ┗━━━━━━┛
┠─── ～ ─────────────────────────────
┃ 囲んだ文字列をボールド体(太字)で描画します。
┃
┠─── ～ ─────────────────────────────
┃ 囲んだ文字列をイタリック体(斜体)で描画します。
┃
┠─── ～ ─────────────────────────────
┃ 囲んだ文字列に下線を描画します。
┃
┠─── <S> ～ </S> ─────────────────────────────
┃ 囲んだ文字列に取消線を描画します。
┃
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
=end

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

class Bitmap
 #--------------------------------------------------------------------------
 # ● 書式指定文字描画
 # x, y, width, height, string[, align]
 # rect, string[, align]
 #--------------------------------------------------------------------------
 def draw_format_text(*args)
 # 引数判定
 if args[0].is_a?(Rect)
 if args.size >= 2 && args.size <= 3
 # 引数を処理用のローカル変数へコピー
 x, y = args[0].x, args[0].y
 width, height = args[0].width, args[0].height
 string = args[1]
 align = args[2] == nil ? 0 : args[2]
 else
 # 引数が不正ならエラーを吐く
 raise(ArgumentError, "wrong number of arguments(#{args.size} of #{args.size < 2 ? 2 : 3})")
 return
 end
 else
 if args.size >= 5 && args.size <= 6
 # 引数を処理用のローカル変数へコピー
 x, y, width, height = args
 string, align = args[4..5]
 else
 # 引数が不正ならエラーを吐く
 raise(ArgumentError, "wrong number of arguments(#{args.size} of #{args.size < 5 ? 5 : 6})")
 return
 end
 end
 # 転送用バッファ作成(かなり大きめ)
 buffer = Bitmap.new(width * 2, height)
 buffer.font = self.font
 tx = 0
 # 制御文字処理
 begin
 last_string = string.clone
 string.gsub!(/\\V\[(\d+)\]/i) { $game_variables[$1.to_i] }
 string.gsub!(/\\G/i) { $game_party.gold.to_s }
 string.gsub!(/\\IN\[(\d+)\]/i) { $data_items[$1.to_i] == nil ?
 "" : $data_items[$1.to_i].name }
 string.gsub!(/\\WN\[(\d+)\]/i) { $data_weapons[$1.to_i] == nil ?
 "" : $data_weapons[$1.to_i].name }
 string.gsub!(/\\AN\[(\d+)\]/i) { $data_armors[$1.to_i] == nil ?
 "" : $data_armors[$1.to_i].name }
 end until string == last_string
 string.gsub!(/\\N\[(\d+)\]/i) do
 $game_actors[$1.to_i] != nil ? $game_actors[$1.to_i].name : ""
 end
 # 変換
 string.gsub!(/\\\\/) { "\000" }
 string.gsub!(/\\C\[(\d+)\]/i) { "\001[#{$1}]" }

string.gsub!(/\\FN\[(.*)\]/i) { "\016[#{$1}]" }
    string.gsub!(/\\FS\[(\d+)\]/i) { "\017[#{$1}]" }

string.gsub!(/\\SS/i) { "\020" }
    string.gsub!(/\\ES/i) { "\021" }
    string.gsub!(/\\SF/i) { "\022" }
    string.gsub!(/\\EF/i) { "\023" }

string.gsub!(//i) { "\030" }
 string.gsub!(/<\/B>/i) { "\031" }
 string.gsub!(//i) { "\032" }
 string.gsub!(/<\/I>/i) { "\033" }
 string.gsub!(//i) { "\034" }
 string.gsub!(/<\/U>/i) { "\035" }
 string.gsub!(/<S>/i) { "\036" }
 string.gsub!(/<\/S>/i) { "\037" }

string.gsub!(/\\IT\[(\d+)\]/i) { "\201[#{$1}]" }
 string.gsub!(/\\WP\[(\d+)\]/i) { "\202[#{$1}]" }
 string.gsub!(/\\AR\[(\d+)\]/i) { "\203[#{$1}]" }
 # c に 1 文字を取得 (文字が取得できなくなるまでループ)
 while ((c = string.slice!(/./m)) != nil)
 # \\ の場合
 if c == "\000"
 # 本来の文字に戻す
 c = "\\"
 end
 # \C[n] の場合
 if c == "\001"
 # 文字色を変更
 string.sub!(/\[(\d+)\]/, "")
 color = $1.to_i
 if color >= 0 && color <= 7
 buffer.font.color = text_color(color)
 end
 # 次の文字へ
 next
 end
 # \FN[n] の場合
 if c == "\016"
 # フォント名を変更
 string.sub!(/\[(.*)\]/, "")
 buffer.font.name = $1 != "" ? $1 : Font.default_name
 # 次の文字へ
 next
 end
 # \FS[n] の場合
 if c == "\017"
 # サイズを変更
 string.sub!(/\[(\d+)\]/, "")
 buffer.font.size = $1.to_i
 # 次の文字へ
 next
 end
 # の場合
 if c == "\030"
 # ボールド
 buffer.font.bold = true
 # 次の文字へ
 next
 end
 # の場合
 if c == "\031"
 # ボールド解除
 buffer.font.bold = false
 # 次の文字へ
 next
 end
 # の場合
 if c == "\032"
 # イタリック
 buffer.font.italic = true
 # 次の文字へ
 next
 end
 # の場合
 if c == "\033"
 # イタリック解除
 buffer.font.italic = false
 # 次の文字へ
 next
 end
 # の場合
 if c == "\034"
 # 下線開始
 underline = true
 # 次の文字へ
 next
 end
 # の場合
 if c == "\035"
 # 下線終了
 underline = false
 # 次の文字へ
 next
 end
 # <S> の場合
 if c == "\036"
 # 取消線開始
 strikeout = true
 # 次の文字へ
 next
 end
 # </S> の場合
 if c == "\037"
 # 取消線終了
 strikeout = false
 # 次の文字へ
 next
 end
 # \SS の場合
 if c == "\020"
 # 影文字開始
 d_shadow = true
 # 次の文字へ
 next
 end
 # \ES の場合
 if c == "\021"
 # 影文字終了
 d_shadow = false
 # 次の文字へ
 next
 end
 # \SF の場合
 if c == "\022"
 # 縁取り文字開始
 d_frame = true
 # 次の文字へ
 next
 end
 # \EF の場合
 if c == "\023"
 # 縁取り文字終了
 d_frame = false
 # 次の文字へ
 next
 end
 # \IT[n] の場合
 if c == "\201"
 string.sub!(/\[(\d+)\]/, "")
 item = $data_items[$1.to_i]
 if item != nil
 # アイテム名をアイコン付きで描画
 icon = RPG::Cache.icon(item.icon_name)
 buffer.blt(tx + 4, [(height - icon.height) / 2, 0].max, icon, icon.rect)
 tx += icon.width + 8
 cx = buffer.text_size(item.name).width + 8
 if d_frame
 buffer.draw_frame_text(tx, 0, cx, height, item.name)
 elsif d_shadow
 buffer.draw_shadow_text(tx, 0, cx, height, item.name)
 else
 buffer.draw_text(tx, 0, cx, height, item.name)
 end
 tx += cx - 8
 end
 # \WP[n] の場合
 elsif c == "\202"
 string.sub!(/\[(\d+)\]/, "")
 item = $data_weapons[$1.to_i]
 if item != nil
 # 武器名をアイコン付きで描画
 icon = RPG::Cache.icon(item.icon_name)
 buffer.blt(tx + 4, [(height - icon.height) / 2, 0].max, icon, icon.rect)
 tx += icon.width + 8
 cx = buffer.text_size(item.name).width + 8
 if d_frame
 buffer.draw_frame_text(tx, 0, cx, height, item.name)
 elsif d_shadow
 buffer.draw_shadow_text(tx, 0, cx, height, item.name)
 else
 buffer.draw_text(tx, 0, cx, height, item.name)
 end
 tx += cx - 8
 end
 # \AR[n] の場合
 elsif c == "\203"
 string.sub!(/\[(\d+)\]/, "")
 item = $data_armors[$1.to_i]
 if item != nil
 # 武器名をアイコン付きで描画
 icon = RPG::Cache.icon(item.icon_name)
 buffer.blt(tx + 4, [(height - icon.height) / 2, 0].max, icon, icon.rect)
 tx += icon.width + 8
 cx = buffer.text_size(item.name).width + 8
 if d_frame
 buffer.draw_frame_text(tx, 0, cx, height, item.name)
 elsif d_shadow
 buffer.draw_shadow_text(tx, 0, cx, height, item.name)
 else
 buffer.draw_text(tx, 0, cx, height, item.name)
 end
 tx += cx - 8
 end
 else
 # 文字を描画
 cx = buffer.text_size(c).width + 8
 ch = buffer.text_size(c).height
 cy = (height - ch) / 2
 if d_frame
 buffer.draw_frame_text(tx, 0, cx, height, c)
 elsif d_shadow
 buffer.draw_shadow_text(tx, 0, cx, height, c)
 else
 buffer.draw_text(tx, 0, cx, height, c)
 end
 # 下線描画
 if underline
 buffer.fill_rect(tx, height - cy, cx - 8, 2, buffer.font.color)
 end
 # 取消線描画
 if strikeout
 buffer.fill_rect(tx, height / 2 + 2, cx - 8, 2, buffer.font.color)
 end
 # tx に描画した文字の幅を加算
 tx += cx - 8
 end
 end
 # 転送
 src_rect = Rect.new(0, 0, tx, height)
 dest_rect = Rect.new(x, y, [tx, width].min, height)
 case align
 when 1
 dest_rect.x = (width - [tx, width].min) / 2
 when 2
 dest_rect.x = [width - tx, 0].max
 end
 stretch_blt(dest_rect, buffer, src_rect)
 # バッファを破棄
 buffer.dispose
 end
 #--------------------------------------------------------------------------
 # ● 文字色の取得
 #--------------------------------------------------------------------------
 def text_color(n)
 case n
 when 0
 return Color.new(255, 255, 255, 255)
 when 1
 return Color.new(128, 128, 255, 255)
 when 2
 return Color.new(255, 128, 128, 255)
 when 3
 return Color.new(128, 255, 128, 255)
 when 4
 return Color.new(128, 255, 255, 255)
 when 5
 return Color.new(255, 128, 255, 255)
 when 6
 return Color.new(255, 255, 128, 255)
 when 7
 return Color.new(192, 192, 192, 255)
 else
 normal_color
 end
 end
 #--------------------------------------------------------------------------
 # ● 通常文字色の取得
 #--------------------------------------------------------------------------
 def normal_color
 return Color.new(255, 255, 255, 255)
 end
end

使用法

draw_text

の代わりに

draw_format_text

を使用することにより、書式指定が可能になります。
使用可能な制御文字は以下の通りです。

文字色を変更。: \\C[n]
所持金を描画。: \\G
アクター名を描画。: \\N[n]
変数の値を描画。: \\V[n]
フォント名を変更。: \\FN[name]
フォントサイズを変更。: \\FS[n]
影文字描画。: \\SS ～ \\ES
縁取り文字描画。: \\SF ～ \\EF
アイテム名を描画。: \\IN[n]
武器名を描画。: \\WN[n]
防具名を描画。: \\AN[n]
アイテム名をアイコン付きで描画。: \\IT[n]
武器名をアイコン付きで描画。: \\WP[n]
防具名をアイコン付きで描画。: \\AR[n]
ボールド体(太文字)で描画。: ～
イタリック体(斜体)で描画。: ～
下線を描画。: ～
取消線を描画。: <S> ～ </S>

全ての機能に関する詳しい使用法はスクリプト中に書かれているので、そちらを参照してください。

制御文字に \\ が使用されているものは、必ず \ を２個付けてください。
制御文字の組み合わせによっては、効果が表れない場合もあります。
もし指示通りの表示にならない場合は、制御文字の順序を入れ替える等の対処を試みてください。
(どうしても動作しない場合は専用板へ)

概要

スクリーンショット

更新履歴

スクリプト

KGC_FormatText

使用法