Module: Miyako::SpriteBase

Included in:
ChoiceStruct, Choices, FixedMap, FixedMap::FixedMapLayer, Font, InitiativeYuki, LayoutSpace, ListPairStruct, Map, Map::MapLayer, MapEvent, Movie, Parts, Plane, Sprite, SpriteAnimation, SpriteArray, SpriteList, TextBox, Viewport, Yuki
Defined in:
lib/Miyako/API/modules.rb

Overview

基本スプライトモジュール

スプライトの基本メソッドで構成されるテンプレートモジュール

Instance Method Summary collapse

Instance Method Details

#bitmap ⇒ Object

画像(Bitmapクラスのインスタンス)を取得するメソッドのテンプレート

返却値

nilを返す



73
74
75
 
# File 'lib/Miyako/API/modules.rb', line 73

def bitmap
  return nil
end

#hide ⇒ Object

描画不可能状態にするメソッドのテンプレート



60
61
62
 
# File 'lib/Miyako/API/modules.rb', line 60

def hide
  self.visible = false
end

#image_rect ⇒ Object

スプライトの元画像の矩形を返す

返却値

Rect構造体インスタンス(デフォルトはnil)



115
116
117
 
# File 'lib/Miyako/API/modules.rb', line 115

def image_rect
  return nil
end

#image_size ⇒ Object

スプライトの元画像の大きさを返す

返却値

Size構造体インスタンス(デフォルトはnil)



109
110
111
 
# File 'lib/Miyako/API/modules.rb', line 109

def image_size
  return nil
end

#oh ⇒ Object

mixin されたインスタンスの部分矩形高を取得する

返却値

インスタンスの高さ(デフォルトは0)



97
98
99
 
# File 'lib/Miyako/API/modules.rb', line 97

def oh
  return 0
end

#ow ⇒ Object

mixin されたインスタンスの部分矩形幅を取得する

返却値

インスタンスの幅(デフォルトは0)



91
92
93
 
# File 'lib/Miyako/API/modules.rb', line 91

def ow
  return 0
end

#ox ⇒ Object

mixin されたインスタンスの部分矩形開始位置(x軸)を取得する

返却値

部分矩形開始位置(デフォルトは0)



79
80
81
 
# File 'lib/Miyako/API/modules.rb', line 79

def ox
  return 0
end

#oy ⇒ Object

mixin されたインスタンスの部分矩形開始位置(y軸)を取得する

返却値::部分矩形開始位置(デフォルトは0)



85
86
87
 
# File 'lib/Miyako/API/modules.rb', line 85

def oy
  return 0
end

#part_rect ⇒ Object

スプライトの部分矩形を返す

返却値

Rect構造体インスタンス(デフォルトはnil)



103
104
105
 
# File 'lib/Miyako/API/modules.rb', line 103

def part_rect
  return nil
end

#rect ⇒ Object

領域の矩形を取得するメソッドのテンプレート

Spriteクラスの時は部分矩形が返ってくることに注意

返却値

Rect構造体インスタンス(デフォルトはnil)



67
68
69
 
# File 'lib/Miyako/API/modules.rb', line 67

def rect
  return nil
end

#render ⇒ Object

画面への描画を指示するメソッドのテンプレート

返却値

自分自身を返す



163
164
165
 
# File 'lib/Miyako/API/modules.rb', line 163

def render
  return self
end

#render_to(dst) ⇒ Object

画像への描画を指示するメソッドのテンプレート

dst

対象の画像

返却値

自分自身を返す



170
171
172
 
# File 'lib/Miyako/API/modules.rb', line 170

def render_to(dst)
  return self
end

#render_xy(x, y) ⇒ Object

位置を指定して画面への描画を指示するメソッドのテンプレート

オブジェクトで保持している位置情報ではなく、引数で渡された位置に描画する 基本的に、メソッドのオーバーライドにより機能するが、pos,move_to!メソッドを持っているときは、 これらのメソッドを呼び出して同じ動作を行うが処理速度的に課題あり ただし、上記のメソッドを持っていない場合は、単純にrenderメソッドを呼び出す

x

描画位置のx座標

y

描画位置のy座標

返却値

自分自身を返す



130
131
132
133
134
135
136
137
138
139
 
# File 'lib/Miyako/API/modules.rb', line 130

def render_xy(x, y)
  if [:pos, :move_to!].all?{|mn| self.class.method_defined?(mn)}
    old_pos = self.pos
    self.move_to!(x,y)
    self.render
    self.move_to!(*old_pos)
    return self
  end
  return self.render
end

#render_xy_to(dst, x, y) ⇒ Object

位置を指定して画像への描画を指示するメソッドのテンプレート

オブジェクトで保持している位置情報ではなく、引数で渡された位置に描画する 基本的に、メソッドのオーバーライドにより機能するが、pos,move_to!メソッドを持っているときは、 これらのメソッドを呼び出して同じ動作を行うが、処理速度的に課題あり ただし、上記のメソッドを持っていない場合は、単純にrender_toメソッドを呼び出す

dst

対象の画像

x

描画位置のx座標

y

描画位置のy座標

返却値

自分自身を返す



150
151
152
153
154
155
156
157
158
159
 
# File 'lib/Miyako/API/modules.rb', line 150

def render_xy_to(dst, x, y)
  if [:pos, :move_to!].all?{|mn| self.class.method_defined?(mn)}
    old_pos = self.pos
    self.move_to!(x,y)
    self.render_to(dst)
    self.move_to!(*old_pos)
    return self
  end
  return self.render_to(dst)
end

#show ⇒ Object

描画可能状態にするメソッドのテンプレート



55
56
57
 
# File 'lib/Miyako/API/modules.rb', line 55

def show
  self.visible = true
end

#to_sprite(data = nil) ⇒ Object

スプライトインスタンスを取得するメソッドのテンプレート

data

あとで書く

返却値

自分自身を返す



32
33
34
 
# File 'lib/Miyako/API/modules.rb', line 32

def to_sprite(data = nil)
  return self
end

#to_unit ⇒ Object

SpriteUnit構造体を取得するメソッドのテンプレート

返却値

nilを返す



38
39
40
 
# File 'lib/Miyako/API/modules.rb', line 38

def to_unit
  return nil
end

#update ⇒ Object 



119
120
 
# File 'lib/Miyako/API/modules.rb', line 119

def update
end

#visible ⇒ Object

描画可能・不可状態を返すメソッドのテンプレート

返却値

falseを返す



44
45
46
 
# File 'lib/Miyako/API/modules.rb', line 44

def visible
  return false
end

#visible=(v) ⇒ Object

描画可能・不可状態を設定するメソッドのテンプレート

返却値

自分自身を返す



50
51
52
 
# File 'lib/Miyako/API/modules.rb', line 50

def visible=(v)
  return self
end