FlxSprite の変更点
[[API Reference]] > [[flixel]] > FlxSprite
*FlxSprite [#i001180f]
>FlxSpriteは"ゲームオブジェクト"です。FlxObjectに描画や属性をもたせたスプライトで、アニメーションしたり足を踏み鳴らして歩いたりできます。
----
#contents
----
* スーパークラス [#z7f6cb46]
FlxBasic < FlxObject
----
* フィールド [#r8d1d309]
** animation:FlxAnimationController : アニメーション [#h5211eab]
** framePixels:BitmapData : FlxStateで描画可能なFlashと互換性のある実際のBitmapDataオブジェクト [#yfb89cf4]
** antialiasing:Bool = false : アンチエイリアシングで描画するかどうか [#abfb53b4]
trueにするとパフォーマンスに影響が出ます
** dirty:Bool = true : 描画実行フラグ。通常、操作する必要はありません [#cae2eeb9]
** pixels:BitmapData : 描画データ。自動的に画面サイズに調整されます [#v36ffe92]
** frame:FlxFrame : 読み込み済みのアトラスから現在のFlxFrameへのリンク [#r7477d99]
** frameWidth:Int = 0 : 実際のグラフィックの幅。もしくは描画用に調整された幅 [#r9db08f3]
この値は必ずしもゲームオブジェクト・バウンディングボックスのサイズと一致するものではありません
** frameHeight:Int = 0 : 実際のグラフィックの高さ。もしくは描画用に調整された高さ [#fbc9aa93]
この値は必ずしもゲームオブジェクト・バウンディングボックスのサイズと一致するものではありません
** frames:Int = 0 : この画像のフレームの総数 [#o6c0032a]
** 描画用変数 [#z8e816c8]
*** region:Region : ??? [#a294dc08]
*** frameData:FlxSpriteFrame : ??? [#id4fabb0]
*** cachedGraphics:Cachedgraphics : ??? [#j4a74117]
** bakedRotationAngle:Float = 0 : ベイクした最小角度 [#odc3384d]
例えば、4つにベイクした場合は90度となります。
0である場合は、ベイクを使用していません
** alpha:Float = 1.0 : アルファ値 [#g83a1e0f]
** facing:Int = FlxObject.RIGHT : 向き [#m7d3401c]
「|(ビットOR演算子」で複数の向きを組み合わせることが可能です
** flipX:Bool = false : 左右反転するかどうか [#ve87ff14]
** flipY:Bool = false : 上下反転するかどうか [#me8d34b1]
** origin:FlxPoint : 描画の中心座標 [#ga13c8f7]
警告: originはスプライトの中心にデフォルト設定されます。
これを変更した場合、回転を行った際に予期しない挙動となります
** offset:FlxPoint :バウンディングボックスの調整座標 [#r85ecd82]
スプライトの幅や高さ、スケール値を変更した場合には、この値の調整が必要となります
** scale:FlxPoint : 拡大縮小の値 [#t07cd425]
** blend:BlendMode : ブレンドモード [#xad8c3d5]
** color:Int = 0xffffff : 描画色(0xRRGGBBフォーマット) [#r06c9c9d]
0xAARRGGBBでも指定可能してもAlpha値は無視されます。
透過色を指定するにはフィールドalphaを使用してください
** colorTransform:ColorTransform : 特殊な色の変換 [#zfa8d1af]
** useColorTransform:Bool = false : ColorTransformを有効にするかどうか [#p4f5242a]
----
* メソッド [#n1fa6f23]
** new() : コンストラクタ [#u6cc7e3c]
- 引数
-- X:Float = 0 : 配置するX座標
-- Y:Float = 0 : 配置するY座標
-- ?SimpleGraphic:Dynamic : 割り当てる画像
** loadGraphic() : 画像を読み込んで割り当てます [#gbf874bd]
- 引数
-- Graphic:Dynamic : グラフィックを指定します
通常は"assets"をルートとしたパスを文字列で指定します(`assets/images/play.png`など）。
それ以外にBitmapDataなどを渡すこともできます
-- Animated:Bool = false
指定のグラフィックをアニメーションデータ(連続したアニメ画像)として扱うかどうかを指定します。
trueを指定すると`Width` / `Height`で切り出すサイズを指定できます
-- Width:Int = 0 : アニメーションとして切り出す画像の幅。0を指定すると画像サイズで自動判定します
-- Height:Int = 0 : アニメーションとして切り出す画像の高さ。0を指定すると画像サイズで自動判定します
-- Unique:Bool = false
画像読み込みをキャッシュせずにユニークな画像として生成します。デフォルトは無効です
-- ?key:String : GraphicにBitmapDataを指定した際のロードパラメータです
- 戻り値 : FlxSprite : thisポインタ
** loadRotatedGraphic() 回転スプライトシートを作成します [#hfd2885c]
回転画像をあらかじめ作成しておくため、
スプライトを回転する場合にグラフィックス性能を向上させることができます
-引数
-- Graphic:Dynamic : 画像データ
-- Rotations:Int = 16 : 回転のパターン数
-- Frame:Int = -1 : 当たり判定に使用するフレームを指定します。-1を指定すると画像全体となります
-- AntiAliasing:Bool = false : 高品質の回転を行うかどうかを指定します
-- AutoBuffer:Bool = false : 回転の角が途切れないように画像を拡大するかどうか
-- ?Key:String : BitmapDataをロードしている場合のキー
-戻り値:FlxSprite : thisポインタ
** makeGraphic() : 指定の色で矩形画像を動的に作ります [#z6946683]
- 引数
-- Width:Int : 矩形の幅
-- Height:Int : 矩形の高さ
-- Color:Int = FlxColor.WHITE : 色
16進数かFlxColorを使うと直感的に指定がしやすいです
-- Unique:Bool = false : キャッシュせずにユニークな画像を作るかどうか
-- ?Key:String : キャッシュに作成するグラフィックを識別する文字列を指定します
- 戻り値 : FlxSprite : thisポインタ
** [[resetSizeFromFrame>FlxSprite#le3ea969]]() : サイズを実際の画像サイズに合わせます [#le3ea969]
width を frameWidth、height を frameHeight に合わせます
- 戻り値:Void
** centerOffsets() : バウンディングボックスの座標を画像データの中心に調整します [#d01ea9b0]
- 引数
-- adjustPosition:Bool = false : 現在の座標も調整するかどうか
- 戻り値:Void
** centerOrigin() : スプライトの中心座標を調整します [#g44b0d4d]
スケール値を変更した後で使います
- 戻り値:Void
** isOnScreen() : スクリーン内に存在するかどうかチェックします [#z9cc53d7]
- 引数
-- ?Camera:FlxCamera : カメラ。nullの場合メインカメラを使用します
- 戻り値: Bool : スクリーン内に存在していればtrue