Module: Miyako::MapEvent
- Includes:
- Animation, SpriteBase
- Defined in:
- lib/Miyako/API/map_event.rb
Overview
マップ上のイベントを管理するモジュール
実際に使う際にはmix-inして使う
Instance Method Summary collapse
-
#dispose ⇒ Object
イベントに使用しているインスタンスを解放する(テンプレートメソッド) ここに、インスタンス解放処理を実装する。.
-
#executing? ⇒ Boolean
イベント発生中問い合わせ(テンプレートメソッド) ここに、イベント発生中の問い合わせ処理を実装する。 param:: あとで書く 返却値:: イベント発生中の時はtrue.
-
#final ⇒ Object
イベント終了後の後処理(テンプレートメソッド) ここに、イベント終了後の後処理を実装する。.
-
#init(map_obj, x, y) ⇒ Object
イベント生成時のテンプレートメソッド イベントクラスからインスタンスが生成された時の初期化処理を実装する map_obj:: 関連づけられたMap/FixedMapクラスのインスタンス x:: マップ上のX座標の値 y:: マップ上のY座標の値.
-
#initialize(map_obj, x = 0, y = 0) ⇒ Object
イベントのインスタンスを作成する 引数として渡せるX,Y座標の値は、表示上ではなく理論上の座標位置 map_obj:: 関連づけられたMap/FixedMapクラスのインスタンス x:: マップ上のX座標の値。デフォルトは0 y:: マップ上のY座標の値。デフォルトは0 返却値:: 生成されたインスタンス.
-
#met?(*params) ⇒ Boolean
イベント発生可否問い合わせ(テンプレートメソッド) イベント発生が可能なときはtrueを返す(その後、startメソッドを呼び出す)処理を実装する param:: 問い合わせに使用するパラメータ群。デフォルトはnil 返却値:: イベント発生可能ならばtrue.
-
#move(dx, dy, *params) ⇒ Object
イベントを指定の分量で移動させたときの値を求める(テンプレートメソッド) dx:: 移動量(x座標)。単位はピクセル dy:: 移動量(y座標)。単位はピクセル params:: move呼び出し時に渡された引数。可変個数 返却値:: 移動した位置のインスタンスを返す.
-
#move!(dx, dy, *params) ⇒ Object
イベントを指定の分量で移動させる(テンプレートメソッド) dx:: 移動量(x座標)。単位はピクセル dy:: 移動量(y座標)。単位はピクセル params:: move呼び出し時に渡された引数。可変個数 返却値:: 自分自身を返す.
-
#move_to(x, y, *params) ⇒ Object
イベントを指定の位置へ移動させたときの値を求める(テンプレートメソッド) x:: 移動先の位置(x座標)。単位はピクセル y:: 移動先の位置(y座標)。単位はピクセル params:: move呼び出し時に渡された引数。可変個数 返却値:: 移動した位置のインスタンスを返す.
-
#move_to!(x, y, *params) ⇒ Object
イベントを指定の位置へ移動させる(テンプレートメソッド) x:: 移動先の位置(x座標)。単位はピクセル y:: 移動先の位置(y座標)。単位はピクセル params:: move呼び出し時に渡された引数。可変個数 返却値:: 自分自身を返す.
-
#pos_move!(dx, dy, *params) ⇒ Object
イベントを指定の分量で移動させる(テンプレートメソッド) 論理的な位置のみを移動させるときにオーバーライドする dx:: 移動量(x座標)。単位はピクセル dy:: 移動量(y座標)。単位はピクセル params:: move呼び出し時に渡された引数。可変個数 返却値:: 自分自身を返す.
-
#pos_move_to!(x, y, *params) ⇒ Object
イベントを指定の位置へ移動させる(テンプレートメソッド) 論理的な位置のみを移動させるときにオーバーライドする x:: 移動先の位置(x座標)。単位はピクセル y:: 移動先の位置(y座標)。単位はピクセル params:: move呼び出し時に渡された引数。可変個数 返却値:: 自分自身を返す.
-
#render ⇒ Object
画面に画像を描画する(テンプレートメソッド) イベントで所持している画像を描画するメソッドを実装する (イベント内部で用意している画像の描画用テンプレートメソッド).
-
#sprite_move!(dx, dy, *params) ⇒ Object
イベントを指定の分量で移動させる(テンプレートメソッド) スプライトのみを移動させるときにオーバーライドする dx:: 移動量(x座標)。単位はピクセル dy:: 移動量(y座標)。単位はピクセル params:: move呼び出し時に渡された引数。可変個数 返却値:: 自分自身を返す.
-
#sprite_move_to!(x, y, *params) ⇒ Object
イベントを指定の位置へ移動させる(テンプレートメソッド) スプライトのみを移動させるときにオーバーライドする x:: 移動先の位置(x座標)。単位はピクセル y:: 移動先の位置(y座標)。単位はピクセル params:: move呼び出し時に渡された引数。可変個数 返却値:: 自分自身を返す.
-
#start(*params) ⇒ Object
イベントを発生させる(テンプレートメソッド) ここに、イベント発生イベントを実装する。更新はupdateメソッドに実装する param:: イベント発生に必要なパラメータ群。デフォルトはnil 返却値:: 自分自身を返す.
-
#stop(*params) ⇒ Object
イベントを停止・終了させる(テンプレートメソッド) ここに、イベント停止・終了イベントを実装する。更新はupdateメソッドに実装する param:: イベント発生に必要なパラメータ群。デフォルトはnil 返却値:: 自分自身を返す.
-
#update(map_obj, events, params) ⇒ Object
インスタンス内の表示やデータを更新するテンプレートメソッド マップ画像が更新された時に呼び出す map_obj:: インスタンスが組み込まれているMap/FixedMapクラスのインスタンス events:: マップに登録されているイベントインスタンスの配列 params:: 開発者が明示的に用意した引数。内容はハッシュ.
-
#update2(*params) ⇒ Object
インスタンス内の表示やデータを更新するテンプレートメソッド 独自に更新を行いたいときに呼び出される params:: 開発者が明示的に用意した引数。可変引数.
Methods included from Animation
[], []=, anim_hash, reset, #reset, start, stop, update, update_animation, #update_animation
Methods included from SpriteBase
#bitmap, #hide, #image_rect, #image_size, #oh, #oh=, #ow, #ow=, #ox, #ox=, #oy, #oy=, #part_rect, #rect, #render_d, #render_to, #render_xy, #render_xy_to, #show, #to_sprite, #to_unit, #visible, #visible=
Instance Method Details
#dispose ⇒ Object
イベントに使用しているインスタンスを解放する(テンプレートメソッド)
ここに、インスタンス解放処理を実装する。
283 284 |
# File 'lib/Miyako/API/map_event.rb', line 283 def dispose end |
#executing? ⇒ Boolean
イベント発生中問い合わせ(テンプレートメソッド)
ここに、イベント発生中の問い合わせ処理を実装する。
- param
-
あとで書く
- 返却値
-
イベント発生中の時はtrue
272 273 274 |
# File 'lib/Miyako/API/map_event.rb', line 272 def executing? return false end |
#final ⇒ Object
イベント終了後の後処理(テンプレートメソッド)
ここに、イベント終了後の後処理を実装する。
278 279 |
# File 'lib/Miyako/API/map_event.rb', line 278 def final end |
#init(map_obj, x, y) ⇒ Object
イベント生成時のテンプレートメソッド
イベントクラスからインスタンスが生成された時の初期化処理を実装する
- map_obj
-
関連づけられたMap/FixedMapクラスのインスタンス
- x
-
マップ上のX座標の値
- y
-
マップ上のY座標の値
145 146 |
# File 'lib/Miyako/API/map_event.rb', line 145 def init(map_obj, x, y) end |
#initialize(map_obj, x = 0, y = 0) ⇒ Object
イベントのインスタンスを作成する
引数として渡せるX,Y座標の値は、表示上ではなく理論上の座標位置
- map_obj
-
関連づけられたMap/FixedMapクラスのインスタンス
- x
-
マップ上のX座標の値。デフォルトは0
- y
-
マップ上のY座標の値。デフォルトは0
- 返却値
-
生成されたインスタンス
136 137 138 |
# File 'lib/Miyako/API/map_event.rb', line 136 def initialize(map_obj, x = 0, y = 0) init(map_obj, x, y) end |
#met?(*params) ⇒ Boolean
イベント発生可否問い合わせ(テンプレートメソッド)
イベント発生が可能なときはtrueを返す(その後、startメソッドを呼び出す)処理を実装する
- param
-
問い合わせに使用するパラメータ群。デフォルトはnil
- 返却値
-
イベント発生可能ならばtrue
242 243 244 |
# File 'lib/Miyako/API/map_event.rb', line 242 def met?(*params) return false end |
#move(dx, dy, *params) ⇒ Object
イベントを指定の分量で移動させたときの値を求める(テンプレートメソッド)
- dx
-
移動量(x座標)。単位はピクセル
- dy
-
移動量(y座標)。単位はピクセル
- params
-
move呼び出し時に渡された引数。可変個数
- 返却値
-
移動した位置のインスタンスを返す
225 226 227 |
# File 'lib/Miyako/API/map_event.rb', line 225 def move(dx,dy,*params) return Point.new(0,0) end |
#move!(dx, dy, *params) ⇒ Object
イベントを指定の分量で移動させる(テンプレートメソッド)
- dx
-
移動量(x座標)。単位はピクセル
- dy
-
移動量(y座標)。単位はピクセル
- params
-
move呼び出し時に渡された引数。可変個数
- 返却値
-
自分自身を返す
167 168 169 |
# File 'lib/Miyako/API/map_event.rb', line 167 def move!(dx,dy,*params) return self end |
#move_to(x, y, *params) ⇒ Object
イベントを指定の位置へ移動させたときの値を求める(テンプレートメソッド)
- x
-
移動先の位置(x座標)。単位はピクセル
- y
-
移動先の位置(y座標)。単位はピクセル
- params
-
move呼び出し時に渡された引数。可変個数
- 返却値
-
移動した位置のインスタンスを返す
234 235 236 |
# File 'lib/Miyako/API/map_event.rb', line 234 def move_to(x,y,*params) return Point.new(0,0) end |
#move_to!(x, y, *params) ⇒ Object
イベントを指定の位置へ移動させる(テンプレートメソッド)
- x
-
移動先の位置(x座標)。単位はピクセル
- y
-
移動先の位置(y座標)。単位はピクセル
- params
-
move呼び出し時に渡された引数。可変個数
- 返却値
-
自分自身を返す
176 177 178 |
# File 'lib/Miyako/API/map_event.rb', line 176 def move_to!(x,y,*params) return self end |
#pos_move!(dx, dy, *params) ⇒ Object
イベントを指定の分量で移動させる(テンプレートメソッド)
論理的な位置のみを移動させるときにオーバーライドする
- dx
-
移動量(x座標)。単位はピクセル
- dy
-
移動量(y座標)。単位はピクセル
- params
-
move呼び出し時に渡された引数。可変個数
- 返却値
-
自分自身を返す
206 207 208 |
# File 'lib/Miyako/API/map_event.rb', line 206 def pos_move!(dx,dy,*params) return self end |
#pos_move_to!(x, y, *params) ⇒ Object
イベントを指定の位置へ移動させる(テンプレートメソッド)
論理的な位置のみを移動させるときにオーバーライドする
- x
-
移動先の位置(x座標)。単位はピクセル
- y
-
移動先の位置(y座標)。単位はピクセル
- params
-
move呼び出し時に渡された引数。可変個数
- 返却値
-
自分自身を返す
216 217 218 |
# File 'lib/Miyako/API/map_event.rb', line 216 def pos_move_to!(x,y,*params) return self end |
#render ⇒ Object
画面に画像を描画する(テンプレートメソッド)
イベントで所持している画像を描画するメソッドを実装する (イベント内部で用意している画像の描画用テンプレートメソッド)
249 250 |
# File 'lib/Miyako/API/map_event.rb', line 249 def render end |
#sprite_move!(dx, dy, *params) ⇒ Object
イベントを指定の分量で移動させる(テンプレートメソッド)
スプライトのみを移動させるときにオーバーライドする
- dx
-
移動量(x座標)。単位はピクセル
- dy
-
移動量(y座標)。単位はピクセル
- params
-
move呼び出し時に渡された引数。可変個数
- 返却値
-
自分自身を返す
186 187 188 |
# File 'lib/Miyako/API/map_event.rb', line 186 def sprite_move!(dx,dy,*params) return self end |
#sprite_move_to!(x, y, *params) ⇒ Object
イベントを指定の位置へ移動させる(テンプレートメソッド)
スプライトのみを移動させるときにオーバーライドする
- x
-
移動先の位置(x座標)。単位はピクセル
- y
-
移動先の位置(y座標)。単位はピクセル
- params
-
move呼び出し時に渡された引数。可変個数
- 返却値
-
自分自身を返す
196 197 198 |
# File 'lib/Miyako/API/map_event.rb', line 196 def sprite_move_to!(x,y,*params) return self end |
#start(*params) ⇒ Object
イベントを発生させる(テンプレートメソッド)
ここに、イベント発生イベントを実装する。更新はupdateメソッドに実装する
- param
-
イベント発生に必要なパラメータ群。デフォルトはnil
- 返却値
-
自分自身を返す
256 257 258 |
# File 'lib/Miyako/API/map_event.rb', line 256 def start(*params) return self end |
#stop(*params) ⇒ Object
イベントを停止・終了させる(テンプレートメソッド)
ここに、イベント停止・終了イベントを実装する。更新はupdateメソッドに実装する
- param
-
イベント発生に必要なパラメータ群。デフォルトはnil
- 返却値
-
自分自身を返す
264 265 266 |
# File 'lib/Miyako/API/map_event.rb', line 264 def stop(*params) return self end |
#update(map_obj, events, params) ⇒ Object
インスタンス内の表示やデータを更新するテンプレートメソッド
マップ画像が更新された時に呼び出す
- map_obj
-
インスタンスが組み込まれているMap/FixedMapクラスのインスタンス
- events
-
マップに登録されているイベントインスタンスの配列
- params
-
開発者が明示的に用意した引数。内容はハッシュ
153 154 |
# File 'lib/Miyako/API/map_event.rb', line 153 def update(map_obj, events, params) end |
#update2(*params) ⇒ Object
インスタンス内の表示やデータを更新するテンプレートメソッド
独自に更新を行いたいときに呼び出される
- params
-
開発者が明示的に用意した引数。可変引数
159 160 |
# File 'lib/Miyako/API/map_event.rb', line 159 def update2(*params) end |